lib.overlay-engine

@lssm-tech/lib.overlay-engine

Website: https://contractspec.io

Runtime overlay engine for ContractSpec personalization and adaptive UI rendering.

What It Provides

• Layer: lib.
• Consumers: personalization, example-shared-ui, bundles.
• Related ContractSpec packages include @lssm-tech/lib.contracts-spec, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.
• Related ContractSpec packages include @lssm-tech/lib.contracts-spec, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.

Installation

npm install @lssm-tech/lib.overlay-engine

or

bun add @lssm-tech/lib.overlay-engine

Usage

Import the root entrypoint from @lssm-tech/lib.overlay-engine, or choose a documented subpath when you only need one part of the package surface.

Architecture

• src/index.ts is the root public barrel and package entrypoint.
• src/merger.ts is part of the package's public or composition surface.
• src/react.ts is part of the package's public or composition surface.
• src/registry.ts is part of the package's public or composition surface.
• src/runtime.ts is part of the package's public or composition surface.
• src/signer.ts is part of the package's public or composition surface.
• src/spec.ts is part of the package's public or composition surface.
• src/types.ts is shared public type definitions.

Public Entry Points

• Export . resolves through ./src/index.ts.
• Export ./merger resolves through ./src/merger.ts.
• Export ./react resolves through ./src/react.ts.
• Export ./registry resolves through ./src/registry.ts.
• Export ./runtime resolves through ./src/runtime.ts.
• Export ./signer resolves through ./src/signer.ts.
• Export ./spec resolves through ./src/spec.ts.
• Export ./types resolves through ./src/types.ts.
• Export ./validator resolves through ./src/validator.ts.

Local Commands

• bun run dev — contractspec-bun-build dev
• bun run build — contractspec-bun-build build
• bun run test — bun test --pass-with-no-tests
• bun run lint — bun lint:fix
• bun run lint:check — biome check .
• bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
• bun run typecheck — tsgo --noEmit
• bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
• bun run publish:pkg:canary — bun publish:pkg --tag canary
• bun run clean — rimraf dist .turbo
• bun run build:bundle — contractspec-bun-build transpile
• bun run build:types — contractspec-bun-build types
• bun run prebuild — contractspec-bun-build prebuild

Recent Updates

• Replace eslint+prettier by biomejs to optimize speed.

Notes

• Overlay spec schema is a contract — changes are breaking for all consumers.
• Signer must preserve cryptographic integrity; do not alter signing algorithm without migration.
• Merger logic must be idempotent — applying the same overlay twice must produce identical results.

Canonical portable contract ownership

The complete Overlay engine keeps its existing spec, registry, merger, signer, runtime and React interfaces. Its operation model, feature constructor and DocBlock type use the existing portable Core owner. This compatible ownership cut changes only the three contract imports and their declared dependency; signature verification, canonicalization, scope order, merge order, errors, defaults and audit callbacks retain their original implementations. All ten Source roots and their publication conditions remain unchanged. Task-bound adoption, fresh producer/declaration and affected consumer qualification are required before campaign acceptance; this Source candidate does not qualify cryptographic or runtime behavior.