@contractspec/module.learning-journey 1.44.0

package/dist/contracts/onboarding.js

@@ -0,0 +1,402 @@
+import { LEARNING_JOURNEY_OWNERS } from "./shared.js";
+import { SuccessOutput } from "./models.js";
+import { ScalarTypeEnum, defineSchemaModel } from "@contractspec/lib.schema";
+import { defineCommand, defineQuery } from "@contractspec/lib.contracts";
+
+//#region src/contracts/onboarding.ts
+const OnboardingStepConditionModel = defineSchemaModel({
+	name: "OnboardingStepCondition",
+	description: "Structured completion condition for onboarding steps.",
+	fields: {
+		eventName: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		eventVersion: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		sourceModule: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		payloadFilter: {
+			type: ScalarTypeEnum.JSON(),
+			isOptional: true
+		}
+	}
+});
+const OnboardingStepModel = defineSchemaModel({
+	name: "OnboardingStep",
+	description: "Declarative onboarding step definition.",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		trackId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		title: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		description: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		instructions: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		helpUrl: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		order: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		completionEvent: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		completionCondition: {
+			type: OnboardingStepConditionModel,
+			isOptional: true
+		},
+		xpReward: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		isRequired: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		canSkip: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		actionUrl: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		actionLabel: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		metadata: {
+			type: ScalarTypeEnum.JSON(),
+			isOptional: true
+		}
+	}
+});
+const OnboardingTrackModel = defineSchemaModel({
+	name: "OnboardingTrack",
+	description: "Onboarding track metadata and steps.",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		productId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		name: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		description: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		targetUserSegment: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		targetRole: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		isActive: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		isRequired: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		canSkip: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		},
+		totalXp: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		completionXpBonus: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		completionBadgeKey: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		streakHoursWindow: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		streakBonusXp: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		metadata: {
+			type: ScalarTypeEnum.JSON(),
+			isOptional: true
+		},
+		steps: {
+			type: OnboardingStepModel,
+			isArray: true,
+			isOptional: false
+		}
+	}
+});
+const OnboardingStepProgressModel = defineSchemaModel({
+	name: "OnboardingStepProgress",
+	description: "Progress for a specific onboarding step.",
+	fields: {
+		stepId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		status: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		xpEarned: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		triggeringEvent: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		eventPayload: {
+			type: ScalarTypeEnum.JSON(),
+			isOptional: true
+		},
+		completedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		}
+	}
+});
+const OnboardingProgressModel = defineSchemaModel({
+	name: "OnboardingProgress",
+	description: "Aggregated progress for an onboarding track.",
+	fields: {
+		learnerId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		trackId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		progress: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		isCompleted: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: false
+		},
+		xpEarned: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		startedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		completedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		lastActivityAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		steps: {
+			type: OnboardingStepProgressModel,
+			isArray: true,
+			isOptional: true
+		}
+	}
+});
+const ListOnboardingTracksInput = defineSchemaModel({
+	name: "ListOnboardingTracksInput",
+	description: "Filters for listing onboarding tracks.",
+	fields: {
+		learnerId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		productId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		trackIds: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isArray: true,
+			isOptional: true
+		},
+		includeProgress: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: true
+		}
+	}
+});
+const ListOnboardingTracksOutput = defineSchemaModel({
+	name: "ListOnboardingTracksOutput",
+	description: "Available onboarding tracks with optional progress.",
+	fields: {
+		tracks: {
+			type: OnboardingTrackModel,
+			isArray: true,
+			isOptional: false
+		},
+		progress: {
+			type: OnboardingProgressModel,
+			isArray: true,
+			isOptional: true
+		}
+	}
+});
+const GetOnboardingProgressInput = defineSchemaModel({
+	name: "GetOnboardingProgressInput",
+	description: "Input for fetching onboarding progress for a track.",
+	fields: {
+		trackId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		learnerId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const RecordOnboardingEventInput = defineSchemaModel({
+	name: "RecordOnboardingEventInput",
+	description: "Record a domain event to advance onboarding progress via completion conditions.",
+	fields: {
+		learnerId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		trackId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		eventName: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		eventVersion: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		eventPayload: {
+			type: ScalarTypeEnum.JSON(),
+			isOptional: true
+		},
+		occurredAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		}
+	}
+});
+const ListOnboardingTracksContract = defineQuery({
+	meta: {
+		key: "learning.onboarding.listTracks",
+		version: 1,
+		stability: "stable",
+		owners: [...LEARNING_JOURNEY_OWNERS],
+		tags: [
+			"learning",
+			"onboarding",
+			"journey"
+		],
+		description: "List onboarding tracks available to a learner or product.",
+		goal: "Expose track catalog for UI/API surfaces.",
+		context: "Called when showing onboarding/learning journey catalog."
+	},
+	io: {
+		input: ListOnboardingTracksInput,
+		output: ListOnboardingTracksOutput
+	},
+	policy: { auth: "user" }
+});
+const GetOnboardingProgressContract = defineQuery({
+	meta: {
+		key: "learning.onboarding.getProgress",
+		version: 1,
+		stability: "stable",
+		owners: [...LEARNING_JOURNEY_OWNERS],
+		tags: [
+			"learning",
+			"onboarding",
+			"journey"
+		],
+		description: "Fetch onboarding progress for a specific track.",
+		goal: "Display learner progress and remaining steps.",
+		context: "Called when rendering a track detail or widget."
+	},
+	io: {
+		input: GetOnboardingProgressInput,
+		output: OnboardingProgressModel
+	},
+	policy: { auth: "user" }
+});
+const RecordOnboardingEventContract = defineCommand({
+	meta: {
+		key: "learning.onboarding.recordEvent",
+		version: 1,
+		stability: "stable",
+		owners: [...LEARNING_JOURNEY_OWNERS],
+		tags: [
+			"learning",
+			"onboarding",
+			"events"
+		],
+		description: "Record a domain event to evaluate onboarding step completion conditions.",
+		goal: "Advance onboarding automatically from product events.",
+		context: "Called by event bus handlers when relevant product events fire (e.g., deal.created)."
+	},
+	io: {
+		input: RecordOnboardingEventInput,
+		output: SuccessOutput,
+		errors: {
+			TRACK_NOT_FOUND: {
+				description: "Track not found for event routing",
+				http: 404,
+				gqlCode: "TRACK_NOT_FOUND",
+				when: "Track ID or routing context is invalid"
+			},
+			STEP_NOT_FOUND: {
+				description: "Step not found for completion condition",
+				http: 404,
+				gqlCode: "STEP_NOT_FOUND",
+				when: "No step matches the incoming event"
+			}
+		}
+	},
+	policy: { auth: "user" }
+});
+
+//#endregion
+export { GetOnboardingProgressContract, ListOnboardingTracksContract, OnboardingProgressModel, OnboardingStepModel, OnboardingStepProgressModel, OnboardingTrackModel, RecordOnboardingEventContract };
+//# sourceMappingURL=onboarding.js.map

package/dist/contracts/onboarding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.js","names":[],"sources":["../../src/contracts/onboarding.ts"],"sourcesContent":["import { ScalarTypeEnum, defineSchemaModel } from '@contractspec/lib.schema';\nimport { defineCommand, defineQuery } from '@contractspec/lib.contracts';\n\nimport { SuccessOutput } from './models';\nimport { LEARNING_JOURNEY_OWNERS } from './shared';\n\nconst OnboardingStepConditionModel = defineSchemaModel({\n  name: 'OnboardingStepCondition',\n  description: 'Structured completion condition for onboarding steps.',\n  fields: {\n    eventName: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    eventVersion: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    sourceModule: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    payloadFilter: { type: ScalarTypeEnum.JSON(), isOptional: true },\n  },\n});\n\nexport const OnboardingStepModel = defineSchemaModel({\n  name: 'OnboardingStep',\n  description: 'Declarative onboarding step definition.',\n  fields: {\n    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    instructions: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    helpUrl: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    order: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },\n    completionEvent: {\n      type: ScalarTypeEnum.String_unsecure(),\n      isOptional: false,\n    },\n    completionCondition: {\n      type: OnboardingStepConditionModel,\n      isOptional: true,\n    },\n    xpReward: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    isRequired: { type: ScalarTypeEnum.Boolean(), isOptional: true },\n    canSkip: { type: ScalarTypeEnum.Boolean(), isOptional: true },\n    actionUrl: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    actionLabel: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true },\n  },\n});\n\nexport const OnboardingTrackModel = defineSchemaModel({\n  name: 'OnboardingTrack',\n  description: 'Onboarding track metadata and steps.',\n  fields: {\n    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    productId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    targetUserSegment: {\n      type: ScalarTypeEnum.String_unsecure(),\n      isOptional: true,\n    },\n    targetRole: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: true },\n    isRequired: { type: ScalarTypeEnum.Boolean(), isOptional: true },\n    canSkip: { type: ScalarTypeEnum.Boolean(), isOptional: true },\n    totalXp: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    completionXpBonus: {\n      type: ScalarTypeEnum.Int_unsecure(),\n      isOptional: true,\n    },\n    completionBadgeKey: {\n      type: ScalarTypeEnum.String_unsecure(),\n      isOptional: true,\n    },\n    streakHoursWindow: {\n      type: ScalarTypeEnum.Int_unsecure(),\n      isOptional: true,\n    },\n    streakBonusXp: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true },\n    steps: { type: OnboardingStepModel, isArray: true, isOptional: false },\n  },\n});\n\nexport const OnboardingStepProgressModel = defineSchemaModel({\n  name: 'OnboardingStepProgress',\n  description: 'Progress for a specific onboarding step.',\n  fields: {\n    stepId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    triggeringEvent: {\n      type: ScalarTypeEnum.String_unsecure(),\n      isOptional: true,\n    },\n    eventPayload: { type: ScalarTypeEnum.JSON(), isOptional: true },\n    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },\n  },\n});\n\nexport const OnboardingProgressModel = defineSchemaModel({\n  name: 'OnboardingProgress',\n  description: 'Aggregated progress for an onboarding track.',\n  fields: {\n    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    progress: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },\n    isCompleted: { type: ScalarTypeEnum.Boolean(), isOptional: false },\n    xpEarned: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    startedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },\n    completedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },\n    lastActivityAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },\n    steps: {\n      type: OnboardingStepProgressModel,\n      isArray: true,\n      isOptional: true,\n    },\n  },\n});\n\nconst ListOnboardingTracksInput = defineSchemaModel({\n  name: 'ListOnboardingTracksInput',\n  description: 'Filters for listing onboarding tracks.',\n  fields: {\n    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    productId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    trackIds: {\n      type: ScalarTypeEnum.String_unsecure(),\n      isArray: true,\n      isOptional: true,\n    },\n    includeProgress: {\n      type: ScalarTypeEnum.Boolean(),\n      isOptional: true,\n    },\n  },\n});\n\nconst ListOnboardingTracksOutput = defineSchemaModel({\n  name: 'ListOnboardingTracksOutput',\n  description: 'Available onboarding tracks with optional progress.',\n  fields: {\n    tracks: { type: OnboardingTrackModel, isArray: true, isOptional: false },\n    progress: {\n      type: OnboardingProgressModel,\n      isArray: true,\n      isOptional: true,\n    },\n  },\n});\n\nconst GetOnboardingProgressInput = defineSchemaModel({\n  name: 'GetOnboardingProgressInput',\n  description: 'Input for fetching onboarding progress for a track.',\n  fields: {\n    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n  },\n});\n\nconst RecordOnboardingEventInput = defineSchemaModel({\n  name: 'RecordOnboardingEventInput',\n  description:\n    'Record a domain event to advance onboarding progress via completion conditions.',\n  fields: {\n    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    trackId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n    eventName: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n    eventVersion: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },\n    eventPayload: { type: ScalarTypeEnum.JSON(), isOptional: true },\n    occurredAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },\n  },\n});\n\nexport const ListOnboardingTracksContract = defineQuery({\n  meta: {\n    key: 'learning.onboarding.listTracks',\n    version: 1,\n    stability: 'stable',\n    owners: [...LEARNING_JOURNEY_OWNERS],\n    tags: ['learning', 'onboarding', 'journey'],\n    description: 'List onboarding tracks available to a learner or product.',\n    goal: 'Expose track catalog for UI/API surfaces.',\n    context: 'Called when showing onboarding/learning journey catalog.',\n  },\n  io: {\n    input: ListOnboardingTracksInput,\n    output: ListOnboardingTracksOutput,\n  },\n  policy: {\n    auth: 'user',\n  },\n});\n\nexport const GetOnboardingProgressContract = defineQuery({\n  meta: {\n    key: 'learning.onboarding.getProgress',\n    version: 1,\n    stability: 'stable',\n    owners: [...LEARNING_JOURNEY_OWNERS],\n    tags: ['learning', 'onboarding', 'journey'],\n    description: 'Fetch onboarding progress for a specific track.',\n    goal: 'Display learner progress and remaining steps.',\n    context: 'Called when rendering a track detail or widget.',\n  },\n  io: {\n    input: GetOnboardingProgressInput,\n    output: OnboardingProgressModel,\n  },\n  policy: {\n    auth: 'user',\n  },\n});\n\nexport const RecordOnboardingEventContract = defineCommand({\n  meta: {\n    key: 'learning.onboarding.recordEvent',\n    version: 1,\n    stability: 'stable',\n    owners: [...LEARNING_JOURNEY_OWNERS],\n    tags: ['learning', 'onboarding', 'events'],\n    description:\n      'Record a domain event to evaluate onboarding step completion conditions.',\n    goal: 'Advance onboarding automatically from product events.',\n    context:\n      'Called by event bus handlers when relevant product events fire (e.g., deal.created).',\n  },\n  io: {\n    input: RecordOnboardingEventInput,\n    output: SuccessOutput,\n    errors: {\n      TRACK_NOT_FOUND: {\n        description: 'Track not found for event routing',\n        http: 404,\n        gqlCode: 'TRACK_NOT_FOUND',\n        when: 'Track ID or routing context is invalid',\n      },\n      STEP_NOT_FOUND: {\n        description: 'Step not found for completion condition',\n        http: 404,\n        gqlCode: 'STEP_NOT_FOUND',\n        when: 'No step matches the incoming event',\n      },\n    },\n  },\n  policy: {\n    auth: 'user',\n  },\n});\n"],"mappings":";;;;;;AAMA,MAAM,+BAA+B,kBAAkB;CACrD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,cAAc;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EACvE,cAAc;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EAC1E,eAAe;GAAE,MAAM,eAAe,MAAM;GAAE,YAAY;GAAM;EACjE;CACF,CAAC;AAEF,MAAa,sBAAsB,kBAAkB;CACnD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,IAAI;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACjE,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACtE,OAAO;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACpE,aAAa;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACzE,cAAc;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EAC1E,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACrE,OAAO;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAO;EACjE,iBAAiB;GACf,MAAM,eAAe,iBAAiB;GACtC,YAAY;GACb;EACD,qBAAqB;GACnB,MAAM;GACN,YAAY;GACb;EACD,UAAU;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EACnE,YAAY;GAAE,MAAM,eAAe,SAAS;GAAE,YAAY;GAAM;EAChE,SAAS;GAAE,MAAM,eAAe,SAAS;GAAE,YAAY;GAAM;EAC7D,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACvE,aAAa;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACzE,UAAU;GAAE,MAAM,eAAe,MAAM;GAAE,YAAY;GAAM;EAC5D;CACF,CAAC;AAEF,MAAa,uBAAuB,kBAAkB;CACpD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,IAAI;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACjE,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACvE,MAAM;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACnE,aAAa;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACzE,mBAAmB;GACjB,MAAM,eAAe,iBAAiB;GACtC,YAAY;GACb;EACD,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACxE,UAAU;GAAE,MAAM,eAAe,SAAS;GAAE,YAAY;GAAM;EAC9D,YAAY;GAAE,MAAM,eAAe,SAAS;GAAE,YAAY;GAAM;EAChE,SAAS;GAAE,MAAM,eAAe,SAAS;GAAE,YAAY;GAAM;EAC7D,SAAS;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EAClE,mBAAmB;GACjB,MAAM,eAAe,cAAc;GACnC,YAAY;GACb;EACD,oBAAoB;GAClB,MAAM,eAAe,iBAAiB;GACtC,YAAY;GACb;EACD,mBAAmB;GACjB,MAAM,eAAe,cAAc;GACnC,YAAY;GACb;EACD,eAAe;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EACxE,UAAU;GAAE,MAAM,eAAe,MAAM;GAAE,YAAY;GAAM;EAC3D,OAAO;GAAE,MAAM;GAAqB,SAAS;GAAM,YAAY;GAAO;EACvE;CACF,CAAC;AAEF,MAAa,8BAA8B,kBAAkB;CAC3D,MAAM;CACN,aAAa;CACb,QAAQ;EACN,QAAQ;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACrE,QAAQ;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACrE,UAAU;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EACnE,iBAAiB;GACf,MAAM,eAAe,iBAAiB;GACtC,YAAY;GACb;EACD,cAAc;GAAE,MAAM,eAAe,MAAM;GAAE,YAAY;GAAM;EAC/D,aAAa;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAM;EACnE;CACF,CAAC;AAEF,MAAa,0BAA0B,kBAAkB;CACvD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACvE,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACtE,UAAU;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAO;EACpE,aAAa;GAAE,MAAM,eAAe,SAAS;GAAE,YAAY;GAAO;EAClE,UAAU;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EACnE,WAAW;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAM;EAChE,aAAa;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAM;EAClE,gBAAgB;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAM;EACrE,OAAO;GACL,MAAM;GACN,SAAS;GACT,YAAY;GACb;EACF;CACF,CAAC;AAEF,MAAM,4BAA4B,kBAAkB;CAClD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACvE,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACvE,UAAU;GACR,MAAM,eAAe,iBAAiB;GACtC,SAAS;GACT,YAAY;GACb;EACD,iBAAiB;GACf,MAAM,eAAe,SAAS;GAC9B,YAAY;GACb;EACF;CACF,CAAC;AAEF,MAAM,6BAA6B,kBAAkB;CACnD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,QAAQ;GAAE,MAAM;GAAsB,SAAS;GAAM,YAAY;GAAO;EACxE,UAAU;GACR,MAAM;GACN,SAAS;GACT,YAAY;GACb;EACF;CACF,CAAC;AAEF,MAAM,6BAA6B,kBAAkB;CACnD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACtE,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACxE;CACF,CAAC;AAEF,MAAM,6BAA6B,kBAAkB;CACnD,MAAM;CACN,aACE;CACF,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACrE,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,cAAc;GAAE,MAAM,eAAe,cAAc;GAAE,YAAY;GAAM;EACvE,cAAc;GAAE,MAAM,eAAe,MAAM;GAAE,YAAY;GAAM;EAC/D,YAAY;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAM;EAClE;CACF,CAAC;AAEF,MAAa,+BAA+B,YAAY;CACtD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,WAAW;EACX,QAAQ,CAAC,GAAG,wBAAwB;EACpC,MAAM;GAAC;GAAY;GAAc;GAAU;EAC3C,aAAa;EACb,MAAM;EACN,SAAS;EACV;CACD,IAAI;EACF,OAAO;EACP,QAAQ;EACT;CACD,QAAQ,EACN,MAAM,QACP;CACF,CAAC;AAEF,MAAa,gCAAgC,YAAY;CACvD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,WAAW;EACX,QAAQ,CAAC,GAAG,wBAAwB;EACpC,MAAM;GAAC;GAAY;GAAc;GAAU;EAC3C,aAAa;EACb,MAAM;EACN,SAAS;EACV;CACD,IAAI;EACF,OAAO;EACP,QAAQ;EACT;CACD,QAAQ,EACN,MAAM,QACP;CACF,CAAC;AAEF,MAAa,gCAAgC,cAAc;CACzD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,WAAW;EACX,QAAQ,CAAC,GAAG,wBAAwB;EACpC,MAAM;GAAC;GAAY;GAAc;GAAS;EAC1C,aACE;EACF,MAAM;EACN,SACE;EACH;CACD,IAAI;EACF,OAAO;EACP,QAAQ;EACR,QAAQ;GACN,iBAAiB;IACf,aAAa;IACb,MAAM;IACN,SAAS;IACT,MAAM;IACP;GACD,gBAAgB;IACd,aAAa;IACb,MAAM;IACN,SAAS;IACT,MAAM;IACP;GACF;EACF;CACD,QAAQ,EACN,MAAM,QACP;CACF,CAAC"}

