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

package/dist/entities/onboarding.js

@@ -1 +1,307 @@
-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:`OnboardingStepStatus`,values:[`PENDING`,`IN_PROGRESS`,`COMPLETED`,`SKIPPED`],schema:`lssm_learning`,description:`Status of an onboarding step.`}),a=r({name:`OnboardingTrack`,description:`An onboarding track for a product.`,schema:`lssm_learning`,map:`onboarding_track`,fields:{id:n.id({description:`Unique track identifier`}),productId:n.string({description:`Product this track is for`}),name:n.string({description:`Track name`}),description:n.string({isOptional:!0,description:`Track description`}),targetUserSegment:n.string({isOptional:!0,description:`Target user segment`}),targetRole:n.string({isOptional:!0,description:`Target user role`}),welcomeTitle:n.string({isOptional:!0,description:`Welcome message title`}),welcomeMessage:n.string({isOptional:!0,description:`Welcome message`}),completionTitle:n.string({isOptional:!0,description:`Completion message title`}),completionMessage:n.string({isOptional:!0,description:`Completion message`}),isActive:n.boolean({default:!0,description:`Whether track is active`}),isRequired:n.boolean({default:!1,description:`Whether track is required`}),canSkip:n.boolean({default:!0,description:`Whether steps can be skipped`}),totalXp:n.int({default:100,description:`Total XP for completing track`}),completionXpBonus:n.int({isOptional:!0,description:`Bonus XP for completing track`}),completionBadgeKey:n.string({isOptional:!0,description:`Badge awarded on completion`}),streakHoursWindow:n.int({isOptional:!0,description:`Hours window to finish for streak bonus`}),streakBonusXp:n.int({isOptional:!0,description:`Bonus XP if completed within streak window`}),orgId:n.string({isOptional:!0,description:`Organization scope`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),steps:n.hasMany(`OnboardingStep`),progress:n.hasMany(`OnboardingProgress`)},indexes:[e.on([`productId`,`isActive`]),e.on([`orgId`]),e.unique([`productId`,`targetUserSegment`,`targetRole`],{name:`onboarding_track_target`})]}),o=r({name:`OnboardingStep`,description:`A step in an onboarding track.`,schema:`lssm_learning`,map:`onboarding_step`,fields:{id:n.id({description:`Unique step identifier`}),trackId:n.foreignKey({description:`Parent track`}),title:n.string({description:`Step title`}),description:n.string({isOptional:!0,description:`Step description`}),instructions:n.string({isOptional:!0,description:`How to complete the step`}),helpUrl:n.string({isOptional:!0,description:`Link to help documentation`}),order:n.int({default:0,description:`Display order`}),triggerEvent:n.string({isOptional:!0,description:`Event that triggers step start`}),completionEvent:n.string({description:`Event that completes the step`}),completionEventVersion:n.int({isOptional:!0,description:`Version of the completion event`}),completionSourceModule:n.string({isOptional:!0,description:`Module emitting the completion event`}),completionEventFilter:n.json({isOptional:!0,description:`Filter for completion event`}),actionUrl:n.string({isOptional:!0,description:`URL to navigate to complete`}),actionLabel:n.string({isOptional:!0,description:`Action button label`}),highlightSelector:n.string({isOptional:!0,description:`CSS selector to highlight`}),tooltipPosition:n.string({isOptional:!0,description:`Tooltip position`}),xpReward:n.int({default:10,description:`XP for completing step`}),isRequired:n.boolean({default:!0,description:`Whether step is required`}),canSkip:n.boolean({default:!0,description:`Whether step can be skipped`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),track:n.belongsTo(`OnboardingTrack`,[`trackId`],[`id`],{onDelete:`Cascade`})},indexes:[e.on([`trackId`,`order`]),e.on([`completionEvent`])]}),s=r({name:`OnboardingProgress`,description:`Tracks user progress through an onboarding track.`,schema:`lssm_learning`,map:`onboarding_progress`,fields:{id:n.id({description:`Unique progress identifier`}),learnerId:n.foreignKey({description:`Learner`}),trackId:n.foreignKey({description:`Onboarding track`}),currentStepId:n.string({isOptional:!0,description:`Current step ID`}),completedSteps:n.json({default:`[]`,description:`Array of completed step IDs`}),skippedSteps:n.json({default:`[]`,description:`Array of skipped step IDs`}),progress:n.int({default:0,description:`Completion percentage (0-100)`}),isCompleted:n.boolean({default:!1,description:`Whether track is completed`}),xpEarned:n.int({default:0,description:`XP earned from track`}),startedAt:n.dateTime({description:`When user started`}),completedAt:n.dateTime({isOptional:!0,description:`When user completed`}),lastActivityAt:n.dateTime({isOptional:!0,description:`Last activity`}),isDismissed:n.boolean({default:!1,description:`Whether user dismissed onboarding`}),dismissedAt:n.dateTime({isOptional:!0,description:`When dismissed`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),learner:n.belongsTo(`Learner`,[`learnerId`],[`id`],{onDelete:`Cascade`}),track:n.belongsTo(`OnboardingTrack`,[`trackId`],[`id`],{onDelete:`Cascade`})},indexes:[e.unique([`learnerId`,`trackId`],{name:`onboarding_progress_unique`}),e.on([`learnerId`,`isCompleted`]),e.on([`trackId`])],enums:[i]}),c=r({name:`OnboardingStepCompletion`,description:`Individual step completion record.`,schema:`lssm_learning`,map:`onboarding_step_completion`,fields:{id:n.id({description:`Unique completion identifier`}),progressId:n.foreignKey({description:`Parent progress record`}),stepId:n.foreignKey({description:`Completed step`}),status:n.enum(`OnboardingStepStatus`,{description:`Completion status`}),xpEarned:n.int({default:0,description:`XP earned`}),triggeringEvent:n.string({isOptional:!0,description:`Event that triggered completion`}),eventPayload:n.json({isOptional:!0,description:`Event payload`}),completedAt:n.dateTime({description:`When completed`}),createdAt:n.createdAt(),progress:n.belongsTo(`OnboardingProgress`,[`progressId`],[`id`],{onDelete:`Cascade`}),step:n.belongsTo(`OnboardingStep`,[`stepId`],[`id`],{onDelete:`Cascade`})},indexes:[e.unique([`progressId`,`stepId`],{name:`step_completion_unique`}),e.on([`completedAt`])]}),l=[a,o,s,c],u=[i];export{s as OnboardingProgressEntity,c as OnboardingStepCompletionEntity,o as OnboardingStepEntity,i as OnboardingStepStatusEnum,a as OnboardingTrackEntity,l as onboardingEntities,u as onboardingEnums};
+import { defineEntity, defineEntityEnum, field, index } from "../libs/schema/dist/entity/defineEntity.js";
+import "../libs/schema/dist/index.js";
+
+//#region src/entities/onboarding.ts
+/**
+* Onboarding step status enum.
+*/
+const OnboardingStepStatusEnum = defineEntityEnum({
+	name: "OnboardingStepStatus",
+	values: [
+		"PENDING",
+		"IN_PROGRESS",
+		"COMPLETED",
+		"SKIPPED"
+	],
+	schema: "lssm_learning",
+	description: "Status of an onboarding step."
+});
+/**
+* OnboardingTrack entity - defines an onboarding journey.
+*/
+const OnboardingTrackEntity = defineEntity({
+	name: "OnboardingTrack",
+	description: "An onboarding track for a product.",
+	schema: "lssm_learning",
+	map: "onboarding_track",
+	fields: {
+		id: field.id({ description: "Unique track identifier" }),
+		productId: field.string({ description: "Product this track is for" }),
+		name: field.string({ description: "Track name" }),
+		description: field.string({
+			isOptional: true,
+			description: "Track description"
+		}),
+		targetUserSegment: field.string({
+			isOptional: true,
+			description: "Target user segment"
+		}),
+		targetRole: field.string({
+			isOptional: true,
+			description: "Target user role"
+		}),
+		welcomeTitle: field.string({
+			isOptional: true,
+			description: "Welcome message title"
+		}),
+		welcomeMessage: field.string({
+			isOptional: true,
+			description: "Welcome message"
+		}),
+		completionTitle: field.string({
+			isOptional: true,
+			description: "Completion message title"
+		}),
+		completionMessage: field.string({
+			isOptional: true,
+			description: "Completion message"
+		}),
+		isActive: field.boolean({
+			default: true,
+			description: "Whether track is active"
+		}),
+		isRequired: field.boolean({
+			default: false,
+			description: "Whether track is required"
+		}),
+		canSkip: field.boolean({
+			default: true,
+			description: "Whether steps can be skipped"
+		}),
+		totalXp: field.int({
+			default: 100,
+			description: "Total XP for completing track"
+		}),
+		completionXpBonus: field.int({
+			isOptional: true,
+			description: "Bonus XP for completing track"
+		}),
+		completionBadgeKey: field.string({
+			isOptional: true,
+			description: "Badge awarded on completion"
+		}),
+		streakHoursWindow: field.int({
+			isOptional: true,
+			description: "Hours window to finish for streak bonus"
+		}),
+		streakBonusXp: field.int({
+			isOptional: true,
+			description: "Bonus XP if completed within streak window"
+		}),
+		orgId: field.string({
+			isOptional: true,
+			description: "Organization scope"
+		}),
+		metadata: field.json({
+			isOptional: true,
+			description: "Additional metadata"
+		}),
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+		steps: field.hasMany("OnboardingStep"),
+		progress: field.hasMany("OnboardingProgress")
+	},
+	indexes: [
+		index.on(["productId", "isActive"]),
+		index.on(["orgId"]),
+		index.unique([
+			"productId",
+			"targetUserSegment",
+			"targetRole"
+		], { name: "onboarding_track_target" })
+	]
+});
+/**
+* OnboardingStep entity - a step in an onboarding track.
+*/
+const OnboardingStepEntity = defineEntity({
+	name: "OnboardingStep",
+	description: "A step in an onboarding track.",
+	schema: "lssm_learning",
+	map: "onboarding_step",
+	fields: {
+		id: field.id({ description: "Unique step identifier" }),
+		trackId: field.foreignKey({ description: "Parent track" }),
+		title: field.string({ description: "Step title" }),
+		description: field.string({
+			isOptional: true,
+			description: "Step description"
+		}),
+		instructions: field.string({
+			isOptional: true,
+			description: "How to complete the step"
+		}),
+		helpUrl: field.string({
+			isOptional: true,
+			description: "Link to help documentation"
+		}),
+		order: field.int({
+			default: 0,
+			description: "Display order"
+		}),
+		triggerEvent: field.string({
+			isOptional: true,
+			description: "Event that triggers step start"
+		}),
+		completionEvent: field.string({ description: "Event that completes the step" }),
+		completionEventVersion: field.int({
+			isOptional: true,
+			description: "Version of the completion event"
+		}),
+		completionSourceModule: field.string({
+			isOptional: true,
+			description: "Module emitting the completion event"
+		}),
+		completionEventFilter: field.json({
+			isOptional: true,
+			description: "Filter for completion event"
+		}),
+		actionUrl: field.string({
+			isOptional: true,
+			description: "URL to navigate to complete"
+		}),
+		actionLabel: field.string({
+			isOptional: true,
+			description: "Action button label"
+		}),
+		highlightSelector: field.string({
+			isOptional: true,
+			description: "CSS selector to highlight"
+		}),
+		tooltipPosition: field.string({
+			isOptional: true,
+			description: "Tooltip position"
+		}),
+		xpReward: field.int({
+			default: 10,
+			description: "XP for completing step"
+		}),
+		isRequired: field.boolean({
+			default: true,
+			description: "Whether step is required"
+		}),
+		canSkip: field.boolean({
+			default: true,
+			description: "Whether step can be skipped"
+		}),
+		metadata: field.json({
+			isOptional: true,
+			description: "Additional metadata"
+		}),
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+		track: field.belongsTo("OnboardingTrack", ["trackId"], ["id"], { onDelete: "Cascade" })
+	},
+	indexes: [index.on(["trackId", "order"]), index.on(["completionEvent"])]
+});
+/**
+* OnboardingProgress entity - tracks user progress through onboarding.
+*/
+const OnboardingProgressEntity = defineEntity({
+	name: "OnboardingProgress",
+	description: "Tracks user progress through an onboarding track.",
+	schema: "lssm_learning",
+	map: "onboarding_progress",
+	fields: {
+		id: field.id({ description: "Unique progress identifier" }),
+		learnerId: field.foreignKey({ description: "Learner" }),
+		trackId: field.foreignKey({ description: "Onboarding track" }),
+		currentStepId: field.string({
+			isOptional: true,
+			description: "Current step ID"
+		}),
+		completedSteps: field.json({
+			default: "[]",
+			description: "Array of completed step IDs"
+		}),
+		skippedSteps: field.json({
+			default: "[]",
+			description: "Array of skipped step IDs"
+		}),
+		progress: field.int({
+			default: 0,
+			description: "Completion percentage (0-100)"
+		}),
+		isCompleted: field.boolean({
+			default: false,
+			description: "Whether track is completed"
+		}),
+		xpEarned: field.int({
+			default: 0,
+			description: "XP earned from track"
+		}),
+		startedAt: field.dateTime({ description: "When user started" }),
+		completedAt: field.dateTime({
+			isOptional: true,
+			description: "When user completed"
+		}),
+		lastActivityAt: field.dateTime({
+			isOptional: true,
+			description: "Last activity"
+		}),
+		isDismissed: field.boolean({
+			default: false,
+			description: "Whether user dismissed onboarding"
+		}),
+		dismissedAt: field.dateTime({
+			isOptional: true,
+			description: "When dismissed"
+		}),
+		metadata: field.json({
+			isOptional: true,
+			description: "Additional metadata"
+		}),
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+		learner: field.belongsTo("Learner", ["learnerId"], ["id"], { onDelete: "Cascade" }),
+		track: field.belongsTo("OnboardingTrack", ["trackId"], ["id"], { onDelete: "Cascade" })
+	},
+	indexes: [
+		index.unique(["learnerId", "trackId"], { name: "onboarding_progress_unique" }),
+		index.on(["learnerId", "isCompleted"]),
+		index.on(["trackId"])
+	],
+	enums: [OnboardingStepStatusEnum]
+});
+/**
+* OnboardingStepCompletion entity - individual step completions.
+*/
+const OnboardingStepCompletionEntity = defineEntity({
+	name: "OnboardingStepCompletion",
+	description: "Individual step completion record.",
+	schema: "lssm_learning",
+	map: "onboarding_step_completion",
+	fields: {
+		id: field.id({ description: "Unique completion identifier" }),
+		progressId: field.foreignKey({ description: "Parent progress record" }),
+		stepId: field.foreignKey({ description: "Completed step" }),
+		status: field.enum("OnboardingStepStatus", { description: "Completion status" }),
+		xpEarned: field.int({
+			default: 0,
+			description: "XP earned"
+		}),
+		triggeringEvent: field.string({
+			isOptional: true,
+			description: "Event that triggered completion"
+		}),
+		eventPayload: field.json({
+			isOptional: true,
+			description: "Event payload"
+		}),
+		completedAt: field.dateTime({ description: "When completed" }),
+		createdAt: field.createdAt(),
+		progress: field.belongsTo("OnboardingProgress", ["progressId"], ["id"], { onDelete: "Cascade" }),
+		step: field.belongsTo("OnboardingStep", ["stepId"], ["id"], { onDelete: "Cascade" })
+	},
+	indexes: [index.unique(["progressId", "stepId"], { name: "step_completion_unique" }), index.on(["completedAt"])]
+});
+const onboardingEntities = [
+	OnboardingTrackEntity,
+	OnboardingStepEntity,
+	OnboardingProgressEntity,
+	OnboardingStepCompletionEntity
+];
+const onboardingEnums = [OnboardingStepStatusEnum];
+
+//#endregion
+export { OnboardingProgressEntity, OnboardingStepCompletionEntity, OnboardingStepEntity, OnboardingStepStatusEnum, OnboardingTrackEntity, onboardingEntities, onboardingEnums };