Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.policy-safe-knowledge-assistant

All-in-one template example: policy-safe knowledge assistant with locale/jurisdiction gating, versioned KB snapshots, HITL update pipeline, and learning hub.

examplesexamplev5.0.5stableservernode
@lssm-tech/example.policy-safe-knowledge-assistant
bun add @lssm-tech/example.policy-safe-knowledge-assistant
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

All-in-one template example: policy-safe knowledge assistant with locale/jurisdiction gating, versioned KB snapshots, HITL update pipeline, and learning hub.

What This Demonstrates

  • Composition of multiple example packages into a full-stack assistant.
  • Orchestrator pattern (buildAnswer) for policy-gated responses.
  • React dashboard with hooks and UI components.
  • Seed data and fixture patterns.
  • Feature definition aggregating sub-features.
  • src/docs/ contains docblocks and documentation-facing exports.

Running Locally

From examples/policy-safe-knowledge-assistant:

  • bun run dev
  • bun run build
  • bun run test
  • bun run typecheck

Usage

Use @lssm-tech/example.policy-safe-knowledge-assistant 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/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/integration.test.ts is part of the package's public or composition surface.
  • src/orchestrator is part of the package's public or composition surface.
  • src/policy-safe-knowledge-assistant.feature.ts defines a feature entrypoint.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/policy-safe-knowledge-assistant.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./example resolves through ./src/example.ts.
  • Export ./handlers resolves through ./src/handlers/index.ts.
  • Export ./handlers/policy-safe-knowledge-assistant.handlers resolves through ./src/handlers/policy-safe-knowledge-assistant.handlers.ts.
  • Export ./orchestrator/buildAnswer resolves through ./src/orchestrator/buildAnswer.ts.
  • Export ./policy-safe-knowledge-assistant.feature resolves through ./src/policy-safe-knowledge-assistant.feature.ts.
  • Export ./seed resolves through ./src/seed/index.ts.
  • Export ./seed/fixtures resolves through ./src/seed/fixtures.ts.
  • The package publishes 14 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/example.kb-update-pipeline, @lssm-tech/example.learning-patterns, @lssm-tech/example.locale-jurisdiction-gate, @lssm-tech/example.versioned-knowledge-base, @lssm-tech/lib.contracts-spec, ...

Relationships

THIS PACKAGEexample.policy-safe-knowledge-assistant14 import paths

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

12 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