@lssm/module.learning-journey 0.0.0-canary-20251217054315 → 0.0.0-canary-20251217060433

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { LEARNING_JOURNEY_OWNERS } from "./contracts/shared.js";
+import { AchievementModel, CardModel, CompleteLessonInput, CourseModel, DeckModel, EnrollInCourseInput, EnrollmentModel, GetDueCardsInput, GetDueCardsOutput, GetLearnerDashboardInput, LearnerDashboardModel, LearnerModel, ProgressModel, SubmitCardReviewInput, SuccessOutput } from "./contracts/models.js";
+import { CompleteLessonContract, EnrollInCourseContract, GetDueCardsContract, GetLearnerDashboardContract, SubmitCardReviewContract } from "./contracts/operations.js";
+import { GetOnboardingProgressContract, ListOnboardingTracksContract, OnboardingProgressModel, OnboardingStepModel, OnboardingStepProgressModel, OnboardingTrackModel, RecordOnboardingEventContract } from "./contracts/onboarding.js";
+import "./contracts/index.js";
+import { CardRating, DEFAULT_SRS_CONFIG, ReviewResult, SRSConfig, SRSEngine, SRSState, srsEngine } from "./engines/srs.js";
+import { DEFAULT_XP_CONFIG, XPActivityType, XPBreakdown, XPCalculationInput, XPConfig, XPEngine, XPResult, xpEngine } from "./engines/xp.js";
+import { DEFAULT_STREAK_CONFIG, StreakConfig, StreakEngine, StreakState, StreakUpdateResult, streakEngine } from "./engines/streak.js";
+import { LearnerProfileEntity, LearningGapEntity, LearningPathEntity, LearningStyleEnum, RecommendationEntity, RecommendationTypeEnum, SkillMapEntity, aiEntities, aiEnums } from "./entities/ai.js";
+import { ContentTypeEnum, CourseDifficultyEnum, CourseEntity, CourseModuleEntity, CourseStatusEnum, LessonContentEntity, LessonEntity, LessonTypeEnum, courseEntities, courseEnums } from "./entities/course.js";
+import { CardEntity, CardRatingEnum, CardReviewEntity, CardScheduleEntity, DeckEntity, flashcardEntities, flashcardEnums } from "./entities/flashcard.js";
+import { AchievementEntity, AchievementTypeEnum, DailyGoalEntity, HeartEntity, LeaderboardEntryEntity, LeaderboardPeriodEnum, LearnerAchievementEntity, StreakEntity, XPTransactionEntity, gamificationEntities, gamificationEnums } from "./entities/gamification.js";
+import { CertificateEntity, EnrollmentEntity, EnrollmentStatusEnum, LearnerEntity, LessonProgressEntity, ModuleCompletionEntity, ProgressStatusEnum, learnerEntities, learnerEnums } from "./entities/learner.js";
+import { OnboardingProgressEntity, OnboardingStepCompletionEntity, OnboardingStepEntity, OnboardingStepStatusEnum, OnboardingTrackEntity, onboardingEntities, onboardingEnums } from "./entities/onboarding.js";
+import { AttemptStatusEnum, QuestionEntity, QuestionOptionEntity, QuestionTypeEnum, QuizAttemptEntity, QuizEntity, QuizStatusEnum, SkillAssessmentEntity, quizEntities, quizEnums } from "./entities/quiz.js";
+import { learningJourneyEntities, learningJourneyEnums, learningJourneySchemaContribution } from "./entities/index.js";
+import { AchievementUnlockedEvent, CardReviewedEvent, CertificateIssuedEvent, CourseCompletedEvent, CoursePublishedEvent, DailyGoalCompletedEvent, EnrollmentCreatedEvent, LearningJourneyEvents, LessonCompletedEvent, LevelUpEvent, OnboardingCompletedEvent, OnboardingStartedEvent, OnboardingStepCompletedEvent, QuizCompletedEvent, QuizStartedEvent, StreakUpdatedEvent, XpEarnedEvent } from "./events.js";
+import { BaseEventConditionSpec, CompletionRewardsSpec, CountCompletionConditionSpec, EventCompletionConditionSpec, LearningJourneyStepSpec, LearningJourneyTrackSpec, SrsMasteryCompletionConditionSpec, StepAvailabilitySpec, StepCompletionConditionSpec, StreakRuleSpec, TimeWindowCompletionConditionSpec } from "./track-spec.js";
+import { LearningJourneyFeature } from "./learning-journey.feature.js";
+export { AchievementEntity, AchievementModel, AchievementTypeEnum, AchievementUnlockedEvent, AttemptStatusEnum, BaseEventConditionSpec, CardEntity, CardModel, CardRating, CardRatingEnum, CardReviewEntity, CardReviewedEvent, CardScheduleEntity, CertificateEntity, CertificateIssuedEvent, CompleteLessonContract, CompleteLessonInput, CompletionRewardsSpec, ContentTypeEnum, CountCompletionConditionSpec, CourseCompletedEvent, CourseDifficultyEnum, CourseEntity, CourseModel, CourseModuleEntity, CoursePublishedEvent, CourseStatusEnum, DEFAULT_SRS_CONFIG, DEFAULT_STREAK_CONFIG, DEFAULT_XP_CONFIG, DailyGoalCompletedEvent, DailyGoalEntity, DeckEntity, DeckModel, EnrollInCourseContract, EnrollInCourseInput, EnrollmentCreatedEvent, EnrollmentEntity, EnrollmentModel, EnrollmentStatusEnum, EventCompletionConditionSpec, GetDueCardsContract, GetDueCardsInput, GetDueCardsOutput, GetLearnerDashboardContract, GetLearnerDashboardInput, GetOnboardingProgressContract, HeartEntity, LEARNING_JOURNEY_OWNERS, LeaderboardEntryEntity, LeaderboardPeriodEnum, LearnerAchievementEntity, LearnerDashboardModel, LearnerEntity, LearnerModel, LearnerProfileEntity, LearningGapEntity, LearningJourneyEvents, LearningJourneyFeature, LearningJourneyStepSpec, LearningJourneyTrackSpec, LearningPathEntity, LearningStyleEnum, LessonCompletedEvent, LessonContentEntity, LessonEntity, LessonProgressEntity, LessonTypeEnum, LevelUpEvent, ListOnboardingTracksContract, ModuleCompletionEntity, OnboardingCompletedEvent, OnboardingProgressEntity, OnboardingProgressModel, OnboardingStartedEvent, OnboardingStepCompletedEvent, OnboardingStepCompletionEntity, OnboardingStepEntity, OnboardingStepModel, OnboardingStepProgressModel, OnboardingStepStatusEnum, OnboardingTrackEntity, OnboardingTrackModel, ProgressModel, ProgressStatusEnum, QuestionEntity, QuestionOptionEntity, QuestionTypeEnum, QuizAttemptEntity, QuizCompletedEvent, QuizEntity, QuizStartedEvent, QuizStatusEnum, RecommendationEntity, RecommendationTypeEnum, RecordOnboardingEventContract, ReviewResult, SRSConfig, SRSEngine, SRSState, SkillAssessmentEntity, SkillMapEntity, SrsMasteryCompletionConditionSpec, StepAvailabilitySpec, StepCompletionConditionSpec, StreakConfig, StreakEngine, StreakEntity, StreakRuleSpec, StreakState, StreakUpdateResult, StreakUpdatedEvent, SubmitCardReviewContract, SubmitCardReviewInput, SuccessOutput, TimeWindowCompletionConditionSpec, XPActivityType, XPBreakdown, XPCalculationInput, XPConfig, XPEngine, XPResult, XPTransactionEntity, XpEarnedEvent, aiEntities, aiEnums, courseEntities, courseEnums, flashcardEntities, flashcardEnums, gamificationEntities, gamificationEnums, learnerEntities, learnerEnums, learningJourneyEntities, learningJourneyEnums, learningJourneySchemaContribution, onboardingEntities, onboardingEnums, quizEntities, quizEnums, srsEngine, streakEngine, xpEngine };

