rekwest 5.0.2 → 5.0.3

package/README.md

@@ -1,241 +1,241 @@
-The robust request library that humanity deserves 🌐
----
-This package provides highly likely functional and **easy-to-use** abstraction atop of
-native [http(s).request](https://nodejs.org/api/https.html#httpsrequesturl-options-callback)
-and [http2.request](https://nodejs.org/api/http2.html#clienthttp2sessionrequestheaders-options).
-
-## Abstract
-
-* Fetch-alike
-* Cool-beans 🫐 config options (with defaults)
-* Automatic HTTP/2 support (ALPN negotiation)
-* Automatic or opt-in body parse (with non-UTF-8 charset decoding)
-* Automatic and simplistic `Cookies` treatment (with built-in **jar** & **ttl**)
-* Automatic decompression (with opt-in body compression)
-* Built-in streamable `FormData` interface
-* Support redirects & retries with fine-grained tune-ups
-* Support all legit request body types (include blobs & streams)
-* Support both CJS and ESM module systems
-* Fully promise-able and pipe-able
-* Zero dependencies
-
-## Prerequisites
-
-* Node.js `>= 18.13.0`
-
-## Installation
-
-```bash
-npm install rekwest --save
-```
-
-### Usage
-
-```javascript
-import rekwest, { constants } from 'rekwest';
-
-const {
-  HTTP2_HEADER_AUTHORIZATION,
-  HTTP2_HEADER_CONTENT_ENCODING,
-  HTTP2_METHOD_POST,
-  HTTP_STATUS_OK,
-} = constants;
-
-const url = 'https://somewhe.re/somewhat/endpoint';
-
-const res = await rekwest(url, {
-  body: { celestial: 'payload' },
-  headers: {
-    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
-    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
-    /** [HTTP2_HEADER_CONTENT_TYPE]
-     * is undue for
-     * Array/Blob/File/FormData/Object/URLSearchParams body types
-     * and will be set automatically, with an option to override it here
-     */
-  },
-  method: HTTP2_METHOD_POST,
-});
-
-console.assert(res.statusCode === HTTP_STATUS_OK);
-console.info(res.headers);
-console.log(res.body);
-```
-
----
-
-```javascript
-import { Readable } from 'node:stream';
-import rekwest, {
-  constants,
-  Blob,
-  File,
-  FormData,
-} from 'rekwest';
-
-const {
-  HTTP2_HEADER_AUTHORIZATION,
-  HTTP2_HEADER_CONTENT_ENCODING,
-  HTTP2_METHOD_POST,
-  HTTP_STATUS_OK,
-} = constants;
-
-const blob = new Blob(['bits']);
-const file = new File(['bits'], 'file.dab');
-const readable = Readable.from('bits');
-
-const fd = new FormData({
-  aux: Date.now(),  // either [[key, value]] or kv sequenceable
-});
-
-fd.append('celestial', 'payload');
-fd.append('blob', blob, 'blob.dab');
-fd.append('file', file);
-fd.append('readable', readable, 'readable.dab');
-
-const url = 'https://somewhe.re/somewhat/endpoint';
-
-const res = await rekwest(url, {
-  body: fd,
-  headers: {
-    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
-    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
-  },
-  method: HTTP2_METHOD_POST,
-});
-
-console.assert(res.statusCode === HTTP_STATUS_OK);
-console.info(res.headers);
-console.log(res.body);
-```
-
-### API
-
-#### `rekwest(url[, options])`
-
-* `url` **{string | URL}** The URL to send the request to
-* `options` **{Object}**
-  Extends [http(s).RequestOptions](https://nodejs.org/api/https.html#httpsrequesturl-options-callback) along with
-  extra [http2.ClientSessionOptions](https://nodejs.org/api/http2.html#http2connectauthority-options-listener)
-  & [http2.ClientSessionRequestOptions](https://nodejs.org/api/http2.html#clienthttp2sessionrequestheaders-options)
-  and [tls.ConnectionOptions](https://nodejs.org/api/tls.html#tlsconnectoptions-callback)
-  for HTTP/2 attunes
-  * `baseURL` **{string | URL}** The base URL to use in cases where `url` is a relative URL
-  * `body` **{string | Array | ArrayBuffer | ArrayBufferView | AsyncIterator | Blob | Buffer | DataView | File |
-    FormData | Iterator | Object | Readable | ReadableStream | SharedArrayBuffer | URLSearchParams}** The body to send
-    with the request
-  * `cookies` **{boolean | Array<[k, v]> | Array<string\> | Cookies | Object | URLSearchParams}** `Default: true` The
-    cookies to add to
-    the request
-  * `cookiesTTL` **{boolean}** `Default: false` Controls enablement of TTL for the cookies cache
-  * `credentials` **{include | omit | same-origin}** `Default: same-origin` Controls credentials in case of cross-origin
-    redirects
-  * `digest` **{boolean}** `Default: true` Controls whether to read the response stream or simply add a mixin
-  * `follow` **{number}** `Default: 20` The number of redirects to follow
-  * `h2` **{boolean}** `Default: false` Forces the use of HTTP/2 protocol
-  * `headers` **{Object}** The headers to add to the request
-  * `maxRetryAfter` **{number}** The upper limit of `retry-after` header. If unset, it will use `timeout` value
-  * `parse` **{boolean}** `Default: true` Controls whether to parse response body or simply return a buffer
-  * `redirect` **{error | follow | manual}** `Default: follow` Controls the redirect flows
-  * `retry` **{Object}** Represents the retry options
-    * `attempts` **{number}** `Default: 0` The number of retry attempts
-    * `backoffStrategy` **{string}** `Default: interval * Math.log(Math.random() * (Math.E * Math.E - Math.E) + Math.E)`
-      The backoff strategy algorithm that increases logarithmically. To fixate set value to `interval * 1`
-    * `interval` **{number}** `Default: 1e3` The initial retry interval
-    * `retryAfter` **{boolean}** `Default: true` Controls `retry-after` header receptiveness
-    * `statusCodes` **{number[]}** `Default: [429, 503]` The list of status codes to retry on
-  * `stripTrailingSlash` **{boolean}** `Default: false` Controls whether to strip trailing slash at the end of the URL
-  * `thenable` **{boolean}** `Default: false` Controls the promise resolutions
-  * `timeout` **{number}** `Default: 3e5` The number of milliseconds a request can take before termination
-  * `trimTrailingSlashes` **{boolean}** `Default: false` Controls whether to trim trailing slashes within the URL
-* **Returns:** Promise that resolves to
-  extended [http.IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage)
-  or [http2.ClientHttp2Stream](https://nodejs.org/api/http2.html#class-clienthttp2stream) which is respectively
-  readable and duplex streams
-  * if `digest: true` & `parse: true`
-    * `body` **{string | Array | Buffer | Object}** The body based on its content type
-  * if `digest: false`
-    * `arrayBuffer` **{AsyncFunction}** Reads the response and returns **ArrayBuffer**
-    * `blob` **{AsyncFunction}** Reads the response and returns **Blob**
-    * `body` **{AsyncFunction}** Reads the response and returns **Buffer** if `parse: false`
-    * `json` **{AsyncFunction}** Reads the response and returns **Object**
-    * `text` **{AsyncFunction}** Reads the response and returns **String**
-  * `bodyUsed` **{boolean}** Indicates whether the response were read or not
-  * `cookies` **{undefined | Cookies}** The cookies sent and received with the response
-  * `headers` **{Object}** The headers received with the response
-  * `httpVersion` **{string}** Indicates protocol version negotiated with the server
-  * `ok` **{boolean}** Indicates if the response was successful (statusCode: **200-299**)
-  * `redirected` **{boolean}** Indicates if the response is the result of a redirect
-  * `statusCode` **{number}** Indicates the status code of the response
-  * `trailers` **{undefined | Object}** The trailer headers received with the response
-
----
-
-#### `rekwest.defaults`
-
-The object to fulfill with default [options](#rekwesturl-options).
-
----
-
-#### `rekwest.extend(options)`
-
-The method to extend default [options](#rekwesturl-options) per instance.
-
-```javascript
-import rekwest, { constants } from 'rekwest';
-
-const {
-  HTTP_STATUS_OK,
-} = constants;
-
-const rk = rekwest.extend({
-  baseURL: 'https://somewhe.re',
-});
-
-const signal = AbortSignal.timeout(1e4);
-const url = '/somewhat/endpoint';
-
-const res = await rk(url, {
-  signal,
-});
-
-console.assert(res.statusCode === HTTP_STATUS_OK);
-console.info(res.headers);
-console.log(res.body);
-```
-
----
-
-#### `rekwest.stream(url[, options])`
-
-The method with limited functionality to use with streams and/or pipes.
-
-* No automata (redirects & retries)
-* Pass `h2: true` in options to use HTTP/2 protocol
-  * Use `ackn({ url: URL })` method in advance to check the available protocols
-
-```javascript
-import fs from 'node:fs';
-import { pipeline } from 'node:stream/promises';
-import rekwest, {
-  ackn,
-  constants,
-} from 'rekwest';
-
-const {
-  HTTP2_METHOD_POST,
-} = constants;
-
-const url = new URL('https://somewhe.re/somewhat/endpoint');
-const options = await ackn({ url });
-
-await pipeline(
-  fs.createReadStream('/var/tmp/vent/inlet.dab'),
-  rekwest.stream(url, { ...options, method: HTTP2_METHOD_POST }),
-  fs.createWriteStream('/var/tmp/vent/outlet.dab'),
-);
-```
-
----
-
-For more details, please check tests (coverage: **>97%**) in the repository.
+The robust request library that humanity deserves 🌐
+---
+This package provides highly likely functional and **easy-to-use** abstraction atop of
+native [http(s).request](https://nodejs.org/api/https.html#httpsrequesturl-options-callback)
+and [http2.request](https://nodejs.org/api/http2.html#clienthttp2sessionrequestheaders-options).
+
+## Abstract
+
+* Fetch-alike
+* Cool-beans 🫐 config options (with defaults)
+* Automatic HTTP/2 support (ALPN negotiation)
+* Automatic or opt-in body parse (with non-UTF-8 charset decoding)
+* Automatic and simplistic `Cookies` treatment (with built-in **jar** & **ttl**)
+* Automatic decompression (with opt-in body compression)
+* Built-in streamable `FormData` interface
+* Support redirects & retries with fine-grained tune-ups
+* Support all legit request body types (include blobs & streams)
+* Support both CJS and ESM module systems
+* Fully promise-able and pipe-able
+* Zero dependencies
+
+## Prerequisites
+
+* Node.js `>= 18.13.0`
+
+## Installation
+
+```bash
+npm install rekwest --save
+```
+
+### Usage
+
+```javascript
+import rekwest, { constants } from 'rekwest';
+
+const {
+  HTTP2_HEADER_AUTHORIZATION,
+  HTTP2_HEADER_CONTENT_ENCODING,
+  HTTP2_METHOD_POST,
+  HTTP_STATUS_OK,
+} = constants;
+
+const url = 'https://somewhe.re/somewhat/endpoint';
+
+const res = await rekwest(url, {
+  body: { celestial: 'payload' },
+  headers: {
+    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
+    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
+    /** [HTTP2_HEADER_CONTENT_TYPE]
+     * is undue for
+     * Array/Blob/File/FormData/Object/URLSearchParams body types
+     * and will be set automatically, with an option to override it here
+     */
+  },
+  method: HTTP2_METHOD_POST,
+});
+
+console.assert(res.statusCode === HTTP_STATUS_OK);
+console.info(res.headers);
+console.log(res.body);
+```
+
+---
+
+```javascript
+import { Readable } from 'node:stream';
+import rekwest, {
+  constants,
+  Blob,
+  File,
+  FormData,
+} from 'rekwest';
+
+const {
+  HTTP2_HEADER_AUTHORIZATION,
+  HTTP2_HEADER_CONTENT_ENCODING,
+  HTTP2_METHOD_POST,
+  HTTP_STATUS_OK,
+} = constants;
+
+const blob = new Blob(['bits']);
+const file = new File(['bits'], 'file.dab');
+const readable = Readable.from('bits');
+
+const fd = new FormData({
+  aux: Date.now(),  // either [[key, value]] or kv sequenceable
+});
+
+fd.append('celestial', 'payload');
+fd.append('blob', blob, 'blob.dab');
+fd.append('file', file);
+fd.append('readable', readable, 'readable.dab');
+
+const url = 'https://somewhe.re/somewhat/endpoint';
+
+const res = await rekwest(url, {
+  body: fd,
+  headers: {
+    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
+    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
+  },
+  method: HTTP2_METHOD_POST,
+});
+
+console.assert(res.statusCode === HTTP_STATUS_OK);
+console.info(res.headers);
+console.log(res.body);
+```
+
+### API
+
+#### `rekwest(url[, options])`
+
+* `url` **{string | URL}** The URL to send the request to
+* `options` **{Object}**
+  Extends [http(s).RequestOptions](https://nodejs.org/api/https.html#httpsrequesturl-options-callback) along with
+  extra [http2.ClientSessionOptions](https://nodejs.org/api/http2.html#http2connectauthority-options-listener)
+  & [http2.ClientSessionRequestOptions](https://nodejs.org/api/http2.html#clienthttp2sessionrequestheaders-options)
+  and [tls.ConnectionOptions](https://nodejs.org/api/tls.html#tlsconnectoptions-callback)
+  for HTTP/2 attunes
+  * `baseURL` **{string | URL}** The base URL to use in cases where `url` is a relative URL
+  * `body` **{string | Array | ArrayBuffer | ArrayBufferView | AsyncIterator | Blob | Buffer | DataView | File |
+    FormData | Iterator | Object | Readable | ReadableStream | SharedArrayBuffer | URLSearchParams}** The body to send
+    with the request
+  * `cookies` **{boolean | Array<[k, v]> | Array<string\> | Cookies | Object | URLSearchParams}** `Default: true` The
+    cookies to add to
+    the request
+  * `cookiesTTL` **{boolean}** `Default: false` Controls enablement of TTL for the cookies cache
+  * `credentials` **{include | omit | same-origin}** `Default: same-origin` Controls credentials in case of cross-origin
+    redirects
+  * `digest` **{boolean}** `Default: true` Controls whether to read the response stream or simply add a mixin
+  * `follow` **{number}** `Default: 20` The number of redirects to follow
+  * `h2` **{boolean}** `Default: false` Forces the use of HTTP/2 protocol
+  * `headers` **{Object}** The headers to add to the request
+  * `maxRetryAfter` **{number}** The upper limit of `retry-after` header. If unset, it will use `timeout` value
+  * `parse` **{boolean}** `Default: true` Controls whether to parse response body or simply return a buffer
+  * `redirect` **{error | follow | manual}** `Default: follow` Controls the redirect flows
+  * `retry` **{Object}** Represents the retry options
+    * `attempts` **{number}** `Default: 0` The number of retry attempts
+    * `backoffStrategy` **{string}** `Default: interval * Math.log(Math.random() * (Math.E * Math.E - Math.E) + Math.E)`
+      The backoff strategy algorithm that increases logarithmically. To fixate set value to `interval * 1`
+    * `interval` **{number}** `Default: 1e3` The initial retry interval
+    * `retryAfter` **{boolean}** `Default: true` Controls `retry-after` header receptiveness
+    * `statusCodes` **{number[]}** `Default: [429, 503]` The list of status codes to retry on
+  * `stripTrailingSlash` **{boolean}** `Default: false` Controls whether to strip trailing slash at the end of the URL
+  * `thenable` **{boolean}** `Default: false` Controls the promise resolutions
+  * `timeout` **{number}** `Default: 3e5` The number of milliseconds a request can take before termination
+  * `trimTrailingSlashes` **{boolean}** `Default: false` Controls whether to trim trailing slashes within the URL
+* **Returns:** Promise that resolves to
+  extended [http.IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage)
+  or [http2.ClientHttp2Stream](https://nodejs.org/api/http2.html#class-clienthttp2stream) which is respectively
+  readable and duplex streams
+  * if `digest: true` & `parse: true`
+    * `body` **{string | Array | Buffer | Object}** The body based on its content type
+  * if `digest: false`
+    * `arrayBuffer` **{AsyncFunction}** Reads the response and returns **ArrayBuffer**
+    * `blob` **{AsyncFunction}** Reads the response and returns **Blob**
+    * `body` **{AsyncFunction}** Reads the response and returns **Buffer** if `parse: false`
+    * `json` **{AsyncFunction}** Reads the response and returns **Object**
+    * `text` **{AsyncFunction}** Reads the response and returns **String**
+  * `bodyUsed` **{boolean}** Indicates whether the response were read or not
+  * `cookies` **{undefined | Cookies}** The cookies sent and received with the response
+  * `headers` **{Object}** The headers received with the response
+  * `httpVersion` **{string}** Indicates protocol version negotiated with the server
+  * `ok` **{boolean}** Indicates if the response was successful (statusCode: **200-299**)
+  * `redirected` **{boolean}** Indicates if the response is the result of a redirect
+  * `statusCode` **{number}** Indicates the status code of the response
+  * `trailers` **{undefined | Object}** The trailer headers received with the response
+
+---
+
+#### `rekwest.defaults`
+
+The object to fulfill with default [options](#rekwesturl-options).
+
+---
+
+#### `rekwest.extend(options)`
+
+The method to extend default [options](#rekwesturl-options) per instance.
+
+```javascript
+import rekwest, { constants } from 'rekwest';
+
+const {
+  HTTP_STATUS_OK,
+} = constants;
+
+const rk = rekwest.extend({
+  baseURL: 'https://somewhe.re',
+});
+
+const signal = AbortSignal.timeout(1e4);
+const url = '/somewhat/endpoint';
+
+const res = await rk(url, {
+  signal,
+});
+
+console.assert(res.statusCode === HTTP_STATUS_OK);
+console.info(res.headers);
+console.log(res.body);
+```
+
+---
+
+#### `rekwest.stream(url[, options])`
+
+The method with limited functionality to use with streams and/or pipes.
+
+* No automata (redirects & retries)
+* Pass `h2: true` in options to use HTTP/2 protocol
+  * Use `ackn({ url: URL })` method in advance to check the available protocols
+
+```javascript
+import fs from 'node:fs';
+import { pipeline } from 'node:stream/promises';
+import rekwest, {
+  ackn,
+  constants,
+} from 'rekwest';
+
+const {
+  HTTP2_METHOD_POST,
+} = constants;
+
+const url = new URL('https://somewhe.re/somewhat/endpoint');
+const options = await ackn({ url });
+
+await pipeline(
+  fs.createReadStream('/var/tmp/vent/inlet.xyz'),
+  rekwest.stream(url, { ...options, method: HTTP2_METHOD_POST }),
+  fs.createWriteStream('/var/tmp/vent/outlet.xyz'),
+);
+```
+
+---
+
+For more details, please check tests (coverage: **>97%**) in the repository.

package/dist/cookies.js

@@ -31,41 +31,45 @@ class Cookies extends URLSearchParams {
           return [it.split(';').at(0).trim()];
         }
         const [cookie, ...attrs] = it.split(';').map(it => it.trim());
-        const ttl = attrs.reduce((acc, val) => {
+        const ttl = {};
+        for (const val of attrs) {
           if (/(?:Expires|Max-Age)=/i.test(val)) {
             const [key, value] = val.toLowerCase().split('=');
-            acc[(0, _utils.toCamelCase)(key)] = !Number.isNaN(Number(value)) ? value * 1e3 : Date.parse(value) - Date.now();
+            ttl[(0, _utils.toCamelCase)(key)] = !Number.isNaN(Number(value)) ? value * 1e3 : Date.parse(value) - Date.now();
           }
-          return acc;
-        }, {});
+        }
         return [cookie.replace(/\u0022/g, ''), Object.keys(ttl).length ? ttl : null];
       });
     }
     super(Array.isArray(input) ? input.map(it => it.at(0)).join('&') : input);
     if (Array.isArray(input) && cookiesTTL) {
-      input.filter(it => it.at(1)).forEach(([cookie, ttl]) => {
-        cookie = cookie.split('=').at(0);
-        if (this.#chronometry.has(cookie)) {
-          clearTimeout(this.#chronometry.get(cookie));
-          this.#chronometry.delete(cookie);
+      for (const [cookie, ttl] of input.filter(it => it.at(1))) {
+        const key = cookie.split('=').at(0);
+        if (this.#chronometry.has(key)) {
+          clearTimeout(this.#chronometry.get(key));
+          this.#chronometry.delete(key);
         }
         const {
           expires,
           maxAge
         } = ttl;
-        [maxAge, expires].filter(it => Number.isInteger(it)).some(ms => {
+        for (const ms of [maxAge, expires]) {
+          if (!Number.isInteger(ms)) {
+            continue;
+          }
           const ref = new WeakRef(this);
           const tid = setTimeout(() => {
             const ctx = ref.deref();
             if (ctx) {
-              ctx.#chronometry.delete(cookie);
-              ctx.delete(cookie);
+              ctx.#chronometry.delete(key);
+              ctx.delete(key);
             }
           }, Math.max(ms, 0));
           this.constructor.#register(this, tid);
-          return this.#chronometry.set(cookie, tid);
-        });
-      });
+          this.#chronometry.set(key, tid);
+          break;
+        }
+      }
     }
   }
   toString() {

package/dist/formdata.js

@@ -81,7 +81,9 @@ class FormData {
       if (input.constructor === Object) {
         input = Object.entries(input);
       }
-      input.forEach(([key, value]) => this.append(key, value));
+      for (const [key, value] of input) {
+        this.append(key, value);
+      }
     }
   }
   #ensureArgs(args, expected, method) {

package/dist/postflight.js

@@ -87,7 +87,9 @@ const postflight = (req, res, options, {
         return res.emit('error', new _errors.RequestError(`Unable to ${redirect} redirect with streamable body.`));
       }
       if ([HTTP_STATUS_MOVED_PERMANENTLY, HTTP_STATUS_FOUND].includes(statusCode) && options.method === HTTP2_METHOD_POST || statusCode === HTTP_STATUS_SEE_OTHER && ![HTTP2_METHOD_GET, HTTP2_METHOD_HEAD].includes(options.method)) {
-        Object.keys(options.headers).filter(it => /^content-/i.test(it)).forEach(it => Reflect.deleteProperty(options.headers, it));
+        for (const it of Object.keys(options.headers).filter(val => /^content-/i.test(val))) {
+          Reflect.deleteProperty(options.headers, it);
+        }
         options.body = null;
         options.method = HTTP2_METHOD_GET;
       }

package/dist/preflight.js

@@ -60,7 +60,9 @@ const preflight = options => {
   }
   if (credentials === _constants.requestCredentials.omit) {
     options.cookies = false;
-    Object.keys(options.headers ?? {}).filter(it => new RegExp(`^(${HTTP2_HEADER_AUTHORIZATION}|${HTTP2_HEADER_COOKIE})$`, 'i').test(it)).forEach(it => Reflect.deleteProperty(options.headers, it));
+    for (const it of Object.keys(options.headers ?? {}).filter(val => new RegExp(`^(${HTTP2_HEADER_AUTHORIZATION}|${HTTP2_HEADER_COOKIE})$`, 'i').test(val))) {
+      Reflect.deleteProperty(options.headers, it);
+    }
     url.password = url.username = '';
   }
   options.headers = {

package/dist/transfer.js

@@ -35,7 +35,9 @@ const transfer = async (options, overact) => {
       protocol: url.protocol
     };
   } else if (Reflect.has(options, 'alpnProtocol')) {
-    ['alpnProtocol', 'createConnection', 'h2', 'protocol'].forEach(it => Reflect.deleteProperty(options, it));
+    for (const it of ['alpnProtocol', 'createConnection', 'h2', 'protocol']) {
+      Reflect.deleteProperty(options, it);
+    }
   }
   try {
     options = await (0, _transform.transform)((0, _preflight.preflight)(options));