undici-types 7.22.0 → 7.23.0

package/connector.d.ts

@@ -13,6 +13,7 @@ declare namespace buildConnector {
     port?: number;
     keepAlive?: boolean | null;
     keepAliveInitialDelay?: number | null;
+    typeOfService?: number | null;
   }
 
   export interface Options {
@@ -22,6 +23,7 @@ declare namespace buildConnector {
     port: string
     servername?: string
     localAddress?: string | null
+    socketPath?: string | null
     httpSocket?: Socket
   }
 

package/dispatcher.d.ts

@@ -96,7 +96,7 @@ declare class Dispatcher extends EventEmitter {
 }
 
 declare namespace Dispatcher {
-  export interface ComposedDispatcher extends Dispatcher {}
+  export interface ComposedDispatcher extends Dispatcher { }
   export type Dispatch = Dispatcher['dispatch']
   export type DispatcherComposeInterceptor = (dispatch: Dispatch) => Dispatch
   export interface DispatchOptions {
@@ -113,6 +113,8 @@ declare namespace Dispatcher {
     idempotent?: boolean;
     /** Whether the response is expected to take a long time and would end up blocking the pipeline. When this is set to `true` further pipelining will be avoided on the same connection until headers have been received. Defaults to `method !== 'HEAD'`. */
     blocking?: boolean;
+    /** The IP Type of Service (ToS) value for the request socket. Must be an integer between 0 and 255. Default: `0` */
+    typeOfService?: number | null;
     /** Upgrade the request. Should be used to specify the kind of upgrade i.e. `'Websocket'`. Default: `method === 'CONNECT' || null`. */
     upgrade?: boolean | string | null;
     /** The amount of time, in milliseconds, the parser will wait to receive the complete HTTP headers. Defaults to 300 seconds. */
@@ -213,10 +215,10 @@ declare namespace Dispatcher {
   export type StreamFactory<TOpaque = null> = (data: StreamFactoryData<TOpaque>) => Writable
 
   export interface DispatchController {
-    get aborted () : boolean
-    get paused () : boolean
-    get reason () : Error | null
-    abort (reason: Error): void
+    get aborted(): boolean
+    get paused(): boolean
+    get reason(): Error | null
+    abort(reason: Error): void
     pause(): void
     resume(): void
   }

package/errors.d.ts

@@ -154,8 +154,18 @@ declare namespace Errors {
     code: 'UND_ERR_PRX_TLS'
   }
 
-  class MaxOriginsReachedError extends UndiciError {
+  export class MaxOriginsReachedError extends UndiciError {
     name: 'MaxOriginsReachedError'
     code: 'UND_ERR_MAX_ORIGINS_REACHED'
   }
+
+  /** SOCKS5 proxy related error. */
+  export class Socks5ProxyError extends UndiciError {
+    constructor (
+      message?: string,
+      code?: string
+    )
+    name: 'Socks5ProxyError'
+    code: string
+  }
 }

package/index.d.ts

@@ -18,6 +18,7 @@ import { SnapshotAgent } from './snapshot-agent'
 import { MockCallHistory, MockCallHistoryLog } from './mock-call-history'
 import mockErrors from './mock-errors'
 import ProxyAgent from './proxy-agent'
+import Socks5ProxyAgent from './socks5-proxy-agent'
 import EnvHttpProxyAgent from './env-http-proxy-agent'
 import RetryHandler from './retry-handler'
 import RetryAgent from './retry-agent'
@@ -43,7 +44,7 @@ export { Interceptable } from './mock-interceptor'
 
 declare function globalThisInstall (): void
 
-export { Dispatcher, BalancedPool, RoundRobinPool, Pool, Client, buildConnector, errors, Agent, request, stream, pipeline, connect, upgrade, setGlobalDispatcher, getGlobalDispatcher, setGlobalOrigin, getGlobalOrigin, interceptors, cacheStores, MockClient, MockPool, MockAgent, SnapshotAgent, MockCallHistory, MockCallHistoryLog, mockErrors, ProxyAgent, EnvHttpProxyAgent, RedirectHandler, DecoratorHandler, RetryHandler, RetryAgent, H2CClient, globalThisInstall as install }
+export { Dispatcher, BalancedPool, RoundRobinPool, Pool, Client, buildConnector, errors, Agent, request, stream, pipeline, connect, upgrade, setGlobalDispatcher, getGlobalDispatcher, setGlobalOrigin, getGlobalOrigin, interceptors, cacheStores, MockClient, MockPool, MockAgent, SnapshotAgent, MockCallHistory, MockCallHistoryLog, mockErrors, ProxyAgent, Socks5ProxyAgent, EnvHttpProxyAgent, RedirectHandler, DecoratorHandler, RetryHandler, RetryAgent, H2CClient, globalThisInstall as install }
 export default Undici
 
 declare namespace Undici {
@@ -73,6 +74,8 @@ declare namespace Undici {
   const MockCallHistory: typeof import('./mock-call-history').MockCallHistory
   const MockCallHistoryLog: typeof import('./mock-call-history').MockCallHistoryLog
   const mockErrors: typeof import('./mock-errors').default
+  const ProxyAgent: typeof import('./proxy-agent').default
+  const Socks5ProxyAgent: typeof import('./socks5-proxy-agent').default
   const fetch: typeof import('./fetch').fetch
   const Headers: typeof import('./fetch').Headers
   const Response: typeof import('./fetch').Response

package/package.json

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

package/socks5-proxy-agent.d.ts

@@ -0,0 +1,25 @@
+import Dispatcher from './dispatcher'
+import buildConnector from './connector'
+import { IncomingHttpHeaders } from './header'
+import Pool from './pool'
+
+export default Socks5ProxyAgent
+
+declare class Socks5ProxyAgent extends Dispatcher {
+  constructor (proxyUrl: string | URL, options?: Socks5ProxyAgent.Options)
+}
+
+declare namespace Socks5ProxyAgent {
+  export interface Options extends Pool.Options {
+    /** Additional headers to send with the proxy connection */
+    headers?: IncomingHttpHeaders;
+    /** SOCKS5 proxy username for authentication */
+    username?: string;
+    /** SOCKS5 proxy password for authentication */
+    password?: string;
+    /** Custom connector function for proxy connection */
+    connect?: buildConnector.connector;
+    /** TLS options for the proxy connection (for SOCKS5 over TLS) */
+    proxyTls?: buildConnector.BuildOptions;
+  }
+}