example.team-hub
Team Hub example with spaces, tasks, rituals, and announcements
examplesexamplev5.0.4stableservernode
@lssm-tech/example.team-hubbun add @lssm-tech/example.team-hubManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Team Hub example with spaces, tasks, rituals, and announcements.
What This Demonstrates
- Multi-entity team collaboration domain (space, task, ritual, announcement).
- Per-entity schema and operations pattern.
- Capability and feature definition patterns.
- Presentation layer with team-hub presentation.
src/docs/contains docblocks and documentation-facing exports.src/handlers/contains handlers or demo adapters wired to contract surfaces.
Running Locally
From examples/team-hub:
bun run devbun run buildbun run typecheckbun run test
Usage
Use @lssm-tech/example.team-hub as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/announcementis 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
./announcementresolves through./src/announcement/index.ts. - Export
./announcement/announcement.operationsresolves through./src/announcement/announcement.operations.ts. - Export
./announcement/announcement.schemaresolves through./src/announcement/announcement.schema.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/team-hub.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 23 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
THIS PACKAGEexample.team-hub23 import paths
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
2 declarations
@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-specworkspace:^
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 .prebuildcontractspec-bun-build prebuildtypechecktsgo --noEmittestbun test