@apifuse/provider-sdk 2.1.0-beta.5 → 2.1.0-beta.8

package/dist/config/loader.d.ts

@@ -0,0 +1,107 @@
+import Redis from "ioredis";
+import type { ProviderProxyPolicy, TraceConfig } from "../types";
+export declare const SMARTPROXY_APP_KEY_ENV = "APIFUSE__PROXY__SMARTPROXY_APP_KEY";
+export declare const SMARTPROXY_MAX_LIFETIME_MINUTES = 2000;
+export declare const DEFAULT_SMARTPROXY_POOL_SIZE = 20;
+export declare const SMARTPROXY_MAX_POOL_SIZE = 20;
+export declare const DEFAULT_PROXY_PROVIDER_ENV = "APIFUSE__PROXY__PROVIDER";
+export declare const DEFAULT_PROXY_COUNTRY_ENV = "APIFUSE__PROXY__DEFAULT_COUNTRY";
+export declare const DEFAULT_PROXY_LIFETIME_ENV = "APIFUSE__PROXY__DEFAULT_LIFETIME_MINUTES";
+export declare const PROVIDER_CACHE_REDIS_URL_ENV = "APIFUSE__PROVIDER__CACHE_REDIS_URL";
+export declare const PROVIDER_STATE_REDIS_URL_ENV = "APIFUSE__PROVIDER__STATE_REDIS_URL";
+export declare const REDIS_URL_ENV = "APIFUSE__REDIS__URL";
+export type ProxyOptions = {
+    url: string;
+};
+export type ProxyConfig = Partial<ProxyOptions> & {
+    provider?: string;
+    apiKey?: string;
+};
+export type BrowserConfig = {
+    executablePath?: string;
+    headless?: boolean;
+};
+export type SessionConfig = {
+    storage?: "sqlite" | "supabase";
+    path?: string;
+};
+export type ApiFuseConfig = {
+    proxy?: ProxyConfig;
+    browser?: BrowserConfig;
+    session?: SessionConfig;
+    trace?: TraceConfig;
+    credentials?: Record<string, Record<string, string>>;
+};
+export type ProxyResolutionOptions = {
+    proxy?: string;
+    upstream?: {
+        proxy?: boolean | ProviderProxyPolicy;
+    };
+    apifuseConfig?: Pick<ApiFuseConfig, "proxy">;
+    proxyPolicy?: ProviderProxyPolicy;
+    affinityKey?: string;
+    /** Zero-based proxy-pool attempt index used by SDK transports for failover. */
+    proxyAttempt?: number;
+    telemetry?: ProxyTelemetrySink;
+};
+export type ProxyCacheStatus = "memory_hit" | "redis_hit" | "allocator" | "soft_stale_refresh" | "lock_wait" | "redis_error" | "redis_corrupt" | "disabled";
+export type SmartproxyAllocatorBodyClass = "network_error" | "http_error" | "empty" | "json_without_proxies" | "text_without_proxies" | "usable_proxy_endpoints";
+export type ProxyResolutionTelemetryEvent = {
+    provider: "smartproxy";
+    cacheStatus: ProxyCacheStatus;
+    cacheHit: boolean;
+    resolutionMs: number;
+    allocatorMs?: number;
+    allocatorStatus?: number;
+    allocatorBodyClass?: SmartproxyAllocatorBodyClass;
+    allocatorAttempts?: number;
+    lockWaitMs?: number;
+    redisReadMs?: number;
+    redisWriteMs?: number;
+    poolAgeMs?: number;
+    poolExpiresInMs?: number;
+    attempts: number;
+    refreshes?: number;
+};
+export type ProxyAttemptTelemetryEvent = {
+    provider: "smartproxy";
+    attempt: number;
+    poolIndex?: number;
+    proxyHash?: string;
+    outcome: "ok" | "error";
+    errorCode?: string;
+    status?: number;
+    durationMs?: number;
+};
+export type ProxyTelemetrySink = {
+    recordProxyResolution(event: ProxyResolutionTelemetryEvent): void;
+    recordProxyAttempt?(event: ProxyAttemptTelemetryEvent): void;
+};
+export type ResolvedProxyConfig = {
+    shouldWarn: boolean;
+    url?: string;
+    source?: "explicit" | "env" | "config" | "smartproxy-allocator";
+    diagnostics?: Record<string, string | number | boolean>;
+};
+export declare class ProxyResolutionError extends Error {
+    readonly code: "PROXY_REQUIRED" | "PROXY_ALLOCATION_FAILED";
+    readonly telemetry?: ProxyResolutionTelemetryEvent;
+    constructor(code: "PROXY_REQUIRED" | "PROXY_ALLOCATION_FAILED", message: string, options?: {
+        cause?: unknown;
+        telemetry?: ProxyResolutionTelemetryEvent;
+    });
+}
+type ProxyRedisClient = Pick<Redis, "connect" | "del" | "eval" | "get" | "on" | "pttl" | "set" | "status">;
+export declare function providerCacheRedisUrlFromEnv(): string | undefined;
+export declare function providerStateRedisUrlFromEnv(): string | undefined;
+/** @internal Test-only hook for exercising shared proxy-cache behavior. */
+export declare function __setProxyRedisForTests(redis: ProxyRedisClient | undefined): void;
+export declare function __setSmartproxyAllocatorDeadlineMsForTests(deadlineMs: number | undefined): void;
+export declare function resolveProxyConfig(options?: ProxyResolutionOptions): ResolvedProxyConfig;
+export declare function resolveProxyConfigAsync(options?: ProxyResolutionOptions): Promise<ResolvedProxyConfig>;
+export declare function clearProxyResolutionCache(): void;
+export declare function invalidateProxyResolutionCache(options?: ProxyResolutionOptions): boolean;
+export declare function invalidateProxyResolutionCacheAsync(options?: ProxyResolutionOptions): Promise<boolean>;
+export declare function defineConfig(config: ApiFuseConfig): ApiFuseConfig;
+export declare function loadApiFuseConfig(dir?: string): Promise<ApiFuseConfig>;
+export {};