@contractspec/example.video-docs-terminal 2.1.0

package/.turbo/turbo-build.log

@@ -0,0 +1,38 @@
+$ contractspec-bun-build prebuild
+$ bun run prebuild && bun run build:bundle && bun run build:types
+$ contractspec-bun-build prebuild
+$ contractspec-bun-build transpile
+[contractspec-bun-build] transpile target=bun root=src entries=7
+Bundled 7 modules in 28ms
+
+  ./build-tutorial.js                   1.87 KB   (entry point)
+  ./index.js                            14.53 KB  (entry point)
+  docs/index.js                         3.77 KB   (entry point)
+  docs/video-docs-terminal.docblock.js  3.77 KB   (entry point)
+  ./example.js                          1.0 KB    (entry point)
+  ./generate-narration.js               0.69 KB   (entry point)
+  ./sample-tutorials.js                 7.26 KB   (entry point)
+
+[contractspec-bun-build] transpile target=node root=src entries=7
+Bundled 7 modules in 31ms
+
+  ./build-tutorial.js                   1.86 KB   (entry point)
+  ./index.js                            14.42 KB  (entry point)
+  docs/index.js                         3.76 KB   (entry point)
+  docs/video-docs-terminal.docblock.js  3.76 KB   (entry point)
+  ./example.js                          1.00 KB   (entry point)
+  ./generate-narration.js               0.68 KB   (entry point)
+  ./sample-tutorials.js                 7.15 KB   (entry point)
+
+[contractspec-bun-build] transpile target=browser root=src entries=7
+Bundled 7 modules in 17ms
+
+  ./build-tutorial.js                   1.86 KB   (entry point)
+  ./index.js                            14.42 KB  (entry point)
+  docs/index.js                         3.76 KB   (entry point)
+  docs/video-docs-terminal.docblock.js  3.76 KB   (entry point)
+  ./example.js                          1.00 KB   (entry point)
+  ./generate-narration.js               0.68 KB   (entry point)
+  ./sample-tutorials.js                 7.15 KB   (entry point)
+
+$ contractspec-bun-build types

package/.turbo/turbo-prebuild.log

@@ -0,0 +1 @@
+$ contractspec-bun-build prebuild

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @contractspec/example.video-docs-terminal
+
+## 2.1.0
+
+### Minor Changes
+
+- ac88935: chore: add examples
+
+### Patch Changes
+
+- Updated dependencies [57e2819]
+  - @contractspec/lib.contracts-spec@2.1.1
+  - @contractspec/lib.content-gen@2.1.1
+  - @contractspec/lib.video-gen@1.42.1

package/dist/browser/build-tutorial.js

@@ -0,0 +1,60 @@
+// src/build-tutorial.ts
+import { VIDEO_FORMATS } from "@contractspec/lib.video-gen/design/layouts";
+var DEFAULT_FPS = 30;
+var DEFAULT_SCENE_DURATION_SECONDS = 12;
+function buildTutorialVideo(tutorial, options) {
+  const fps = options?.fps ?? DEFAULT_FPS;
+  const sceneDuration = options?.sceneDurationSeconds ?? DEFAULT_SCENE_DURATION_SECONDS;
+  const durationInFrames = sceneDuration * fps;
+  return {
+    id: `tutorial-${tutorial.id}-${Date.now().toString(36)}`,
+    scenes: [
+      {
+        id: `scene-${tutorial.id}`,
+        compositionId: "TerminalDemo",
+        props: {
+          title: tutorial.title,
+          subtitle: tutorial.subtitle,
+          lines: tutorial.lines,
+          terminalTitle: tutorial.terminalTitle,
+          prompt: options?.prompt ?? "$ ",
+          summary: tutorial.summary
+        },
+        durationInFrames
+      }
+    ],
+    totalDurationInFrames: durationInFrames,
+    fps,
+    format: VIDEO_FORMATS.landscape
+  };
+}
+function buildTutorialSuite(tutorials, options) {
+  const fps = options?.fps ?? DEFAULT_FPS;
+  const sceneDuration = options?.sceneDurationSeconds ?? DEFAULT_SCENE_DURATION_SECONDS;
+  const durationInFrames = sceneDuration * fps;
+  const scenes = tutorials.map((tutorial) => ({
+    id: `scene-${tutorial.id}`,
+    compositionId: "TerminalDemo",
+    props: {
+      title: tutorial.title,
+      subtitle: tutorial.subtitle,
+      lines: tutorial.lines,
+      terminalTitle: tutorial.terminalTitle,
+      prompt: options?.prompt ?? "$ ",
+      summary: tutorial.summary
+    },
+    durationInFrames
+  }));
+  const totalDurationInFrames = scenes.reduce((sum, s) => sum + s.durationInFrames, 0);
+  return {
+    id: `tutorial-suite-${Date.now().toString(36)}`,
+    scenes,
+    totalDurationInFrames,
+    fps,
+    format: VIDEO_FORMATS.landscape
+  };
+}
+export {
+  buildTutorialVideo,
+  buildTutorialSuite
+};

