@coinbase/cdp-sdk 1.51.1 → 1.52.0

package/src/_vendor/core/fetcher/getErrorResponseBody.ts

@@ -0,0 +1,33 @@
+import { fromJson } from "../json.js";
+import { getResponseBody } from "./getResponseBody.js";
+
+export async function getErrorResponseBody(response: Response): Promise<unknown> {
+    let contentType = response.headers.get("Content-Type")?.toLowerCase();
+    if (contentType == null || contentType.length === 0) {
+        return getResponseBody(response);
+    }
+
+    if (contentType.indexOf(";") !== -1) {
+        contentType = contentType.split(";")[0]?.trim() ?? "";
+    }
+    switch (contentType) {
+        case "application/hal+json":
+        case "application/json":
+        case "application/ld+json":
+        case "application/problem+json":
+        case "application/vnd.api+json":
+        case "text/json": {
+            const text = await response.text();
+            return text.length > 0 ? fromJson(text) : undefined;
+        }
+        default:
+            if (contentType.startsWith("application/vnd.") && contentType.endsWith("+json")) {
+                const text = await response.text();
+                return text.length > 0 ? fromJson(text) : undefined;
+            }
+
+            // Fallback to plain text if content type is not recognized
+            // Even if no body is present, the response will be an empty string
+            return await response.text();
+    }
+}

package/src/_vendor/core/fetcher/getFetchFn.ts

@@ -0,0 +1,3 @@
+export async function getFetchFn(): Promise<typeof fetch> {
+    return fetch;
+}

package/src/_vendor/core/fetcher/getHeader.ts

@@ -0,0 +1,8 @@
+export function getHeader(headers: Record<string, any>, header: string): string | undefined {
+    for (const [headerKey, headerValue] of Object.entries(headers)) {
+        if (headerKey.toLowerCase() === header.toLowerCase()) {
+            return headerValue;
+        }
+    }
+    return undefined;
+}

package/src/_vendor/core/fetcher/getRequestBody.ts

@@ -0,0 +1,20 @@
+import { toJson } from "../json.js";
+import { toQueryString } from "../url/qs.js";
+
+export declare namespace GetRequestBody {
+    interface Args {
+        body: unknown;
+        type: "json" | "file" | "bytes" | "form" | "other";
+    }
+}
+
+export async function getRequestBody({ body, type }: GetRequestBody.Args): Promise<BodyInit | undefined> {
+    if (type === "form") {
+        return toQueryString(body, { arrayFormat: "repeat", encode: true });
+    }
+    if (type.includes("json")) {
+        return toJson(body);
+    } else {
+        return body as BodyInit;
+    }
+}

package/src/_vendor/core/fetcher/getResponseBody.ts

@@ -0,0 +1,70 @@
+import { fromJson } from "../json.js";
+import { getBinaryResponse } from "./BinaryResponse.js";
+
+// Pins the upstream Response so undici's FinalizationRegistry can't GC it and cancel the body stream.
+function retainResponse(target: object, response: Response): void {
+    Object.defineProperty(target, "__fern_response_ref", {
+        value: response,
+        enumerable: false,
+        configurable: true,
+        writable: false,
+    });
+}
+
+export async function getResponseBody(response: Response, responseType?: string): Promise<unknown> {
+    switch (responseType) {
+        case "binary-response":
+            return getBinaryResponse(response);
+        case "blob":
+            return await response.blob();
+        case "arrayBuffer":
+            return await response.arrayBuffer();
+        case "sse":
+            if (response.body == null) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "body-is-null",
+                        statusCode: response.status,
+                    },
+                };
+            }
+            retainResponse(response.body, response);
+            return response.body;
+        case "streaming":
+            if (response.body == null) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "body-is-null",
+                        statusCode: response.status,
+                    },
+                };
+            }
+
+            retainResponse(response.body, response);
+            return response.body;
+
+        case "text":
+            return await response.text();
+    }
+
+    // if responseType is "json" or not specified, try to parse as JSON
+    const text = await response.text();
+    if (text.length > 0) {
+        try {
+            const responseBody = fromJson(text);
+            return responseBody;
+        } catch (_err) {
+            return {
+                ok: false,
+                error: {
+                    reason: "non-json",
+                    statusCode: response.status,
+                    rawBody: text,
+                },
+            };
+        }
+    }
+    return undefined;
+}

