@apifuse/provider-sdk 2.2.0-beta.22 → 2.2.0-beta.24

package/dist/runtime/resolver-vendors/bindings.js

@@ -0,0 +1,15 @@
+export const RESOLVER_CHALLENGE_BINDINGS = {
+    aws_waf: "portable",
+    cloudflare_interstitial: "identity_scoped",
+};
+export function resolverChallengeIsIdentityScoped(challenge) {
+    return (RESOLVER_CHALLENGE_BINDINGS[challenge.kind] ===
+        "identity_scoped");
+}
+export function resolverChallengeIssuingIdentity(challenge, identity) {
+    const binding = RESOLVER_CHALLENGE_BINDINGS[challenge.kind];
+    if (binding === "portable") {
+        return { userAgent: identity.userAgent };
+    }
+    return identity;
+}

package/dist/runtime/resolver-vendors/browser.d.ts

@@ -0,0 +1,24 @@
+import type { BrowserClient, ChallengeSolution, ProviderChallenge } from "../../types.js";
+import { type BrowserClientOptions } from "../browser.js";
+import type { TraceRecorder } from "../trace.js";
+import { type ResolverIdentity, type ResolverVendorAdapter } from "./types.js";
+type BrowserClientFactory = (options: BrowserClientOptions) => BrowserClient;
+export interface BrowserResolverVendorOptions {
+    readonly cdpUrl?: string;
+    readonly timeoutMs: number;
+    readonly pollIntervalMs?: number;
+    readonly allowedHosts: readonly string[];
+    readonly createClient?: BrowserClientFactory;
+}
+export type BrowserResolverSolution = Extract<ChallengeSolution, {
+    readonly form: "cookies";
+}> & {
+    /** Unix seconds from the cookie that proved the challenge cleared. */
+    readonly expires?: number;
+};
+export interface BrowserResolverVendorAdapter extends ResolverVendorAdapter {
+    readonly id: "browser";
+    solve(challenge: ProviderChallenge, identity: ResolverIdentity | undefined, signal: AbortSignal, traceRecorder?: TraceRecorder): Promise<BrowserResolverSolution>;
+}
+export declare function createBrowserResolverVendorAdapter(options: BrowserResolverVendorOptions): BrowserResolverVendorAdapter;
+export {};

package/dist/runtime/resolver-vendors/browser.js

@@ -0,0 +1,287 @@
+import { isProviderError, ProviderError } from "../../errors.js";
+import { createBrowserClient } from "../browser.js";
+import { resolverChallengeIssuingIdentity } from "./bindings.js";
+import { ResolverVendorUnavailableError, } from "./types.js";
+const BROWSER_VENDOR_ID = "browser";
+const DEFAULT_COOKIE_POLL_INTERVAL_MS = 100;
+const SUCCESS_COOKIE_NAMES = {
+    aws_waf: "aws-waf-token",
+    cloudflare_interstitial: "cf_clearance",
+};
+class BrowserSolveTimeoutError extends Error {
+    constructor() {
+        super("Browser resolver solve budget elapsed");
+        this.name = "BrowserSolveTimeoutError";
+    }
+}
+class BrowserCleanupTimeoutError extends Error {
+    constructor(timeoutMs) {
+        super(`Browser resolver cleanup exceeded ${timeoutMs}ms`);
+        this.name = "BrowserCleanupTimeoutError";
+    }
+}
+function abortReason(signal) {
+    return signal.reason ?? new DOMException("The operation was aborted", "AbortError");
+}
+function raceWithAbort(operation, signal) {
+    if (signal.aborted) {
+        return Promise.reject(abortReason(signal));
+    }
+    return new Promise((resolve, reject) => {
+        const cleanup = () => signal.removeEventListener("abort", onAbort);
+        const onAbort = () => {
+            cleanup();
+            reject(abortReason(signal));
+        };
+        signal.addEventListener("abort", onAbort, { once: true });
+        operation().then((value) => {
+            cleanup();
+            resolve(value);
+        }, (error) => {
+            cleanup();
+            reject(error);
+        });
+    });
+}
+async function runBoundedCleanup(cleanup, timeoutMs, challengeKind, operation, traceRecorder) {
+    let timeout;
+    const boundedCleanup = async () => {
+        try {
+            await Promise.race([
+                cleanup(),
+                new Promise((_resolve, reject) => {
+                    timeout = setTimeout(() => reject(new BrowserCleanupTimeoutError(timeoutMs)), timeoutMs);
+                }),
+            ]);
+        }
+        finally {
+            if (timeout !== undefined)
+                clearTimeout(timeout);
+        }
+    };
+    if (!traceRecorder) {
+        await boundedCleanup().catch(() => undefined);
+        return;
+    }
+    await traceRecorder
+        .runSpan("resolver.vendor.cleanup", boundedCleanup, {
+        attributes: {
+            vendor: BROWSER_VENDOR_ID,
+            challenge_kind: challengeKind,
+            operation,
+        },
+        onError(error) {
+            return {
+                error_message: error instanceof Error ? error.message : String(error),
+                ...(error instanceof Error && error.stack ? { error_stack: error.stack } : {}),
+            };
+        },
+    })
+        .catch(() => undefined);
+}
+async function abortableDelay(ms, signal) {
+    let timer;
+    try {
+        await raceWithAbort(() => new Promise((resolve) => {
+            timer = setTimeout(resolve, ms);
+        }), signal);
+    }
+    finally {
+        if (timer !== undefined)
+            clearTimeout(timer);
+    }
+}
+function isSupportedKind(kind) {
+    return Object.hasOwn(SUCCESS_COOKIE_NAMES, kind);
+}
+function normalizedHostname(hostname) {
+    return hostname.trim().toLowerCase().replace(/\.$/, "");
+}
+function assertChallengeHostAllowed(pageUrl, allowedHosts) {
+    const challengeHost = normalizedHostname(new URL(pageUrl).hostname);
+    const isAllowed = allowedHosts.some((host) => {
+        const declaredHost = normalizedHostname(host);
+        return declaredHost.length > 0 && !declaredHost.includes("*") && declaredHost === challengeHost;
+    });
+    if (isAllowed)
+        return;
+    throw new ProviderError(`Resolver challenge host "${challengeHost}" is not declared`, {
+        code: "RESOLVER_HOST_NOT_ALLOWED",
+        fix: "Add the exact challenge hostname to the provider's allowedHosts declaration.",
+    });
+}
+function cookieDomainSpecificity(cookie) {
+    return normalizedHostname(cookie.domain.replace(/^\./, "")).length;
+}
+function isHostOnlyCookieFor(cookie, hostname) {
+    return (!cookie.domain.startsWith(".") &&
+        normalizedHostname(cookie.domain) === normalizedHostname(hostname));
+}
+function cookieAppliesToUrl(cookie, url) {
+    const cookieDomain = normalizedHostname(cookie.domain.replace(/^\./, ""));
+    const requestHostname = normalizedHostname(url.hostname);
+    const domainMatches = cookieDomain.length > 0 &&
+        (requestHostname === cookieDomain ||
+            (cookie.domain.startsWith(".") && requestHostname.endsWith(`.${cookieDomain}`)));
+    if (!domainMatches || (cookie.secure && url.protocol !== "https:"))
+        return false;
+    const requestPath = url.pathname || "/";
+    const cookiePath = cookie.path;
+    return (cookiePath.startsWith("/") &&
+        (requestPath === cookiePath ||
+            (requestPath.startsWith(cookiePath) &&
+                (cookiePath.endsWith("/") || requestPath[cookiePath.length] === "/"))));
+}
+function selectSuccessCookie(cookies, successCookieName, pageUrl) {
+    const url = new URL(pageUrl);
+    return cookies
+        .filter((cookie) => cookie.name === successCookieName && cookieAppliesToUrl(cookie, url))
+        .sort((left, right) => Number(isHostOnlyCookieFor(right, url.hostname)) -
+        Number(isHostOnlyCookieFor(left, url.hostname)) ||
+        cookieDomainSpecificity(right) - cookieDomainSpecificity(left) ||
+        right.path.length - left.path.length)[0];
+}
+async function solveInPage(page, pageUrl, successCookieName, pollIntervalMs, signal) {
+    await raceWithAbort(() => page.goto(pageUrl), signal);
+    while (true) {
+        const cookies = await raceWithAbort(() => page.cookies(), signal);
+        const successCookie = selectSuccessCookie(cookies, successCookieName, pageUrl);
+        if (successCookie) {
+            const userAgent = await raceWithAbort(() => page.evaluate("navigator.userAgent"), signal);
+            return {
+                form: "cookies",
+                cookies: { [successCookieName]: successCookie.value },
+                userAgent,
+                ...(successCookie.expires === undefined ? {} : { expires: successCookie.expires }),
+            };
+        }
+        await abortableDelay(pollIntervalMs, signal);
+    }
+}
+const POOL_ALLOCATION_EXHAUSTED_CODES = new Set([
+    -32_001, // queue full
+    -32_002, // acquire timed out
+    -32_003, // shutting down
+]);
+function poolErrorCode(error) {
+    const code = error.code;
+    return typeof code === "number" ? code : undefined;
+}
+function knownUnavailableReason(error) {
+    // Source-grounded mappings:
+    // - apps/cdp-pool/src/index.ts: the JSON-RPC codes and messages below.
+    // - src/runtime/browser.ts: BROWSER_CDP_POOL_REQUIRED and the two WebSocket messages.
+    // The pool's numeric JSON-RPC code is authoritative and is preferred whenever present.
+    // The message substrings remain as a fallback for pool builds predating code
+    // propagation; they are exact strings verified against the pool source. -32004 (unknown
+    // lease) and -32006 (missing allowedHosts) are deliberately unmapped: both are caller
+    // bugs, and the next vendor would fail identically, so they propagate unchanged.
+    if (isProviderError(error)) {
+        return error.code === "BROWSER_CDP_POOL_REQUIRED" ? "missing_credentials" : undefined;
+    }
+    if (!(error instanceof Error))
+        return undefined;
+    const code = poolErrorCode(error);
+    if (code !== undefined) {
+        return POOL_ALLOCATION_EXHAUSTED_CODES.has(code) ? "allocation_exhausted" : undefined;
+    }
+    if (error.message.includes("CDP pool acquire queue is full") ||
+        error.message.includes("CDP pool acquire timed out") ||
+        error.message.includes("CDP pool is shutting down")) {
+        return "allocation_exhausted";
+    }
+    if (error.message.includes("Unable to connect to WebSocket endpoint") ||
+        error.message.includes("WebSocket closed")) {
+        return "transport_failure";
+    }
+    return undefined;
+}
+async function closeBrowserClient(client, timeoutMs, challengeKind, traceRecorder) {
+    const close = client?.close;
+    if (!close)
+        return;
+    await runBoundedCleanup(() => close.call(client), timeoutMs, challengeKind, "client.close", traceRecorder);
+}
+export function createBrowserResolverVendorAdapter(options) {
+    const createClient = options.createClient ?? createBrowserClient;
+    const pollIntervalMs = options.pollIntervalMs ?? DEFAULT_COOKIE_POLL_INTERVAL_MS;
+    return {
+        id: BROWSER_VENDOR_ID,
+        supports(kind) {
+            return isSupportedKind(kind);
+        },
+        getIssuingIdentity(solution, requestedIdentity, challenge) {
+            if (solution.form !== "cookies" || !isSupportedKind(challenge.kind))
+                return undefined;
+            return resolverChallengeIssuingIdentity(challenge, {
+                ...(requestedIdentity ? { proxyUrl: requestedIdentity.proxyUrl } : {}),
+                userAgent: solution.userAgent,
+            });
+        },
+        async solve(challenge, identity, callerSignal, traceRecorder) {
+            void identity;
+            if (!options.cdpUrl?.trim()) {
+                throw new ResolverVendorUnavailableError(BROWSER_VENDOR_ID, "missing_credentials");
+            }
+            if (!isSupportedKind(challenge.kind)) {
+                throw new TypeError(`Browser resolver does not support ${challenge.kind}`);
+            }
+            assertChallengeHostAllowed(challenge.pageUrl, options.allowedHosts);
+            const challengeKind = challenge.kind;
+            callerSignal.throwIfAborted();
+            const solveController = new AbortController();
+            const onCallerAbort = () => solveController.abort(abortReason(callerSignal));
+            callerSignal.addEventListener("abort", onCallerAbort, { once: true });
+            const timeout = setTimeout(() => solveController.abort(new BrowserSolveTimeoutError()), options.timeoutMs);
+            let client;
+            let handlerEntered = false;
+            try {
+                client = createClient({
+                    allowedHosts: [...options.allowedHosts],
+                    cdpUrl: options.cdpUrl.trim(),
+                    requireCdpPool: true,
+                });
+                const contextOperation = client.withIsolatedContext(async (page) => {
+                    handlerEntered = true;
+                    return await solveInPage(page, challenge.pageUrl, SUCCESS_COOKIE_NAMES[challengeKind], pollIntervalMs, solveController.signal);
+                });
+                try {
+                    return await raceWithAbort(() => contextOperation, solveController.signal);
+                }
+                catch (error) {
+                    if (solveController.signal.aborted) {
+                        if (handlerEntered) {
+                            await runBoundedCleanup(() => contextOperation, options.timeoutMs, challengeKind, "context.close", traceRecorder);
+                            throw error;
+                        }
+                        await closeBrowserClient(client, options.timeoutMs, challengeKind, traceRecorder);
+                        void contextOperation.catch(() => undefined);
+                    }
+                    throw error;
+                }
+            }
+            catch (error) {
+                if (callerSignal.aborted)
+                    throw abortReason(callerSignal);
+                if (error instanceof BrowserSolveTimeoutError) {
+                    throw new ResolverVendorUnavailableError(BROWSER_VENDOR_ID, "timeout", {
+                        cause: error,
+                    });
+                }
+                if (error instanceof ResolverVendorUnavailableError) {
+                    throw error;
+                }
+                const reason = knownUnavailableReason(error);
+                if (reason) {
+                    throw new ResolverVendorUnavailableError(BROWSER_VENDOR_ID, reason, { cause: error });
+                }
+                throw error;
+            }
+            finally {
+                clearTimeout(timeout);
+                callerSignal.removeEventListener("abort", onCallerAbort);
+                await closeBrowserClient(client, options.timeoutMs, challengeKind, traceRecorder);
+            }
+        },
+    };
+}

package/dist/runtime/resolver-vendors/types.d.ts

@@ -0,0 +1,42 @@
+import type { ChallengeSolution, ProviderChallenge, ProviderChallengeKind, ProviderResolverVendor } from "../../types.js";
+import type { TraceRecorder } from "../trace.js";
+export declare const RESOLVER_VENDOR_CAPABILITIES: {
+    readonly browser: readonly ["aws_waf", "cloudflare_interstitial"];
+    readonly "2captcha": readonly ["turnstile", "recaptcha_v2", "recaptcha_v3", "hcaptcha", "cloudflare_interstitial", "aws_waf"];
+    readonly capsolver: readonly ["turnstile", "recaptcha_v2", "recaptcha_v3", "hcaptcha", "cloudflare_interstitial", "aws_waf"];
+    readonly capmonster: readonly ["turnstile", "recaptcha_v2", "recaptcha_v3", "hcaptcha"];
+    readonly custom: readonly ["turnstile", "recaptcha_v2", "recaptcha_v3", "hcaptcha", "cloudflare_interstitial", "aws_waf"];
+};
+export declare function resolverVendorSupports(vendor: ProviderResolverVendor, kind: ProviderChallengeKind): boolean;
+export interface ResolverIdentity {
+    readonly proxyUrl: string;
+    readonly userAgent: string;
+}
+export interface ResolverIssuingIdentity {
+    /** Absent when the adapter genuinely solved without a proxy. */
+    readonly proxyUrl?: string;
+    readonly userAgent: string;
+}
+export interface ResolverVendorAdapter {
+    readonly id: ProviderResolverVendor;
+    supports(kind: ProviderChallengeKind): boolean;
+    /** Identity the adapter actually used, reported after a successful solve. */
+    getIssuingIdentity?(solution: ChallengeSolution, requestedIdentity: ResolverIdentity | undefined, challenge: ProviderChallenge): ResolverIssuingIdentity | undefined;
+    solve(challenge: ProviderChallenge, identity: ResolverIdentity | undefined, signal: AbortSignal, traceRecorder?: TraceRecorder): Promise<ChallengeSolution>;
+}
+export type ResolverVendorUnavailableReason = "missing_credentials" | "missing_transport" | "allocation_exhausted" | "transport_failure" | "timeout" | "not_implemented";
+export type ResolverChallengeVerdictReason = "human_puzzle";
+type ResolverErrorOptions = {
+    readonly cause?: unknown;
+};
+export declare class ResolverVendorUnavailableError extends Error {
+    readonly vendor: ProviderResolverVendor;
+    readonly reason: ResolverVendorUnavailableReason;
+    constructor(vendor: ProviderResolverVendor, reason: ResolverVendorUnavailableReason, options?: ResolverErrorOptions);
+}
+export declare class ResolverChallengeVerdictError extends Error {
+    readonly vendor: ProviderResolverVendor;
+    readonly reason: ResolverChallengeVerdictReason;
+    constructor(vendor: ProviderResolverVendor, reason: ResolverChallengeVerdictReason, options?: ResolverErrorOptions);
+}
+export {};

package/dist/runtime/resolver-vendors/types.js

@@ -0,0 +1,57 @@
+export const RESOLVER_VENDOR_CAPABILITIES = {
+    browser: ["aws_waf", "cloudflare_interstitial"],
+    "2captcha": [
+        "turnstile",
+        "recaptcha_v2",
+        "recaptcha_v3",
+        "hcaptcha",
+        "cloudflare_interstitial",
+        "aws_waf",
+    ],
+    capsolver: [
+        "turnstile",
+        "recaptcha_v2",
+        "recaptcha_v3",
+        "hcaptcha",
+        "cloudflare_interstitial",
+        "aws_waf",
+    ],
+    capmonster: ["turnstile", "recaptcha_v2", "recaptcha_v3", "hcaptcha"],
+    custom: [
+        "turnstile",
+        "recaptcha_v2",
+        "recaptcha_v3",
+        "hcaptcha",
+        "cloudflare_interstitial",
+        "aws_waf",
+    ],
+};
+export function resolverVendorSupports(vendor, kind) {
+    return RESOLVER_VENDOR_CAPABILITIES[vendor].includes(kind);
+}
+export class ResolverVendorUnavailableError extends Error {
+    vendor;
+    reason;
+    constructor(vendor, reason, options = {}) {
+        super(`Resolver vendor ${vendor} is unavailable: ${reason}`);
+        this.vendor = vendor;
+        this.reason = reason;
+        this.name = "ResolverVendorUnavailableError";
+        if (options.cause !== undefined) {
+            this.cause = options.cause;
+        }
+    }
+}
+export class ResolverChallengeVerdictError extends Error {
+    vendor;
+    reason;
+    constructor(vendor, reason, options = {}) {
+        super(`Resolver vendor ${vendor} returned a challenge verdict: ${reason}`);
+        this.vendor = vendor;
+        this.reason = reason;
+        this.name = "ResolverChallengeVerdictError";
+        if (options.cause !== undefined) {
+            this.cause = options.cause;
+        }
+    }
+}

package/dist/runtime/resolver.d.ts

@@ -0,0 +1,39 @@
+import type { ChallengeSolution, ProviderCache, ProviderChallenge, ProviderChallengeKind, ProviderResolverConfig, ProviderResolverVendor, ResolverContext } from "../types.js";
+import { type ResolverIdentity, type ResolverVendorAdapter } from "./resolver-vendors/types.js";
+import type { TraceRecorder } from "./trace.js";
+export declare const APIFUSE__RESOLVER__2CAPTCHA__API_KEY = "APIFUSE__RESOLVER__2CAPTCHA__API_KEY";
+export declare const APIFUSE__RESOLVER__CAPSOLVER__API_KEY = "APIFUSE__RESOLVER__CAPSOLVER__API_KEY";
+export declare const APIFUSE__RESOLVER__CAPMONSTER__API_KEY = "APIFUSE__RESOLVER__CAPMONSTER__API_KEY";
+export declare const APIFUSE__RESOLVER__TIMEOUT_MS = "APIFUSE__RESOLVER__TIMEOUT_MS";
+export declare const APIFUSE__CDP_POOL__URL = "APIFUSE__CDP_POOL__URL";
+export declare const DEFAULT_RESOLVER_TIMEOUT_MS = 180000;
+type EnvLike = Record<string, string | undefined>;
+type ResolverChainClient = ResolverContext & {
+    solve(challenge: ProviderChallenge, signal?: AbortSignal, traceRecorder?: TraceRecorder): Promise<ChallengeSolution>;
+};
+export interface ResolverRuntimeOptions {
+    readonly allowedHosts?: readonly string[];
+    readonly cache?: ProviderCache;
+    /** Server-owned context/proxy scope used only for identity-bound cache entries. */
+    readonly identityScope?: string;
+}
+export declare const RESOLVER_INSTRUMENTATION_METADATA: unique symbol;
+export type ResolverInstrumentationMetadata = {
+    readonly target: ResolverContext;
+    readonly traceRecorder: TraceRecorder;
+};
+type ResolverAdapterFactory = (configuration: string, timeoutMs: number, allowedHosts: readonly string[]) => ResolverVendorAdapter;
+export declare const RESOLVER_ADAPTER_REGISTRY: Partial<Readonly<Record<ProviderResolverVendor, ResolverAdapterFactory>>>;
+/** Remove the cached entry for the exact solution object returned by this resolver. */
+export declare function invalidateResolverSolution(resolver: ResolverContext, challenge: ProviderChallenge, solution: ChallengeSolution): Promise<void>;
+export declare function createResolverClient(options: {
+    readonly kinds: readonly ProviderChallengeKind[];
+    readonly adapters: readonly ResolverVendorAdapter[];
+    readonly unavailableReason?: string;
+    readonly cache?: ProviderCache;
+    readonly identity?: ResolverIdentity;
+}): ResolverChainClient;
+export declare function createUnsupportedResolverClient(reason?: string): ResolverContext;
+export declare function bindResolverSignal(resolver: ResolverContext, defaultSignal: AbortSignal | undefined): ResolverContext;
+export declare function createResolverClientFromEnv(config: ProviderResolverConfig | undefined, env?: EnvLike, options?: ResolverRuntimeOptions): ResolverContext;
+export {};