undici-types 8.1.0 → 8.3.0

package/client.d.ts

@@ -3,7 +3,7 @@ import Dispatcher from './dispatcher'
 import buildConnector from './connector'
 import TClientStats from './client-stats'
 
-type ClientConnectOptions = Omit<Dispatcher.ConnectOptions, 'origin'>
+type ClientConnectOptions<TOpaque = null> = Omit<Dispatcher.ConnectOptions<TOpaque>, 'origin'>
 
 /**
  * A basic HTTP/1.1 client, mapped on top a single TCP/TLS connection. Pipelining is disabled by default.
@@ -20,12 +20,12 @@ export class Client extends Dispatcher {
   readonly stats: TClientStats
 
   // Override dispatcher APIs.
-  override connect (
-    options: ClientConnectOptions
-  ): Promise<Dispatcher.ConnectData>
-  override connect (
-    options: ClientConnectOptions,
-    callback: (err: Error | null, data: Dispatcher.ConnectData) => void
+  override connect<TOpaque = null> (
+    options: ClientConnectOptions<TOpaque>
+  ): Promise<Dispatcher.ConnectData<TOpaque>>
+  override connect<TOpaque = null> (
+    options: ClientConnectOptions<TOpaque>,
+    callback: (err: Error | null, data: Dispatcher.ConnectData<TOpaque>) => void
   ): void
 }
 

package/dispatcher.d.ts

@@ -2,7 +2,7 @@ import { URL } from 'node:url'
 import { Duplex, Readable, Writable } from 'node:stream'
 import { EventEmitter } from 'node:events'
 import { Blob } from 'node:buffer'
-import { IncomingHttpHeaders } from './header'
+import { IncomingHttpHeaders, OutgoingHttpHeaders } from './header'
 import BodyReadable from './readable'
 import { FormData } from './formdata'
 import Errors from './errors'
@@ -10,7 +10,7 @@ import { Autocomplete } from './utility'
 
 export default Dispatcher
 
-export type UndiciHeaders = Record<string, string | string[]> | IncomingHttpHeaders | string[] | Iterable<[string, string | string[] | undefined]> | null
+export type UndiciHeaders = OutgoingHttpHeaders | string[] | Iterable<[string, string | string[] | undefined]> | null
 
 /** Dispatcher is the core API used to dispatch requests. */
 declare class Dispatcher extends EventEmitter {
@@ -121,8 +121,6 @@ declare namespace Dispatcher {
     bodyTimeout?: number | null;
     /** Whether the request should stablish a keep-alive or not. Default `false` */
     reset?: boolean;
-    /** Whether Undici should throw an error upon receiving a 4xx or 5xx response from the server. Defaults to false */
-    throwOnError?: boolean;
     /** For H2, it appends the expect: 100-continue header, and halts the request body until a 100-continue is received from the remote server */
     expectContinue?: boolean;
   }
@@ -210,8 +208,8 @@ declare namespace Dispatcher {
     get aborted(): boolean
     get paused(): boolean
     get reason(): Error | null
-    rawHeaders?: Buffer[] | string[] | null
-    rawTrailers?: Buffer[] | string[] | null
+    rawHeaders?: Buffer[] | string[] | IncomingHttpHeaders | null
+    rawTrailers?: Buffer[] | string[] | IncomingHttpHeaders | null
     abort(reason: Error): void
     pause(): void
     resume(): void

package/formdata.d.ts

@@ -4,12 +4,6 @@
 import { File } from 'node:buffer'
 import { SpecIterableIterator } from './fetch'
 
-declare module 'node:buffer' {
-  interface File {
-    readonly [Symbol.toStringTag]: string
-  }
-}
-
 /**
  * A `string` or `File` that represents a single value from a set of `FormData` key-value pairs.
  */

package/header.d.ts

@@ -5,6 +5,11 @@ import { Autocomplete } from './utility'
  */
 export type IncomingHttpHeaders = Record<string, string | string[] | undefined>
 
+/**
+ * The header type declaration of `undici` for outgoing requests.
+ */
+export type OutgoingHttpHeaders = Record<string, number | string | string[] | undefined>
+
 type HeaderNames = Autocomplete<
   | 'Accept'
   | 'Accept-CH'

package/interceptors.d.ts

@@ -8,7 +8,7 @@ export default Interceptors
 declare namespace Interceptors {
   export type DumpInterceptorOpts = { maxSize?: number }
   export type RetryInterceptorOpts = RetryHandler.RetryOptions
-  export type RedirectInterceptorOpts = { maxRedirections?: number }
+  export type RedirectInterceptorOpts = { maxRedirections?: number, throwOnMaxRedirect?: boolean }
   export type DecompressInterceptorOpts = {
     skipErrorResponses?: boolean
     skipStatusCodes?: number[]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "undici-types",
-  "version": "8.1.0",
+  "version": "8.3.0",
   "description": "A stand-alone types package for Undici",
   "homepage": "https://undici.nodejs.org",
   "bugs": {

package/proxy-agent.d.ts

@@ -1,7 +1,7 @@
 import Agent from './agent'
 import buildConnector from './connector'
 import Dispatcher from './dispatcher'
-import { IncomingHttpHeaders } from './header'
+import { OutgoingHttpHeaders } from './header'
 
 export default ProxyAgent
 
@@ -20,7 +20,7 @@ declare namespace ProxyAgent {
      */
     auth?: string;
     token?: string;
-    headers?: IncomingHttpHeaders;
+    headers?: OutgoingHttpHeaders;
     requestTls?: buildConnector.BuildOptions;
     proxyTls?: buildConnector.BuildOptions;
     clientFactory?(origin: URL, opts: object): Dispatcher;

package/snapshot-agent.d.ts

@@ -30,7 +30,9 @@ declare namespace SnapshotRecorder {
     ignoreHeaders?: string[]
     excludeHeaders?: string[]
     matchBody?: boolean
+    normalizeBody?: (body: string | Buffer | null | undefined) => string
     matchQuery?: boolean
+    normalizeQuery?: (query: URLSearchParams) => string
     caseSensitive?: boolean
     shouldRecord?: (requestOpts: any) => boolean
     shouldPlayback?: (requestOpts: any) => boolean
@@ -98,7 +100,9 @@ declare namespace SnapshotAgent {
     ignoreHeaders?: string[]
     excludeHeaders?: string[]
     matchBody?: boolean
+    normalizeBody?: (body: string | Buffer | null | undefined) => string
     matchQuery?: boolean
+    normalizeQuery?: (query: URLSearchParams) => string
     caseSensitive?: boolean
     shouldRecord?: (requestOpts: any) => boolean
     shouldPlayback?: (requestOpts: any) => boolean

package/socks5-proxy-agent.d.ts

@@ -1,6 +1,6 @@
 import Dispatcher from './dispatcher'
 import buildConnector from './connector'
-import { IncomingHttpHeaders } from './header'
+import { OutgoingHttpHeaders } from './header'
 import Pool from './pool'
 
 export default Socks5ProxyAgent
@@ -12,7 +12,7 @@ declare class Socks5ProxyAgent extends Dispatcher {
 declare namespace Socks5ProxyAgent {
   export interface Options extends Pool.Options {
     /** Additional headers to send with the proxy connection */
-    headers?: IncomingHttpHeaders;
+    headers?: OutgoingHttpHeaders;
     /** SOCKS5 proxy username for authentication */
     username?: string;
     /** SOCKS5 proxy password for authentication */