@contractspec/example.learning-journey-studio-onboarding 1.44.0

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@contractspec/example.learning-journey-studio-onboarding",
+  "version": "1.44.0",
+  "description": "Learning journey track for first 30 minutes in ContractSpec Studio.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./docs": "./dist/docs/index.js",
+    "./docs/studio-onboarding.docblock": "./dist/docs/studio-onboarding.docblock.js",
+    "./example": "./dist/example.js",
+    "./handlers/demo.handlers": "./dist/handlers/demo.handlers.js",
+    "./learning-journey-studio-onboarding.feature": "./dist/learning-journey-studio-onboarding.feature.js",
+    "./operations": "./dist/operations/index.js",
+    "./presentations": "./dist/presentations/index.js",
+    "./track": "./dist/track.js",
+    "./*": "./*"
+  },
+  "scripts": {
+    "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
+    "publish:pkg:canary": "bun publish:pkg --tag canary",
+    "build": "bun build:types && bun build:bundle",
+    "build:bundle": "tsdown",
+    "build:types": "tsc --noEmit",
+    "dev": "bun build:bundle --watch",
+    "clean": "rimraf dist .turbo",
+    "lint": "bun lint:fix",
+    "lint:fix": "eslint src --fix",
+    "lint:check": "eslint src"
+  },
+  "dependencies": {
+    "@contractspec/lib.contracts": "1.44.0",
+    "@contractspec/lib.schema": "1.44.0",
+    "@contractspec/module.learning-journey": "1.44.0"
+  },
+  "devDependencies": {
+    "@contractspec/tool.tsdown": "1.44.0",
+    "@contractspec/tool.typescript": "1.44.0",
+    "tsdown": "^0.18.3",
+    "typescript": "^5.9.3"
+  },
+  "module": "./dist/index.js",
+  "publishConfig": {
+    "exports": {
+      ".": "./dist/index.js",
+      "./contracts": "./dist/contracts/index.js",
+      "./docs": "./dist/docs/index.js",
+      "./docs/studio-onboarding.docblock": "./dist/docs/studio-onboarding.docblock.js",
+      "./example": "./dist/example.js",
+      "./handlers/demo.handlers": "./dist/handlers/demo.handlers.js",
+      "./learning-journey-studio-onboarding.feature": "./dist/learning-journey-studio-onboarding.feature.js",
+      "./presentations": "./dist/presentations/index.js",
+      "./track": "./dist/track.js",
+      "./*": "./*"
+    },
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lssm-tech/contractspec.git",
+    "directory": "packages/examples/learning-journey-studio-onboarding"
+  },
+  "homepage": "https://contractspec.io"
+}

package/src/docs/index.ts

@@ -0,0 +1 @@
+import './studio-onboarding.docblock';

package/src/docs/studio-onboarding.docblock.ts

@@ -0,0 +1,38 @@
+import type { DocBlock } from '@contractspec/lib.contracts';
+import { registerDocBlocks } from '@contractspec/lib.contracts';
+
+const studioOnboardingDocBlocks: DocBlock[] = [
+  {
+    id: 'docs.learning-journey.studio-onboarding',
+    title: 'Learning Journey — Studio Getting Started',
+    summary:
+      'Track that guides a new Studio user through template spawn, spec edit, regeneration, playground, and evolution.',
+    kind: 'reference',
+    visibility: 'public',
+    route: '/docs/learning-journey/studio-onboarding',
+    tags: ['learning', 'onboarding', 'studio'],
+    body: `## Track
+- **Key**: \`studio_getting_started\`
+- **Persona**: new Studio developer, first 30 minutes
+- **Goal**: instantiate template → edit spec → regenerate → play → run evolution
+
+## Steps & Events
+1) \`choose_template\` → event \`studio.template.instantiated\`
+2) \`edit_spec\` → event \`spec.changed\` (scope: sandbox)
+3) \`regenerate_app\` → event \`regeneration.completed\`
+4) \`play_in_playground\` → event \`playground.session.started\`
+5) \`try_evolution_mode\` → event \`studio.evolution.applied\`
+
+XP: 20/20/20/20/30 with bonus 25 XP if completed within 48h (streak rule). Badge: \`studio_first_30m\`.
+
+## Wiring
+- Tracks export from \`@contractspec/example.learning-journey-studio-onboarding/track\`.
+- Use onboarding API:
+  - \`learning.onboarding.listTracks\` to surface catalog
+  - \`learning.onboarding.getProgress\` to render progress
+  - \`learning.onboarding.recordEvent\` to advance from bus events
+- Events should be emitted by Studio surfaces (template creation, spec save, regeneration, playground session start, evolution apply).`,
+  },
+];
+
+registerDocBlocks(studioOnboardingDocBlocks);

