rekwest 2.3.5 → 3.0.0

package/src/formdata.mjs

@@ -1,224 +1,224 @@
-import { randomBytes } from 'crypto';
-import http2 from 'http2';
-import { toUSVString } from 'util';
-import { File } from './file.mjs';
-import { tap } from './helpers.mjs';
-import {
-  APPLICATION_OCTET_STREAM,
-  MULTIPART_FORM_DATA,
-} from './mediatypes.mjs';
-
-const CRLF = '\r\n';
-const {
-  HTTP2_HEADER_CONTENT_DISPOSITION,
-  HTTP2_HEADER_CONTENT_TYPE,
-} = http2.constants;
-
-export class FormData {
-
-  static actuate(fd) {
-    const boundary = randomBytes(24).toString('hex');
-    const contentType = `${ MULTIPART_FORM_DATA }; boundary=${ boundary }`;
-    const prefix = `--${ boundary }${ CRLF }${ HTTP2_HEADER_CONTENT_DISPOSITION }: form-data`;
-
-    const escape = (str) => str.replace(/\n/g, '%0A').replace(/\r/g, '%0D').replace(/"/g, '%22');
-    const normalize = (value) => value.replace(/\r?\n|\r/g, CRLF);
-
-    return {
-      contentType,
-      async* [Symbol.asyncIterator]() {
-        const encoder = new TextEncoder();
-
-        for (const [name, value] of fd) {
-          if (value.constructor === String) {
-            yield encoder.encode(`${ prefix }; name="${
-              escape(normalize(name))
-            }"${ CRLF.repeat(2) }${ normalize(value) }${ CRLF }`);
-          } else {
-            yield encoder.encode(`${ prefix }; name="${
-              escape(normalize(name))
-            }"${ value.name ? `; filename="${ escape(value.name) }"` : '' }${ CRLF }${
-              HTTP2_HEADER_CONTENT_TYPE
-            }: ${
-              value.type || APPLICATION_OCTET_STREAM
-            }${ CRLF.repeat(2) }`);
-            yield* tap(value);
-            yield encoder.encode(CRLF);
-          }
-        }
-
-        yield encoder.encode(`--${ boundary }--`);
-      },
-    };
-  }
-
-  static alike(instance) {
-    return instance?.constructor.name === FormData.name;
-  }
-
-  static #enfoldEntry(name, value, filename) {
-    name = toUSVString(name);
-    filename &&= toUSVString(filename);
-
-    if (File.alike(value)) {
-      value = new File([value], filename, value);
-    } else if (this.#ensureInstance(value)) {
-      value.name = filename || value.name;
-    } else {
-      value = toUSVString(value);
-    }
-
-    return {
-      name,
-      value,
-    };
-  }
-
-  static #ensureInstance(value) {
-    return File.alike(value) || (value === Object(value) && Reflect.has(value, Symbol.asyncIterator));
-  }
-
-  #entries = [];
-
-  get [Symbol.toStringTag]() {
-    return this.constructor.name;
-  }
-
-  constructor(input) {
-    if (input === Object(input)
-      && (input?.constructor === Object || Reflect.has(input, Symbol.iterator))) {
-
-      if (input.constructor !== Object) {
-        input = Array.from(input);
-      }
-
-      if (Array.isArray(input)) {
-        if (!input.every((it) => Array.isArray(it))) {
-          throw new TypeError(`Failed to construct '${
-            this[Symbol.toStringTag]
-          }': The provided value cannot be converted to a sequence.`);
-        } else if (!input.every((it) => it.length === 2)) {
-          throw new TypeError(`Failed to construct '${
-            this[Symbol.toStringTag]
-          }': Sequence initializer must only contain pair elements.`);
-        }
-      }
-
-      if (input.constructor === Object) {
-        input = Object.entries(input);
-      }
-
-      input.forEach(([key, value]) => this.append(key, value));
-    }
-  }
-
-  #ensureArgs(args, expected, method) {
-    if (args.length < expected) {
-      throw new TypeError(`Failed to execute '${ method }' on '${
-        this[Symbol.toStringTag]
-      }': ${ expected } arguments required, but only ${ args.length } present.`);
-    }
-
-    if ([
-      'append',
-      'set',
-    ].includes(method)) {
-      if (args.length === 3 && !this.constructor.#ensureInstance(args[1])) {
-        throw new TypeError(`Failed to execute '${ method }' on '${
-          this[Symbol.toStringTag]
-        }': parameter ${ expected } is not of type 'Blob', 'File' or async iterable.`);
-      }
-    }
-
-    if (method === 'forEach') {
-      if (args[0]?.constructor !== Function) {
-        throw new TypeError(`Failed to execute '${ method }' on '${
-          this[Symbol.toStringTag]
-        }': parameter ${ expected } is not of type 'Function'.`);
-      }
-    }
-  }
-
-  append(...args) {
-    this.#ensureArgs(args, 2, 'append');
-    this.#entries.push(this.constructor.#enfoldEntry(...args));
-  }
-
-  delete(...args) {
-    this.#ensureArgs(args, 1, 'delete');
-    const name = toUSVString(args[0]);
-
-    this.#entries = this.#entries.filter((it) => it.name !== name);
-  }
-
-  forEach(...args) {
-    this.#ensureArgs(args, 1, 'forEach');
-    const [callback, thisArg] = args;
-
-    for (const entry of this) {
-      Reflect.apply(callback, thisArg, [
-        ...(entry.reverse()),
-        this,
-      ]);
-    }
-  }
-
-  get(...args) {
-    this.#ensureArgs(args, 1, 'get');
-    const name = toUSVString(args[0]);
-
-    return (this.#entries.find((it) => it.name === name) ?? {}).value ?? null;
-  }
-
-  getAll(...args) {
-    this.#ensureArgs(args, 1, 'getAll');
-    const name = toUSVString(args[0]);
-
-    return this.#entries.filter((it) => it.name === name).map((it) => it.value);
-  }
-
-  has(...args) {
-    this.#ensureArgs(args, 1, 'has');
-    const name = toUSVString(args[0]);
-
-    return !!this.#entries.find((it) => it.name === name);
-  }
-
-  set(...args) {
-    this.#ensureArgs(args, 2, 'set');
-    const entry = this.constructor.#enfoldEntry(...args);
-    const idx = this.#entries.findIndex((it) => it.name === entry.name);
-
-    if (idx !== -1) {
-      this.#entries.splice(idx, 1, entry);
-    } else {
-      this.#entries.push(entry);
-    }
-  }
-
-  * entries() {
-    for (const { name, value } of this.#entries) {
-      yield [
-        name,
-        value,
-      ];
-    }
-  }
-
-  * keys() {
-    for (const [name] of this) {
-      yield name;
-    }
-  }
-
-  * values() {
-    for (const [, value] of this) {
-      yield value;
-    }
-  }
-
-  [Symbol.iterator]() {
-    return this.entries();
-  }
-
-}
+import { randomBytes } from 'crypto';
+import http2 from 'http2';
+import { toUSVString } from 'util';
+import { File } from './file.mjs';
+import { tap } from './helpers.mjs';
+import {
+  APPLICATION_OCTET_STREAM,
+  MULTIPART_FORM_DATA,
+} from './mediatypes.mjs';
+
+const CRLF = '\r\n';
+const {
+  HTTP2_HEADER_CONTENT_DISPOSITION,
+  HTTP2_HEADER_CONTENT_TYPE,
+} = http2.constants;
+
+export class FormData {
+
+  static actuate(fd) {
+    const boundary = randomBytes(24).toString('hex');
+    const contentType = `${ MULTIPART_FORM_DATA }; boundary=${ boundary }`;
+    const prefix = `--${ boundary }${ CRLF }${ HTTP2_HEADER_CONTENT_DISPOSITION }: form-data`;
+
+    const escape = (str) => str.replace(/\n/g, '%0A').replace(/\r/g, '%0D').replace(/"/g, '%22');
+    const normalize = (value) => value.replace(/\r?\n|\r/g, CRLF);
+
+    return {
+      contentType,
+      async* [Symbol.asyncIterator]() {
+        const encoder = new TextEncoder();
+
+        for (const [name, value] of fd) {
+          if (value.constructor === String) {
+            yield encoder.encode(`${ prefix }; name="${
+              escape(normalize(name))
+            }"${ CRLF.repeat(2) }${ normalize(value) }${ CRLF }`);
+          } else {
+            yield encoder.encode(`${ prefix }; name="${
+              escape(normalize(name))
+            }"${ value.name ? `; filename="${ escape(value.name) }"` : '' }${ CRLF }${
+              HTTP2_HEADER_CONTENT_TYPE
+            }: ${
+              value.type || APPLICATION_OCTET_STREAM
+            }${ CRLF.repeat(2) }`);
+            yield* tap(value);
+            yield encoder.encode(CRLF);
+          }
+        }
+
+        yield encoder.encode(`--${ boundary }--`);
+      },
+    };
+  }
+
+  static alike(instance) {
+    return instance?.constructor.name === FormData.name;
+  }
+
+  static #enfoldEntry(name, value, filename) {
+    name = toUSVString(name);
+    filename &&= toUSVString(filename);
+
+    if (File.alike(value)) {
+      value = new File([value], filename, value);
+    } else if (this.#ensureInstance(value)) {
+      value.name = filename || value.name;
+    } else {
+      value = toUSVString(value);
+    }
+
+    return {
+      name,
+      value,
+    };
+  }
+
+  static #ensureInstance(value) {
+    return File.alike(value) || (value === Object(value) && Reflect.has(value, Symbol.asyncIterator));
+  }
+
+  #entries = [];
+
+  get [Symbol.toStringTag]() {
+    return this.constructor.name;
+  }
+
+  constructor(input) {
+    if (input === Object(input)
+      && (input?.constructor === Object || Reflect.has(input, Symbol.iterator))) {
+
+      if (input.constructor !== Object) {
+        input = Array.from(input);
+      }
+
+      if (Array.isArray(input)) {
+        if (!input.every((it) => Array.isArray(it))) {
+          throw new TypeError(`Failed to construct '${
+            this[Symbol.toStringTag]
+          }': The provided value cannot be converted to a sequence.`);
+        } else if (!input.every((it) => it.length === 2)) {
+          throw new TypeError(`Failed to construct '${
+            this[Symbol.toStringTag]
+          }': Sequence initializer must only contain pair elements.`);
+        }
+      }
+
+      if (input.constructor === Object) {
+        input = Object.entries(input);
+      }
+
+      input.forEach(([key, value]) => this.append(key, value));
+    }
+  }
+
+  #ensureArgs(args, expected, method) {
+    if (args.length < expected) {
+      throw new TypeError(`Failed to execute '${ method }' on '${
+        this[Symbol.toStringTag]
+      }': ${ expected } arguments required, but only ${ args.length } present.`);
+    }
+
+    if ([
+      'append',
+      'set',
+    ].includes(method)) {
+      if (args.length === 3 && !this.constructor.#ensureInstance(args[1])) {
+        throw new TypeError(`Failed to execute '${ method }' on '${
+          this[Symbol.toStringTag]
+        }': parameter ${ expected } is not of type 'Blob', 'File' or async iterable.`);
+      }
+    }
+
+    if (method === 'forEach') {
+      if (args[0]?.constructor !== Function) {
+        throw new TypeError(`Failed to execute '${ method }' on '${
+          this[Symbol.toStringTag]
+        }': parameter ${ expected } is not of type 'Function'.`);
+      }
+    }
+  }
+
+  append(...args) {
+    this.#ensureArgs(args, 2, 'append');
+    this.#entries.push(this.constructor.#enfoldEntry(...args));
+  }
+
+  delete(...args) {
+    this.#ensureArgs(args, 1, 'delete');
+    const name = toUSVString(args[0]);
+
+    this.#entries = this.#entries.filter((it) => it.name !== name);
+  }
+
+  forEach(...args) {
+    this.#ensureArgs(args, 1, 'forEach');
+    const [callback, thisArg] = args;
+
+    for (const entry of this) {
+      Reflect.apply(callback, thisArg, [
+        ...(entry.reverse()),
+        this,
+      ]);
+    }
+  }
+
+  get(...args) {
+    this.#ensureArgs(args, 1, 'get');
+    const name = toUSVString(args[0]);
+
+    return (this.#entries.find((it) => it.name === name) ?? {}).value ?? null;
+  }
+
+  getAll(...args) {
+    this.#ensureArgs(args, 1, 'getAll');
+    const name = toUSVString(args[0]);
+
+    return this.#entries.filter((it) => it.name === name).map((it) => it.value);
+  }
+
+  has(...args) {
+    this.#ensureArgs(args, 1, 'has');
+    const name = toUSVString(args[0]);
+
+    return !!this.#entries.find((it) => it.name === name);
+  }
+
+  set(...args) {
+    this.#ensureArgs(args, 2, 'set');
+    const entry = this.constructor.#enfoldEntry(...args);
+    const idx = this.#entries.findIndex((it) => it.name === entry.name);
+
+    if (idx !== -1) {
+      this.#entries.splice(idx, 1, entry);
+    } else {
+      this.#entries.push(entry);
+    }
+  }
+
+  * entries() {
+    for (const { name, value } of this.#entries) {
+      yield [
+        name,
+        value,
+      ];
+    }
+  }
+
+  * keys() {
+    for (const [name] of this) {
+      yield name;
+    }
+  }
+
+  * values() {
+    for (const [, value] of this) {
+      yield value;
+    }
+  }
+
+  [Symbol.iterator]() {
+    return this.entries();
+  }
+
+}

