wreq-js 2.1.0 → 2.2.0

package/dist/wreq-js.d.cts

@@ -1,3 +1,4 @@
+import { Readable } from 'node:stream';
 import { ReadableStream } from 'node:stream/web';
 
 /**
@@ -53,6 +54,94 @@ type HeaderTuple = [string, string];
  * ```
  */
 type HeadersInit = Iterable<HeaderTuple> | Array<HeaderTuple> | Record<string, string | number | boolean | null | undefined>;
+type AlpnProtocol = "HTTP1" | "HTTP2" | "HTTP3";
+type AlpsProtocol = "HTTP1" | "HTTP2" | "HTTP3";
+type TlsVersion = "1.0" | "1.1" | "1.2" | "1.3" | "TLS1.0" | "TLS1.1" | "TLS1.2" | "TLS1.3";
+type Http2PseudoHeaderId = "Method" | "Scheme" | "Authority" | "Path" | "Protocol";
+type Http2SettingId = "HeaderTableSize" | "EnablePush" | "MaxConcurrentStreams" | "InitialWindowSize" | "MaxFrameSize" | "MaxHeaderListSize" | "EnableConnectProtocol" | "NoRfc7540Priorities";
+interface Http2StreamDependency {
+    dependencyId: number;
+    weight: number;
+    exclusive?: boolean;
+}
+interface Http2Priority {
+    streamId: number;
+    dependency: Http2StreamDependency;
+}
+interface Http2ExperimentalSetting {
+    id: number;
+    value: number;
+}
+interface CustomTlsOptions {
+    alpnProtocols?: AlpnProtocol[];
+    alpsProtocols?: AlpsProtocol[];
+    alpsUseNewCodepoint?: boolean;
+    sessionTicket?: boolean;
+    minTlsVersion?: TlsVersion;
+    maxTlsVersion?: TlsVersion;
+    preSharedKey?: boolean;
+    enableEchGrease?: boolean;
+    permuteExtensions?: boolean;
+    greaseEnabled?: boolean;
+    enableOcspStapling?: boolean;
+    enableSignedCertTimestamps?: boolean;
+    recordSizeLimit?: number;
+    pskSkipSessionTicket?: boolean;
+    keySharesLimit?: number;
+    pskDheKe?: boolean;
+    renegotiation?: boolean;
+    delegatedCredentials?: string;
+    curvesList?: string;
+    cipherList?: string;
+    sigalgsList?: string;
+    certificateCompressionAlgorithms?: Array<"zlib" | "brotli" | "zstd">;
+    extensionPermutation?: number[];
+    aesHwOverride?: boolean;
+    preserveTls13CipherList?: boolean;
+    randomAesHwOverride?: boolean;
+}
+interface CustomHttp1Options {
+    http09Responses?: boolean;
+    writev?: boolean;
+    maxHeaders?: number;
+    readBufExactSize?: number;
+    maxBufSize?: number;
+    ignoreInvalidHeadersInResponses?: boolean;
+    allowSpacesAfterHeaderNameInResponses?: boolean;
+    allowObsoleteMultilineHeadersInResponses?: boolean;
+}
+interface CustomHttp2Options {
+    adaptiveWindow?: boolean;
+    initialStreamId?: number;
+    initialConnectionWindowSize?: number;
+    initialWindowSize?: number;
+    initialMaxSendStreams?: number;
+    maxFrameSize?: number;
+    keepAliveInterval?: number;
+    keepAliveTimeout?: number;
+    keepAliveWhileIdle?: boolean;
+    maxConcurrentResetStreams?: number;
+    maxSendBufferSize?: number;
+    maxConcurrentStreams?: number;
+    maxHeaderListSize?: number;
+    maxPendingAcceptResetStreams?: number;
+    enablePush?: boolean;
+    headerTableSize?: number;
+    enableConnectProtocol?: boolean;
+    noRfc7540Priorities?: boolean;
+    settingsOrder?: Http2SettingId[];
+    headersPseudoOrder?: Http2PseudoHeaderId[];
+    headersStreamDependency?: Http2StreamDependency;
+    priorities?: Http2Priority[];
+    experimentalSettings?: Http2ExperimentalSetting[];
+}
+interface CustomEmulationOptions {
+    tlsOptions?: CustomTlsOptions;
+    http1Options?: CustomHttp1Options;
+    http2Options?: CustomHttp2Options;
+    headers?: HeadersInit;
+    origHeaders?: string[];
+}
 /**
  * Represents the various types of data that can be used as a request body.
  * Supports strings, binary payloads, URL-encoded parameters, multipart forms, and blobs.
@@ -176,6 +265,12 @@ interface RequestInit {
      * @default 'macos'
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides. When `browser` or `os` is present, these fields
+     * layer on top of the resolved preset profile. When both are omitted, this
+     * switches the request into standalone custom emulation mode.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Proxy URL to route the request through (e.g., 'http://proxy.example.com:8080').
      * Proxy support depends on the native layer and proxy scheme.
@@ -254,6 +349,10 @@ interface CreateSessionOptions {
      * Operating system to bind to this session. Defaults to 'macos'.
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides or a standalone custom emulation for the session transport.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Optional proxy for every request made through the session.
      */
@@ -294,6 +393,10 @@ interface CreateTransportOptions {
      * Operating system to emulate for this transport.
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides or a standalone custom emulation for this transport.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Disable HTTPS certificate verification for this transport.
      */
@@ -356,6 +459,12 @@ interface RequestOptions {
      * @default 'macos'
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides. When `browser` or `os` is present, these fields
+     * layer on top of the resolved preset profile. When both are omitted, this
+     * switches the request into standalone custom emulation mode.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * HTTP method to use for the request.
      * @default 'GET'
@@ -505,6 +614,12 @@ interface WebSocketOptions {
      * @default 'macos'
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides. When `browser` or `os` is present, these fields
+     * layer on top of the resolved preset profile. When both are omitted, this
+     * switches the handshake into standalone custom emulation mode.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Additional headers to send with the WebSocket upgrade request.
      * Common headers include Authorization, Origin, or custom application headers.
@@ -547,7 +662,7 @@ interface LegacyWebSocketOptions extends WebSocketOptions {
      */
     onError?: (error: string) => void;
 }
-type SessionWebSocketOptions = Omit<WebSocketOptions, "browser" | "os" | "proxy">;
+type SessionWebSocketOptions = Omit<WebSocketOptions, "browser" | "os" | "proxy" | "emulation">;
 interface LegacySessionWebSocketOptions extends SessionWebSocketOptions {
     /**
      * @deprecated Use `session.websocket(url, options)`.
@@ -615,8 +730,7 @@ interface NativeWebSocketCloseEvent {
     reason: string;
 }
 type SessionDefaults = {
-    browser: BrowserProfile;
-    os: EmulationOS;
+    transportMode: ResolvedEmulationMode;
     proxy?: string;
     timeout?: number;
     insecure?: boolean;
@@ -624,6 +738,17 @@ type SessionDefaults = {
     transportId?: string;
     ownsTransport?: boolean;
 };
+type PresetEmulationMode = {
+    kind: "preset";
+    browser: BrowserProfile;
+    os: EmulationOS;
+    emulationJson?: string;
+};
+type CustomEmulationMode = {
+    kind: "custom";
+    emulationJson: string;
+};
+type ResolvedEmulationMode = PresetEmulationMode | CustomEmulationMode;
 type LegacyWebSocketCallbacks = {
     onMessage?: (data: string | Buffer) => void;
     onClose?: (event: WebSocketCloseEvent) => void;
@@ -692,6 +817,7 @@ declare class Response {
     text(): Promise<string>;
     blob(): Promise<Blob>;
     formData(): Promise<FormData>;
+    readable(): Readable;
     clone(): Response;
     private assertBodyAvailable;
     private consumeBody;
@@ -912,4 +1038,4 @@ declare const _default: {
     RequestError: typeof RequestError;
 };
 
-export { type BodyInit, type BrowserProfile, type CookieMode, type CreateSessionOptions, type CreateTransportOptions, type EmulationOS, Headers, type HeadersInit, RequestError, type RequestInit, type RequestOptions, Response, Session, type SessionHandle, type SessionWebSocketOptions, Transport, WebSocket, type WebSocketBinaryType, type WebSocketCloseEvent, type WebSocketErrorEvent, type WebSocketEventType, type WebSocketMessageEvent, type WebSocketOpenEvent, type WebSocketOptions, createSession, createTransport, _default as default, fetch, get, getOperatingSystems, getProfiles, post, request, websocket, withSession };
+export { type AlpnProtocol, type AlpsProtocol, type BodyInit, type BrowserProfile, type CookieMode, type CreateSessionOptions, type CreateTransportOptions, type CustomEmulationOptions, type CustomHttp1Options, type CustomHttp2Options, type CustomTlsOptions, type EmulationOS, Headers, type HeadersInit, type Http2ExperimentalSetting, type Http2Priority, type Http2PseudoHeaderId, type Http2SettingId, type Http2StreamDependency, RequestError, type RequestInit, type RequestOptions, Response, Session, type SessionHandle, type SessionWebSocketOptions, type TlsVersion, Transport, WebSocket, type WebSocketBinaryType, type WebSocketCloseEvent, type WebSocketErrorEvent, type WebSocketEventType, type WebSocketMessageEvent, type WebSocketOpenEvent, type WebSocketOptions, createSession, createTransport, _default as default, fetch, get, getOperatingSystems, getProfiles, post, request, websocket, withSession };

package/dist/wreq-js.d.ts

@@ -1,3 +1,4 @@
+import { Readable } from 'node:stream';
 import { ReadableStream } from 'node:stream/web';
 
 /**
@@ -53,6 +54,94 @@ type HeaderTuple = [string, string];
  * ```
  */
 type HeadersInit = Iterable<HeaderTuple> | Array<HeaderTuple> | Record<string, string | number | boolean | null | undefined>;
+type AlpnProtocol = "HTTP1" | "HTTP2" | "HTTP3";
+type AlpsProtocol = "HTTP1" | "HTTP2" | "HTTP3";
+type TlsVersion = "1.0" | "1.1" | "1.2" | "1.3" | "TLS1.0" | "TLS1.1" | "TLS1.2" | "TLS1.3";
+type Http2PseudoHeaderId = "Method" | "Scheme" | "Authority" | "Path" | "Protocol";
+type Http2SettingId = "HeaderTableSize" | "EnablePush" | "MaxConcurrentStreams" | "InitialWindowSize" | "MaxFrameSize" | "MaxHeaderListSize" | "EnableConnectProtocol" | "NoRfc7540Priorities";
+interface Http2StreamDependency {
+    dependencyId: number;
+    weight: number;
+    exclusive?: boolean;
+}
+interface Http2Priority {
+    streamId: number;
+    dependency: Http2StreamDependency;
+}
+interface Http2ExperimentalSetting {
+    id: number;
+    value: number;
+}
+interface CustomTlsOptions {
+    alpnProtocols?: AlpnProtocol[];
+    alpsProtocols?: AlpsProtocol[];
+    alpsUseNewCodepoint?: boolean;
+    sessionTicket?: boolean;
+    minTlsVersion?: TlsVersion;
+    maxTlsVersion?: TlsVersion;
+    preSharedKey?: boolean;
+    enableEchGrease?: boolean;
+    permuteExtensions?: boolean;
+    greaseEnabled?: boolean;
+    enableOcspStapling?: boolean;
+    enableSignedCertTimestamps?: boolean;
+    recordSizeLimit?: number;
+    pskSkipSessionTicket?: boolean;
+    keySharesLimit?: number;
+    pskDheKe?: boolean;
+    renegotiation?: boolean;
+    delegatedCredentials?: string;
+    curvesList?: string;
+    cipherList?: string;
+    sigalgsList?: string;
+    certificateCompressionAlgorithms?: Array<"zlib" | "brotli" | "zstd">;
+    extensionPermutation?: number[];
+    aesHwOverride?: boolean;
+    preserveTls13CipherList?: boolean;
+    randomAesHwOverride?: boolean;
+}
+interface CustomHttp1Options {
+    http09Responses?: boolean;
+    writev?: boolean;
+    maxHeaders?: number;
+    readBufExactSize?: number;
+    maxBufSize?: number;
+    ignoreInvalidHeadersInResponses?: boolean;
+    allowSpacesAfterHeaderNameInResponses?: boolean;
+    allowObsoleteMultilineHeadersInResponses?: boolean;
+}
+interface CustomHttp2Options {
+    adaptiveWindow?: boolean;
+    initialStreamId?: number;
+    initialConnectionWindowSize?: number;
+    initialWindowSize?: number;
+    initialMaxSendStreams?: number;
+    maxFrameSize?: number;
+    keepAliveInterval?: number;
+    keepAliveTimeout?: number;
+    keepAliveWhileIdle?: boolean;
+    maxConcurrentResetStreams?: number;
+    maxSendBufferSize?: number;
+    maxConcurrentStreams?: number;
+    maxHeaderListSize?: number;
+    maxPendingAcceptResetStreams?: number;
+    enablePush?: boolean;
+    headerTableSize?: number;
+    enableConnectProtocol?: boolean;
+    noRfc7540Priorities?: boolean;
+    settingsOrder?: Http2SettingId[];
+    headersPseudoOrder?: Http2PseudoHeaderId[];
+    headersStreamDependency?: Http2StreamDependency;
+    priorities?: Http2Priority[];
+    experimentalSettings?: Http2ExperimentalSetting[];
+}
+interface CustomEmulationOptions {
+    tlsOptions?: CustomTlsOptions;
+    http1Options?: CustomHttp1Options;
+    http2Options?: CustomHttp2Options;
+    headers?: HeadersInit;
+    origHeaders?: string[];
+}
 /**
  * Represents the various types of data that can be used as a request body.
  * Supports strings, binary payloads, URL-encoded parameters, multipart forms, and blobs.
@@ -176,6 +265,12 @@ interface RequestInit {
      * @default 'macos'
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides. When `browser` or `os` is present, these fields
+     * layer on top of the resolved preset profile. When both are omitted, this
+     * switches the request into standalone custom emulation mode.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Proxy URL to route the request through (e.g., 'http://proxy.example.com:8080').
      * Proxy support depends on the native layer and proxy scheme.
@@ -254,6 +349,10 @@ interface CreateSessionOptions {
      * Operating system to bind to this session. Defaults to 'macos'.
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides or a standalone custom emulation for the session transport.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Optional proxy for every request made through the session.
      */
@@ -294,6 +393,10 @@ interface CreateTransportOptions {
      * Operating system to emulate for this transport.
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides or a standalone custom emulation for this transport.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Disable HTTPS certificate verification for this transport.
      */
@@ -356,6 +459,12 @@ interface RequestOptions {
      * @default 'macos'
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides. When `browser` or `os` is present, these fields
+     * layer on top of the resolved preset profile. When both are omitted, this
+     * switches the request into standalone custom emulation mode.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * HTTP method to use for the request.
      * @default 'GET'
@@ -505,6 +614,12 @@ interface WebSocketOptions {
      * @default 'macos'
      */
     os?: EmulationOS;
+    /**
+     * Custom emulation overrides. When `browser` or `os` is present, these fields
+     * layer on top of the resolved preset profile. When both are omitted, this
+     * switches the handshake into standalone custom emulation mode.
+     */
+    emulation?: CustomEmulationOptions;
     /**
      * Additional headers to send with the WebSocket upgrade request.
      * Common headers include Authorization, Origin, or custom application headers.
@@ -547,7 +662,7 @@ interface LegacyWebSocketOptions extends WebSocketOptions {
      */
     onError?: (error: string) => void;
 }
-type SessionWebSocketOptions = Omit<WebSocketOptions, "browser" | "os" | "proxy">;
+type SessionWebSocketOptions = Omit<WebSocketOptions, "browser" | "os" | "proxy" | "emulation">;
 interface LegacySessionWebSocketOptions extends SessionWebSocketOptions {
     /**
      * @deprecated Use `session.websocket(url, options)`.
@@ -615,8 +730,7 @@ interface NativeWebSocketCloseEvent {
     reason: string;
 }
 type SessionDefaults = {
-    browser: BrowserProfile;
-    os: EmulationOS;
+    transportMode: ResolvedEmulationMode;
     proxy?: string;
     timeout?: number;
     insecure?: boolean;
@@ -624,6 +738,17 @@ type SessionDefaults = {
     transportId?: string;
     ownsTransport?: boolean;
 };
+type PresetEmulationMode = {
+    kind: "preset";
+    browser: BrowserProfile;
+    os: EmulationOS;
+    emulationJson?: string;
+};
+type CustomEmulationMode = {
+    kind: "custom";
+    emulationJson: string;
+};
+type ResolvedEmulationMode = PresetEmulationMode | CustomEmulationMode;
 type LegacyWebSocketCallbacks = {
     onMessage?: (data: string | Buffer) => void;
     onClose?: (event: WebSocketCloseEvent) => void;
@@ -692,6 +817,7 @@ declare class Response {
     text(): Promise<string>;
     blob(): Promise<Blob>;
     formData(): Promise<FormData>;
+    readable(): Readable;
     clone(): Response;
     private assertBodyAvailable;
     private consumeBody;
@@ -912,4 +1038,4 @@ declare const _default: {
     RequestError: typeof RequestError;
 };
 
-export { type BodyInit, type BrowserProfile, type CookieMode, type CreateSessionOptions, type CreateTransportOptions, type EmulationOS, Headers, type HeadersInit, RequestError, type RequestInit, type RequestOptions, Response, Session, type SessionHandle, type SessionWebSocketOptions, Transport, WebSocket, type WebSocketBinaryType, type WebSocketCloseEvent, type WebSocketErrorEvent, type WebSocketEventType, type WebSocketMessageEvent, type WebSocketOpenEvent, type WebSocketOptions, createSession, createTransport, _default as default, fetch, get, getOperatingSystems, getProfiles, post, request, websocket, withSession };
+export { type AlpnProtocol, type AlpsProtocol, type BodyInit, type BrowserProfile, type CookieMode, type CreateSessionOptions, type CreateTransportOptions, type CustomEmulationOptions, type CustomHttp1Options, type CustomHttp2Options, type CustomTlsOptions, type EmulationOS, Headers, type HeadersInit, type Http2ExperimentalSetting, type Http2Priority, type Http2PseudoHeaderId, type Http2SettingId, type Http2StreamDependency, RequestError, type RequestInit, type RequestOptions, Response, Session, type SessionHandle, type SessionWebSocketOptions, type TlsVersion, Transport, WebSocket, type WebSocketBinaryType, type WebSocketCloseEvent, type WebSocketErrorEvent, type WebSocketEventType, type WebSocketMessageEvent, type WebSocketOpenEvent, type WebSocketOptions, createSession, createTransport, _default as default, fetch, get, getOperatingSystems, getProfiles, post, request, websocket, withSession };