@alwaysmeticulous/custom-checks 2.290.0

package/dist/__tests__/custom-checks.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/custom-checks.spec.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const get_snapshots_from_test_run_1 = require("../get-snapshots-from-test-run");
+const report_custom_check_results_1 = require("../report-custom-check-results");
+const wait_for_test_run_1 = require("../wait-for-test-run");
+const testRun = (id, status) => ({ id, status });
+(0, vitest_1.describe)("custom checks SDK helpers", () => {
+    let client;
+    const asClient = () => client;
+    (0, vitest_1.beforeEach)(() => {
+        client = { get: vitest_1.vi.fn(), post: vitest_1.vi.fn(), put: vitest_1.vi.fn() };
+    });
+    (0, vitest_1.describe)("reportCustomCheckResults", () => {
+        (0, vitest_1.it)("POSTs the results to the custom-check-results endpoint", async () => {
+            client.post.mockResolvedValue({ data: { reported: true } });
+            const results = {
+                status: "complete",
+                checks: [
+                    {
+                        checkId: "network-requests-diff",
+                        verdict: "warn",
+                        summary: "1 session changed",
+                        report: { type: "markdown", markdown: "# Report" },
+                    },
+                ],
+            };
+            await (0, report_custom_check_results_1.reportCustomCheckResults)({
+                client: asClient(),
+                testRunId: "tr-1",
+                results,
+            });
+            (0, vitest_1.expect)(client.post).toHaveBeenCalledWith("test-runs/tr-1/custom-check-results", results);
+        });
+        (0, vitest_1.it)("reports a run-level execution error", async () => {
+            client.post.mockResolvedValue({ data: { reported: true } });
+            const results = {
+                status: "execution-error",
+                error: "boom",
+            };
+            await (0, report_custom_check_results_1.reportCustomCheckResults)({
+                client: asClient(),
+                testRunId: "tr-1",
+                results,
+            });
+            (0, vitest_1.expect)(client.post).toHaveBeenCalledWith("test-runs/tr-1/custom-check-results", { status: "execution-error", error: "boom" });
+        });
+    });
+    (0, vitest_1.describe)("getSnapshotsFromTestRun", () => {
+        (0, vitest_1.it)("fetches snapshots for the requested types", async () => {
+            const response = {
+                testRunId: "tr-1",
+                baseTestRunId: "base-1",
+                baseSnapshots: [],
+                headSnapshots: [],
+            };
+            client.get.mockResolvedValue({ data: response });
+            const result = await (0, get_snapshots_from_test_run_1.getSnapshotsFromTestRun)({
+                client: asClient(),
+                testRunId: "tr-1",
+                snapshotTypes: ["network-requests"],
+            });
+            (0, vitest_1.expect)(result).toEqual(response);
+            (0, vitest_1.expect)(client.get).toHaveBeenCalledWith("test-runs/tr-1/custom-check-snapshots?snapshotTypes=network-requests");
+        });
+    });
+    (0, vitest_1.describe)("findTestRunByIdAndWaitForCompletion", () => {
+        (0, vitest_1.it)("polls until the test run reaches a terminal status", async () => {
+            client.get
+                .mockResolvedValueOnce({ data: testRun("tr-1", "Running") })
+                .mockResolvedValueOnce({ data: testRun("tr-1", "PostProcessing") })
+                .mockResolvedValueOnce({ data: testRun("tr-1", "Success") });
+            const result = await (0, wait_for_test_run_1.findTestRunByIdAndWaitForCompletion)({
+                client: asClient(),
+                testRunId: "tr-1",
+                pollIntervalMs: 1,
+            });
+            (0, vitest_1.expect)(result.testRun.status).toBe("Success");
+            (0, vitest_1.expect)(client.get).toHaveBeenCalledTimes(3);
+        });
+        (0, vitest_1.it)("returns when a run leaves the in-progress states (e.g. Partial), not only on Success/Failure", async () => {
+            client.get
+                .mockResolvedValueOnce({ data: testRun("tr-1", "Running") })
+                .mockResolvedValueOnce({ data: testRun("tr-1", "Partial") });
+            const result = await (0, wait_for_test_run_1.findTestRunByIdAndWaitForCompletion)({
+                client: asClient(),
+                testRunId: "tr-1",
+                pollIntervalMs: 1,
+            });
+            (0, vitest_1.expect)(result.testRun.status).toBe("Partial");
+            (0, vitest_1.expect)(client.get).toHaveBeenCalledTimes(2);
+        });
+        (0, vitest_1.it)("throws once the timeout elapses", async () => {
+            client.get.mockResolvedValue({ data: testRun("tr-1", "Running") });
+            await (0, vitest_1.expect)((0, wait_for_test_run_1.findTestRunByIdAndWaitForCompletion)({
+                client: asClient(),
+                testRunId: "tr-1",
+                pollIntervalMs: 1,
+                timeoutMs: 0,
+            })).rejects.toThrow(/Timed out/);
+        });
+    });
+    (0, vitest_1.describe)("findTestRunByCommitAndWaitForCompletion", () => {
+        (0, vitest_1.it)("resolves the latest run for the commit, then waits for it to complete", async () => {
+            client.get.mockImplementation(async (url) => url === "test-runs/cache"
+                ? { data: testRun("tr-9", "Running") }
+                : { data: testRun("tr-9", "Success") });
+            const result = await (0, wait_for_test_run_1.findTestRunByCommitAndWaitForCompletion)({
+                client: asClient(),
+                commitSha: "abc123",
+                pollIntervalMs: 1,
+            });
+            (0, vitest_1.expect)(result.testRunId).toBe("tr-9");
+            (0, vitest_1.expect)(result.testRun.status).toBe("Success");
+        });
+        (0, vitest_1.it)("throws when no test run exists for the commit", async () => {
+            // The cache endpoint yields no run (getLatestTestRunResults returns null).
+            client.get.mockResolvedValue({ data: null });
+            await (0, vitest_1.expect)((0, wait_for_test_run_1.findTestRunByCommitAndWaitForCompletion)({
+                client: asClient(),
+                commitSha: "missing",
+            })).rejects.toThrow(/No test run found for commit missing/);
+        });
+    });
+});
+//# sourceMappingURL=custom-checks.spec.js.map

package/dist/__tests__/custom-checks.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-checks.spec.js","sourceRoot":"","sources":["../../src/__tests__/custom-checks.spec.ts"],"names":[],"mappings":";;AAMA,mCAAyE;AACzE,gFAAyE;AACzE,gFAA0E;AAC1E,4DAG8B;AAE9B,MAAM,OAAO,GAAG,CAAC,EAAU,EAAE,MAAqB,EAAW,EAAE,CAC7D,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAuB,CAAC;AAEzC,IAAA,iBAAQ,EAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,IAAI,MAA4C,CAAC;IACjD,MAAM,QAAQ,GAAG,GAAqB,EAAE,CACtC,MAAqC,CAAC;IAExC,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,MAAM,GAAG,EAAE,GAAG,EAAE,WAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,WAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,WAAE,CAAC,EAAE,EAAE,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,IAAA,WAAE,EAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAC5D,MAAM,OAAO,GAAoC;gBAC/C,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE;oBACN;wBACE,OAAO,EAAE,uBAAuB;wBAChC,OAAO,EAAE,MAAM;wBACf,OAAO,EAAE,mBAAmB;wBAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE;qBACnD;iBACF;aACF,CAAC;YAEF,MAAM,IAAA,sDAAwB,EAAC;gBAC7B,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,MAAM;gBACjB,OAAO;aACR,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CACtC,qCAAqC,EACrC,OAAO,CACR,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAC5D,MAAM,OAAO,GAAoC;gBAC/C,MAAM,EAAE,iBAAiB;gBACzB,KAAK,EAAE,MAAM;aACd,CAAC;YAEF,MAAM,IAAA,sDAAwB,EAAC;gBAC7B,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,MAAM;gBACjB,OAAO;aACR,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CACtC,qCAAqC,EACrC,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,EAAE,CAC7C,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,IAAA,WAAE,EAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,QAAQ,GAAG;gBACf,SAAS,EAAE,MAAM;gBACjB,aAAa,EAAE,QAAQ;gBACvB,aAAa,EAAE,EAAE;gBACjB,aAAa,EAAE,EAAE;aAClB,CAAC;YACF,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;YAEjD,MAAM,MAAM,GAAG,MAAM,IAAA,qDAAuB,EAAC;gBAC3C,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,MAAM;gBACjB,aAAa,EAAE,CAAC,kBAAkB,CAAC;aACpC,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACjC,IAAA,eAAM,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CACrC,sEAAsE,CACvE,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,qCAAqC,EAAE,GAAG,EAAE;QACnD,IAAA,WAAE,EAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YAClE,MAAM,CAAC,GAAG;iBACP,qBAAqB,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;iBAC3D,qBAAqB,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;iBAClE,qBAAqB,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;YAE/D,MAAM,MAAM,GAAG,MAAM,IAAA,uDAAmC,EAAC;gBACvD,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,MAAM;gBACjB,cAAc,EAAE,CAAC;aAClB,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAA,eAAM,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,8FAA8F,EAAE,KAAK,IAAI,EAAE;YAC5G,MAAM,CAAC,GAAG;iBACP,qBAAqB,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;iBAC3D,qBAAqB,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;YAE/D,MAAM,MAAM,GAAG,MAAM,IAAA,uDAAmC,EAAC;gBACvD,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,MAAM;gBACjB,cAAc,EAAE,CAAC;aAClB,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAA,eAAM,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YAC/C,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;YAEnE,MAAM,IAAA,eAAM,EACV,IAAA,uDAAmC,EAAC;gBAClC,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,MAAM;gBACjB,cAAc,EAAE,CAAC;gBACjB,SAAS,EAAE,CAAC;aACb,CAAC,CACH,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,yCAAyC,EAAE,GAAG,EAAE;QACvD,IAAA,WAAE,EAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,KAAK,EAAE,GAAW,EAAE,EAAE,CAClD,GAAG,KAAK,iBAAiB;gBACvB,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE;gBACtC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CACzC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAA,2DAAuC,EAAC;gBAC3D,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,QAAQ;gBACnB,cAAc,EAAE,CAAC;aAClB,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtC,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,2EAA2E;YAC3E,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAE7C,MAAM,IAAA,eAAM,EACV,IAAA,2DAAuC,EAAC;gBACtC,MAAM,EAAE,QAAQ,EAAE;gBAClB,SAAS,EAAE,SAAS;aACrB,CAAC,CACH,CAAC,OAAO,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/download-snapshots.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/download-snapshots.spec.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const downloading_helpers_1 = require("@alwaysmeticulous/downloading-helpers");
+const vitest_1 = require("vitest");
+const download_snapshots_1 = require("../download-snapshots");
+vitest_1.vi.mock("@alwaysmeticulous/downloading-helpers", () => ({
+    downloadAndExtractFile: vitest_1.vi.fn(),
+}));
+const SIGNED_BASE_URL = "https://cf.example/?Signature=sig&Key-Pair-Id=k";
+const keyFromUrl = (url) => new URL(url).pathname.slice(1);
+(0, vitest_1.describe)("downloadAndAssembleSnapshots", () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.clearAllMocks();
+        // Emulate the real helper: extract the (zip-wrapped) file into `extractDir`
+        // as a single `<type>.json` containing the stored snapshot array, with the
+        // file's key echoed into `data` so the test can assert per-file wiring.
+        downloading_helpers_1.downloadAndExtractFile.mockImplementation(async (url, _zipPath, extractDir) => {
+            const key = keyFromUrl(url);
+            const fileName = key.split("/").pop().replace(/\.gz$/, "");
+            await (0, promises_1.mkdir)(extractDir, { recursive: true });
+            await (0, promises_1.writeFile)((0, path_1.join)(extractDir, fileName), JSON.stringify([
+                { stageDuringSession: "final-state", data: { fromKey: key } },
+            ]));
+            return [fileName];
+        });
+    });
+    (0, vitest_1.it)("downloads each file from the signed base URL and tags entries with type + sessionId", async () => {
+        const files = [
+            {
+                type: "network-requests",
+                sessionId: "sess-a",
+                key: "proj/replay-a/custom-checks-snapshots/network-requests.json.gz",
+            },
+            {
+                type: "network-requests",
+                sessionId: "sess-b",
+                key: "proj/replay-b/custom-checks-snapshots/network-requests.json.gz",
+            },
+        ];
+        const snapshots = await (0, download_snapshots_1.downloadAndAssembleSnapshots)({
+            signedBaseUrl: SIGNED_BASE_URL,
+            files,
+        });
+        (0, vitest_1.expect)(snapshots).toEqual([
+            {
+                type: "network-requests",
+                sessionId: "sess-a",
+                stageDuringSession: "final-state",
+                data: { fromKey: files[0].key },
+            },
+            {
+                type: "network-requests",
+                sessionId: "sess-b",
+                stageDuringSession: "final-state",
+                data: { fromKey: files[1].key },
+            },
+        ]);
+        // Each file is fetched by setting the path on the signed base URL while
+        // preserving the signature query string.
+        const requestedUrls = downloading_helpers_1.downloadAndExtractFile.mock.calls.map((call) => call[0]);
+        (0, vitest_1.expect)(requestedUrls).toEqual(vitest_1.expect.arrayContaining([
+            `https://cf.example/${files[0].key}?Signature=sig&Key-Pair-Id=k`,
+            `https://cf.example/${files[1].key}?Signature=sig&Key-Pair-Id=k`,
+        ]));
+    });
+    (0, vitest_1.it)("returns no snapshots and does not download when there are no files", async () => {
+        const snapshots = await (0, download_snapshots_1.downloadAndAssembleSnapshots)({
+            signedBaseUrl: SIGNED_BASE_URL,
+            files: [],
+        });
+        (0, vitest_1.expect)(snapshots).toEqual([]);
+        (0, vitest_1.expect)(downloading_helpers_1.downloadAndExtractFile).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)("throws if a downloaded file has no .json entry", async () => {
+        downloading_helpers_1.downloadAndExtractFile.mockResolvedValue([]);
+        await (0, vitest_1.expect)((0, download_snapshots_1.downloadAndAssembleSnapshots)({
+            signedBaseUrl: SIGNED_BASE_URL,
+            files: [
+                {
+                    type: "network-requests",
+                    sessionId: "sess-a",
+                    key: "proj/replay-a/custom-checks-snapshots/network-requests.json.gz",
+                },
+            ],
+        })).rejects.toThrow(/did not contain a .json entry/);
+    });
+});
+//# sourceMappingURL=download-snapshots.spec.js.map

package/dist/__tests__/download-snapshots.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"download-snapshots.spec.js","sourceRoot":"","sources":["../../src/__tests__/download-snapshots.spec.ts"],"names":[],"mappings":";;AAAA,0CAA+C;AAC/C,+BAA4B;AAC5B,+EAA+E;AAC/E,mCAAyE;AACzE,8DAAqE;AAErE,WAAE,CAAC,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE,CAAC,CAAC;IACtD,sBAAsB,EAAE,WAAE,CAAC,EAAE,EAAE;CAChC,CAAC,CAAC,CAAC;AAEJ,MAAM,eAAe,GAAG,iDAAiD,CAAC;AAE1E,MAAM,UAAU,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3E,IAAA,iBAAQ,EAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,WAAE,CAAC,aAAa,EAAE,CAAC;QACnB,4EAA4E;QAC5E,2EAA2E;QAC3E,wEAAwE;QACvE,4CAA+B,CAAC,kBAAkB,CACjD,KAAK,EAAE,GAAW,EAAE,QAAgB,EAAE,UAAkB,EAAE,EAAE;YAC1D,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC5D,MAAM,IAAA,gBAAK,EAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7C,MAAM,IAAA,oBAAS,EACb,IAAA,WAAI,EAAC,UAAU,EAAE,QAAQ,CAAC,EAC1B,IAAI,CAAC,SAAS,CAAC;gBACb,EAAE,kBAAkB,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE;aAC9D,CAAC,CACH,CAAC;YACF,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;QACnG,MAAM,KAAK,GAAG;YACZ;gBACE,IAAI,EAAE,kBAAkB;gBACxB,SAAS,EAAE,QAAQ;gBACnB,GAAG,EAAE,gEAAgE;aACtE;YACD;gBACE,IAAI,EAAE,kBAAkB;gBACxB,SAAS,EAAE,QAAQ;gBACnB,GAAG,EAAE,gEAAgE;aACtE;SACF,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,IAAA,iDAA4B,EAAC;YACnD,aAAa,EAAE,eAAe;YAC9B,KAAK;SACN,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACxB;gBACE,IAAI,EAAE,kBAAkB;gBACxB,SAAS,EAAE,QAAQ;gBACnB,kBAAkB,EAAE,aAAa;gBACjC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE;aAChC;YACD;gBACE,IAAI,EAAE,kBAAkB;gBACxB,SAAS,EAAE,QAAQ;gBACnB,kBAAkB,EAAE,aAAa;gBACjC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE;aAChC;SACF,CAAC,CAAC;QAEH,wEAAwE;QACxE,yCAAyC;QACzC,MAAM,aAAa,GAAI,4CAA+B,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CACnE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAW,CAC5B,CAAC;QACF,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,OAAO,CAC3B,eAAM,CAAC,eAAe,CAAC;YACrB,sBAAsB,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,8BAA8B;YAChE,sBAAsB,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,8BAA8B;SACjE,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,SAAS,GAAG,MAAM,IAAA,iDAA4B,EAAC;YACnD,aAAa,EAAE,eAAe;YAC9B,KAAK,EAAE,EAAE;SACV,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAA,eAAM,EAAC,4CAAsB,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC7D,4CAA+B,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAEvD,MAAM,IAAA,eAAM,EACV,IAAA,iDAA4B,EAAC;YAC3B,aAAa,EAAE,eAAe;YAC9B,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,kBAAkB;oBACxB,SAAS,EAAE,QAAQ;oBACnB,GAAG,EAAE,gEAAgE;iBACtE;aACF;SACF,CAAC,CACH,CAAC,OAAO,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/download-snapshots.d.ts

@@ -0,0 +1,20 @@
+import type { Snapshot } from "@alwaysmeticulous/api";
+/**
+ * One custom check snapshot file to download. `key` is appended to the signed
+ * base URL to fetch it; `type` and `sessionId` aren't stored in the file and so
+ * are stamped onto each parsed snapshot.
+ */
+export interface CustomCheckSnapshotFileToDownload {
+    type: string;
+    sessionId: string;
+    key: string;
+}
+/**
+ * Downloads every snapshot file in parallel from the single signed base URL and
+ * assembles them into a flat list of {@link Snapshot}s for a custom check.
+ */
+export declare const downloadAndAssembleSnapshots: ({ signedBaseUrl, files, concurrency, }: {
+    signedBaseUrl: string;
+    files: CustomCheckSnapshotFileToDownload[];
+    concurrency?: number;
+}) => Promise<Snapshot[]>;

package/dist/download-snapshots.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadAndAssembleSnapshots = void 0;
+const promises_1 = require("fs/promises");
+const os_1 = require("os");
+const path_1 = require("path");
+const downloading_helpers_1 = require("@alwaysmeticulous/downloading-helpers");
+const p_limit_1 = __importDefault(require("p-limit"));
+/** How many snapshot files to download and extract in parallel. */
+const DEFAULT_DOWNLOAD_CONCURRENCY = 20;
+/**
+ * Downloads every snapshot file in parallel from the single signed base URL and
+ * assembles them into a flat list of {@link Snapshot}s for a custom check.
+ */
+const downloadAndAssembleSnapshots = async ({ signedBaseUrl, files, concurrency = DEFAULT_DOWNLOAD_CONCURRENCY, }) => {
+    if (files.length === 0) {
+        return [];
+    }
+    const limit = (0, p_limit_1.default)(concurrency);
+    const snapshotsPerFile = await Promise.all(files.map((file) => limit(() => downloadSnapshotFile(signedBaseUrl, file))));
+    return snapshotsPerFile.flat();
+};
+exports.downloadAndAssembleSnapshots = downloadAndAssembleSnapshots;
+/**
+ * Downloads and parses a single snapshot file, tagging each entry with the
+ * file's `type` and `sessionId`.
+ *
+ * Despite the `.json.gz` key the stored file is a zip archive (containing a
+ * single `<type>.json` entry) like the other replay artifacts, so we reuse the
+ * same download-and-extract helper via a throwaway temp dir.
+ */
+const downloadSnapshotFile = async (signedBaseUrl, file) => {
+    const url = buildSnapshotFileUrl(signedBaseUrl, file.key);
+    const workDir = await (0, promises_1.mkdtemp)((0, path_1.join)((0, os_1.tmpdir)(), "met-custom-check-snapshots-"));
+    try {
+        const zipPath = (0, path_1.join)(workDir, "snapshot.json.gz");
+        const extractDir = (0, path_1.join)(workDir, "extracted");
+        const entries = await (0, downloading_helpers_1.downloadAndExtractFile)(url, zipPath, extractDir);
+        const jsonEntry = entries.find((entry) => entry.endsWith(".json"));
+        if (jsonEntry == null) {
+            throw new Error(`Custom check snapshot file "${file.key}" did not contain a .json entry (got: ${entries.join(", ") || "<none>"}).`);
+        }
+        const parsed = JSON.parse(await (0, promises_1.readFile)((0, path_1.join)(extractDir, jsonEntry), "utf-8"));
+        if (!Array.isArray(parsed)) {
+            throw new Error(`Expected custom check snapshot file "${file.key}" to contain a JSON array, got ${typeof parsed}.`);
+        }
+        return parsed.map((snapshot) => ({
+            type: file.type,
+            sessionId: file.sessionId,
+            stageDuringSession: snapshot.stageDuringSession,
+            data: snapshot.data,
+        }));
+    }
+    finally {
+        await (0, promises_1.rm)(workDir, { recursive: true, force: true });
+    }
+};
+/**
+ * Builds a file's URL by setting the path on the signed base URL. The CloudFront
+ * signature is in the query string, so we keep it and only replace the path.
+ */
+const buildSnapshotFileUrl = (signedBaseUrl, key) => {
+    const url = new URL(signedBaseUrl);
+    url.pathname = `/${key}`;
+    return url.toString();
+};
+//# sourceMappingURL=download-snapshots.js.map

package/dist/download-snapshots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"download-snapshots.js","sourceRoot":"","sources":["../src/download-snapshots.ts"],"names":[],"mappings":";;;;;;AAAA,0CAAoD;AACpD,2BAA4B;AAC5B,+BAA4B;AAE5B,+EAA+E;AAC/E,sDAA6B;AAE7B,mEAAmE;AACnE,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAaxC;;;GAGG;AACI,MAAM,4BAA4B,GAAG,KAAK,EAAE,EACjD,aAAa,EACb,KAAK,EACL,WAAW,GAAG,4BAA4B,GAK3C,EAAuB,EAAE;IACxB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,IAAA,iBAAM,EAAC,WAAW,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CACxC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC,CAC5E,CAAC;IACF,OAAO,gBAAgB,CAAC,IAAI,EAAE,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,4BAA4B,gCAiBvC;AAEF;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAAG,KAAK,EAChC,aAAqB,EACrB,IAAuC,EAClB,EAAE;IACvB,MAAM,GAAG,GAAG,oBAAoB,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAO,EAAC,IAAA,WAAI,EAAC,IAAA,WAAM,GAAE,EAAE,6BAA6B,CAAC,CAAC,CAAC;IAC7E,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;QAClD,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,MAAM,IAAA,4CAAsB,EAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEvE,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,+BAA+B,IAAI,CAAC,GAAG,yCACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,QACxB,IAAI,CACL,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAChC,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,UAAU,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CACrD,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,wCAAwC,IAAI,CAAC,GAAG,kCAAkC,OAAO,MAAM,GAAG,CACnG,CAAC;QACJ,CAAC;QAED,OAAQ,MAA+D,CAAC,GAAG,CACzE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;YAC/C,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB,CAAC,CACH,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,IAAA,aAAE,EAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAAC,aAAqB,EAAE,GAAW,EAAU,EAAE;IAC1E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;IACnC,GAAG,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;IACzB,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC,CAAC"}

package/dist/get-snapshots-from-test-run.d.ts

@@ -0,0 +1,21 @@
+import type { Snapshot } from "@alwaysmeticulous/api";
+import { type MeticulousClient } from "@alwaysmeticulous/client";
+export interface GetSnapshotsFromTestRunOptions {
+    client: MeticulousClient;
+    testRunId: string;
+    /** The custom check snapshot types to fetch, e.g. ["network-requests"]. */
+    snapshotTypes: string[];
+}
+export interface SnapshotsFromTestRun {
+    testRunId: string;
+    /** The base test run the snapshots were compared against. */
+    baseTestRunId: string;
+    baseSnapshots: Snapshot[];
+    headSnapshots: Snapshot[];
+}
+/**
+ * Fetches the custom check snapshots gathered during the base and head replays
+ * of a test run, ready to be passed to a custom check's `execute`. Throws if the
+ * test run has no resolvable base test run.
+ */
+export declare const getSnapshotsFromTestRun: ({ client, testRunId, snapshotTypes, }: GetSnapshotsFromTestRunOptions) => Promise<SnapshotsFromTestRun>;

package/dist/get-snapshots-from-test-run.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSnapshotsFromTestRun = void 0;
+const client_1 = require("@alwaysmeticulous/client");
+/**
+ * Fetches the custom check snapshots gathered during the base and head replays
+ * of a test run, ready to be passed to a custom check's `execute`. Throws if the
+ * test run has no resolvable base test run.
+ */
+const getSnapshotsFromTestRun = async ({ client, testRunId, snapshotTypes, }) => {
+    const params = new URLSearchParams();
+    for (const snapshotType of snapshotTypes) {
+        params.append("snapshotTypes", snapshotType);
+    }
+    const { data } = await client
+        .get(`test-runs/${testRunId}/custom-check-snapshots?${params.toString()}`)
+        .catch((error) => {
+        throw (0, client_1.maybeEnrichFetchError)(error);
+    });
+    return data;
+};
+exports.getSnapshotsFromTestRun = getSnapshotsFromTestRun;
+//# sourceMappingURL=get-snapshots-from-test-run.js.map

package/dist/get-snapshots-from-test-run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-snapshots-from-test-run.js","sourceRoot":"","sources":["../src/get-snapshots-from-test-run.ts"],"names":[],"mappings":";;;AACA,qDAGkC;AAiBlC;;;;GAIG;AACI,MAAM,uBAAuB,GAAG,KAAK,EAAE,EAC5C,MAAM,EACN,SAAS,EACT,aAAa,GACkB,EAAiC,EAAE;IAClE,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IAC/C,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM;SAC1B,GAAG,CAGF,aAAa,SAAS,2BAA2B,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;SACtE,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACL,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAlBW,QAAA,uBAAuB,2BAkBlC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { ReportCustomCheckResultsOptions, reportCustomCheckResults, } from "./report-custom-check-results";
+export { WaitForTestRunCompletionOptions, WaitForTestRunResult, FindTestRunByCommitAndWaitForCompletionOptions, findTestRunByCommitAndWaitForCompletion, FindTestRunByIdAndWaitForCompletionOptions, findTestRunByIdAndWaitForCompletion, } from "./wait-for-test-run";
+export { GetSnapshotsFromTestRunOptions, SnapshotsFromTestRun, getSnapshotsFromTestRun, } from "./get-snapshots-from-test-run";
+export { createClient, createClientWithOAuth, MeticulousClient, } from "@alwaysmeticulous/client";
+export { CustomCheckVerdict, CustomCheckOutput, CustomCheckReport, MarkdownReport, Snapshot, ReportedCustomCheckResult, ReportCustomCheckResultsRequest, CustomCheckResultsStatus, CUSTOM_CHECK_RESULTS_STATUSES, CUSTOM_CHECK_SUMMARY_MAX_LENGTH, } from "@alwaysmeticulous/api";

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CUSTOM_CHECK_SUMMARY_MAX_LENGTH = exports.CUSTOM_CHECK_RESULTS_STATUSES = exports.createClientWithOAuth = exports.createClient = exports.getSnapshotsFromTestRun = exports.findTestRunByIdAndWaitForCompletion = exports.findTestRunByCommitAndWaitForCompletion = exports.reportCustomCheckResults = void 0;
+var report_custom_check_results_1 = require("./report-custom-check-results");
+Object.defineProperty(exports, "reportCustomCheckResults", { enumerable: true, get: function () { return report_custom_check_results_1.reportCustomCheckResults; } });
+var wait_for_test_run_1 = require("./wait-for-test-run");
+Object.defineProperty(exports, "findTestRunByCommitAndWaitForCompletion", { enumerable: true, get: function () { return wait_for_test_run_1.findTestRunByCommitAndWaitForCompletion; } });
+Object.defineProperty(exports, "findTestRunByIdAndWaitForCompletion", { enumerable: true, get: function () { return wait_for_test_run_1.findTestRunByIdAndWaitForCompletion; } });
+var get_snapshots_from_test_run_1 = require("./get-snapshots-from-test-run");
+Object.defineProperty(exports, "getSnapshotsFromTestRun", { enumerable: true, get: function () { return get_snapshots_from_test_run_1.getSnapshotsFromTestRun; } });
+// Re-export the client building blocks a custom-check script needs (creating a
+// client), so everything can be imported from one package.
+var client_1 = require("@alwaysmeticulous/client");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
+Object.defineProperty(exports, "createClientWithOAuth", { enumerable: true, get: function () { return client_1.createClientWithOAuth; } });
+// Re-export the custom-check authoring and transport types.
+var api_1 = require("@alwaysmeticulous/api");
+Object.defineProperty(exports, "CUSTOM_CHECK_RESULTS_STATUSES", { enumerable: true, get: function () { return api_1.CUSTOM_CHECK_RESULTS_STATUSES; } });
+Object.defineProperty(exports, "CUSTOM_CHECK_SUMMARY_MAX_LENGTH", { enumerable: true, get: function () { return api_1.CUSTOM_CHECK_SUMMARY_MAX_LENGTH; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6EAGuC;AADrC,uIAAA,wBAAwB,OAAA;AAE1B,yDAO6B;AAH3B,4IAAA,uCAAuC,OAAA;AAEvC,wIAAA,mCAAmC,OAAA;AAErC,6EAIuC;AADrC,sIAAA,uBAAuB,OAAA;AAGzB,+EAA+E;AAC/E,2DAA2D;AAC3D,mDAIkC;AAHhC,sGAAA,YAAY,OAAA;AACZ,+GAAA,qBAAqB,OAAA;AAIvB,4DAA4D;AAC5D,6CAW+B;AAF7B,oHAAA,6BAA6B,OAAA;AAC7B,sHAAA,+BAA+B,OAAA"}

package/dist/report-custom-check-results.d.ts

@@ -0,0 +1,19 @@
+import type { ReportCustomCheckResultsRequest } from "@alwaysmeticulous/api";
+import { type MeticulousClient } from "@alwaysmeticulous/client";
+export interface ReportCustomCheckResultsOptions {
+    client: MeticulousClient;
+    testRunId: string;
+    /**
+     * The results to report: either every check's result (`status: "complete"`)
+     * or a single execution error for the run as a whole (`status:
+     * "execution-error"`).
+     */
+    results: ReportCustomCheckResultsRequest;
+}
+/**
+ * Reports the custom check results computed for a test run (e.g. from a job in
+ * the customer's CI after the run completes). May be called only once per test
+ * run — a second call fails. Pair with {@link findTestRunByCommitAndWaitForCompletion}
+ * and `getSnapshotsFromTestRun` to write a custom check from any script.
+ */
+export declare const reportCustomCheckResults: ({ client, testRunId, results, }: ReportCustomCheckResultsOptions) => Promise<void>;

package/dist/report-custom-check-results.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportCustomCheckResults = void 0;
+const client_1 = require("@alwaysmeticulous/client");
+/**
+ * Reports the custom check results computed for a test run (e.g. from a job in
+ * the customer's CI after the run completes). May be called only once per test
+ * run — a second call fails. Pair with {@link findTestRunByCommitAndWaitForCompletion}
+ * and `getSnapshotsFromTestRun` to write a custom check from any script.
+ */
+const reportCustomCheckResults = async ({ client, testRunId, results, }) => {
+    await client
+        .post(`test-runs/${testRunId}/custom-check-results`, results)
+        .catch((error) => {
+        throw (0, client_1.maybeEnrichFetchError)(error);
+    });
+};
+exports.reportCustomCheckResults = reportCustomCheckResults;
+//# sourceMappingURL=report-custom-check-results.js.map

package/dist/report-custom-check-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-custom-check-results.js","sourceRoot":"","sources":["../src/report-custom-check-results.ts"],"names":[],"mappings":";;;AACA,qDAGkC;AAalC;;;;;GAKG;AACI,MAAM,wBAAwB,GAAG,KAAK,EAAE,EAC7C,MAAM,EACN,SAAS,EACT,OAAO,GACyB,EAAiB,EAAE;IACnD,MAAM,MAAM;SACT,IAAI,CAAC,aAAa,SAAS,uBAAuB,EAAE,OAAO,CAAC;SAC5D,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAVW,QAAA,wBAAwB,4BAUnC"}

package/dist/wait-for-test-run.d.ts

@@ -0,0 +1,34 @@
+import type { TestRun } from "@alwaysmeticulous/api";
+import { type MeticulousClient } from "@alwaysmeticulous/client";
+export interface WaitForTestRunCompletionOptions {
+    /** How often to poll the test run's status, in ms. Defaults to 10000. */
+    pollIntervalMs?: number;
+    /**
+     * Maximum time to wait for the test run to complete before throwing, in ms.
+     * Defaults to 30 minutes.
+     */
+    timeoutMs?: number;
+}
+export interface WaitForTestRunResult {
+    testRunId: string;
+    testRun: TestRun;
+}
+export type FindTestRunByCommitAndWaitForCompletionOptions = WaitForTestRunCompletionOptions & {
+    client: MeticulousClient;
+    commitSha: string;
+};
+/**
+ * Resolves the latest test run for a commit and waits for it to reach a terminal
+ * status, returning it. Throws if no test run exists for the commit, or if it
+ * does not complete within the timeout.
+ */
+export declare const findTestRunByCommitAndWaitForCompletion: ({ client, commitSha, ...waitOptions }: FindTestRunByCommitAndWaitForCompletionOptions) => Promise<WaitForTestRunResult>;
+export type FindTestRunByIdAndWaitForCompletionOptions = WaitForTestRunCompletionOptions & {
+    client: MeticulousClient;
+    testRunId: string;
+};
+/**
+ * Waits for a known test run to reach a terminal status, returning it. Throws if
+ * it does not complete within the timeout.
+ */
+export declare const findTestRunByIdAndWaitForCompletion: ({ client, testRunId, pollIntervalMs, timeoutMs, }: FindTestRunByIdAndWaitForCompletionOptions) => Promise<WaitForTestRunResult>;

package/dist/wait-for-test-run.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findTestRunByIdAndWaitForCompletion = exports.findTestRunByCommitAndWaitForCompletion = void 0;
+const client_1 = require("@alwaysmeticulous/client");
+const common_1 = require("@alwaysmeticulous/common");
+// Mirrors the base-test-run polling in the SDK's `pollWhileBaseNotFound`: poll on
+// a fixed interval, cap the total wait, and log progress at most once per
+// PROGRESS_LOG_INTERVAL_MS so a long-running script isn't silent.
+const DEFAULT_POLL_INTERVAL_MS = 10_000;
+const DEFAULT_TIMEOUT_MS = 30 * 60 * 1_000;
+const PROGRESS_LOG_INTERVAL_MS = 30_000;
+/**
+ * Resolves the latest test run for a commit and waits for it to reach a terminal
+ * status, returning it. Throws if no test run exists for the commit, or if it
+ * does not complete within the timeout.
+ */
+const findTestRunByCommitAndWaitForCompletion = async ({ client, commitSha, ...waitOptions }) => {
+    const latest = await (0, client_1.getLatestTestRunResults)({ client, commitSha });
+    if (!latest) {
+        throw new Error(`No test run found for commit ${commitSha}. A test run must be triggered for the commit before its custom check results can be reported.`);
+    }
+    (0, common_1.initLogger)().info(`Found test run ${latest.id} for commit ${commitSha}; waiting for it to complete...`);
+    return (0, exports.findTestRunByIdAndWaitForCompletion)({
+        client,
+        testRunId: latest.id,
+        ...waitOptions,
+    });
+};
+exports.findTestRunByCommitAndWaitForCompletion = findTestRunByCommitAndWaitForCompletion;
+/**
+ * Waits for a known test run to reach a terminal status, returning it. Throws if
+ * it does not complete within the timeout.
+ */
+const findTestRunByIdAndWaitForCompletion = async ({ client, testRunId, pollIntervalMs = DEFAULT_POLL_INTERVAL_MS, timeoutMs = DEFAULT_TIMEOUT_MS, }) => {
+    const logger = (0, common_1.initLogger)();
+    const startTime = Date.now();
+    let lastLoggedElapsedMs = 0;
+    for (;;) {
+        const testRun = await (0, client_1.getTestRun)({ client, testRunId });
+        // Done once the run leaves the in-progress states — matching how the rest of
+        // the SDK determines completion. This also returns for `Partial` (lazy
+        // session pools), which is terminal enough and would otherwise hang here
+        // until the timeout.
+        if (!client_1.IN_PROGRESS_TEST_RUN_STATUS.includes(testRun.status)) {
+            return { testRunId: testRun.id, testRun };
+        }
+        const elapsedMs = Date.now() - startTime;
+        if (elapsedMs > timeoutMs) {
+            throw new Error(`Timed out after ${Math.round(timeoutMs / 1000)}s waiting for test run ${testRunId} to complete (current status: ${testRun.status}).`);
+        }
+        // Log progress at most once every PROGRESS_LOG_INTERVAL_MS (mirroring the
+        // base-test-run wait) so a script blocked here for minutes isn't silent.
+        if (lastLoggedElapsedMs === 0 ||
+            elapsedMs - lastLoggedElapsedMs >= PROGRESS_LOG_INTERVAL_MS) {
+            logger.info(`Waiting for test run ${testRunId} to complete (current status: ${testRun.status}). Time elapsed: ${Math.round(elapsedMs / 1000)}s`);
+            lastLoggedElapsedMs = elapsedMs;
+        }
+        await sleep(pollIntervalMs);
+    }
+};
+exports.findTestRunByIdAndWaitForCompletion = findTestRunByIdAndWaitForCompletion;
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+//# sourceMappingURL=wait-for-test-run.js.map

package/dist/wait-for-test-run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait-for-test-run.js","sourceRoot":"","sources":["../src/wait-for-test-run.ts"],"names":[],"mappings":";;;AACA,qDAKkC;AAClC,qDAAsD;AAEtD,kFAAkF;AAClF,0EAA0E;AAC1E,kEAAkE;AAClE,MAAM,wBAAwB,GAAG,MAAM,CAAC;AACxC,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;AAC3C,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAuBxC;;;;GAIG;AACI,MAAM,uCAAuC,GAAG,KAAK,EAAE,EAC5D,MAAM,EACN,SAAS,EACT,GAAG,WAAW,EACiC,EAAiC,EAAE;IAClF,MAAM,MAAM,GAAG,MAAM,IAAA,gCAAuB,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACpE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,gCAAgC,SAAS,gGAAgG,CAC1I,CAAC;IACJ,CAAC;IACD,IAAA,mBAAU,GAAE,CAAC,IAAI,CACf,kBAAkB,MAAM,CAAC,EAAE,eAAe,SAAS,iCAAiC,CACrF,CAAC;IACF,OAAO,IAAA,2CAAmC,EAAC;QACzC,MAAM;QACN,SAAS,EAAE,MAAM,CAAC,EAAE;QACpB,GAAG,WAAW;KACf,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,uCAAuC,2CAmBlD;AAQF;;;GAGG;AACI,MAAM,mCAAmC,GAAG,KAAK,EAAE,EACxD,MAAM,EACN,SAAS,EACT,cAAc,GAAG,wBAAwB,EACzC,SAAS,GAAG,kBAAkB,GACa,EAAiC,EAAE;IAC9E,MAAM,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAC;IAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,IAAI,mBAAmB,GAAG,CAAC,CAAC;IAE5B,SAAS,CAAC;QACR,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAU,EAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACxD,6EAA6E;QAC7E,uEAAuE;QACvE,yEAAyE;QACzE,qBAAqB;QACrB,IAAI,CAAC,oCAA2B,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC;QAC5C,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QACzC,IAAI,SAAS,GAAG,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,mBAAmB,IAAI,CAAC,KAAK,CAC3B,SAAS,GAAG,IAAI,CACjB,0BAA0B,SAAS,iCAAiC,OAAO,CAAC,MAAM,IAAI,CACxF,CAAC;QACJ,CAAC;QAED,0EAA0E;QAC1E,yEAAyE;QACzE,IACE,mBAAmB,KAAK,CAAC;YACzB,SAAS,GAAG,mBAAmB,IAAI,wBAAwB,EAC3D,CAAC;YACD,MAAM,CAAC,IAAI,CACT,wBAAwB,SAAS,iCAAiC,OAAO,CAAC,MAAM,oBAAoB,IAAI,CAAC,KAAK,CAC5G,SAAS,GAAG,IAAI,CACjB,GAAG,CACL,CAAC;YACF,mBAAmB,GAAG,SAAS,CAAC;QAClC,CAAC;QAED,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC,CAAC;AA7CW,QAAA,mCAAmC,uCA6C9C;AAEF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAiB,EAAE,CAC1C,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@alwaysmeticulous/custom-checks",
+  "version": "2.290.0",
+  "description": "Helpers for writing Meticulous custom checks: fetch snapshots, wait for a test run, and report results from any script",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "build": "tsc --build tsconfig.json",
+    "dev": "tsc --build tsconfig.json --watch",
+    "format": "prettier --write src",
+    "lint": "eslint \"src/**/*.{js,ts,tsx}\"  --cache",
+    "lint:commit": "eslint --cache $(git diff --relative --name-only --diff-filter=ACMRTUXB master | grep  -E \"(.js$|.ts$|.tsx$)\")",
+    "lint:fix": "eslint \"src/**/*.{js,ts,tsx}\"  --cache --fix",
+    "depcheck": "depcheck --ignore-patterns=dist",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@alwaysmeticulous/api": "workspace:*",
+    "@alwaysmeticulous/client": "workspace:*",
+    "@alwaysmeticulous/common": "workspace:*"
+  },
+  "devDependencies": {
+    "vitest": "catalog:"
+  },
+  "author": {
+    "name": "The Meticulous Team",
+    "email": "eng@meticulous.ai",
+    "url": "https://meticulous.ai"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "homepage": "https://github.com/alwaysmeticulous/meticulous-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alwaysmeticulous/meticulous-sdk.git",
+    "directory": "packages/custom-checks"
+  },
+  "bugs": {
+    "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
+  }
+}