@lssm/module.learning-journey 0.0.0-canary-20251217063201 → 0.0.0-canary-20251217072406

package/dist/entities/gamification.js

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