package/dist/contracts/operations.d.ts

@@ -0,0 +1,280 @@
+import * as _contractspec_lib_schema678 from "@contractspec/lib.schema";
+import * as _contractspec_lib_contracts34 from "@contractspec/lib.contracts";
+
+//#region src/contracts/operations.d.ts
+/**
+ * Enroll in a course.
+ */
+declare const EnrollInCourseContract: _contractspec_lib_contracts34.OperationSpec<_contractspec_lib_schema678.SchemaModel<{
+  courseId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+}>, _contractspec_lib_schema678.SchemaModel<{
+  id: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  learnerId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  courseId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  progress: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+  startedAt: {
+    type: _contractspec_lib_schema678.FieldType<Date, string>;
+    isOptional: true;
+  };
+  completedAt: {
+    type: _contractspec_lib_schema678.FieldType<Date, string>;
+    isOptional: true;
+  };
+}>, undefined>;
+/**
+ * Complete a lesson.
+ */
+declare const CompleteLessonContract: _contractspec_lib_contracts34.OperationSpec<_contractspec_lib_schema678.SchemaModel<{
+  lessonId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  score: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: true;
+  };
+  timeSpent: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+}>, _contractspec_lib_schema678.SchemaModel<{
+  success: {
+    type: _contractspec_lib_schema678.FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  xpEarned: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, undefined>;
+/**
+ * Submit a card review.
+ */
+declare const SubmitCardReviewContract: _contractspec_lib_contracts34.OperationSpec<_contractspec_lib_schema678.SchemaModel<{
+  cardId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  rating: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: false;
+  };
+  responseTimeMs: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema678.SchemaModel<{
+  success: {
+    type: _contractspec_lib_schema678.FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  xpEarned: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, undefined>;
+/**
+ * Get cards due for review.
+ */
+declare const GetDueCardsContract: _contractspec_lib_contracts34.OperationSpec<_contractspec_lib_schema678.SchemaModel<{
+  deckId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: true;
+  };
+  limit: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema678.SchemaModel<{
+  cards: {
+    type: _contractspec_lib_schema678.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      deckId: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      front: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      back: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      hints: {
+        type: _contractspec_lib_schema678.FieldType<unknown, unknown>;
+        isOptional: true;
+      };
+      isDue: {
+        type: _contractspec_lib_schema678.FieldType<boolean, boolean>;
+        isOptional: false;
+      };
+      nextReviewAt: {
+        type: _contractspec_lib_schema678.FieldType<Date, string>;
+        isOptional: true;
+      };
+    }>;
+    isArray: true;
+    isOptional: false;
+  };
+  total: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+}>, undefined>;
+/**
+ * Get learner dashboard.
+ */
+declare const GetLearnerDashboardContract: _contractspec_lib_contracts34.OperationSpec<_contractspec_lib_schema678.SchemaModel<{
+  learnerId: {
+    type: _contractspec_lib_schema678.FieldType<string, string>;
+    isOptional: true;
+  };
+}>, _contractspec_lib_schema678.SchemaModel<{
+  learner: {
+    type: _contractspec_lib_schema678.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      userId: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      displayName: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: true;
+      };
+      level: {
+        type: _contractspec_lib_schema678.FieldType<number, number>;
+        isOptional: false;
+      };
+      totalXp: {
+        type: _contractspec_lib_schema678.FieldType<number, number>;
+        isOptional: false;
+      };
+      currentStreak: {
+        type: _contractspec_lib_schema678.FieldType<number, number>;
+        isOptional: false;
+      };
+      longestStreak: {
+        type: _contractspec_lib_schema678.FieldType<number, number>;
+        isOptional: false;
+      };
+      createdAt: {
+        type: _contractspec_lib_schema678.FieldType<Date, string>;
+        isOptional: false;
+      };
+    }>;
+    isOptional: false;
+  };
+  currentStreak: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+  dailyXpGoal: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+  dailyXpProgress: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+  activeEnrollments: {
+    type: _contractspec_lib_schema678.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      learnerId: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      courseId: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      status: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      progress: {
+        type: _contractspec_lib_schema678.FieldType<number, number>;
+        isOptional: false;
+      };
+      startedAt: {
+        type: _contractspec_lib_schema678.FieldType<Date, string>;
+        isOptional: true;
+      };
+      completedAt: {
+        type: _contractspec_lib_schema678.FieldType<Date, string>;
+        isOptional: true;
+      };
+    }>;
+    isArray: true;
+    isOptional: false;
+  };
+  recentAchievements: {
+    type: _contractspec_lib_schema678.SchemaModel<{
+      id: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      key: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      name: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      description: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: false;
+      };
+      icon: {
+        type: _contractspec_lib_schema678.FieldType<string, string>;
+        isOptional: true;
+      };
+      xpReward: {
+        type: _contractspec_lib_schema678.FieldType<number, number>;
+        isOptional: false;
+      };
+      unlockedAt: {
+        type: _contractspec_lib_schema678.FieldType<Date, string>;
+        isOptional: true;
+      };
+    }>;
+    isArray: true;
+    isOptional: false;
+  };
+  dueCardCount: {
+    type: _contractspec_lib_schema678.FieldType<number, number>;
+    isOptional: false;
+  };
+}>, undefined>;
+//#endregion
+export { CompleteLessonContract, EnrollInCourseContract, GetDueCardsContract, GetLearnerDashboardContract, SubmitCardReviewContract };
+//# sourceMappingURL=operations.d.ts.map