VyriyVyriy Documentation
Vyriy is a calm architecture toolkit for building cloud-ready applications, libraries, APIs, serverless handlers, static sites, SSR pages, and OpenMFE widgets.
This documentation section is organized by package groups. Each package page describes the package purpose, installation, public exports, parameters, and usage examples.
Config
Reusable configuration packages for frontend, backend, tests, linting, formatting, and documentation tooling.
| Package | Description |
|---|---|
| Browserslist | Shared Browserslist targets for consistent browser and Node.js support. |
| ESLint | Shared ESLint configuration for TypeScript-first Vyriy projects. |
| Jest | Shared Jest configuration for package, unit, and integration tests. |
| Prettier | Shared Prettier configuration for consistent formatting. |
| Storybook | Shared Storybook configuration for component documentation and examples. |
| Stylelint | Shared Stylelint configuration for CSS, SCSS, and component styles. |
| TypeScript | Shared TypeScript configuration for strict ESM packages. |
| Webpack | Shared Webpack configuration helpers for browser, SSR, and library builds. |
CLI
Command-line packages and script helpers for creating, building, checking, and shipping Vyriy projects.
| Package | Description |
|---|---|
| Script | Functional script primitives for calm automation flows. |
| Scripts | Reusable project scripts for common local and CI tasks. |
| Check | Validation helpers for checking project state, inputs, and generated output. |
| Create Vyriy | Package entry point for creating new Vyriy projects from presets. |
| Create | Project generation logic used by the Vyriy CLI. |
| Dist | Distribution and build output helpers for packages and generated projects. |
| Static | Static asset and static-site helpers for docs, examples, and deployments. |
| Vyriy | Main Vyriy CLI package and user-facing command entry point. |
App
Core application helpers used across Vyriy projects and scripts.
| Package | Description |
|---|---|
| Commit | Commit-related helpers for predictable repository and release workflows. |
| Config | Shared configuration loading and composition utilities for Vyriy packages. |
| Env | Environment variable helpers for typed and explicit runtime configuration. |
| Exec | Process execution helpers for scripts, CLIs, and automation flows. |
| Logger | Small logging utilities for readable script and runtime output. |
| Package | Package metadata helpers for monorepos, workspaces, and package-aware tooling. |
| Path | Path helpers for stable file-system access across scripts and packages. |
Stack
Infrastructure packages for deploying cloud-ready Vyriy applications.
| Package | Description |
|---|---|
| CDK | AWS CDK helpers for defining infrastructure in TypeScript. |
| Services | Shared service composition helpers for infrastructure and runtime modules. |
| AWS Stack | AWS stack primitives for deploying Vyriy apps with calm, explicit infrastructure. |
API
Packages for request handling, routing, runtime composition, and API smoke checks.
| Package | Description |
|---|---|
| Chaos | Small helpers for testing failure cases and runtime resilience. |
| Handler | Runtime-agnostic handler utilities for Lambda, HTTP, and other event sources. |
| Router | Lightweight routing primitives for REST-like APIs and request dispatching. |
| Server | Server helpers for local development, HTTP adapters, and runtime entry points. |
| Smoke | Smoke-test helpers for validating deployments and API availability. |
UI
UI and rendering packages for components, HTML generation, custom events, React helpers, and browser rendering.
| Package | Description |
|---|---|
| ClassNames | Class name composition helper for predictable component styling. |
| CustomEvent | Typed custom event helpers for browser and micro-frontend communication. |
| React HOC | React higher-order component helpers for reusable UI composition. |
| HTML | HTML string and document helpers for SSR, SSG, and static output. |
| Render | Browser rendering and hydration helpers for React, Shadow DOM, and OpenMFE widgets. |
Processing
Small functional utilities for request processing, retries, recursion, delays, errors, and timeouts.
| Package | Description |
|---|---|
| Error | Error helpers for explicit failure handling and readable messages. |
| Pause | Delay helpers for scripts, retries, tests, and async workflows. |
| Recursive | Recursion helpers for walking nested data, trees, and file structures. |
| Request | Request helpers for HTTP-like operations and API integrations. |
| Retry | Retry helpers for unstable operations, network calls, and deployment checks. |
| Timeout | Timeout helpers for bounding async work and preventing hanging processes. |