package/dist/learning-journey.feature.d.ts

@@ -0,0 +1,11 @@
+import { FeatureModuleSpec } from "@lssm/lib.contracts";
+
+//#region src/learning-journey.feature.d.ts
+
+/**
+ * Learning Journey feature module that bundles course enrollment,
+ * onboarding tracks, flashcard review, and gamification capabilities.
+ */
+declare const LearningJourneyFeature: FeatureModuleSpec;
+//#endregion
+export { LearningJourneyFeature };

package/dist/track-spec.d.ts

@@ -0,0 +1,128 @@
+//#region src/track-spec.d.ts
+interface BaseEventConditionSpec {
+  /**
+   * Required event name to satisfy the condition.
+   */
+  eventName: string;
+  /**
+   * Optional event version to match.
+   */
+  eventVersion?: number;
+  /**
+   * Optional source module to match (for disambiguation).
+   */
+  sourceModule?: string;
+  /**
+   * Optional payload filter (shallow equality on keys).
+   */
+  payloadFilter?: Record<string, unknown>;
+}
+interface EventCompletionConditionSpec extends BaseEventConditionSpec {
+  kind?: 'event';
+}
+interface CountCompletionConditionSpec extends BaseEventConditionSpec {
+  kind: 'count';
+  /**
+   * Minimum number of matching events required to complete the step.
+   */
+  atLeast: number;
+  /**
+   * Optional time window (hours) from track start for counting.
+   */
+  withinHours?: number;
+}
+interface TimeWindowCompletionConditionSpec extends BaseEventConditionSpec {
+  kind: 'time_window';
+  /**
+   * Must be completed within this window (hours) from track start.
+   */
+  withinHoursOfStart?: number;
+  /**
+   * Optional additional delay before the step becomes available (hours).
+   */
+  availableAfterHours?: number;
+}
+interface SrsMasteryCompletionConditionSpec {
+  kind: 'srs_mastery';
+  /**
+   * Event carrying mastery info (defaults to drill/flashcard mastery events).
+   */
+  eventName: string;
+  /**
+   * Payload key containing skill identifier; defaults to `skillId`.
+   */
+  skillIdField?: string;
+  /**
+   * Payload key containing mastery value; defaults to `mastery`.
+   */
+  masteryField?: string;
+  /**
+   * Minimum mastery value required (e.g., 0-1 or a numeric level).
+   */
+  minimumMastery: number;
+  /**
+   * Optional number of mastered cards required to complete step.
+   */
+  requiredCount?: number;
+  /**
+   * Optional payload filter.
+   */
+  payloadFilter?: Record<string, unknown>;
+}
+type StepCompletionConditionSpec = EventCompletionConditionSpec | CountCompletionConditionSpec | TimeWindowCompletionConditionSpec | SrsMasteryCompletionConditionSpec;
+interface StepAvailabilitySpec {
+  /**
+   * Unlock step after a delay (hours) from track start.
+   */
+  unlockAfterHours?: number;
+  /**
+   * Unlock on a specific day from track start (day 1 = start day).
+   */
+  unlockOnDay?: number;
+  /**
+   * Optional due window (hours) from unlock; if exceeded, step is considered missed.
+   */
+  dueWithinHours?: number;
+}
+interface StreakRuleSpec {
+  hoursWindow?: number;
+  bonusXp?: number;
+}
+interface CompletionRewardsSpec {
+  xpBonus?: number;
+  badgeKey?: string;
+}
+interface LearningJourneyStepSpec {
+  id: string;
+  title: string;
+  description?: string;
+  instructions?: string;
+  helpUrl?: string;
+  order?: number;
+  completion: StepCompletionConditionSpec;
+  availability?: StepAvailabilitySpec;
+  xpReward?: number;
+  isRequired?: boolean;
+  canSkip?: boolean;
+  actionUrl?: string;
+  actionLabel?: string;
+  metadata?: Record<string, unknown>;
+}
+interface LearningJourneyTrackSpec {
+  id: string;
+  productId?: string;
+  name: string;
+  description?: string;
+  targetUserSegment?: string;
+  targetRole?: string;
+  totalXp?: number;
+  isActive?: boolean;
+  isRequired?: boolean;
+  canSkip?: boolean;
+  streakRule?: StreakRuleSpec;
+  completionRewards?: CompletionRewardsSpec;
+  steps: LearningJourneyStepSpec[];
+  metadata?: Record<string, unknown>;
+}
+//#endregion
+export { BaseEventConditionSpec, CompletionRewardsSpec, CountCompletionConditionSpec, EventCompletionConditionSpec, LearningJourneyStepSpec, LearningJourneyTrackSpec, SrsMasteryCompletionConditionSpec, StepAvailabilitySpec, StepCompletionConditionSpec, StreakRuleSpec, TimeWindowCompletionConditionSpec };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lssm/module.learning-journey",
-  "version": "0.0.0-canary-20251217054315",
+  "version": "0.0.0-canary-20251217060433",
   "description": "Comprehensive learning journey engine - onboarding, LMS, flashcards, gamification, and AI personalization",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,39 +18,39 @@
     "lint:check": "eslint src"
   },
   "dependencies": {
-    "@lssm/lib.schema": "0.0.0-canary-20251217054315",
-    "@lssm/lib.contracts": "0.0.0-canary-20251217054315",
+    "@lssm/lib.schema": "0.0.0-canary-20251217060433",
+    "@lssm/lib.contracts": "0.0.0-canary-20251217060433",
     "zod": "^4.1.13"
   },
   "devDependencies": {
-    "@lssm/tool.typescript": "0.0.0-canary-20251217054315",
-    "@lssm/tool.tsdown": "0.0.0-canary-20251217054315",
+    "@lssm/tool.typescript": "0.0.0-canary-20251217060433",
+    "@lssm/tool.tsdown": "0.0.0-canary-20251217060433",
     "typescript": "^5.9.3"
   },
   "exports": {
-    ".": "./src/index.ts",
-    "./contracts": "./src/contracts/index.ts",
-    "./contracts/models": "./src/contracts/models.ts",
-    "./contracts/onboarding": "./src/contracts/onboarding.ts",
-    "./contracts/operations": "./src/contracts/operations.ts",
-    "./contracts/shared": "./src/contracts/shared.ts",
-    "./docs": "./src/docs/index.ts",
-    "./docs/learning-journey.docblock": "./src/docs/learning-journey.docblock.ts",
-    "./engines": "./src/engines/index.ts",
-    "./engines/srs": "./src/engines/srs.ts",
-    "./engines/streak": "./src/engines/streak.ts",
-    "./engines/xp": "./src/engines/xp.ts",
-    "./entities": "./src/entities/index.ts",
-    "./entities/ai": "./src/entities/ai.ts",
-    "./entities/course": "./src/entities/course.ts",
-    "./entities/flashcard": "./src/entities/flashcard.ts",
-    "./entities/gamification": "./src/entities/gamification.ts",
-    "./entities/learner": "./src/entities/learner.ts",
-    "./entities/onboarding": "./src/entities/onboarding.ts",
-    "./entities/quiz": "./src/entities/quiz.ts",
-    "./events": "./src/events.ts",
-    "./learning-journey.feature": "./src/learning-journey.feature.ts",
-    "./track-spec": "./src/track-spec.ts",
+    ".": "./dist/index.js",
+    "./contracts": "./dist/contracts/index.js",
+    "./contracts/models": "./dist/contracts/models.js",
+    "./contracts/onboarding": "./dist/contracts/onboarding.js",
+    "./contracts/operations": "./dist/contracts/operations.js",
+    "./contracts/shared": "./dist/contracts/shared.js",
+    "./docs": "./dist/docs/index.js",
+    "./docs/learning-journey.docblock": "./dist/docs/learning-journey.docblock.js",
+    "./engines": "./dist/engines/index.js",
+    "./engines/srs": "./dist/engines/srs.js",
+    "./engines/streak": "./dist/engines/streak.js",
+    "./engines/xp": "./dist/engines/xp.js",
+    "./entities": "./dist/entities/index.js",
+    "./entities/ai": "./dist/entities/ai.js",
+    "./entities/course": "./dist/entities/course.js",
+    "./entities/flashcard": "./dist/entities/flashcard.js",
+    "./entities/gamification": "./dist/entities/gamification.js",
+    "./entities/learner": "./dist/entities/learner.js",
+    "./entities/onboarding": "./dist/entities/onboarding.js",
+    "./entities/quiz": "./dist/entities/quiz.js",
+    "./events": "./dist/events.js",
+    "./learning-journey.feature": "./dist/learning-journey.feature.js",
+    "./track-spec": "./dist/track-spec.js",
     "./*": "./*"
   },
   "module": "./dist/index.js",