undici 7.0.0-alpha.5 → 7.0.0-alpha.7

package/types/cache-interceptor.d.ts

@@ -5,6 +5,10 @@ export default CacheHandler
 declare namespace CacheHandler {
   export type CacheMethods = 'GET' | 'HEAD' | 'OPTIONS' | 'TRACE'
 
+  export interface CacheHandlerOptions {
+    store: CacheStore
+  }
+
   export interface CacheOptions {
     store?: CacheStore
 
@@ -28,7 +32,7 @@ declare namespace CacheHandler {
   export interface CacheValue {
     statusCode: number
     statusMessage: string
-    rawHeaders: Buffer[]
+    headers: Record<string, string | string[]>
     vary?: Record<string, string | string[]>
     etag?: string
     cachedAt: number
@@ -45,7 +49,8 @@ declare namespace CacheHandler {
   type GetResult = {
     statusCode: number
     statusMessage: string
-    rawHeaders: Buffer[]
+    headers: Record<string, string | string[]>
+    etag?: string
     body: null | Readable | Iterable<Buffer> | AsyncIterable<Buffer> | Buffer | Iterable<string> | AsyncIterable<string> | string
     cachedAt: number
     staleAt: number
@@ -70,13 +75,13 @@ declare namespace CacheHandler {
     maxCount?: number
 
     /**
-       * @default Infinity
-       */
+     * @default Infinity
+     */
     maxSize?: number
 
     /**
-       * @default Infinity
-       */
+     * @default Infinity
+     */
     maxEntrySize?: number
 
     errorCallback?: (err: Error) => void
@@ -91,4 +96,37 @@ declare namespace CacheHandler {
 
     delete (key: CacheKey): void | Promise<void>
   }
+
+  export interface SqliteCacheStoreOpts {
+    /**
+     * Location of the database
+     * @default ':memory:'
+     */
+    location?: string
+
+    /**
+     * @default Infinity
+     */
+    maxCount?: number
+
+    /**
+     * @default Infinity
+     */
+    maxEntrySize?: number
+  }
+
+  export class SqliteCacheStore implements CacheStore {
+    constructor (opts?: SqliteCacheStoreOpts)
+
+    /**
+     * Closes the connection to the database
+     */
+    close (): void
+
+    get (key: CacheKey): GetResult | Promise<GetResult | undefined> | undefined
+
+    createWriteStream (key: CacheKey, value: CacheValue): Writable | undefined
+
+    delete (key: CacheKey): void | Promise<void>
+  }
 }

package/types/dispatcher.d.ts

@@ -15,7 +15,7 @@ export default Dispatcher
 /** Dispatcher is the core API used to dispatch requests. */
 declare class Dispatcher extends EventEmitter {
   /** Dispatches a request. This API is expected to evolve through semver-major versions and is less stable than the preceding higher level APIs. It is primarily intended for library developers who implement higher level APIs on top of this. */
-  dispatch (options: Dispatcher.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Dispatcher.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean
   /** Starts two-way communications with the requested resource. */
   connect<TOpaque = null>(options: Dispatcher.ConnectOptions<TOpaque>): Promise<Dispatcher.ConnectData<TOpaque>>
   connect<TOpaque = null>(options: Dispatcher.ConnectOptions<TOpaque>, callback: (err: Error | null, data: Dispatcher.ConnectData<TOpaque>) => void): void
@@ -103,7 +103,7 @@ declare namespace Dispatcher {
     /** Default: `null` */
     body?: string | Buffer | Uint8Array | Readable | null | FormData;
     /** Default: `null` */
-    headers?: IncomingHttpHeaders | string[] | Iterable<[string, string | string[] | undefined]> | null;
+    headers?: Record<string, string | string[]> | IncomingHttpHeaders | string[] | Iterable<[string, string | string[] | undefined]> | null;
     /** Query string params to be embedded in the request URL. Default: `null` */
     query?: Record<string, any>;
     /** Whether the requests can be safely retried or not. If `false` the request won't be sent until all preceding requests in the pipeline have completed. Default: `true` if `method` is `HEAD` or `GET`. */
@@ -213,22 +213,47 @@ declare namespace Dispatcher {
     context: object;
   }
   export type StreamFactory<TOpaque = null> = (data: StreamFactoryData<TOpaque>) => Writable
-  export interface DispatchHandlers {
+
+  export interface DispatchController {
+    get aborted () : boolean
+    get paused () : boolean
+    get reason () : Error | null
+    abort (reason: Error): void
+    pause(): void
+    resume(): void
+  }
+
+  export interface DispatchHandler {
+    onRequestStart?(controller: DispatchController, context: any): void;
+    onRequestUpgrade?(controller: DispatchController, statusCode: number, headers: IncomingHttpHeaders, socket: Duplex): void;
+    onResponseStart?(controller: DispatchController, statusCode: number, statusMessage: string | null, headers: IncomingHttpHeaders): void;
+    onResponseData?(controller: DispatchController, chunk: Buffer): void;
+    onResponseEnd?(controller: DispatchController, trailers: IncomingHttpHeaders): void;
+    onResponseError?(controller: DispatchController, error: Error): void;
+
     /** Invoked before request is dispatched on socket. May be invoked multiple times when a request is retried when the request at the head of the pipeline fails. */
+    /** @deprecated */
     onConnect?(abort: (err?: Error) => void): void;
     /** Invoked when an error has occurred. */
+    /** @deprecated */
     onError?(err: Error): void;
     /** Invoked when request is upgraded either due to a `Upgrade` header or `CONNECT` method. */
+    /** @deprecated */
     onUpgrade?(statusCode: number, headers: Buffer[] | string[] | null, socket: Duplex): void;
     /** Invoked when response is received, before headers have been read. **/
+    /** @deprecated */
     onResponseStarted?(): void;
     /** Invoked when statusCode and headers have been received. May be invoked multiple times due to 1xx informational headers. */
+    /** @deprecated */
     onHeaders?(statusCode: number, headers: Buffer[], resume: () => void, statusText: string): boolean;
     /** Invoked when response payload data is received. */
+    /** @deprecated */
     onData?(chunk: Buffer): boolean;
     /** Invoked when response payload and trailers have been received and the request has completed. */
+    /** @deprecated */
     onComplete?(trailers: string[] | null): void;
     /** Invoked when a body chunk is sent to the server. May be invoked multiple times for chunked requests */
+    /** @deprecated */
     onBodySent?(chunkSize: number, totalBytesSent: number): void;
   }
   export type PipelineHandler<TOpaque = null> = (data: PipelineHandlerData<TOpaque>) => Readable

package/types/env-http-proxy-agent.d.ts

@@ -6,7 +6,7 @@ export default EnvHttpProxyAgent
 declare class EnvHttpProxyAgent extends Dispatcher {
   constructor (opts?: EnvHttpProxyAgent.Options)
 
-  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean
 }
 
 declare namespace EnvHttpProxyAgent {

package/types/handlers.d.ts

@@ -1,15 +1,15 @@
 import Dispatcher from './dispatcher'
 
-export declare class RedirectHandler implements Dispatcher.DispatchHandlers {
+export declare class RedirectHandler implements Dispatcher.DispatchHandler {
   constructor (
     dispatch: Dispatcher,
     maxRedirections: number,
     opts: Dispatcher.DispatchOptions,
-    handler: Dispatcher.DispatchHandlers,
+    handler: Dispatcher.DispatchHandler,
     redirectionLimitReached: boolean
   )
 }
 
-export declare class DecoratorHandler implements Dispatcher.DispatchHandlers {
-  constructor (handler: Dispatcher.DispatchHandlers)
+export declare class DecoratorHandler implements Dispatcher.DispatchHandler {
+  constructor (handler: Dispatcher.DispatchHandler)
 }

package/types/mock-agent.d.ts

@@ -17,7 +17,7 @@ declare class MockAgent<TMockAgentOptions extends MockAgent.Options = MockAgent.
   get<TInterceptable extends Interceptable>(origin: RegExp): TInterceptable
   get<TInterceptable extends Interceptable>(origin: ((origin: string) => boolean)): TInterceptable
   /** Dispatches a mocked request. */
-  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean
   /** Closes the mock agent and waits for registered mock pools and clients to also close before resolving. */
   close (): Promise<void>
   /** Disables mocking in MockAgent. */

package/types/mock-client.d.ts

@@ -11,7 +11,7 @@ declare class MockClient extends Client implements Interceptable {
   /** Intercepts any matching requests that use the same origin as this mock client. */
   intercept (options: MockInterceptor.Options): MockInterceptor
   /** Dispatches a mocked request. */
-  dispatch (options: Dispatcher.DispatchOptions, handlers: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Dispatcher.DispatchOptions, handlers: Dispatcher.DispatchHandler): boolean
   /** Closes the mock client and gracefully waits for enqueued requests to complete. */
   close (): Promise<void>
 }

package/types/mock-pool.d.ts

@@ -11,7 +11,7 @@ declare class MockPool extends Pool implements Interceptable {
   /** Intercepts any matching requests that use the same origin as this mock pool. */
   intercept (options: MockInterceptor.Options): MockInterceptor
   /** Dispatches a mocked request. */
-  dispatch (options: Dispatcher.DispatchOptions, handlers: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Dispatcher.DispatchOptions, handlers: Dispatcher.DispatchHandler): boolean
   /** Closes the mock pool and gracefully waits for enqueued requests to complete. */
   close (): Promise<void>
 }

package/types/proxy-agent.d.ts

@@ -8,7 +8,7 @@ export default ProxyAgent
 declare class ProxyAgent extends Dispatcher {
   constructor (options: ProxyAgent.Options | string)
 
-  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandlers): boolean
+  dispatch (options: Agent.DispatchOptions, handler: Dispatcher.DispatchHandler): boolean
   close (): Promise<void>
 }
 

package/types/retry-handler.d.ts

@@ -2,7 +2,7 @@ import Dispatcher from './dispatcher'
 
 export default RetryHandler
 
-declare class RetryHandler implements Dispatcher.DispatchHandlers {
+declare class RetryHandler implements Dispatcher.DispatchHandler {
   constructor (
     options: Dispatcher.DispatchOptions & {
       retryOptions?: RetryHandler.RetryOptions;
@@ -32,7 +32,7 @@ declare namespace RetryHandler {
       };
     },
     callback: OnRetryCallback
-  ) => number | null
+  ) => void
 
   export interface RetryOptions {
     /**
@@ -111,6 +111,6 @@ declare namespace RetryHandler {
 
   export interface RetryHandlers {
     dispatch: Dispatcher['dispatch'];
-    handler: Dispatcher.DispatchHandlers;
+    handler: Dispatcher.DispatchHandler;
   }
 }