lib.overlay-engine
Runtime overlay engine for ContractSpec personalization and adaptive UI rendering.
@lssm-tech/lib.overlay-enginebun add @lssm-tech/lib.overlay-engineManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
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.tsis the root public barrel and package entrypoint.src/merger.tsis part of the package's public or composition surface.src/react.tsis part of the package's public or composition surface.src/registry.tsis part of the package's public or composition surface.src/runtime.tsis part of the package's public or composition surface.src/signer.tsis part of the package's public or composition surface.src/spec.tsis part of the package's public or composition surface.src/types.tsis shared public type definitions.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./mergerresolves through./src/merger.ts. - Export
./reactresolves through./src/react.ts. - Export
./registryresolves through./src/registry.ts. - Export
./runtimeresolves through./src/runtime.ts. - Export
./signerresolves through./src/signer.ts. - Export
./specresolves through./src/spec.ts. - Export
./typesresolves through./src/types.ts. - Export
./validatorresolves through./src/validator.ts.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun test --pass-with-no-testsbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun 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.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
2 declarations
@lssm-tech/lib.contracts-spec-coreworkspace:^
Read the package manual ↗fast-json-stable-stringify^2.1.0
Declared capabilities
Runtime overlay engine for ContractSpec personalization and adaptive UI rendering.
Scripts
publish:pkgbun publish --tolerate-republish --ignore-scripts --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanrimraf dist .turbolintbun lint:fixlint:fixnode ../../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../../scripts/biome.cjs check --write .lint:checknode ../../../../scripts/biome.cjs check .testbun test --pass-with-no-testsprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit