module.learning-journey
Comprehensive learning journey engine - onboarding, LMS, flashcards, gamification, and AI personalization
@lssm-tech/module.learning-journeybun add @lssm-tech/module.learning-journeyManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Canonical adaptive journey runtime for onboarding, drills, coaching, LMS, flashcards, gamification, and AI personalization.
What It Provides
- Layer: module.
- Consumers: bundles (library, contractspec-studio), apps (web-landing).
src/contracts/contains contract specs, operations, entities, and registry exports.src/docs/contains docblocks and documentation-facing exports.
Installation
npm install @lssm-tech/module.learning-journey
or
bun add @lssm-tech/module.learning-journey
Usage
Import the root entrypoint from @lssm-tech/module.learning-journey, or choose a documented subpath when you only need one part of the package surface.
Existing StreakEngine, XPEngine, singleton, root, and engine-subpath exports remain unchanged. The ./engines surface also provides adapters for projecting legacy Date-based learning state and XP receipts into the storage-neutral @lssm-tech/lib.gamification-runtime shapes.
Use ./engines/gamification-progress-adapters to serialize and restore the unchanged JourneyProgressState shape without losing its Date fields. These adapters do not alter legacy timezone, streak, or XP rounding behavior.
Creator training can use ./contracts/competencies and ./runtime/competencies for evidence-backed mastery projections, plus ./contracts/coaching and ./runtime/coaching for contestable assistive coaching proposals. These projections never grant product authority.
Architecture
src/contracts/contains contract specs, operations, entities, and registry exports.src/docs/contains docblocks and documentation-facing exports.src/enginesis part of the package's public or composition surface.src/entities/contains domain entities and value objects.src/events.tsis package-level event definitions.src/i18nis part of the package's public or composition surface.src/index.tsis the root public barrel and package entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./contractsresolves through./src/contracts/index.ts. - Export
./contracts/coachingresolves through./src/contracts/coaching.ts. - Export
./contracts/competenciesresolves through./src/contracts/competencies.ts. - Export
./contracts/modelsresolves through./src/contracts/models.ts. - Export
./contracts/journeyresolves through./src/contracts/journey.ts. - Export
./contracts/onboardingresolves through./src/contracts/onboarding.ts. - Export
./contracts/operationsresolves through./src/contracts/operations.ts. - Export
./contracts/sharedresolves through./src/contracts/shared.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/learning-journey.docblockresolves through./src/docs/learning-journey.docblock.ts. - Export
./enginesresolves through./src/engines/index.ts. - Export
./engines/gamification-adaptersresolves through./src/engines/gamification-adapters.ts. - Export
./engines/gamification-progress-adaptersresolves through./src/engines/gamification-progress-adapters.ts. - Export
./engines/srsresolves through./src/engines/srs.ts. - Export
./runtimeresolves through./src/runtime/index.ts. - Export
./runtime/coachingresolves through./src/runtime/coaching.ts. - Export
./runtime/competenciesresolves through./src/runtime/competencies.ts. - Export
./runtime/onboarding-runtimeresolves through./src/runtime/onboarding-runtime.ts. - The package publishes 41 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.
- Add full i18n support across all 10 packages (en/fr/es, 460 keys).
Notes
- SRS/streak/XP engines are pure functions -- keep them side-effect-free.
- i18n catalogs must stay in sync across all supported locales (en, es, fr).
- Entity schemas are shared with the UI; breaking changes propagate to all learning surfaces.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
7 declarations
@lssm-tech/lib.gamification-runtimeworkspace:^
Read the package manual ↗@lssm-tech/lib.gamification-specworkspace:^
Read the package manual ↗@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-spec-coreworkspace:^
Read the package manual ↗@lssm-tech/lib.surface-runtimeworkspace:^
Read the package manual ↗@lssm-tech/lib.translation-runtimeworkspace:^
Read the package manual ↗
Declared capabilities
Comprehensive learning journey engine - onboarding, LMS, flashcards, gamification, and AI personalization
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 .testbun testprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit