Skip to content

Write HTML. Render video. Built for agents.

6.3 KB
Raw Blame
// @vitest-environment node
import { describe, expect, it, afterEach, beforeEach } from "vitest";
import { mkdtempSync, readFileSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { runComponentImport } from "./component.js";
import { FigmaClientError, appendBinding, type FigmaClient } from "@hyperframes/core/figma";

let dir = "";
beforeEach(() => {
  dir = mkdtempSync(join(tmpdir(), "hf-figma-component-"));
});
afterEach(() => rmSync(dir, { recursive: true, force: true }));

const TREE = {
  id: "1:1",
  name: "Hero Card",
  type: "FRAME",
  absoluteBoundingBox: { x: 0, y: 0, width: 400, height: 300 },
  fills: [{ type: "SOLID", color: { r: 1, g: 1, b: 1, a: 1 } }],
  children: [
    {
      id: "1:2",
      name: "Badge",
      type: "RECTANGLE",
      absoluteBoundingBox: { x: 20, y: 20, width: 100, height: 40 },
      fills: [{ type: "SOLID", color: { r: 0, g: 0.4, b: 1, a: 1 } }],
      boundVariables: { fills: [{ type: "VARIABLE_ALIAS", id: "VariableID:1:1" }] },
    },
    {
      id: "1:3",
      name: "Mark",
      type: "VECTOR",
      absoluteBoundingBox: { x: 40, y: 100, width: 64, height: 64 },
    },
  ],
};

const SVG = new TextEncoder().encode("<svg/>");

function client(): FigmaClient {
  return {
    renderNode: () => Promise.resolve({ url: "https://cdn/x", ext: "svg" }),
    // Delegates to whatever renderNode is on the final object (via `this`), so
    // inline clients that spread `...client()` and override renderNode still
    // drive the batch path; rejections propagate (matching production).
    renderNodes(fileKey, nodeIds, opts) {
      return Promise.all(
        nodeIds.map((nodeId) =>
          this.renderNode({ fileKey, nodeId }, opts).then((r) => ({
            nodeId,
            url: r.url,
            ext: r.ext,
          })),
        ),
      );
    },
    imageFills: () => Promise.resolve(new Map()),
    variables: () => Promise.resolve({ variables: {}, variableCollections: {} }),
    styles: () => Promise.resolve([]),
    nodeTree: () => Promise.resolve(TREE),
    fileVersion: () => Promise.resolve({ version: "7", lastModified: "2026-07-01" }),
  };
}

async function importHero() {
  const out = await runComponentImport("FILE:1-1", {
    projectDir: dir,
    client: client(),
    download: () => Promise.resolve(SVG),
  });
  return { out, html: readFileSync(join(dir, out.htmlPath), "utf8") };
}

describe("runComponentImport", () => {
  it("writes component html with resolved var() when the binding index knows the id", async () => {
    appendBinding(dir, {
      kind: "binding",
      figmaId: "VariableID:1:1",
      sourceFileKey: "FILE",
      compositionVariableId: "figma:Blue/500",
      version: "7",
    });
    const { out, html } = await importHero();
    expect(html).toContain("var(--figma-blue-500, #0066FF)");
    expect(out.unresolved).toEqual([]);
  });

  it("bakes literals and reports unresolved bindings when the index is empty", async () => {
    const { out, html } = await importHero();
    expect(html).toContain("background-color: #0066FF");
    expect(html).not.toContain("var(");
    expect(out.unresolved).toHaveLength(1);
    expect(out.unresolved[0]?.figmaId).toBe("VariableID:1:1");
  });

  it("rasterizes vectors into frozen assets, fills img src, writes the registry item", async () => {
    const { out, html } = await importHero();
    expect(html).toContain('src="../../../.media/images/image_001.svg"');
    expect(out.rasterized).toHaveLength(1);
    const item = JSON.parse(
      readFileSync(
        join(dir, "compositions", "components", "hero-card", "registry-item.json"),
        "utf8",
      ),
    ) as { type: string; files: Array<{ type: string }> };
    expect(item.type).toBe("hyperframes:component");
    expect(item.files.some((f) => f.type === "hyperframes:snippet")).toBe(true);
    expect(out.name).toBe("hero-card");
  });

  it("skips nodes figma refuses to render instead of aborting the import", async () => {
    const failing: FigmaClient = {
      ...client(),
      renderNode: () =>
        Promise.reject(
          new FigmaClientError("RENDER_FAILED", "figma could not render node 1:3 as svg"),
        ),
    };
    const out = await runComponentImport("FILE:1-1", {
      projectDir: dir,
      client: failing,
      download: () => Promise.resolve(SVG),
    });
    const html = readFileSync(join(dir, out.htmlPath), "utf8");
    expect(html).toContain("data-figma-rasterize=");
    expect(html).not.toContain("src=");
    const registry = JSON.parse(
      readFileSync(join(dir, "compositions", "components", out.name, "registry-item.json"), "utf8"),
    );
    expect(registry.files).toHaveLength(1);
  });

  it("recovers a node via png when svg render fails", async () => {
    let calls = 0;
    const svgFailsPngWorks: FigmaClient = {
      ...client(),
      renderNode: (_ref, opts) => {
        calls++;
        if (opts.format === "svg")
          return Promise.reject(new FigmaClientError("RENDER_FAILED", "no svg for you"));
        return Promise.resolve({ url: "https://cdn/x.png", ext: "png" });
      },
    };
    const out = await runComponentImport("FILE:1-1", {
      projectDir: dir,
      client: svgFailsPngWorks,
      download: () => Promise.resolve(SVG),
    });
    expect(out.failedRasterize).toHaveLength(0);
    const html = readFileSync(join(dir, out.htmlPath), "utf8");
    expect(html).toContain('src="');
    expect(calls).toBeGreaterThanOrEqual(2);
  });

  it("propagates non-RENDER_FAILED errors instead of skipping", async () => {
    const rateLimited: FigmaClient = {
      ...client(),
      renderNode: () =>
        Promise.reject(new FigmaClientError("RATE_LIMITED", "figma rate limit hit (429)", 429)),
    };
    await expect(
      runComponentImport("FILE:1-1", {
        projectDir: dir,
        client: rateLimited,
        download: () => Promise.resolve(SVG),
      }),
    ).rejects.toThrow(/rate limit/);
  });

  it("honors a name override so variant frames don't slug-collide", async () => {
    const out = await runComponentImport("FILE:1-1", {
      projectDir: dir,
      client: client(),
      download: () => Promise.resolve(SVG),
      name: "Hero Actions",
    });
    expect(out.name).toBe("hero-actions");
    expect(out.htmlPath).toContain("hero-actions");
    const html = readFileSync(join(dir, out.htmlPath), "utf8");
    expect(html).toMatch(/^<div id="hero-actions"/);
  });
});