mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 04:38:33 +00:00
## Summary Studio manual geometry edits now persist as a project-local manifest instead of being baked into composition source on each gesture. The manifest lives at: ```text .hyperframes/studio-manual-edits.json ``` It is the source of truth for manual drag, resize, rotation, inspector geometry edits, group moves, and selected-layer reset. ## Architecture - **Manifest-backed edits**: each edit stores a kind (`path-offset`, `box-size`, `rotation`), a source-scoped target, and the edit values. - **Source-scoped resolution**: targets include `sourceFile`, `id`, `selector`, and `selectorIndex`, so duplicate selectors in nested compositions resolve against the owning source file. - **Additive CSS layer**: move uses CSS `translate`, resize writes stable dimensions/flex sizing, and rotation uses CSS `rotate` over the authored base. - **Shared replay runtime**: Studio preview, thumbnails, frame capture, producer renders, and CLI Studio renders/thumbnails all use the same core manual-edit render script. - **Animation-safe replay**: Studio reapplies the manual layer after load, refresh, timeline seeks, player operations, playback frames, thumbnail seeks, and render seeks instead of rewriting GSAP timelines. - **History and handoff**: the manifest is a normal project file, so undo/redo and agent edits can preserve, modify, or remove manual visual edits explicitly. ## User Impact Users can move, resize, rotate, group-move, and reset supported layers from the canvas or inspector, then refresh, capture thumbnails/screenshots, play animated compositions, and render videos without manual edits drifting away from the edited state. ## Main Files - `packages/studio/src/components/editor/manualEdits.ts` - `packages/studio/src/components/editor/DomEditOverlay.tsx` - `packages/studio/src/components/editor/PropertyPanel.tsx` - `packages/studio/src/App.tsx` - `packages/core/src/studio-api/helpers/manualEditsRenderScript.ts` - `packages/studio/vite.config.ts` - `packages/cli/src/server/studioServer.ts` - `packages/core/src/compiler/htmlBundler.ts` - `packages/producer/src/services/htmlCompiler.ts` - `packages/core/src/studio-api/routes/thumbnail.ts` - `packages/producer/src/services/fileServer.ts` - `packages/producer/src/services/renderOrchestrator.ts` ## Test Plan ```bash volta run --node 22.20.0 bun run build volta run --node 22.20.0 bun run --filter @hyperframes/core test -- src/studio-api/helpers/manualEditsRenderScript.test.ts volta run --node 22.20.0 bun run --filter @hyperframes/core typecheck volta run --node 22.20.0 bun run --filter @hyperframes/studio typecheck volta run --node 22.20.0 bun run --filter @hyperframes/cli typecheck volta run --node 22.20.0 bunx oxlint <changed files> volta run --node 22.20.0 bunx oxfmt --check <changed files> git diff --check ```
383 lines
12 KiB
TypeScript
383 lines
12 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import { Window } from "happy-dom";
|
|
import { createStudioManualEditsRenderBodyScript } from "./manualEditsRenderScript";
|
|
|
|
function runScript(
|
|
window: Window,
|
|
script: string,
|
|
getComputedStyle: typeof window.getComputedStyle = window.getComputedStyle.bind(window),
|
|
timers: {
|
|
setInterval?: typeof globalThis.setInterval;
|
|
clearInterval?: typeof globalThis.clearInterval;
|
|
} = {},
|
|
): void {
|
|
const execute = new Function(
|
|
"window",
|
|
"document",
|
|
"HTMLElement",
|
|
"getComputedStyle",
|
|
"setInterval",
|
|
"clearInterval",
|
|
script,
|
|
);
|
|
execute(
|
|
window,
|
|
window.document,
|
|
window.HTMLElement,
|
|
getComputedStyle,
|
|
timers.setInterval ??
|
|
(((callback: TimerHandler) => {
|
|
void callback;
|
|
return 0 as never;
|
|
}) as typeof globalThis.setInterval),
|
|
timers.clearInterval ?? globalThis.clearInterval,
|
|
);
|
|
}
|
|
|
|
describe("createStudioManualEditsRenderBodyScript", () => {
|
|
it("returns null for an empty manifest", () => {
|
|
expect(createStudioManualEditsRenderBodyScript("")).toBeNull();
|
|
});
|
|
|
|
it("applies manual edits and reapplies them after render seeks", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = '<div id="card" style="width: 20px; height: 20px"></div>';
|
|
const card = window.document.getElementById("card");
|
|
if (!(card instanceof window.HTMLElement)) {
|
|
throw new Error("card fixture missing");
|
|
}
|
|
|
|
let seekCalls = 0;
|
|
(
|
|
window as unknown as {
|
|
__hf: { seek: (time: number) => void };
|
|
}
|
|
).__hf = {
|
|
seek: () => {
|
|
seekCalls += 1;
|
|
card.style.removeProperty("translate");
|
|
},
|
|
};
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "path-offset",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
x: 12,
|
|
y: 24,
|
|
},
|
|
{
|
|
kind: "box-size",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
width: 120,
|
|
height: 64,
|
|
},
|
|
{
|
|
kind: "rotation",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
angle: 15,
|
|
},
|
|
],
|
|
}),
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
const computedStyle = (element: Element) =>
|
|
({
|
|
display: element === card ? "block" : "block",
|
|
flexDirection: "row",
|
|
}) as CSSStyleDeclaration;
|
|
|
|
const intervalCallbacks: Array<() => void> = [];
|
|
runScript(window, script, computedStyle, {
|
|
setInterval: ((callback: TimerHandler) => {
|
|
if (typeof callback === "function") intervalCallbacks.push(callback as () => void);
|
|
return 0 as never;
|
|
}) as typeof globalThis.setInterval,
|
|
});
|
|
|
|
expect(card.style.getPropertyValue("translate")).toContain("--hf-studio-offset-x");
|
|
expect(card.style.getPropertyValue("width")).toBe("120px");
|
|
expect(card.style.getPropertyValue("height")).toBe("64px");
|
|
expect(card.style.getPropertyValue("rotate")).toContain("--hf-studio-rotation");
|
|
expect(card.style.getPropertyValue("transform-origin")).toBe("center center");
|
|
|
|
(
|
|
window as unknown as {
|
|
__hf: { seek: (time: number) => void };
|
|
}
|
|
).__hf.seek(1);
|
|
|
|
expect(seekCalls).toBe(1);
|
|
expect(card.style.getPropertyValue("translate")).toContain("--hf-studio-offset-x");
|
|
|
|
(
|
|
window as unknown as {
|
|
__hf: { seek: (time: number) => void };
|
|
}
|
|
).__hf.seek = () => {
|
|
card.style.removeProperty("rotate");
|
|
};
|
|
intervalCallbacks.forEach((callback) => callback());
|
|
(
|
|
window as unknown as {
|
|
__hf: { seek: (time: number) => void };
|
|
}
|
|
).__hf.seek(2);
|
|
expect(card.style.getPropertyValue("rotate")).toContain("--hf-studio-rotation");
|
|
|
|
(
|
|
window as unknown as {
|
|
__player: { renderSeek: (time: number) => void };
|
|
}
|
|
).__player = {
|
|
renderSeek: () => {
|
|
card.style.removeProperty("rotate");
|
|
},
|
|
};
|
|
intervalCallbacks.forEach((callback) => callback());
|
|
(
|
|
window as unknown as {
|
|
__player: { renderSeek: (time: number) => void };
|
|
}
|
|
).__player.renderSeek(3);
|
|
expect(card.style.getPropertyValue("rotate")).toContain("--hf-studio-rotation");
|
|
});
|
|
|
|
it("applies render edits to the matching source file target", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = `
|
|
<div data-composition-id="root">
|
|
<div id="card"></div>
|
|
<div data-composition-id="nested" data-composition-file="scenes/nested.html">
|
|
<div id="card"></div>
|
|
</div>
|
|
</div>
|
|
`;
|
|
const cards = Array.from(window.document.getElementsByTagName("*")).filter(
|
|
(element): element is HTMLElement =>
|
|
element instanceof window.HTMLElement && element.id === "card",
|
|
);
|
|
const rootCard = cards[0];
|
|
const nestedCard = cards[1];
|
|
if (!rootCard || !nestedCard) {
|
|
throw new Error("source-scoped render fixture missing");
|
|
}
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "rotation",
|
|
target: { sourceFile: "scenes/nested.html", id: "card" },
|
|
angle: 21,
|
|
},
|
|
],
|
|
}),
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
runScript(window, script);
|
|
|
|
expect(rootCard.style.getPropertyValue("rotate")).toBe("");
|
|
expect(nestedCard.style.getPropertyValue("rotate")).toContain("--hf-studio-rotation");
|
|
});
|
|
|
|
it("applies render edits inside composition-file hosts without composition ids", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = `
|
|
<div data-composition-id="root">
|
|
<div id="card"></div>
|
|
<div data-composition-file="scenes/anonymous.html">
|
|
<div id="card"></div>
|
|
</div>
|
|
</div>
|
|
`;
|
|
const cards = Array.from(window.document.getElementsByTagName("*")).filter(
|
|
(element): element is HTMLElement =>
|
|
element instanceof window.HTMLElement && element.id === "card",
|
|
);
|
|
const rootCard = cards[0];
|
|
const nestedCard = cards[1];
|
|
if (!rootCard || !nestedCard) {
|
|
throw new Error("anonymous composition render fixture missing");
|
|
}
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "path-offset",
|
|
target: { sourceFile: "scenes/anonymous.html", id: "card" },
|
|
x: 12,
|
|
y: 24,
|
|
},
|
|
],
|
|
}),
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
runScript(window, script);
|
|
|
|
expect(rootCard.style.getPropertyValue("translate")).toBe("");
|
|
expect(nestedCard.style.getPropertyValue("translate")).toContain("--hf-studio-offset-x");
|
|
});
|
|
|
|
it("uses the active composition path as the unscoped document fallback", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = `<div id="card"></div>`;
|
|
const card = window.document.getElementById("card");
|
|
if (!(card instanceof window.HTMLElement)) {
|
|
throw new Error("card fixture missing");
|
|
}
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "path-offset",
|
|
target: { sourceFile: "compositions/scene-2.html", id: "card" },
|
|
x: 12,
|
|
y: 24,
|
|
},
|
|
],
|
|
}),
|
|
{ activeCompositionPath: "compositions/scene-2.html" },
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
runScript(window, script);
|
|
|
|
expect(card.style.getPropertyValue("translate")).toContain("--hf-studio-offset-x");
|
|
});
|
|
|
|
it("preserves computed transform longhands as render edit bases", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = `<div id="card"></div>`;
|
|
const card = window.document.getElementById("card");
|
|
if (!(card instanceof window.HTMLElement)) {
|
|
throw new Error("card fixture missing");
|
|
}
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "path-offset",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
x: 12,
|
|
y: 24,
|
|
},
|
|
{
|
|
kind: "rotation",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
angle: 15,
|
|
},
|
|
],
|
|
}),
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
const computedStyle = (element: Element) =>
|
|
({
|
|
getPropertyValue: (property: string) => {
|
|
if (element !== card) return "";
|
|
if (property === "translate") return "10px 20px";
|
|
if (property === "rotate") return "8deg";
|
|
return "";
|
|
},
|
|
}) as CSSStyleDeclaration;
|
|
|
|
runScript(window, script, computedStyle);
|
|
|
|
expect(card.style.getPropertyValue("translate")).toContain("calc(10px +");
|
|
expect(card.style.getPropertyValue("translate")).toContain("calc(20px +");
|
|
expect(card.style.getPropertyValue("rotate")).toContain("8deg");
|
|
expect(card.style.getPropertyValue("rotate")).toContain("--hf-studio-rotation");
|
|
expect(card.style.getPropertyValue("transform-origin")).toBe("center center");
|
|
});
|
|
|
|
it("does not compound stale studio variables during render reapply", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = `
|
|
<div id="card" style="
|
|
translate: var(--hf-studio-offset-x, 0px) var(--hf-studio-offset-y, 0px);
|
|
rotate: var(--hf-studio-rotation, 0deg);
|
|
"></div>
|
|
`;
|
|
const card = window.document.getElementById("card");
|
|
if (!(card instanceof window.HTMLElement)) {
|
|
throw new Error("card fixture missing");
|
|
}
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "path-offset",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
x: 12,
|
|
y: 24,
|
|
},
|
|
{
|
|
kind: "rotation",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
angle: 15,
|
|
},
|
|
],
|
|
}),
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
runScript(window, script);
|
|
|
|
expect(card.style.getPropertyValue("translate")).toBe(
|
|
"var(--hf-studio-offset-x, 0px) var(--hf-studio-offset-y, 0px)",
|
|
);
|
|
expect(card.style.getPropertyValue("rotate")).toBe("var(--hf-studio-rotation, 0deg)");
|
|
});
|
|
|
|
it("exposes a render reapply hook for thumbnails after layout settles", () => {
|
|
const window = new Window();
|
|
window.document.body.innerHTML = `<div id="card"></div>`;
|
|
const card = window.document.getElementById("card");
|
|
if (!(card instanceof window.HTMLElement)) {
|
|
throw new Error("card fixture missing");
|
|
}
|
|
|
|
const script = createStudioManualEditsRenderBodyScript(
|
|
JSON.stringify({
|
|
version: 1,
|
|
edits: [
|
|
{
|
|
kind: "path-offset",
|
|
target: { sourceFile: "index.html", id: "card" },
|
|
x: 12,
|
|
y: 24,
|
|
},
|
|
],
|
|
}),
|
|
);
|
|
if (!script) throw new Error("script fixture missing");
|
|
|
|
runScript(window, script);
|
|
card.style.removeProperty("translate");
|
|
|
|
(
|
|
window as unknown as {
|
|
__hfStudioManualEditsApply?: () => number;
|
|
}
|
|
).__hfStudioManualEditsApply?.();
|
|
|
|
expect(card.style.getPropertyValue("translate")).toContain("--hf-studio-offset-x");
|
|
});
|
|
});
|