package/src/helpers.mjs

@@ -1,5 +1,4 @@
 import { Blob } from 'buffer';
-import { globalAgent } from 'http';
 import http2 from 'http2';
 import {
   PassThrough,
@@ -11,6 +10,7 @@ import {
 } from 'util';
 import zlib from 'zlib';
 import { Cookies } from './cookies.mjs';
+import { TimeoutError } from './errors.mjs';
 import { File } from './file.mjs';
 import { FormData } from './formdata.mjs';
 import {
@@ -32,6 +32,7 @@ const {
   HTTP2_HEADER_METHOD,
   HTTP2_HEADER_PATH,
   HTTP2_HEADER_SCHEME,
+  HTTP2_HEADER_STATUS,
   HTTP2_METHOD_GET,
   HTTP2_METHOD_HEAD,
 } = http2.constants;
@@ -43,6 +44,48 @@ const gunzip = promisify(zlib.gunzip);
 const deflate = promisify(zlib.deflate);
 const inflate = promisify(zlib.inflate);
 
+export const admix = (res, headers, options) => {
+  const { h2 } = options;
+
+  if (h2) {
+    Reflect.defineProperty(res, 'headers', {
+      enumerable: true,
+      value: headers,
+    });
+
+    Reflect.defineProperty(res, 'httpVersion', {
+      enumerable: true,
+      value: `${ h2 + 1 }.0`,
+    });
+
+    Reflect.defineProperty(res, 'statusCode', {
+      enumerable: true,
+      value: headers[HTTP2_HEADER_STATUS],
+    });
+  }
+
+  Reflect.defineProperty(res, 'ok', {
+    enumerable: true,
+    value: /^2\d{2}$/.test(res.statusCode),
+  });
+
+  Reflect.defineProperty(res, 'redirected', {
+    enumerable: true,
+    value: !!options.redirected,
+  });
+};
+
+export const affix = (client, req, options) => {
+  req.once('end', () => client?.close());
+  req.once('timeout', () => req.destroy(new TimeoutError(`Timed out after ${ options.timeout } ms.`)));
+  req.once('trailers', (trailers) => {
+    Reflect.defineProperty(req, 'trailers', {
+      enumerable: true,
+      value: trailers,
+    });
+  });
+};
+
 export const compress = (buf, encoding, { async = false } = {}) => {
   encoding &&= encoding.match(/(?<encoding>\bbr\b|\bdeflate\b|\bgzip\b)/i)?.groups.encoding.toLowerCase();
   const compressor = {
@@ -119,65 +162,7 @@ export const merge = (target = {}, ...rest) => {
   return target;
 };
 
-export const preflight = (options) => {
-  const url = options.url = new URL(options.url);
-  const { cookies, h2 = false, method = HTTP2_METHOD_GET, headers, redirected } = options;
-
-  if (!h2) {
-    options.agent ??= url.protocol === 'http:' ? globalAgent : void 0;
-  } else {
-    options.endStream = [
-      HTTP2_METHOD_GET,
-      HTTP2_METHOD_HEAD,
-    ].includes(method);
-  }
-
-  if (cookies !== false) {
-    let cookie = Cookies.jar.get(url.origin);
-
-    if (cookies === Object(cookies) && !redirected) {
-      if (cookie) {
-        new Cookies(cookies).forEach(function (val, key) {
-          this.set(key, val);
-        }, cookie);
-      } else {
-        cookie = new Cookies(cookies);
-        Cookies.jar.set(url.origin, cookie);
-      }
-    }
-
-    options.headers = {
-      ...cookie && { [HTTP2_HEADER_COOKIE]: cookie },
-      ...headers,
-    };
-  }
-
-  options.digest ??= true;
-  options.follow ??= 20;
-  options.h2 ??= h2;
-  options.headers = {
-    [HTTP2_HEADER_ACCEPT]: `${ APPLICATION_JSON }, ${ TEXT_PLAIN }, ${ WILDCARD }`,
-    [HTTP2_HEADER_ACCEPT_ENCODING]: 'br, deflate, gzip, identity',
-    ...Object.entries(options.headers ?? {})
-             .reduce((acc, [key, val]) => (acc[key.toLowerCase()] = val, acc), {}),
-    ...h2 && {
-      [HTTP2_HEADER_AUTHORITY]: url.host,
-      [HTTP2_HEADER_METHOD]: method,
-      [HTTP2_HEADER_PATH]: `${ url.pathname }${ url.search }`,
-      [HTTP2_HEADER_SCHEME]: url.protocol.replace(/\p{Punctuation}/gu, ''),
-    },
-  };
-
-  options.method ??= method;
-  options.parse ??= true;
-  options.redirect ??= 'follow';
-  options.redirected ??= false;
-  options.thenable ??= false;
-
-  return options;
-};
-
-export const premix = (res, { digest = false, parse = false } = {}) => {
+export const mixin = (res, { digest = false, parse = false } = {}) => {
   if (!digest) {
     Object.defineProperties(res, {
       arrayBuffer: {
@@ -217,7 +202,7 @@ export const premix = (res, { digest = false, parse = false } = {}) => {
       enumerable: true,
       value: async function () {
         if (this.bodyUsed) {
-          throw new TypeError('Response stream already read');
+          throw new TypeError('Response stream already read.');
         }
 
         let spool = [];
@@ -265,6 +250,76 @@ export const premix = (res, { digest = false, parse = false } = {}) => {
   });
 };
 
+export const preflight = (options) => {
+  const url = options.url = new URL(options.url);
+  const { cookies, h2 = false, method = HTTP2_METHOD_GET, headers, redirected } = options;
+
+  if (h2) {
+    options.endStream = [
+      HTTP2_METHOD_GET,
+      HTTP2_METHOD_HEAD,
+    ].includes(method);
+  }
+
+  if (cookies !== false) {
+    let cookie = Cookies.jar.get(url.origin);
+
+    if (cookies === Object(cookies) && !redirected) {
+      if (cookie) {
+        new Cookies(cookies).forEach(function (val, key) {
+          this.set(key, val);
+        }, cookie);
+      } else {
+        cookie = new Cookies(cookies);
+        Cookies.jar.set(url.origin, cookie);
+      }
+    }
+
+    options.headers = {
+      ...cookie && { [HTTP2_HEADER_COOKIE]: cookie },
+      ...headers,
+    };
+  }
+
+  options.digest ??= true;
+  options.follow ??= 20;
+  options.h2 ??= h2;
+  options.headers = {
+    [HTTP2_HEADER_ACCEPT]: `${ APPLICATION_JSON }, ${ TEXT_PLAIN }, ${ WILDCARD }`,
+    [HTTP2_HEADER_ACCEPT_ENCODING]: 'br, deflate, gzip, identity',
+    ...Object.entries(options.headers ?? {})
+             .reduce((acc, [key, val]) => (acc[key.toLowerCase()] = val, acc), {}),
+    ...h2 && {
+      [HTTP2_HEADER_AUTHORITY]: url.host,
+      [HTTP2_HEADER_METHOD]: method,
+      [HTTP2_HEADER_PATH]: `${ url.pathname }${ url.search }`,
+      [HTTP2_HEADER_SCHEME]: url.protocol.replace(/\p{Punctuation}/gu, ''),
+    },
+  };
+
+  options.method ??= method;
+  options.parse ??= true;
+  options.redirect ??= redirects.follow;
+
+  if (!Object.values(redirects).includes(options.redirect)) {
+    options.createConnection?.().destroy();
+    throw new TypeError(`Failed to read the 'redirect' property from 'options': The provided value '${
+      options.redirect
+    }' is not a valid enum value.`);
+  }
+
+  options.redirected ??= false;
+  options.thenable ??= false;
+
+  return options;
+};
+
+export const redirects = {
+  error: 'error',
+  follow: 'follow',
+  manual: 'manual',
+};
+
 export async function* tap(value) {
   if (Reflect.has(value, Symbol.asyncIterator)) {
     yield* value;