@contractspec/example.video-docs-terminal 2.1.0

package/dist/node/sample-tutorials.js

@@ -0,0 +1,192 @@
+// src/sample-tutorials.ts
+var initTutorial = {
+  id: "init",
+  title: "Initialize a Project",
+  subtitle: "Set up a new ContractSpec workspace in seconds",
+  terminalTitle: "~/projects",
+  lines: [
+    { text: "contractspec init my-api", type: "command" },
+    { text: "Creating project my-api...", type: "output", delay: 15 },
+    { text: "  ├── contracts/", type: "output", delay: 5 },
+    { text: "  ├── generated/", type: "output", delay: 5 },
+    { text: "  ├── contractspec.config.ts", type: "output", delay: 5 },
+    { text: "  └── package.json", type: "output", delay: 5 },
+    { text: "✓ Project initialized", type: "success", delay: 10 },
+    { text: "cd my-api", type: "command", delay: 15 },
+    { text: "contractspec status", type: "command", delay: 15 },
+    {
+      text: "0 contracts · 0 generated files · ready",
+      type: "output",
+      delay: 10
+    }
+  ],
+  summary: "Your project is ready. Define contracts next.",
+  brief: {
+    title: "Initialize a ContractSpec Project",
+    summary: "The init command scaffolds a new workspace with contracts, generated output, and configuration.",
+    problems: [
+      "Setting up API projects manually is tedious and error-prone",
+      "Teams need a consistent project structure from day one"
+    ],
+    solutions: [
+      "One command creates the entire project scaffold",
+      "Standard structure ensures consistency across teams"
+    ],
+    audience: {
+      role: "Developer",
+      painPoints: ["Manual project setup", "Inconsistent project structure"]
+    },
+    callToAction: "Run contractspec init to get started."
+  }
+};
+var buildTutorial = {
+  id: "build",
+  title: "Build from Contracts",
+  subtitle: "Generate all surfaces from a single spec",
+  terminalTitle: "~/projects/my-api",
+  lines: [
+    { text: "# Define a contract first", type: "comment" },
+    { text: "contractspec build", type: "command", delay: 15 },
+    { text: "Building 3 contracts...", type: "output", delay: 15 },
+    { text: "  → CreateUser   REST + GraphQL + DB", type: "output", delay: 8 },
+    { text: "  → ListUsers    REST + GraphQL", type: "output", delay: 8 },
+    { text: "  → DeleteUser   REST + GraphQL + DB", type: "output", delay: 8 },
+    { text: "✓ 18 files generated in 0.4s", type: "success", delay: 12 },
+    { text: "contractspec status", type: "command", delay: 15 },
+    {
+      text: "3 contracts · 18 generated files · all up to date",
+      type: "output",
+      delay: 10
+    }
+  ],
+  summary: "3 contracts → 18 files. One spec, every surface.",
+  brief: {
+    title: "Build from Contracts",
+    summary: "The build command reads your contract definitions and generates REST, GraphQL, DB schemas, and more.",
+    problems: [
+      "Manually writing the same logic across REST, GraphQL, and DB",
+      "Generated code drifts out of sync with the spec"
+    ],
+    solutions: [
+      "Deterministic build: same spec always produces the same output",
+      "All surfaces generated in a single pass"
+    ],
+    metrics: [
+      "18 files from 3 contracts in 0.4 seconds",
+      "Zero manual synchronization"
+    ],
+    audience: {
+      role: "Developer",
+      painPoints: ["Cross-surface code duplication", "Schema drift"]
+    },
+    callToAction: "Run contractspec build after defining your contracts."
+  }
+};
+var validateTutorial = {
+  id: "validate",
+  title: "Validate Contracts",
+  subtitle: "Catch errors before they reach production",
+  terminalTitle: "~/projects/my-api",
+  lines: [
+    { text: "contractspec validate", type: "command" },
+    { text: "Validating 3 contracts...", type: "output", delay: 15 },
+    { text: "  ✓ CreateUser   schema valid", type: "success", delay: 8 },
+    { text: "  ✓ ListUsers    schema valid", type: "success", delay: 8 },
+    {
+      text: '  ✗ DeleteUser   missing required field "reason"',
+      type: "error",
+      delay: 8
+    },
+    { text: "", type: "output", delay: 5 },
+    { text: "2 passed · 1 failed", type: "output", delay: 10 },
+    { text: "# Fix the contract and re-validate", type: "comment", delay: 15 },
+    { text: "contractspec validate", type: "command", delay: 15 },
+    { text: "  ✓ CreateUser   schema valid", type: "success", delay: 8 },
+    { text: "  ✓ ListUsers    schema valid", type: "success", delay: 8 },
+    { text: "  ✓ DeleteUser   schema valid", type: "success", delay: 8 },
+    { text: "✓ All 3 contracts valid", type: "success", delay: 10 }
+  ],
+  summary: "Validate early, validate often.",
+  brief: {
+    title: "Validate Contracts",
+    summary: "The validate command checks all contracts against their schemas before generating code.",
+    problems: [
+      "Invalid schemas slip through to production",
+      "Catching errors late in the pipeline costs time"
+    ],
+    solutions: [
+      "Pre-build validation catches schema errors instantly",
+      "Clear error messages pinpoint exactly what needs fixing"
+    ],
+    audience: {
+      role: "Developer",
+      painPoints: ["Invalid schemas in production", "Late error detection"]
+    },
+    callToAction: "Run contractspec validate as part of your CI pipeline."
+  }
+};
+var deployTutorial = {
+  id: "deploy",
+  title: "Deploy Artifacts",
+  subtitle: "Ship generated code to production",
+  terminalTitle: "~/projects/my-api",
+  lines: [
+    { text: "contractspec build --production", type: "command" },
+    {
+      text: "✓ 18 files generated (production mode)",
+      type: "success",
+      delay: 15
+    },
+    { text: "contractspec publish --dry-run", type: "command", delay: 15 },
+    {
+      text: "Publishing @my-api/contracts v1.2.0...",
+      type: "output",
+      delay: 12
+    },
+    { text: "  → npm pack (dry run)", type: "output", delay: 8 },
+    { text: "  → 3 contracts, 18 generated files", type: "output", delay: 8 },
+    { text: "  → Package size: 24.3 KB", type: "output", delay: 8 },
+    {
+      text: "✓ Dry run complete -- ready to publish",
+      type: "success",
+      delay: 10
+    },
+    { text: "contractspec publish", type: "command", delay: 15 },
+    { text: "✓ Published @my-api/contracts@1.2.0", type: "success", delay: 15 }
+  ],
+  summary: "From spec to production in one pipeline.",
+  brief: {
+    title: "Deploy Artifacts",
+    summary: "Build in production mode and publish your generated contracts as an npm package.",
+    problems: [
+      "Deploying hand-written API code is risky and manual",
+      "Teams need confidence that generated code matches the spec"
+    ],
+    solutions: [
+      "Production builds are deterministic and reproducible",
+      "Dry-run publishing catches packaging issues before release"
+    ],
+    metrics: [
+      "24.3 KB package with 3 contracts and 18 files",
+      "Entire pipeline runs in seconds"
+    ],
+    audience: {
+      role: "DevOps Engineer",
+      painPoints: ["Manual deployment processes", "Spec-to-production drift"]
+    },
+    callToAction: "Add contractspec publish to your CI/CD pipeline."
+  }
+};
+var allTutorials = [
+  initTutorial,
+  buildTutorial,
+  validateTutorial,
+  deployTutorial
+];
+export {
+  validateTutorial,
+  initTutorial,
+  deployTutorial,
+  buildTutorial,
+  allTutorials
+};

package/dist/sample-tutorials.d.ts

@@ -0,0 +1,40 @@
+import type { TerminalLine } from '@contractspec/lib.video-gen/compositions/primitives/terminal';
+import type { ContentBrief } from '@contractspec/lib.content-gen/types';
+/**
+ * A CLI tutorial definition combining terminal lines with a content brief
+ * for narration generation.
+ */
+export interface CliTutorial {
+    /** Tutorial identifier */
+    id: string;
+    /** Display title for the scene */
+    title: string;
+    /** Subtitle shown below the title */
+    subtitle?: string;
+    /** Terminal window title */
+    terminalTitle: string;
+    /** Terminal lines (commands + output) */
+    lines: TerminalLine[];
+    /** Summary text shown after the terminal completes */
+    summary?: string;
+    /** Content brief used for narration generation */
+    brief: ContentBrief;
+}
+/**
+ * Tutorial: Initialize a new ContractSpec project.
+ */
+export declare const initTutorial: CliTutorial;
+/**
+ * Tutorial: Build and generate code from contracts.
+ */
+export declare const buildTutorial: CliTutorial;
+/**
+ * Tutorial: Validate contracts before building.
+ */
+export declare const validateTutorial: CliTutorial;
+/**
+ * Tutorial: Deploy generated artifacts.
+ */
+export declare const deployTutorial: CliTutorial;
+/** All sample tutorials in recommended presentation order. */
+export declare const allTutorials: CliTutorial[];

package/dist/sample-tutorials.js

@@ -0,0 +1,193 @@
+// @bun
+// src/sample-tutorials.ts
+var initTutorial = {
+  id: "init",
+  title: "Initialize a Project",
+  subtitle: "Set up a new ContractSpec workspace in seconds",
+  terminalTitle: "~/projects",
+  lines: [
+    { text: "contractspec init my-api", type: "command" },
+    { text: "Creating project my-api...", type: "output", delay: 15 },
+    { text: "  \u251C\u2500\u2500 contracts/", type: "output", delay: 5 },
+    { text: "  \u251C\u2500\u2500 generated/", type: "output", delay: 5 },
+    { text: "  \u251C\u2500\u2500 contractspec.config.ts", type: "output", delay: 5 },
+    { text: "  \u2514\u2500\u2500 package.json", type: "output", delay: 5 },
+    { text: "\u2713 Project initialized", type: "success", delay: 10 },
+    { text: "cd my-api", type: "command", delay: 15 },
+    { text: "contractspec status", type: "command", delay: 15 },
+    {
+      text: "0 contracts \xB7 0 generated files \xB7 ready",
+      type: "output",
+      delay: 10
+    }
+  ],
+  summary: "Your project is ready. Define contracts next.",
+  brief: {
+    title: "Initialize a ContractSpec Project",
+    summary: "The init command scaffolds a new workspace with contracts, generated output, and configuration.",
+    problems: [
+      "Setting up API projects manually is tedious and error-prone",
+      "Teams need a consistent project structure from day one"
+    ],
+    solutions: [
+      "One command creates the entire project scaffold",
+      "Standard structure ensures consistency across teams"
+    ],
+    audience: {
+      role: "Developer",
+      painPoints: ["Manual project setup", "Inconsistent project structure"]
+    },
+    callToAction: "Run contractspec init to get started."
+  }
+};
+var buildTutorial = {
+  id: "build",
+  title: "Build from Contracts",
+  subtitle: "Generate all surfaces from a single spec",
+  terminalTitle: "~/projects/my-api",
+  lines: [
+    { text: "# Define a contract first", type: "comment" },
+    { text: "contractspec build", type: "command", delay: 15 },
+    { text: "Building 3 contracts...", type: "output", delay: 15 },
+    { text: "  \u2192 CreateUser   REST + GraphQL + DB", type: "output", delay: 8 },
+    { text: "  \u2192 ListUsers    REST + GraphQL", type: "output", delay: 8 },
+    { text: "  \u2192 DeleteUser   REST + GraphQL + DB", type: "output", delay: 8 },
+    { text: "\u2713 18 files generated in 0.4s", type: "success", delay: 12 },
+    { text: "contractspec status", type: "command", delay: 15 },
+    {
+      text: "3 contracts \xB7 18 generated files \xB7 all up to date",
+      type: "output",
+      delay: 10
+    }
+  ],
+  summary: "3 contracts \u2192 18 files. One spec, every surface.",
+  brief: {
+    title: "Build from Contracts",
+    summary: "The build command reads your contract definitions and generates REST, GraphQL, DB schemas, and more.",
+    problems: [
+      "Manually writing the same logic across REST, GraphQL, and DB",
+      "Generated code drifts out of sync with the spec"
+    ],
+    solutions: [
+      "Deterministic build: same spec always produces the same output",
+      "All surfaces generated in a single pass"
+    ],
+    metrics: [
+      "18 files from 3 contracts in 0.4 seconds",
+      "Zero manual synchronization"
+    ],
+    audience: {
+      role: "Developer",
+      painPoints: ["Cross-surface code duplication", "Schema drift"]
+    },
+    callToAction: "Run contractspec build after defining your contracts."
+  }
+};
+var validateTutorial = {
+  id: "validate",
+  title: "Validate Contracts",
+  subtitle: "Catch errors before they reach production",
+  terminalTitle: "~/projects/my-api",
+  lines: [
+    { text: "contractspec validate", type: "command" },
+    { text: "Validating 3 contracts...", type: "output", delay: 15 },
+    { text: "  \u2713 CreateUser   schema valid", type: "success", delay: 8 },
+    { text: "  \u2713 ListUsers    schema valid", type: "success", delay: 8 },
+    {
+      text: '  \u2717 DeleteUser   missing required field "reason"',
+      type: "error",
+      delay: 8
+    },
+    { text: "", type: "output", delay: 5 },
+    { text: "2 passed \xB7 1 failed", type: "output", delay: 10 },
+    { text: "# Fix the contract and re-validate", type: "comment", delay: 15 },
+    { text: "contractspec validate", type: "command", delay: 15 },
+    { text: "  \u2713 CreateUser   schema valid", type: "success", delay: 8 },
+    { text: "  \u2713 ListUsers    schema valid", type: "success", delay: 8 },
+    { text: "  \u2713 DeleteUser   schema valid", type: "success", delay: 8 },
+    { text: "\u2713 All 3 contracts valid", type: "success", delay: 10 }
+  ],
+  summary: "Validate early, validate often.",
+  brief: {
+    title: "Validate Contracts",
+    summary: "The validate command checks all contracts against their schemas before generating code.",
+    problems: [
+      "Invalid schemas slip through to production",
+      "Catching errors late in the pipeline costs time"
+    ],
+    solutions: [
+      "Pre-build validation catches schema errors instantly",
+      "Clear error messages pinpoint exactly what needs fixing"
+    ],
+    audience: {
+      role: "Developer",
+      painPoints: ["Invalid schemas in production", "Late error detection"]
+    },
+    callToAction: "Run contractspec validate as part of your CI pipeline."
+  }
+};
+var deployTutorial = {
+  id: "deploy",
+  title: "Deploy Artifacts",
+  subtitle: "Ship generated code to production",
+  terminalTitle: "~/projects/my-api",
+  lines: [
+    { text: "contractspec build --production", type: "command" },
+    {
+      text: "\u2713 18 files generated (production mode)",
+      type: "success",
+      delay: 15
+    },
+    { text: "contractspec publish --dry-run", type: "command", delay: 15 },
+    {
+      text: "Publishing @my-api/contracts v1.2.0...",
+      type: "output",
+      delay: 12
+    },
+    { text: "  \u2192 npm pack (dry run)", type: "output", delay: 8 },
+    { text: "  \u2192 3 contracts, 18 generated files", type: "output", delay: 8 },
+    { text: "  \u2192 Package size: 24.3 KB", type: "output", delay: 8 },
+    {
+      text: "\u2713 Dry run complete -- ready to publish",
+      type: "success",
+      delay: 10
+    },
+    { text: "contractspec publish", type: "command", delay: 15 },
+    { text: "\u2713 Published @my-api/contracts@1.2.0", type: "success", delay: 15 }
+  ],
+  summary: "From spec to production in one pipeline.",
+  brief: {
+    title: "Deploy Artifacts",
+    summary: "Build in production mode and publish your generated contracts as an npm package.",
+    problems: [
+      "Deploying hand-written API code is risky and manual",
+      "Teams need confidence that generated code matches the spec"
+    ],
+    solutions: [
+      "Production builds are deterministic and reproducible",
+      "Dry-run publishing catches packaging issues before release"
+    ],
+    metrics: [
+      "24.3 KB package with 3 contracts and 18 files",
+      "Entire pipeline runs in seconds"
+    ],
+    audience: {
+      role: "DevOps Engineer",
+      painPoints: ["Manual deployment processes", "Spec-to-production drift"]
+    },
+    callToAction: "Add contractspec publish to your CI/CD pipeline."
+  }
+};
+var allTutorials = [
+  initTutorial,
+  buildTutorial,
+  validateTutorial,
+  deployTutorial
+];
+export {
+  validateTutorial,
+  initTutorial,
+  deployTutorial,
+  buildTutorial,
+  allTutorials
+};

