Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.learning-journey-registry

Registry that aggregates learning journey example tracks.

examplesexamplev6.0.4stableservernode
@lssm-tech/example.learning-journey-registry
bun add @lssm-tech/example.learning-journey-registry
Package source ↗Manifest ↗

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

Package guide

Website: https://contractspec.io

Registry that aggregates learning journey example tracks.

What This Demonstrates

  • Track aggregation and discovery via a central registry.
  • Feature definition pattern (learning-journey-registry.feature).
  • Progress store for cross-track state.
  • API and API-types separation for typed endpoints.
  • Presentation layer with LearningMiniApp UI.
  • src/docs/ contains docblocks and documentation-facing exports.

Running Locally

From examples/learning-journey-registry:

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

Usage

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

Architecture

  • src/api-types.ts is part of the package's public or composition surface.
  • src/api.test.ts is part of the package's public or composition surface.
  • src/api.ts is part of the package's public or composition surface.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/example.ts is the runnable example entrypoint.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/learning-journey-registry.feature.ts defines a feature entrypoint.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./api resolves through ./src/api.ts.
  • Export ./api-types resolves through ./src/api-types.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/learning-journey-registry.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./example resolves through ./src/example.ts.
  • Export ./learning-journey-registry.feature resolves through ./src/learning-journey-registry.feature.ts.
  • Export ./presentations resolves through ./src/presentations/index.ts.
  • Export ./progress-store resolves through ./src/progress-store.ts.
  • Export ./tracks resolves through ./src/tracks.ts.
  • The package publishes 12 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
  • 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 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/example.learning-journey-ambient-coach, @lssm-tech/example.learning-journey-crm-onboarding, @lssm-tech/example.learning-journey-duo-drills, @lssm-tech/example.learning-journey-platform-tour, @lssm-tech/example.learning-journey-quest-challenges, ...

Relationships

THIS PACKAGEexample.learning-journey-registry15 import paths

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

15 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
  • testbun test
  • lint: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 prebuild
  • typechecktsgo --noEmit