@apifuse/provider-sdk 2.2.0-beta.10 → 2.2.0-beta.12

package/dist/stateful-signing.d.ts

@@ -0,0 +1,18 @@
+export declare const STATEFUL_SIGNATURE_HEADER = "x-apifuse-stateful-signature";
+export declare const STATEFUL_TIMESTAMP_HEADER = "x-apifuse-stateful-timestamp";
+export declare const STATEFUL_NONCE_HEADER = "x-apifuse-stateful-nonce";
+export type StatefulSigningInput = {
+    readonly secret: string;
+    readonly timestamp: string;
+    readonly rawBody: string;
+    readonly method: string;
+    readonly path: string;
+    readonly nonce: string;
+};
+export declare function signStatefulRequestBody(input: StatefulSigningInput): string;
+export declare function verifyStatefulRequestSignature(input: StatefulSigningInput & {
+    readonly signature: string;
+}): boolean;
+export declare function statefulSignedHeaders(input: Omit<StatefulSigningInput, "nonce"> & {
+    readonly nonce?: string;
+}): Record<string, string>;

package/dist/stateful-signing.js

@@ -0,0 +1,27 @@
+import { createHmac, randomUUID, timingSafeEqual } from "node:crypto";
+export const STATEFUL_SIGNATURE_HEADER = "x-apifuse-stateful-signature";
+export const STATEFUL_TIMESTAMP_HEADER = "x-apifuse-stateful-timestamp";
+export const STATEFUL_NONCE_HEADER = "x-apifuse-stateful-nonce";
+export function signStatefulRequestBody(input) {
+    return `v1=${createHmac("sha256", input.secret)
+        .update(`v1:${input.method.toUpperCase()}:${input.path}:${input.timestamp}:${input.nonce}.${input.rawBody}`)
+        .digest("hex")}`;
+}
+export function verifyStatefulRequestSignature(input) {
+    return safeEqualAscii(input.signature, signStatefulRequestBody(input));
+}
+export function statefulSignedHeaders(input) {
+    const nonce = input.nonce ?? randomUUID();
+    return {
+        [STATEFUL_SIGNATURE_HEADER]: signStatefulRequestBody({ ...input, nonce }),
+        [STATEFUL_TIMESTAMP_HEADER]: input.timestamp,
+        [STATEFUL_NONCE_HEADER]: nonce,
+    };
+}
+function safeEqualAscii(actual, expected) {
+    const actualBytes = Buffer.from(actual);
+    const expectedBytes = Buffer.from(expected);
+    if (actualBytes.byteLength !== expectedBytes.byteLength)
+        return false;
+    return timingSafeEqual(actualBytes, expectedBytes);
+}

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import type ms from "ms";
+import type { SerializedCookieJar } from "tough-cookie";
 import type { infer as ZodInfer, ZodType } from "zod";
 /** Minimal Standard Schema v1 shape accepted by provider operations. */
 export interface StandardSchemaV1<Input = unknown, Output = Input> {
@@ -872,17 +873,42 @@ export interface StealthFetchOptions extends RequestOptions {
     };
 }
 export interface CookieJar {
-    get(name: string): string | undefined;
-    getAll(): Record<string, string>;
-    toString(): string;
-    find?(predicate: (cookie: string) => boolean): string | undefined;
+    /** URL-less reads use the jar's response URL or session base URL. */
+    get(name: string, url?: string): string | undefined;
+    getAll(url?: string): Record<string, string>;
+    toString(url?: string): string;
+    find?(predicate: (cookie: string) => boolean, url?: string): string | undefined;
 }
+/**
+ * Version 1 of the JSON-safe, attribute-preserving stealth cookie store.
+ * The nested jar is tough-cookie's serialized form and retains cookie origin,
+ * Path, Secure, expiry, host-only, and other RFC attributes.
+ */
+export interface StealthCookieStoreV1 {
+    readonly version: 1;
+    readonly jar: SerializedCookieJar;
+}
+/** Cookie persistence formats understood by this SDK version. */
+export type StealthCookieStore = StealthCookieStoreV1;
 export interface StealthSessionCookies extends CookieJar {
-    has(name: string): boolean;
-    setFromCookieStrings(cookieStrings: readonly string[]): void;
-    toHeader(): string;
+    has(name: string, url?: string): boolean;
+    /** URL-less writes are scoped to the session base URL. */
+    setFromCookieStrings(cookieStrings: readonly string[], url?: string): void;
+    toHeader(url?: string): string;
+    /**
+     * Returns every cookie as a flat name/value map, collapsing duplicate names.
+     * @deprecated Use serialize() for lossless, attribute-preserving persistence.
+     */
     snapshot(): Record<string, string>;
+    /**
+     * Restores flat values as host-only, Path=/ cookies on the session base URL.
+     * @deprecated Use deserialize() with state produced by serialize().
+     */
     restore(cookies: Record<string, string>): void;
+    /** Returns a versioned, JSON-safe, attribute-preserving representation of every cookie. */
+    serialize(): StealthCookieStoreV1;
+    /** Replaces the jar with a previously serialized, attribute-preserving cookie store. */
+    deserialize(state: StealthCookieStore): void;
     clear(): void;
 }
 export interface DeclarativeStealthResponse {
@@ -925,7 +951,13 @@ export interface StealthRedirectRunResult {
     final: StealthResponse;
     hops: StealthRedirectHop[];
     reason: "completed" | "stopped" | "max_hops" | "missing_location" | "loop";
+    /**
+     * Complete flat view across all redirect hosts. Attributes and duplicate names are lost.
+     * @deprecated Use cookieStore for lossless persistence.
+     */
     cookies: Record<string, string>;
+    /** Versioned, attribute-preserving cookie state accumulated across the redirect chain. */
+    cookieStore: StealthCookieStoreV1;
 }
 export interface StealthSession {
     fetch(url: string, options?: StealthFetchOptions): Promise<StealthResponse>;

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.2.0-beta.10",
+	"version": "2.2.0-beta.12",
 	"name": "@apifuse/provider-sdk",
 	"private": false,
 	"type": "module",
@@ -61,6 +61,11 @@
 			"import": "./dist/server/index.js",
 			"default": "./dist/server/index.js"
 		},
+		"./stateful": {
+			"types": "./dist/stateful/index.d.ts",
+			"import": "./dist/stateful/index.js",
+			"default": "./dist/stateful/index.js"
+		},
 		"./testing": {
 			"types": "./dist/testing/index.d.ts",
 			"import": "./dist/testing/index.js",
@@ -109,6 +114,7 @@
 		"puppeteer-extra-plugin-stealth": "^2.11.2",
 		"re2-wasm": "^1.0",
 		"safe-regex": "^2.1",
+		"tough-cookie": "^6.0.2",
 		"zod": "^4.4.3"
 	},
 	"repository": {

package/src/config/loader.ts

@@ -156,10 +156,19 @@ export type ProxyTelemetrySink = {
 	recordProxyVendorFailover?(event: ProxyVendorFailoverTelemetryEvent): void;
 };
 
+export type ProxyResolutionSource =
+	| "explicit"
+	| "env"
+	| "config"
+	| "smartproxy-allocator"
+	| "nodemaven-gateway";
+
 export type ResolvedProxyConfig = {
 	shouldWarn: boolean;
 	url?: string;
-	source?: "explicit" | "env" | "config" | "smartproxy-allocator" | "nodemaven-gateway";
+	/** SDK-native vendor that supplied the URL, when applicable. */
+	vendor?: ProxyVendorName;
+	source?: ProxyResolutionSource;
 	protocol?: ProxyProtocol;
 	diagnostics?: Record<string, string | number | boolean>;
 };
@@ -656,6 +665,18 @@ export async function resolveProxyConfigAsync(
 	return { shouldWarn: true };
 }
 
+/**
+ * Resolve the proxy URL for a provider-owned consumer such as a CAPTCHA solver.
+ * Vendor allocation and failover remain owned by the SDK.
+ */
+export async function resolveProxy(
+	options: ProxyResolutionOptions = {},
+): Promise<ResolvedProxyConfig> {
+	const resolved = await resolveProxyConfigAsync(options);
+	const vendor = vendorFromResolvedSource(resolved.source);
+	return vendor ? { ...resolved, vendor } : resolved;
+}
+
 /**
  * Each vendor's default egress protocol, chosen from live KR benchmarks. HTTP
  * CONNECT wins for nodemaven (socks5 adds ~500ms through the gateway) and ties

package/src/errors.ts

@@ -79,6 +79,21 @@ export class SDKError extends ProviderError {
 	}
 }
 
+/** Raised when persisted stealth cookies use a store version this SDK cannot read. */
+export class StealthCookieStoreVersionError extends SDKError {
+	constructor(public readonly version: unknown) {
+		const displayedVersion =
+			typeof version === "string" || typeof version === "number"
+				? String(version)
+				: "missing or invalid";
+		super(`Unsupported stealth cookie store version: ${displayedVersion}`, {
+			code: "unsupported_stealth_cookie_store_version",
+			details: { receivedVersion: version, supportedVersions: [1] },
+		});
+		this.name = "StealthCookieStoreVersionError";
+	}
+}
+
 export class AuthError extends ProviderError {
 	constructor(message: string, options?: ProviderErrorOptions) {
 		super(message, options);

package/src/index.ts

@@ -7,9 +7,14 @@ export type {
 	ApiFuseConfig,
 	BrowserConfig,
 	ProxyConfig,
+	ProxyProtocol,
+	ProxyResolutionOptions,
+	ProxyResolutionSource,
+	ProxyVendorName,
+	ResolvedProxyConfig,
 	SessionConfig,
 } from "./config/loader.js";
-export { defineConfig, loadApiFuseConfig } from "./config/loader.js";
+export { defineConfig, loadApiFuseConfig, resolveProxy } from "./config/loader.js";
 export {
 	canonicalJson,
 	digestProviderContract,
@@ -245,6 +250,8 @@ export type {
 	StateValue,
 	StateWriteOptions,
 	StealthClient,
+	StealthCookieStore,
+	StealthCookieStoreV1,
 	StealthFetchOptions,
 	StealthPlatform,
 	StealthProfile,

package/src/runtime/stealth.ts

@@ -1,24 +1,27 @@
 import { createHash } from "node:crypto";
 import type { Browser, ImpitOptions, ImpitResponse, RequestInit } from "impit";
 import { Impit } from "impit";
+import { Cookie, CookieJar as ToughCookieJar } from "tough-cookie";
 
 import type { ProxyResolutionOptions, ProxyVendorName } from "../config/loader.js";
 import {
 	DEFAULT_SMARTPROXY_POOL_SIZE,
 	invalidateProxyResolutionCacheAsync,
-	policyResolvesRegistryVendorChain,
 	ProxyResolutionError,
+	policyResolvesRegistryVendorChain,
 	resolvePolicyProxyPoolSpan,
 	resolvePolicyTransportAttemptCap,
 	resolveProxyConfigAsync,
 	vendorFromResolvedSource,
 } from "../config/loader.js";
-import { SDKError, TransportError } from "../errors.js";
+import { SDKError, StealthCookieStoreVersionError, TransportError } from "../errors.js";
 import { getStealthProfile } from "../stealth/profiles.js";
 import type {
 	CookieJar,
 	HttpMethod,
 	StealthClient,
+	StealthCookieStore,
+	StealthCookieStoreV1,
 	StealthFetchOptions,
 	StealthRedirectHop,
 	StealthResponse,
@@ -127,81 +130,145 @@ function isRecord(value: unknown): value is Record<PropertyKey, unknown> {
 	return typeof value === "object" && value !== null;
 }
 
+const LEGACY_COOKIE_ORIGIN = "https://legacy-cookie.invalid/";
+
 class CookieJarImpl implements CookieJar {
-	private readonly cookies: Record<string, string>;
+	private cookies: ToughCookieJar;
+	private readonly defaultUrl: string;
 
-	constructor(cookieStrings: string[]) {
-		this.cookies = {};
+	constructor(cookieStrings: readonly string[], defaultUrl = LEGACY_COOKIE_ORIGIN) {
+		this.cookies = new ToughCookieJar(undefined, {
+			allowSecureOnLocal: false,
+			rejectPublicSuffixes: true,
+		});
+		this.defaultUrl = this.normalizeUrl(defaultUrl) ?? LEGACY_COOKIE_ORIGIN;
 		this.setFromCookieStrings(cookieStrings);
 	}
 
-	setFromCookieStrings(cookieStrings: readonly string[]): void {
-		for (const cookieString of cookieStrings) {
-			const [nameValue] = cookieString.split(";");
-			if (!nameValue) {
-				continue;
-			}
-
-			const separatorIndex = nameValue.indexOf("=");
-			if (separatorIndex === -1) {
-				continue;
-			}
+	/**
+	 * URL-less legacy operations are scoped to this jar's default URL. Session
+	 * jars use the client's base URL and response jars use the response URL. A
+	 * flat restore has no attributes to recover, so it creates host-only Path=/
+	 * cookies for that default URL instead of making them visible to every host.
+	 */
+	setFromCookieStrings(cookieStrings: readonly string[], url = this.defaultUrl): void {
+		const cookieUrl = this.normalizeUrl(url);
+		if (!cookieUrl) return;
 
-			const name = nameValue.slice(0, separatorIndex).trim();
-			const value = nameValue.slice(separatorIndex + 1).trim();
-			if (name) this.cookies[name] = value;
+		for (const cookieString of cookieStrings) {
+			this.cookies.setCookieSync(cookieString, cookieUrl, { ignoreError: true });
 		}
 	}
 
-	get(name: string): string | undefined {
-		return this.cookies[name];
+	get(name: string, url?: string): string | undefined {
+		return this.getAll(url)[name];
 	}
 
-	getAll(): Record<string, string> {
-		return { ...this.cookies };
+	getAll(url?: string): Record<string, string> {
+		return Object.fromEntries(
+			this.getUniqueCookies(url ?? this.defaultUrl).map((cookie) => [cookie.key, cookie.value]),
+		);
 	}
 
-	has(name: string): boolean {
-		return Object.hasOwn(this.cookies, name);
+	has(name: string, url?: string): boolean {
+		return Object.hasOwn(this.getAll(url), name);
 	}
 
-	toString(): string {
-		return Object.entries(this.cookies)
-			.map(([name, value]) => `${name}=${value}`)
+	toString(url?: string): string {
+		return this.getUniqueCookies(url ?? this.defaultUrl)
+			.map((cookie) => cookie.cookieString())
 			.join("; ");
 	}
 
-	toHeader(): string {
-		return this.toString();
+	toHeader(url?: string): string {
+		return this.toString(url);
 	}
 
 	snapshot(): Record<string, string> {
-		return this.getAll();
+		// This compatibility view deliberately enumerates the serialized store,
+		// not getAll(defaultUrl): persistence must include sibling hosts and paths.
+		// Duplicate names still collapse because a flat map cannot represent them.
+		const entries: [string, string][] = [];
+		for (const cookie of this.serialize().jar.cookies) {
+			if (typeof cookie.key === "string" && typeof cookie.value === "string" && cookie.key) {
+				entries.push([cookie.key, cookie.value]);
+			}
+		}
+		return Object.fromEntries(entries);
 	}
 
 	restore(cookies: Record<string, string>): void {
 		this.clear();
 		for (const [name, value] of Object.entries(cookies)) {
-			if (name) this.cookies[name] = value;
+			if (!name) continue;
+			this.cookies.setCookieSync(new Cookie({ key: name, path: "/", value }), this.defaultUrl, {
+				ignoreError: true,
+			});
 		}
 	}
 
-	clear(): void {
-		for (const name of Object.keys(this.cookies)) {
-			delete this.cookies[name];
+	serialize(): StealthCookieStoreV1 {
+		const jar = this.cookies.serializeSync();
+		if (!jar) {
+			throw new SDKError("Stealth cookie store could not be serialized", {
+				code: "stealth_cookie_store_serialize_failed",
+			});
 		}
+		return { version: 1, jar };
 	}
 
-	find(predicate: (cookie: string) => boolean): string | undefined {
-		for (const [name, value] of Object.entries(this.cookies)) {
-			const cookie = `${name}=${value}`;
-			if (predicate(cookie)) {
-				return cookie;
+	deserialize(state: StealthCookieStore): void {
+		const version = isRecord(state) ? state.version : undefined;
+		if (version !== 1) {
+			throw new StealthCookieStoreVersionError(version);
+		}
+
+		// Deserialize into a new jar first so invalid state cannot partially clear
+		// or replace a live session. tough-cookie restores the cookie attributes and
+		// matching semantics represented in its own serialized format.
+		const restored = ToughCookieJar.deserializeSync(state.jar);
+		// tough-cookie 6 does not include this option in serializeSync(). Preserve
+		// the SDK's stricter setting across restoration.
+		Reflect.set(restored, "allowSecureOnLocal", false);
+		this.cookies = restored;
+	}
+
+	clear(): void {
+		this.cookies.removeAllCookiesSync();
+	}
+
+	find(predicate: (cookie: string) => boolean, url?: string): string | undefined {
+		for (const cookie of this.getUniqueCookies(url ?? this.defaultUrl)) {
+			const cookieString = cookie.cookieString();
+			if (predicate(cookieString)) {
+				return cookieString;
 			}
 		}
 
 		return undefined;
 	}
+
+	private normalizeUrl(url: string): string | undefined {
+		try {
+			return new URL(url).toString();
+		} catch {
+			return undefined;
+		}
+	}
+
+	private getUniqueCookies(url: string): Cookie[] {
+		const cookieUrl = this.normalizeUrl(url);
+		if (!cookieUrl) return [];
+
+		// tough-cookie returns longer (more-specific) paths first. Keeping the
+		// first cookie for each name prevents ambiguous duplicate-name headers.
+		const names = new Set<string>();
+		return this.cookies.getCookiesSync(cookieUrl).filter((cookie) => {
+			if (names.has(cookie.key)) return false;
+			names.add(cookie.key);
+			return true;
+		});
+	}
 }
 
 function closestImpitBrowser(
@@ -282,12 +349,12 @@ function hasOwn(object: object, key: string): boolean {
 }
 function toImpitCookieJar(cookieJar: CookieJarImpl): NonNullable<ImpitOptions["cookieJar"]> {
 	return {
-		setCookie(cookie: string, _url: string, cb?: (error?: unknown) => void) {
-			cookieJar.setFromCookieStrings([cookie]);
+		setCookie(cookie: string, url: string, cb?: (error?: unknown) => void) {
+			cookieJar.setFromCookieStrings([cookie], url);
 			if (typeof cb === "function") cb();
 		},
-		getCookieString(_url: string) {
-			return cookieJar.toString();
+		getCookieString(url: string) {
+			return cookieJar.toHeader(url);
 		},
 	};
 }
@@ -341,7 +408,10 @@ export async function normalizeResponse(
 	requestUrl?: string,
 ): Promise<StealthResponse> {
 	const headers = Object.fromEntries(response.headers.entries());
-	const cookies = new CookieJarImpl(setCookieHeadersFromResponse(response.headers));
+	const cookies = new CookieJarImpl(
+		setCookieHeadersFromResponse(response.headers),
+		response.url ?? requestUrl,
+	);
 	const bodyBytes = await response.arrayBuffer();
 	const body = new TextDecoder().decode(bodyBytes);
 
@@ -588,7 +658,7 @@ function createSessionFetcher(
 	let closed = false;
 	let hasWarnedMissingProxy = false;
 	const warn = clientOptions.warn ?? console.warn;
-	const cookieJar = new CookieJarImpl([]);
+	const cookieJar = new CookieJarImpl([], baseUrl);
 	const impitCookieJar = toImpitCookieJar(cookieJar);
 
 	function getClient(
@@ -757,7 +827,7 @@ function createSessionFetcher(
 						const requestUrl = appendQueryParams(resolveUrl(baseUrl, url), options.params);
 						const headers = { ...(options.headers ?? {}) };
 						if (!hasHeader(headers, "Cookie")) {
-							const cookieHeader = cookieJar.toString();
+							const cookieHeader = cookieJar.toHeader(requestUrl);
 							if (cookieHeader) headers.Cookie = cookieHeader;
 						}
 						const requestInit: StealthRequestInit = {
@@ -774,7 +844,10 @@ function createSessionFetcher(
 							requestInit,
 						);
 						const normalized = await normalizeResponse(response, requestUrl);
-						cookieJar.setFromCookieStrings(setCookieHeadersFromResponse(response.headers));
+						cookieJar.setFromCookieStrings(
+							setCookieHeadersFromResponse(response.headers),
+							response.url ?? requestUrl,
+						);
 
 						if (proxy && isProxyConnectFailureResponse(response, normalized.body)) {
 							throw createProxyConnectFailureError(normalized.body);
@@ -954,6 +1027,7 @@ function createSessionFetcher(
 							hops,
 							reason: "completed",
 							cookies: cookieJar.snapshot(),
+							cookieStore: cookieJar.serialize(),
 						};
 					}
 
@@ -976,6 +1050,7 @@ function createSessionFetcher(
 							hops,
 							reason: "stopped",
 							cookies: cookieJar.snapshot(),
+							cookieStore: cookieJar.serialize(),
 						};
 					}
 
@@ -985,6 +1060,7 @@ function createSessionFetcher(
 							hops,
 							reason: "missing_location",
 							cookies: cookieJar.snapshot(),
+							cookieStore: cookieJar.serialize(),
 						};
 					}
 
@@ -994,6 +1070,7 @@ function createSessionFetcher(
 							hops,
 							reason: "max_hops",
 							cookies: cookieJar.snapshot(),
+							cookieStore: cookieJar.serialize(),
 						};
 					}
 
@@ -1007,6 +1084,7 @@ function createSessionFetcher(
 							hops,
 							reason: "loop",
 							cookies: cookieJar.snapshot(),
+							cookieStore: cookieJar.serialize(),
 						};
 					}
 					method = nextMethod;
@@ -1028,6 +1106,7 @@ function createSessionFetcher(
 					hops,
 					reason: "max_hops",
 					cookies: cookieJar.snapshot(),
+					cookieStore: cookieJar.serialize(),
 				};
 			},
 		},

package/src/server/index.ts

@@ -1,4 +1,16 @@
-export { createServerApp, type ServeOptions, serve } from "./serve.js";
+export {
+	createServerApp,
+	type ProviderServerCloseOptions,
+	type ProviderServerHandle,
+	type ProviderServerLogEvent,
+	type ProviderServerLogger,
+	type ProviderServerOperationExecutor,
+	type ProviderServerOperationExecutorInput,
+	type ProviderServerOptions,
+	type ProviderServerStatefulForwardEnvelope,
+	type ServeOptions,
+	serve,
+} from "./serve.js";
 export {
 	computeSelfTestPlanDigest,
 	createSelfTestApp,