example.versioned-knowledge-base
Example: curated, versioned knowledge base with immutable sources, rule versions, and published snapshots.
@lssm-tech/example.versioned-knowledge-basebun add @lssm-tech/example.versioned-knowledge-baseManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Example: curated, versioned knowledge base with immutable sources, rule versions, and published snapshots.
What This Demonstrates
- Immutable source and versioned rule management.
- Snapshot publishing pattern.
- Canonical
migrationexport viaKnowledgeSnapshotPublicationMigration. - Entity models for KB domain.
- Memory-based handler implementation.
- Feature definition and event-driven architecture.
src/docs/contains docblocks and documentation-facing exports.
Running Locally
From examples/versioned-knowledge-base:
bun run devbun run buildbun run testbun run typecheck
Usage
Use @lssm-tech/example.versioned-knowledge-base as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/docs/contains docblocks and documentation-facing exports.src/entities/contains domain entities and value objects.src/events.tsis package-level event definitions.src/example.tsis the runnable example entrypoint.src/handlers/contains handlers or demo adapters wired to contract surfaces.src/index.tsis the root public barrel and package entrypoint.src/knowledge-snapshot-publication.migration.tsdefines the exported migration spec.src/operationsis part of the package's public or composition surface.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/versioned-knowledge-base.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./entitiesresolves through./src/entities/index.ts. - Export
./entities/modelsresolves through./src/entities/models.ts. - Export
./eventsresolves through./src/events.ts. - Export
./exampleresolves through./src/example.ts. - Export
./handlersresolves through./src/handlers/index.ts. - Export
./handlers/memory.handlersresolves through./src/handlers/memory.handlers.ts. - Export
./knowledge-snapshot-publication.migrationresolves through./src/knowledge-snapshot-publication.migration.ts. - Export
./operationsresolves through./src/operations/index.ts. - Export
./operations/kbresolves through./src/operations/kb.ts. - Export
./versioned-knowledge-base.featureresolves through./src/versioned-knowledge-base.feature.ts. - The package publishes 12 total export subpaths; keep docs aligned with
package.json.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun testbun 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.
- Missing contract layers.
Notes
- Works alongside
@lssm-tech/lib.contracts-spec,@lssm-tech/lib.schema,@lssm-tech/tool.bun,@lssm-tech/tool.typescript.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
2 declarations
@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗
Declared capabilities
This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.
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 testprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit