@contractspec/example.learning-journey-quest-challenges 1.44.0

package/src/track.test.ts

@@ -0,0 +1,52 @@
+import { describe, expect, it } from 'bun:test';
+
+import { moneyResetQuestTrack } from './track';
+
+const addDays = (date: Date, days: number) =>
+  new Date(date.getTime() + days * 24 * 60 * 60 * 1000);
+
+type StepStatus = 'PENDING' | 'COMPLETED';
+
+describe('quest challenges track', () => {
+  it('unlocks by day and completes within window', () => {
+    const start = new Date('2024-01-01T09:00:00Z');
+    const events = [
+      { name: 'accounts.mapped', dayOffset: 0 },
+      { name: 'transactions.categorized', dayOffset: 1 },
+      { name: 'goals.created', dayOffset: 2 },
+      { name: 'recurring_rule.created', dayOffset: 3 },
+      { name: 'subscription.flagged_or_cancelled', dayOffset: 4 },
+      { name: 'emergency_plan.completed', dayOffset: 5 },
+      { name: 'quest.review.completed', dayOffset: 6 },
+    ];
+
+    const progress = moneyResetQuestTrack.steps.map((step) => ({
+      id: step.id,
+      status: 'PENDING' as StepStatus,
+    }));
+
+    events.forEach((evt) => {
+      const now = addDays(start, evt.dayOffset);
+      moneyResetQuestTrack.steps.forEach((spec, idx) => {
+        const step = progress[idx];
+        if (!step || step.status === 'COMPLETED') return;
+        const availableAt =
+          spec.availability?.unlockOnDay !== undefined
+            ? addDays(start, spec.availability.unlockOnDay - 1)
+            : start;
+        if (now < availableAt) return;
+        const within =
+          spec.completion.kind === 'time_window' &&
+          spec.completion.withinHoursOfStart !== undefined
+            ? (now.getTime() - start.getTime()) / (1000 * 60 * 60) <=
+              spec.completion.withinHoursOfStart
+            : true;
+        if (!within) return;
+        if (spec.completion.eventName !== evt.name) return;
+        step.status = 'COMPLETED';
+      });
+    });
+
+    expect(progress.every((s) => s.status === 'COMPLETED')).toBeTrue();
+  });
+});

package/src/track.ts

@@ -0,0 +1,76 @@
+import type { LearningJourneyTrackSpec } from '@contractspec/module.learning-journey/track-spec';
+
+const dayStep = (
+  id: string,
+  day: number,
+  eventName: string,
+  description: string
+): LearningJourneyTrackSpec['steps'][number] => ({
+  id,
+  title: `Day ${day}`,
+  description,
+  availability: { unlockOnDay: day },
+  completion: {
+    kind: 'time_window',
+    eventName,
+    withinHoursOfStart: (day + 1) * 24, // allow grace through next day
+  },
+  xpReward: 15,
+  metadata: { day },
+});
+
+export const moneyResetQuestTrack: LearningJourneyTrackSpec = {
+  id: 'money_reset_7day',
+  name: '7-day Money Reset',
+  description:
+    'Time-bound quest to reset personal finances over a focused week.',
+  targetUserSegment: 'money_user',
+  totalXp: 105,
+  completionRewards: { xpBonus: 30 },
+  steps: [
+    dayStep(
+      'day1_map_accounts',
+      1,
+      'accounts.mapped',
+      'Map bank and card accounts.'
+    ),
+    dayStep(
+      'day2_categorize_transactions',
+      2,
+      'transactions.categorized',
+      'Categorize recent transactions.'
+    ),
+    dayStep(
+      'day3_define_goals',
+      3,
+      'goals.created',
+      'Define at least one savings goal.'
+    ),
+    dayStep(
+      'day4_setup_recurring_savings',
+      4,
+      'recurring_rule.created',
+      'Set a recurring savings rule.'
+    ),
+    dayStep(
+      'day5_review_subscriptions',
+      5,
+      'subscription.flagged_or_cancelled',
+      'Review subscriptions and flag or cancel wasteful ones.'
+    ),
+    dayStep(
+      'day6_plan_emergency',
+      6,
+      'emergency_plan.completed',
+      'Draft an emergency plan and target buffer.'
+    ),
+    dayStep(
+      'day7_review_commit',
+      7,
+      'quest.review.completed',
+      'Review week outcomes and commit to the next month.'
+    ),
+  ],
+};
+
+export const questTracks: LearningJourneyTrackSpec[] = [moneyResetQuestTrack];

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@contractspec/tool.typescript/react-library.json",
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  }
+}