Framework — Documentation

Lightweight DI (Dependency Injection) system for browser JS applications. Modules are pure factory functions, resolvable on demand, serializable for Web Workers. No external dependencies, no bundler required.

Package: @awacloud/fw

See Bundler integration and TypeScript.

Quick Start — standalone

Since the refactor — @awacloud/fw no longer auto-registers modules when main.js loads. The user must explicitly call runtime.registerAll(modules) (or registerAllDeep, or register module by module via subpath).

import fw from '@awacloud/fw';
import modules from '@awacloud/fw/core/modules.js';

const { runtime, createWorker, domReady } = fw;
runtime.registerAll(modules);

// Resolve a module
const hex = runtime.resolve('hex');
console.log(hex.fromBytes(new Uint8Array([72, 101, 108]))); // "48656c"

// Wait for the DOM
domReady.loaded(() => {
    const ui = runtime.resolve('uiSession');
    // ...
});

For a minimal graph (bundler-side tree-shaking), import the module directly via its subpath and use registerDeep:

import { ModuleRuntime } from '@awacloud/fw/core/runtime';
import { sanitize } from '@awacloud/fw/dom/rendering/sanitize.js';

const runtime = new ModuleRuntime();
runtime.registerDeep(sanitize); // pulls parser, render, secPolicy via JS imports

Quick Start — bundler-integrated (Vite)

// vite.config.js
import fw from '@awacloud/fw/vite';
export default { plugins: [ fw({ preset: 'site-interactive' }) ] };

// src/main.js
import { runtime } from 'virtual:@awacloud/fw/preset/site-interactive';
const hex = runtime.resolve('hex');

Navigation map

Generated API reference (HTML, exhaustive signatures from types): bun run docs:api → docs/api-generated/ (generated on demand, distinct from the editorial pages docs/api/). See ../integrations/typedoc.

All modules

Key concepts

• The module pattern (pure factory) — including version (semver) and type (taxonomy) validated at register
• Using workers
• Rendering pipeline
• Security (sanity)

Multi-version & discovery (runtime)

runtime natively supports multi-version coexistence of the same name: resolve('foo') returns the highest version (semver); resolve('foo@1.0.0') returns the exact version. runtime.list({type, name, version}) enables filtered discovery. See ModuleRuntime API.

Contributing a module

• Full workflow — step-by-step plan (discovery → implementation → tests → doc → README cascade)
• Test format
• Documentation format