@clipboard-health/playwright-toolkit 1.0.0

package/src/lib/deployedAssets.js

@@ -0,0 +1,348 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyDeployedAssets = verifyDeployedAssets;
+exports.waitForDeployedAssets = waitForDeployedAssets;
+const node_perf_hooks_1 = require("node:perf_hooks");
+const util_ts_1 = require("@clipboard-health/util-ts");
+const retry_1 = require("./retry");
+const setupRetry_1 = require("./setupRetry");
+const DEFAULT_CONCURRENCY_LIMIT = 5;
+const DEFAULT_FETCH_TIMEOUT_MS = 10_000;
+const DEFAULT_RETRY_ATTEMPTS = 3;
+const DEFAULT_RETRY_DELAY_MS = 500;
+const DEFAULT_POLL_INTERVAL_MS = 10_000;
+const CACHE_BUST_QUERY_PARAMETER = "cbhAssetVerifier";
+class AssetAttemptFailure extends Error {
+    attempt;
+    isTransient;
+    constructor(params) {
+        super(params.message);
+        this.name = "AssetAttemptFailure";
+        this.attempt = params.attempt;
+        this.isTransient = params.isTransient;
+    }
+}
+class AssetGraphNotReadyError extends Error {
+}
+/**
+ * Checks a repo-supplied deployed asset graph with bounded concurrency and
+ * classified per-asset retries. Discovery and asset classification remain in
+ * thin repo wrappers.
+ */
+async function verifyDeployedAssets(params) {
+    const concurrencyLimit = params.concurrencyLimit ?? DEFAULT_CONCURRENCY_LIMIT;
+    if (!Number.isInteger(concurrencyLimit) || concurrencyLimit < 1) {
+        throw new Error("concurrencyLimit must be a positive integer");
+    }
+    const results = Array.from({
+        length: params.checks.length,
+    });
+    let nextIndex = 0;
+    async function worker() {
+        for (;;) {
+            const index = nextIndex;
+            nextIndex += 1;
+            if (index >= params.checks.length) {
+                return;
+            }
+            const check = params.checks[index];
+            if (check === undefined) {
+                return;
+            }
+            // eslint-disable-next-line no-await-in-loop -- Each worker consumes one bounded queue item at a time.
+            results[index] = await verifyDeployedAsset({ check, options: params });
+        }
+    }
+    await Promise.all(Array.from({ length: Math.min(concurrencyLimit, params.checks.length) }, worker));
+    const completedResults = results.filter(util_ts_1.isDefined);
+    const failureCount = completedResults.filter((result) => !result.isSuccess).length;
+    return {
+        results: completedResults,
+        summary: {
+            failureCount,
+            passedCount: completedResults.length - failureCount,
+            totalCount: completedResults.length,
+        },
+    };
+}
+/**
+ * Polls the whole graph until it is healthy for an optional stable window.
+ */
+async function waitForDeployedAssets(params) {
+    const nowImplementation = params.nowImplementation ?? Date.now;
+    const stableWindowMs = params.stableWindowMs ?? 0;
+    let stableWindowStartedAtMs;
+    let lastReport;
+    const result = await (0, retry_1.runWithRetry)({
+        operationName: "wait for deployed asset graph",
+        operation: async () => {
+            lastReport = await verifyDeployedAssets(params);
+            const nowMs = nowImplementation();
+            if (lastReport.summary.failureCount > 0) {
+                stableWindowStartedAtMs = undefined;
+                throw new AssetGraphNotReadyError(`Deployed asset graph has ${lastReport.summary.failureCount} failure(s)`);
+            }
+            stableWindowStartedAtMs ??= nowMs;
+            const stableWindowElapsedMs = nowMs - stableWindowStartedAtMs;
+            if (stableWindowElapsedMs < stableWindowMs) {
+                throw new AssetGraphNotReadyError(`Deployed asset graph is healthy for ${stableWindowElapsedMs}ms; ` +
+                    `${stableWindowMs}ms required`);
+            }
+            return {
+                report: lastReport,
+                stableWindowElapsedMs,
+            };
+        },
+        mode: {
+            kind: "poll",
+            timeoutMs: params.timeoutMs,
+            intervalsMs: [params.pollIntervalMs ?? DEFAULT_POLL_INTERVAL_MS],
+            isTransient: ({ error }) => error instanceof AssetGraphNotReadyError,
+        },
+        nowImplementation,
+        sleepImplementation: params.sleepImplementation,
+    });
+    return {
+        ...result.value.report,
+        wait: {
+            attempts: result.attempts,
+            isStableWindowSatisfied: true,
+            stableWindowElapsedMs: result.value.stableWindowElapsedMs,
+        },
+    };
+}
+async function verifyDeployedAsset(params) {
+    const attempts = [];
+    const maxAttempts = params.options.retry?.maxAttempts ?? DEFAULT_RETRY_ATTEMPTS;
+    const reportCheck = toDeployedAssetReportCheck(params.check);
+    try {
+        const result = await (0, retry_1.runWithRetry)({
+            operationName: `verify deployed asset ${params.check.path}`,
+            operation: async ({ attemptNumber }) => {
+                try {
+                    const attempt = await checkAssetOnce({
+                        attemptNumber,
+                        check: params.check,
+                        fetchImplementation: params.options.fetchImplementation ?? fetch,
+                        fetchTimeoutMs: params.options.fetchTimeoutMs ?? DEFAULT_FETCH_TIMEOUT_MS,
+                        nowImplementation: params.options.nowImplementation ?? (() => node_perf_hooks_1.performance.now()),
+                    });
+                    attempts.push(attempt);
+                    return attempt;
+                }
+                catch (error) {
+                    if (error instanceof AssetAttemptFailure) {
+                        attempts.push(error.attempt);
+                    }
+                    throw error;
+                }
+            },
+            mode: {
+                kind: "classified",
+                maxAttempts,
+                delayMs: params.options.retry?.delayMs ?? DEFAULT_RETRY_DELAY_MS,
+                isTransient: ({ error }) => error instanceof AssetAttemptFailure && error.isTransient,
+            },
+            sleepImplementation: params.options.sleepImplementation,
+            nowImplementation: params.options.nowImplementation,
+        });
+        const finalAttempt = result.value;
+        return {
+            attempts,
+            check: reportCheck,
+            ...(finalAttempt.contentType === undefined ? {} : { contentType: finalAttempt.contentType }),
+            isSuccess: true,
+            ...(finalAttempt.status === undefined ? {} : { status: finalAttempt.status }),
+        };
+    }
+    catch (error) {
+        const failure = getAssetAttemptFailure({ error });
+        const finalAttempt = attempts.at(-1);
+        return {
+            attempts,
+            check: reportCheck,
+            ...(finalAttempt?.contentType === undefined ? {} : { contentType: finalAttempt.contentType }),
+            errorMessage: failure?.message ?? (0, util_ts_1.toErrorMessage)(error),
+            isSuccess: false,
+            ...(finalAttempt?.status === undefined ? {} : { status: finalAttempt.status }),
+        };
+    }
+}
+async function checkAssetOnce(params) {
+    const requestUrl = getRequestUrl({
+        attemptNumber: params.attemptNumber,
+        check: params.check,
+    });
+    const abortController = new AbortController();
+    const timeout = setTimeout(() => {
+        abortController.abort();
+    }, params.fetchTimeoutMs);
+    const startedAtMs = params.nowImplementation();
+    try {
+        let response;
+        try {
+            response = await params.fetchImplementation(requestUrl, {
+                ...getRequestInit({ check: params.check }),
+                method: params.check.method ?? "GET",
+                signal: abortController.signal,
+            });
+        }
+        catch (error) {
+            const message = (0, util_ts_1.toErrorMessage)(error);
+            throw new AssetAttemptFailure({
+                attempt: {
+                    attemptNumber: params.attemptNumber,
+                    durationMs: params.nowImplementation() - startedAtMs,
+                    errorMessage: message,
+                    url: requestUrl,
+                },
+                isTransient: isTransientFetchError({ error }),
+                message,
+            });
+        }
+        const contentType = response.headers.get("content-type") ?? undefined;
+        const attempt = {
+            attemptNumber: params.attemptNumber,
+            ...(contentType === undefined ? {} : { contentType }),
+            durationMs: params.nowImplementation() - startedAtMs,
+            status: response.status,
+            url: requestUrl,
+        };
+        if (!response.ok) {
+            const message = `expected HTTP 2xx but received HTTP ${response.status}`;
+            throw new AssetAttemptFailure({
+                attempt: { ...attempt, errorMessage: message },
+                isTransient: isTransientAssetStatus({ status: response.status }),
+                message,
+            });
+        }
+        if (params.check.expectedContentTypes !== undefined &&
+            !isExpectedContentType({
+                actualContentType: contentType,
+                expectedContentTypes: params.check.expectedContentTypes,
+            })) {
+            const message = `expected content-type ${params.check.expectedContentTypes.join(" or ")} ` +
+                `but received ${contentType ?? "none"}`;
+            throw new AssetAttemptFailure({
+                attempt: { ...attempt, errorMessage: message },
+                isTransient: false,
+                message,
+            });
+        }
+        if (params.check.validateResponse !== undefined) {
+            let validation;
+            try {
+                validation = await params.check.validateResponse({ response });
+            }
+            catch (error) {
+                const message = (0, util_ts_1.toErrorMessage)(error);
+                throw new AssetAttemptFailure({
+                    attempt: { ...attempt, errorMessage: message },
+                    isTransient: isTransientFetchError({ error }),
+                    message,
+                });
+            }
+            if (!validation.isValid) {
+                const message = validation.message ?? "custom deployed asset validation failed";
+                throw new AssetAttemptFailure({
+                    attempt: { ...attempt, errorMessage: message },
+                    isTransient: validation.isTransient ?? false,
+                    message,
+                });
+            }
+        }
+        return attempt;
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+function getRequestUrl(params) {
+    const url = new URL(params.check.url);
+    if ((params.check.cacheMode ?? "normal") === "normal") {
+        return url.toString();
+    }
+    url.searchParams.set(CACHE_BUST_QUERY_PARAMETER, `${Date.now()}-${params.attemptNumber}`);
+    return url.toString();
+}
+function getRequestInit(params) {
+    if ((params.check.cacheMode ?? "normal") === "normal") {
+        return params.check.headers === undefined ? {} : { headers: params.check.headers };
+    }
+    return {
+        cache: "no-store",
+        headers: {
+            "cache-control": "no-cache",
+            pragma: "no-cache",
+            ...params.check.headers,
+        },
+    };
+}
+function isTransientAssetStatus(params) {
+    return params.status === 425 || (0, setupRetry_1.isRetryableHttpStatus)({ status: params.status });
+}
+function isTransientFetchError(params) {
+    const inspectedErrors = new Set();
+    let error = params.error;
+    while ((0, util_ts_1.isRecord)(error) && !inspectedErrors.has(error)) {
+        inspectedErrors.add(error);
+        if (error["name"] === "AbortError" ||
+            error["code"] === "ECONNREFUSED" ||
+            error["code"] === "ECONNRESET" ||
+            error["code"] === "EAI_AGAIN" ||
+            error["code"] === "ENOTFOUND" ||
+            error["code"] === "ETIMEDOUT") {
+            return true;
+        }
+        error = error["cause"];
+    }
+    const normalizedMessage = (0, util_ts_1.toErrorMessage)(params.error).toLowerCase();
+    return (normalizedMessage.includes("failed to fetch") ||
+        normalizedMessage.includes("fetch failed") ||
+        normalizedMessage.includes("networkerror"));
+}
+function isExpectedContentType(params) {
+    if (params.actualContentType === undefined) {
+        return false;
+    }
+    const actualContentType = normalizeContentType(params.actualContentType);
+    const expectedContentTypes = params.expectedContentTypes.flatMap(getEquivalentContentTypes);
+    return expectedContentTypes.includes(actualContentType);
+}
+function getEquivalentContentTypes(contentType) {
+    const normalized = normalizeContentType(contentType);
+    if (normalized === "application/javascript" || normalized === "text/javascript") {
+        return ["application/javascript", "text/javascript"];
+    }
+    if (normalized === "application/json" || normalized === "application/manifest+json") {
+        return ["application/json", "application/manifest+json"];
+    }
+    if (normalized === "image/x-icon" || normalized === "image/vnd.microsoft.icon") {
+        return ["image/x-icon", "image/vnd.microsoft.icon"];
+    }
+    return [normalized];
+}
+function toDeployedAssetReportCheck(check) {
+    return {
+        path: check.path,
+        url: check.url,
+        ...(check.method === undefined ? {} : { method: check.method }),
+        ...(check.cacheMode === undefined ? {} : { cacheMode: check.cacheMode }),
+        ...(check.expectedContentTypes === undefined
+            ? {}
+            : { expectedContentTypes: check.expectedContentTypes }),
+    };
+}
+function normalizeContentType(contentType) {
+    return contentType.split(";")[0]?.trim().toLowerCase() ?? "";
+}
+function getAssetAttemptFailure(params) {
+    if (params.error instanceof AssetAttemptFailure) {
+        return params.error;
+    }
+    if (params.error instanceof retry_1.RetryError && params.error.cause instanceof AssetAttemptFailure) {
+        return params.error.cause;
+    }
+    return undefined;
+}
+//# sourceMappingURL=deployedAssets.js.map

package/src/lib/deployedAssets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployedAssets.js","sourceRoot":"","sources":["../../../../../packages/playwright-toolkit/src/lib/deployedAssets.ts"],"names":[],"mappings":";;;;AAAA,qDAA8C;AAE9C,uDAAmG;AAEnG,mCAAmD;AACnD,6CAAqD;AAErD,MAAM,yBAAyB,GAAG,CAAC,CAAC;AACpC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AACxC,MAAM,sBAAsB,GAAG,CAAC,CAAC;AACjC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AACxC,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAwFtD,MAAM,mBAAoB,SAAQ,KAAK;IACrB,OAAO,CAAuB;IAC9B,WAAW,CAAU;IAErC,YAAmB,MAAiC;QAClD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IACxC,CAAC;CACF;AAED,MAAM,uBAAwB,SAAQ,KAAK;CAAG;AAE9C;;;;GAIG;AACI,KAAK,+BACV,MAAkC;IAElC,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,yBAAyB,CAAC;IAC9E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,OAAO,GAA2C,KAAK,CAAC,IAAI,CAAC;QACjE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;KAC7B,CAAC,CAAC;IACH,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,KAAK,UAAU,MAAM;QACnB,SAAS,CAAC;YACR,MAAM,KAAK,GAAG,SAAS,CAAC;YACxB,SAAS,IAAI,CAAC,CAAC;YAEf,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClC,OAAO;YACT,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO;YACT,CAAC;YAED,sGAAsG;YACtG,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,mBAAmB,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CACjF,CAAC;IAEF,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,mBAAS,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;IAEnF,OAAO;QACL,OAAO,EAAE,gBAAgB;QACzB,OAAO,EAAE;YACP,YAAY;YACZ,WAAW,EAAE,gBAAgB,CAAC,MAAM,GAAG,YAAY;YACnD,UAAU,EAAE,gBAAgB,CAAC,MAAM;SACpC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACI,KAAK,gCACV,MAAmC;IAEnC,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,IAAI,CAAC,GAAG,CAAC;IAC/D,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC;IAClD,IAAI,uBAA2C,CAAC;IAChD,IAAI,UAAuD,CAAC;IAE5D,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAY,EAAC;QAChC,aAAa,EAAE,+BAA+B;QAC9C,SAAS,EAAE,KAAK,IAAI,EAAE;YACpB,UAAU,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,KAAK,GAAG,iBAAiB,EAAE,CAAC;YAElC,IAAI,UAAU,CAAC,OAAO,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;gBACxC,uBAAuB,GAAG,SAAS,CAAC;gBACpC,MAAM,IAAI,uBAAuB,CAC/B,4BAA4B,UAAU,CAAC,OAAO,CAAC,YAAY,aAAa,CACzE,CAAC;YACJ,CAAC;YAED,uBAAuB,KAAK,KAAK,CAAC;YAClC,MAAM,qBAAqB,GAAG,KAAK,GAAG,uBAAuB,CAAC;YAE9D,IAAI,qBAAqB,GAAG,cAAc,EAAE,CAAC;gBAC3C,MAAM,IAAI,uBAAuB,CAC/B,uCAAuC,qBAAqB,MAAM;oBAChE,GAAG,cAAc,aAAa,CACjC,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,MAAM,EAAE,UAAU;gBAClB,qBAAqB;aACtB,CAAC;QACJ,CAAC;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,WAAW,EAAE,CAAC,MAAM,CAAC,cAAc,IAAI,wBAAwB,CAAC;YAChE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,YAAY,uBAAuB;SACrE;QACD,iBAAiB;QACjB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;KAChD,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM;QACtB,IAAI,EAAE;YACJ,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,uBAAuB,EAAE,IAAI;YAC7B,qBAAqB,EAAE,MAAM,CAAC,KAAK,CAAC,qBAAqB;SAC1D;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,mBAAmB,CAAC,MAGlC;IACC,MAAM,QAAQ,GAA2B,EAAE,CAAC;IAC5C,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,IAAI,sBAAsB,CAAC;IAChF,MAAM,WAAW,GAAG,0BAA0B,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAE7D,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAY,EAAuB;YACtD,aAAa,EAAE,yBAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE;YAC3D,SAAS,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE;gBACrC,IAAI,CAAC;oBACH,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC;wBACnC,aAAa;wBACb,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,mBAAmB,EAAE,MAAM,CAAC,OAAO,CAAC,mBAAmB,IAAI,KAAK;wBAChE,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC,cAAc,IAAI,wBAAwB;wBACzE,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,iBAAiB,IAAI,CAAC,GAAG,EAAE,CAAC,6BAAW,CAAC,GAAG,EAAE,CAAC;qBACjF,CAAC,CAAC;oBACH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACvB,OAAO,OAAO,CAAC;gBACjB,CAAC;gBAAC,OAAO,KAAc,EAAE,CAAC;oBACxB,IAAI,KAAK,YAAY,mBAAmB,EAAE,CAAC;wBACzC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC/B,CAAC;oBAED,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,YAAY;gBAClB,WAAW;gBACX,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,sBAAsB;gBAChE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,YAAY,mBAAmB,IAAI,KAAK,CAAC,WAAW;aACtF;YACD,mBAAmB,EAAE,MAAM,CAAC,OAAO,CAAC,mBAAmB;YACvD,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,iBAAiB;SACpD,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC;QAElC,OAAO;YACL,QAAQ;YACR,KAAK,EAAE,WAAW;YAClB,GAAG,CAAC,YAAY,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,WAAW,EAAE,CAAC;YAC5F,SAAS,EAAE,IAAI;YACf,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC;SAC9E,CAAC;IACJ,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,sBAAsB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAErC,OAAO;YACL,QAAQ;YACR,KAAK,EAAE,WAAW;YAClB,GAAG,CAAC,YAAY,EAAE,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,WAAW,EAAE,CAAC;YAC7F,YAAY,EAAE,OAAO,EAAE,OAAO,IAAI,IAAA,wBAAe,EAAC,KAAK,CAAC;YACxD,SAAS,EAAE,KAAK;YAChB,GAAG,CAAC,YAAY,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC;SAC/E,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,MAM7B;IACC,MAAM,UAAU,GAAG,aAAa,CAAC;QAC/B,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,KAAK,EAAE,MAAM,CAAC,KAAK;KACpB,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;QAC9B,eAAe,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;IAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAE/C,IAAI,CAAC;QACH,IAAI,QAAkB,CAAC;QAEvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE;gBACtD,GAAG,cAAc,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC1C,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK;gBACpC,MAAM,EAAE,eAAe,CAAC,MAAM;aAC/B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,IAAA,wBAAe,EAAC,KAAK,CAAC,CAAC;YACvC,MAAM,IAAI,mBAAmB,CAAC;gBAC5B,OAAO,EAAE;oBACP,aAAa,EAAE,MAAM,CAAC,aAAa;oBACnC,UAAU,EAAE,MAAM,CAAC,iBAAiB,EAAE,GAAG,WAAW;oBACpD,YAAY,EAAE,OAAO;oBACrB,GAAG,EAAE,UAAU;iBAChB;gBACD,WAAW,EAAE,qBAAqB,CAAC,EAAE,KAAK,EAAE,CAAC;gBAC7C,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;QACtE,MAAM,OAAO,GAAyB;YACpC,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;YACrD,UAAU,EAAE,MAAM,CAAC,iBAAiB,EAAE,GAAG,WAAW;YACpD,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,GAAG,EAAE,UAAU;SAChB,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,OAAO,GAAG,uCAAuC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzE,MAAM,IAAI,mBAAmB,CAAC;gBAC5B,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE;gBAC9C,WAAW,EAAE,sBAAsB,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAChE,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,IACE,MAAM,CAAC,KAAK,CAAC,oBAAoB,KAAK,SAAS;YAC/C,CAAC,qBAAqB,CAAC;gBACrB,iBAAiB,EAAE,WAAW;gBAC9B,oBAAoB,EAAE,MAAM,CAAC,KAAK,CAAC,oBAAoB;aACxD,CAAC,EACF,CAAC;YACD,MAAM,OAAO,GACX,yBAAyB,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG;gBAC1E,gBAAgB,WAAW,IAAI,MAAM,EAAE,CAAC;YAC1C,MAAM,IAAI,mBAAmB,CAAC;gBAC5B,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE;gBAC9C,WAAW,EAAE,KAAK;gBAClB,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAChD,IAAI,UAAyC,CAAC;YAE9C,IAAI,CAAC;gBACH,UAAU,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACjE,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,MAAM,OAAO,GAAG,IAAA,wBAAe,EAAC,KAAK,CAAC,CAAC;gBACvC,MAAM,IAAI,mBAAmB,CAAC;oBAC5B,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE;oBAC9C,WAAW,EAAE,qBAAqB,CAAC,EAAE,KAAK,EAAE,CAAC;oBAC7C,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;YAED,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;gBACxB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,yCAAyC,CAAC;gBAChF,MAAM,IAAI,mBAAmB,CAAC;oBAC5B,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE;oBAC9C,WAAW,EAAE,UAAU,CAAC,WAAW,IAAI,KAAK;oBAC5C,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,MAA4D;IACjF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,0BAA0B,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;IAE1F,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAED,SAAS,cAAc,CAAC,MAAqC;IAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,QAAQ,CAAC,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACrF,CAAC;IAED,OAAO;QACL,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE;YACP,eAAe,EAAE,UAAU;YAC3B,MAAM,EAAE,UAAU;YAClB,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO;SACxB;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,MAA0B;IACxD,OAAO,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,IAAA,kCAAqB,EAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,qBAAqB,CAAC,MAA0B;IACvD,MAAM,eAAe,GAAG,IAAI,GAAG,EAAW,CAAC;IAC3C,IAAI,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAEzB,OAAO,IAAA,kBAAQ,EAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3B,IACE,KAAK,CAAC,MAAM,CAAC,KAAK,YAAY;YAC9B,KAAK,CAAC,MAAM,CAAC,KAAK,cAAc;YAChC,KAAK,CAAC,MAAM,CAAC,KAAK,YAAY;YAC9B,KAAK,CAAC,MAAM,CAAC,KAAK,WAAW;YAC7B,KAAK,CAAC,MAAM,CAAC,KAAK,WAAW;YAC7B,KAAK,CAAC,MAAM,CAAC,KAAK,WAAW,EAC7B,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,iBAAiB,GAAG,IAAA,wBAAe,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IACtE,OAAO,CACL,iBAAiB,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAC7C,iBAAiB,CAAC,QAAQ,CAAC,cAAc,CAAC;QAC1C,iBAAiB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,MAG9B;IACC,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACzE,MAAM,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAE5F,OAAO,oBAAoB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,yBAAyB,CAAC,WAAmB;IACpD,MAAM,UAAU,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAErD,IAAI,UAAU,KAAK,wBAAwB,IAAI,UAAU,KAAK,iBAAiB,EAAE,CAAC;QAChF,OAAO,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,UAAU,KAAK,kBAAkB,IAAI,UAAU,KAAK,2BAA2B,EAAE,CAAC;QACpF,OAAO,CAAC,kBAAkB,EAAE,2BAA2B,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,UAAU,KAAK,cAAc,IAAI,UAAU,KAAK,0BAA0B,EAAE,CAAC;QAC/E,OAAO,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,CAAC,UAAU,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,0BAA0B,CAAC,KAAyB;IAC3D,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;QAC/D,GAAG,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;QACxE,GAAG,CAAC,KAAK,CAAC,oBAAoB,KAAK,SAAS;YAC1C,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,EAAE,CAAC;KAC1D,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,WAAmB;IAC/C,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,sBAAsB,CAAC,MAA0B;IACxD,IAAI,MAAM,CAAC,KAAK,YAAY,mBAAmB,EAAE,CAAC;QAChD,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,YAAY,kBAAU,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,YAAY,mBAAmB,EAAE,CAAC;QAC5F,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/src/lib/mailpit.d.ts

@@ -0,0 +1,86 @@
+export interface MailpitAddress {
+    Address: string;
+    Name: string;
+}
+export interface MailpitMessageHeaders {
+    ID: string;
+    From: MailpitAddress;
+    To: MailpitAddress[];
+    Subject: string;
+}
+export interface MailpitMessageSummary extends MailpitMessageHeaders {
+    Created: string;
+}
+export interface MailpitMessage extends MailpitMessageHeaders {
+    Date: string;
+    Text: string;
+    HTML: string;
+}
+export interface MailpitClient {
+    searchMessages(params: {
+        query: string;
+    }): Promise<MailpitMessageSummary[]>;
+    getMessage(params: {
+        messageId: string;
+    }): Promise<MailpitMessage>;
+}
+export interface CreateMailpitClientParams {
+    password: string;
+    username?: string | undefined;
+    baseUrl?: string | undefined;
+    fetchImplementation?: typeof fetch | undefined;
+    requestTimeoutMs?: number | undefined;
+}
+export interface FetchMailpitValueResult {
+    value: string;
+    messageId: string;
+}
+export interface FetchMailpitValueParams {
+    client: MailpitClient;
+    email: string;
+    extractValue: (params: {
+        message: MailpitMessage;
+    }) => string | undefined;
+    valueLabel: string;
+    timeoutMs?: number | undefined;
+    pollIntervalMs?: number | undefined;
+    sentAfter?: Date | undefined;
+    excludedValues?: readonly string[] | undefined;
+    sleepImplementation?: ((params: {
+        durationMs: number;
+    }) => Promise<void>) | undefined;
+    nowImplementation?: (() => number) | undefined;
+}
+type MailpitPollParams = Omit<FetchMailpitValueParams, "excludedValues" | "extractValue" | "valueLabel">;
+export type FetchMagicLinkFromMailpitParams = MailpitPollParams & {
+    excludeLinks?: readonly string[] | undefined;
+};
+export type FetchEmailOtpCodeFromMailpitParams = MailpitPollParams & {
+    excludeCodes?: readonly string[] | undefined;
+};
+interface MailpitRequestErrorParams {
+    message: string;
+    status?: number | undefined;
+    cause?: unknown;
+    isTransient?: boolean | undefined;
+}
+export declare class MailpitRequestError extends Error {
+    readonly cause: unknown;
+    readonly isTransient: boolean;
+    readonly status: number | undefined;
+    constructor(params: MailpitRequestErrorParams);
+}
+export declare function createMailpitClient(params: CreateMailpitClientParams): MailpitClient;
+export declare function fetchMailpitValue(params: FetchMailpitValueParams): Promise<FetchMailpitValueResult>;
+export declare function fetchMagicLinkFromMailpit(params: FetchMagicLinkFromMailpitParams): Promise<FetchMailpitValueResult>;
+export declare function fetchEmailOtpCodeFromMailpit(params: FetchEmailOtpCodeFromMailpitParams): Promise<FetchMailpitValueResult>;
+export declare function extractMagicLinkFromMailpitMessage(params: {
+    message: MailpitMessage;
+}): string | undefined;
+export declare function extractEmailOtpCodeFromMailpitMessage(params: {
+    message: MailpitMessage;
+}): string | undefined;
+export declare function isTransientMailpitError(params: {
+    error: unknown;
+}): boolean;
+export {};