zilmate 1.9.3 → 1.10.1
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/.agents/skills/ad-creative/SKILL.md +362 -0
- package/.agents/skills/ad-creative/evals/evals.json +90 -0
- package/.agents/skills/ad-creative/references/generative-tools.md +637 -0
- package/.agents/skills/ad-creative/references/platform-specs.md +213 -0
- package/.agents/skills/ai-seo/SKILL.md +489 -0
- package/.agents/skills/ai-seo/evals/evals.json +90 -0
- package/.agents/skills/ai-seo/references/content-patterns.md +285 -0
- package/.agents/skills/ai-seo/references/content-types.md +71 -0
- package/.agents/skills/ai-seo/references/okf.md +104 -0
- package/.agents/skills/ai-seo/references/platform-ranking-factors.md +154 -0
- package/.agents/skills/clerk-backend-api/SKILL.md +426 -0
- package/.agents/skills/clerk-backend-api/evals/evals.json +87 -0
- package/.agents/skills/clerk-backend-api/scripts/api-specs-context.sh +30 -0
- package/.agents/skills/clerk-backend-api/scripts/execute-request.sh +88 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-endpoint-detail.sh +165 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-tag-endpoints.sh +208 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-tags.js +14 -0
- package/.agents/skills/copy-editing/SKILL.md +457 -0
- package/.agents/skills/copy-editing/evals/evals.json +89 -0
- package/.agents/skills/copy-editing/references/checklist.md +66 -0
- package/.agents/skills/copy-editing/references/content-refresh.md +38 -0
- package/.agents/skills/copy-editing/references/plain-english-alternatives.md +394 -0
- package/.agents/skills/hyperframes/SKILL.md +163 -0
- package/.agents/skills/hyperframes-cli/SKILL.md +109 -0
- package/.agents/skills/hyperframes-cli/references/doctor-browser.md +45 -0
- package/.agents/skills/hyperframes-cli/references/init-and-scaffold.md +51 -0
- package/.agents/skills/hyperframes-cli/references/lambda.md +132 -0
- package/.agents/skills/hyperframes-cli/references/lint-validate-inspect.md +121 -0
- package/.agents/skills/hyperframes-cli/references/preview-render.md +109 -0
- package/.agents/skills/hyperframes-cli/references/upgrade-info-misc.md +75 -0
- package/.agents/skills/hyperframes-media/SKILL.md +97 -0
- package/.agents/skills/hyperframes-media/assets/sfx/CREDITS.md +35 -0
- package/.agents/skills/hyperframes-media/assets/sfx/manifest.json +97 -0
- package/.agents/skills/hyperframes-media/references/bgm.md +72 -0
- package/.agents/skills/hyperframes-media/references/captions/authoring.md +159 -0
- package/.agents/skills/hyperframes-media/references/captions/motion.md +87 -0
- package/.agents/skills/hyperframes-media/references/captions/transcript-handling.md +97 -0
- package/.agents/skills/hyperframes-media/references/remove-background.md +143 -0
- package/.agents/skills/hyperframes-media/references/requirements.md +29 -0
- package/.agents/skills/hyperframes-media/references/sfx.md +42 -0
- package/.agents/skills/hyperframes-media/references/transcribe.md +52 -0
- package/.agents/skills/hyperframes-media/references/tts-to-captions.md +24 -0
- package/.agents/skills/hyperframes-media/references/tts.md +135 -0
- package/.agents/skills/hyperframes-media/scripts/audio.mjs +282 -0
- package/.agents/skills/hyperframes-media/scripts/heygen-tts.mjs +121 -0
- package/.agents/skills/hyperframes-media/scripts/lib/bgm.mjs +235 -0
- package/.agents/skills/hyperframes-media/scripts/lib/heygen.mjs +131 -0
- package/.agents/skills/hyperframes-media/scripts/lib/sfx.mjs +128 -0
- package/.agents/skills/hyperframes-media/scripts/lib/tts.mjs +220 -0
- package/.agents/skills/hyperframes-media/scripts/lyria-recipe.py +128 -0
- package/.agents/skills/hyperframes-media/scripts/wait-bgm.mjs +167 -0
- package/.agents/skills/hyperframes-registry/SKILL.md +101 -0
- package/.agents/skills/hyperframes-registry/examples/add-block.md +51 -0
- package/.agents/skills/hyperframes-registry/examples/add-component.md +73 -0
- package/.agents/skills/hyperframes-registry/references/contributing.md +166 -0
- package/.agents/skills/hyperframes-registry/references/demo-html-pattern.md +54 -0
- package/.agents/skills/hyperframes-registry/references/discovery.md +215 -0
- package/.agents/skills/hyperframes-registry/references/install-locations.md +45 -0
- package/.agents/skills/hyperframes-registry/references/templates.md +417 -0
- package/.agents/skills/hyperframes-registry/references/wiring-blocks.md +61 -0
- package/.agents/skills/hyperframes-registry/references/wiring-components.md +39 -0
- package/.agents/skills/marketing-psychology/SKILL.md +455 -0
- package/.agents/skills/marketing-psychology/evals/evals.json +88 -0
- package/.agents/skills/mintlify/SKILL.md +328 -0
- package/.agents/skills/product-launch-video/SKILL.md +206 -0
- package/.agents/skills/product-launch-video/references/cut-catalog.md +220 -0
- package/.agents/skills/product-launch-video/references/motion-language.md +156 -0
- package/.agents/skills/product-launch-video/references/story-design.md +373 -0
- package/.agents/skills/product-launch-video/references/visual-design.md +126 -0
- package/.agents/skills/product-launch-video/scripts/assemble-index.mjs +570 -0
- package/.agents/skills/product-launch-video/scripts/audio.mjs +253 -0
- package/.agents/skills/product-launch-video/scripts/build-frame.mjs +536 -0
- package/.agents/skills/product-launch-video/scripts/captions.mjs +508 -0
- package/.agents/skills/product-launch-video/scripts/lib/assets.mjs +55 -0
- package/.agents/skills/product-launch-video/scripts/lib/dimensions.mjs +45 -0
- package/.agents/skills/product-launch-video/scripts/lib/storyboard.mjs +249 -0
- package/.agents/skills/product-launch-video/scripts/lib/tokens.mjs +204 -0
- package/.agents/skills/product-launch-video/scripts/lib/transition-registry.mjs +38 -0
- package/.agents/skills/product-launch-video/scripts/lib/transitions.json +71 -0
- package/.agents/skills/product-launch-video/scripts/stage-assets.mjs +39 -0
- package/.agents/skills/product-launch-video/scripts/transitions.mjs +320 -0
- package/.agents/skills/product-launch-video/sub-agents/frame-worker.md +74 -0
- package/.agents/skills/prompt-engineering-patterns/SKILL.md +144 -0
- package/.agents/skills/prompt-engineering-patterns/assets/few-shot-examples.json +106 -0
- package/.agents/skills/prompt-engineering-patterns/assets/prompt-template-library.md +264 -0
- package/.agents/skills/prompt-engineering-patterns/references/chain-of-thought.md +412 -0
- package/.agents/skills/prompt-engineering-patterns/references/details.md +338 -0
- package/.agents/skills/prompt-engineering-patterns/references/few-shot-learning.md +386 -0
- package/.agents/skills/prompt-engineering-patterns/references/prompt-optimization.md +428 -0
- package/.agents/skills/prompt-engineering-patterns/references/prompt-templates.md +484 -0
- package/.agents/skills/prompt-engineering-patterns/references/system-prompts.md +195 -0
- package/.agents/skills/prompt-engineering-patterns/scripts/optimize-prompt.py +279 -0
- package/.agents/skills/remotion-to-hyperframes/SKILL.md +127 -0
- package/.agents/skills/remotion-to-hyperframes/assets/.gitkeep +0 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/run.sh +249 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/README.md +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/expected.json +26 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/hf-src/index.html +61 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/package.json +14 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/Root.tsx +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/TitleCard.tsx +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/README.md +54 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/expected.json +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/hf-src/index.html +118 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/package.json +14 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/MultiScene.tsx +105 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/Root.tsx +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/setup.sh +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/README.md +85 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/expected.json +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/hf-src/index.html +269 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/package.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/Root.tsx +27 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/Stargazed.tsx +37 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/AnimatedNumber.tsx +23 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/StatCard.tsx +59 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/UnderlinedText.tsx +47 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/OutroScene.tsx +18 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/StatsScene.tsx +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/TitleScene.tsx +55 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/README.md +51 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/01-use-state.tsx +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/02-use-effect-deps.tsx +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/03-async-metadata.tsx +39 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/04-third-party-react.tsx +30 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/05-lambda-config.tsx +38 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/06-warnings-only.tsx +36 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/07-custom-hook.tsx +28 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/08-mixed.tsx +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/expected.json +85 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/validate.sh +110 -0
- package/.agents/skills/remotion-to-hyperframes/references/api-map.md +142 -0
- package/.agents/skills/remotion-to-hyperframes/references/escape-hatch.md +115 -0
- package/.agents/skills/remotion-to-hyperframes/references/eval.md +140 -0
- package/.agents/skills/remotion-to-hyperframes/references/fonts.md +112 -0
- package/.agents/skills/remotion-to-hyperframes/references/limitations.md +136 -0
- package/.agents/skills/remotion-to-hyperframes/references/lottie.md +121 -0
- package/.agents/skills/remotion-to-hyperframes/references/media.md +149 -0
- package/.agents/skills/remotion-to-hyperframes/references/parameters.md +167 -0
- package/.agents/skills/remotion-to-hyperframes/references/sequencing.md +195 -0
- package/.agents/skills/remotion-to-hyperframes/references/timing.md +165 -0
- package/.agents/skills/remotion-to-hyperframes/references/transitions.md +114 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/.gitkeep +0 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/frame_strip.sh +107 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/lint_source.py +358 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/render_diff.sh +103 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/fixtures/blocker.tsx +50 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/fixtures/clean.tsx +46 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/smoke.sh +90 -0
- package/.agents/skills/seo-audit/SKILL.md +497 -0
- package/.agents/skills/seo-audit/evals/evals.json +136 -0
- package/.agents/skills/seo-audit/references/ai-writing-detection.md +200 -0
- package/.agents/skills/seo-audit/references/international-seo.md +230 -0
- package/README.md +4 -2
- package/SDK.md +64 -1
- package/dist/agents/coding.agent.d.ts +632 -0
- package/dist/agents/coding.agent.d.ts.map +1 -1
- package/dist/agents/coding.agent.js +11 -3
- package/dist/agents/coding.agent.js.map +1 -1
- package/dist/agents/developer-helper.agent.d.ts +704 -0
- package/dist/agents/developer-helper.agent.d.ts.map +1 -1
- package/dist/agents/developer-helper.agent.js +6 -0
- package/dist/agents/developer-helper.agent.js.map +1 -1
- package/dist/agents/manager.d.ts +1009 -4
- package/dist/agents/manager.d.ts.map +1 -1
- package/dist/agents/manager.js +16 -5
- package/dist/agents/manager.js.map +1 -1
- package/dist/agents/security.agent.d.ts +157 -3
- package/dist/agents/security.agent.d.ts.map +1 -1
- package/dist/agents/security.agent.js +3 -0
- package/dist/agents/security.agent.js.map +1 -1
- package/dist/agents/swarm/main.js +1 -1
- package/dist/agents/swarm/main.js.map +1 -1
- package/dist/agents/swarm/registry.d.ts.map +1 -1
- package/dist/agents/swarm/registry.js +232 -26
- package/dist/agents/swarm/registry.js.map +1 -1
- package/dist/cli/chat.d.ts +1 -1
- package/dist/cli/chat.d.ts.map +1 -1
- package/dist/cli/chat.js +32 -10
- package/dist/cli/chat.js.map +1 -1
- package/dist/cli/doctor.d.ts +14 -0
- package/dist/cli/doctor.d.ts.map +1 -1
- package/dist/cli/doctor.js +91 -0
- package/dist/cli/doctor.js.map +1 -1
- package/dist/cli/format.d.ts +1 -0
- package/dist/cli/format.d.ts.map +1 -1
- package/dist/cli/format.js +68 -14
- package/dist/cli/format.js.map +1 -1
- package/dist/cli/menu.d.ts.map +1 -1
- package/dist/cli/menu.js +102 -0
- package/dist/cli/menu.js.map +1 -1
- package/dist/cli/setup.d.ts +10 -0
- package/dist/cli/setup.d.ts.map +1 -1
- package/dist/cli/setup.js +187 -3
- package/dist/cli/setup.js.map +1 -1
- package/dist/cli/update.d.ts +2 -0
- package/dist/cli/update.d.ts.map +1 -1
- package/dist/cli/update.js +89 -1
- package/dist/cli/update.js.map +1 -1
- package/dist/config/env.d.ts +12 -0
- package/dist/config/env.d.ts.map +1 -1
- package/dist/config/env.js +19 -5
- package/dist/config/env.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +61 -5
- package/dist/index.js.map +1 -1
- package/dist/jobs/trigger-orchestrator.d.ts +5 -1
- package/dist/jobs/trigger-orchestrator.d.ts.map +1 -1
- package/dist/jobs/trigger-orchestrator.js +29 -9
- package/dist/jobs/trigger-orchestrator.js.map +1 -1
- package/dist/jobs/trigger-router.d.ts.map +1 -1
- package/dist/jobs/trigger-router.js +3 -2
- package/dist/jobs/trigger-router.js.map +1 -1
- package/dist/memory/corporate-wiki.d.ts +15 -0
- package/dist/memory/corporate-wiki.d.ts.map +1 -0
- package/dist/memory/corporate-wiki.js +152 -0
- package/dist/memory/corporate-wiki.js.map +1 -0
- package/dist/observability/doctor.d.ts.map +1 -1
- package/dist/observability/doctor.js +12 -4
- package/dist/observability/doctor.js.map +1 -1
- package/dist/pre-init.d.ts +2 -0
- package/dist/pre-init.d.ts.map +1 -0
- package/dist/pre-init.js +3 -0
- package/dist/pre-init.js.map +1 -0
- package/dist/runtime/chat-bridge.d.ts.map +1 -1
- package/dist/runtime/chat-bridge.js +33 -2
- package/dist/runtime/chat-bridge.js.map +1 -1
- package/dist/runtime/swarm.d.ts +0 -1
- package/dist/runtime/swarm.d.ts.map +1 -1
- package/dist/runtime/swarm.js +26 -15
- package/dist/runtime/swarm.js.map +1 -1
- package/dist/safety/approvals.d.ts +2 -2
- package/dist/safety/approvals.d.ts.map +1 -1
- package/dist/safety/approvals.js +47 -1
- package/dist/safety/approvals.js.map +1 -1
- package/dist/safety/redaction.d.ts.map +1 -1
- package/dist/safety/redaction.js +10 -0
- package/dist/safety/redaction.js.map +1 -1
- package/dist/server.d.ts +1 -0
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +1 -0
- package/dist/server.js.map +1 -1
- package/dist/tools/cloud.tool.d.ts +394 -0
- package/dist/tools/cloud.tool.d.ts.map +1 -0
- package/dist/tools/cloud.tool.js +784 -0
- package/dist/tools/cloud.tool.js.map +1 -0
- package/dist/tools/computer-use.tool.d.ts +6 -6
- package/dist/tools/corporate-wiki.tool.d.ts +22 -0
- package/dist/tools/corporate-wiki.tool.d.ts.map +1 -0
- package/dist/tools/corporate-wiki.tool.js +39 -0
- package/dist/tools/corporate-wiki.tool.js.map +1 -0
- package/dist/tools/desktop.tool.d.ts +96 -0
- package/dist/tools/desktop.tool.d.ts.map +1 -1
- package/dist/tools/desktop.tool.js +439 -0
- package/dist/tools/desktop.tool.js.map +1 -1
- package/dist/tools/devops.tool.d.ts +162 -0
- package/dist/tools/devops.tool.d.ts.map +1 -0
- package/dist/tools/devops.tool.js +377 -0
- package/dist/tools/devops.tool.js.map +1 -0
- package/dist/tools/multimedia.tool.d.ts +126 -0
- package/dist/tools/multimedia.tool.d.ts.map +1 -0
- package/dist/tools/multimedia.tool.js +533 -0
- package/dist/tools/multimedia.tool.js.map +1 -0
- package/dist/tools/osint.tool.d.ts +6 -6
- package/dist/tools/sandbox-dev.tool.d.ts +15 -0
- package/dist/tools/sandbox-dev.tool.d.ts.map +1 -0
- package/dist/tools/sandbox-dev.tool.js +139 -0
- package/dist/tools/sandbox-dev.tool.js.map +1 -0
- package/dist/tools/setup-assistant.tool.d.ts +1 -1
- package/dist/tools/shell.tool.d.ts +82 -0
- package/dist/tools/shell.tool.d.ts.map +1 -1
- package/dist/tools/shell.tool.js +192 -1
- package/dist/tools/shell.tool.js.map +1 -1
- package/dist/tools/swarm-ops.tool.d.ts +14 -0
- package/dist/tools/swarm-ops.tool.d.ts.map +1 -1
- package/dist/tools/swarm-ops.tool.js +44 -0
- package/dist/tools/swarm-ops.tool.js.map +1 -1
- package/dist/tools/sysops.tool.d.ts +157 -0
- package/dist/tools/sysops.tool.d.ts.map +1 -0
- package/dist/tools/sysops.tool.js +643 -0
- package/dist/tools/sysops.tool.js.map +1 -0
- package/dist/voice/cascade.d.ts +1 -0
- package/dist/voice/cascade.d.ts.map +1 -1
- package/dist/voice/cascade.js +16 -1
- package/dist/voice/cascade.js.map +1 -1
- package/dist/voice/deepgram.d.ts.map +1 -1
- package/dist/voice/deepgram.js +34 -2
- package/dist/voice/deepgram.js.map +1 -1
- package/dist/voice/terminal.d.ts +1 -0
- package/dist/voice/terminal.d.ts.map +1 -1
- package/dist/voice/terminal.js +28 -0
- package/dist/voice/terminal.js.map +1 -1
- package/dist/voice/types.d.ts +2 -0
- package/dist/voice/types.d.ts.map +1 -1
- package/package.json +9 -1
- package/scripts/release-github.mjs +23 -18
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# Remotion → HyperFrames API Map
|
|
2
|
+
|
|
3
|
+
Authoritative translation table. Load this reference when starting a translation
|
|
4
|
+
to know the high-level mapping; load the per-topic references for fragile
|
|
5
|
+
details (timing, transitions, etc.).
|
|
6
|
+
|
|
7
|
+
## Reading this table
|
|
8
|
+
|
|
9
|
+
- **`drop`** = remove from output entirely. The HF runtime handles it.
|
|
10
|
+
- **`see references/X.md`** = the mapping is non-trivial; read the linked file.
|
|
11
|
+
- **`refuse + interop`** = the skill bows out and recommends the runtime adapter
|
|
12
|
+
pattern from [PR #214](https://github.com/heygen-com/hyperframes/pull/214).
|
|
13
|
+
|
|
14
|
+
## Composition root
|
|
15
|
+
|
|
16
|
+
| Remotion | HyperFrames |
|
|
17
|
+
| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
+
| `<Composition id durationInFrames fps width height>` | root `<div id="stage" data-composition-id data-start="0" data-duration="<dur/fps>" data-fps data-width data-height>` |
|
|
19
|
+
| `defaultProps={...}` | `data-*` attributes on `#stage` (one per scalar prop). Nested objects/arrays — see [parameters.md](parameters.md) |
|
|
20
|
+
| `schema={z.object(...)}` | not represented in HTML; the schema lives in the agent's translation step only |
|
|
21
|
+
| `calculateMetadata` (sync) | resolve at translation time, write concrete values into `data-*` |
|
|
22
|
+
| `calculateMetadata` (async) | **refuse + interop** — see [escape-hatch.md](escape-hatch.md) |
|
|
23
|
+
| `registerRoot(RemotionRoot)` | drop |
|
|
24
|
+
| `<AbsoluteFill style>` | `<div style="position:absolute;inset:0;{style}">` |
|
|
25
|
+
|
|
26
|
+
## Sequencing
|
|
27
|
+
|
|
28
|
+
See [sequencing.md](sequencing.md) for nesting and stagger details.
|
|
29
|
+
|
|
30
|
+
| Remotion | HyperFrames |
|
|
31
|
+
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| `<Sequence from={F} durationInFrames={D}>` | `<div data-start="<F/fps>" data-duration="<D/fps>" data-track-index="N">` |
|
|
33
|
+
| `<Series>` + `<Series.Sequence>` | siblings with sequential `data-start` values |
|
|
34
|
+
| `<Loop durationInFrames={D}>` | not a primitive — emit a custom GSAP `repeat: -1` loop with manual offset math |
|
|
35
|
+
| `<Freeze frame={F}>` | drop the wrapper; HF doesn't have running animation outside the seek-driven timeline so freeze is a no-op |
|
|
36
|
+
|
|
37
|
+
## Timing
|
|
38
|
+
|
|
39
|
+
See [timing.md](timing.md) — this is the highest-leverage section.
|
|
40
|
+
|
|
41
|
+
| Remotion | HyperFrames |
|
|
42
|
+
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
43
|
+
| `useCurrentFrame()` | drop — HF seeks the timeline. The math derived from `frame` becomes an animatable property of a paused GSAP tween. |
|
|
44
|
+
| `useVideoConfig()` for `fps` / `durationInFrames` | drop — read from `data-fps` / `data-duration` on `#stage` |
|
|
45
|
+
| `interpolate(frame, [a,b], [x,y])` (linear) | `gsap.fromTo(t, {p:x}, {p:y, duration:(b-a)/fps, ease:"none"})` at offset `a/fps` |
|
|
46
|
+
| `interpolate(frame, [a,b,c,d], [x,y,y,z])` (multi-segment) | three `gsap.to` calls at offsets `a/fps`, `b/fps`, `c/fps` |
|
|
47
|
+
| `interpolate(..., {easing: Easing.bezier})` | GSAP `CustomEase.create("c", "M0,0 C${a},${b} ${c},${d} 1,1")` |
|
|
48
|
+
| `spring({frame, fps, config: {damping, stiffness, mass}})` | GSAP `back.out(N)` — see [timing.md](timing.md) for damping → overshoot table |
|
|
49
|
+
| `interpolateColors(frame, range, colors)` | `gsap.to({...}, { backgroundColor, color, duration, ease })` — GSAP handles color tweens natively |
|
|
50
|
+
| `Easing.in / .out / .inOut(power)` | GSAP `power<N>.in` / `power<N>.out` / `power<N>.inOut` |
|
|
51
|
+
|
|
52
|
+
## Media
|
|
53
|
+
|
|
54
|
+
See [media.md](media.md) for trim, volume ramps, and decoder notes.
|
|
55
|
+
|
|
56
|
+
| Remotion | HyperFrames |
|
|
57
|
+
| -------------------------------------- | --------------------------------------------------------------------------- |
|
|
58
|
+
| `<Audio src volume>` | `<audio data-start data-duration data-track-index data-volume src>` |
|
|
59
|
+
| `<Audio playbackRate startFrom endAt>` | `data-playback-rate`, `data-trim-start`, `data-trim-end` |
|
|
60
|
+
| `<Video src>` | `<video muted playsinline data-start data-duration data-track-index src>` |
|
|
61
|
+
| `<OffthreadVideo>` | `<video>` — HF doesn't need the off-thread variant (uses headless Chrome) |
|
|
62
|
+
| `<Img src>` | `<img>` |
|
|
63
|
+
| `<IFrame src>` | `<iframe>` — HF auto-falls back to screenshot mode for nested iframes |
|
|
64
|
+
| `staticFile("x.png")` | `"assets/x.png"` — copy the file into `hf-src/assets/` next to `index.html` |
|
|
65
|
+
| `delayRender()` / `continueRender()` | drop — HF waits on asset readiness via the Frame Adapter pattern |
|
|
66
|
+
|
|
67
|
+
## Transitions
|
|
68
|
+
|
|
69
|
+
See [transitions.md](transitions.md).
|
|
70
|
+
|
|
71
|
+
| Remotion | HyperFrames |
|
|
72
|
+
| ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
|
|
73
|
+
| `<TransitionSeries>` + `<TransitionSeries.Transition presentation={fade()} />` | manual `gsap.to(scene, {opacity: 0/1, duration})` crossfade at the boundary |
|
|
74
|
+
| `slide()`, `wipe()`, `clockWipe()`, `fade()` | HF [shader-transitions](https://hyperframes.heygen.com/catalog/blocks) package presets — pick the closest |
|
|
75
|
+
| `linearTiming({durationInFrames})` | duration in seconds (`/fps`) |
|
|
76
|
+
| `springTiming({config})` | duration in seconds, ease `back.out` — see [timing.md](timing.md) |
|
|
77
|
+
|
|
78
|
+
## Lottie
|
|
79
|
+
|
|
80
|
+
See [lottie.md](lottie.md).
|
|
81
|
+
|
|
82
|
+
| Remotion | HyperFrames |
|
|
83
|
+
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
84
|
+
| `<Lottie animationData={data}>` | `<div id="lottie-N">` + `<script>const anim = lottie.loadAnimation({...}); window.__hfLottie.push(anim)</script>` |
|
|
85
|
+
| `loop` / `playbackRate` props | translate only after checking player seek behavior; HF adapter seeks absolute time via `goToAndStop` |
|
|
86
|
+
| `@remotion/lottie` runtime | `lottie-web` from CDN — drop the React wrapper |
|
|
87
|
+
|
|
88
|
+
## Fonts
|
|
89
|
+
|
|
90
|
+
See [fonts.md](fonts.md).
|
|
91
|
+
|
|
92
|
+
| Remotion | HyperFrames |
|
|
93
|
+
| --------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
94
|
+
| `loadFont()` from `@remotion/google-fonts/<Family>` | `@font-face` rule referencing the Google Fonts CSS, OR `<link>` to Google Fonts in `<head>` |
|
|
95
|
+
| Local font via `@font-face` | same — paste the rule into `<style>` |
|
|
96
|
+
| System font fallback | document the font-fallback divergence cost (see [eval.md](eval.md)) |
|
|
97
|
+
|
|
98
|
+
## Parameters
|
|
99
|
+
|
|
100
|
+
See [parameters.md](parameters.md).
|
|
101
|
+
|
|
102
|
+
| Remotion | HyperFrames |
|
|
103
|
+
| ----------------------------- | --------------------------------------------------------------------------------------------- |
|
|
104
|
+
| `z.object({foo: z.string()})` | `data-foo` on `#stage` (the schema is implicit in HTML structure) |
|
|
105
|
+
| nested array prop (`stats[]`) | repeated HTML markup with per-instance `data-*` attrs |
|
|
106
|
+
| Zod default values | bake defaults into the HTML directly |
|
|
107
|
+
| Zod runtime validation | not represented; if validation matters, validate in the translation step before emitting HTML |
|
|
108
|
+
|
|
109
|
+
## React patterns
|
|
110
|
+
|
|
111
|
+
| Remotion | HyperFrames |
|
|
112
|
+
| -------------------------------------------------- | ---------------------------------------------------------------- |
|
|
113
|
+
| Custom React subcomponent (pure, prop-driven) | inline as repeated HTML using the prop interface as the template |
|
|
114
|
+
| `useState` driving animation | **refuse + interop** |
|
|
115
|
+
| `useReducer` driving animation | **refuse + interop** |
|
|
116
|
+
| `useEffect(fn, [deps])` (non-empty deps) | **refuse + interop** |
|
|
117
|
+
| `useEffect(fn, [])` (mount-once side effect) | drop the effect; use `queueMicrotask` if startup work is needed |
|
|
118
|
+
| `useCallback`, `useMemo` | drop the wrappers — decorative |
|
|
119
|
+
| Custom hook (pure derivation of `useCurrentFrame`) | inline the body |
|
|
120
|
+
| Custom hook with state/effects | refuse + interop |
|
|
121
|
+
|
|
122
|
+
## Distributed rendering
|
|
123
|
+
|
|
124
|
+
`@remotion/lambda` and `@remotion/cloudrun` are deployment configuration —
|
|
125
|
+
orthogonal to the rendered composition itself. The skill emits these as
|
|
126
|
+
**warnings** (not blockers) and drops them in step 3 (Generate) with a note
|
|
127
|
+
in `TRANSLATION_NOTES.md`. HF is single-machine today; document the gap.
|
|
128
|
+
|
|
129
|
+
| Remotion | HyperFrames |
|
|
130
|
+
| -------------------------- | ------------------------------------------------------ |
|
|
131
|
+
| `@remotion/lambda` import | drop the import (warning `r2hf/lambda-import`) |
|
|
132
|
+
| `renderMediaOnLambda(...)` | drop the call; note in `TRANSLATION_NOTES.md` |
|
|
133
|
+
| `@remotion/cloudrun` | drop the import + call; note in `TRANSLATION_NOTES.md` |
|
|
134
|
+
|
|
135
|
+
## When to bow out entirely
|
|
136
|
+
|
|
137
|
+
If any blocker pattern is present, recommend the runtime interop pattern from
|
|
138
|
+
[PR #214](https://github.com/heygen-com/hyperframes/pull/214) instead of
|
|
139
|
+
attempting translation. See [escape-hatch.md](escape-hatch.md).
|
|
140
|
+
|
|
141
|
+
The blockers are documented in [`scripts/lint_source.py`](../scripts/lint_source.py)
|
|
142
|
+
and tested by [tier-4-escape-hatch](../assets/test-corpus/tier-4-escape-hatch/).
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# When to bow out: the runtime interop pattern
|
|
2
|
+
|
|
3
|
+
Some Remotion compositions can't be translated cleanly. The skill should
|
|
4
|
+
recognize them upfront and recommend the **runtime interop pattern** from
|
|
5
|
+
[PR #214](https://github.com/heygen-com/hyperframes/pull/214) instead of
|
|
6
|
+
producing broken HTML.
|
|
7
|
+
|
|
8
|
+
## When to recommend interop
|
|
9
|
+
|
|
10
|
+
Run `scripts/lint_source.py` first. If it returns any blocker, recommend
|
|
11
|
+
interop. The blockers are:
|
|
12
|
+
|
|
13
|
+
| Rule | What it catches |
|
|
14
|
+
| --------------------------- | -------------------------------------------------------------- |
|
|
15
|
+
| `r2hf/use-state` | useState driving animation |
|
|
16
|
+
| `r2hf/use-reducer` | useReducer driving animation |
|
|
17
|
+
| `r2hf/use-effect-deps` | useEffect/useLayoutEffect with non-empty deps (side effects) |
|
|
18
|
+
| `r2hf/async-metadata` | calculateMetadata returns a Promise |
|
|
19
|
+
| `r2hf/third-party-react-ui` | Imports from MUI, Chakra, Mantine, antd, shadcn, Radix, NextUI |
|
|
20
|
+
|
|
21
|
+
Each of these breaks the seek-driven, deterministic-frame model that HF
|
|
22
|
+
relies on. Translating them produces silently-wrong output.
|
|
23
|
+
|
|
24
|
+
## What the interop pattern actually does
|
|
25
|
+
|
|
26
|
+
Per [PR #214](https://github.com/heygen-com/hyperframes/pull/214), the
|
|
27
|
+
runtime adapter:
|
|
28
|
+
|
|
29
|
+
1. Bundles the user's Remotion code with React + `@remotion/player` via esbuild.
|
|
30
|
+
2. Mounts a Remotion `<Player>` inside an HF composition's HTML.
|
|
31
|
+
3. Pauses the player on mount.
|
|
32
|
+
4. Registers the player on `window.__hfRemotion` with `seekTo(frame)`,
|
|
33
|
+
`pause()`, `durationInFrames`, `fps`.
|
|
34
|
+
5. HF's render loop seeks the player frame-by-frame via `seekTo(frame)`.
|
|
35
|
+
|
|
36
|
+
Result: Remotion's React tree renders at HF's deterministic frame ticks.
|
|
37
|
+
Custom hooks, useState, useEffect, MUI components — all work because
|
|
38
|
+
Remotion's React reconciler is doing the rendering.
|
|
39
|
+
|
|
40
|
+
## The recommendation message
|
|
41
|
+
|
|
42
|
+
When the skill detects a blocker, output something like:
|
|
43
|
+
|
|
44
|
+
> The Remotion source uses `useState` (and others), which can't be
|
|
45
|
+
> translated to HF's seek-driven HTML model. The recommended path is the
|
|
46
|
+
> **runtime interop pattern**: bundle your Remotion code with `@remotion/player`
|
|
47
|
+
> and let HF drive it frame-by-frame.
|
|
48
|
+
>
|
|
49
|
+
> See https://github.com/heygen-com/hyperframes/pull/214 for the full
|
|
50
|
+
> implementation. Quick summary:
|
|
51
|
+
>
|
|
52
|
+
> 1. Bundle `entry.tsx` with esbuild: `npx esbuild entry.tsx --bundle --outfile=dist/bundle.js --format=iife --jsx=automatic`
|
|
53
|
+
> 2. Mount the Player and register on `window.__hfRemotion`:
|
|
54
|
+
>
|
|
55
|
+
> ```tsx
|
|
56
|
+
> const playerRef = useRef<PlayerRef>(null);
|
|
57
|
+
> useEffect(() => {
|
|
58
|
+
> playerRef.current?.pause();
|
|
59
|
+
> window.__hfRemotion = window.__hfRemotion || [];
|
|
60
|
+
> window.__hfRemotion.push({
|
|
61
|
+
> seekTo: (f) => playerRef.current?.seekTo(f),
|
|
62
|
+
> pause: () => playerRef.current?.pause(),
|
|
63
|
+
> durationInFrames,
|
|
64
|
+
> fps,
|
|
65
|
+
> });
|
|
66
|
+
> }, []);
|
|
67
|
+
> ```
|
|
68
|
+
>
|
|
69
|
+
> 3. Reference the bundle from your HF `index.html` and render normally:
|
|
70
|
+
> `<script src="dist/bundle.js"></script>`
|
|
71
|
+
|
|
72
|
+
## The lint output already includes recommendations
|
|
73
|
+
|
|
74
|
+
`lint_source.py` emits a `recommendation` field per finding. Surface those
|
|
75
|
+
verbatim — they're tuned per blocker rule:
|
|
76
|
+
|
|
77
|
+
```json
|
|
78
|
+
{
|
|
79
|
+
"rule": "r2hf/use-state",
|
|
80
|
+
"message": "useState detected — Remotion compositions that drive animation via React state are not deterministic frame-capture targets in HyperFrames",
|
|
81
|
+
"recommendation": "Use the runtime interop pattern from PR #214 instead of attempting a translation"
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## When NOT to bow out: warnings only
|
|
86
|
+
|
|
87
|
+
Some patterns produce warnings, not blockers — translate after dropping
|
|
88
|
+
the wrappers:
|
|
89
|
+
|
|
90
|
+
| Rule | Action |
|
|
91
|
+
| ------------------------- | ------------------------------------------------------------------- |
|
|
92
|
+
| `r2hf/lambda-import` | drop the `@remotion/lambda` config; HF runs single-machine, log gap |
|
|
93
|
+
| `r2hf/delay-render` | drop the call; HF handles asset readiness |
|
|
94
|
+
| `r2hf/use-callback` | drop the wrapper, inline the function |
|
|
95
|
+
| `r2hf/use-memo` | drop the wrapper, compute inline |
|
|
96
|
+
| `r2hf/custom-hook` (pure) | inline the hook body if it's a derivation of `useCurrentFrame` |
|
|
97
|
+
| `r2hf/static-file` | replace `staticFile("x")` with `"assets/x"` |
|
|
98
|
+
| `r2hf/interpolate-colors` | translate to GSAP color tween (see [timing.md](timing.md)) |
|
|
99
|
+
|
|
100
|
+
These are documented in T4 cases 05–07.
|
|
101
|
+
|
|
102
|
+
`r2hf/lambda-import` is a warning — not a blocker — because Lambda
|
|
103
|
+
configuration is orthogonal to the rendered composition. Translating an
|
|
104
|
+
otherwise-clean Remotion comp shouldn't fail just because the author also
|
|
105
|
+
configured AWS Lambda for distributed rendering. The skill drops the
|
|
106
|
+
`@remotion/lambda` imports and `renderMediaOnLambda(...)` calls in step 3
|
|
107
|
+
(Generate) and writes a `TRANSLATION_NOTES.md` entry so the user knows to
|
|
108
|
+
set up HF rendering separately.
|
|
109
|
+
|
|
110
|
+
## When the source has BOTH blockers AND warnings
|
|
111
|
+
|
|
112
|
+
Bow out. The presence of a single blocker means the skill shouldn't
|
|
113
|
+
attempt translation — even if the rest of the composition is clean.
|
|
114
|
+
The user should use interop for the whole thing OR refactor the
|
|
115
|
+
blocker patterns out of their Remotion source first.
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# Eval: how to validate a translation end-to-end
|
|
2
|
+
|
|
3
|
+
Every translation should be measured. The skill ships three scripts and
|
|
4
|
+
a tiered test corpus that, together, gate translation quality.
|
|
5
|
+
|
|
6
|
+
## The three scripts
|
|
7
|
+
|
|
8
|
+
| Script | Input | Output |
|
|
9
|
+
| ------------------------ | --------------------------- | ------------------------------------------------------------------- |
|
|
10
|
+
| `scripts/lint_source.py` | Remotion source dir or file | JSON findings + exit code (0 clean, 1 has blockers) |
|
|
11
|
+
| `scripts/render_diff.sh` | two MP4 paths | per-frame SSIM + JSON summary (`mean`, `min`, `p05`, `p95`, `pass`) |
|
|
12
|
+
| `scripts/frame_strip.sh` | two MP4 paths | side-by-side comparison strip PNG for visual debugging |
|
|
13
|
+
|
|
14
|
+
Run them in this order: **lint → render → diff → (if fail) strip**.
|
|
15
|
+
|
|
16
|
+
## Per-fixture flow
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# 1. Lint the source — blockers mean stop
|
|
20
|
+
python3 ../../scripts/lint_source.py ./remotion-src/src/
|
|
21
|
+
|
|
22
|
+
# 2. Generate any binary assets (T2+T3 only)
|
|
23
|
+
[ -f setup.sh ] && ./setup.sh
|
|
24
|
+
|
|
25
|
+
# 3. Render Remotion baseline
|
|
26
|
+
cd remotion-src && npm install && npm run render
|
|
27
|
+
# -> remotion-src/out/baseline.mp4
|
|
28
|
+
|
|
29
|
+
# 4. Render HF translation
|
|
30
|
+
cd .. && node ../../../packages/cli/dist/cli.js render hf-src/ --output hf.mp4
|
|
31
|
+
# -> hf.mp4
|
|
32
|
+
|
|
33
|
+
# 5. SSIM diff
|
|
34
|
+
../../scripts/render_diff.sh ./remotion-src/out/baseline.mp4 ./hf.mp4 ./diff
|
|
35
|
+
# -> diff/summary.json
|
|
36
|
+
|
|
37
|
+
# 6. If diff fails, generate frame strip for visual inspection
|
|
38
|
+
../../scripts/frame_strip.sh ./remotion-src/out/baseline.mp4 ./hf.mp4 ./strip 8
|
|
39
|
+
# -> strip/strip.png
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Reading `diff/summary.json`
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"frame_count": 90,
|
|
47
|
+
"mean": 0.974,
|
|
48
|
+
"min": 0.972,
|
|
49
|
+
"max": 0.999,
|
|
50
|
+
"p05": 0.972,
|
|
51
|
+
"p95": 0.983,
|
|
52
|
+
"threshold": 0.95,
|
|
53
|
+
"pass": true
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
| Field | What it tells you |
|
|
58
|
+
| ------------- | --------------------------------------------------------------------------- |
|
|
59
|
+
| `mean` | average SSIM across all frames; the headline number |
|
|
60
|
+
| `min` | worst frame; below threshold means at least one frame is structurally wrong |
|
|
61
|
+
| `p05` / `p95` | 5th / 95th percentile — most frames sit between these |
|
|
62
|
+
| `threshold` | from `R2HF_SSIM_THRESHOLD` env var (default 0.85) |
|
|
63
|
+
| `pass` | whether `mean >= threshold` |
|
|
64
|
+
|
|
65
|
+
## Validated tier thresholds
|
|
66
|
+
|
|
67
|
+
Calibrated against actual Remotion + HF renders:
|
|
68
|
+
|
|
69
|
+
| Tier | Composition shape | Mean | Threshold | Margin |
|
|
70
|
+
| ---- | ------------------------------------------- | ----- | --------- | ------ |
|
|
71
|
+
| T1 | single-element fade-in | 0.974 | 0.95 | +0.022 |
|
|
72
|
+
| T2 | multi-scene + spring + audio + image | 0.985 | 0.95 | +0.016 |
|
|
73
|
+
| T3 | data-driven, custom subcomponents, count-up | 0.953 | 0.90 | +0.038 |
|
|
74
|
+
|
|
75
|
+
Each fixture's `expected.json` carries:
|
|
76
|
+
|
|
77
|
+
- `ssim_threshold` — the gate for `pass`
|
|
78
|
+
- `validation` — the actual measured numbers from the calibration run
|
|
79
|
+
- `translation_notes` — what's lossy and why
|
|
80
|
+
|
|
81
|
+
## Critical: encoder config
|
|
82
|
+
|
|
83
|
+
Both Remotion and HF must output the same pixel format for SSIM to be
|
|
84
|
+
meaningful. Remotion's default JPEG output writes `yuvj420p` (full-range);
|
|
85
|
+
HF outputs `yuv420p` (limited-range). The mismatch costs ~0.05 SSIM.
|
|
86
|
+
|
|
87
|
+
Every fixture's `remotion.config.ts` sets:
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
Config.setVideoImageFormat("png");
|
|
91
|
+
Config.setColorSpace("bt709");
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
If the user's source doesn't have these, add them in the translation
|
|
95
|
+
step — otherwise the diff measures encoder differences, not translation
|
|
96
|
+
fidelity.
|
|
97
|
+
|
|
98
|
+
## What the noise floor looks like
|
|
99
|
+
|
|
100
|
+
The dominant non-translation noise is **system font fallback divergence**.
|
|
101
|
+
Remotion's bundled Chromium and HF's `chrome-headless-shell` interpret
|
|
102
|
+
`font-weight: 800` differently when there's no real font installed:
|
|
103
|
+
|
|
104
|
+
- Remotion HELLO at 160px: medium-weight stroke
|
|
105
|
+
- HF HELLO at 160px: heavy-weight stroke
|
|
106
|
+
|
|
107
|
+
This costs ~0.025 mean SSIM. Visible in T1's frame strip.
|
|
108
|
+
[fonts.md](fonts.md) covers how to mitigate (use Inter, load explicit
|
|
109
|
+
Google Fonts).
|
|
110
|
+
|
|
111
|
+
## Threshold rule of thumb
|
|
112
|
+
|
|
113
|
+
Set the threshold ~0.02 below measured `p05`:
|
|
114
|
+
|
|
115
|
+
- Real translation regressions drop mean by 0.05+ — caught.
|
|
116
|
+
- Encoder/font drift between CI runs is bounded at ~0.01 — not caught.
|
|
117
|
+
|
|
118
|
+
If a calibration run's measured mean is far above your initial threshold
|
|
119
|
+
guess, _don't_ tighten the threshold to fit. Leave headroom — fixtures
|
|
120
|
+
re-rendered on different hardware will drift.
|
|
121
|
+
|
|
122
|
+
## When the diff fails
|
|
123
|
+
|
|
124
|
+
1. **Look at `frame_strip.sh` output first.** A side-by-side strip at 6–10
|
|
125
|
+
evenly-spaced timestamps shows whether the failure is structural
|
|
126
|
+
(wrong scene durations, missing element) or cosmetic (different font
|
|
127
|
+
weight, slight timing skew).
|
|
128
|
+
2. **Check `diff/ssim.log`.** Per-frame SSIM tells you _which_ frames
|
|
129
|
+
failed. Cluster of bad frames in the middle of a scene = animation
|
|
130
|
+
problem; bad frames at scene boundaries = sequencing problem.
|
|
131
|
+
3. **Re-read the relevant reference.** [timing.md](timing.md) for
|
|
132
|
+
spring/easing issues, [sequencing.md](sequencing.md) for scene
|
|
133
|
+
boundary issues, [media.md](media.md) for asset loading issues.
|
|
134
|
+
|
|
135
|
+
## CI integration
|
|
136
|
+
|
|
137
|
+
The fixtures are not yet wired into CI (`packages/producer/tests/` runs
|
|
138
|
+
inside Docker; the skill corpus needs the same). PR 7 of the stack adds
|
|
139
|
+
the orchestrator that runs all four tiers and emits an aggregated pass
|
|
140
|
+
report. For now, evaluate by hand per fixture.
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# Font translation
|
|
2
|
+
|
|
3
|
+
Fonts are the dominant non-translation noise floor. Same `font-weight: 800`
|
|
4
|
+
renders perceptibly bolder on HF's `chrome-headless-shell` than on
|
|
5
|
+
Remotion's bundled Chromium when there's no real font installed. Validation
|
|
6
|
+
showed this costs ~0.025 mean SSIM at the noise floor.
|
|
7
|
+
|
|
8
|
+
## Pattern: `@remotion/google-fonts/<Family>`
|
|
9
|
+
|
|
10
|
+
```tsx
|
|
11
|
+
import { loadFont } from "@remotion/google-fonts/Inter";
|
|
12
|
+
loadFont("normal", { weights: ["400", "800"] });
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Translate to a `<link>` tag in `<head>`:
|
|
16
|
+
|
|
17
|
+
```html
|
|
18
|
+
<head>
|
|
19
|
+
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
20
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
21
|
+
<link
|
|
22
|
+
href="https://fonts.googleapis.com/css2?family=Inter:wght@400;800&display=swap"
|
|
23
|
+
rel="stylesheet"
|
|
24
|
+
/>
|
|
25
|
+
<style>
|
|
26
|
+
body {
|
|
27
|
+
font-family: Inter, sans-serif;
|
|
28
|
+
}
|
|
29
|
+
</style>
|
|
30
|
+
</head>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Pull the family name and weights from the import path and `loadFont`
|
|
34
|
+
arguments. HF's compiler inlines the Google Fonts CSS at render time, so
|
|
35
|
+
you don't pay a network round-trip per render.
|
|
36
|
+
|
|
37
|
+
## Pattern: local fonts via `@font-face`
|
|
38
|
+
|
|
39
|
+
```tsx
|
|
40
|
+
import { Font } from "remotion";
|
|
41
|
+
|
|
42
|
+
Font.loadFont("/MyFont.woff2", "MyFont");
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Translate to a `@font-face` rule:
|
|
46
|
+
|
|
47
|
+
```html
|
|
48
|
+
<style>
|
|
49
|
+
@font-face {
|
|
50
|
+
font-family: "MyFont";
|
|
51
|
+
src: url("assets/MyFont.woff2") format("woff2");
|
|
52
|
+
font-weight: 400;
|
|
53
|
+
font-style: normal;
|
|
54
|
+
}
|
|
55
|
+
</style>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Copy the font file into `hf-src/assets/` next to the HTML.
|
|
59
|
+
|
|
60
|
+
## Pattern: system font fallback (no font load)
|
|
61
|
+
|
|
62
|
+
```tsx
|
|
63
|
+
<div style={{ fontFamily: "Helvetica, Arial, sans-serif" }}>...</div>
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Same string in HF — but be aware: on Linux without a real Helvetica
|
|
67
|
+
installed (typical CI environment), Remotion and HF fall back to
|
|
68
|
+
_different_ sans-serif system fonts because they bundle different
|
|
69
|
+
Chromium versions. This is the noise floor: ~0.025 mean SSIM cost,
|
|
70
|
+
visible as different stroke widths at large font weights (800+).
|
|
71
|
+
|
|
72
|
+
If matching the Remotion render exactly matters for a specific
|
|
73
|
+
fixture, load the same font explicitly — don't rely on system
|
|
74
|
+
fallback.
|
|
75
|
+
|
|
76
|
+
## When in doubt: use Inter
|
|
77
|
+
|
|
78
|
+
Inter renders identically across Chromium versions and is free.
|
|
79
|
+
Translate any "system sans-serif" Remotion comp to Inter when you
|
|
80
|
+
need to minimize font drift in the validation harness.
|
|
81
|
+
|
|
82
|
+
## Font loading and `delayRender`
|
|
83
|
+
|
|
84
|
+
Remotion uses `delayRender()` to defer the first frame until fonts
|
|
85
|
+
load. HF's compiler inlines Google Fonts at compile time and waits
|
|
86
|
+
on `@font-face` readiness via the Frame Adapter pattern — the
|
|
87
|
+
`delayRender` call drops in translation. See [media.md](media.md).
|
|
88
|
+
|
|
89
|
+
## Multi-weight loading
|
|
90
|
+
|
|
91
|
+
When Remotion loads multiple weights:
|
|
92
|
+
|
|
93
|
+
```tsx
|
|
94
|
+
loadFont("normal", { weights: ["400", "500", "700", "800"] });
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Inline all weights in the Google Fonts URL:
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
?family=Inter:wght@400;500;700;800&display=swap
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Translation rule: enumerate every distinct `font-weight` value
|
|
104
|
+
that appears in the composition's CSS (`font-weight: 800` →
|
|
105
|
+
weight 800 must be loaded). If the Remotion source loads weights
|
|
106
|
+
that aren't actually used, drop them.
|
|
107
|
+
|
|
108
|
+
## Font subsetting
|
|
109
|
+
|
|
110
|
+
Remotion's `loadFont` doesn't subset; HF's compiler doesn't either
|
|
111
|
+
(yet). Don't try to optimize this in translation — it's lossless to
|
|
112
|
+
keep the same weight set as the Remotion source.
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# Translation limitations
|
|
2
|
+
|
|
3
|
+
What the skill explicitly cannot translate, separated from the
|
|
4
|
+
blocker-list (which is enforced by `lint_source.py`). These are
|
|
5
|
+
_known_ gaps — surface them to the user as translation notes
|
|
6
|
+
when translating the surrounding composition.
|
|
7
|
+
|
|
8
|
+
## React patterns the skill refuses
|
|
9
|
+
|
|
10
|
+
See [escape-hatch.md](escape-hatch.md). Any of these triggers
|
|
11
|
+
a bow-out:
|
|
12
|
+
|
|
13
|
+
- `useState`, `useReducer` driving animation
|
|
14
|
+
- `useEffect` / `useLayoutEffect` with non-empty deps (side effects)
|
|
15
|
+
- async `calculateMetadata`
|
|
16
|
+
- Third-party React UI libraries (MUI, Chakra, Mantine, antd, shadcn, Radix, NextUI)
|
|
17
|
+
|
|
18
|
+
`@remotion/lambda` is no longer in this list — it's a warning, not a
|
|
19
|
+
blocker, because Lambda config is orthogonal to composition rendering.
|
|
20
|
+
The skill drops the imports and `renderMediaOnLambda(...)` calls and
|
|
21
|
+
writes a `TRANSLATION_NOTES.md` entry. See
|
|
22
|
+
[escape-hatch.md](escape-hatch.md).
|
|
23
|
+
|
|
24
|
+
## Patterns that work with caveats
|
|
25
|
+
|
|
26
|
+
### Volume ramps on `<Audio>`
|
|
27
|
+
|
|
28
|
+
Remotion accepts a function for `volume`:
|
|
29
|
+
|
|
30
|
+
```tsx
|
|
31
|
+
<Audio src={...} volume={(f) => interpolate(f, [0, 30], [0, 1])} />
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
HF supports static `data-volume` only. Translation: bake the ramp into
|
|
35
|
+
the audio file at translation time using `ffmpeg afade`, OR drop the
|
|
36
|
+
ramp with a note. The dropped-ramp path produces audibly different
|
|
37
|
+
output but visually-identical video, so SSIM passes — just flag it.
|
|
38
|
+
|
|
39
|
+
### `<Loop>` with stateful children
|
|
40
|
+
|
|
41
|
+
```tsx
|
|
42
|
+
<Loop durationInFrames={30}>
|
|
43
|
+
<CounterThatIncrementsViaUseRef />
|
|
44
|
+
</Loop>
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Loop with `repeat: -1` works for _visual_ repetition. If the looped
|
|
48
|
+
child has cross-iteration state (a counter, a randomness seed), HF
|
|
49
|
+
won't reproduce it identically per iteration. Bow out unless the
|
|
50
|
+
child is fully deterministic per-iteration.
|
|
51
|
+
|
|
52
|
+
### Remotion's `<Img>` with crossOrigin
|
|
53
|
+
|
|
54
|
+
```tsx
|
|
55
|
+
<Img src="https://other-domain.com/x.png" crossOrigin="anonymous" />
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
HF's renderer doesn't enforce CORS the same way Remotion does. Most
|
|
59
|
+
public images work; private images served with auth headers won't.
|
|
60
|
+
If the source uses `crossOrigin="use-credentials"`, the asset needs
|
|
61
|
+
to be downloaded and inlined at translation time.
|
|
62
|
+
|
|
63
|
+
### Custom `presentation` in `<TransitionSeries>`
|
|
64
|
+
|
|
65
|
+
```tsx
|
|
66
|
+
const customPresentation: PresentationComponent = ({ children, presentationProgress }) => {
|
|
67
|
+
return <div style={{ filter: `blur(${(1 - presentationProgress) * 20}px)` }}>{children}</div>;
|
|
68
|
+
};
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Pure presentations (transform/filter/opacity computed from progress)
|
|
72
|
+
translate to GSAP tweens cleanly. Presentations that read
|
|
73
|
+
`useCurrentFrame()` internally or have stateful children don't —
|
|
74
|
+
bow out.
|
|
75
|
+
|
|
76
|
+
### Code-split components (`React.lazy`)
|
|
77
|
+
|
|
78
|
+
```tsx
|
|
79
|
+
const HeavyChart = React.lazy(() => import("./HeavyChart"));
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
`React.lazy` is async and doesn't fit the deterministic-render model.
|
|
83
|
+
Translate to a regular import; the resulting HF composition will
|
|
84
|
+
just include all the code upfront.
|
|
85
|
+
|
|
86
|
+
## Patterns that always work
|
|
87
|
+
|
|
88
|
+
- `<AbsoluteFill>` and `<Sequence>` (any nesting)
|
|
89
|
+
- `useCurrentFrame()` derivations: `interpolate`, `spring`, `Easing`,
|
|
90
|
+
`interpolateColors`, manual math
|
|
91
|
+
- `<Audio>`, `<Video>`, `<Img>`, `<IFrame>` with simple props
|
|
92
|
+
- `staticFile()` references
|
|
93
|
+
- Custom React subcomponents that are pure functions of props
|
|
94
|
+
- Custom hooks that are pure derivations of `useCurrentFrame`
|
|
95
|
+
- `@remotion/lottie` (translates to HF's Lottie adapter)
|
|
96
|
+
- `@remotion/google-fonts/<Family>` (translates to `<link>` or `@font-face`)
|
|
97
|
+
- Sync `calculateMetadata` (resolved at translation time)
|
|
98
|
+
- `<TransitionSeries>` with built-in presentations (`fade`, `slide`,
|
|
99
|
+
`wipe`, `clockWipe`, `flip`, `iris`)
|
|
100
|
+
|
|
101
|
+
## What the skill never tries to translate
|
|
102
|
+
|
|
103
|
+
These are out-of-scope by design:
|
|
104
|
+
|
|
105
|
+
- **HDR rendering** — HF supports HDR but Remotion doesn't, so there's
|
|
106
|
+
nothing to translate from.
|
|
107
|
+
- **Variable frame rate** — both tools assume constant fps.
|
|
108
|
+
- **Multi-composition `<Composition>` lists** — translate one at a
|
|
109
|
+
time. The skill prompts the user to choose which composition.
|
|
110
|
+
- **Remotion Studio props panel** — visual prop editing in HF Studio
|
|
111
|
+
needs different infrastructure; out of scope.
|
|
112
|
+
|
|
113
|
+
## Reporting gaps to the user
|
|
114
|
+
|
|
115
|
+
When translation produces _something_ but the something has gaps, write
|
|
116
|
+
a `TRANSLATION_NOTES.md` next to the output:
|
|
117
|
+
|
|
118
|
+
```markdown
|
|
119
|
+
# Translation notes
|
|
120
|
+
|
|
121
|
+
The following Remotion patterns were translated with caveats:
|
|
122
|
+
|
|
123
|
+
- `<Audio volume={(f) => ...}>` (line 15): volume ramp dropped — added
|
|
124
|
+
static `data-volume="0.5"`. To preserve the ramp, run
|
|
125
|
+
`ffmpeg -i music.wav -af "afade=t=in:st=0:d=1" music.faded.wav` and
|
|
126
|
+
swap the source file.
|
|
127
|
+
- `<HeavyChart>` (line 30): translated as inline HTML. The original
|
|
128
|
+
React.lazy boundary was dropped — bundle size unchanged because HF
|
|
129
|
+
serves a single HTML file.
|
|
130
|
+
|
|
131
|
+
If any of these caveats matter, consider the runtime interop pattern
|
|
132
|
+
instead.
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
This file is also generated by the skill alongside the HF output, not
|
|
136
|
+
held in the corpus.
|