wreq-js 1.4.0 → 1.5.2

package/dist/wreq-js.d.ts

@@ -1,6 +1,457 @@
-import { ReadableStream } from "node:stream/web";
-import type { BodyInit, BrowserProfile, CreateSessionOptions, EmulationOS, HeadersInit, HeaderTuple, NativeResponse, NativeWebSocketConnection, RequestOptions, SessionHandle, WebSocketOptions, RequestInit as WreqRequestInit } from "./types";
-import { RequestError } from "./types";
+import { ReadableStream } from 'node:stream/web';
+
+/**
+ * Auto-generated from Rust build script
+ * DO NOT EDIT MANUALLY
+ */
+/**
+ * Browser profile names supported
+ */
+type BrowserProfile = 'chrome_100' | 'chrome_101' | 'chrome_104' | 'chrome_105' | 'chrome_106' | 'chrome_107' | 'chrome_108' | 'chrome_109' | 'chrome_110' | 'chrome_114' | 'chrome_116' | 'chrome_117' | 'chrome_118' | 'chrome_119' | 'chrome_120' | 'chrome_123' | 'chrome_124' | 'chrome_126' | 'chrome_127' | 'chrome_128' | 'chrome_129' | 'chrome_130' | 'chrome_131' | 'chrome_132' | 'chrome_133' | 'chrome_134' | 'chrome_135' | 'chrome_136' | 'chrome_137' | 'chrome_138' | 'chrome_139' | 'chrome_140' | 'chrome_141' | 'chrome_142' | 'chrome_143' | 'edge_101' | 'edge_122' | 'edge_127' | 'edge_131' | 'edge_134' | 'edge_135' | 'edge_136' | 'edge_137' | 'edge_138' | 'edge_139' | 'edge_140' | 'edge_141' | 'edge_142' | 'opera_116' | 'opera_117' | 'opera_118' | 'opera_119' | 'safari_ios_17.2' | 'safari_ios_17.4.1' | 'safari_ios_16.5' | 'safari_15.3' | 'safari_15.5' | 'safari_15.6.1' | 'safari_16' | 'safari_16.5' | 'safari_17.0' | 'safari_17.2.1' | 'safari_17.4.1' | 'safari_17.5' | 'safari_17.6' | 'safari_18' | 'safari_ipad_18' | 'safari_18.2' | 'safari_ios_18.1.1' | 'safari_18.3' | 'safari_18.3.1' | 'safari_18.5' | 'safari_26' | 'safari_26.1' | 'safari_26.2' | 'safari_ipad_26' | 'safari_ipad_26.2' | 'safari_ios_26' | 'safari_ios_26.2' | 'firefox_109' | 'firefox_117' | 'firefox_128' | 'firefox_133' | 'firefox_135' | 'firefox_private_135' | 'firefox_android_135' | 'firefox_136' | 'firefox_private_136' | 'firefox_139' | 'firefox_142' | 'firefox_143' | 'firefox_144' | 'firefox_145' | 'okhttp_3.9' | 'okhttp_3.11' | 'okhttp_3.13' | 'okhttp_3.14' | 'okhttp_4.9' | 'okhttp_4.10' | 'okhttp_4.12' | 'okhttp_5';
+/**
+ * Operating systems supported for emulation
+ */
+type EmulationOS = 'windows' | 'macos' | 'linux' | 'android' | 'ios';
+
+/**
+ * Controls how cookies are scoped for a request.
+ * - "session": reuse an explicit Session or sessionId across calls.
+ * - "ephemeral": create an isolated, single-use session.
+ */
+type CookieMode = "session" | "ephemeral";
+/**
+ * Minimal handle implemented by {@link Session}. Exposed for integrations
+ * that only need to carry a session id.
+ */
+interface SessionHandle {
+    readonly id: string;
+}
+/**
+ * A tuple of [name, value] pairs used for initializing headers.
+ * Both name and value must be strings.
+ *
+ * @example
+ * ```typescript
+ * const headers: HeaderTuple = ['Content-Type', 'application/json'];
+ * ```
+ */
+type HeaderTuple = [string, string];
+/**
+ * Represents various input types accepted when creating or initializing headers.
+ * Can be an iterable of header tuples, an array of tuples, or a plain object.
+ *
+ * @example
+ * ```typescript
+ * // As an object
+ * const headers: HeadersInit = { 'Content-Type': 'application/json' };
+ *
+ * // As an array of tuples
+ * const headers: HeadersInit = [['Content-Type', 'application/json']];
+ *
+ * // As an iterable
+ * const headers: HeadersInit = new Map([['Content-Type', 'application/json']]);
+ * ```
+ */
+type HeadersInit = Iterable<HeaderTuple> | Array<HeaderTuple> | Record<string, string | number | boolean | null | undefined>;
+/**
+ * Represents the various types of data that can be used as a request body.
+ * Supports string, binary data (ArrayBuffer, ArrayBufferView), URL-encoded parameters, and Node.js Buffer.
+ *
+ * @example
+ * ```typescript
+ * // String body
+ * const body: BodyInit = JSON.stringify({ key: 'value' });
+ *
+ * // URLSearchParams
+ * const body: BodyInit = new URLSearchParams({ key: 'value' });
+ *
+ * // Buffer
+ * const body: BodyInit = Buffer.from('data');
+ * ```
+ */
+type BodyInit = string | ArrayBuffer | ArrayBufferView | URLSearchParams | Buffer;
+/**
+ * Options for configuring a fetch request. Compatible with the standard Fetch API
+ * with additional wreq-specific extensions for browser impersonation, proxies, and timeouts.
+ *
+ * @example
+ * ```typescript
+ * const options: RequestInit = {
+ *   method: 'POST',
+ *   headers: { 'Content-Type': 'application/json' },
+ *   body: JSON.stringify({ key: 'value' }),
+ *   browser: 'chrome_142',
+ *   proxy: 'http://proxy.example.com:8080',
+ *   timeout: 5000
+ * };
+ * ```
+ */
+interface RequestInit {
+    /**
+     * A string to set request's method.
+     * @default 'GET'
+     */
+    method?: string;
+    /**
+     * A Headers object, an object literal, or an array of two-item arrays to set request's headers.
+     */
+    headers?: HeadersInit;
+    /**
+     * A BodyInit object or null to set request's body.
+     */
+    body?: BodyInit | null;
+    /**
+     * An AbortSignal to set request's signal.
+     */
+    signal?: AbortSignal | null;
+    /**
+     * A string indicating whether request follows redirects, results in an error upon
+     * encountering a redirect, or returns the redirect (in an opaque fashion).
+     * @default 'follow'
+     */
+    redirect?: "follow" | "manual" | "error";
+    /**
+     * Browser profile to impersonate for this request.
+     * Automatically applies browser-specific headers, TLS fingerprints, and HTTP/2 settings.
+     * @default 'chrome_142'
+     */
+    browser?: BrowserProfile;
+    /**
+     * Operating system to emulate for this request.
+     * Influences platform-specific headers and TLS fingerprints.
+     * @default 'macos'
+     */
+    os?: EmulationOS;
+    /**
+     * Proxy URL to route the request through (e.g., 'http://proxy.example.com:8080').
+     * Supports HTTP and SOCKS5 proxies.
+     */
+    proxy?: string;
+    /**
+     * Request timeout in milliseconds. If the request takes longer than this value,
+     * it will be aborted.
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Controls how cookies are managed for this call.
+     * - "ephemeral": default when no session/sessionId is provided. Creates an isolated session per request.
+     * - "session": requires an explicit session or sessionId and reuses its cookie jar.
+     */
+    cookieMode?: CookieMode;
+    /**
+     * Session instance to bind this request to. When provided, {@link cookieMode}
+     * automatically behaves like `"session"`.
+     */
+    session?: Session;
+    /**
+     * Identifier of an existing session created elsewhere (e.g., via {@link createSession}).
+     */
+    sessionId?: string;
+    /**
+     * Disable default headers from browser emulation. When enabled, only explicitly
+     * provided headers will be sent with the request, preventing emulation headers
+     * from being automatically added or appended.
+     * @default false
+     */
+    disableDefaultHeaders?: boolean;
+    /**
+     * Disable HTTPS certificate verification. When enabled, self-signed and invalid
+     * certificates will be accepted.
+     *
+     * # Warning
+     *
+     * You should think very carefully before using this method. If invalid
+     * certificates are trusted, *any* certificate for *any* site will be
+     * trusted for use. This includes expired certificates. This introduces
+     * significant vulnerabilities, and should only be used as a last resort.
+     *
+     * @default false
+     */
+    insecure?: boolean;
+}
+/**
+ * Configuration for {@link createSession}.
+ */
+interface CreateSessionOptions {
+    /**
+     * Provide a custom identifier instead of an auto-generated random ID.
+     */
+    sessionId?: string;
+    /**
+     * Browser profile to bind to this session. Defaults to 'chrome_142'.
+     */
+    browser?: BrowserProfile;
+    /**
+     * Operating system to bind to this session. Defaults to 'macos'.
+     */
+    os?: EmulationOS;
+    /**
+     * Optional proxy for every request made through the session.
+     */
+    proxy?: string;
+    /**
+     * Default timeout applied when {@link Session.fetch} is called without
+     * overriding `timeout`.
+     */
+    timeout?: number;
+    /**
+     * Disable HTTPS certificate verification. When enabled, self-signed and invalid
+     * certificates will be accepted for all requests made through this session.
+     *
+     * # Warning
+     *
+     * You should think very carefully before using this method. If invalid
+     * certificates are trusted, *any* certificate for *any* site will be
+     * trusted for use. This includes expired certificates. This introduces
+     * significant vulnerabilities, and should only be used as a last resort.
+     *
+     * @default false
+     */
+    insecure?: boolean;
+}
+/**
+ * Legacy request options interface. This interface is deprecated and will be removed in a future version.
+ *
+ * @deprecated Use {@link RequestInit} with the standard `fetch()` API instead.
+ *
+ * @example
+ * ```typescript
+ * // Old (deprecated):
+ * const options: RequestOptions = {
+ *   url: 'https://api.example.com',
+ *   method: 'POST',
+ *   body: JSON.stringify({ data: 'value' })
+ * };
+ *
+ * // New (recommended):
+ * const response = await fetch('https://api.example.com', {
+ *   method: 'POST',
+ *   body: JSON.stringify({ data: 'value' })
+ * });
+ * ```
+ */
+interface RequestOptions {
+    /**
+     * The URL to request.
+     */
+    url: string;
+    /**
+     * Browser profile to impersonate.
+     * Automatically applies browser-specific headers, TLS fingerprints, and HTTP/2 settings.
+     * @default 'chrome_142'
+     */
+    browser?: BrowserProfile;
+    /**
+     * Operating system to emulate.
+     * @default 'macos'
+     */
+    os?: EmulationOS;
+    /**
+     * HTTP method to use for the request.
+     * @default 'GET'
+     */
+    method?: string;
+    /**
+     * Additional headers to send with the request.
+     * Browser-specific headers will be automatically added based on the selected browser profile.
+     */
+    headers?: Record<string, string> | HeaderTuple[];
+    /**
+     * Request body data (for POST, PUT, PATCH requests).
+     */
+    body?: Buffer;
+    /**
+     * Proxy URL to route the request through (e.g., 'http://proxy.example.com:8080').
+     * Supports HTTP and SOCKS5 proxies.
+     */
+    proxy?: string;
+    /**
+     * Redirect policy applied to this request. Matches the `redirect` option accepted by {@link fetch}.
+     * @default "follow"
+     */
+    redirect?: "follow" | "manual" | "error";
+    /**
+     * Request timeout in milliseconds. If the request takes longer than this value,
+     * it will be aborted.
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Identifier for the session that should handle this request.
+     * @internal
+     */
+    sessionId?: string;
+    /**
+     * Internal flag indicating whether the session should be discarded once the
+     * request finishes.
+     * @internal
+     */
+    ephemeral?: boolean;
+    /**
+     * Disable default headers from browser emulation. When enabled, only explicitly
+     * provided headers will be sent with the request, preventing emulation headers
+     * from being automatically added or appended.
+     * @default false
+     */
+    disableDefaultHeaders?: boolean;
+    /**
+     * Disable HTTPS certificate verification. When enabled, self-signed and invalid
+     * certificates will be accepted.
+     *
+     * # Warning
+     *
+     * You should think very carefully before using this method. If invalid
+     * certificates are trusted, *any* certificate for *any* site will be
+     * trusted for use. This includes expired certificates. This introduces
+     * significant vulnerabilities, and should only be used as a last resort.
+     *
+     * @default false
+     */
+    insecure?: boolean;
+}
+/**
+ * Internal response payload returned from the native Rust binding.
+ * This interface represents the raw response data before it's converted
+ * to a standard Response object.
+ *
+ * @internal
+ */
+interface NativeResponse {
+    /**
+     * HTTP status code (e.g., 200, 404, 500).
+     */
+    status: number;
+    /**
+     * Response headers as [name, value] tuples.
+     * Header names are normalized to lowercase.
+     */
+    headers: HeaderTuple[];
+    /**
+     * Handle for streaming response body chunks from the native layer.
+     * When `null`, the response does not have a body (e.g., HEAD/204/304).
+     */
+    bodyHandle: number | null;
+    /**
+     * Inline body buffer returned for small payloads. When present, `bodyHandle`
+     * will be `null` to avoid a second native round-trip to read the body.
+     */
+    bodyBytes: Buffer | null;
+    /**
+     * Optional Content-Length hint reported by the server after decompression.
+     */
+    contentLength: number | null;
+    /**
+     * Cookies set by the server as [name, value] tuples.
+     */
+    cookies: HeaderTuple[];
+    /**
+     * Final URL after following any redirects.
+     * If no redirects occurred, this will match the original request URL.
+     */
+    url: string;
+}
+/**
+ * Configuration options for creating a WebSocket connection.
+ * Supports browser impersonation and proxies, similar to HTTP requests.
+ *
+ * @example
+ * ```typescript
+ * const ws = await createWebSocket({
+ *   url: 'wss://echo.websocket.org',
+ *   browser: 'chrome_142',
+ *   headers: { 'Authorization': 'Bearer token' },
+ *   onMessage: (data) => {
+ *     console.log('Received:', data);
+ *   },
+ *   onClose: () => {
+ *     console.log('Connection closed');
+ *   },
+ *   onError: (error) => {
+ *     console.error('WebSocket error:', error);
+ *   }
+ * });
+ * ```
+ */
+interface WebSocketOptions {
+    /**
+     * The WebSocket URL to connect to. Must use wss:// (secure) or ws:// (insecure) protocol.
+     */
+    url: string;
+    /**
+     * Browser profile to impersonate for the WebSocket upgrade request.
+     * Automatically applies browser-specific headers and TLS fingerprints.
+     * @default 'chrome_142'
+     */
+    browser?: BrowserProfile;
+    /**
+     * Operating system to emulate for the WebSocket handshake.
+     * @default 'macos'
+     */
+    os?: EmulationOS;
+    /**
+     * Additional headers to send with the WebSocket upgrade request.
+     * Common headers include Authorization, Origin, or custom application headers.
+     */
+    headers?: Record<string, string> | HeaderTuple[];
+    /**
+     * Proxy URL to route the connection through (e.g., 'http://proxy.example.com:8080').
+     * Supports HTTP and SOCKS5 proxies.
+     */
+    proxy?: string;
+    /**
+     * Callback function invoked when a message is received from the server.
+     * The data parameter will be a string for text frames or a Buffer for binary frames.
+     *
+     * @param data - The received message as a string or Buffer
+     */
+    onMessage: (data: string | Buffer) => void;
+    /**
+     * Callback function invoked when the WebSocket connection is closed.
+     * This is called for both clean closes and connection errors.
+     */
+    onClose?: () => void;
+    /**
+     * Callback function invoked when a connection or protocol error occurs.
+     *
+     * @param error - A string describing the error that occurred
+     */
+    onError?: (error: string) => void;
+}
+/**
+ * Internal WebSocket connection object returned from the native Rust binding.
+ * This interface contains the connection ID used to reference the WebSocket
+ * in subsequent operations like sending messages or closing the connection.
+ *
+ * @internal
+ */
+interface NativeWebSocketConnection {
+    /**
+     * Unique identifier for this WebSocket connection.
+     * Used internally to track and manage the connection.
+     * @internal
+     */
+    _id: number;
+}
+/**
+ * Error thrown when a request fails. This can occur due to network errors,
+ * timeouts, invalid URLs, or other request-related issues.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const response = await fetch('https://api.example.com');
+ * } catch (error) {
+ *   if (error instanceof RequestError) {
+ *     console.error('Request failed:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare class RequestError extends Error {
+    constructor(message: string);
+}
+
 type SessionDefaults = {
     browser: BrowserProfile;
     os: EmulationOS;
@@ -8,7 +459,7 @@ type SessionDefaults = {
     timeout?: number;
     insecure?: boolean;
 };
-export declare class Headers implements Iterable<[string, string]> {
+declare class Headers implements Iterable<[string, string]> {
     private readonly store;
     constructor(init?: HeadersInit);
     private applyInit;
@@ -28,26 +479,29 @@ export declare class Headers implements Iterable<[string, string]> {
     toTuples(): HeaderTuple[];
 }
 type ResponseType = "basic" | "cors" | "error" | "opaque" | "opaqueredirect";
-export declare class Response {
+declare class Response {
     readonly status: number;
-    readonly statusText: string;
     readonly ok: boolean;
     readonly contentLength: number | null;
     readonly url: string;
-    readonly redirected: boolean;
     readonly type: ResponseType;
-    readonly cookies: Record<string, string>;
     bodyUsed: boolean;
     private readonly payload;
     private readonly requestUrl;
+    private redirectedMemo;
     private readonly headersInit;
     private headersInstance;
+    private readonly cookiesInit;
+    private cookiesRecord;
     private inlineBody;
     private bodySource;
     private bodyStream;
     private nativeHandleAvailable;
     constructor(payload: NativeResponse, requestUrl: string, bodySource?: ReadableStream<Uint8Array> | null);
+    get redirected(): boolean;
+    get statusText(): string;
     get headers(): Headers;
+    get cookies(): Record<string, string | string[]>;
     get body(): ReadableStream<Uint8Array> | null;
     json<T = unknown>(): Promise<T>;
     arrayBuffer(): Promise<ArrayBuffer>;
@@ -56,7 +510,7 @@ export declare class Response {
     private assertBodyAvailable;
     private consumeBody;
 }
-export declare class Session implements SessionHandle {
+declare class Session implements SessionHandle {
     readonly id: string;
     private disposed;
     private readonly defaults;
@@ -65,10 +519,9 @@ export declare class Session implements SessionHandle {
     private ensureActive;
     /** @internal */
     getDefaults(): SessionDefaults;
-    private enforceBrowser;
-    private enforceOs;
-    private enforceProxy;
-    fetch(input: string | URL, init?: WreqRequestInit): Promise<Response>;
+    /** @internal */
+    _defaultsRef(): SessionDefaults;
+    fetch(input: string | URL, init?: RequestInit): Promise<Response>;
     clearCookies(): Promise<void>;
     close(): Promise<void>;
 }
@@ -103,13 +556,13 @@ export declare class Session implements SessionHandle {
  * });
  * ```
  */
-export declare function fetch(input: string | URL, init?: WreqRequestInit): Promise<Response>;
-export declare function createSession(options?: CreateSessionOptions): Promise<Session>;
-export declare function withSession<T>(fn: (session: Session) => Promise<T> | T, options?: CreateSessionOptions): Promise<T>;
+declare function fetch(input: string | URL, init?: RequestInit): Promise<Response>;
+declare function createSession(options?: CreateSessionOptions): Promise<Session>;
+declare function withSession<T>(fn: (session: Session) => Promise<T> | T, options?: CreateSessionOptions): Promise<T>;
 /**
  * @deprecated Use {@link fetch} instead.
  */
-export declare function request(options: RequestOptions): Promise<Response>;
+declare function request(options: RequestOptions): Promise<Response>;
 /**
  * Get list of available browser profiles
  *
@@ -123,21 +576,21 @@ export declare function request(options: RequestOptions): Promise<Response>;
  * console.log(profiles); // ['chrome_120', 'chrome_131', 'firefox', ...]
  * ```
  */
-export declare function getProfiles(): BrowserProfile[];
+declare function getProfiles(): BrowserProfile[];
 /**
  * Get list of supported operating systems for emulation.
  *
  * @returns Array of operating system identifiers
  */
-export declare function getOperatingSystems(): EmulationOS[];
+declare function getOperatingSystems(): EmulationOS[];
 /**
  * Convenience helper for GET requests using {@link fetch}.
  */
-export declare function get(url: string, init?: Omit<WreqRequestInit, "method">): Promise<Response>;
+declare function get(url: string, init?: Omit<RequestInit, "method">): Promise<Response>;
 /**
  * Convenience helper for POST requests using {@link fetch}.
  */
-export declare function post(url: string, body?: BodyInit | null, init?: Omit<WreqRequestInit, "method" | "body">): Promise<Response>;
+declare function post(url: string, body?: BodyInit | null, init?: Omit<RequestInit, "method" | "body">): Promise<Response>;
 /**
  * WebSocket connection class
  *
@@ -169,7 +622,7 @@ export declare function post(url: string, body?: BodyInit | null, init?: Omit<Wr
  * await ws.close();
  * ```
  */
-export declare class WebSocket {
+declare class WebSocket {
     private _connection;
     private _finalizerToken;
     private _closed;
@@ -189,9 +642,8 @@ export declare class WebSocket {
  * @param options - WebSocket options
  * @returns Promise that resolves to the WebSocket instance
  */
-export declare function websocket(options: WebSocketOptions): Promise<WebSocket>;
-export type { BodyInit, BrowserProfile, CookieMode, CreateSessionOptions, EmulationOS, HeadersInit, RequestInit, RequestOptions, SessionHandle, WebSocketOptions, } from "./types";
-export { RequestError };
+declare function websocket(options: WebSocketOptions): Promise<WebSocket>;
+
 declare const _default: {
     fetch: typeof fetch;
     request: typeof request;
@@ -207,5 +659,5 @@ declare const _default: {
     Response: typeof Response;
     Session: typeof Session;
 };
-export default _default;
-//# sourceMappingURL=wreq-js.d.ts.map
+
+export { type BodyInit, type BrowserProfile, type CookieMode, type CreateSessionOptions, type EmulationOS, Headers, type HeadersInit, RequestError, type RequestInit, type RequestOptions, Response, Session, type SessionHandle, WebSocket, type WebSocketOptions, createSession, _default as default, fetch, get, getOperatingSystems, getProfiles, post, request, websocket, withSession };