package/src/_vendor/core/fetcher/index.ts

@@ -0,0 +1,13 @@
+export type { APIResponse } from "./APIResponse.js";
+export type { BinaryResponse } from "./BinaryResponse.js";
+export type { EndpointMetadata } from "./EndpointMetadata.js";
+export { EndpointSupplier } from "./EndpointSupplier.js";
+export type { Fetcher, FetchFunction } from "./Fetcher.js";
+export { fetcher } from "./Fetcher.js";
+export { getHeader } from "./getHeader.js";
+export { HttpResponsePromise } from "./HttpResponsePromise.js";
+export type { PassthroughRequest } from "./makePassthroughRequest.js";
+export { makePassthroughRequest } from "./makePassthroughRequest.js";
+export type { RawResponse, WithRawResponse } from "./RawResponse.js";
+export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
+export { Supplier } from "./Supplier.js";

package/src/_vendor/core/fetcher/makePassthroughRequest.ts

@@ -0,0 +1,189 @@
+import { createLogger, type LogConfig, type Logger } from "../logging/logger.js";
+import { join } from "../url/join.js";
+import { EndpointSupplier } from "./EndpointSupplier.js";
+import { getFetchFn } from "./getFetchFn.js";
+import { makeRequest } from "./makeRequest.js";
+import { requestWithRetries } from "./requestWithRetries.js";
+import { Supplier } from "./Supplier.js";
+
+export declare namespace PassthroughRequest {
+    /**
+     * Per-request options that can override the SDK client defaults.
+     */
+    export interface RequestOptions {
+        /** Override the default timeout for this request (in seconds). */
+        timeoutInSeconds?: number;
+        /** Override the default number of retries for this request. */
+        maxRetries?: number;
+        /** Additional headers to include in this request. */
+        headers?: Record<string, string>;
+        /** Abort signal for this request. */
+        abortSignal?: AbortSignal;
+    }
+
+    /**
+     * SDK client configuration used by the passthrough fetch method.
+     */
+    export interface ClientOptions {
+        /** The base URL or environment for the client. */
+        environment?: Supplier<string>;
+        /** Override the base URL. */
+        baseUrl?: Supplier<string>;
+        /** Default headers to include in requests. */
+        headers?: Record<string, unknown>;
+        /** Default maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** Default number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A custom fetch function. */
+        fetch?: typeof fetch;
+        /** Logging configuration. */
+        logging?: LogConfig | Logger;
+        /** A function that returns auth headers. */
+        getAuthHeaders?: () => Promise<Record<string, string>>;
+    }
+}
+
+/**
+ * Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
+ * while mimicking the standard `fetch` API.
+ *
+ * @param input - The URL, path, or Request object. If a relative path, it will be resolved against the configured base URL.
+ * @param init - Standard RequestInit options (method, headers, body, signal, etc.)
+ * @param clientOptions - SDK client options (auth, default headers, logging, etc.)
+ * @param requestOptions - Per-request overrides (timeout, retries, extra headers, abort signal).
+ * @returns A standard Response object.
+ */
+export async function makePassthroughRequest(
+    input: Request | string | URL,
+    init: RequestInit | undefined,
+    clientOptions: PassthroughRequest.ClientOptions,
+    requestOptions?: PassthroughRequest.RequestOptions,
+): Promise<Response> {
+    const logger = createLogger(clientOptions.logging);
+
+    // Extract URL and default init properties from Request object if provided
+    let url: string;
+    let effectiveInit: RequestInit | undefined = init;
+    if (input instanceof Request) {
+        url = input.url;
+        // If no explicit init provided, extract properties from the Request object
+        if (init == null) {
+            effectiveInit = {
+                method: input.method,
+                headers: Object.fromEntries(input.headers.entries()),
+                body: input.body,
+                signal: input.signal,
+                credentials: input.credentials,
+                cache: input.cache as RequestCache,
+                redirect: input.redirect,
+                referrer: input.referrer,
+                integrity: input.integrity,
+                mode: input.mode,
+            };
+        }
+    } else {
+        url = input instanceof URL ? input.toString() : input;
+    }
+
+    // Resolve the base URL
+    const baseUrl =
+        (clientOptions.baseUrl != null ? await Supplier.get(clientOptions.baseUrl) : undefined) ??
+        (clientOptions.environment != null ? await Supplier.get(clientOptions.environment) : undefined);
+
+    // Determine the full URL
+    let fullUrl: string;
+    if (url.startsWith("http://") || url.startsWith("https://")) {
+        fullUrl = url;
+    } else if (baseUrl != null) {
+        fullUrl = join(baseUrl, url);
+    } else {
+        fullUrl = url;
+    }
+
+    // Merge headers: SDK default headers -> auth headers -> user-provided headers
+    const mergedHeaders: Record<string, string> = {};
+
+    // Apply SDK default headers (resolve suppliers)
+    if (clientOptions.headers != null) {
+        for (const [key, value] of Object.entries(clientOptions.headers)) {
+            const resolved = await EndpointSupplier.get(value, { endpointMetadata: {} });
+            if (resolved != null) {
+                mergedHeaders[key.toLowerCase()] = `${resolved}`;
+            }
+        }
+    }
+
+    // Apply auth headers
+    if (clientOptions.getAuthHeaders != null) {
+        const authHeaders = await clientOptions.getAuthHeaders();
+        for (const [key, value] of Object.entries(authHeaders)) {
+            mergedHeaders[key.toLowerCase()] = value;
+        }
+    }
+
+    // Apply user-provided headers from init
+    if (effectiveInit?.headers != null) {
+        const initHeaders =
+            effectiveInit.headers instanceof Headers
+                ? Object.fromEntries(effectiveInit.headers.entries())
+                : Array.isArray(effectiveInit.headers)
+                  ? Object.fromEntries(effectiveInit.headers)
+                  : effectiveInit.headers;
+        for (const [key, value] of Object.entries(initHeaders)) {
+            if (value != null) {
+                mergedHeaders[key.toLowerCase()] = value;
+            }
+        }
+    }
+
+    // Apply per-request option headers (highest priority)
+    if (requestOptions?.headers != null) {
+        for (const [key, value] of Object.entries(requestOptions.headers)) {
+            mergedHeaders[key.toLowerCase()] = value;
+        }
+    }
+
+    const method = effectiveInit?.method ?? "GET";
+    const body = effectiveInit?.body;
+    const timeoutInSeconds = requestOptions?.timeoutInSeconds ?? clientOptions.timeoutInSeconds;
+    const timeoutMs = timeoutInSeconds != null ? timeoutInSeconds * 1000 : undefined;
+    const maxRetries = requestOptions?.maxRetries ?? clientOptions.maxRetries;
+    const abortSignal = requestOptions?.abortSignal ?? effectiveInit?.signal ?? undefined;
+    const fetchFn = clientOptions.fetch ?? (await getFetchFn());
+
+    if (logger.isDebug()) {
+        logger.debug("Making passthrough HTTP request", {
+            method,
+            url: fullUrl,
+            hasBody: body != null,
+        });
+    }
+
+    const response = await requestWithRetries(
+        async () =>
+            makeRequest(
+                fetchFn,
+                fullUrl,
+                method,
+                mergedHeaders,
+                body ?? undefined,
+                timeoutMs,
+                abortSignal,
+                effectiveInit?.credentials === "include",
+                undefined, // duplex
+                false, // disableCache
+            ),
+        maxRetries,
+    );
+
+    if (logger.isDebug()) {
+        logger.debug("Passthrough HTTP request completed", {
+            method,
+            url: fullUrl,
+            statusCode: response.status,
+        });
+    }
+
+    return response;
+}

package/src/_vendor/core/fetcher/makeRequest.ts

@@ -0,0 +1,70 @@
+import { anySignal, getTimeoutSignal } from "./signals.js";
+
+/**
+ * Cached result of checking whether the current runtime supports
+ * the `cache` option in `Request`. Some runtimes (e.g. Cloudflare Workers)
+ * throw a TypeError when this option is used.
+ */
+let _cacheNoStoreSupported: boolean | undefined;
+export function isCacheNoStoreSupported(): boolean {
+    if (_cacheNoStoreSupported != null) {
+        return _cacheNoStoreSupported;
+    }
+    try {
+        new Request("http://localhost", { cache: "no-store" });
+        _cacheNoStoreSupported = true;
+    } catch {
+        _cacheNoStoreSupported = false;
+    }
+    return _cacheNoStoreSupported;
+}
+
+/**
+ * Reset the cached result of `isCacheNoStoreSupported`. Exposed for testing only.
+ */
+export function resetCacheNoStoreSupported(): void {
+    _cacheNoStoreSupported = undefined;
+}
+
+export const makeRequest = async (
+    fetchFn: (url: string, init: RequestInit) => Promise<Response>,
+    url: string,
+    method: string,
+    headers: Headers | Record<string, string>,
+    requestBody: BodyInit | undefined,
+    timeoutMs?: number,
+    abortSignal?: AbortSignal,
+    withCredentials?: boolean,
+    duplex?: "half",
+    disableCache?: boolean,
+): Promise<Response> => {
+    const signals: AbortSignal[] = [];
+
+    let timeoutAbortId: ReturnType<typeof setTimeout> | undefined;
+    if (timeoutMs != null) {
+        const { signal, abortId } = getTimeoutSignal(timeoutMs);
+        timeoutAbortId = abortId;
+        signals.push(signal);
+    }
+
+    if (abortSignal != null) {
+        signals.push(abortSignal);
+    }
+    const newSignals = anySignal(signals);
+    const response = await fetchFn(url, {
+        method: method,
+        headers,
+        body: requestBody,
+        signal: newSignals,
+        credentials: withCredentials ? "include" : undefined,
+        // @ts-ignore
+        duplex,
+        ...(disableCache && isCacheNoStoreSupported() ? { cache: "no-store" as RequestCache } : {}),
+    });
+
+    if (timeoutAbortId != null) {
+        clearTimeout(timeoutAbortId);
+    }
+
+    return response;
+};

package/src/_vendor/core/fetcher/requestWithRetries.ts

@@ -0,0 +1,68 @@
+const INITIAL_RETRY_DELAY = 1000; // in milliseconds
+const MAX_RETRY_DELAY = 60000; // in milliseconds
+const DEFAULT_MAX_RETRIES = 2;
+const JITTER_FACTOR = 0.2; // 20% random jitter
+
+function isRetryableStatusCode(statusCode: number): boolean {
+    return [408, 429].includes(statusCode) || statusCode >= 500;
+}
+
+function addPositiveJitter(delay: number): number {
+    const jitterMultiplier = 1 + Math.random() * JITTER_FACTOR;
+    return delay * jitterMultiplier;
+}
+
+function addSymmetricJitter(delay: number): number {
+    const jitterMultiplier = 1 + (Math.random() - 0.5) * JITTER_FACTOR;
+    return delay * jitterMultiplier;
+}
+
+function getRetryDelayFromHeaders(response: Response, retryAttempt: number): number {
+    const retryAfter = response.headers.get("Retry-After");
+    if (retryAfter) {
+        const retryAfterSeconds = parseInt(retryAfter, 10);
+        if (!Number.isNaN(retryAfterSeconds) && retryAfterSeconds > 0) {
+            return Math.min(retryAfterSeconds * 1000, MAX_RETRY_DELAY);
+        }
+
+        const retryAfterDate = new Date(retryAfter);
+        if (!Number.isNaN(retryAfterDate.getTime())) {
+            const delay = retryAfterDate.getTime() - Date.now();
+            if (delay > 0) {
+                return Math.min(Math.max(delay, 0), MAX_RETRY_DELAY);
+            }
+        }
+    }
+
+    const rateLimitReset = response.headers.get("X-RateLimit-Reset");
+    if (rateLimitReset) {
+        const resetTime = parseInt(rateLimitReset, 10);
+        if (!Number.isNaN(resetTime)) {
+            const delay = resetTime * 1000 - Date.now();
+            if (delay > 0) {
+                return addPositiveJitter(Math.min(delay, MAX_RETRY_DELAY));
+            }
+        }
+    }
+
+    return addSymmetricJitter(Math.min(INITIAL_RETRY_DELAY * 2 ** retryAttempt, MAX_RETRY_DELAY));
+}
+
+export async function requestWithRetries(
+    requestFn: () => Promise<Response>,
+    maxRetries: number = DEFAULT_MAX_RETRIES,
+): Promise<Response> {
+    let response: Response = await requestFn();
+
+    for (let i = 0; i < maxRetries; ++i) {
+        if (isRetryableStatusCode(response.status)) {
+            const delay = getRetryDelayFromHeaders(response, i);
+
+            await new Promise((resolve) => setTimeout(resolve, delay));
+            response = await requestFn();
+        } else {
+            break;
+        }
+    }
+    return response!;
+}

package/src/_vendor/core/fetcher/signals.ts

@@ -0,0 +1,26 @@
+const TIMEOUT = "timeout";
+
+export function getTimeoutSignal(timeoutMs: number): { signal: AbortSignal; abortId: ReturnType<typeof setTimeout> } {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+
+export function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal {
+    const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args) as AbortSignal[];
+
+    const controller = new AbortController();
+
+    for (const signal of signals) {
+        if (signal.aborted) {
+            controller.abort((signal as any)?.reason);
+            break;
+        }
+
+        signal.addEventListener("abort", () => controller.abort((signal as any)?.reason), {
+            signal: controller.signal,
+        });
+    }
+
+    return controller.signal;
+}

package/src/_vendor/core/headers.ts

@@ -0,0 +1,33 @@
+export function mergeHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown> {
+    const result: Record<string, unknown> = {};
+
+    for (const [key, value] of headersArray
+        .filter((headers) => headers != null)
+        .flatMap((headers) => Object.entries(headers))) {
+        const insensitiveKey = key.toLowerCase();
+        if (value != null) {
+            result[insensitiveKey] = value;
+        } else if (insensitiveKey in result) {
+            delete result[insensitiveKey];
+        }
+    }
+
+    return result;
+}
+
+export function mergeOnlyDefinedHeaders(
+    ...headersArray: (Record<string, unknown> | null | undefined)[]
+): Record<string, unknown> {
+    const result: Record<string, unknown> = {};
+
+    for (const [key, value] of headersArray
+        .filter((headers) => headers != null)
+        .flatMap((headers) => Object.entries(headers))) {
+        const insensitiveKey = key.toLowerCase();
+        if (value != null) {
+            result[insensitiveKey] = value;
+        }
+    }
+
+    return result;
+}

package/src/_vendor/core/index.ts

@@ -0,0 +1,6 @@
+export * from "./auth/index.js";
+export * from "./base64.js";
+export * from "./fetcher/index.js";
+export * as logging from "./logging/index.js";
+export * from "./runtime/index.js";
+export * as url from "./url/index.js";

package/src/_vendor/core/json.ts

@@ -0,0 +1,27 @@
+/**
+ * Serialize a value to JSON
+ * @param value A JavaScript value, usually an object or array, to be converted.
+ * @param replacer A function that transforms the results.
+ * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+ * @returns JSON string
+ */
+export const toJson = (
+    value: unknown,
+    replacer?: (this: unknown, key: string, value: unknown) => unknown,
+    space?: string | number,
+): string => {
+    return JSON.stringify(value, replacer, space);
+};
+
+/**
+ * Parse JSON string to object, array, or other type
+ * @param text A valid JSON string.
+ * @param reviver A function that transforms the results. This function is called for each member of the object. If a member contains nested objects, the nested objects are transformed before the parent object is.
+ * @returns Parsed object, array, or other type
+ */
+export function fromJson<T = unknown>(
+    text: string,
+    reviver?: (this: unknown, key: string, value: unknown) => unknown,
+): T {
+    return JSON.parse(text, reviver);
+}

package/src/_vendor/core/logging/exports.ts

@@ -0,0 +1,19 @@
+import * as logger from "./logger.js";
+
+export namespace logging {
+    /**
+     * Configuration for logger instances.
+     */
+    export type LogConfig = logger.LogConfig;
+    export type LogLevel = logger.LogLevel;
+    export const LogLevel: typeof logger.LogLevel = logger.LogLevel;
+    export type ILogger = logger.ILogger;
+    /**
+     * Console logger implementation that outputs to the console.
+     */
+    export type ConsoleLogger = logger.ConsoleLogger;
+    /**
+     * Console logger implementation that outputs to the console.
+     */
+    export const ConsoleLogger: typeof logger.ConsoleLogger = logger.ConsoleLogger;
+}

package/src/_vendor/core/logging/index.ts

@@ -0,0 +1 @@
+export * from "./logger.js";