rekwest 6.0.1 → 6.2.0

package/README.md

@@ -120,6 +120,8 @@ console.log(res.body);
   & [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
+  * `compression` **{Object}** Configures compression options, e.g.: `brotliOptions`, `zstdOptions`,
+    `zlibOptions`
   * `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
@@ -130,12 +132,14 @@ console.log(res.body);
   * `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
+  * `decompression` **{Object}** Configures decompression options, e.g.: `brotliOptions`, `zstdOptions`,
+    `zlibOptions`
+  * `digest` **{boolean}** `Default: true` Controls whether to read the response stream or 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
+  * `parse` **{boolean}** `Default: true` Controls whether to parse response body or 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
@@ -164,10 +168,10 @@ console.log(res.body);
     * `bytes` **{AsyncFunction}** Reads the response and returns **Uint8Array**
     * `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
+  * `bodyUsed` **{boolean}** Indicates whether the response was 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
+  * `httpVersion` **{string}** Indicates a 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

package/dist/config.js

@@ -22,8 +22,21 @@ const {
 } = _nodeHttp.default.constants;
 const isZstdSupported = exports.isZstdSupported = !!_nodeZlib.default.constants.ZSTD_CLEVEL_DEFAULT;
 const defaults = {
+  compression: {
+    brotliOptions: {
+      params: {
+        [_nodeZlib.default.constants.BROTLI_PARAM_QUALITY]: 4
+      }
+    },
+    zstdOptions: {
+      params: {
+        [_nodeZlib.default.constants.ZSTD_c_compressionLevel]: 6
+      }
+    }
+  },
   cookiesTTL: false,
   credentials: _constants.requestCredentials.sameOrigin,
+  decompression: {},
   digest: true,
   follow: 20,
   h2: false,

package/dist/mixin.js

@@ -13,6 +13,7 @@ const {
   HTTP2_HEADER_CONTENT_TYPE
 } = _nodeHttp.default.constants;
 const mixin = (res, {
+  decompression,
   digest = false,
   parse = false
 } = {}) => {
@@ -73,7 +74,9 @@ const mixin = (res, {
           throw new TypeError('Response stream already read');
         }
         let body = [];
-        for await (const chunk of (0, _utils.decompress)(this, this.headers[HTTP2_HEADER_CONTENT_ENCODING])) {
+        for await (const chunk of (0, _utils.decompress)(this, this.headers[HTTP2_HEADER_CONTENT_ENCODING], {
+          decompression
+        })) {
           body.push(chunk);
         }
         body = Buffer.concat(body);

package/dist/transform.js

@@ -58,9 +58,9 @@ const transform = async options => {
   const encodings = options.headers[HTTP2_HEADER_CONTENT_ENCODING];
   if (body === Object(body) && (Reflect.has(body, Symbol.asyncIterator) || !Array.isArray(body) && Reflect.has(body, Symbol.iterator))) {
     body = (0, _nodeStream.isReadable)(body) ? (0, _utils.isReadableStream)(body) ? _nodeStream.Readable.fromWeb(body) : body : _nodeStream.Readable.from(body);
-    body = encodings ? (0, _utils.compress)(body, encodings) : body;
+    body = encodings ? (0, _utils.compress)(body, encodings, options) : body;
   } else if (encodings) {
-    body = await (0, _consumers.buffer)((0, _utils.compress)(_nodeStream.Readable.from(body), encodings));
+    body = await (0, _consumers.buffer)((0, _utils.compress)(_nodeStream.Readable.from(body), encodings, options));
   }
   Object.assign(options.headers, {
     ...headers,

package/dist/utils.js

@@ -64,20 +64,22 @@ const brandCheck = (value, ctor) => {
   }
 };
 exports.brandCheck = brandCheck;
-const compress = (readable, encodings = '') => {
+const compress = (readable, encodings = '', {
+  compression
+} = {}) => {
   const encoders = [];
   encodings = unwind(encodings);
   for (const encoding of encodings) {
     if (/\bbr\b/i.test(encoding)) {
-      encoders.push(_nodeZlib.default.createBrotliCompress());
+      encoders.push(_nodeZlib.default.createBrotliCompress(compression?.brotliOptions));
     } else if (/\bdeflate(?!-(?:\w+)?)\b/i.test(encoding)) {
-      encoders.push(_nodeZlib.default.createDeflate());
+      encoders.push(_nodeZlib.default.createDeflate(compression?.zlibOptions));
     } else if (/\bdeflate-raw\b/i.test(encoding)) {
-      encoders.push(_nodeZlib.default.createDeflateRaw());
+      encoders.push(_nodeZlib.default.createDeflateRaw(compression?.zlibOptions));
     } else if (/\bgzip\b/i.test(encoding)) {
-      encoders.push(_nodeZlib.default.createGzip());
+      encoders.push(_nodeZlib.default.createGzip(compression?.zlibOptions));
     } else if (_config.isZstdSupported && /\bzstd\b/i.test(encoding)) {
-      encoders.push(_nodeZlib.default.createZstdCompress());
+      encoders.push(_nodeZlib.default.createZstdCompress(compression?.zstdOptions));
     } else {
       return readable;
     }
@@ -93,20 +95,22 @@ const copyWithMerge = (target, ...rest) => {
   return merge(target, ...rest);
 };
 exports.copyWithMerge = copyWithMerge;
-const decompress = (readable, encodings = '') => {
+const decompress = (readable, encodings = '', {
+  decompression
+} = {}) => {
   const decoders = [];
   encodings = unwind(encodings);
   for (const encoding of encodings) {
     if (/\bbr\b/i.test(encoding)) {
-      decoders.push(_nodeZlib.default.createBrotliDecompress());
+      decoders.push(_nodeZlib.default.createBrotliDecompress(decompression?.brotliOptions));
     } else if (/\bdeflate(?!-(?:\w+)?)\b/i.test(encoding)) {
-      decoders.push(_nodeZlib.default.createInflate());
+      decoders.push(_nodeZlib.default.createInflate(decompression?.zlibOptions));
     } else if (/\bdeflate-raw\b/i.test(encoding)) {
-      decoders.push(_nodeZlib.default.createInflateRaw());
+      decoders.push(_nodeZlib.default.createInflateRaw(decompression?.zlibOptions));
     } else if (/\bgzip\b/i.test(encoding)) {
-      decoders.push(_nodeZlib.default.createGunzip());
+      decoders.push(_nodeZlib.default.createGunzip(decompression?.zlibOptions));
     } else if (_config.isZstdSupported && /\bzstd\b/i.test(encoding)) {
-      decoders.push(_nodeZlib.default.createZstdDecompress());
+      decoders.push(_nodeZlib.default.createZstdDecompress(decompression?.zstdOptions));
     } else {
       return readable;
     }

package/package.json

@@ -8,14 +8,14 @@
     "url": "https://github.com/bricss/rekwest/issues"
   },
   "devDependencies": {
-    "@babel/cli": "^7.28.0",
-    "@babel/core": "^7.28.0",
-    "@babel/eslint-parser": "^7.28.0",
-    "@babel/preset-env": "^7.28.0",
+    "@babel/cli": "^7.28.3",
+    "@babel/core": "^7.28.4",
+    "@babel/eslint-parser": "^7.28.4",
+    "@babel/preset-env": "^7.28.3",
     "c8": "^10.1.3",
-    "eslint": "^9.33.0",
-    "eslint-config-ultra-refined": "^3.7.4",
-    "mocha": "^11.7.1"
+    "eslint": "^9.35.0",
+    "eslint-config-ultra-refined": "^3.8.0",
+    "mocha": "^11.7.2"
   },
   "description": "The robust request library that humanity deserves 🌐",
   "engines": {
@@ -71,5 +71,5 @@
     "test:bail": "mocha --bail",
     "test:cover": "c8 --include=src --reporter=lcov --reporter=text npm test"
   },
-  "version": "6.0.1"
+  "version": "6.2.0"
 }

package/src/config.mjs

@@ -25,8 +25,21 @@ const {
 export const isZstdSupported = !!zlib.constants.ZSTD_CLEVEL_DEFAULT;
 
 const defaults = {
+  compression: {
+    brotliOptions: {
+      params: {
+        [zlib.constants.BROTLI_PARAM_QUALITY]: 4,
+      },
+    },
+    zstdOptions: {
+      params: {
+        [zlib.constants.ZSTD_c_compressionLevel]: 6,
+      },
+    },
+  },
   cookiesTTL: false,
   credentials: requestCredentials.sameOrigin,
+  decompression: {},
   digest: true,
   follow: 20,
   h2: false,

package/src/mixin.mjs

@@ -1,117 +1,117 @@
-import { Blob } from 'node:buffer';
-import http2 from 'node:http2';
-import {
-  brandCheck,
-  decompress,
-} from './utils.mjs';
-
-const {
-  HTTP2_HEADER_CONTENT_ENCODING,
-  HTTP2_HEADER_CONTENT_TYPE,
-} = http2.constants;
-
-export const mixin = (res, { digest = false, parse = false } = {}) => {
-  if (!digest) {
-    Object.defineProperties(res, {
-      arrayBuffer: {
-        enumerable: true,
-        value: async function () {
-          brandCheck(this, res?.constructor);
-          parse &&= false;
-          const { buffer, byteLength, byteOffset } = await this.body();
-
-          return buffer.slice(byteOffset, byteOffset + byteLength);
-        },
-      },
-      blob: {
-        enumerable: true,
-        value: async function () {
-          brandCheck(this, res?.constructor);
-          const val = await this.arrayBuffer();
-
-          return new Blob([val]);
-        },
-      },
-      bytes: {
-        enumerable: true,
-        value: async function () {
-          brandCheck(this, res?.constructor);
-
-          return new Uint8Array(await this.arrayBuffer());
-        },
-      },
-      json: {
-        enumerable: true,
-        value: async function () {
-          brandCheck(this, res?.constructor);
-          const val = await this.text();
-
-          return JSON.parse(val);
-        },
-      },
-      text: {
-        enumerable: true,
-        value: async function () {
-          brandCheck(this, res?.constructor);
-          const blob = await this.blob();
-
-          return blob.text();
-        },
-      },
-    });
-  }
-
-  return Object.defineProperties(res, {
-    body: {
-      enumerable: true,
-      value: async function () {
-        brandCheck(this, res?.constructor);
-
-        if (this.bodyUsed) {
-          throw new TypeError('Response stream already read');
-        }
-
-        let body = [];
-
-        for await (const chunk of decompress(this, this.headers[HTTP2_HEADER_CONTENT_ENCODING])) {
-          body.push(chunk);
-        }
-
-        body = Buffer.concat(body);
-
-        if (!body.length && parse) {
-          return null;
-        }
-
-        if (body.length && parse) {
-          const contentType = this.headers[HTTP2_HEADER_CONTENT_TYPE] ?? '';
-          const charset = contentType.split(';')
-                                     .find((it) => /charset=/i.test(it))
-                                     ?.toLowerCase()
-                                     .replace('charset=', '')
-                                     .replace('iso-8859-1', 'latin1')
-                                     .trim() || 'utf-8';
-
-          if (/\bjson\b/i.test(contentType)) {
-            body = JSON.parse(body.toString(charset));
-          } else if (/\b(?:text|xml)\b/i.test(contentType)) {
-            if (/\b(?:latin1|ucs-2|utf-(?:8|16le))\b/i.test(charset)) {
-              body = body.toString(charset);
-            } else {
-              body = new TextDecoder(charset).decode(body);
-            }
-          }
-        }
-
-        return body;
-      },
-      writable: true,
-    },
-    bodyUsed: {
-      enumerable: true,
-      get() {
-        return this.readableEnded;
-      },
-    },
-  });
-};
+import { Blob } from 'node:buffer';
+import http2 from 'node:http2';
+import {
+  brandCheck,
+  decompress,
+} from './utils.mjs';
+
+const {
+  HTTP2_HEADER_CONTENT_ENCODING,
+  HTTP2_HEADER_CONTENT_TYPE,
+} = http2.constants;
+
+export const mixin = (res, { decompression, digest = false, parse = false } = {}) => {
+  if (!digest) {
+    Object.defineProperties(res, {
+      arrayBuffer: {
+        enumerable: true,
+        value: async function () {
+          brandCheck(this, res?.constructor);
+          parse &&= false;
+          const { buffer, byteLength, byteOffset } = await this.body();
+
+          return buffer.slice(byteOffset, byteOffset + byteLength);
+        },
+      },
+      blob: {
+        enumerable: true,
+        value: async function () {
+          brandCheck(this, res?.constructor);
+          const val = await this.arrayBuffer();
+
+          return new Blob([val]);
+        },
+      },
+      bytes: {
+        enumerable: true,
+        value: async function () {
+          brandCheck(this, res?.constructor);
+
+          return new Uint8Array(await this.arrayBuffer());
+        },
+      },
+      json: {
+        enumerable: true,
+        value: async function () {
+          brandCheck(this, res?.constructor);
+          const val = await this.text();
+
+          return JSON.parse(val);
+        },
+      },
+      text: {
+        enumerable: true,
+        value: async function () {
+          brandCheck(this, res?.constructor);
+          const blob = await this.blob();
+
+          return blob.text();
+        },
+      },
+    });
+  }
+
+  return Object.defineProperties(res, {
+    body: {
+      enumerable: true,
+      value: async function () {
+        brandCheck(this, res?.constructor);
+
+        if (this.bodyUsed) {
+          throw new TypeError('Response stream already read');
+        }
+
+        let body = [];
+
+        for await (const chunk of decompress(this, this.headers[HTTP2_HEADER_CONTENT_ENCODING], { decompression })) {
+          body.push(chunk);
+        }
+
+        body = Buffer.concat(body);
+
+        if (!body.length && parse) {
+          return null;
+        }
+
+        if (body.length && parse) {
+          const contentType = this.headers[HTTP2_HEADER_CONTENT_TYPE] ?? '';
+          const charset = contentType.split(';')
+                                     .find((it) => /charset=/i.test(it))
+                                     ?.toLowerCase()
+                                     .replace('charset=', '')
+                                     .replace('iso-8859-1', 'latin1')
+                                     .trim() || 'utf-8';
+
+          if (/\bjson\b/i.test(contentType)) {
+            body = JSON.parse(body.toString(charset));
+          } else if (/\b(?:text|xml)\b/i.test(contentType)) {
+            if (/\b(?:latin1|ucs-2|utf-(?:8|16le))\b/i.test(charset)) {
+              body = body.toString(charset);
+            } else {
+              body = new TextDecoder(charset).decode(body);
+            }
+          }
+        }
+
+        return body;
+      },
+      writable: true,
+    },
+    bodyUsed: {
+      enumerable: true,
+      get() {
+        return this.readableEnded;
+      },
+    },
+  });
+};

package/src/transform.mjs

@@ -60,9 +60,9 @@ export const transform = async (options) => {
   if (body === Object(body)
     && (Reflect.has(body, Symbol.asyncIterator) || (!Array.isArray(body) && Reflect.has(body, Symbol.iterator)))) {
     body = isReadable(body) ? (isReadableStream(body) ? Readable.fromWeb(body) : body) : Readable.from(body);
-    body = encodings ? compress(body, encodings) : body;
+    body = encodings ? compress(body, encodings, options) : body;
   } else if (encodings) {
-    body = await buffer(compress(Readable.from(body), encodings));
+    body = await buffer(compress(Readable.from(body), encodings, options));
   }
 
   Object.assign(options.headers, {

package/src/utils.mjs

@@ -65,22 +65,22 @@ export const brandCheck = (value, ctor) => {
   }
 };
 
-export const compress = (readable, encodings = '') => {
+export const compress = (readable, encodings = '', { compression } = {}) => {
   const encoders = [];
 
   encodings = unwind(encodings);
 
   for (const encoding of encodings) {
     if (/\bbr\b/i.test(encoding)) {
-      encoders.push(zlib.createBrotliCompress());
+      encoders.push(zlib.createBrotliCompress(compression?.brotliOptions));
     } else if (/\bdeflate(?!-(?:\w+)?)\b/i.test(encoding)) {
-      encoders.push(zlib.createDeflate());
+      encoders.push(zlib.createDeflate(compression?.zlibOptions));
     } else if (/\bdeflate-raw\b/i.test(encoding)) {
-      encoders.push(zlib.createDeflateRaw());
+      encoders.push(zlib.createDeflateRaw(compression?.zlibOptions));
     } else if (/\bgzip\b/i.test(encoding)) {
-      encoders.push(zlib.createGzip());
+      encoders.push(zlib.createGzip(compression?.zlibOptions));
     } else if (isZstdSupported && /\bzstd\b/i.test(encoding)) {
-      encoders.push(zlib.createZstdCompress());
+      encoders.push(zlib.createZstdCompress(compression?.zstdOptions));
     } else {
       return readable;
     }
@@ -98,22 +98,22 @@ export const copyWithMerge = (target, ...rest) => {
   return merge(target, ...rest);
 };
 
-export const decompress = (readable, encodings = '') => {
+export const decompress = (readable, encodings = '', { decompression } = {}) => {
   const decoders = [];
 
   encodings = unwind(encodings);
 
   for (const encoding of encodings) {
     if (/\bbr\b/i.test(encoding)) {
-      decoders.push(zlib.createBrotliDecompress());
+      decoders.push(zlib.createBrotliDecompress(decompression?.brotliOptions));
     } else if (/\bdeflate(?!-(?:\w+)?)\b/i.test(encoding)) {
-      decoders.push(zlib.createInflate());
+      decoders.push(zlib.createInflate(decompression?.zlibOptions));
     } else if (/\bdeflate-raw\b/i.test(encoding)) {
-      decoders.push(zlib.createInflateRaw());
+      decoders.push(zlib.createInflateRaw(decompression?.zlibOptions));
     } else if (/\bgzip\b/i.test(encoding)) {
-      decoders.push(zlib.createGunzip());
+      decoders.push(zlib.createGunzip(decompression?.zlibOptions));
     } else if (isZstdSupported && /\bzstd\b/i.test(encoding)) {
-      decoders.push(zlib.createZstdDecompress());
+      decoders.push(zlib.createZstdDecompress(decompression?.zstdOptions));
     } else {
       return readable;
     }