Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.versioned-knowledge-base

Example: curated, versioned knowledge base with immutable sources, rule versions, and published snapshots.

examplesexamplev5.0.4stableservernode
@lssm-tech/example.versioned-knowledge-base
bun add @lssm-tech/example.versioned-knowledge-base
Package source ↗Manifest ↗

Manifest 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 migration export via KnowledgeSnapshotPublicationMigration.
  • 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 dev
  • bun run build
  • bun run test
  • bun 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.ts is package-level event definitions.
  • src/example.ts is the runnable example entrypoint.
  • src/handlers/ contains handlers or demo adapters wired to contract surfaces.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/knowledge-snapshot-publication.migration.ts defines the exported migration spec.
  • src/operations is part of the package's public or composition surface.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/versioned-knowledge-base.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./entities resolves through ./src/entities/index.ts.
  • Export ./entities/models resolves through ./src/entities/models.ts.
  • Export ./events resolves through ./src/events.ts.
  • Export ./example resolves through ./src/example.ts.
  • Export ./handlers resolves through ./src/handlers/index.ts.
  • Export ./handlers/memory.handlers resolves through ./src/handlers/memory.handlers.ts.
  • Export ./knowledge-snapshot-publication.migration resolves through ./src/knowledge-snapshot-publication.migration.ts.
  • Export ./operations resolves through ./src/operations/index.ts.
  • Export ./operations/kb resolves through ./src/operations/kb.ts.
  • Export ./versioned-knowledge-base.feature resolves 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 dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test
  • 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.
  • Missing contract layers.

Notes

  • Works alongside @lssm-tech/lib.contracts-spec, @lssm-tech/lib.schema, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.

Relationships

THIS PACKAGEexample.versioned-knowledge-base13 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

2 declarations

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 --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .
  • lint:checknode ../../scripts/biome.cjs check .
  • testbun test
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit