example.service-business-os
Service Business OS example (clients, quotes, jobs, invoices) for ContractSpec
@lssm-tech/example.service-business-osbun add @lssm-tech/example.service-business-osManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Service Business OS example (clients, quotes, jobs, invoices) for ContractSpec.
What This Demonstrates
- Multi-entity domain modeling (client, quote, job, invoice, payment).
- Per-entity schema and operations pattern.
- Capability and feature definition patterns.
- Presentation layer and event-driven architecture.
- Handler aggregation.
src/docs/contains docblocks and documentation-facing exports.
Preview / export workflow
Service Business OS already publishes ./presentations for deterministic service-business screens. The package-native ./ui preview wraps service-business panels in the shared NestedCommandShell from @lssm-tech/lib.example-shared-ui; keep compatible inline preview work on that reusable nested-safe shell and use an explicitly approved module/examples presentation renderer only when the registry owns the replay adapter.
Keep preview data local and deterministic across client, quote, job, invoice, and payment states. Docs, sandbox, LLMS, and source fallback links should remain visible even when a host renders the richer inline preview.
Running Locally
From examples/service-business-os:
bun run devbun run buildbun run typecheckbun run test
Usage
Use @lssm-tech/example.service-business-os as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/clientis part of the package's public or composition surface.src/docs/contains docblocks and documentation-facing exports.src/entities/contains domain entities and value objects.src/events.tsis package-level event definitions.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.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./clientresolves through./src/client/index.ts. - Export
./client/client.operationsresolves through./src/client/client.operations.ts. - Export
./client/client.schemaresolves through./src/client/client.schema.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/service-business-os.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./entitiesresolves through./src/entities/index.ts. - Export
./eventsresolves through./src/events.ts. - Export
./exampleresolves through./src/example.ts. - Export
./handlersresolves through./src/handlers/index.ts. - The package publishes 26 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 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 test— bun testbun 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/lib.contracts-spec,@lssm-tech/lib.schema,@lssm-tech/tool.bun,@lssm-tech/tool.typescript.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
6 declarations
@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.design-systemworkspace:^
Read the package manual ↗@lssm-tech/lib.example-shared-uiworkspace:^
Read the package manual ↗reactcatalog:
react-domcatalog:
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 .prebuildcontractspec-bun-build prebuildtypechecktsgo --noEmittestbun test