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.
@lssm-tech/example.policy-safe-knowledge-assistantbun add @lssm-tech/example.policy-safe-knowledge-assistantManifest 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 devbun run buildbun run testbun 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.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/integration.test.tsis part of the package's public or composition surface.src/orchestratoris part of the package's public or composition surface.src/policy-safe-knowledge-assistant.feature.tsdefines a feature entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/policy-safe-knowledge-assistant.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./handlersresolves through./src/handlers/index.ts. - Export
./handlers/policy-safe-knowledge-assistant.handlersresolves through./src/handlers/policy-safe-knowledge-assistant.handlers.ts. - Export
./orchestrator/buildAnswerresolves through./src/orchestrator/buildAnswer.ts. - Export
./policy-safe-knowledge-assistant.featureresolves through./src/policy-safe-knowledge-assistant.feature.ts. - Export
./seedresolves through./src/seed/index.ts. - Export
./seed/fixturesresolves 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 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/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
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
12 declarations
@lssm-tech/example.kb-update-pipelineworkspace:^
Read the package manual ↗@lssm-tech/example.learning-patternsworkspace:^
Read the package manual ↗@lssm-tech/example.locale-jurisdiction-gateworkspace:^
Read the package manual ↗@lssm-tech/example.versioned-knowledge-baseworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.design-systemworkspace:^
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