Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.crm-pipeline

CRM Pipeline - Contacts, Companies, Deals, Tasks

examplesexamplev5.0.5stableservernode
@lssm-tech/example.crm-pipeline
bun add @lssm-tech/example.crm-pipeline
Package source ↗Manifest ↗

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

Package guide

Website: https://contractspec.io

CRM Pipeline - Contacts, Companies, Deals, Tasks.

What This Demonstrates

  • Multi-entity domain model (Contact, Company, Deal, Task).
  • Deal pipeline with stage enums, operations, and test-specs.
  • Event-driven architecture (contact, deal, task events).
  • Presentation layer with dashboard and pipeline views.
  • React UI with pipeline board, hooks, modals, overlays, renderers, and a server-mode shared DataTable for deals.
  • Shared table capabilities including sorting, pagination, multi-row selection, column visibility, pinning, resizing, and expandable deal details.
  • Feature definition and capability pattern.
  • Seeders and mock data.
  • LinkedIn contact and company URL storage as a downstream example. Production ingestion uses the governed externalProfiles contract from @lssm-tech/lib.contracts-integrations/integrations/providers/crm; the example is not the LinkedIn integration implementation.

Running Locally

From examples/crm-pipeline:

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

Usage

Use @lssm-tech/example.crm-pipeline as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.

Architecture

  • src/crm-pipeline.feature.ts defines a feature entrypoint.
  • src/deal is 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 is part of the package's public or composition surface.
  • src/example.ts is the runnable example entrypoint.
  • src/handlers/ contains handlers or demo adapters wired to contract surfaces.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./crm-pipeline.feature resolves through ./src/crm-pipeline.feature.ts.
  • Export ./deal resolves through ./src/deal/index.ts.
  • Export ./deal/deal.enum resolves through ./src/deal/deal.enum.ts.
  • Export ./deal/deal.operation resolves through ./src/deal/deal.operation.ts.
  • Export ./deal/deal.schema resolves through ./src/deal/deal.schema.ts.
  • Export ./deal/deal.test-spec resolves through ./src/deal/deal.test-spec.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/crm-pipeline.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./entities resolves through ./src/entities/index.ts.
  • The package publishes 44 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 --pass-with-no-tests
  • 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 validate — contractspec validate "src/*/"
  • 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.design-system, @lssm-tech/lib.example-shared-ui, @lssm-tech/lib.identity-rbac, @lssm-tech/lib.runtime-sandbox, ...

Relationships

THIS PACKAGEexample.crm-pipeline45 import paths

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

13 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 --pass-with-no-tests
  • validatecontractspec validate "src/**/*"
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit