rekwest 3.3.4 → 4.1.0

package/dist/utils.js

@@ -1,32 +1,22 @@
 "use strict";
 
 exports.__esModule = true;
-exports.revise = exports.redirects = exports.preflight = exports.mixin = exports.merge = exports.dispatch = exports.decompress = exports.compress = exports.collate = exports.affix = exports.admix = void 0;
+exports.sanitize = exports.sameOrigin = exports.preflight = exports.mixin = exports.merge = exports.dispatch = exports.decompress = exports.compress = exports.brandCheck = exports.affix = exports.admix = void 0;
 exports.tap = tap;
 exports.transform = void 0;
-
 var _nodeBuffer = require("node:buffer");
-
 var _nodeHttp = _interopRequireDefault(require("node:http2"));
-
 var _nodeStream = require("node:stream");
-
+var _consumers = require("node:stream/consumers");
 var _nodeUtil = require("node:util");
-
 var _nodeZlib = _interopRequireDefault(require("node:zlib"));
-
-var _cookies = require("./cookies.js");
-
-var _errors = require("./errors.js");
-
-var _file = require("./file.js");
-
-var _formdata = require("./formdata.js");
-
-var _mediatypes = require("./mediatypes.js");
-
+var _constants = require("./constants");
+var _cookies = require("./cookies");
+var _errors = require("./errors");
+var _file = require("./file");
+var _formdata = require("./formdata");
+var _mediatypes = require("./mediatypes");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const {
   HTTP2_HEADER_ACCEPT,
   HTTP2_HEADER_ACCEPT_ENCODING,
@@ -42,18 +32,11 @@ const {
   HTTP2_METHOD_GET,
   HTTP2_METHOD_HEAD
 } = _nodeHttp.default.constants;
-const brotliCompress = (0, _nodeUtil.promisify)(_nodeZlib.default.brotliCompress);
-const brotliDecompress = (0, _nodeUtil.promisify)(_nodeZlib.default.brotliDecompress);
-const gzip = (0, _nodeUtil.promisify)(_nodeZlib.default.gzip);
-const gunzip = (0, _nodeUtil.promisify)(_nodeZlib.default.gunzip);
-const deflate = (0, _nodeUtil.promisify)(_nodeZlib.default.deflate);
-const inflate = (0, _nodeUtil.promisify)(_nodeZlib.default.inflate);
-
+const unwind = encodings => encodings.split(',').map(it => it.trim());
 const admix = (res, headers, options) => {
   const {
     h2
   } = options;
-
   if (h2) {
     Reflect.defineProperty(res, 'headers', {
       enumerable: true,
@@ -68,7 +51,6 @@ const admix = (res, headers, options) => {
       value: headers[HTTP2_HEADER_STATUS]
     });
   }
-
   Reflect.defineProperty(res, 'ok', {
     enumerable: true,
     value: /^2\d{2}$/.test(res.statusCode)
@@ -78,9 +60,7 @@ const admix = (res, headers, options) => {
     value: !!options.redirected
   });
 };
-
 exports.admix = admix;
-
 const affix = (client, req, options) => {
   req.once('end', () => client?.close());
   req.once('timeout', () => req.destroy(new _errors.TimeoutError(`Timed out after ${options.timeout} ms.`)));
@@ -91,74 +71,66 @@ const affix = (client, req, options) => {
     });
   });
 };
-
 exports.affix = affix;
-
-const collate = (entity, primordial) => {
-  if (entity?.constructor !== primordial) {
+const brandCheck = (value, ctor) => {
+  if (!(value instanceof ctor)) {
     throw new TypeError('Illegal invocation');
   }
 };
-
-exports.collate = collate;
-
-const compress = (buf, encoding, {
-  async = false
-} = {}) => {
-  encoding &&= encoding.match(/(?<encoding>\bbr\b|\bdeflate\b|\bgzip\b)/i)?.groups.encoding.toLowerCase();
-  const compressor = {
-    br: async ? brotliCompress : _nodeZlib.default.brotliCompressSync,
-    deflate: async ? deflate : _nodeZlib.default.deflateSync,
-    gzip: async ? gzip : _nodeZlib.default.gzipSync
-  }[encoding];
-  return compressor?.(buf) ?? (async ? Promise.resolve(buf) : buf);
+exports.brandCheck = brandCheck;
+const compress = (readable, encodings = '') => {
+  const encoders = [];
+  encodings = unwind(encodings);
+  for (const encoding of encodings) {
+    if (/\bbr\b/i.test(encoding)) {
+      encoders.push(_nodeZlib.default.createBrotliCompress());
+    } else if (/\bdeflate(?!-(?:\w+)?)\b/i.test(encoding)) {
+      encoders.push(_nodeZlib.default.createDeflate());
+    } else if (/\bdeflate-raw\b/i.test(encoding)) {
+      encoders.push(_nodeZlib.default.createDeflateRaw());
+    } else if (/\bgzip\b/i.test(encoding)) {
+      encoders.push(_nodeZlib.default.createGzip());
+    } else {
+      return readable;
+    }
+  }
+  return (0, _nodeStream.pipeline)(readable, ...encoders, () => void 0);
 };
-
 exports.compress = compress;
-
-const decompress = (buf, encoding, {
-  async = false
-} = {}) => {
-  encoding &&= encoding.match(/(?<encoding>\bbr\b|\bdeflate\b|\bgzip\b)/i)?.groups.encoding.toLowerCase();
-  const decompressor = {
-    br: async ? brotliDecompress : _nodeZlib.default.brotliDecompressSync,
-    deflate: async ? inflate : _nodeZlib.default.inflateSync,
-    gzip: async ? gunzip : _nodeZlib.default.gunzipSync
-  }[encoding];
-  return decompressor?.(buf) ?? (async ? Promise.resolve(buf) : buf);
+const decompress = (readable, encodings = '') => {
+  const decoders = [];
+  encodings = unwind(encodings);
+  for (const encoding of encodings) {
+    if (/\bbr\b/i.test(encoding)) {
+      decoders.push(_nodeZlib.default.createBrotliDecompress());
+    } else if (/\bdeflate(?!-(?:\w+)?)\b/i.test(encoding)) {
+      decoders.push(_nodeZlib.default.createInflate());
+    } else if (/\bdeflate-raw\b/i.test(encoding)) {
+      decoders.push(_nodeZlib.default.createInflateRaw());
+    } else if (/\bgzip\b/i.test(encoding)) {
+      decoders.push(_nodeZlib.default.createGunzip());
+    } else {
+      return readable;
+    }
+  }
+  return (0, _nodeStream.pipeline)(readable, ...decoders, () => void 0);
 };
-
 exports.decompress = decompress;
-
-const dispatch = (req, {
-  body,
-  headers
-}) => {
-  if (body === Object(body) && !Buffer.isBuffer(body)) {
-    if (body.pipe?.constructor !== Function && (Reflect.has(body, Symbol.asyncIterator) || Reflect.has(body, Symbol.iterator))) {
-      body = _nodeStream.Readable.from(body);
-    }
-
-    const compressor = {
-      br: _nodeZlib.default.createBrotliCompress,
-      deflate: _nodeZlib.default.createDeflate,
-      gzip: _nodeZlib.default.createGzip
-    }[headers[HTTP2_HEADER_CONTENT_ENCODING]] ?? _nodeStream.PassThrough;
-    body.pipe(compressor()).pipe(req);
+const dispatch = ({
+  body
+}, req) => {
+  if (body?.pipe?.constructor === Function) {
+    body.pipe(req);
   } else {
     req.end(body);
   }
 };
-
 exports.dispatch = dispatch;
-
 const merge = (target = {}, ...rest) => {
   target = JSON.parse(JSON.stringify(target));
-
   if (!rest.length) {
     return target;
   }
-
   rest.filter(it => it === Object(it)).forEach(it => {
     Object.entries(it).reduce((acc, [key, val]) => {
       if ([acc[key]?.constructor, val?.constructor].every(it => [Array, Object].includes(it))) {
@@ -170,15 +142,12 @@ const merge = (target = {}, ...rest) => {
       } else {
         acc[key] = val;
       }
-
       return acc;
     }, target);
   });
   return target;
 };
-
 exports.merge = merge;
-
 const mixin = (res, {
   digest = false,
   parse = false
@@ -188,7 +157,7 @@ const mixin = (res, {
       arrayBuffer: {
         enumerable: true,
         value: async function () {
-          collate(this, res?.constructor);
+          brandCheck(this, res?.constructor);
           parse &&= false;
           const {
             buffer,
@@ -201,7 +170,7 @@ const mixin = (res, {
       blob: {
         enumerable: true,
         value: async function () {
-          collate(this, res?.constructor);
+          brandCheck(this, res?.constructor);
           const val = await this.arrayBuffer();
           return new _nodeBuffer.Blob([val]);
         }
@@ -209,7 +178,7 @@ const mixin = (res, {
       json: {
         enumerable: true,
         value: async function () {
-          collate(this, res?.constructor);
+          brandCheck(this, res?.constructor);
           const val = await this.text();
           return JSON.parse(val);
         }
@@ -217,70 +186,55 @@ const mixin = (res, {
       text: {
         enumerable: true,
         value: async function () {
-          collate(this, res?.constructor);
+          brandCheck(this, res?.constructor);
           const blob = await this.blob();
           return blob.text();
         }
       }
     });
   }
-
   return Object.defineProperties(res, {
     body: {
       enumerable: true,
       value: async function () {
-        collate(this, res?.constructor);
-
+        brandCheck(this, res?.constructor);
         if (this.bodyUsed) {
           throw new TypeError('Response stream already read');
         }
-
-        let spool = [];
-
-        for await (const chunk of this) {
-          spool.push(chunk);
+        let body = [];
+        for await (const chunk of decompress(this, this.headers[HTTP2_HEADER_CONTENT_ENCODING])) {
+          body.push(chunk);
         }
-
-        spool = Buffer.concat(spool);
-
-        if (spool.length) {
-          spool = await decompress(spool, this.headers[HTTP2_HEADER_CONTENT_ENCODING], {
-            async: true
-          });
+        body = Buffer.concat(body);
+        if (!body.length && parse) {
+          return null;
         }
-
-        if (spool.length && parse) {
+        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)) {
-            spool = JSON.parse(spool.toString(charset));
-          } else if (/\b(text|xml)\b/i.test(contentType)) {
-            if (/\b(latin1|ucs-2|utf-(8|16le))\b/.test(charset)) {
-              spool = spool.toString(charset);
+            body = JSON.parse(body.toString(charset));
+          } else if (/\b(?:text|xml)\b/i.test(contentType)) {
+            if (/\b(?:latin1|ucs-2|utf-(?:8|16le))\b/.test(charset)) {
+              body = body.toString(charset);
             } else {
-              spool = new TextDecoder(charset).decode(spool);
+              body = new TextDecoder(charset).decode(body);
             }
           }
         }
-
-        return spool;
+        return body;
       },
       writable: true
     },
     bodyUsed: {
       enumerable: true,
-
       get() {
         return this.readableEnded;
       }
-
     }
   });
 };
-
 exports.mixin = mixin;
-
 const preflight = options => {
   const {
     cookies,
@@ -290,14 +244,11 @@ const preflight = options => {
     redirected,
     url
   } = options;
-
   if (h2) {
     options.endStream = [HTTP2_METHOD_GET, HTTP2_METHOD_HEAD].includes(method);
   }
-
   if (cookies !== false) {
     let cookie = _cookies.Cookies.jar.get(url.origin);
-
     if (cookies === Object(cookies) && !redirected) {
       if (cookie) {
         new _cookies.Cookies(cookies).forEach(function (val, key) {
@@ -305,24 +256,22 @@ const preflight = options => {
         }, cookie);
       } else {
         cookie = new _cookies.Cookies(cookies);
-
         _cookies.Cookies.jar.set(url.origin, cookie);
       }
     }
-
-    options.headers = { ...(cookie && {
+    options.headers = {
+      ...(cookie && {
         [HTTP2_HEADER_COOKIE]: cookie
       }),
       ...headers
     };
   }
-
   options.digest ??= true;
   options.follow ??= 20;
   options.h2 ??= h2;
   options.headers = {
     [HTTP2_HEADER_ACCEPT]: `${_mediatypes.APPLICATION_JSON}, ${_mediatypes.TEXT_PLAIN}, ${_mediatypes.WILDCARD}`,
-    [HTTP2_HEADER_ACCEPT_ENCODING]: 'br, deflate, gzip, identity',
+    [HTTP2_HEADER_ACCEPT_ENCODING]: 'br, deflate, deflate-raw, gzip, identity',
     ...Object.entries(options.headers ?? {}).reduce((acc, [key, val]) => (acc[key.toLowerCase()] = val, acc), {}),
     ...(h2 && {
       [HTTP2_HEADER_AUTHORITY]: url.host,
@@ -333,42 +282,28 @@ const preflight = options => {
   };
   options.method ??= method;
   options.parse ??= true;
-  options.redirect ??= redirects.follow;
-
-  if (!Object.values(redirects).includes(options.redirect)) {
+  options.redirect ??= _constants.redirectModes.follow;
+  if (!Reflect.has(_constants.redirectModes, 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;
 };
-
 exports.preflight = preflight;
-const redirects = {
-  error: 'error',
-  follow: 'follow',
-  manual: 'manual'
-};
-exports.redirects = redirects;
-
-const revise = ({
-  url,
-  options
-}) => {
+const sanitize = (url, options = {}) => {
   if (options.trimTrailingSlashes) {
     url = `${url}`.replace(/(?<!:)\/+/gi, '/');
   }
-
   url = new URL(url);
   return Object.assign(options, {
     url
   });
 };
-
-exports.revise = revise;
-
+exports.sanitize = sanitize;
+const sameOrigin = (a, b) => a.protocol === b.protocol && a.hostname === b.hostname && a.port === b.port;
+exports.sameOrigin = sameOrigin;
 async function* tap(value) {
   if (Reflect.has(value, Symbol.asyncIterator)) {
     yield* value;
@@ -378,57 +313,62 @@ async function* tap(value) {
     yield await value.arrayBuffer();
   }
 }
-
-const transform = (body, options) => {
-  let headers = {};
-
-  if (_nodeUtil.types.isAnyArrayBuffer(body) && !Buffer.isBuffer(body)) {
-    body = Buffer.from(body);
-  } else if (_nodeUtil.types.isArrayBufferView(body) && !Buffer.isBuffer(body)) {
-    body = Buffer.from(body.buffer, body.byteOffset, body.byteLength);
+const transform = async options => {
+  let {
+    body,
+    headers
+  } = options;
+  if (!body) {
+    return options;
   }
-
   if (_file.File.alike(body)) {
     headers = {
       [HTTP2_HEADER_CONTENT_LENGTH]: body.size,
       [HTTP2_HEADER_CONTENT_TYPE]: body.type || _mediatypes.APPLICATION_OCTET_STREAM
     };
-    body = body.stream?.() ?? _nodeStream.Readable.from(tap(body));
+    body = body.stream();
   } else if (_formdata.FormData.alike(body)) {
     body = _formdata.FormData.actuate(body);
     headers = {
       [HTTP2_HEADER_CONTENT_TYPE]: body.contentType
     };
-  } else if (body === Object(body) && !Reflect.has(body, Symbol.asyncIterator)) {
-    if (body.constructor === URLSearchParams) {
-      headers = {
-        [HTTP2_HEADER_CONTENT_TYPE]: _mediatypes.APPLICATION_FORM_URLENCODED
-      };
-      body = body.toString();
-    } else if (!Buffer.isBuffer(body) && !(!Array.isArray(body) && Reflect.has(body, Symbol.iterator))) {
-      headers = {
-        [HTTP2_HEADER_CONTENT_TYPE]: _mediatypes.APPLICATION_JSON
-      };
-      body = JSON.stringify(body);
-    }
-
-    if (Buffer.isBuffer(body) || body !== Object(body)) {
-      if (options.headers[HTTP2_HEADER_CONTENT_ENCODING]) {
-        body = compress(body, options.headers[HTTP2_HEADER_CONTENT_ENCODING]);
+  } else if (!Buffer.isBuffer(body)) {
+    if (_nodeUtil.types.isAnyArrayBuffer(body)) {
+      body = Buffer.from(body);
+    } else if (_nodeUtil.types.isArrayBufferView(body)) {
+      body = Buffer.from(body.buffer, body.byteOffset, body.byteLength);
+    } else if (body === Object(body) && !Reflect.has(body, Symbol.asyncIterator)) {
+      if (body.constructor === URLSearchParams) {
+        headers = {
+          [HTTP2_HEADER_CONTENT_TYPE]: _mediatypes.APPLICATION_FORM_URLENCODED
+        };
+        body = body.toString();
+      } else if (!(!Array.isArray(body) && Reflect.has(body, Symbol.iterator))) {
+        headers = {
+          [HTTP2_HEADER_CONTENT_TYPE]: _mediatypes.APPLICATION_JSON
+        };
+        body = JSON.stringify(body);
       }
-
-      headers = { ...headers,
-        [HTTP2_HEADER_CONTENT_LENGTH]: Buffer.byteLength(body)
-      };
     }
   }
-
-  Object.assign(options.headers, { ...headers,
+  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 = encodings ? compress(_nodeStream.Readable.from(body), encodings) : _nodeStream.Readable.from(body);
+  } else if (encodings) {
+    body = await (0, _consumers.buffer)(compress(_nodeStream.Readable.from(body), encodings));
+  }
+  Object.assign(options.headers, {
+    ...headers,
+    ...(!body[Symbol.asyncIterator] && {
+      [HTTP2_HEADER_CONTENT_LENGTH]: Buffer.byteLength(body)
+    }),
     ...(options.headers[HTTP2_HEADER_CONTENT_TYPE] && {
       [HTTP2_HEADER_CONTENT_TYPE]: options.headers[HTTP2_HEADER_CONTENT_TYPE]
     })
   });
-  return body;
+  return {
+    ...options,
+    body
+  };
 };
-
 exports.transform = transform;

package/package.json

@@ -8,18 +8,18 @@
     "url": "https://github.com/bricss/rekwest/issues"
   },
   "devDependencies": {
-    "@babel/cli": "^7.18.10",
-    "@babel/core": "^7.19.1",
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.20.5",
     "@babel/eslint-parser": "^7.19.1",
-    "@babel/preset-env": "^7.19.1",
+    "@babel/preset-env": "^7.20.2",
     "c8": "^7.12.0",
-    "eslint": "^8.24.0",
-    "eslint-config-ultra-refined": "^2.6.0",
-    "mocha": "^10.0.0"
+    "eslint": "^8.28.0",
+    "eslint-config-ultra-refined": "^2.10.0",
+    "mocha": "^10.1.0"
   },
   "description": "The robust request library that humanity deserves 🌐",
   "engines": {
-    "node": ">=16.5.x"
+    "node": ">=16.7.x"
   },
   "exports": {
     "import": "./src/index.mjs",
@@ -32,11 +32,12 @@
   "homepage": "https://github.com/bricss/rekwest#readme",
   "keywords": [
     "backoff",
-    "compression",
+    "brotli",
     "cookie",
+    "deflate",
     "fetch",
-    "fetch-alike",
     "formdata",
+    "gzip",
     "http",
     "https",
     "h2",
@@ -46,10 +47,10 @@
     "request",
     "redirect",
     "retry",
-    "retry-after"
+    "retry-after",
+    "stream"
   ],
   "license": "MIT",
-  "main": "./dist/index.js",
   "name": "rekwest",
   "repository": {
     "type": "git",
@@ -66,5 +67,5 @@
     "test:bail": "mocha --bail",
     "test:cover": "c8 --include=src --reporter=lcov --reporter=text npm test"
   },
-  "version": "3.3.4"
+  "version": "4.1.0"
 }

package/src/constants.mjs

@@ -0,0 +1,23 @@
+import http2 from 'node:http2';
+
+const {
+  HTTP_STATUS_FOUND,
+  HTTP_STATUS_MOVED_PERMANENTLY,
+  HTTP_STATUS_PERMANENT_REDIRECT,
+  HTTP_STATUS_SEE_OTHER,
+  HTTP_STATUS_TEMPORARY_REDIRECT,
+} = http2.constants;
+
+export const redirectModes = {
+  error: 'error',
+  follow: 'follow',
+  manual: 'manual',
+};
+
+export const redirectStatusCodes = [
+  HTTP_STATUS_MOVED_PERMANENTLY,
+  HTTP_STATUS_FOUND,
+  HTTP_STATUS_SEE_OTHER,
+  HTTP_STATUS_TEMPORARY_REDIRECT,
+  HTTP_STATUS_PERMANENT_REDIRECT,
+];

package/src/cookies.mjs

@@ -1,28 +1,28 @@
-import { collate } from './utils.mjs';
-
-export class Cookies extends URLSearchParams {
-
-  static jar = new Map();
-
-  get [Symbol.toStringTag]() {
-    return this.constructor.name;
-  }
-
-  constructor(input) {
-    if (Array.isArray(input) && input.every((it) => !Array.isArray(it))) {
-      input = input.join(';').split(';')
-                   .filter((it) => !/\b(Domain|Expires|HttpOnly|Max-Age|Path|SameParty|SameSite|Secure)\b/i.test(it))
-                   .map((it) => it.trim())
-                   .join('&');
-    }
-
-    super(input);
-  }
-
-  toString() {
-    collate(this, Cookies);
-
-    return super.toString().split('&').join('; ').trim();
-  }
-
-}
+import { brandCheck } from './utils.mjs';
+
+export class Cookies extends URLSearchParams {
+
+  static jar = new Map();
+
+  get [Symbol.toStringTag]() {
+    return this.constructor.name;
+  }
+
+  constructor(input) {
+    if (Array.isArray(input) && input.every((it) => !Array.isArray(it))) {
+      input = input.join(';').split(';')
+                   .filter((it) => !/\b(?:Domain|Expires|HttpOnly|Max-Age|Path|SameParty|SameSite|Secure)\b/i.test(it))
+                   .map((it) => it.trim())
+                   .join('&');
+    }
+
+    super(input);
+  }
+
+  toString() {
+    brandCheck(this, Cookies);
+
+    return super.toString().split('&').join('; ').trim();
+  }
+
+}