@contractspec/module.learning-journey 1.57.0 → 1.58.0

package/dist/browser/entities/gamification.js

@@ -0,0 +1,340 @@
+// src/entities/gamification.ts
+import {
+  defineEntity,
+  defineEntityEnum,
+  field,
+  index
+} from "@contractspec/lib.schema";
+var AchievementTypeEnum = defineEntityEnum({
+  name: "AchievementType",
+  values: [
+    "MILESTONE",
+    "STREAK",
+    "SKILL",
+    "SOCIAL",
+    "SPECIAL",
+    "SEASONAL"
+  ],
+  schema: "lssm_learning",
+  description: "Type of achievement."
+});
+var LeaderboardPeriodEnum = defineEntityEnum({
+  name: "LeaderboardPeriod",
+  values: ["DAILY", "WEEKLY", "MONTHLY", "ALL_TIME"],
+  schema: "lssm_learning",
+  description: "Leaderboard time period."
+});
+var AchievementEntity = defineEntity({
+  name: "Achievement",
+  description: "An achievement that can be unlocked.",
+  schema: "lssm_learning",
+  map: "achievement",
+  fields: {
+    id: field.id({ description: "Unique achievement identifier" }),
+    key: field.string({ isUnique: true, description: "Achievement key" }),
+    name: field.string({ description: "Achievement name" }),
+    description: field.string({ description: "Achievement description" }),
+    icon: field.string({ isOptional: true, description: "Icon name or URL" }),
+    color: field.string({ isOptional: true, description: "Display color" }),
+    badgeUrl: field.string({
+      isOptional: true,
+      description: "Badge image URL"
+    }),
+    type: field.enum("AchievementType", {
+      default: "MILESTONE",
+      description: "Achievement type"
+    }),
+    category: field.string({
+      isOptional: true,
+      description: "Achievement category"
+    }),
+    rarity: field.string({
+      default: '"common"',
+      description: "Rarity: common, rare, epic, legendary"
+    }),
+    xpReward: field.int({ default: 50, description: "XP awarded" }),
+    condition: field.json({ description: "Unlock condition" }),
+    order: field.int({ default: 0, description: "Display order" }),
+    isHidden: field.boolean({
+      default: false,
+      description: "Hide until unlocked"
+    }),
+    isActive: field.boolean({
+      default: true,
+      description: "Whether achievement is active"
+    }),
+    orgId: field.string({
+      isOptional: true,
+      description: "Organization scope"
+    }),
+    metadata: field.json({
+      isOptional: true,
+      description: "Additional metadata"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    learnerAchievements: field.hasMany("LearnerAchievement")
+  },
+  indexes: [
+    index.on(["type"]),
+    index.on(["category"]),
+    index.on(["isActive"]),
+    index.on(["orgId"])
+  ],
+  enums: [AchievementTypeEnum]
+});
+var LearnerAchievementEntity = defineEntity({
+  name: "LearnerAchievement",
+  description: "An achievement unlocked by a learner.",
+  schema: "lssm_learning",
+  map: "learner_achievement",
+  fields: {
+    id: field.id({ description: "Unique record identifier" }),
+    learnerId: field.foreignKey({ description: "Learner" }),
+    achievementId: field.foreignKey({ description: "Achievement" }),
+    xpEarned: field.int({ default: 0, description: "XP earned" }),
+    progress: field.int({ default: 100, description: "Progress percentage" }),
+    currentValue: field.int({
+      isOptional: true,
+      description: "Current value towards goal"
+    }),
+    targetValue: field.int({
+      isOptional: true,
+      description: "Target value for completion"
+    }),
+    unlockedAt: field.dateTime({ description: "When unlocked" }),
+    createdAt: field.createdAt(),
+    learner: field.belongsTo("Learner", ["learnerId"], ["id"], {
+      onDelete: "Cascade"
+    }),
+    achievement: field.belongsTo("Achievement", ["achievementId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.unique(["learnerId", "achievementId"], {
+      name: "learner_achievement_unique"
+    }),
+    index.on(["learnerId", "unlockedAt"]),
+    index.on(["achievementId"])
+  ]
+});
+var StreakEntity = defineEntity({
+  name: "Streak",
+  description: "Tracks daily learning streaks.",
+  schema: "lssm_learning",
+  map: "streak",
+  fields: {
+    id: field.id({ description: "Unique streak identifier" }),
+    learnerId: field.foreignKey({ description: "Learner" }),
+    currentStreak: field.int({
+      default: 0,
+      description: "Current streak days"
+    }),
+    longestStreak: field.int({
+      default: 0,
+      description: "Longest streak ever"
+    }),
+    lastActivityAt: field.dateTime({
+      isOptional: true,
+      description: "Last learning activity"
+    }),
+    lastActivityDate: field.string({
+      isOptional: true,
+      description: "Last activity date (YYYY-MM-DD)"
+    }),
+    freezesRemaining: field.int({
+      default: 0,
+      description: "Streak freezes available"
+    }),
+    freezeUsedAt: field.dateTime({
+      isOptional: true,
+      description: "When last freeze was used"
+    }),
+    streakHistory: field.json({
+      isOptional: true,
+      description: "Historical streak data"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    learner: field.belongsTo("Learner", ["learnerId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.unique(["learnerId"], { name: "streak_learner_unique" }),
+    index.on(["currentStreak"]),
+    index.on(["longestStreak"])
+  ]
+});
+var DailyGoalEntity = defineEntity({
+  name: "DailyGoal",
+  description: "Daily XP goal tracking.",
+  schema: "lssm_learning",
+  map: "daily_goal",
+  fields: {
+    id: field.id({ description: "Unique goal identifier" }),
+    learnerId: field.foreignKey({ description: "Learner" }),
+    date: field.string({ description: "Date (YYYY-MM-DD)" }),
+    targetXp: field.int({ description: "Target XP for the day" }),
+    currentXp: field.int({ default: 0, description: "XP earned today" }),
+    isCompleted: field.boolean({
+      default: false,
+      description: "Whether goal was met"
+    }),
+    completedAt: field.dateTime({
+      isOptional: true,
+      description: "When goal was completed"
+    }),
+    xpBreakdown: field.json({
+      isOptional: true,
+      description: "XP sources breakdown"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    learner: field.belongsTo("Learner", ["learnerId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.unique(["learnerId", "date"], { name: "daily_goal_unique" }),
+    index.on(["date", "isCompleted"])
+  ]
+});
+var LeaderboardEntryEntity = defineEntity({
+  name: "LeaderboardEntry",
+  description: "Leaderboard entry for a learner.",
+  schema: "lssm_learning",
+  map: "leaderboard_entry",
+  fields: {
+    id: field.id({ description: "Unique entry identifier" }),
+    learnerId: field.foreignKey({ description: "Learner" }),
+    periodType: field.enum("LeaderboardPeriod", { description: "Period type" }),
+    periodKey: field.string({ description: "Period key (e.g., 2024-W01)" }),
+    xp: field.int({ default: 0, description: "XP earned in period" }),
+    rank: field.int({ isOptional: true, description: "Rank in leaderboard" }),
+    lessonsCompleted: field.int({
+      default: 0,
+      description: "Lessons completed"
+    }),
+    quizzesPassed: field.int({ default: 0, description: "Quizzes passed" }),
+    cardsReviewed: field.int({ default: 0, description: "Cards reviewed" }),
+    streakDays: field.int({ default: 0, description: "Streak days in period" }),
+    league: field.string({ isOptional: true, description: "League tier" }),
+    orgId: field.string({
+      isOptional: true,
+      description: "Organization scope"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    learner: field.belongsTo("Learner", ["learnerId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.unique(["learnerId", "periodType", "periodKey"], {
+      name: "leaderboard_entry_unique"
+    }),
+    index.on(["periodType", "periodKey", "xp"]),
+    index.on(["orgId", "periodType", "periodKey", "xp"])
+  ],
+  enums: [LeaderboardPeriodEnum]
+});
+var HeartEntity = defineEntity({
+  name: "Heart",
+  description: "Lives/hearts system for quiz attempts.",
+  schema: "lssm_learning",
+  map: "heart",
+  fields: {
+    id: field.id({ description: "Unique heart record identifier" }),
+    learnerId: field.foreignKey({ description: "Learner" }),
+    current: field.int({ default: 5, description: "Current hearts" }),
+    max: field.int({ default: 5, description: "Maximum hearts" }),
+    lastRefillAt: field.dateTime({
+      isOptional: true,
+      description: "Last refill time"
+    }),
+    nextRefillAt: field.dateTime({
+      isOptional: true,
+      description: "Next refill time"
+    }),
+    refillIntervalMinutes: field.int({
+      default: 240,
+      description: "Minutes between refills"
+    }),
+    infiniteUntil: field.dateTime({
+      isOptional: true,
+      description: "Infinite hearts until"
+    }),
+    createdAt: field.createdAt(),
+    updatedAt: field.updatedAt(),
+    learner: field.belongsTo("Learner", ["learnerId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.unique(["learnerId"], { name: "heart_learner_unique" }),
+    index.on(["nextRefillAt"])
+  ]
+});
+var XPTransactionEntity = defineEntity({
+  name: "XPTransaction",
+  description: "Record of XP earned or spent.",
+  schema: "lssm_learning",
+  map: "xp_transaction",
+  fields: {
+    id: field.id({ description: "Unique transaction identifier" }),
+    learnerId: field.foreignKey({ description: "Learner" }),
+    amount: field.int({
+      description: "XP amount (positive = earned, negative = spent)"
+    }),
+    type: field.string({
+      description: "Transaction type (lesson, quiz, streak, achievement, etc.)"
+    }),
+    sourceType: field.string({
+      isOptional: true,
+      description: "Source entity type"
+    }),
+    sourceId: field.string({
+      isOptional: true,
+      description: "Source entity ID"
+    }),
+    description: field.string({
+      isOptional: true,
+      description: "Human-readable description"
+    }),
+    balanceAfter: field.int({ description: "Total XP after transaction" }),
+    createdAt: field.createdAt(),
+    learner: field.belongsTo("Learner", ["learnerId"], ["id"], {
+      onDelete: "Cascade"
+    })
+  },
+  indexes: [
+    index.on(["learnerId", "createdAt"]),
+    index.on(["type"]),
+    index.on(["sourceType", "sourceId"])
+  ]
+});
+var gamificationEntities = [
+  AchievementEntity,
+  LearnerAchievementEntity,
+  StreakEntity,
+  DailyGoalEntity,
+  LeaderboardEntryEntity,
+  HeartEntity,
+  XPTransactionEntity
+];
+var gamificationEnums = [AchievementTypeEnum, LeaderboardPeriodEnum];
+export {
+  gamificationEnums,
+  gamificationEntities,
+  XPTransactionEntity,
+  StreakEntity,
+  LearnerAchievementEntity,
+  LeaderboardPeriodEnum,
+  LeaderboardEntryEntity,
+  HeartEntity,
+  DailyGoalEntity,
+  AchievementTypeEnum,
+  AchievementEntity
+};