@contractspec/lib.video-gen 1.45.0 → 1.47.0

package/README.md

@@ -0,0 +1,37 @@
+# @contractspec/lib.video-gen
+
+Website: https://contractspec.io/
+
+Programmatic video generation using Remotion. Follows the same generator pattern as `@contractspec/lib.content-gen` and consumes contracts from video provider integrations. All generators work deterministically by default -- LLM integration is optional and enhances output when available.
+
+## Modules
+
+- **Types** -- `VideoBrief`, `VideoGeneratorOptions`, `GeneratedVideo`, `ScenePlan`, `PlannedScene`, plus re-exported contract types (`VideoProject`, `RenderConfig`, `VideoFormat`)
+- **Design** -- Video-specific design tokens extending the design system: color tokens, motion/easing curves, typography scale (1920x1080), and layout safe zones with format variants (landscape/square/portrait)
+- **Compositions** -- Remotion compositions for rendering video scenes:
+  - **Primitives**: `AnimatedText`, `BrandFrame`, `CodeBlock`, `ProgressBar`, `Terminal`, `SceneTransitionWrapper`
+  - **Full**: `ApiOverview` (spec to API surface visualization), `SocialClip` (marketing content, adaptive formats), `TerminalDemo` (CLI walkthrough)
+- **Generators** -- `VideoGenerator` (main orchestrator), `ScenePlanner` (breaks briefs into scenes), `ScriptGenerator` (narration with professional/casual/technical styles)
+- **Renderers** -- `LocalRenderer` wrapping `@remotion/renderer` with quality presets (draft/standard/high)
+- **Player** -- `DemoPlayer` component for embedding in React apps via `@remotion/player`
+
+Deterministic by default: every generator produces consistent output without an LLM. When an LLM is provided via the constructor, generators produce richer, more varied content. On LLM failure, the system falls back to deterministic output automatically.
+
+## Quickstart
+
+```typescript
+import { VideoGenerator } from "@contractspec/lib.video-gen/generators";
+import type { VideoBrief } from "@contractspec/lib.video-gen/types";
+
+const generator = new VideoGenerator(); // no LLM needed
+
+const brief: VideoBrief = {
+  title: "Ship APIs 10x Faster",
+  summary: "See how ContractSpec generates production-ready APIs from specs.",
+  format: "landscape",
+};
+
+const project = await generator.generate(brief);
+```
+
+Compositions are pure React components -- same props always produce the same visual output, with frame-based timing and no side effects.

package/dist/browser/docs/rendering.docblock.js

@@ -23,7 +23,7 @@ The rendering layer wraps \`@remotion/renderer\` for MP4/WebM output and \`@remo
 
 ## LocalRenderer
 
-Renders a \`VideoProject\` to a video file using the local Remotion renderer. Requires **Node.js** (not Bun-compatible).
+Renders a \`VideoProject\` to a video file using the local Remotion renderer. Works with **Node.js** and **Bun** (via \`remotionb\`). Bun caveat: SSR scripts may not auto-quit (see [Remotion Bun docs](https://www.remotion.dev/docs/bun)).
 
 \`\`\`ts
 import { LocalRenderer } from "@contractspec/lib.video-gen/renderers/local";
@@ -45,7 +45,7 @@ result.fileSizeBytes;   // file size
 result.dimensions;      // { width: 1920, height: 1080 }
 \`\`\`
 
-> **Important**: Import \`LocalRenderer\` from the \`/renderers/local\` subpath, not from the main entry. It dynamically imports \`@remotion/bundler\` and \`@remotion/renderer\` which are Node.js-only.
+> **Important**: Import \`LocalRenderer\` from the \`/renderers/local\` subpath, not from the main entry. It dynamically imports \`@remotion/bundler\` and \`@remotion/renderer\` to avoid bundling them in browser builds.
 
 ### Auto-Variants
 
@@ -167,7 +167,7 @@ The \`@contractspec/app.video-studio\` package provides a Remotion Studio entry
 bun run dev:video
 
 # Render a specific composition
-npx remotion render src/index.ts ApiOverview out/api-overview.mp4
+bunx remotionb render src/index.ts ApiOverview out/api-overview.mp4
 
 # Render all compositions
 bun run render:all
@@ -187,7 +187,7 @@ All compositions run at 30fps.
 
 ## Guardrails
 
-- \`LocalRenderer\` requires Node.js -- do not attempt to use it in browser or Bun environments.
+- \`LocalRenderer\` requires Node.js or Bun -- do not attempt to use it in browser environments. On Bun, SSR scripts may not auto-quit (see [Remotion Bun docs](https://www.remotion.dev/docs/bun)).
 - Import \`LocalRenderer\` from the \`/renderers/local\` subpath to avoid bundling \`@remotion/renderer\` in browser builds.
 - The \`remotion\` entry point (\`@contractspec/lib.video-gen/remotion\`) is a **side-effect module** that calls \`registerRoot()\`. Only import it from Remotion Studio or render scripts.
 - Use quality presets for consistency: \`draft\` for development, \`standard\` for CI, \`high\` for releases.

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

@@ -133,7 +133,7 @@ This matches the content-gen pattern: \`constructor({ llm? })\` -> \`generate(br
 
 - Compositions must be **deterministic**: same props = same visual output.
 - Design tokens bridge from \`@contractspec/lib.design-system\` -- do not duplicate brand values.
-- \`LocalRenderer\` requires Node.js (\`@remotion/renderer\` is not Bun-compatible).
+- \`LocalRenderer\` works with Node.js and Bun. On Bun, SSR scripts may not auto-quit (see [Remotion Bun docs](https://www.remotion.dev/docs/bun)).
 - The \`remotion\` entry point is a side-effect module (calls \`registerRoot\`) -- import it only from Remotion Studio or render scripts.
 `
   }