@recursica/adapter-tester 5.0.2 → 5.1.0

package/dist/testing.js

@@ -1,15 +1,15 @@
-import { expect as J } from "@playwright/test";
-import { existsSync as v, unlinkSync as Y, readFileSync as x, mkdirSync as b, writeFileSync as E, closeSync as Q, openSync as Z, renameSync as ee, rmSync as te } from "node:fs";
-import re from "pixelmatch";
+import { expect as D } from "@playwright/test";
+import { existsSync as y, unlinkSync as H, readFileSync as E, mkdirSync as b, writeFileSync as A, closeSync as Y, openSync as Q, renameSync as Z, rmSync as ee } from "node:fs";
+import te from "pixelmatch";
 import { PNG as P } from "pngjs";
-import { join as G } from "node:path";
-import { a as oe, i as ne } from "./index-DqQzFSAH.js";
-function R(e, t) {
+import { join as M } from "node:path";
+import { a as re, i as oe } from "./index-DqQzFSAH.js";
+function J(e, t) {
   const o = P.sync.read(e), r = P.sync.read(t);
   if (o.width !== r.width || o.height !== r.height)
     return { diffPixels: 1 / 0, diffImage: null };
   const s = new P({ width: o.width, height: o.height });
-  return { diffPixels: re(
+  return { diffPixels: te(
     o.data,
     r.data,
     s.data,
@@ -18,19 +18,19 @@ function R(e, t) {
     { threshold: 0.1 }
   ), diffImage: P.sync.write(s) };
 }
-const se = "http://json-schema.org/draft-07/schema#", ie = "https://github.com/borderux/recursica/tree/main/packages/adapter-tester/src/golden/manifest.schema.json", ae = "test/golden/manifest.json", ce = "Tracks golden (baseline) image metadata for @recursica/adapter-tester's golden-image visual regression checks. One manifest lives alongside its adapter's test/golden/<story-id>.png files, keyed by story id.", de = "object", he = { type: "object", additionalProperties: !1, required: ["createdAt"], properties: { createdAt: { type: "string", format: "date-time", description: "When this story's own golden PNG was last captured, via --update-golden, --approve-divergence, or first-run auto-create." }, sourceOfTruthCreatedAt: { type: "string", format: "date-time", description: "The source-of-truth adapter's (mantine) manifest `createdAt` for this story at the time this adapter's divergence from it was last reviewed via --approve-divergence. Omitted on the source-of-truth adapter's own manifest, and omitted here until the first approval. If mantine's current `createdAt` for this story is newer than this value, the divergence is flagged again for re-review." } } }, ue = {
-  $schema: se,
-  $id: ie,
-  title: ae,
-  description: ce,
-  type: de,
-  additionalProperties: he
-}, le = ne, V = new oe.Ajv({ allErrors: !0, strict: !0 });
-le(V);
-const U = V.compile(ue);
-function F(e, t) {
-  if (U(e)) return;
-  const o = (U.errors ?? []).map((r) => {
+const ne = "http://json-schema.org/draft-07/schema#", se = "https://github.com/borderux/recursica/tree/main/packages/adapter-tester/src/golden/manifest.schema.json", ie = "test/golden/manifest.json", ae = "Tracks golden (baseline) image metadata for @recursica/adapter-tester's golden-image visual regression checks. One manifest lives alongside its adapter's test/golden/<story-id>.png files, keyed by story id.", ce = "object", de = { type: "object", additionalProperties: !1, required: ["createdAt"], properties: { createdAt: { type: "string", format: "date-time", description: "When this story's own golden PNG was last captured, via --update-golden, --approve-divergence, or first-run auto-create." }, sourceOfTruthCreatedAt: { type: "string", format: "date-time", description: "The source-of-truth adapter's (mantine) manifest `createdAt` for this story at the time this adapter's divergence from it was last reviewed via --approve-divergence. Omitted on the source-of-truth adapter's own manifest, and omitted here until the first approval. If mantine's current `createdAt` for this story is newer than this value, the divergence is flagged again for re-review." } } }, he = {
+  $schema: ne,
+  $id: se,
+  title: ie,
+  description: ae,
+  type: ce,
+  additionalProperties: de
+}, ue = oe, K = new re.Ajv({ allErrors: !0, strict: !0 });
+ue(K);
+const R = K.compile(he);
+function B(e, t) {
+  if (R(e)) return;
+  const o = (R.errors ?? []).map((r) => {
     var i;
     const s = (i = r.params) != null && i.additionalProperty ? ` '${r.params.additionalProperty}'` : "";
     return `  - ${r.instancePath || "root"} ${r.message}${s}`;
@@ -39,42 +39,42 @@ function F(e, t) {
   throw new Error(`Invalid ${t}:
 ${o}`);
 }
-function A(e) {
-  return G(e, "manifest.json");
+function G(e) {
+  return M(e, "manifest.json");
 }
-function W(e) {
-  return G(e, "manifest.json.lock");
+function V(e) {
+  return M(e, "manifest.json.lock");
 }
 function S(e, t) {
-  return G(e, `${t}.png`);
+  return M(e, `${t}.png`);
 }
 function j(e) {
-  const t = A(e);
-  if (!v(t)) return {};
-  const o = JSON.parse(x(t, "utf8"));
-  return F(o, t), o;
+  const t = G(e);
+  if (!y(t)) return {};
+  const o = JSON.parse(E(t, "utf8"));
+  return B(o, t), o;
 }
-function fe(e, t) {
-  const o = A(e);
-  F(t, o);
+function le(e, t) {
+  const o = G(e);
+  B(t, o);
   const r = {};
   for (const i of Object.keys(t).sort())
     r[i] = t[i];
   b(e, { recursive: !0 });
   const s = `${o}.tmp-${process.pid}-${Math.random().toString(36).slice(2)}`;
-  E(s, JSON.stringify(r, null, 2) + `
-`), ee(s, o);
+  A(s, JSON.stringify(r, null, 2) + `
+`), Z(s, o);
 }
-const pe = 25, ge = 15e3;
-function me(e) {
+const fe = 25, pe = 15e3;
+function ge(e) {
   return new Promise((t) => setTimeout(t, e));
 }
-async function we(e) {
+async function me(e) {
   b(e, { recursive: !0 });
-  const t = W(e), o = Date.now() + ge;
+  const t = V(e), o = Date.now() + pe;
   for (; ; )
     try {
-      Q(Z(t, "wx"));
+      Y(Q(t, "wx"));
       return;
     } catch (r) {
       if (r.code !== "EEXIST") throw r;
@@ -82,37 +82,37 @@ async function we(e) {
         throw new Error(
           `Timed out waiting for the manifest lock at "${t}" — delete it if a previous run crashed while holding it.`
         );
-      await me(pe);
+      await ge(fe);
     }
 }
-function ye(e) {
-  te(W(e), { force: !0 });
+function we(e) {
+  ee(V(e), { force: !0 });
 }
-async function X(e, t, o) {
-  await we(e);
+async function W(e, t, o) {
+  await me(e);
   try {
     const r = j(e), s = o(r[t]);
-    return s === void 0 ? delete r[t] : r[t] = s, fe(e, r), s;
+    return s === void 0 ? delete r[t] : r[t] = s, le(e, r), s;
   } finally {
-    ye(e);
+    we(e);
   }
 }
-function ve(e, t, o) {
-  b(e, { recursive: !0 }), E(S(e, t), o);
+function ye(e, t, o) {
+  b(e, { recursive: !0 }), A(S(e, t), o);
 }
-async function Te(e, t) {
+async function ve(e, t) {
   const o = j(e), r = Object.keys(o).filter(
     (s) => !t.has(s)
   );
   for (const s of r) {
     const i = S(e, s);
-    v(i) && Y(i), await X(e, s, () => {
+    y(i) && H(i), await W(e, s, () => {
     });
   }
   return r;
 }
-const $e = "borderux/recursica";
-async function Oe(e, t) {
+const Te = "borderux/recursica";
+async function $e(e, t) {
   var i, d;
   const o = await fetch(`https://registry.npmjs.org/${e}`);
   if (!o.ok)
@@ -126,23 +126,23 @@ async function Oe(e, t) {
     );
   return s;
 }
-function ke(e) {
+function Oe(e) {
   return `packages/${e.split("/").pop()}`;
 }
-async function xe(e) {
+async function ke(e) {
   if (e.type === "local")
-    return v(A(e.dir)) ? {
+    return y(G(e.dir)) ? {
       manifest: j(e.dir),
       async readImage(h) {
         const c = S(e.dir, h);
-        return v(c) ? x(c) : null;
+        return y(c) ? E(c) : null;
       }
     } : (console.warn(
       `No golden baseline found yet at ${e.dir} — source-of-truth divergence check skipped for this run.`
     ), null);
   let t;
   try {
-    t = await Oe(
+    t = await $e(
       e.packageName,
       e.versionSpec
     );
@@ -152,10 +152,10 @@ async function xe(e) {
       a
     ), null;
   }
-  const o = G(e.cacheDir, t), r = `${e.packageName}@${t}`, s = `https://raw.githubusercontent.com/${$e}/${r}/${ke(e.packageName)}/test/golden`;
+  const o = M(e.cacheDir, t), r = `${e.packageName}@${t}`, s = `https://raw.githubusercontent.com/${Te}/${r}/${Oe(e.packageName)}/test/golden`;
   let i;
-  const d = A(o);
-  if (v(d))
+  const d = G(o);
+  if (y(d))
     i = j(o);
   else {
     let a;
@@ -172,25 +172,25 @@ async function xe(e) {
         `No golden baseline published for ${r} — source-of-truth divergence check skipped for this run.`
       ), null;
     const h = await a.text(), c = JSON.parse(h);
-    F(c, `${s}/manifest.json`), b(o, { recursive: !0 }), E(d, h), i = c;
+    B(c, `${s}/manifest.json`), b(o, { recursive: !0 }), A(d, h), i = c;
   }
   return {
     manifest: i,
     async readImage(a) {
       const h = S(o, a);
-      if (v(h)) return x(h);
+      if (y(h)) return E(h);
       const c = await fetch(`${s}/${a}.png`);
       if (!c.ok) return null;
       const f = Buffer.from(await c.arrayBuffer());
-      return b(o, { recursive: !0 }), E(h, f), f;
+      return b(o, { recursive: !0 }), A(h, f), f;
     }
   };
 }
-const be = ["Theme", "Tokens", "Introduction"];
-function B(e, t) {
+const xe = ["Theme", "Tokens", "Introduction"];
+function N(e, t) {
   return e === t || e.startsWith(t);
 }
-async function Se(e, t) {
+async function be(e, t) {
   let o;
   try {
     const r = await fetch(`${e.url}/index.json`);
@@ -215,141 +215,141 @@ async function Se(e, t) {
   }
   return o;
 }
-function K(e, t, o) {
+function U(e, t, o) {
   let r;
   for (const s of Object.keys(t))
-    B(e, s) && (!r || s.length > r.length) && (r = s);
+    N(e, s) && (!r || s.length > r.length) && (r = s);
   return r !== void 0 ? t[r] : o;
 }
-async function Ie(e) {
+async function Me(e) {
   const t = e.isSourceOfTruthAdapter ? e.targets[0] : e.targets.find((n) => !n.sourceOfTruth);
   if (!t)
     throw new Error(
       "adapter-tester config has no non-sourceOfTruth target to run the golden check against."
     );
-  const o = e.excludeTitlePrefixes ?? be, r = e.stories ?? {}, s = Object.keys(r).filter(
+  const o = e.excludeTitlePrefixes ?? xe, r = e.stories ?? {}, s = Object.keys(r).filter(
     (n) => r[n].exclude
   ), i = Object.fromEntries(
     Object.entries(r).filter(([, n]) => n.goldenThreshold !== void 0).map(([n, u]) => [n, u.goldenThreshold])
   ), d = Object.fromEntries(
     Object.entries(r).filter(([, n]) => n.sourceOfTruthThreshold !== void 0).map(([n, u]) => [n, u.sourceOfTruthThreshold])
-  ), a = e.goldenDir, h = e.goldenMode, c = e.checkMode, f = await Se(t, o), M = f.filter(
-    (n) => !s.some((u) => B(n.id, u))
+  ), a = e.goldenDir, h = e.goldenMode, c = e.checkMode, f = await be(t, o), I = f.filter(
+    (n) => !s.some((u) => N(n.id, u))
   );
   if (h === "update-golden") {
-    const n = await Te(
+    const n = await ve(
       a,
-      new Set(M.map((u) => u.id))
+      new Set(I.map((u) => u.id))
     );
     n.length > 0 && console.warn(
       `Pruned ${n.length} orphaned golden(s) no longer in Storybook: ${n.join(", ")}`
     );
   }
-  const p = c !== "divergence" || e.isSourceOfTruthAdapter || !e.sourceOfTruthGolden ? null : await xe(e.sourceOfTruthGolden), q = new Set(f.map((n) => n.id)), T = p ? Object.keys(p.manifest).filter(
-    (n) => !q.has(n) && !s.some((u) => B(n, u))
+  const p = c !== "divergence" || e.isSourceOfTruthAdapter || !e.sourceOfTruthGolden ? null : await ke(e.sourceOfTruthGolden), X = new Set(f.map((n) => n.id)), v = p ? Object.keys(p.manifest).filter(
+    (n) => !X.has(n) && !s.some((u) => N(n, u))
   ).sort() : [];
-  T.length > 0 && console.error(
-    `[adapter-tester] ${T.length} stor(y/ies) exist in the source of truth but are missing here: ${T.join(", ")}. Add the missing story, or mark it \`exclude: true\` under \`stories\` in adapter-tester.config.json if intentional.`
+  v.length > 0 && console.error(
+    `[adapter-tester] ${v.length} stor(y/ies) exist in the source of truth but are missing here: ${v.join(", ")}. Add the missing story, or mark it \`exclude: true\` under \`stories\` in adapter-tester.config.json if intentional.`
   ), console.log(
     [
       `[adapter-tester] target: "${t.name}" (${t.url})`,
-      `[adapter-tester] checkMode: "${c}" (${c === "divergence" ? "this project's golden vs source-of-truth's golden" : "live render vs this project's own golden"})`,
+      `[adapter-tester] checkMode: "${c}" (${c === "divergence" ? "live render vs source-of-truth's golden" : "live render vs this project's own golden"})`,
       `[adapter-tester] goldenMode: "${h}"`,
       `[adapter-tester] goldenThresholdPixels: ${e.goldenThresholdPixels}`,
       `[adapter-tester] sourceOfTruthThresholdPixels: ${e.sourceOfTruthThresholdPixels}`,
       c === "divergence" ? e.isSourceOfTruthAdapter ? "[adapter-tester] sourceOfTruthGolden: skipped — this is the source-of-truth adapter, nothing to diverge from" : e.sourceOfTruthGolden ? p ? `[adapter-tester] sourceOfTruthGolden: resolved, ${Object.keys(p.manifest).length} golden(s) available (config: ${JSON.stringify(e.sourceOfTruthGolden)})` : `[adapter-tester] sourceOfTruthGolden: unavailable — no baseline found or unreachable (config: ${JSON.stringify(e.sourceOfTruthGolden)}); divergence check will skip every story` : "[adapter-tester] sourceOfTruthGolden: skipped — no sourceOfTruthGolden configured" : '[adapter-tester] sourceOfTruthGolden: not used in "own" checkMode',
-      `[adapter-tester] stories: ${M.length} to check (excluded: ${s.length}, title prefixes excluded: ${o.join(", ") || "none"})`,
-      `[adapter-tester] story parity with source of truth: ${T.length === 0 ? "OK" : `${T.length} missing (see error above)`}`
+      `[adapter-tester] stories: ${I.length} to check (excluded: ${s.length}, title prefixes excluded: ${o.join(", ") || "none"})`,
+      `[adapter-tester] story parity with source of truth: ${v.length === 0 ? "OK" : `${v.length} missing (see error above)`}`
     ].join(`
 `)
   );
-  const z = c === "divergence" ? "Source-of-Truth Divergence Check" : "Own-Drift Golden Image Check";
+  const q = c === "divergence" ? "Source-of-Truth Divergence Check" : "Own-Drift Golden Image Check";
   return {
     ownTargetName: t.name,
-    suiteLabel: z,
-    stories: M,
-    missingFromSourceOfTruth: T,
+    suiteLabel: q,
+    stories: I,
+    missingFromSourceOfTruth: v,
     checkStory: async (n, u, l) => {
-      const $ = await u.newPage();
-      await $.setViewportSize({ width: 800, height: 600 }), await $.goto(
+      const T = await u.newPage();
+      await T.setViewportSize({ width: 800, height: 600 }), await T.goto(
         `${t.url}/iframe.html?id=${n.id}&viewMode=story`,
         { waitUntil: "networkidle" }
-      ), await $.waitForSelector("#storybook-root"), await $.addStyleTag({
+      ), await T.waitForSelector("#storybook-root"), await T.addStyleTag({
         content: "* { -webkit-font-smoothing: antialiased !important; -moz-osx-font-smoothing: grayscale !important; }"
-      }), await $.waitForTimeout(300);
-      const I = await $.screenshot(), C = S(a, n.id), g = j(a)[n.id], H = h !== "check" || !g || !v(C);
-      let O;
-      if (H)
-        ve(a, n.id, I), O = g != null && g.sourceOfTruthCreatedAt ? {
+      }), await T.waitForTimeout(300);
+      const x = await T.screenshot(), F = S(a, n.id), g = j(a)[n.id], z = h !== "check" || !g || !y(F);
+      let $;
+      if (z)
+        ye(a, n.id, x), $ = g != null && g.sourceOfTruthCreatedAt ? {
           createdAt: (/* @__PURE__ */ new Date()).toISOString(),
           sourceOfTruthCreatedAt: g.sourceOfTruthCreatedAt
         } : { createdAt: (/* @__PURE__ */ new Date()).toISOString() }, g || l.annotations.push({
           type: "golden-created",
           description: `No golden existed yet for "${n.id}" — captured one from this run.`
         });
-      else if (O = g, c === "own") {
-        const m = x(C), { diffPixels: w, diffImage: k } = R(
-          I,
+      else if ($ = g, c === "own") {
+        const m = E(F), { diffPixels: w, diffImage: O } = J(
+          x,
           m
-        ), y = K(
+        ), k = U(
           n.id,
           i,
           e.goldenThresholdPixels
         );
-        w >= y && (await l.attach("expected", {
+        w >= k && (await l.attach("expected", {
           body: m,
           contentType: "image/png"
         }), await l.attach("actual", {
-          body: I,
+          body: x,
           contentType: "image/png"
-        }), k && await l.attach("diff", {
-          body: k,
+        }), O && await l.attach("diff", {
+          body: O,
           contentType: "image/png"
-        })), J.soft(
+        })), D.soft(
           w,
-          `"${n.id}" has drifted from its own golden image (${w} mismatched pixels, threshold ${y})`
-        ).toBeLessThan(y);
+          `"${n.id}" has drifted from its own golden image (${w} mismatched pixels, threshold ${k})`
+        ).toBeLessThan(k);
       }
       if (p) {
         const m = p.manifest[n.id], w = m ? await p.readImage(n.id) : null;
         if (m && w)
           if (h === "approve-divergence")
-            O = {
-              ...O,
+            $ = {
+              ...$,
               sourceOfTruthCreatedAt: m.createdAt
             };
           else {
-            const k = x(C), { diffPixels: y, diffImage: L } = R(
-              k,
+            const { diffPixels: O, diffImage: k } = J(
+              x,
               w
-            ), N = K(
+            ), C = U(
               n.id,
               d,
               e.sourceOfTruthThresholdPixels
-            ), _ = O.sourceOfTruthCreatedAt, D = y < N || _ !== void 0 && _ >= m.createdAt;
-            D || (await l.attach("expected", {
+            ), L = $.sourceOfTruthCreatedAt, _ = O < C || L !== void 0 && L >= m.createdAt;
+            _ || (await l.attach("expected", {
               body: w,
               contentType: "image/png"
             }), await l.attach("actual", {
-              body: k,
+              body: x,
               contentType: "image/png"
-            }), L && await l.attach("diff", {
-              body: L,
+            }), k && await l.attach("diff", {
+              body: k,
               contentType: "image/png"
             }), l.annotations.push({
               type: "source-of-truth-divergence",
-              description: `"${n.id}" differs from the source of truth's golden by ${y} mismatched pixels (threshold ${N}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
-            })), J.soft(
-              D,
-              `"${n.id}" differs from the source of truth's golden by ${y} mismatched pixels (threshold ${N}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
+              description: `"${n.id}" differs from the source of truth's golden by ${O} mismatched pixels (threshold ${C}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
+            })), D.soft(
+              _,
+              `"${n.id}" differs from the source of truth's golden by ${O} mismatched pixels (threshold ${C}) and hasn't been reviewed — run with --approve-divergence if this is intentional, or fix the adapter styling.`
             ).toBe(!0);
           }
       }
-      await X(a, n.id, () => O);
+      await W(a, n.id, () => $);
     }
   };
 }
 export {
-  Ie as resolveVisualRegressionPlan
+  Me as resolveVisualRegressionPlan
 };
 //# sourceMappingURL=testing.js.map