Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.locale-jurisdiction-gate

Example: enforce locale + jurisdiction + kbSnapshotId + allowed scope for assistant calls (fail-closed).

examplesexamplev5.0.4stableservernode
@lssm-tech/example.locale-jurisdiction-gate
bun add @lssm-tech/example.locale-jurisdiction-gate
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: enforce locale + jurisdiction + kbSnapshotId + allowed scope for assistant calls (fail-closed).

What This Demonstrates

  • Canonical policy export via AssistantGatePolicy.
  • Canonical form export via AssistantContextForm.
  • Canonical translation exports for en-US, en-GB, and fr-FR.
  • Fail-closed policy guard pattern for AI assistant calls.
  • Entity models for locale/jurisdiction gating.
  • Event-driven policy enforcement.
  • Handler and operation separation with typed operations.
  • Feature definition pattern.
  • src/docs/ contains docblocks and documentation-facing exports.

Running Locally

From examples/locale-jurisdiction-gate:

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

Usage

Use @lssm-tech/example.locale-jurisdiction-gate 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/forms/ contains the exported assistant context form spec.
  • src/handlers/ contains handlers or demo adapters wired to contract surfaces.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/locale-jurisdiction-gate.feature.ts defines a feature entrypoint.
  • src/translations/ contains the exported locale catalogs.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/locale-jurisdiction-gate.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 ./forms resolves through ./src/forms/index.ts.
  • Export ./forms/assistant-context.form resolves through ./src/forms/assistant-context.form.ts.
  • Export ./handlers resolves through ./src/handlers/index.ts.
  • Export ./handlers/demo.handlers resolves through ./src/handlers/demo.handlers.ts.
  • Export ./locale-jurisdiction-gate.feature resolves through ./src/locale-jurisdiction-gate.feature.ts.
  • Export ./policy/assistant-gate.policy resolves through ./src/policy/assistant-gate.policy.ts.
  • Export ./translations resolves through ./src/translations/index.ts.
  • Export ./translations/assistant-gate.en-GB.translation resolves through ./src/translations/assistant-gate.en-GB.translation.ts.
  • Export ./translations/assistant-gate.en-US.translation resolves through ./src/translations/assistant-gate.en-US.translation.ts.
  • Export ./translations/assistant-gate.fr-FR.translation resolves through ./src/translations/assistant-gate.fr-FR.translation.ts.
  • The package publishes 21 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.locale-jurisdiction-gate22 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