package/dist/browser/docs/index.js

@@ -0,0 +1,89 @@
+// src/docs/video-docs-terminal.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
+var blocks = [
+  {
+    id: "docs.examples.video-docs-terminal",
+    title: "Video Docs Terminal (example)",
+    summary: "Generate terminal demo videos from CLI walkthroughs using the TerminalDemo composition and ScriptGenerator.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/video-docs-terminal",
+    tags: ["video", "documentation", "terminal", "cli", "example"],
+    body: `## What this example shows
+
+- Defining CLI tutorials as structured \`CliTutorial\` objects with \`TerminalLine\` arrays.
+- Building single-scene and multi-scene \`VideoProject\` instances using the \`TerminalDemo\` composition.
+- Using \`ScriptGenerator\` (deterministic, no LLM) to generate narration from tutorial content briefs.
+- Assembling a full documentation video covering init, build, validate, and deploy workflows.
+
+## Key concepts
+
+- **CliTutorial**: Combines \`TerminalLine[]\` (commands + output) with a \`ContentBrief\` for narration.
+- **TerminalDemo**: The Remotion composition that renders animated terminal sessions.
+- **ScriptGenerator**: Produces narration scripts from content briefs. Deterministic by default.
+- **VideoProject**: The output scene graph -- one scene per tutorial, ready for rendering or preview.
+
+## Notes
+
+- No LLM or voice provider is needed -- the pipeline is fully deterministic.
+- Each tutorial maps to one \`TerminalDemo\` scene in the final video project.
+- The example produces the \`VideoProject\` data structure, not rendered MP4. Use \`LocalRenderer\` for final output.
+`
+  },
+  {
+    id: "docs.examples.video-docs-terminal.usage",
+    title: "Video Docs Terminal -- Usage",
+    summary: "How to generate terminal demo videos and narration from CLI tutorials.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/video-docs-terminal/usage",
+    tags: ["video", "terminal", "usage"],
+    body: `## Usage
+
+### Build a single tutorial video
+
+\`\`\`ts
+import { buildTutorialVideo } from "@contractspec/example.video-docs-terminal/build-tutorial";
+import { initTutorial } from "@contractspec/example.video-docs-terminal/sample-tutorials";
+
+const project = buildTutorialVideo(initTutorial);
+
+console.log(project.scenes.length);          // 1
+console.log(project.scenes[0].compositionId); // "TerminalDemo"
+console.log(project.totalDurationInFrames);   // 360 (12s × 30fps)
+\`\`\`
+
+### Build a multi-scene tutorial suite
+
+\`\`\`ts
+import { buildTutorialSuite } from "@contractspec/example.video-docs-terminal/build-tutorial";
+import { allTutorials } from "@contractspec/example.video-docs-terminal/sample-tutorials";
+
+const project = buildTutorialSuite(allTutorials);
+
+console.log(project.scenes.length); // 4 (init, build, validate, deploy)
+\`\`\`
+
+### Generate narration
+
+\`\`\`ts
+import { generateTutorialNarration } from "@contractspec/example.video-docs-terminal/generate-narration";
+import { buildTutorial } from "@contractspec/example.video-docs-terminal/sample-tutorials";
+
+const narration = await generateTutorialNarration(buildTutorial);
+
+console.log(narration.fullText);              // Full narration text
+console.log(narration.segments.length);       // Per-scene segments
+console.log(narration.estimatedDurationSeconds); // ~12s
+\`\`\`
+
+## Guardrails
+
+- Keep terminal lines concise -- long output slows the typing animation.
+- Target 10-15 lines per tutorial for optimal pacing at 12 seconds per scene.
+- The \`summary\` field is displayed as a call-out after the terminal completes -- keep it to one sentence.
+- Use \`"technical"\` narration style for documentation videos and \`"professional"\` for marketing.
+`
+  }
+];
+registerDocBlocks(blocks);

package/dist/browser/docs/video-docs-terminal.docblock.js

