@juangadm/pre-post 0.3.0 → 1.1.0

package/dist/deployments.js

@@ -0,0 +1,204 @@
+/**
+ * Deployment URLs from the GitHub Deployments API.
+ *
+ * Vercel, Cloudflare Pages, Netlify and Render all report their deploys to
+ * GitHub against a commit, so one lookup covers every provider: no per-host
+ * API tokens, and nothing to configure per repo.
+ */
+import { normalizeUrl } from './url.js';
+/**
+ * Bots whose PR comments may be read for a preview URL. A comment is only
+ * trusted when GitHub reports its author as one of these apps: anyone can post
+ * a comment that looks like Vercel's, and following it would point a capture at
+ * a URL a stranger chose.
+ */
+const TRUSTED_BOTS = new Set(['vercel[bot]', 'netlify[bot]']);
+/** Commit-status contexts these same providers post under. */
+const PROVIDER_STATUS = /vercel|netlify|cloudflare|render/i;
+const PRODUCTION = /^prod/i;
+/** How many deployments to inspect per page; each costs one status request. */
+const MAX_DEPLOYMENTS = 5;
+/** Deployments per page when scanning for production. */
+const SCAN_PAGE_SIZE = 100;
+/** How far back to scan. A repo can bury production under a wall of previews. */
+const SCAN_PAGES = 3;
+/**
+ * The newest successful deployment URL matching a query.
+ *
+ * Shared by the two questions callers ask — "what was deployed for this
+ * commit?" and "what is deployed to production right now?" — so both apply the
+ * same production/preview split and the same "success with a URL" rule.
+ */
+async function listDeployments(gh, ownerRepo, query) {
+    try {
+        const deployments = await gh.request('GET', `/repos/${ownerRepo}/deployments?${query}`);
+        return Array.isArray(deployments) ? deployments : null;
+    }
+    catch {
+        return null;
+    }
+}
+/** The first of these deployments that reported success with a live URL. */
+async function firstReady(gh, ownerRepo, candidates) {
+    const ready = await Promise.all(candidates.map(async (deployment) => {
+        try {
+            const statuses = await gh.request('GET', `/repos/${ownerRepo}/deployments/${deployment.id}/statuses?per_page=20`);
+            if (!Array.isArray(statuses))
+                return null;
+            const ok = statuses.find((s) => s.state === 'success' && !!s.environment_url);
+            return ok ? { url: ok.environment_url, environment: deployment.environment, sha: deployment.sha } : null;
+        }
+        catch {
+            return null;
+        }
+    }));
+    // Candidates stay in newest-first order, so the first hit is the newest.
+    return ready.find(Boolean) ?? null;
+}
+/** One page of deployments, narrowed to production or preview. */
+async function newestSuccessful(gh, ownerRepo, query, production) {
+    const deployments = await listDeployments(gh, ownerRepo, query);
+    if (!deployments)
+        return null;
+    return firstReady(gh, ownerRepo, matching(deployments, production));
+}
+/** Production or preview, newest first, capped at what is worth a status call. */
+function matching(deployments, production) {
+    return deployments.filter(d => PRODUCTION.test(d.environment || '') === production).slice(0, MAX_DEPLOYMENTS);
+}
+/**
+ * The newest successful deployment URL for a commit.
+ *
+ * `production: true` accepts only production environments (the baseline for
+ * "Pre"); `false` accepts only the others, which is where every provider puts
+ * per-PR previews. Neither falls back to the other kind — a preview standing in
+ * for production would silently compare against the wrong thing.
+ *
+ * Returns null whenever the answer is not unambiguous, so callers fall through
+ * to their next option. Never throws: a repo with no deployments, or a token
+ * without `deployments: read`, is a normal outcome, not a failure.
+ */
+export async function deploymentUrlForSha(gh, ownerRepo, sha, opts) {
+    return newestSuccessful(gh, ownerRepo, `sha=${encodeURIComponent(sha)}&per_page=20`, opts.production);
+}
+/**
+ * What is deployed to production right now, whatever commit it was built from.
+ *
+ * `deploymentUrlForSha` pins Pre to the commit the branch forked from, which is
+ * the most honest baseline there is — but it only exists if production happened
+ * to be deployed at exactly that commit. Production is a moving branch, so on
+ * most repositories it was not, and pinning alone leaves the deployed
+ * comparison with no Pre at all.
+ *
+ * This asks the same question without the pin. It reports the commit it found,
+ * so the caller can name what Pre actually is rather than implying the base.
+ */
+export async function latestProductionDeployment(gh, ownerRepo) {
+    // Deployments come back newest first, previews and production interleaved.
+    // A busy repository can push its live production deployment well past the
+    // first page, so scan a few pages rather than reading one and giving up —
+    // but stop the moment a page comes back short, which is the end of the list.
+    for (let page = 1; page <= SCAN_PAGES; page++) {
+        const deployments = await listDeployments(gh, ownerRepo, `per_page=${SCAN_PAGE_SIZE}&page=${page}`);
+        if (!deployments)
+            return null;
+        const found = await firstReady(gh, ownerRepo, matching(deployments, true));
+        if (found)
+            return { ...found, url: normalizeUrl(found.url) };
+        if (deployments.length < SCAN_PAGE_SIZE)
+            return null;
+    }
+    return null;
+}
+/** Has a deployment provider reported success against this exact commit? */
+async function providerSucceededFor(gh, ownerRepo, sha) {
+    try {
+        const combined = await gh.request('GET', `/repos/${ownerRepo}/commits/${sha}/status`);
+        return (combined.statuses ?? []).some(s => s.state === 'success' && PROVIDER_STATUS.test(s.context));
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * The preview for a commit, from whichever mechanism the provider uses.
+ *
+ * The freshness rule lives here rather than in the caller: a bot comment is
+ * edited in place and carries no SHA, so mid-deploy it still advertises the
+ * previous commit's preview. Screenshotting that and labelling it as this
+ * branch is the worst failure this tool has, because it looks exactly like a
+ * correct result. Every caller gets that guarantee by construction.
+ */
+export async function findPreviewForCommit(gh, ownerRepo, opts) {
+    const recorded = await deploymentUrlForSha(gh, ownerRepo, opts.sha, { production: false });
+    if (recorded)
+        return { ...recorded, url: normalizeUrl(recorded.url) };
+    if (opts.prNumber === undefined)
+        return null;
+    const [fresh, commented] = await Promise.all([
+        providerSucceededFor(gh, ownerRepo, opts.sha),
+        previewUrlFromComments(gh, ownerRepo, opts.prNumber, { appPrefix: opts.appPrefix }),
+    ]);
+    return fresh && commented ? { ...commented, url: normalizeUrl(commented.url) } : null;
+}
+function decodeVercelPayload(body) {
+    const marker = /^\[vc\]: #[^:\n]+:(\S+)/m.exec(body);
+    if (!marker)
+        return null;
+    try {
+        const json = JSON.parse(Buffer.from(marker[1], 'base64').toString('utf8'));
+        return json && typeof json === 'object' ? json : null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * The preview URL a deployment bot posted on the PR.
+ *
+ * Not every provider records a GitHub Deployment — Vercel's GitHub app reports
+ * a commit status and a comment, and the commit status only links to its own
+ * dashboard. The comment is where the deployed URL actually appears, so this is
+ * the fallback when `deploymentUrlForSha` finds nothing.
+ *
+ * `appPrefix` disambiguates a monorepo comment listing several projects, by
+ * matching the project whose root directory is the app being captured.
+ */
+export async function previewUrlFromComments(gh, ownerRepo, prNumber, opts = {}) {
+    let comments;
+    try {
+        comments = await gh.request('GET', `/repos/${ownerRepo}/issues/${prNumber}/comments?per_page=100`);
+    }
+    catch {
+        return null;
+    }
+    if (!Array.isArray(comments))
+        return null;
+    // Newest first: a re-run posts an updated URL.
+    for (const comment of [...comments].reverse()) {
+        const body = comment.body ?? '';
+        if (!comment.user || !TRUSTED_BOTS.has(comment.user.login))
+            continue;
+        const payload = decodeVercelPayload(body);
+        const projects = (payload?.projects ?? []).filter(p => p.previewUrl);
+        if (projects.length) {
+            // Only projects that could be the app being captured. A project that
+            // declares a different root directory is a different app, so falling back
+            // to it would screenshot the wrong site.
+            const norm = (dir) => (dir ?? '').replace(/^\.?\//, '').replace(/\/$/, '');
+            const candidates = projects.filter(p => !opts.appPrefix || !p.rootDirectory || norm(p.rootDirectory) === opts.appPrefix);
+            const chosen = candidates.length === 1 ? candidates[0] : undefined;
+            // A build still running has a URL that does not serve the branch yet.
+            if (chosen && (chosen.nextCommitStatus ?? 'DEPLOYED') === 'DEPLOYED') {
+                return { url: normalizeUrl(chosen.previewUrl), environment: chosen.name ? `Preview (${chosen.name})` : 'Preview' };
+            }
+            continue;
+        }
+        // Providers without a structured payload still link the preview by name.
+        const link = /\[(?:Preview|Deploy Preview)\]\((https?:\/\/[^\s)]+)\)/i.exec(body);
+        if (link)
+            return { url: link[1], environment: 'Preview' };
+    }
+    return null;
+}
+//# sourceMappingURL=deployments.js.map

package/dist/deployments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../src/deployments.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC;;;;;GAKG;AACH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC;AAE9D,8DAA8D;AAC9D,MAAM,eAAe,GAAG,mCAAmC,CAAC;AAsB5D,MAAM,UAAU,GAAG,QAAQ,CAAC;AAE5B,+EAA+E;AAC/E,MAAM,eAAe,GAAG,CAAC,CAAC;AAE1B,yDAAyD;AACzD,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B,iFAAiF;AACjF,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB;;;;;;GAMG;AACH,KAAK,UAAU,eAAe,CAAC,EAAU,EAAE,SAAiB,EAAE,KAAa;IACzE,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,OAAO,CAAe,KAAK,EAAE,UAAU,SAAS,gBAAgB,KAAK,EAAE,CAAC,CAAC;QACtG,OAAO,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;IACzD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,KAAK,UAAU,UAAU,CAAC,EAAU,EAAE,SAAiB,EAAE,UAAwB;IAC/E,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAC,UAAU,EAAC,EAAE;QAChE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,OAAO,CAAqB,KAAK,EAAE,UAAU,SAAS,gBAAgB,UAAU,CAAC,EAAE,uBAAuB,CAAC,CAAC;YACtI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC1C,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAuD,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;YACnI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,eAAe,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3G,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC,CAAC;IACJ,yEAAyE;IACzE,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC;AACrC,CAAC;AAED,kEAAkE;AAClE,KAAK,UAAU,gBAAgB,CAC7B,EAAU,EACV,SAAiB,EACjB,KAAa,EACb,UAAmB;IAEnB,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAChE,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC9B,OAAO,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,kFAAkF;AAClF,SAAS,QAAQ,CAAC,WAAyB,EAAE,UAAmB;IAC9D,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC;AAChH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,EAAU,EACV,SAAiB,EACjB,GAAW,EACX,IAA6B;IAE7B,OAAO,gBAAgB,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,kBAAkB,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;AACxG,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,EAAU,EAAE,SAAiB;IAC5E,2EAA2E;IAC3E,0EAA0E;IAC1E,0EAA0E;IAC1E,6EAA6E;IAC7E,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,EAAE,EAAE,SAAS,EAAE,YAAY,cAAc,SAAS,IAAI,EAAE,CAAC,CAAC;QACpG,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC;QAC9B,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3E,IAAI,KAAK;YAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7D,IAAI,WAAW,CAAC,MAAM,GAAG,cAAc;YAAE,OAAO,IAAI,CAAC;IACvD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,4EAA4E;AAC5E,KAAK,UAAU,oBAAoB,CAAC,EAAU,EAAE,SAAiB,EAAE,GAAW;IAC5E,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,OAAO,CAA2D,KAAK,EAAE,UAAU,SAAS,YAAY,GAAG,SAAS,CAAC,CAAC;QAChJ,OAAO,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACvG,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,EAAU,EACV,SAAiB,EACjB,IAA4D;IAE5D,MAAM,QAAQ,GAAG,MAAM,mBAAmB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3F,IAAI,QAAQ;QAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;IACtE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAE7C,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC3C,oBAAoB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC;QAC7C,sBAAsB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;KACpF,CAAC,CAAC;IACH,OAAO,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACxF,CAAC;AAaD,SAAS,mBAAmB,CAAC,IAAY;IACvC,MAAM,MAAM,GAAG,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACzB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3E,OAAO,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAE,IAAsB,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,EAAU,EACV,SAAiB,EACjB,QAAgB,EAChB,OAA+B,EAAE;IAEjC,IAAI,QAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,EAAE,CAAC,OAAO,CAAiB,KAAK,EAAE,UAAU,SAAS,WAAW,QAAQ,wBAAwB,CAAC,CAAC;IACrH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IAE1C,+CAA+C;IAC/C,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,SAAS;QAErE,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,qEAAqE;YACrE,0EAA0E;YAC1E,yCAAyC;YACzC,MAAM,IAAI,GAAG,CAAC,GAAY,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACpF,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;YACzH,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACnE,sEAAsE;YACtE,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,UAAU,CAAC,KAAK,UAAU,EAAE,CAAC;gBACrE,OAAO,EAAE,GAAG,EAAE,YAAY,CAAC,MAAM,CAAC,UAAW,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;YACtH,CAAC;YACD,SAAS;QACX,CAAC;QAED,yEAAyE;QACzE,MAAM,IAAI,GAAG,yDAAyD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClF,IAAI,IAAI;YAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;IAC5D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/diff-pool.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A small worker pool for pixel diffs. Runs inline when worker threads are
+ * unavailable (e.g. executing from TypeScript sources under a test runner).
+ */
+import { DiffJob, DiffJobResult } from './diff-worker.js';
+export declare class DiffPool {
+    private readonly size;
+    private workers;
+    private queue;
+    private inline;
+    constructor(size?: number);
+    run(job: DiffJob): Promise<DiffJobResult>;
+    private spawn;
+    private pump;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=diff-pool.d.ts.map

package/dist/diff-pool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff-pool.d.ts","sourceRoot":"","sources":["../src/diff-pool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,OAAO,EAAE,aAAa,EAAkB,MAAM,kBAAkB,CAAC;AAa1E,qBAAa,QAAQ;IAKP,OAAO,CAAC,QAAQ,CAAC,IAAI;IAJjC,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,KAAK,CAAiB;IAC9B,OAAO,CAAC,MAAM,CAAS;gBAEM,IAAI,SAAiD;IAElF,GAAG,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAOzC,OAAO,CAAC,KAAK;IA8Bb,OAAO,CAAC,IAAI;IAsBN,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAI7B"}

package/dist/diff-pool.js

@@ -0,0 +1,92 @@
+/**
+ * A small worker pool for pixel diffs. Runs inline when worker threads are
+ * unavailable (e.g. executing from TypeScript sources under a test runner).
+ */
+import os from 'os';
+import { Worker } from 'worker_threads';
+import { executeDiffJob } from './diff-worker.js';
+function runInline(p) {
+    try {
+        p.resolve(executeDiffJob(p.job));
+    }
+    catch (e) {
+        p.reject(e);
+    }
+}
+export class DiffPool {
+    size;
+    workers = [];
+    queue = [];
+    inline = false;
+    constructor(size = Math.max(1, Math.min(4, os.cpus().length - 1))) {
+        this.size = size;
+    }
+    run(job) {
+        return new Promise((resolve, reject) => {
+            this.queue.push({ job, resolve, reject });
+            this.pump();
+        });
+    }
+    spawn() {
+        try {
+            const worker = new Worker(new URL('./diff-worker.js', import.meta.url));
+            const slot = { worker, busy: null };
+            worker.on('message', (msg) => {
+                const pending = slot.busy;
+                slot.busy = null;
+                if (pending) {
+                    if (msg.error)
+                        pending.reject(new Error(msg.error));
+                    else
+                        pending.resolve(msg);
+                }
+                this.pump();
+            });
+            worker.on('error', () => {
+                // The worker died: finish its job inline and stop using workers if none are left.
+                const pending = slot.busy;
+                slot.busy = null;
+                this.workers = this.workers.filter(w => w !== slot);
+                if (pending)
+                    runInline(pending);
+                if (this.workers.length === 0)
+                    this.inline = true;
+                this.pump();
+            });
+            this.workers.push(slot);
+            return slot;
+        }
+        catch {
+            this.inline = true;
+            return null;
+        }
+    }
+    pump() {
+        while (this.queue.length) {
+            if (this.inline) {
+                runInline(this.queue.shift());
+                continue;
+            }
+            let slot = this.workers.find(w => !w.busy);
+            if (!slot && this.workers.length < this.size)
+                slot = this.spawn() ?? undefined;
+            if (!slot) {
+                if (this.inline)
+                    continue; // spawn failed: drain inline
+                return; // all workers busy: wait for a message
+            }
+            const pending = this.queue.shift();
+            slot.busy = pending;
+            // Copied, not transferred. Transferring detaches the buffers here, which
+            // leaves the `error` handler above holding a job it cannot run inline —
+            // so the fallback it exists to provide could never work. A structured
+            // clone of two PNGs costs far less than the diff that follows it.
+            slot.worker.postMessage(pending.job);
+        }
+    }
+    async close() {
+        await Promise.all(this.workers.map(w => w.worker.terminate()));
+        this.workers = [];
+    }
+}
+//# sourceMappingURL=diff-pool.js.map

package/dist/diff-pool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff-pool.js","sourceRoot":"","sources":["../src/diff-pool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAA0B,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAK1E,SAAS,SAAS,CAAC,CAAU;IAC3B,IAAI,CAAC;QACH,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,CAAC,CAAC,MAAM,CAAC,CAAU,CAAC,CAAC;IACvB,CAAC;AACH,CAAC;AAED,MAAM,OAAO,QAAQ;IAKU;IAJrB,OAAO,GAAW,EAAE,CAAC;IACrB,KAAK,GAAc,EAAE,CAAC;IACtB,MAAM,GAAG,KAAK,CAAC;IAEvB,YAA6B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAArD,SAAI,GAAJ,IAAI,CAAiD;IAAG,CAAC;IAEtF,GAAG,CAAC,GAAY;QACd,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YAC1C,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK;QACX,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACxE,MAAM,IAAI,GAAS,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC1C,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAkB,EAAE,EAAE;gBAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;gBAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBACjB,IAAI,OAAO,EAAE,CAAC;oBACZ,IAAI,GAAG,CAAC,KAAK;wBAAE,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;;wBAC/C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC5B,CAAC;gBACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACtB,kFAAkF;gBAClF,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;gBAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;gBACpD,IAAI,OAAO;oBAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBAChC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;oBAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;gBAClD,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEO,IAAI;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAG,CAAC,CAAC;gBAC/B,SAAS;YACX,CAAC;YACD,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI;gBAAE,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC;YAC/E,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,IAAI,IAAI,CAAC,MAAM;oBAAE,SAAS,CAAC,6BAA6B;gBACxD,OAAO,CAAC,uCAAuC;YACjD,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAG,CAAC;YACpC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YACpB,yEAAyE;YACzE,wEAAwE;YACxE,sEAAsE;YACtE,kEAAkE;YAClE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;CACF"}

package/dist/diff-worker.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Worker-thread entry: diff two PNGs held in memory and write every output.
+ * Keeps pixel work and file I/O off the main thread so captures keep flowing.
+ */
+import { DiffOptions } from './diff.js';
+import { ShiftSummary } from './types.js';
+export interface DiffJob {
+    /** PNG bytes; transferred to the worker, so the caller must not reuse them. */
+    before: Uint8Array;
+    after: Uint8Array;
+    /** Where to write pre, post, diff, and (when produced) crops. */
+    outputs: {
+        before: string;
+        after: string;
+        diff: string;
+        cropBefore: string;
+        cropAfter: string;
+    };
+    options?: DiffOptions;
+}
+export interface DiffJobResult {
+    changedRatio: number;
+    changedPixels: number;
+    sizeChanged: boolean;
+    hasCrop: boolean;
+    hasHighlight: boolean;
+    /** Plain numbers, so the summary survives the structured clone back to the pool. */
+    shift?: ShiftSummary;
+    error?: string;
+}
+export declare function executeDiffJob(job: DiffJob): DiffJobResult;
+//# sourceMappingURL=diff-worker.d.ts.map

package/dist/diff-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff-worker.d.ts","sourceRoot":"","sources":["../src/diff-worker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAc,WAAW,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,WAAW,OAAO;IACtB,+EAA+E;IAC/E,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,UAAU,CAAC;IAClB,iEAAiE;IACjE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAChG,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;IACtB,oFAAoF;IACpF,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,CAmB1D"}

package/dist/diff-worker.js

@@ -0,0 +1,39 @@
+/**
+ * Worker-thread entry: diff two PNGs held in memory and write every output.
+ * Keeps pixel work and file I/O off the main thread so captures keep flowing.
+ */
+import fs from 'fs';
+import { parentPort } from 'worker_threads';
+import { diffImages } from './diff.js';
+export function executeDiffJob(job) {
+    const before = Buffer.from(job.before.buffer, job.before.byteOffset, job.before.byteLength);
+    const after = Buffer.from(job.after.buffer, job.after.byteOffset, job.after.byteLength);
+    fs.writeFileSync(job.outputs.before, before);
+    fs.writeFileSync(job.outputs.after, after);
+    const result = diffImages(before, after, job.options);
+    if (result.highlight)
+        fs.writeFileSync(job.outputs.diff, result.highlight);
+    if (result.crop) {
+        fs.writeFileSync(job.outputs.cropBefore, result.crop.before);
+        fs.writeFileSync(job.outputs.cropAfter, result.crop.after);
+    }
+    return {
+        changedRatio: result.changedRatio,
+        changedPixels: result.changedPixels,
+        sizeChanged: result.sizeChanged,
+        hasCrop: Boolean(result.crop),
+        hasHighlight: Boolean(result.highlight),
+        shift: result.shift,
+    };
+}
+if (parentPort) {
+    parentPort.on('message', (job) => {
+        try {
+            parentPort.postMessage(executeDiffJob(job));
+        }
+        catch (err) {
+            parentPort.postMessage({ error: err.message });
+        }
+    });
+}
+//# sourceMappingURL=diff-worker.js.map

package/dist/diff-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff-worker.js","sourceRoot":"","sources":["../src/diff-worker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAe,MAAM,WAAW,CAAC;AAuBpD,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC5F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACxF,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACtD,IAAI,MAAM,CAAC,SAAS;QAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3E,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7D,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO;QACL,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;QAC7B,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;QACvC,KAAK,EAAE,MAAM,CAAC,KAAK;KACpB,CAAC;AACJ,CAAC;AAED,IAAI,UAAU,EAAE,CAAC;IACf,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAY,EAAE,EAAE;QACxC,IAAI,CAAC;YACH,UAAW,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,UAAW,CAAC,WAAW,CAAC,EAAE,KAAK,EAAG,GAAa,CAAC,OAAO,EAAmB,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/diff.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Pixel diff between two PNG screenshots.
+ *
+ * Pure JS (pixelmatch + pngjs): no native build step, works everywhere the
+ * CLI runs. Produces a change ratio, the bounding box of the change, a
+ * highlight image, and tight crops of before/after around the change.
+ */
+import { PNG } from 'pngjs';
+import { DiffRegion, DiffResult } from './types.js';
+export interface DiffOptions {
+    /** Padding around the change region for crops, in device pixels. Default 80 */
+    padding?: number;
+    /** Minimum crop size in device pixels. Default 800x400 */
+    minCrop?: {
+        width: number;
+        height: number;
+    };
+    /** Integer factor to shrink the highlight image by (e.g. 2 for 2x captures). Default 1 */
+    highlightDownscale?: number;
+    /**
+     * Produce the red-highlight overlay. Default true.
+     *
+     * The pr pipeline uses the bounding box to crop Pre and Post, and ships that
+     * pair; it never publishes the overlay, and a wall of red pixels is not
+     * something a reviewer reads anyway. Encoding one per capture is a downscale
+     * and a deflate of a full-page image for nothing, so that path turns it off.
+     * Image mode still writes diff.png.
+     */
+    highlight?: boolean;
+}
+/** Box-filter downscale by an integer factor. */
+export declare function downscale(src: PNG, factor: number): PNG;
+export declare function decodePng(buffer: Buffer): PNG;
+/** Expand a region by padding and to a minimum size, clamped to the canvas. */
+export declare function expandRegion(region: DiffRegion, canvas: {
+    width: number;
+    height: number;
+}, padding: number, min: {
+    width: number;
+    height: number;
+}): DiffRegion;
+/**
+ * Compare two PNG buffers. Images of different sizes are padded onto a shared
+ * canvas so a height change shows up as a change rather than an error.
+ */
+export declare function diffImages(beforePng: Buffer, afterPng: Buffer, options?: DiffOptions): DiffResult;
+//# sourceMappingURL=diff.d.ts.map

package/dist/diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../src/diff.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,UAAU,EAAgB,MAAM,YAAY,CAAC;AAGlE,MAAM,WAAW,WAAW;IAC1B,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,0FAA0F;IAC1F,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AA8ED,iDAAiD;AACjD,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG,CAoBvD;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAE7C;AAoCD,+EAA+E;AAC/E,wBAAgB,YAAY,CAC1B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EACzC,OAAO,EAAE,MAAM,EACf,GAAG,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACrC,UAAU,CAqBZ;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,UAAU,CAuGrG"}