example.learning-journey-registry
Registry that aggregates learning journey example tracks.
@lssm-tech/example.learning-journey-registrybun add @lssm-tech/example.learning-journey-registryManifest 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 devbun run buildbun run testbun 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.tsis part of the package's public or composition surface.src/api.test.tsis part of the package's public or composition surface.src/api.tsis part of the package's public or composition surface.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/index.tsis the root public barrel and package entrypoint.src/learning-journey-registry.feature.tsdefines a feature entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./apiresolves through./src/api.ts. - Export
./api-typesresolves through./src/api-types.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/learning-journey-registry.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./learning-journey-registry.featureresolves through./src/learning-journey-registry.feature.ts. - Export
./presentationsresolves through./src/presentations/index.ts. - Export
./progress-storeresolves through./src/progress-store.ts. - Export
./tracksresolves 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 devbun run build— contractspec-bun-build buildbun run test— bun testbun 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 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/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
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
15 declarations
@lssm-tech/example.learning-journey-ambient-coachworkspace:^
Read the package manual ↗@lssm-tech/example.learning-journey-crm-onboardingworkspace:^
Read the package manual ↗@lssm-tech/example.learning-journey-duo-drillsworkspace:^
Read the package manual ↗@lssm-tech/example.learning-journey-platform-tourworkspace:^
Read the package manual ↗@lssm-tech/example.learning-journey-quest-challengesworkspace:^
Read the package manual ↗@lssm-tech/example.learning-journey-studio-onboardingworkspace:^
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:fixtestbun testlint: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 --noEmit