package/src/example.ts

@@ -0,0 +1,24 @@
+const example = {
+  id: 'learning-journey-studio-onboarding',
+  title: 'Learning Journey — Studio Getting Started',
+  summary:
+    'Onboarding track guiding a new Studio user through template spawn, spec edit, regeneration, playground, and evolution.',
+  tags: ['learning', 'onboarding', 'studio'],
+  kind: 'template',
+  visibility: 'public',
+  docs: {
+    rootDocId: 'docs.learning-journey.studio-onboarding',
+  },
+  entrypoints: {
+    packageName: '@contractspec/example.learning-journey-studio-onboarding',
+    docs: './docs',
+  },
+  surfaces: {
+    templates: true,
+    sandbox: { enabled: true, modes: ['playground', 'markdown'] },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true },
+  },
+} as const;
+
+export default example;

package/src/handlers/demo.handlers.ts

@@ -0,0 +1,48 @@
+import { studioGettingStartedTrack } from '../track';
+
+interface EmitParams {
+  learnerId: string;
+  occurredAt?: Date;
+}
+
+interface LearningJourneyEvent {
+  learnerId: string;
+  name: string;
+  occurredAt: Date;
+  trackId: string;
+  payload?: Record<string, unknown>;
+}
+
+type RecordEvent = (event: LearningJourneyEvent) => unknown;
+
+export const studioOnboardingEvents = [
+  'studio.template.instantiated',
+  'spec.changed',
+  'regeneration.completed',
+  'playground.session.started',
+  'studio.evolution.applied',
+] as const;
+
+export type StudioEvent = (typeof studioOnboardingEvents)[number];
+
+export const emitStudioOnboardingEvent = (
+  eventName: StudioEvent,
+  { learnerId, occurredAt = new Date() }: EmitParams,
+  record?: RecordEvent
+) => {
+  const event: LearningJourneyEvent = {
+    learnerId,
+    name: eventName,
+    occurredAt,
+    trackId: studioGettingStartedTrack.id,
+  };
+  return record ? record(event) : event;
+};
+
+export const emitAllStudioOnboardingEvents = (
+  params: EmitParams,
+  record?: RecordEvent
+) =>
+  studioOnboardingEvents.map((name) =>
+    emitStudioOnboardingEvent(name, params, record)
+  );

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './track';
+export * from './docs';
+export * from './operations';
+export * from './handlers/demo.handlers';
+export * from './presentations';
+export * from './learning-journey-studio-onboarding.feature';
+export { default as example } from './example';

package/src/learning-journey-studio-onboarding.feature.ts

@@ -0,0 +1,66 @@
+/**
+ * Learning Journey Studio Onboarding Feature Module Specification
+ *
+ * Defines the feature module for Studio onboarding journey.
+ */
+import type { FeatureModuleSpec } from '@contractspec/lib.contracts';
+
+/**
+ * Learning Journey Studio Onboarding feature module that bundles
+ * Studio-specific onboarding track operations and presentations.
+ */
+export const LearningJourneyStudioOnboardingFeature: FeatureModuleSpec = {
+  meta: {
+    key: 'learning-journey-studio-onboarding',
+    title: 'Learning Journey: Studio Onboarding',
+    description:
+      'Studio onboarding journey for getting started with ContractSpec Studio',
+    domain: 'learning-journey',
+    owners: ['@examples.learning-journey.studio-onboarding'],
+    tags: ['learning', 'onboarding', 'studio', 'journey'],
+    stability: 'experimental',
+    version: 1,
+  },
+
+  // All contract operations included in this feature
+  operations: [
+    { key: 'learningJourney.studioOnboarding.recordEvent', version: 1 },
+    { key: 'learningJourney.studioOnboarding.getTrack', version: 1 },
+  ],
+
+  // Events emitted by this feature
+  events: [],
+
+  // Presentations associated with this feature
+  presentations: [
+    { key: 'learning.journey.studio.track', version: 1 },
+    { key: 'learning.journey.studio.widget', version: 1 },
+  ],
+
+  // Link operations to their primary presentations
+  opToPresentation: [
+    {
+      op: { key: 'learningJourney.studioOnboarding.getTrack', version: 1 },
+      pres: { key: 'learning.journey.studio.track', version: 1 },
+    },
+  ],
+
+  // Target requirements for multi-surface rendering
+  presentationsTargets: [
+    {
+      key: 'learning.journey.studio.track',
+      version: 1,
+      targets: ['react', 'markdown', 'application/json'],
+    },
+    {
+      key: 'learning.journey.studio.widget',
+      version: 1,
+      targets: ['react'],
+    },
+  ],
+
+  // Capability requirements
+  capabilities: {
+    requires: [{ key: 'identity', version: 1 }],
+  },
+};

package/src/operations/index.test.ts

@@ -0,0 +1,49 @@
+import { describe, expect, it } from 'bun:test';
+
+import {
+  GetStudioOnboardingTrack,
+  RecordStudioOnboardingEvent,
+  studioOnboardingContracts,
+} from './index';
+import { studioGettingStartedTrack } from '../track';
+import {
+  emitStudioOnboardingEvent,
+  studioOnboardingEvents,
+} from '../handlers/demo.handlers';
+import type { StudioEvent } from '../handlers/demo.handlers';
+
+describe('studio onboarding contracts', () => {
+  it('exposes track metadata', () => {
+    expect(studioOnboardingContracts.track.id).toBe('studio_getting_started');
+    expect(studioOnboardingContracts.track.steps.length).toBeGreaterThan(0);
+    expect(GetStudioOnboardingTrack.meta.key).toBe(
+      'learningJourney.studioOnboarding.getTrack'
+    );
+  });
+
+  it('allows recording events via demo handler', async () => {
+    const step = studioGettingStartedTrack.steps[0];
+    expect(step).toBeDefined();
+    if (!step) throw new Error('Expected at least one onboarding step');
+
+    const eventName = step.completion.eventName;
+    const isStudioEvent = (value: string): value is StudioEvent =>
+      studioOnboardingEvents.includes(value as StudioEvent);
+
+    expect(isStudioEvent(eventName)).toBe(true);
+    if (!isStudioEvent(eventName)) {
+      throw new Error(`Unexpected event name: ${eventName}`);
+    }
+
+    const result = await emitStudioOnboardingEvent(eventName, {
+      learnerId: 'demo-learner',
+    });
+    expect(result).toBeDefined();
+  });
+
+  it('exposes record event contract', () => {
+    expect(RecordStudioOnboardingEvent.meta.key).toBe(
+      'learningJourney.studioOnboarding.recordEvent'
+    );
+  });
+});

package/src/operations/index.ts

@@ -0,0 +1,122 @@
+import { ScalarTypeEnum, defineSchemaModel } from '@contractspec/lib.schema';
+import { defineCommand, defineQuery } from '@contractspec/lib.contracts';
+
+import { studioGettingStartedTrack } from '../track';
+
+const OWNERS = ['examples.learning-journey.studio-onboarding'] as const;
+
+const StepModel = defineSchemaModel({
+  name: 'StudioOnboardingStep',
+  description: 'Step metadata for Studio onboarding 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 StudioOnboardingTrackModel = defineSchemaModel({
+  name: 'StudioOnboardingTrack',
+  description: 'Studio 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: 'StudioOnboardingTrackResponse',
+  description: 'Response wrapper for studio onboarding track',
+  fields: {
+    track: { type: StudioOnboardingTrackModel, isOptional: false },
+  },
+});
+
+const RecordDemoEventInput = defineSchemaModel({
+  name: 'StudioOnboardingRecordEventInput',
+  description: 'Emit a demo event to advance Studio 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: 'StudioOnboardingSuccess',
+  description: 'Generic success response',
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+  },
+});
+
+export const GetStudioOnboardingTrack = defineQuery({
+  meta: {
+    key: 'learningJourney.studioOnboarding.getTrack',
+    version: 1,
+    stability: 'experimental',
+    owners: [...OWNERS],
+    tags: ['learning', 'onboarding', 'studio'],
+    description: 'Fetch the Studio onboarding track definition.',
+    goal: 'Expose track metadata to UIs and templates.',
+    context: 'Called by Studio/Playground to render journey steps.',
+  },
+  io: {
+    input: defineSchemaModel({
+      name: 'StudioOnboardingTrackInput',
+      description: 'Track input',
+      fields: {},
+    }),
+    output: TrackResponseModel,
+  },
+  policy: { auth: 'user' },
+});
+
+export const RecordStudioOnboardingEvent = defineCommand({
+  meta: {
+    key: 'learningJourney.studioOnboarding.recordEvent',
+    version: 1,
+    stability: 'experimental',
+    owners: [...OWNERS],
+    tags: ['learning', 'onboarding', 'studio'],
+    description: 'Record an event to advance Studio 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 studioOnboardingContracts = {
+  GetStudioOnboardingTrack,
+  RecordStudioOnboardingEvent,
+  track: studioGettingStartedTrack,
+};

package/src/presentations/index.ts

@@ -0,0 +1,57 @@
+import type {
+  PresentationSpecMeta,
+  PresentationSpec,
+} from '@contractspec/lib.contracts';
+import { StabilityEnum } from '@contractspec/lib.contracts';
+import { StudioOnboardingTrackModel } from '../operations';
+
+const baseMeta: Pick<
+  PresentationSpecMeta,
+  'domain' | 'owners' | 'tags' | 'title' | 'stability'
+> = {
+  domain: 'learning-journey',
+  title: 'Studio Onboarding',
+  owners: ['@examples.learning-journey.studio-onboarding'] as string[],
+  tags: ['learning', 'onboarding', 'studio'] as string[],
+  stability: StabilityEnum.Experimental,
+};
+
+export const StudioOnboardingTrackPresentation: PresentationSpec = {
+  meta: {
+    key: 'learning.journey.studio.track',
+    version: 1,
+    description: 'Studio onboarding track detail',
+    goal: 'Visualize the onboarding track for the user.',
+    context: 'Displayed in the Studio dashboard.',
+    ...baseMeta,
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'LearningTrackDetail',
+    props: StudioOnboardingTrackModel,
+  },
+  targets: ['react', 'markdown', 'application/json'],
+};
+
+export const StudioOnboardingWidgetPresentation: PresentationSpec = {
+  meta: {
+    key: 'learning.journey.studio.widget',
+    version: 1,
+    description: 'Compact widget for Studio onboarding progress',
+    goal: 'Show quick progress summary.',
+    context: 'Displayed in the Studio sidebar or header.',
+    ...baseMeta,
+  },
+  source: {
+    type: 'component',
+    framework: 'react',
+    componentKey: 'LearningTrackProgressWidget',
+  },
+  targets: ['react'],
+};
+
+export const studioOnboardingPresentations = [
+  StudioOnboardingTrackPresentation,
+  StudioOnboardingWidgetPresentation,
+];

package/src/track.ts

@@ -0,0 +1,86 @@
+import type { LearningJourneyTrackSpec } from '@contractspec/module.learning-journey/track-spec';
+
+export const studioGettingStartedTrack: LearningJourneyTrackSpec = {
+  id: 'studio_getting_started',
+  productId: 'contractspec-studio',
+  name: 'Studio Getting Started',
+  description:
+    'First 30 minutes in Studio: create a project, edit the spec, deploy/regenerate, and try key modules.',
+  targetUserSegment: 'new_studio_user',
+  targetRole: 'developer',
+  totalXp: 110,
+  streakRule: { hoursWindow: 48, bonusXp: 25 },
+  completionRewards: { xpBonus: 25, badgeKey: 'studio_first_30m' },
+  steps: [
+    {
+      id: 'choose_template',
+      title: 'Choose a template',
+      description: 'Create your first Studio project (starter template).',
+      order: 1,
+      completion: {
+        eventName: 'studio.template.instantiated',
+        sourceModule: '@contractspec/bundle.studio',
+      },
+      xpReward: 20,
+      metadata: { surface: 'projects' },
+    },
+    {
+      id: 'edit_spec',
+      title: 'Edit the spec',
+      description: 'Change the spec (not generated code) and save.',
+      instructions: 'Open spec editor, tweak a contract or presentation, save.',
+      order: 2,
+      completion: {
+        eventName: 'spec.changed',
+        sourceModule: '@contractspec/bundle.studio',
+      },
+      xpReward: 20,
+      metadata: { surface: 'spec-editor' },
+    },
+    {
+      id: 'regenerate_app',
+      title: 'Regenerate the app',
+      description: 'Regenerate artifacts from the updated spec.',
+      order: 3,
+      completion: {
+        eventName: 'regeneration.completed',
+        sourceModule: '@contractspec/lib.contracts/regenerator',
+      },
+      xpReward: 20,
+      metadata: { surface: 'regenerator' },
+    },
+    {
+      id: 'open_canvas',
+      title: 'Open the canvas',
+      description: 'Visit the canvas module for your project.',
+      order: 4,
+      completion: {
+        eventName: 'module.navigated',
+        sourceModule: '@contractspec/bundle.studio',
+        payloadFilter: { moduleId: 'canvas' },
+      },
+      xpReward: 20,
+      metadata: { surface: 'canvas' },
+    },
+    {
+      id: 'try_evolution_mode',
+      title: 'Try evolution mode',
+      description: 'Request a change via Evolution, then regenerate.',
+      order: 5,
+      completion: {
+        eventName: 'studio.evolution.applied',
+        sourceModule: '@contractspec/lib.evolution',
+      },
+      xpReward: 30,
+      metadata: { surface: 'evolution' },
+    },
+  ],
+  metadata: {
+    persona: 'first_run',
+    surfacedIn: ['studio/home', 'studio/sidebar/learning'],
+  },
+};
+
+export const studioLearningTracks: LearningJourneyTrackSpec[] = [
+  studioGettingStartedTrack,
+];

package/tsconfig.json

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