package/package.json

@@ -0,0 +1,159 @@
+{
+  "name": "@contractspec/example.video-docs-terminal",
+  "version": "2.1.0",
+  "description": "Generate terminal demo videos from CLI walkthroughs using the TerminalDemo composition and ScriptGenerator.",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "bun": "./dist/index.js",
+      "node": "./dist/node/index.js",
+      "browser": "./dist/browser/index.js",
+      "default": "./dist/index.js"
+    },
+    "./build-tutorial": {
+      "types": "./dist/build-tutorial.d.ts",
+      "bun": "./dist/build-tutorial.js",
+      "node": "./dist/node/build-tutorial.js",
+      "browser": "./dist/browser/build-tutorial.js",
+      "default": "./dist/build-tutorial.js"
+    },
+    "./docs": {
+      "types": "./dist/docs/index.d.ts",
+      "bun": "./dist/docs/index.js",
+      "node": "./dist/node/docs/index.js",
+      "browser": "./dist/browser/docs/index.js",
+      "default": "./dist/docs/index.js"
+    },
+    "./docs/index": {
+      "types": "./dist/docs/index.d.ts",
+      "bun": "./dist/docs/index.js",
+      "node": "./dist/node/docs/index.js",
+      "browser": "./dist/browser/docs/index.js",
+      "default": "./dist/docs/index.js"
+    },
+    "./docs/video-docs-terminal.docblock": {
+      "types": "./dist/docs/video-docs-terminal.docblock.d.ts",
+      "bun": "./dist/docs/video-docs-terminal.docblock.js",
+      "node": "./dist/node/docs/video-docs-terminal.docblock.js",
+      "browser": "./dist/browser/docs/video-docs-terminal.docblock.js",
+      "default": "./dist/docs/video-docs-terminal.docblock.js"
+    },
+    "./example": {
+      "types": "./dist/example.d.ts",
+      "bun": "./dist/example.js",
+      "node": "./dist/node/example.js",
+      "browser": "./dist/browser/example.js",
+      "default": "./dist/example.js"
+    },
+    "./generate-narration": {
+      "types": "./dist/generate-narration.d.ts",
+      "bun": "./dist/generate-narration.js",
+      "node": "./dist/node/generate-narration.js",
+      "browser": "./dist/browser/generate-narration.js",
+      "default": "./dist/generate-narration.js"
+    },
+    "./sample-tutorials": {
+      "types": "./dist/sample-tutorials.d.ts",
+      "bun": "./dist/sample-tutorials.js",
+      "node": "./dist/node/sample-tutorials.js",
+      "browser": "./dist/browser/sample-tutorials.js",
+      "default": "./dist/sample-tutorials.js"
+    }
+  },
+  "scripts": {
+    "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
+    "publish:pkg:canary": "bun publish:pkg --tag canary",
+    "build": "bun run prebuild && bun run build:bundle && bun run build:types",
+    "build:bundle": "contractspec-bun-build transpile",
+    "build:types": "contractspec-bun-build types",
+    "dev": "contractspec-bun-build dev",
+    "clean": "rimraf dist .turbo",
+    "lint": "bun lint:fix",
+    "lint:fix": "eslint src --fix",
+    "lint:check": "eslint src",
+    "test": "bun test --pass-with-no-tests",
+    "prebuild": "contractspec-bun-build prebuild",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@contractspec/lib.contracts-spec": "2.1.1",
+    "@contractspec/lib.video-gen": "1.42.1",
+    "@contractspec/lib.content-gen": "2.1.1"
+  },
+  "devDependencies": {
+    "@contractspec/tool.typescript": "2.1.0",
+    "@contractspec/tool.bun": "2.1.0",
+    "typescript": "^5.9.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "bun": "./dist/index.js",
+        "node": "./dist/node/index.js",
+        "browser": "./dist/browser/index.js",
+        "default": "./dist/index.js"
+      },
+      "./build-tutorial": {
+        "types": "./dist/build-tutorial.d.ts",
+        "bun": "./dist/build-tutorial.js",
+        "node": "./dist/node/build-tutorial.js",
+        "browser": "./dist/browser/build-tutorial.js",
+        "default": "./dist/build-tutorial.js"
+      },
+      "./docs": {
+        "types": "./dist/docs/index.d.ts",
+        "bun": "./dist/docs/index.js",
+        "node": "./dist/node/docs/index.js",
+        "browser": "./dist/browser/docs/index.js",
+        "default": "./dist/docs/index.js"
+      },
+      "./docs/index": {
+        "types": "./dist/docs/index.d.ts",
+        "bun": "./dist/docs/index.js",
+        "node": "./dist/node/docs/index.js",
+        "browser": "./dist/browser/docs/index.js",
+        "default": "./dist/docs/index.js"
+      },
+      "./docs/video-docs-terminal.docblock": {
+        "types": "./dist/docs/video-docs-terminal.docblock.d.ts",
+        "bun": "./dist/docs/video-docs-terminal.docblock.js",
+        "node": "./dist/node/docs/video-docs-terminal.docblock.js",
+        "browser": "./dist/browser/docs/video-docs-terminal.docblock.js",
+        "default": "./dist/docs/video-docs-terminal.docblock.js"
+      },
+      "./example": {
+        "types": "./dist/example.d.ts",
+        "bun": "./dist/example.js",
+        "node": "./dist/node/example.js",
+        "browser": "./dist/browser/example.js",
+        "default": "./dist/example.js"
+      },
+      "./generate-narration": {
+        "types": "./dist/generate-narration.d.ts",
+        "bun": "./dist/generate-narration.js",
+        "node": "./dist/node/generate-narration.js",
+        "browser": "./dist/browser/generate-narration.js",
+        "default": "./dist/generate-narration.js"
+      },
+      "./sample-tutorials": {
+        "types": "./dist/sample-tutorials.d.ts",
+        "bun": "./dist/sample-tutorials.js",
+        "node": "./dist/node/sample-tutorials.js",
+        "browser": "./dist/browser/sample-tutorials.js",
+        "default": "./dist/sample-tutorials.js"
+      }
+    },
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lssm-tech/contractspec.git",
+    "directory": "packages/examples/video-docs-terminal"
+  },
+  "homepage": "https://contractspec.io"
+}