Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.communication-os

Standalone CommunicationOS examples, fixtures, and replay proof for external adopter flows.

examplesexamplev3.0.6stableservernode
@lssm-tech/example.communication-os
bun add @lssm-tech/example.communication-os
Package source ↗Manifest ↗

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

Package guide

Standalone CommunicationOS examples, fixtures, replay proof, and composition adapters. This package consumes public CommunicationOS surfaces as an adopter would, keeps example data out of the module package, and imports reusable UI from @lssm-tech/module.communication-os/ui.

Entry Points

  • .
  • ./docs
  • ./example
  • ./examples
  • ./fixtures
  • ./proof
  • ./contracts
  • ./handlers
  • ./ui
  • ./ui/CommunicationOsPreview
  • ./ui/communication-os-preview.data
  • ./ui/communication-os.types
  • ./communication-os.feature

Preview / export workflow

CommunicationOS preview work must keep this package as the source of truth for example fixtures and replay proof. Public preview discovery requires compatible ./example, ./docs, ./examples, ./fixtures, and ./proof publish exports before an inline ./ui surface can be generated.

./ui is a thin example adapter: it builds deterministic local communication fixture data and passes it into @lssm-tech/module.communication-os/ui. Adapter tests assert that actions/drafts remain review-gated and fixture-owned. Do not duplicate reusable screen components here and do not move example data back into the module package.

The adapter also mounts the CommunicationOS translation catalog, because the reusable module UI reads its copy through useI18n and never mounts a provider. It follows the host's active locale (en, fr, es) and falls back to the host translator for keys it does not own, so the preview shows real copy instead of commOs.* keys in any host. Once the preview has mounted on the client, its root carries data-communication-os-preview-ready="true"; hosts and browser tests wait for it before interacting. The Compose policy ribbon evaluates the draft body 300 ms after the last edit and evaluates each body once.

The replay proof also covers command-inbox fail-closed behavior: blocked send commands become persisted inbox evidence with no outbound message, provider call, credential access, shell execution, or external mutation.

Operation keys

Contracts use the canonical communication.* keys. The 23 keys renamed from communicationOs.* stay resolvable as meta.aliases: OperationSpecRegistry.get('communicationOs.inbox.list') returns the communication.inbox.list operation and its bound handler. Each operation is registered once under its canonical key, and the MCP manifest lists canonical keys only. Move direct callers to communication.*.

Commands

  • bun run test
  • bun run typecheck
  • bun run build
  • bun run lint:check

VoiceOps fixture integration

This example now carries a voiceSignal summary through the reusable CommunicationOS module UI. The fixture models the Rivage Retail voice escalation from the hackathon proof as CommunicationOS evidence first: redacted source text, blocked customer-promise language, and a receipt reference. The example still imports only public module surfaces and remains provider-free.

Declaration publication uses contractspec-bun-build types through build:types; build runs bundle and declaration generation. The build config preserves declared exports and excludes test-only files from generated build artifacts. Package tests and typecheck remain separate verification gates.

Full build regenerates JavaScript and declarations in one output transaction, restoring previous dist if either stage fails. Standalone build:bundle still preserves declarations; use full build to reconcile obsolete output layouts.

Relationships

THIS PACKAGEexample.communication-os14 import paths

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

8 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • buildcontractspec-bun-build build
  • typechecktsgo --noEmit
  • testbun test
  • smokebun test src/communication-os.example.smoke.test.ts
  • lint:checknode ../../scripts/biome.cjs check .
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write .
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types