UDIOT framework documentation
End-user documentation for @tagna/udiot 1.0.0-rc.1. Requires Node.js >=22.17.0, npm >=9, and ESM. Stable 1.0 has not shipped. Experimental APIs are not production support promises.
The repository's source can be ahead of the published RC while retaining the same version metadata. The generated inventory describes the built checkout; verify installed declarations for a deployed archive. See source and release evidence.
Start here
- Install from public npm.
- Configure TypeScript.
- Run the complete quick-start examples.
- Choose a public entry point and review its support status.
No registry credentials are needed to install. Pin the RC when evaluating it;
latest and next are separate npm channels.
Framework guides
| Area | Guide |
|---|---|
| Concepts and architecture | Core concepts, architecture, modules |
| Dependency injection | Overview, container, providers |
| Middleware | Overview, pipeline, composition, built-ins |
| State | Overview, store, observables, persistence |
| Web and server | Web apps, composition recipe, Express helpers, event streams |
| Routing and rendering | Routing, rendering |
| Database | Adapters and repositories |
| Caching | Overview, invalidation |
| Configuration | Overview, secret providers |
| Validation | Public validation APIs, HTTP schemas |
| Background jobs and events | Jobs, event bus |
| Telemetry | Overview, logging, run events, notifications |
| AI and agents | AI overview, agent runtime, generation limitations |
| Browser/UI | Browser setup, micro-frontends, components, forms, HTTP client |
| Isolation | Tenant scoping, reactive context, workspace filesystem |
| Developer tools for applications | Overview, CLI |
| Reference | Entry points, export inventory, decorators, type utilities |
Application lifecycle
- Evaluate and upgrade to the 1.0 RC
- Migrate from Express or NestJS
- Test an application
- Measure performance
- Prepare deployment
- Security policy and support policy
- Contributing, project coverage and website deployment
Reading examples
Complete examples marked typescript check are compiled and executed by
npm run test:docs after a framework build. Other snippets illustrate an API
or integration and may depend on application-owned objects, credentials,
services or a browser; they are not all standalone programs.
Example execution checks awaited assertions, not whole-application resource
shutdown; the runner ends each isolated example process after evaluation.
The documentation check validates local file links and public named imports throughout this directory. This does not certify every integration, benchmark claim, or third-party service. Check installed declarations for exact signatures.
Documentation boundaries
This website is the single maintained documentation source. Guides, contributor
instructions and policies live together in content/docs/ in the udiot.in
repository. Framework entry files link here. Edit the website source directly;
do not copy guides back into the framework's docs/ or documentation/ folders.
Historical plans, issue notes, audits and completion reports are preserved in
the website repository's archives/ outside the public build. They are dated
evidence and do not establish current implementation or support. Machine-readable
API snapshots, release gates and operational assets remain with framework tooling.
Repository-hosted material may require repository access; public npm installation does not. The package includes README, support and security guidance. See the repository for source and development work.