@contractspec/module.learning-journey 1.57.0 → 1.59.0

package/dist/node/events.js

@@ -0,0 +1,423 @@
+// src/contracts/shared.ts
+var LEARNING_JOURNEY_OWNERS = ["modules.learning-journey"];
+
+// src/events.ts
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+import { defineEvent } from "@contractspec/lib.contracts";
+var CoursePublishedPayload = defineSchemaModel({
+  name: "CoursePublishedEventPayload",
+  description: "Payload when a course is published",
+  fields: {
+    courseId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    authorId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    publishedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CoursePublishedEvent = defineEvent({
+  meta: {
+    key: "course.published",
+    version: "1.0.0",
+    description: "A course has been published.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "course"]
+  },
+  payload: CoursePublishedPayload
+});
+var EnrollmentCreatedPayload = defineSchemaModel({
+  name: "EnrollmentCreatedEventPayload",
+  description: "Payload when a learner enrolls in a course",
+  fields: {
+    enrollmentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    courseId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    enrolledAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var EnrollmentCreatedEvent = defineEvent({
+  meta: {
+    key: "enrollment.created",
+    version: "1.0.0",
+    description: "A learner has enrolled in a course.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "enrollment"]
+  },
+  payload: EnrollmentCreatedPayload
+});
+var LessonCompletedPayload = defineSchemaModel({
+  name: "LessonCompletedEventPayload",
+  description: "Payload when a lesson is completed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    lessonId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    courseId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    score: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    timeSpent: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var LessonCompletedEvent = defineEvent({
+  meta: {
+    key: "lesson.completed",
+    version: "1.0.0",
+    description: "A learner has completed a lesson.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "progress", "lesson"]
+  },
+  payload: LessonCompletedPayload
+});
+var CourseCompletedPayload = defineSchemaModel({
+  name: "CourseCompletedEventPayload",
+  description: "Payload when a course is completed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    courseId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    enrollmentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    score: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    certificateId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CourseCompletedEvent = defineEvent({
+  meta: {
+    key: "course.completed",
+    version: "1.0.0",
+    description: "A learner has completed a course.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "progress", "course"]
+  },
+  payload: CourseCompletedPayload
+});
+var OnboardingStartedPayload = defineSchemaModel({
+  name: "OnboardingStartedEventPayload",
+  description: "Payload when onboarding starts",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    productId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    startedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var OnboardingStartedEvent = defineEvent({
+  meta: {
+    key: "onboarding.started",
+    version: "1.0.0",
+    description: "A learner has started onboarding.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "onboarding"]
+  },
+  payload: OnboardingStartedPayload
+});
+var OnboardingStepCompletedPayload = defineSchemaModel({
+  name: "OnboardingStepCompletedEventPayload",
+  description: "Payload when an onboarding step is completed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    stepId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    triggeringEvent: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: true
+    },
+    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var OnboardingStepCompletedEvent = defineEvent({
+  meta: {
+    key: "onboarding.step_completed",
+    version: "1.0.0",
+    description: "An onboarding step has been completed.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "onboarding"]
+  },
+  payload: OnboardingStepCompletedPayload
+});
+var OnboardingCompletedPayload = defineSchemaModel({
+  name: "OnboardingCompletedEventPayload",
+  description: "Payload when onboarding is completed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    productId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var OnboardingCompletedEvent = defineEvent({
+  meta: {
+    key: "onboarding.completed",
+    version: "1.0.0",
+    description: "A learner has completed onboarding.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "onboarding"]
+  },
+  payload: OnboardingCompletedPayload
+});
+var CardReviewedPayload = defineSchemaModel({
+  name: "CardReviewedEventPayload",
+  description: "Payload when a flashcard is reviewed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    cardId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    deckId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    rating: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    responseTimeMs: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    reviewedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CardReviewedEvent = defineEvent({
+  meta: {
+    key: "flashcard.reviewed",
+    version: "1.0.0",
+    description: "A flashcard has been reviewed.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "flashcards"]
+  },
+  payload: CardReviewedPayload
+});
+var QuizStartedPayload = defineSchemaModel({
+  name: "QuizStartedEventPayload",
+  description: "Payload when a quiz is started",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    quizId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    attemptId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    attemptNumber: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    startedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var QuizStartedEvent = defineEvent({
+  meta: {
+    key: "quiz.started",
+    version: "1.0.0",
+    description: "A quiz attempt has started.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "quiz"]
+  },
+  payload: QuizStartedPayload
+});
+var QuizCompletedPayload = defineSchemaModel({
+  name: "QuizCompletedEventPayload",
+  description: "Payload when a quiz is completed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    quizId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    attemptId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    score: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    percentageScore: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    passed: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    timeSpent: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var QuizCompletedEvent = defineEvent({
+  meta: {
+    key: "quiz.completed",
+    version: "1.0.0",
+    description: "A quiz attempt has been completed.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "quiz"]
+  },
+  payload: QuizCompletedPayload
+});
+var XpEarnedPayload = defineSchemaModel({
+  name: "XpEarnedEventPayload",
+  description: "Payload when XP is earned",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    amount: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    source: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    sourceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    totalXp: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    earnedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var XpEarnedEvent = defineEvent({
+  meta: {
+    key: "xp.earned",
+    version: "1.0.0",
+    description: "XP has been earned.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "gamification", "xp"]
+  },
+  payload: XpEarnedPayload
+});
+var LevelUpPayload = defineSchemaModel({
+  name: "LevelUpEventPayload",
+  description: "Payload when a learner levels up",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    previousLevel: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    newLevel: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    totalXp: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    leveledUpAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var LevelUpEvent = defineEvent({
+  meta: {
+    key: "level.up",
+    version: "1.0.0",
+    description: "A learner has leveled up.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "gamification", "level"]
+  },
+  payload: LevelUpPayload
+});
+var StreakUpdatedPayload = defineSchemaModel({
+  name: "StreakUpdatedEventPayload",
+  description: "Payload when a streak is updated",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    previousStreak: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    currentStreak: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    longestStreak: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    freezeUsed: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var StreakUpdatedEvent = defineEvent({
+  meta: {
+    key: "streak.updated",
+    version: "1.0.0",
+    description: "A streak has been updated.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "gamification", "streak"]
+  },
+  payload: StreakUpdatedPayload
+});
+var AchievementUnlockedPayload = defineSchemaModel({
+  name: "AchievementUnlockedEventPayload",
+  description: "Payload when an achievement is unlocked",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    achievementId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    achievementKey: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    achievementName: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    unlockedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var AchievementUnlockedEvent = defineEvent({
+  meta: {
+    key: "achievement.unlocked",
+    version: "1.0.0",
+    description: "An achievement has been unlocked.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "gamification", "achievement"]
+  },
+  payload: AchievementUnlockedPayload
+});
+var DailyGoalCompletedPayload = defineSchemaModel({
+  name: "DailyGoalCompletedEventPayload",
+  description: "Payload when a daily goal is completed",
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    date: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    targetXp: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    actualXp: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var DailyGoalCompletedEvent = defineEvent({
+  meta: {
+    key: "daily_goal.completed",
+    version: "1.0.0",
+    description: "A daily goal has been completed.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "gamification", "goal"]
+  },
+  payload: DailyGoalCompletedPayload
+});
+var CertificateIssuedPayload = defineSchemaModel({
+  name: "CertificateIssuedEventPayload",
+  description: "Payload when a certificate is issued",
+  fields: {
+    certificateId: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    courseId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    certificateNumber: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false
+    },
+    issuedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
+  }
+});
+var CertificateIssuedEvent = defineEvent({
+  meta: {
+    key: "certificate.issued",
+    version: "1.0.0",
+    description: "A certificate has been issued.",
+    stability: "stable",
+    owners: [...LEARNING_JOURNEY_OWNERS],
+    tags: ["learning", "certificate"]
+  },
+  payload: CertificateIssuedPayload
+});
+var LearningJourneyEvents = {
+  CoursePublishedEvent,
+  EnrollmentCreatedEvent,
+  LessonCompletedEvent,
+  CourseCompletedEvent,
+  OnboardingStartedEvent,
+  OnboardingStepCompletedEvent,
+  OnboardingCompletedEvent,
+  CardReviewedEvent,
+  QuizStartedEvent,
+  QuizCompletedEvent,
+  XpEarnedEvent,
+  LevelUpEvent,
+  StreakUpdatedEvent,
+  AchievementUnlockedEvent,
+  DailyGoalCompletedEvent,
+  CertificateIssuedEvent
+};
+export {
+  XpEarnedEvent,
+  StreakUpdatedEvent,
+  QuizStartedEvent,
+  QuizCompletedEvent,
+  OnboardingStepCompletedEvent,
+  OnboardingStartedEvent,
+  OnboardingCompletedEvent,
+  LevelUpEvent,
+  LessonCompletedEvent,
+  LearningJourneyEvents,
+  EnrollmentCreatedEvent,
+  DailyGoalCompletedEvent,
+  CoursePublishedEvent,
+  CourseCompletedEvent,
+  CertificateIssuedEvent,
+  CardReviewedEvent,
+  AchievementUnlockedEvent
+};