mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-07 10:06:21 +00:00
* fix(core,producer,cli): pre-flight validation for empty/malformed sub-compositions The #1 render failure bucket in production telemetry (PostHog project 356858, dashboard 1783183 "HyperFrames — Bottom-Line & Activation"; ~65-69K occurrences / ~27-28K affected users over 30 days, ~80% via AI-agent authoring flows) is a `data-composition-src` reference pointing at a scene file that is empty, malformed, or missing. Root cause, traced end-to-end: - The literal error "Composition HTML is empty or could not be parsed: <path>" is real (not a PostHog paraphrase) — thrown by a since-reverted guard in packages/core/src/compiler/inlineSubCompositions.ts (#1364), then changed to a silent skip in #1678 to avoid aborting renders on partial content during authoring. #1629 added per-assembler guards for 3 skill workflows (product-launch-video, faceless-explainer, pr-to-video), but general-video and hand-authored flows — where the dominant filename `scene-title.html` (40K+/68K of the bucket) originates — have no assembler and thus no guard. #1678 assumed the assembler guards from #1629 covered this pre-render; they only covered 3 of the many authoring flows. - On current `main`, an empty/malformed data-composition-src file no longer crashes or throws during render — it's silently dropped by the tolerant inliner. Reproduced locally: `hyperframes render` on a project with an empty scene-title.html "succeeds" after ~93s (two 45s pollSubCompositionTimelines timeouts) with the scene silently missing from the output video. `hyperframes validate` also reports "No console errors" for the same broken project. - The raw `Cannot destructure property 'firstElementChild' of 'documentElement' as it is null` crash reproduces directly against linkedom (the DOMParser polyfill packages/cli/src/utils/dom.ts installs in the real CLI runtime) for empty and non-HTML input — confirmed with a standalone repro script, not just inferred. jsdom/happy-dom (used in this repo's own test environment) are spec-compliant and never produce a null documentElement, which is why this needed a linkedom-specific test file. Fix: - New shared helper `checkSubCompositionUsability` (packages/core/src/compiler/subCompositionValidity.ts) is the single source of truth for "is this data-composition-src file usable" — mirrors the inliner's own parse/template/body logic so all callers agree. - `inlineSubCompositions.ts` (preview/studio bundling) now uses the shared helper internally but keeps its #1678 tolerant skip-and-continue behavior unchanged — mid-authoring iteration on a partial project must keep working. `onMissingComposition` now also receives a human-readable reason. - New render-only pre-flight (`assertSubCompositionsUsable` in packages/producer/src/services/htmlCompiler.ts) walks every data-composition-src reference (including nested ones, root-relative, matching parseSubCompositions' own resolution) before any compilation work starts, and throws naming every offending file at once. This is unconditional — not gated behind --strict — because a render that silently drops a scene is strictly worse than one that refuses to start. Confirmed locally: render now fails in ~0.4s with an actionable message instead of "succeeding" after 93s with a missing scene. - New `hyperframes lint` rule `missing_or_empty_sub_composition` (packages/cli/src/utils/lintProject.ts) surfaces the same check as a file-scoped, actionable lint error (already unconditional — lint exits 1 on any error). - `hyperframes validate` now also runs this check before launching a browser, so it no longer reports "No console errors" for a project with a broken sub-composition. - `packages/core/src/parsers/htmlParser.ts`: guarded every `documentElement`-may-be-null access (parseHtml, updateElementInHtml, addElementToHtml, removeElementFromHtml, extractCompositionMetadata, validateCompositionHtml) with a new typed `CompositionHtmlParseError` (or, for validateCompositionHtml's collect-and-report contract, a typed validation failure) instead of a raw crash. Tests: empty file, whitespace-only, malformed/non-HTML, missing file, nested sub-compositions (both happy path and broken-grandchild), and the happy path — at the shared-helper, lint, and render pre-flight layers. Not changed: the AI-agent authoring skills (skills/*). general-video and hand-authored flows have no assemble-index.mjs equivalent to guard, so the fix is at the CLI/render layer instead — flow-agnostic, covers every authoring path, and the skills' existing "run lint/validate and stop on failure" guidance now actually catches this class of mistake once run. Not run in this environment: the producer package's full regression-harness test suite (`bun test` in packages/producer) — it performs heavy real rendering (S3 asset downloads, Google Fonts fetches, full video encodes) and did not complete in a reasonable time in this sandbox. Verified instead via the targeted test file for all touched code (76/76 passing), whole-repo typecheck/build/oxlint, `fallow audit` (complexity/duplication/dead-code gate, clean), and manual end-to-end CLI runs (render/lint/validate) against reproduction projects, including a nested sub-composition scenario. CI should run the full producer suite before merge. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * refactor(parsers,lint): port empty-composition pre-flight to extracted packages Rebased onto main, which extracted @hyperframes/lint from core (lint depends only on parsers, not core). Relocate checkSubCompositionUsability from core to @hyperframes/parsers so both core (inliner) and lint can consume it without a core<->lint cycle; core keeps a @deprecated re-export shim. Correctness fixes from code review: - checkSubCompositionUsability now returns "no-composition-root" when the <template>/<body> content has no [data-composition-id] element (previously a marker-free placeholder body passed both guards). - lint's missing/empty sub-composition rule now only checks files reachable via data-composition-src from the root (matching render pre-flight), instead of a raw filesystem walk that false-positived on orphaned files. - drop `as string` cast in inlineSubCompositions in favor of an explicit null guard (per CLAUDE.md). Review-comment items: - move EmptyCompositionError JSDoc above the class (was above the adapter fn). - correct stale circular-ref comment to match actual silent-skip behavior. - rewrite self-contradicting lint message ("silently drop") to describe the new loud render-pre-flight abort. - add the __PLACEHOLDER__ (/^__[A-Z_]+__$/) skip to the render pre-flight so it agrees with lint. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
915 lines
29 KiB
TypeScript
915 lines
29 KiB
TypeScript
import type {
|
|
TimelineElement,
|
|
TimelineElementType,
|
|
TimelineMediaElement,
|
|
TimelineTextElement,
|
|
TimelineCompositionElement,
|
|
CanvasResolution,
|
|
Keyframe,
|
|
KeyframeProperties,
|
|
StageZoomKeyframe,
|
|
CompositionVariable,
|
|
ValidationResult,
|
|
} from "./types.js";
|
|
import { validateCompositionGsap } from "./gsapSerialize";
|
|
import { ensureHfIds } from "./hfIds.js";
|
|
import { parseGsapScriptAcornForWrite } from "./gsapParserAcorn.js";
|
|
import { queryByAttr } from "./utils/cssSelector.js";
|
|
import { removeAnimationFromScript } from "./gsapWriterAcorn.js";
|
|
|
|
const MEDIA_TYPES = new Set<string>(["video", "image", "audio"]);
|
|
|
|
/**
|
|
* Thrown by htmlParser functions when the input HTML is empty or does not
|
|
* parse to a document with a `documentElement` — the condition that,
|
|
* unguarded, previously surfaced as a raw
|
|
* `Cannot read properties of null (reading '...')` /
|
|
* `Cannot destructure property 'firstElementChild' of 'documentElement' as
|
|
* it is null` crash deep inside the DOM implementation instead of a clear,
|
|
* catchable error naming which function received bad input.
|
|
*/
|
|
export class CompositionHtmlParseError extends Error {
|
|
constructor(message: string) {
|
|
super(message);
|
|
this.name = "CompositionHtmlParseError";
|
|
}
|
|
}
|
|
|
|
export interface ParsedHtml {
|
|
elements: TimelineElement[];
|
|
gsapScript: string | null;
|
|
styles: string | null;
|
|
resolution: CanvasResolution;
|
|
keyframes: Record<string, Keyframe[]>;
|
|
stageZoomKeyframes: StageZoomKeyframe[];
|
|
}
|
|
|
|
function getElementType(el: Element): TimelineElementType | null {
|
|
const tag = el.tagName.toLowerCase();
|
|
if (tag === "video") return "video";
|
|
if (tag === "img") return "image";
|
|
if (tag === "audio") return "audio";
|
|
// Check for explicit data-type attribute first
|
|
const dataType = el.getAttribute("data-type");
|
|
if (dataType === "composition") return "composition";
|
|
if (dataType === "text") return "text";
|
|
// Fall back to tag-based detection for backwards compatibility
|
|
if (
|
|
tag === "div" ||
|
|
tag === "p" ||
|
|
tag === "h1" ||
|
|
tag === "h2" ||
|
|
tag === "h3" ||
|
|
tag === "span"
|
|
) {
|
|
return "text";
|
|
}
|
|
return null;
|
|
}
|
|
|
|
function getElementName(el: Element): string {
|
|
const dataName = el.getAttribute("data-name");
|
|
if (dataName) return dataName;
|
|
|
|
const type = getElementType(el);
|
|
if (type === "text") {
|
|
const text = el.textContent?.trim().slice(0, 30) || "Text";
|
|
return text.length === 30 ? text + "..." : text;
|
|
}
|
|
|
|
const src = el.getAttribute("src");
|
|
if (src) {
|
|
const filename = src.split("/").pop() || src;
|
|
return filename.split("?")[0] ?? filename;
|
|
}
|
|
|
|
return el.id || el.className?.toString().split(" ")[0] || "Element";
|
|
}
|
|
|
|
function getZIndex(el: Element): number {
|
|
const dataLayer = el.getAttribute("data-layer");
|
|
if (dataLayer) return parseInt(dataLayer, 10) || 0;
|
|
|
|
const style = (el as HTMLElement).style?.zIndex;
|
|
if (style) return parseInt(style, 10) || 0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
function parseResolutionFromCss(doc: Document, cssText: string | null): CanvasResolution {
|
|
const stage = doc.getElementById("stage") || doc.querySelector("#stage");
|
|
if (stage) {
|
|
const inlineStyle = (stage as HTMLElement).style;
|
|
if (inlineStyle?.width && inlineStyle?.height) {
|
|
const w = parseInt(inlineStyle.width, 10);
|
|
const h = parseInt(inlineStyle.height, 10);
|
|
if (w && h) {
|
|
return resolveResolutionFromDimensions(w, h);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (cssText) {
|
|
const stageMatch = cssText.match(
|
|
/#stage\s*\{[^}]*width:\s*(\d+)px[^}]*height:\s*(\d+)px[^}]*\}/,
|
|
);
|
|
if (stageMatch) {
|
|
const w = parseInt(stageMatch[1] ?? "", 10);
|
|
const h = parseInt(stageMatch[2] ?? "", 10);
|
|
return resolveResolutionFromDimensions(w, h);
|
|
}
|
|
const stageMatchReverse = cssText.match(
|
|
/#stage\s*\{[^}]*height:\s*(\d+)px[^}]*width:\s*(\d+)px[^}]*\}/,
|
|
);
|
|
if (stageMatchReverse) {
|
|
const h = parseInt(stageMatchReverse[1] ?? "", 10);
|
|
const w = parseInt(stageMatchReverse[2] ?? "", 10);
|
|
return resolveResolutionFromDimensions(w, h);
|
|
}
|
|
}
|
|
|
|
return "portrait";
|
|
}
|
|
|
|
function parseResolutionFromHtml(doc: Document): CanvasResolution | null {
|
|
const htmlEl = doc.documentElement;
|
|
if (!htmlEl) return null;
|
|
const resolutionAttr = htmlEl.getAttribute("data-resolution");
|
|
if (
|
|
resolutionAttr === "landscape" ||
|
|
resolutionAttr === "portrait" ||
|
|
resolutionAttr === "landscape-4k" ||
|
|
resolutionAttr === "portrait-4k" ||
|
|
resolutionAttr === "square" ||
|
|
resolutionAttr === "square-4k"
|
|
) {
|
|
return resolutionAttr;
|
|
}
|
|
|
|
const widthAttr = htmlEl.getAttribute("data-composition-width");
|
|
const heightAttr = htmlEl.getAttribute("data-composition-height");
|
|
if (widthAttr && heightAttr) {
|
|
const width = parseInt(widthAttr, 10);
|
|
const height = parseInt(heightAttr, 10);
|
|
if (width && height) {
|
|
return resolveResolutionFromDimensions(width, height);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
const UHD_SQUARE_MIN = 2160;
|
|
const UHD_RECT_MIN = 3840;
|
|
|
|
function resolveResolutionFromDimensions(width: number, height: number): CanvasResolution {
|
|
const longSide = Math.max(width, height);
|
|
if (width === height) {
|
|
return longSide >= UHD_SQUARE_MIN ? "square-4k" : "square";
|
|
}
|
|
const isLandscape = width > height;
|
|
const isUhd = longSide >= UHD_RECT_MIN;
|
|
if (isLandscape) return isUhd ? "landscape-4k" : "landscape";
|
|
return isUhd ? "portrait-4k" : "portrait";
|
|
}
|
|
|
|
export function parseHtml(html: string): ParsedHtml {
|
|
const withIds = ensureHfIds(html);
|
|
const parser = new DOMParser();
|
|
const doc = parser.parseFromString(withIds, "text/html");
|
|
|
|
const elements: TimelineElement[] = [];
|
|
const keyframes: Record<string, Keyframe[]> = {};
|
|
let idCounter = 0;
|
|
|
|
const htmlEl = doc.documentElement;
|
|
if (!htmlEl) {
|
|
throw new CompositionHtmlParseError("parseHtml: input HTML is empty or could not be parsed");
|
|
}
|
|
const customStylesAttr = htmlEl.getAttribute("data-custom-styles");
|
|
let customStyles: string | null = null;
|
|
if (customStylesAttr) {
|
|
try {
|
|
customStyles = JSON.parse(customStylesAttr);
|
|
} catch {
|
|
customStyles = customStylesAttr;
|
|
}
|
|
}
|
|
|
|
const timedElements = doc.querySelectorAll("[data-start]");
|
|
|
|
timedElements.forEach((el) => {
|
|
const type = getElementType(el);
|
|
if (!type) return;
|
|
|
|
const start = parseFloat(el.getAttribute("data-start") || "0");
|
|
const dataEnd = el.getAttribute("data-end");
|
|
|
|
let duration: number;
|
|
if (dataEnd) {
|
|
duration = Math.max(0, parseFloat(dataEnd) - start);
|
|
} else {
|
|
duration = 5;
|
|
}
|
|
|
|
// R1: stable hf- id minted by ensureHfIds above; clips just read it.
|
|
// Legacy/migration note: ensureHfIds pins a pre-existing `data-hf-id`, and
|
|
// the generator emits `data-hf-id="${element.id}"`. So a clip authored
|
|
// before R1 with `id="my-title"` round-trips as `data-hf-id="my-title"` —
|
|
// a non-`hf-`-shaped but still stable, exact-match handle. This is safe
|
|
// indefinitely: targeting uses exact `[data-hf-id="…"]` match (it does not
|
|
// require the hf- prefix). ensureHfIds skips elements that already carry
|
|
// data-hf-id, so legacy values are NOT re-minted automatically — they
|
|
// persist until the user re-saves the composition through Studio. Not a bug.
|
|
const id = el.getAttribute("data-hf-id") || el.id || `element-${++idCounter}`;
|
|
const name = getElementName(el);
|
|
const zIndex = getZIndex(el);
|
|
|
|
// Parse data-keyframes attribute if present
|
|
const keyframesAttr = el.getAttribute("data-keyframes");
|
|
if (keyframesAttr) {
|
|
try {
|
|
const parsedKeyframes = JSON.parse(keyframesAttr);
|
|
if (Array.isArray(parsedKeyframes) && parsedKeyframes.length > 0) {
|
|
keyframes[id] = parsedKeyframes;
|
|
}
|
|
} catch {
|
|
// skip invalid keyframes
|
|
}
|
|
}
|
|
|
|
// Parse transform properties (x, y, scale, opacity)
|
|
const xAttr = el.getAttribute("data-x");
|
|
const yAttr = el.getAttribute("data-y");
|
|
const scaleAttr = el.getAttribute("data-scale");
|
|
const opacityAttr = el.getAttribute("data-opacity");
|
|
const x = xAttr ? parseFloat(xAttr) : undefined;
|
|
const y = yAttr ? parseFloat(yAttr) : undefined;
|
|
const scale = scaleAttr ? parseFloat(scaleAttr) : undefined;
|
|
const opacity = opacityAttr ? parseFloat(opacityAttr) : undefined;
|
|
|
|
if (type === "text") {
|
|
const textEl = el.firstElementChild;
|
|
const content = textEl?.textContent || name;
|
|
const color = el.getAttribute("data-color") || undefined;
|
|
const fontSizeAttr = el.getAttribute("data-font-size");
|
|
const fontSize = fontSizeAttr ? parseInt(fontSizeAttr, 10) : undefined;
|
|
const fontWeightAttr = el.getAttribute("data-font-weight");
|
|
const fontWeight = fontWeightAttr ? parseInt(fontWeightAttr, 10) : undefined;
|
|
const fontFamily = el.getAttribute("data-font-family") || undefined;
|
|
const textShadowAttr = el.getAttribute("data-text-shadow");
|
|
const textShadow = textShadowAttr === "false" ? false : undefined;
|
|
|
|
// Parse outline properties
|
|
const textOutlineAttr = el.getAttribute("data-text-outline");
|
|
const textOutline = textOutlineAttr === "true" ? true : undefined;
|
|
const textOutlineColor = el.getAttribute("data-text-outline-color") || undefined;
|
|
const textOutlineWidthAttr = el.getAttribute("data-text-outline-width");
|
|
const textOutlineWidth = textOutlineWidthAttr
|
|
? parseInt(textOutlineWidthAttr, 10)
|
|
: undefined;
|
|
|
|
// Parse highlight properties
|
|
const textHighlightAttr = el.getAttribute("data-text-highlight");
|
|
const textHighlight = textHighlightAttr === "true" ? true : undefined;
|
|
const textHighlightColor = el.getAttribute("data-text-highlight-color") || undefined;
|
|
const textHighlightPaddingAttr = el.getAttribute("data-text-highlight-padding");
|
|
const textHighlightPadding = textHighlightPaddingAttr
|
|
? parseInt(textHighlightPaddingAttr, 10)
|
|
: undefined;
|
|
const textHighlightRadiusAttr = el.getAttribute("data-text-highlight-radius");
|
|
const textHighlightRadius = textHighlightRadiusAttr
|
|
? parseInt(textHighlightRadiusAttr, 10)
|
|
: undefined;
|
|
|
|
const textElement: TimelineTextElement = {
|
|
id,
|
|
type: "text",
|
|
name,
|
|
content,
|
|
startTime: start,
|
|
duration,
|
|
zIndex,
|
|
x,
|
|
y,
|
|
scale,
|
|
opacity,
|
|
color,
|
|
fontSize,
|
|
fontWeight,
|
|
fontFamily,
|
|
textShadow,
|
|
textOutline,
|
|
textOutlineColor,
|
|
textOutlineWidth,
|
|
textHighlight,
|
|
textHighlightColor,
|
|
textHighlightPadding,
|
|
textHighlightRadius,
|
|
};
|
|
elements.push(textElement);
|
|
} else if (type === "composition") {
|
|
// Composition is a div container with iframe inside
|
|
const iframe = el.querySelector("iframe");
|
|
const src = iframe?.getAttribute("src") || el.getAttribute("src") || "";
|
|
const compositionId = el.getAttribute("data-composition-id") || "";
|
|
const sourceDurationAttr = el.getAttribute("data-source-duration");
|
|
const sourceDuration = sourceDurationAttr ? parseFloat(sourceDurationAttr) : undefined;
|
|
const sourceWidthAttr = el.getAttribute("data-source-width");
|
|
const sourceWidth = sourceWidthAttr ? parseInt(sourceWidthAttr, 10) : undefined;
|
|
const sourceHeightAttr = el.getAttribute("data-source-height");
|
|
const sourceHeight = sourceHeightAttr ? parseInt(sourceHeightAttr, 10) : undefined;
|
|
|
|
// Parse variable values if present
|
|
const variableValuesAttr = el.getAttribute("data-variable-values");
|
|
let variableValues: Record<string, string | number | boolean> | undefined;
|
|
if (variableValuesAttr) {
|
|
try {
|
|
variableValues = JSON.parse(variableValuesAttr);
|
|
} catch {
|
|
// skip invalid variable values
|
|
}
|
|
}
|
|
|
|
const compositionElement: TimelineCompositionElement = {
|
|
id,
|
|
type: "composition",
|
|
name,
|
|
src,
|
|
compositionId,
|
|
startTime: start,
|
|
duration,
|
|
zIndex,
|
|
x,
|
|
y,
|
|
scale,
|
|
opacity,
|
|
sourceDuration,
|
|
sourceWidth,
|
|
sourceHeight,
|
|
variableValues,
|
|
};
|
|
elements.push(compositionElement);
|
|
} else {
|
|
if (!MEDIA_TYPES.has(type)) return;
|
|
|
|
const src = el.getAttribute("src") || "";
|
|
const mediaStartTimeAttr = el.getAttribute("data-media-start");
|
|
const mediaStartTime = mediaStartTimeAttr ? parseFloat(mediaStartTimeAttr) : undefined;
|
|
const sourceDurationAttr = el.getAttribute("data-source-duration");
|
|
const sourceDuration = sourceDurationAttr ? parseFloat(sourceDurationAttr) : undefined;
|
|
const isArollAttr = el.getAttribute("data-aroll");
|
|
const isAroll = isArollAttr === "true" ? true : undefined;
|
|
const volumeAttr = el.getAttribute("data-volume");
|
|
const volume = volumeAttr ? parseFloat(volumeAttr) : undefined;
|
|
const hasAudioAttr = el.getAttribute("data-has-audio");
|
|
const hasAudio = hasAudioAttr === "true" ? true : undefined;
|
|
|
|
const mediaElement: TimelineMediaElement = {
|
|
id,
|
|
type: type as "video" | "image" | "audio",
|
|
name,
|
|
src,
|
|
startTime: start,
|
|
duration,
|
|
zIndex,
|
|
x,
|
|
y,
|
|
scale,
|
|
opacity,
|
|
mediaStartTime,
|
|
sourceDuration,
|
|
isAroll,
|
|
volume,
|
|
hasAudio,
|
|
};
|
|
elements.push(mediaElement);
|
|
}
|
|
});
|
|
|
|
const scriptTags = doc.querySelectorAll("script");
|
|
let gsapScript: string | null = null;
|
|
|
|
for (const script of scriptTags) {
|
|
const src = script.getAttribute("src");
|
|
if (src && src.includes("gsap")) continue;
|
|
|
|
const content = script.textContent?.trim();
|
|
if (content && (content.includes("gsap") || content.includes("timeline"))) {
|
|
gsapScript = content;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Normalize keyframes (clamp negative time, convert absolute -> relative if detected)
|
|
for (const element of elements) {
|
|
const elementKeyframes = keyframes[element.id];
|
|
if (!elementKeyframes || elementKeyframes.length === 0) continue;
|
|
|
|
const baseX = element.x ?? 0;
|
|
const baseY = element.y ?? 0;
|
|
const baseScale =
|
|
element.type === "video" || element.type === "image" || element.type === "composition"
|
|
? ((element as TimelineMediaElement | TimelineCompositionElement).scale ?? 1)
|
|
: 1;
|
|
|
|
keyframes[element.id] = normalizeKeyframes(elementKeyframes, baseX, baseY, baseScale);
|
|
}
|
|
|
|
const styleTags = doc.querySelectorAll("style");
|
|
const allStyles =
|
|
Array.from(styleTags)
|
|
.map((s) => s.textContent?.trim())
|
|
.filter(Boolean)
|
|
.join("\n\n") || null;
|
|
|
|
const customStyleTags = Array.from(styleTags).filter(
|
|
(s) => s.getAttribute("data-hf-custom") === "true",
|
|
);
|
|
const customStylesFromTags =
|
|
customStyleTags
|
|
.map((s) => s.textContent?.trim())
|
|
.filter(Boolean)
|
|
.join("\n\n") || null;
|
|
|
|
const styles = customStyles ?? customStylesFromTags ?? null;
|
|
|
|
const resolution = parseResolutionFromHtml(doc) ?? parseResolutionFromCss(doc, allStyles);
|
|
|
|
// Parse stage zoom keyframes from zoom container
|
|
const stageZoomKeyframes = parseStageZoomKeyframes(doc);
|
|
|
|
return {
|
|
elements,
|
|
gsapScript,
|
|
styles,
|
|
resolution,
|
|
keyframes,
|
|
stageZoomKeyframes,
|
|
};
|
|
}
|
|
|
|
function parseStageZoomKeyframes(doc: Document): StageZoomKeyframe[] {
|
|
const zoomContainer = doc.getElementById("stage-zoom-container");
|
|
if (!zoomContainer) {
|
|
return [];
|
|
}
|
|
|
|
const zoomKeyframesAttr = zoomContainer.getAttribute("data-zoom-keyframes");
|
|
if (!zoomKeyframesAttr) {
|
|
return [];
|
|
}
|
|
|
|
try {
|
|
const parsed = JSON.parse(zoomKeyframesAttr);
|
|
if (Array.isArray(parsed)) {
|
|
return parsed.filter(
|
|
(kf): kf is StageZoomKeyframe =>
|
|
typeof kf === "object" &&
|
|
kf !== null &&
|
|
typeof kf.id === "string" &&
|
|
typeof kf.time === "number" &&
|
|
typeof kf.zoom === "object" &&
|
|
kf.zoom !== null &&
|
|
typeof kf.zoom.scale === "number" &&
|
|
typeof kf.zoom.focusX === "number" &&
|
|
typeof kf.zoom.focusY === "number",
|
|
);
|
|
}
|
|
} catch {
|
|
// skip invalid zoom keyframes
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
function normalizeKeyframes(
|
|
keyframes: Keyframe[],
|
|
baseX: number,
|
|
baseY: number,
|
|
baseScale: number,
|
|
): Keyframe[] {
|
|
const timeEpsilon = 0.001;
|
|
const valueEpsilon = 0.00001;
|
|
|
|
const hasBaseCheck = (value: number | undefined, base: number): boolean =>
|
|
value !== undefined && Math.abs(value - base) <= valueEpsilon && Math.abs(base) > valueEpsilon;
|
|
|
|
const timeZeroKeyframes = keyframes.filter((kf) => Math.abs(kf.time) <= timeEpsilon);
|
|
|
|
const treatAsAbsolute = timeZeroKeyframes.some((kf) => {
|
|
const props = kf.properties || {};
|
|
if (
|
|
hasBaseCheck(props.x, baseX) ||
|
|
hasBaseCheck(props.y, baseY) ||
|
|
(baseScale !== 1 && hasBaseCheck(props.scale, baseScale))
|
|
) {
|
|
return true;
|
|
}
|
|
return false;
|
|
});
|
|
|
|
return keyframes.map((kf) => {
|
|
const normalizedProps: Partial<KeyframeProperties> = {};
|
|
for (const [key, value] of Object.entries(kf.properties || {})) {
|
|
if (typeof value !== "number") continue;
|
|
if (treatAsAbsolute && key === "x") {
|
|
normalizedProps.x = value - baseX;
|
|
} else if (treatAsAbsolute && key === "y") {
|
|
normalizedProps.y = value - baseY;
|
|
} else if (treatAsAbsolute && key === "scale") {
|
|
normalizedProps.scale = baseScale !== 0 ? value / baseScale : value;
|
|
} else {
|
|
(normalizedProps as Record<string, number>)[key] = value;
|
|
}
|
|
}
|
|
|
|
return {
|
|
...kf,
|
|
time: Math.max(0, kf.time),
|
|
properties: normalizedProps,
|
|
};
|
|
});
|
|
}
|
|
|
|
export function updateElementInHtml(
|
|
html: string,
|
|
elementId: string,
|
|
updates: Partial<TimelineElement>,
|
|
): string {
|
|
const parser = new DOMParser();
|
|
const doc = parser.parseFromString(html, "text/html");
|
|
|
|
const el = doc.getElementById(elementId) || queryByAttr(doc, "data-name", elementId);
|
|
if (!el) return html;
|
|
|
|
if (updates.startTime !== undefined) {
|
|
el.setAttribute("data-start", String(updates.startTime));
|
|
if (el.hasAttribute("data-end") && updates.duration !== undefined) {
|
|
el.setAttribute("data-end", String(updates.startTime + updates.duration));
|
|
}
|
|
}
|
|
|
|
if (updates.duration !== undefined) {
|
|
const start = parseFloat(el.getAttribute("data-start") || "0");
|
|
el.setAttribute("data-end", String(start + updates.duration));
|
|
el.removeAttribute("data-duration"); // Clean up legacy
|
|
}
|
|
|
|
if (updates.name !== undefined) {
|
|
el.setAttribute("data-name", updates.name);
|
|
}
|
|
|
|
if (updates.zIndex !== undefined) {
|
|
el.setAttribute("data-layer", String(updates.zIndex));
|
|
}
|
|
|
|
// Handle media-specific property
|
|
if ("src" in updates && updates.src !== undefined) {
|
|
el.setAttribute("src", updates.src);
|
|
}
|
|
|
|
// Handle text-specific properties
|
|
if ("content" in updates && updates.content !== undefined) {
|
|
const textEl = el.firstElementChild;
|
|
if (textEl) {
|
|
textEl.textContent = updates.content;
|
|
}
|
|
}
|
|
|
|
if ("color" in updates && updates.color !== undefined) {
|
|
el.setAttribute("data-color", updates.color);
|
|
}
|
|
|
|
if ("fontSize" in updates && updates.fontSize !== undefined) {
|
|
el.setAttribute("data-font-size", String(updates.fontSize));
|
|
}
|
|
|
|
if ("textShadow" in updates) {
|
|
if (updates.textShadow === false) {
|
|
el.setAttribute("data-text-shadow", "false");
|
|
} else {
|
|
el.removeAttribute("data-text-shadow");
|
|
}
|
|
}
|
|
|
|
// Handle volume property for audio/video
|
|
if ("volume" in updates) {
|
|
if (updates.volume !== undefined && updates.volume !== 1) {
|
|
el.setAttribute("data-volume", String(updates.volume));
|
|
} else {
|
|
el.removeAttribute("data-volume");
|
|
}
|
|
}
|
|
|
|
// Handle hasAudio property for videos
|
|
if ("hasAudio" in updates) {
|
|
if (updates.hasAudio === true) {
|
|
el.setAttribute("data-has-audio", "true");
|
|
} else {
|
|
el.removeAttribute("data-has-audio");
|
|
}
|
|
}
|
|
|
|
if (!doc.documentElement) {
|
|
throw new CompositionHtmlParseError(
|
|
"updateElementInHtml: input HTML is empty or could not be parsed",
|
|
);
|
|
}
|
|
return "<!DOCTYPE html>\n" + doc.documentElement.outerHTML;
|
|
}
|
|
|
|
export function addElementToHtml(
|
|
html: string,
|
|
element: Omit<TimelineElement, "id"> & { id?: string },
|
|
): { html: string; id: string } {
|
|
const parser = new DOMParser();
|
|
const doc = parser.parseFromString(html, "text/html");
|
|
|
|
if (!doc.documentElement) {
|
|
throw new CompositionHtmlParseError(
|
|
"addElementToHtml: input HTML is empty or could not be parsed",
|
|
);
|
|
}
|
|
|
|
// Prefer zoom container, fall back to stage, then container, then body
|
|
const container =
|
|
doc.querySelector("#stage-zoom-container") ||
|
|
doc.querySelector(".container") ||
|
|
doc.querySelector("#stage") ||
|
|
doc.body;
|
|
|
|
if (!container) {
|
|
throw new CompositionHtmlParseError("addElementToHtml: input HTML has no <body>");
|
|
}
|
|
|
|
const id = element.id || `element-${Date.now()}`;
|
|
|
|
let newEl: Element;
|
|
|
|
function applyMediaAttrs(el: Element, mediaEl: TimelineMediaElement): void {
|
|
if (mediaEl.src) el.setAttribute("src", mediaEl.src);
|
|
if (mediaEl.volume !== undefined && mediaEl.volume !== 1) {
|
|
el.setAttribute("data-volume", String(mediaEl.volume));
|
|
}
|
|
}
|
|
|
|
switch (element.type) {
|
|
case "video": {
|
|
const mediaEl = element as TimelineMediaElement;
|
|
newEl = doc.createElement("video");
|
|
newEl.setAttribute("muted", "");
|
|
newEl.setAttribute("playsinline", "");
|
|
applyMediaAttrs(newEl, mediaEl);
|
|
if (mediaEl.hasAudio) {
|
|
newEl.setAttribute("data-has-audio", "true");
|
|
}
|
|
break;
|
|
}
|
|
case "image": {
|
|
const mediaEl = element as TimelineMediaElement;
|
|
newEl = doc.createElement("img");
|
|
if (mediaEl.src) newEl.setAttribute("src", mediaEl.src);
|
|
newEl.setAttribute("alt", element.name);
|
|
break;
|
|
}
|
|
case "audio": {
|
|
const mediaEl = element as TimelineMediaElement;
|
|
newEl = doc.createElement("audio");
|
|
applyMediaAttrs(newEl, mediaEl);
|
|
break;
|
|
}
|
|
case "text":
|
|
default: {
|
|
const textEl = element as TimelineTextElement;
|
|
newEl = doc.createElement("div");
|
|
const textContent = doc.createElement("div");
|
|
textContent.textContent = textEl.content || element.name;
|
|
newEl.appendChild(textContent);
|
|
if (textEl.color) {
|
|
newEl.setAttribute("data-color", textEl.color);
|
|
}
|
|
if (textEl.fontSize) {
|
|
newEl.setAttribute("data-font-size", String(textEl.fontSize));
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
newEl.id = id;
|
|
newEl.setAttribute("data-start", String(element.startTime));
|
|
newEl.setAttribute("data-end", String(element.startTime + element.duration));
|
|
newEl.setAttribute("data-layer", String(element.zIndex));
|
|
newEl.setAttribute("data-name", element.name);
|
|
|
|
container.appendChild(newEl);
|
|
|
|
return {
|
|
html: "<!DOCTYPE html>\n" + doc.documentElement.outerHTML,
|
|
id,
|
|
};
|
|
}
|
|
|
|
function selectorTargetsId(selector: string, id: string): boolean {
|
|
return (
|
|
selector === `#${id}` ||
|
|
selector === `[data-hf-id="${id}"]` ||
|
|
selector === `[data-hf-id='${id}']`
|
|
);
|
|
}
|
|
|
|
function stripGsapForId(script: string, elementId: string): string {
|
|
// Re-parse after every removal. Animation ids are count-based (positional), so
|
|
// removing one tween renumbers the survivors — ids captured from a single
|
|
// up-front parse go stale and silently no-op, orphaning later tweens on the
|
|
// now-deleted element. Always remove the FIRST still-matching animation in a
|
|
// freshly-parsed script until none remain.
|
|
let current = script;
|
|
for (;;) {
|
|
const parsed = parseGsapScriptAcornForWrite(current);
|
|
if (!parsed) return current;
|
|
const match = parsed.located.find((l) =>
|
|
selectorTargetsId(l.animation.targetSelector, elementId),
|
|
);
|
|
if (!match) return current;
|
|
const updated = removeAnimationFromScript(current, match.id);
|
|
// Guard against a non-removing match (would otherwise loop forever).
|
|
if (updated === current) return current;
|
|
current = updated;
|
|
}
|
|
}
|
|
|
|
function cascadeRemoveGsapById(doc: Document, elementId: string): void {
|
|
for (const script of Array.from(doc.querySelectorAll("script"))) {
|
|
const text = script.textContent ?? "";
|
|
if (!text.includes("gsap") && !text.includes("ScrollTrigger")) continue;
|
|
const updated = stripGsapForId(text, elementId);
|
|
if (updated !== text) script.textContent = updated;
|
|
}
|
|
}
|
|
|
|
export function removeElementFromHtml(html: string, elementId: string): string {
|
|
const parser = new DOMParser();
|
|
const doc = parser.parseFromString(html, "text/html");
|
|
if (!doc.documentElement) {
|
|
throw new CompositionHtmlParseError(
|
|
"removeElementFromHtml: input HTML is empty or could not be parsed",
|
|
);
|
|
}
|
|
doc.getElementById(elementId)?.remove();
|
|
cascadeRemoveGsapById(doc, elementId);
|
|
return "<!DOCTYPE html>\n" + doc.documentElement.outerHTML;
|
|
}
|
|
|
|
export interface CompositionMetadata {
|
|
compositionId: string | null;
|
|
compositionDuration: number | null;
|
|
variables: CompositionVariable[];
|
|
}
|
|
|
|
export function extractCompositionMetadata(html: string): CompositionMetadata {
|
|
const parser = new DOMParser();
|
|
const doc = parser.parseFromString(html, "text/html");
|
|
const htmlEl = doc.documentElement;
|
|
if (!htmlEl) {
|
|
throw new CompositionHtmlParseError(
|
|
"extractCompositionMetadata: input HTML is empty or could not be parsed",
|
|
);
|
|
}
|
|
|
|
const compositionId = htmlEl.getAttribute("data-composition-id");
|
|
const durationStr = htmlEl.getAttribute("data-composition-duration");
|
|
const compositionDuration = durationStr ? parseFloat(durationStr) : null;
|
|
|
|
const variables = parseCompositionVariables(htmlEl);
|
|
|
|
return {
|
|
compositionId,
|
|
compositionDuration:
|
|
compositionDuration && isFinite(compositionDuration) ? compositionDuration : null,
|
|
variables,
|
|
};
|
|
}
|
|
|
|
function parseCompositionVariables(htmlEl: Element): CompositionVariable[] {
|
|
const variablesAttr = htmlEl.getAttribute("data-composition-variables");
|
|
if (!variablesAttr) {
|
|
return [];
|
|
}
|
|
|
|
try {
|
|
const parsed = JSON.parse(variablesAttr);
|
|
if (!Array.isArray(parsed)) {
|
|
return [];
|
|
}
|
|
|
|
return parsed.filter((v): v is CompositionVariable => {
|
|
if (typeof v !== "object" || v === null) return false;
|
|
if (typeof v.id !== "string" || typeof v.label !== "string") return false;
|
|
if (!["string", "number", "color", "boolean", "enum", "font", "image"].includes(v.type))
|
|
return false;
|
|
|
|
switch (v.type) {
|
|
case "string":
|
|
return typeof v.default === "string";
|
|
case "number":
|
|
return typeof v.default === "number";
|
|
case "color":
|
|
return typeof v.default === "string";
|
|
case "boolean":
|
|
return typeof v.default === "boolean";
|
|
case "enum":
|
|
return typeof v.default === "string" && Array.isArray(v.options);
|
|
case "font":
|
|
// default is the font-family name string; extra metadata fields are optional
|
|
return typeof v.default === "string";
|
|
case "image":
|
|
// default is the fallback image URL string; extra metadata fields are optional
|
|
return typeof v.default === "string";
|
|
default:
|
|
return false;
|
|
}
|
|
});
|
|
} catch {
|
|
return [];
|
|
}
|
|
}
|
|
|
|
export function validateCompositionHtml(html: string): ValidationResult {
|
|
const errors: string[] = [];
|
|
const warnings: string[] = [];
|
|
|
|
const parser = new DOMParser();
|
|
const doc = parser.parseFromString(html, "text/html");
|
|
const htmlEl = doc.documentElement;
|
|
|
|
if (!htmlEl) {
|
|
return {
|
|
valid: false,
|
|
errors: ["Composition HTML is empty or could not be parsed"],
|
|
warnings: [],
|
|
};
|
|
}
|
|
|
|
const compositionId = htmlEl.getAttribute("data-composition-id");
|
|
if (!compositionId) {
|
|
errors.push("Missing data-composition-id attribute on <html> element");
|
|
}
|
|
|
|
const durationStr = htmlEl.getAttribute("data-composition-duration");
|
|
if (!durationStr) {
|
|
errors.push("Missing data-composition-duration attribute on <html> element");
|
|
} else {
|
|
const duration = parseFloat(durationStr);
|
|
if (!isFinite(duration) || duration <= 0) {
|
|
errors.push("data-composition-duration must be a positive finite number");
|
|
}
|
|
}
|
|
|
|
const stage = doc.getElementById("stage");
|
|
if (!stage) {
|
|
errors.push("Missing #stage element");
|
|
}
|
|
|
|
if (/\son\w+\s*=/i.test(html)) {
|
|
errors.push("Inline event handlers (onclick, onload, etc.) not allowed");
|
|
}
|
|
|
|
if (/javascript\s*:/i.test(html)) {
|
|
errors.push("javascript: URLs not allowed");
|
|
}
|
|
|
|
const scripts = doc.querySelectorAll("script");
|
|
if (scripts.length > 2) {
|
|
warnings.push("Multiple script tags detected - only GSAP CDN and main script expected");
|
|
}
|
|
|
|
const gsapScript = extractGsapScript(doc);
|
|
if (gsapScript) {
|
|
const gsapValidation = validateCompositionGsap(gsapScript);
|
|
errors.push(...gsapValidation.errors);
|
|
warnings.push(...gsapValidation.warnings);
|
|
}
|
|
|
|
return {
|
|
valid: errors.length === 0,
|
|
errors,
|
|
warnings,
|
|
};
|
|
}
|
|
|
|
function extractGsapScript(doc: Document): string | null {
|
|
const scripts = doc.querySelectorAll("script");
|
|
for (const script of scripts) {
|
|
const content = script.textContent || "";
|
|
if (
|
|
content.includes("gsap.timeline") ||
|
|
content.includes(".set(") ||
|
|
content.includes(".to(")
|
|
) {
|
|
return content;
|
|
}
|
|
}
|
|
return null;
|
|
}
|