undici-types 6.21.0 → 7.8.0

package/webidl.d.ts

@@ -1,4 +1,5 @@
 // These types are not exported, and are only used internally
+import * as undici from './index'
 
 /**
  * Take in an unknown value and return one that is of type T
@@ -34,11 +35,24 @@ interface WebidlErrors {
   }): TypeError
 }
 
+interface WebIDLTypes {
+  UNDEFINED: 1,
+  BOOLEAN: 2,
+  STRING: 3,
+  SYMBOL: 4,
+  NUMBER: 5,
+  BIGINT: 6,
+  NULL: 7
+  OBJECT: 8
+}
+
 interface WebidlUtil {
   /**
    * @see https://tc39.es/ecma262/#sec-ecmascript-data-types-and-values
    */
-  Type (object: unknown):
+  Type (object: unknown): WebIDLTypes[keyof WebIDLTypes]
+
+  TypeValueToString (o: unknown):
     | 'Undefined'
     | 'Boolean'
     | 'String'
@@ -48,6 +62,8 @@ interface WebidlUtil {
     | 'Null'
     | 'Object'
 
+  Types: WebIDLTypes
+
   /**
    * @see https://webidl.spec.whatwg.org/#abstract-opdef-converttoint
    */
@@ -68,6 +84,8 @@ interface WebidlUtil {
    */
   Stringify (V: any): string
 
+  MakeTypeAssertion <I>(I: I): (arg: any) => arg is I
+
   /**
    * Mark a value as uncloneable for Node.js.
    * This is only effective in some newer Node.js versions.
@@ -156,7 +174,7 @@ interface WebidlConverters {
   ): NodeJS.TypedArray | ArrayBufferLike | DataView
 
   ['sequence<ByteString>']: SequenceConverter<string>
-  
+
   ['sequence<sequence<ByteString>>']: SequenceConverter<string[]>
 
   ['record<ByteString, ByteString>']: RecordConverter<string, string>
@@ -164,16 +182,35 @@ interface WebidlConverters {
   [Key: string]: (...args: any[]) => unknown
 }
 
+type IsAssertion<T> = (arg: any) => arg is T
+
+interface WebidlIs {
+  Request: IsAssertion<undici.Request>
+  Response: IsAssertion<undici.Response>
+  ReadableStream: IsAssertion<ReadableStream>
+  Blob: IsAssertion<Blob>
+  URLSearchParams: IsAssertion<URLSearchParams>
+  File: IsAssertion<File>
+  FormData: IsAssertion<undici.FormData>
+  URL: IsAssertion<URL>
+  WebSocketError: IsAssertion<undici.WebSocketError>
+  AbortSignal: IsAssertion<AbortSignal>
+  MessagePort: IsAssertion<MessagePort>
+}
+
 export interface Webidl {
   errors: WebidlErrors
   util: WebidlUtil
   converters: WebidlConverters
+  is: WebidlIs
 
   /**
    * @description Performs a brand-check on {@param V} to ensure it is a
    * {@param cls} object.
    */
-  brandCheck <Interface>(V: unknown, cls: Interface, opts?: { strict?: boolean }): asserts V is Interface
+  brandCheck <Interface extends new () => unknown>(V: unknown, cls: Interface): asserts V is Interface
+
+  brandCheckMultiple <Interfaces extends (new () => unknown)[]> (list: Interfaces): (V: any) => asserts V is Interfaces[number]
 
   /**
    * @see https://webidl.spec.whatwg.org/#es-sequence
@@ -196,10 +233,11 @@ export interface Webidl {
    * Similar to {@link Webidl.brandCheck} but allows skipping the check if third party
    * interfaces are allowed.
    */
-  interfaceConverter <Interface>(cls: Interface): (
+  interfaceConverter <Interface>(typeCheck: IsAssertion<Interface>, name: string): (
     V: unknown,
-    opts?: { strict: boolean }
-  ) => asserts V is typeof cls
+    prefix: string,
+    argument: string
+  ) => asserts V is Interface
 
   // TODO(@KhafraDev): a type could likely be implemented that can infer the return type
   // from the converters given?

package/websocket.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 
 import type { Blob } from 'buffer'
+import type { ReadableStream, WritableStream } from 'stream/web'
 import type { MessagePort } from 'worker_threads'
 import {
   EventInit,
@@ -22,7 +23,7 @@ interface WebSocketEventMap {
 
 interface WebSocket extends EventTarget {
   binaryType: BinaryType
-  
+
   readonly bufferedAmount: number
   readonly extensions: string
 
@@ -148,3 +149,36 @@ interface WebSocketInit {
   dispatcher?: Dispatcher,
   headers?: HeadersInit
 }
+
+interface WebSocketStreamOptions {
+  protocols?: string | string[]
+  signal?: AbortSignal
+}
+
+interface WebSocketCloseInfo {
+  closeCode: number
+  reason: string
+}
+
+interface WebSocketStream {
+  closed: Promise<WebSocketCloseInfo>
+  opened: Promise<{
+    extensions: string
+    protocol: string
+    readable: ReadableStream
+    writable: WritableStream
+  }>
+  url: string
+}
+
+export declare const WebSocketStream: {
+  prototype: WebSocketStream
+  new (url: string | URL, options?: WebSocketStreamOptions): WebSocketStream
+}
+
+interface WebSocketError extends Event, WebSocketCloseInfo {}
+
+export declare const WebSocketError: {
+  prototype: WebSocketError
+  new (type: string, init?: WebSocketCloseInfo): WebSocketError
+}

package/file.d.ts

@@ -1,39 +0,0 @@
-// Based on https://github.com/octet-stream/form-data/blob/2d0f0dc371517444ce1f22cdde13f51995d0953a/lib/File.ts (MIT)
-/// <reference types="node" />
-
-import { Blob } from 'buffer'
-
-export interface BlobPropertyBag {
-  type?: string
-  endings?: 'native' | 'transparent'
-}
-
-export interface FilePropertyBag extends BlobPropertyBag {
-  /**
-   * The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.
-   */
-  lastModified?: number
-}
-
-export declare class File extends Blob {
-  /**
-   * Creates a new File instance.
-   *
-   * @param fileBits An `Array` strings, or [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer), [`ArrayBufferView`](https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView), [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) objects, or a mix of any of such objects, that will be put inside the [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File).
-   * @param fileName The name of the file.
-   * @param options An options object containing optional attributes for the file.
-   */
-  constructor(fileBits: ReadonlyArray<string | NodeJS.ArrayBufferView | Blob>, fileName: string, options?: FilePropertyBag)
-
-  /**
-   * Name of the file referenced by the File object.
-   */
-  readonly name: string
-
-  /**
-   * The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.
-   */
-  readonly lastModified: number
-
-  readonly [Symbol.toStringTag]: string
-}

package/filereader.d.ts

@@ -1,54 +0,0 @@
-/// <reference types="node" />
-
-import { Blob } from 'buffer'
-import { DOMException, EventInit } from './patch'
-
-export declare class FileReader {
-  __proto__: EventTarget & FileReader
-
-  constructor ()
-
-  readAsArrayBuffer (blob: Blob): void
-  readAsBinaryString (blob: Blob): void
-  readAsText (blob: Blob, encoding?: string): void
-  readAsDataURL (blob: Blob): void
-
-  abort (): void
-
-  static readonly EMPTY = 0
-  static readonly LOADING = 1
-  static readonly DONE = 2
-
-  readonly EMPTY = 0
-  readonly LOADING = 1
-  readonly DONE = 2
-
-  readonly readyState: number
-
-  readonly result: string | ArrayBuffer | null
-
-  readonly error: DOMException | null
-
-  onloadstart: null | ((this: FileReader, event: ProgressEvent) => void)
-  onprogress: null | ((this: FileReader, event: ProgressEvent) => void)
-  onload: null | ((this: FileReader, event: ProgressEvent) => void)
-  onabort: null |  ((this: FileReader, event: ProgressEvent) => void)
-  onerror: null | ((this: FileReader, event: ProgressEvent) => void)
-  onloadend: null | ((this: FileReader, event: ProgressEvent) => void)
-}
-
-export interface ProgressEventInit extends EventInit {
-  lengthComputable?: boolean
-  loaded?: number
-  total?: number
-}
-
-export declare class ProgressEvent {
-  __proto__: Event & ProgressEvent
-
-  constructor (type: string, eventInitDict?: ProgressEventInit)
-
-  readonly lengthComputable: boolean
-  readonly loaded: number
-  readonly total: number
-}