@@ -0,0 +1,89 @@
+// src/docs/video-docs-terminal.docblock.ts
+import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
+var blocks = [
+  {
+    id: "docs.examples.video-docs-terminal",
+    title: "Video Docs Terminal (example)",
+    summary: "Generate terminal demo videos from CLI walkthroughs using the TerminalDemo composition and ScriptGenerator.",
+    kind: "reference",
+    visibility: "public",
+    route: "/docs/examples/video-docs-terminal",
+    tags: ["video", "documentation", "terminal", "cli", "example"],
+    body: `## What this example shows
+
+- Defining CLI tutorials as structured \`CliTutorial\` objects with \`TerminalLine\` arrays.
+- Building single-scene and multi-scene \`VideoProject\` instances using the \`TerminalDemo\` composition.
+- Using \`ScriptGenerator\` (deterministic, no LLM) to generate narration from tutorial content briefs.
+- Assembling a full documentation video covering init, build, validate, and deploy workflows.
+
+## Key concepts
+
+- **CliTutorial**: Combines \`TerminalLine[]\` (commands + output) with a \`ContentBrief\` for narration.
+- **TerminalDemo**: The Remotion composition that renders animated terminal sessions.
+- **ScriptGenerator**: Produces narration scripts from content briefs. Deterministic by default.
+- **VideoProject**: The output scene graph -- one scene per tutorial, ready for rendering or preview.
+
+## Notes
+
+- No LLM or voice provider is needed -- the pipeline is fully deterministic.
+- Each tutorial maps to one \`TerminalDemo\` scene in the final video project.
+- The example produces the \`VideoProject\` data structure, not rendered MP4. Use \`LocalRenderer\` for final output.
+`
+  },
+  {
+    id: "docs.examples.video-docs-terminal.usage",
+    title: "Video Docs Terminal -- Usage",
+    summary: "How to generate terminal demo videos and narration from CLI tutorials.",
+    kind: "usage",
+    visibility: "public",
+    route: "/docs/examples/video-docs-terminal/usage",
+    tags: ["video", "terminal", "usage"],
+    body: `## Usage
+
+### Build a single tutorial video
+
+\`\`\`ts
+import { buildTutorialVideo } from "@contractspec/example.video-docs-terminal/build-tutorial";
+import { initTutorial } from "@contractspec/example.video-docs-terminal/sample-tutorials";
+
+const project = buildTutorialVideo(initTutorial);
+
+console.log(project.scenes.length);          // 1
+console.log(project.scenes[0].compositionId); // "TerminalDemo"
+console.log(project.totalDurationInFrames);   // 360 (12s × 30fps)
+\`\`\`
+
+### Build a multi-scene tutorial suite
+
+\`\`\`ts
+import { buildTutorialSuite } from "@contractspec/example.video-docs-terminal/build-tutorial";
+import { allTutorials } from "@contractspec/example.video-docs-terminal/sample-tutorials";
+
+const project = buildTutorialSuite(allTutorials);
+
+console.log(project.scenes.length); // 4 (init, build, validate, deploy)
+\`\`\`
+
+### Generate narration
+
+\`\`\`ts
+import { generateTutorialNarration } from "@contractspec/example.video-docs-terminal/generate-narration";
+import { buildTutorial } from "@contractspec/example.video-docs-terminal/sample-tutorials";
+
+const narration = await generateTutorialNarration(buildTutorial);
+
+console.log(narration.fullText);              // Full narration text
+console.log(narration.segments.length);       // Per-scene segments
+console.log(narration.estimatedDurationSeconds); // ~12s
+\`\`\`
+
+## Guardrails
+
+- Keep terminal lines concise -- long output slows the typing animation.
+- Target 10-15 lines per tutorial for optimal pacing at 12 seconds per scene.
+- The \`summary\` field is displayed as a call-out after the terminal completes -- keep it to one sentence.
+- Use \`"technical"\` narration style for documentation videos and \`"professional"\` for marketing.
+`
+  }
+];
+registerDocBlocks(blocks);

package/dist/browser/example.js

@@ -0,0 +1,33 @@
+// src/example.ts
+import { defineExample } from "@contractspec/lib.contracts-spec";
+var example = defineExample({
+  meta: {
+    key: "video-docs-terminal",
+    version: "1.0.0",
+    title: "Video Docs Terminal",
+    description: "Generate terminal demo videos from CLI walkthroughs using the TerminalDemo composition and ScriptGenerator.",
+    kind: "script",
+    visibility: "public",
+    stability: "experimental",
+    owners: ["@platform.core"],
+    tags: ["video", "documentation", "terminal", "cli", "tutorial"]
+  },
+  docs: {
+    rootDocId: "docs.examples.video-docs-terminal",
+    usageDocId: "docs.examples.video-docs-terminal.usage"
+  },
+  entrypoints: {
+    packageName: "@contractspec/example.video-docs-terminal",
+    docs: "./docs"
+  },
+  surfaces: {
+    templates: true,
+    sandbox: { enabled: true, modes: ["markdown"] },
+    studio: { enabled: true, installable: true },
+    mcp: { enabled: true }
+  }
+});
+var example_default = example;
+export {
+  example_default as default
+};

package/dist/browser/generate-narration.js

@@ -0,0 +1,18 @@
+// src/generate-narration.ts
+import { ScriptGenerator } from "@contractspec/lib.video-gen/generators/script-generator";
+async function generateTutorialNarration(tutorial, options) {
+  const generator = new ScriptGenerator;
+  const style = options?.style ?? "technical";
+  return generator.generate(tutorial.brief, { enabled: true, style });
+}
+async function generateSuiteNarration(tutorials, options) {
+  const results = await Promise.all(tutorials.map(async (tutorial) => {
+    const script = await generateTutorialNarration(tutorial, options);
+    return [tutorial.id, script];
+  }));
+  return new Map(results);
+}
+export {
+  generateTutorialNarration,
+  generateSuiteNarration
+};