mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-08-31 02:41:44 +00:00
Miguel Ángel
406bf316a3
* fix(catalog): make component previews answer their variables panel Every control on a component's catalog page did nothing. Asking caption-camera-follow for a violet accent rendered gold, and so did green and blue, on 166 of the 168 components that declare variables. A component ships a snippet, which is what the page hands you to paste and which carries the declaration plus the script that turns a chosen value into a CSS custom property, and a demo.html which stages and animates it. The preview is built from the demo, and the demo was authored as a copy of the snippet rather than a reference to it. The copies drifted until almost none of them carried the declaration or the reader, so the payload for that page never contained the word violet at all. Components come in two shapes, so the repair does too. 123 ship a snippet that registers its own paused timeline. That snippet is a whole piece, so their preview is now built from it and carries markup, variables and motion together. 45 are markup plus a commented recipe, where the demo owns the motion. Those demos now carry the snippet's declaration, reader and var-driven CSS in the registry itself, written by scripts/catalog/sync-demo-variables.ts. Nothing is patched in at build time. A test runs that tool in dry mode and fails when a demo has drifted again, naming the command that repairs it. It also asserts it inspected more than a hundred components, because a check that silently matches nothing is how this rotted in the first place. Measured by rendering every payload in a real player rather than by reading markup: payloads declaring their variables go from 2 of 168 to 168 of 168, previews that animate go from 166 to 167, and nothing that moved stopped moving. ascii-render-pass and star-rating-fill render a still frame when built from their snippet, so they keep the demo path as a recorded exception and stay in the state they were already in. * refactor(catalog): give the preview pipeline one lookup and one entrypoint guard Follow-up on the same branch, no behaviour change: 42 tests still pass and `sync-demo-variables --check` still reports all 168 components clean. The payload generator and the demo sync had each grown their own copy of "given a component directory, find the snippet and the demo". Both now call `componentFiles`, which is the same duplication-by-copying that broke the previews in the first place. Both catalog generators also carried a byte-identical 12-line guard for "only run main() when this file is the entrypoint". That clone was already in the tree, but nothing had touched both files at once before, so it had never surfaced. It is now `runAsCommand`, and the sync script's variant of the same condition is `isEntrypoint`. The rest is flattening: the layering guards read as a table of conditions instead of a chain, the reporting splits by what it reports, and the entry resolution comes out of `buildPayload` rather than being spliced into it. Also runs the formatter over the demos this branch rewrote. Whitespace only, and `notes-typing` is the only component demo that renders pre-formatted text, which this does not touch.
129 lines
5.2 KiB
TypeScript
129 lines
5.2 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
|
|
import { layerVariablesOntoDemo, snippetOwnsItsMotion } from "./component-variables.ts";
|
|
|
|
const DECLARATION = `[{ "id": "size", "type": "number", "label": "Size", "default": 52 }]`;
|
|
|
|
const snippet = `
|
|
<div data-hf-ui-root class="hf-ui-demo" data-composition-variables='${DECLARATION}'>
|
|
<span>word</span>
|
|
</div>
|
|
<style>.hf-ui-demo { font-size: var(--hf-demo-size, 52px); }</style>
|
|
<script>
|
|
var vars = window.__hyperframes ? window.__hyperframes.getVariables() : {};
|
|
document.querySelector("[data-hf-ui-root]").style.setProperty("--hf-demo-size", (vars.size || 52) + "px");
|
|
</script>
|
|
`;
|
|
|
|
const demo = `<!doctype html>
|
|
<html><head><style>.hf-ui-demo { font-size: 52px; }</style></head>
|
|
<body>
|
|
<main data-composition-id="demo">
|
|
<div data-hf-ui-root class="hf-ui-demo"><span>word</span></div>
|
|
</main>
|
|
<script>window.__timelines = { demo: gsap.timeline({ paused: true }) };</script>
|
|
</body></html>`;
|
|
|
|
describe("layerVariablesOntoDemo", () => {
|
|
it("gives the demo the declaration, the reader and the var-driven CSS", () => {
|
|
const result = layerVariablesOntoDemo(demo, snippet);
|
|
expect(result.applied).toBe(true);
|
|
expect(result.html).toContain("data-composition-variables=");
|
|
expect(result.html).toContain("getVariables");
|
|
expect(result.html).toContain("var(--hf-demo-size");
|
|
});
|
|
|
|
it("keeps the demo's own markup and timeline, which is what animates it", () => {
|
|
const { html } = layerVariablesOntoDemo(demo, snippet);
|
|
expect(html).toContain('data-composition-id="demo"');
|
|
expect(html).toContain("__timelines");
|
|
expect(html).toContain("<span>word</span>");
|
|
});
|
|
|
|
it("appends the snippet's CSS after the demo's, so var() wins on order", () => {
|
|
const { html } = layerVariablesOntoDemo(demo, snippet);
|
|
// The demo hardcodes the same property the snippet parameterises. Whichever
|
|
// rule comes last is the one that renders, so the appended one has to.
|
|
expect(html.indexOf("var(--hf-demo-size")).toBeGreaterThan(html.indexOf("font-size: 52px"));
|
|
});
|
|
|
|
it("declines when the snippet declares nothing, rather than half-applying", () => {
|
|
const result = layerVariablesOntoDemo(demo, "<div data-hf-ui-root></div>");
|
|
expect(result.applied).toBe(false);
|
|
expect(result).toHaveProperty("reason", "snippet declares no variables");
|
|
expect(result.html).toBe(demo);
|
|
});
|
|
|
|
it("declines when the demo has no component root to attach to", () => {
|
|
const result = layerVariablesOntoDemo("<html><body>nothing</body></html>", snippet);
|
|
expect(result.applied).toBe(false);
|
|
expect(result).toHaveProperty("reason", "demo has nowhere to hang the declaration");
|
|
});
|
|
|
|
it("leaves a demo that already declares its variables alone", () => {
|
|
const already = demo.replace(
|
|
'<div data-hf-ui-root class="hf-ui-demo">',
|
|
`<div data-hf-ui-root class="hf-ui-demo" data-composition-variables='${DECLARATION}'>`,
|
|
);
|
|
const result = layerVariablesOntoDemo(already, snippet);
|
|
expect(result.applied).toBe(false);
|
|
expect(result).toHaveProperty("reason", "demo already declares its variables");
|
|
});
|
|
|
|
it("does not copy a src script, which would re-run a shared library", () => {
|
|
const withSrc = snippet.replace(
|
|
"<style>",
|
|
'<script src="https://cdn.example.com/gsap.min.js"></script>\n<style>',
|
|
);
|
|
const { html } = layerVariablesOntoDemo(demo, withSrc);
|
|
expect(html).not.toContain("cdn.example.com");
|
|
});
|
|
|
|
it("handles a self-closing root without eating its bracket", () => {
|
|
const selfClosing = demo.replace(
|
|
'<div data-hf-ui-root class="hf-ui-demo"><span>word</span></div>',
|
|
'<img data-hf-ui-root class="hf-ui-demo" src="a.png" />',
|
|
);
|
|
const { html } = layerVariablesOntoDemo(selfClosing, snippet);
|
|
expect(html).toContain("data-composition-variables=");
|
|
expect(html).toContain("/>");
|
|
expect(html).not.toContain("/>>");
|
|
});
|
|
});
|
|
|
|
describe("snippetOwnsItsMotion", () => {
|
|
it("recognises a snippet that registers its own paused timeline", () => {
|
|
const selfContained = `
|
|
<div class="x" data-composition-variables='[]'></div>
|
|
<script>
|
|
var tl = gsap.timeline({ paused: true });
|
|
window.__timelines = window.__timelines || {};
|
|
window.__timelines["x"] = tl;
|
|
</script>`;
|
|
expect(snippetOwnsItsMotion(selfContained)).toBe(true);
|
|
});
|
|
|
|
it("does not count a timeline that is only shown as a recipe", () => {
|
|
// Every recipe-only snippet carries its integration note as a comment, so
|
|
// matching on the text alone would call all 168 self-contained and build
|
|
// the 45 recipe-only ones from a snippet that never animates.
|
|
const recipeOnly = `
|
|
<!--
|
|
Timeline integration:
|
|
window.__timelines["x"] = gsap.timeline({ paused: true });
|
|
-->
|
|
<div class="x" data-composition-variables='[]'></div>
|
|
<script>var vars = window.__hyperframes.getVariables();</script>`;
|
|
expect(snippetOwnsItsMotion(recipeOnly)).toBe(false);
|
|
});
|
|
|
|
it("ignores a block comment recipe too", () => {
|
|
const recipeOnly = `
|
|
<script>
|
|
/* window.__timelines["x"] = gsap.timeline({ paused: true }); */
|
|
var vars = window.__hyperframes.getVariables();
|
|
</script>`;
|
|
expect(snippetOwnsItsMotion(recipeOnly)).toBe(false);
|
|
});
|
|
});
|