Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.companyos-voiceops-workbench

Deterministic CompanyOS VoiceOps workbench example adapted from the Hackathon Voice AI UI/UX ingest lane.

examplesexamplev2.0.5experimentalservernode
@lssm-tech/example.companyos-voiceops-workbench
bun add @lssm-tech/example.companyos-voiceops-workbench
Package source ↗Manifest ↗

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

Package guide

Deterministic example package for Hackathon Voice AI web-app parity inside the CompanyOS examples registry.

The package adapts the hackathon app's product shape into a safe, provider-free CompanyOS preview. VoiceOpsWorkbenchPreview now renders a package-local app shell with deterministic screen navigation for Workbench, Company, Work, Inbox, Integrations, Settings, Contracts, Receipt Viewer, and Receipt Verify. The Workbench screen keeps the core demo concepts together: source pills, redacted transcript replay, redaction proof, policy/action table, graph canvas, replay scrubber, receipt evidence, and an explicit live-mode-disabled safety banner.

This package intentionally does not ship live provider SDKs, API keys, production endpoints, generated media, raw quarantined source, browser audio capture, network behavior, or production writes. Live/provider ideas are represented only as fixture-backed disabled or reference-only view-model data.

Source traceability

The UI model records source-path references from the Hackathon Voice AI ingest lane, including original workbench panels such as TranscriptPanel.tsx, RedactionDiff.tsx, ReplayScrubber.tsx, ReceiptPanel.tsx, WorkTable.tsx, and the sixty-second demo spec. Conceptual screen-map material is marked reference-only, while live/provider controls such as LiveAudioRecorder.tsx and GradiumTtsButton.tsx are marked rejected-live so hosts can audit parity without executing unsafe behavior.

Public surface

  • VoiceOpsWorkbenchPreview remains the public preview entrypoint.
  • initialScreenId can render any deterministic app-shell screen for tests or host previews.
  • voiceOpsWorkbenchFixture contains all screen, contract, approval, receipt, graph, replay, provider-readiness, and source-reference data.

Safety boundary

All behavior is fixture/view-model only. Browser audio capture, speech recognition, live model/provider calls, router dependencies, environment reads, network requests, and production writes are represented as disabled explanatory cards rather than executable code.

Future fixture changes should keep each adapted concept source-traceable and should classify unsafe/live-only files as reference-only or rejected rather than executable package behavior. Examples of unsafe/live-only concepts include live audio recorders, provider test buttons, provider runtime wiring, environment/configuration files, production URLs, and credential-bearing readiness checks.

Public exports

Preserve these package exports when evolving the example:

  • CompanyOsVoiceOpsWorkbenchExample
  • voiceOpsWorkbenchFixture
  • VoiceOpsWorkbenchPreview
  • ./fixtures
  • ./ui
  • ./ui/VoiceOpsWorkbenchPreview

Additive fixture/type growth is preferred so downstream registry and sandbox consumers can keep importing the existing surface.

Verification commands

Run package-local checks before claiming changes:

bash
bun run typecheck
bun run test
bun run smoke
bun run lint:check

If example metadata or exported registry fields change, also regenerate/check the examples registry from the repository root.

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.

Relationships

THIS PACKAGEexample.companyos-voiceops-workbench7 import paths

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

4 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/example.smoke.test.ts
  • lint:checknode ../../scripts/biome.cjs check .
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write .
  • preflightbun run build && bun run typecheck && bun run test && bun run smoke
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types