@contractspec/lib.video-gen 1.44.0 → 1.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/dist/browser/docs/rendering.docblock.js +4 -4
- package/dist/browser/docs/video-gen.docblock.js +1 -1
- package/dist/browser/generators/index.js +601 -192
- package/dist/browser/generators/scene-planner.js +527 -23
- package/dist/browser/generators/script-generator.js +528 -18
- package/dist/browser/generators/video-generator.js +601 -191
- package/dist/browser/i18n/catalogs/en.js +160 -0
- package/dist/browser/i18n/catalogs/es.js +160 -0
- package/dist/browser/i18n/catalogs/fr.js +160 -0
- package/dist/browser/i18n/catalogs/index.js +462 -0
- package/dist/browser/i18n/index.js +534 -0
- package/dist/browser/i18n/keys.js +54 -0
- package/dist/browser/i18n/locale.js +21 -0
- package/dist/browser/i18n/messages.js +474 -0
- package/dist/browser/index.js +601 -192
- package/dist/docs/rendering.docblock.js +4 -4
- package/dist/docs/video-gen.docblock.js +1 -1
- package/dist/generators/index.d.ts +0 -2
- package/dist/generators/index.js +601 -192
- package/dist/generators/scene-planner.d.ts +2 -0
- package/dist/generators/scene-planner.js +527 -23
- package/dist/generators/script-generator.d.ts +2 -0
- package/dist/generators/script-generator.js +528 -18
- package/dist/generators/video-generator.d.ts +6 -5
- package/dist/generators/video-generator.js +601 -191
- package/dist/i18n/catalogs/en.d.ts +8 -0
- package/dist/i18n/catalogs/en.js +155 -0
- package/dist/i18n/catalogs/es.d.ts +6 -0
- package/dist/i18n/catalogs/es.js +155 -0
- package/dist/i18n/catalogs/fr.d.ts +6 -0
- package/dist/i18n/catalogs/fr.js +155 -0
- package/dist/i18n/catalogs/index.d.ts +8 -0
- package/dist/i18n/catalogs/index.js +457 -0
- package/dist/i18n/i18n.test.d.ts +1 -0
- package/dist/i18n/index.d.ts +22 -0
- package/dist/i18n/index.js +529 -0
- package/dist/i18n/keys.d.ts +116 -0
- package/dist/i18n/keys.js +49 -0
- package/dist/i18n/locale.d.ts +8 -0
- package/dist/i18n/locale.js +16 -0
- package/dist/i18n/messages.d.ts +14 -0
- package/dist/i18n/messages.js +469 -0
- package/dist/index.js +601 -192
- package/dist/node/docs/rendering.docblock.js +4 -4
- package/dist/node/docs/video-gen.docblock.js +1 -1
- package/dist/node/generators/index.js +601 -192
- package/dist/node/generators/scene-planner.js +527 -23
- package/dist/node/generators/script-generator.js +528 -18
- package/dist/node/generators/video-generator.js +601 -191
- package/dist/node/i18n/catalogs/en.js +155 -0
- package/dist/node/i18n/catalogs/es.js +155 -0
- package/dist/node/i18n/catalogs/fr.js +155 -0
- package/dist/node/i18n/catalogs/index.js +457 -0
- package/dist/node/i18n/index.js +529 -0
- package/dist/node/i18n/keys.js +49 -0
- package/dist/node/i18n/locale.js +16 -0
- package/dist/node/i18n/messages.js +469 -0
- package/dist/node/index.js +601 -192
- package/dist/types.d.ts +14 -3
- package/package.json +149 -6
|
@@ -24,7 +24,7 @@ The rendering layer wraps \`@remotion/renderer\` for MP4/WebM output and \`@remo
|
|
|
24
24
|
|
|
25
25
|
## LocalRenderer
|
|
26
26
|
|
|
27
|
-
Renders a \`VideoProject\` to a video file using the local Remotion renderer.
|
|
27
|
+
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)).
|
|
28
28
|
|
|
29
29
|
\`\`\`ts
|
|
30
30
|
import { LocalRenderer } from "@contractspec/lib.video-gen/renderers/local";
|
|
@@ -46,7 +46,7 @@ result.fileSizeBytes; // file size
|
|
|
46
46
|
result.dimensions; // { width: 1920, height: 1080 }
|
|
47
47
|
\`\`\`
|
|
48
48
|
|
|
49
|
-
> **Important**: Import \`LocalRenderer\` from the \`/renderers/local\` subpath, not from the main entry. It dynamically imports \`@remotion/bundler\` and \`@remotion/renderer\`
|
|
49
|
+
> **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.
|
|
50
50
|
|
|
51
51
|
### Auto-Variants
|
|
52
52
|
|
|
@@ -168,7 +168,7 @@ The \`@contractspec/app.video-studio\` package provides a Remotion Studio entry
|
|
|
168
168
|
bun run dev:video
|
|
169
169
|
|
|
170
170
|
# Render a specific composition
|
|
171
|
-
|
|
171
|
+
bunx remotionb render src/index.ts ApiOverview out/api-overview.mp4
|
|
172
172
|
|
|
173
173
|
# Render all compositions
|
|
174
174
|
bun run render:all
|
|
@@ -188,7 +188,7 @@ All compositions run at 30fps.
|
|
|
188
188
|
|
|
189
189
|
## Guardrails
|
|
190
190
|
|
|
191
|
-
- \`LocalRenderer\` requires Node.js -- do not attempt to use it in browser
|
|
191
|
+
- \`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)).
|
|
192
192
|
- Import \`LocalRenderer\` from the \`/renderers/local\` subpath to avoid bundling \`@remotion/renderer\` in browser builds.
|
|
193
193
|
- 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.
|
|
194
194
|
- Use quality presets for consistency: \`draft\` for development, \`standard\` for CI, \`high\` for releases.
|
|
@@ -134,7 +134,7 @@ This matches the content-gen pattern: \`constructor({ llm? })\` -> \`generate(br
|
|
|
134
134
|
|
|
135
135
|
- Compositions must be **deterministic**: same props = same visual output.
|
|
136
136
|
- Design tokens bridge from \`@contractspec/lib.design-system\` -- do not duplicate brand values.
|
|
137
|
-
- \`LocalRenderer\`
|
|
137
|
+
- \`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)).
|
|
138
138
|
- The \`remotion\` entry point is a side-effect module (calls \`registerRoot\`) -- import it only from Remotion Studio or render scripts.
|
|
139
139
|
`
|
|
140
140
|
}
|
|
@@ -1,5 +1,3 @@
|
|
|
1
1
|
export { VideoGenerator } from './video-generator';
|
|
2
2
|
export { ScenePlanner } from './scene-planner';
|
|
3
3
|
export type { ScenePlannerOptions } from './scene-planner';
|
|
4
|
-
export { ScriptGenerator } from './script-generator';
|
|
5
|
-
export type { ScriptGeneratorOptions, NarrationScript, NarrationSegment, } from './script-generator';
|