@contractspec/example.learning-journey-crm-onboarding 0.0.0-canary-20260113170453

package/src/operations/index.ts

@@ -0,0 +1,122 @@
+import { defineSchemaModel, ScalarTypeEnum } from '@contractspec/lib.schema';
+import { defineCommand, defineQuery } from '@contractspec/lib.contracts';
+
+import { crmFirstWinTrack } from '../track';
+
+const OWNERS = ['examples.learning-journey.crm-onboarding'] as const;
+
+const StepModel = defineSchemaModel({
+  name: 'CrmOnboardingStep',
+  description: 'Step metadata for CRM first win journey',
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    completionEvent: {
+      type: ScalarTypeEnum.String_unsecure(),
+      isOptional: false,
+    },
+    sourceModule: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+    xpReward: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+    order: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+  },
+});
+
+export const CrmOnboardingTrackModel = defineSchemaModel({
+  name: 'CrmOnboardingTrack',
+  description: 'CRM onboarding track definition',
+  fields: {
+    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    description: { type: ScalarTypeEnum.String_unsecure(), 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 },
+    steps: { type: StepModel, isArray: true, isOptional: false },
+  },
+});
+
+const TrackResponseModel = defineSchemaModel({
+  name: 'CrmOnboardingTrackResponse',
+  description: 'Response wrapper for CRM onboarding track',
+  fields: {
+    track: { type: CrmOnboardingTrackModel, isOptional: false },
+  },
+});
+
+const RecordDemoEventInput = defineSchemaModel({
+  name: 'CrmOnboardingRecordEventInput',
+  description: 'Emit a demo event to advance CRM onboarding steps',
+  fields: {
+    learnerId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    eventName: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+    payload: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    occurredAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+  },
+});
+
+const SuccessModel = defineSchemaModel({
+  name: 'CrmOnboardingSuccess',
+  description: 'Generic success response',
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+  },
+});
+
+export const GetCrmOnboardingTrack = defineQuery({
+  meta: {
+    key: 'learningJourney.crmOnboarding.getTrack',
+    version: '1.0.0',
+    stability: 'experimental',
+    owners: [...OWNERS],
+    tags: ['learning', 'crm', 'onboarding'],
+    description: 'Fetch CRM first win track definition.',
+    goal: 'Expose track metadata to UIs and templates.',
+    context: 'Called by Studio/Playground to render journey steps.',
+  },
+  io: {
+    input: defineSchemaModel({
+      name: 'CrmOnboardingTrackInput',
+      description: 'Track input',
+      fields: {},
+    }),
+    output: TrackResponseModel,
+  },
+  policy: { auth: 'user' },
+});
+
+export const RecordCrmOnboardingEvent = defineCommand({
+  meta: {
+    key: 'learningJourney.crmOnboarding.recordEvent',
+    version: '1.0.0',
+    stability: 'experimental',
+    owners: [...OWNERS],
+    tags: ['learning', 'crm', 'onboarding'],
+    description: 'Record an event to advance CRM onboarding progress.',
+    goal: 'Advance steps via domain events in demo/sandbox contexts.',
+    context:
+      'Called by handlers or demo scripts to emit step completion events.',
+  },
+  io: {
+    input: RecordDemoEventInput,
+    output: SuccessModel,
+  },
+  policy: { auth: 'user' },
+});
+
+export const crmOnboardingContracts = {
+  GetCrmOnboardingTrack,
+  RecordCrmOnboardingEvent,
+  track: crmFirstWinTrack,
+};

package/src/presentations/index.ts

@@ -0,0 +1,51 @@
+import { definePresentation, StabilityEnum, type PresentationSpecMeta } from '@contractspec/lib.contracts';
+import { CrmOnboardingTrackModel } from '../operations';
+
+const baseMeta: Pick<
+  PresentationSpecMeta,
+  'domain' | 'owners' | 'tags' | 'title' | 'stability' | 'goal' | 'context'
+> = {
+  domain: 'learning-journey',
+  title: 'CRM Onboarding',
+  owners: ['@examples.learning-journey.crm-onboarding'],
+  tags: ['learning', 'crm', 'onboarding'],
+  stability: StabilityEnum.Experimental,
+  goal: 'Guide CRM users through onboarding',
+  context: 'CRM onboarding journey',
+};
+
+export const CrmOnboardingTrackPresentation = definePresentation({
+  meta: {
+    key: 'learning.journey.crm.track',
+    version: '1.0.0',
+    description: 'CRM first win track detail',
+    ...baseMeta,
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'LearningTrackDetail',
+    props: CrmOnboardingTrackModel,
+  },
+  targets: ['react', 'markdown', 'application/json'],
+});
+
+export const CrmOnboardingWidgetPresentation = definePresentation({
+  meta: {
+    key: 'learning.journey.crm.widget',
+    version: '1.0.0',
+    description: 'Compact widget for CRM onboarding progress',
+    ...baseMeta,
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'LearningTrackProgressWidget',
+  },
+  targets: ['react'],
+});
+
+export const crmOnboardingPresentations = [
+  CrmOnboardingTrackPresentation,
+  CrmOnboardingWidgetPresentation,
+];

package/src/tests/operations.test-spec.ts

@@ -0,0 +1,31 @@
+import { defineTestSpec } from '@contractspec/lib.contracts';
+
+export const GetTrackTest = defineTestSpec({
+  meta: {
+    key: 'learningJourney.crmOnboarding.getTrack.test',
+    version: '1.0.0',
+    stability: 'experimental',
+    owners: ['@example.learning-journey-crm-onboarding'],
+    description: 'Test for getting CRM onboarding track',
+    tags: ['test'],
+  },
+  target: {
+    type: 'operation',
+    operation: {
+      key: 'learningJourney.crmOnboarding.getTrack',
+      version: '1.0.0',
+    },
+  },
+  scenarios: [
+    {
+      key: 'success',
+      when: { operation: { key: 'learningJourney.crmOnboarding.getTrack' } },
+      then: [{ type: 'expectOutput', match: {} }],
+    },
+    {
+      key: 'error',
+      when: { operation: { key: 'learningJourney.crmOnboarding.getTrack' } },
+      then: [{ type: 'expectError' }],
+    },
+  ],
+});

package/src/track.ts

@@ -0,0 +1,95 @@
+import type { LearningJourneyTrackSpec } from '@contractspec/module.learning-journey/track-spec';
+
+export const crmFirstWinTrack: LearningJourneyTrackSpec = {
+  id: 'crm_first_win',
+  productId: 'crm-pipeline',
+  name: 'CRM First Win',
+  description:
+    'Guide a new CRM user from empty pipeline to first closed-won deal.',
+  targetUserSegment: 'crm_adopter',
+  targetRole: 'sales',
+  totalXp: 135,
+  streakRule: { hoursWindow: 72, bonusXp: 25 },
+  completionRewards: { xpBonus: 25, badgeKey: 'crm_first_win' },
+  steps: [
+    {
+      id: 'create_pipeline',
+      title: 'Create pipeline & stages',
+      description: 'Create a pipeline with baseline stages.',
+      order: 1,
+      completion: {
+        eventName: 'pipeline.created',
+        sourceModule: '@contractspec/example.crm-pipeline',
+      },
+      xpReward: 15,
+      metadata: { surface: 'pipeline' },
+    },
+    {
+      id: 'create_contact_and_company',
+      title: 'Create contact and company',
+      description: 'Add your first contact and associated company.',
+      order: 2,
+      completion: {
+        eventName: 'contact.created',
+        sourceModule: '@contractspec/example.crm-pipeline',
+      },
+      xpReward: 20,
+      metadata: { surface: 'contacts' },
+    },
+    {
+      id: 'create_first_deal',
+      title: 'Log first deal',
+      description: 'Create your first deal in the pipeline.',
+      order: 3,
+      completion: {
+        eventName: 'deal.created',
+        sourceModule: '@contractspec/example.crm-pipeline',
+      },
+      xpReward: 20,
+      metadata: { surface: 'deals' },
+    },
+    {
+      id: 'move_deal_in_pipeline',
+      title: 'Move a deal across stages',
+      description: 'Move a deal across at least three stages.',
+      order: 4,
+      completion: {
+        eventName: 'deal.moved',
+        sourceModule: '@contractspec/example.crm-pipeline',
+      },
+      xpReward: 20,
+      metadata: { surface: 'deals' },
+    },
+    {
+      id: 'close_deal_won',
+      title: 'Close a deal as won',
+      description: 'Close a deal as won to hit first revenue.',
+      order: 5,
+      completion: {
+        eventName: 'deal.won',
+        sourceModule: '@contractspec/example.crm-pipeline',
+      },
+      xpReward: 30,
+      metadata: { surface: 'deals' },
+    },
+    {
+      id: 'setup_follow_up',
+      title: 'Create follow-up task',
+      description:
+        'Create a follow-up task and notification for a contact or deal.',
+      order: 6,
+      completion: {
+        eventName: 'task.completed',
+        sourceModule: '@contractspec/example.crm-pipeline',
+        payloadFilter: { type: 'follow_up' },
+      },
+      xpReward: 30,
+      metadata: { surface: 'tasks' },
+    },
+  ],
+  metadata: {
+    surfacedIn: ['crm/dashboard', 'crm/pipeline'],
+  },
+};
+
+export const crmLearningTracks: LearningJourneyTrackSpec[] = [crmFirstWinTrack];

package/tsconfig.json

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