@faasjs/request 1.3.0 → 1.3.1

package/README.md

@@ -70,7 +70,7 @@ ___
 | `passphrase?` | `string` | - |
 | `pfx?` | `Buffer` | - |
 | `query?` | \{ `[key: string]`: `any`;  } | - |
-| `timeout?` | `number` | - |
+| `timeout?` | `number` | Timeout in milliseconds, **`Default`** ```ts 5000 ``` |
 
 ___
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import * as http from 'node:http';
+import http from 'node:http';
 import { Logger } from '@faasjs/logger';
 
 type Request = {
@@ -117,6 +117,6 @@ declare class ResponseError extends Error {
  *
  * @url https://faasjs.com/doc/request.html
  */
-declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, downloadFile, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
+declare function request<T = any>(url: string, options?: RequestOptions): Promise<Response<T>>;
 
 export { type Request, type RequestOptions, type Response, ResponseError, querystringify, request, setMock };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as http from 'node:http';
+import http from 'node:http';
 import { Logger } from '@faasjs/logger';
 
 type Request = {
@@ -117,6 +117,6 @@ declare class ResponseError extends Error {
  *
  * @url https://faasjs.com/doc/request.html
  */
-declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, downloadFile, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
+declare function request<T = any>(url: string, options?: RequestOptions): Promise<Response<T>>;
 
 export { type Request, type RequestOptions, type Response, ResponseError, querystringify, request, setMock };

package/dist/index.js

@@ -9,26 +9,10 @@ var logger = require('@faasjs/logger');
 var zlib = require('zlib');
 var crypto = require('crypto');
 
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
-var http__namespace = /*#__PURE__*/_interopNamespace(http);
-var https__namespace = /*#__PURE__*/_interopNamespace(https);
+var http__default = /*#__PURE__*/_interopDefault(http);
+var https__default = /*#__PURE__*/_interopDefault(https);
 
 // src/index.ts
 var mock = null;
@@ -65,185 +49,161 @@ var ResponseError = class extends Error {
     this.body = response.body;
   }
 };
-async function request(url$1, {
-  headers,
-  method,
-  query,
-  body,
-  timeout,
-  auth,
-  file,
-  downloadStream,
-  downloadFile,
-  pfx,
-  passphrase,
-  agent,
-  parse,
-  logger: logger$1
-} = { headers: {} }) {
+async function request(url$1, options = { headers: {} }) {
   var _a;
-  if (!logger$1)
-    logger$1 = new logger.Logger("request");
+  const logger$1 = options.logger || new logger.Logger("request");
   if (mock) {
-    logger$1.debug("mock %s %j", url$1, {
-      headers,
-      method,
-      query,
-      body
-    });
-    return mock(url$1, {
-      headers,
-      method,
-      query,
-      body
-    });
+    logger$1.debug("mock %s %j", url$1, options);
+    return mock(url$1, options);
   }
-  if (query) {
+  if (options.query) {
     if (!url$1.includes("?"))
       url$1 += "?";
     else if (!url$1.endsWith("?"))
       url$1 += "&";
-    url$1 += querystringify(query);
+    url$1 += querystringify(options.query);
   }
+  if (!options.headers)
+    options.headers = {};
   const uri = new url.URL(url$1);
-  const protocol = uri.protocol === "https:" ? https__namespace : http__namespace;
+  const protocol = uri.protocol === "https:" ? https__default.default : http__default.default;
   if (!uri.protocol)
     throw Error("Unknown protocol");
-  const options = {
+  const requestOptions = {
     headers: {},
     host: uri.host ? uri.host.replace(/:[0-9]+$/, "") : uri.host,
-    method: method ? method.toUpperCase() : "GET",
+    method: options.method ? options.method.toUpperCase() : "GET",
     path: uri.pathname + uri.search,
     port: uri.port || (uri.protocol === "https:" ? "443" : "80"),
-    timeout: timeout || 5e3,
-    auth,
-    pfx,
-    passphrase,
-    agent
+    timeout: options.timeout || 5e3,
+    auth: options.auth,
+    pfx: options.pfx,
+    passphrase: options.passphrase,
+    agent: options.agent
   };
-  if (!options.headers["Accept-Encoding"] && !downloadFile && !downloadStream) {
+  if (!options.headers["Accept-Encoding"] && !options.downloadFile && !options.downloadStream)
     options.headers["Accept-Encoding"] = "br,gzip";
-  }
-  for (const key in headers)
-    if (typeof headers[key] !== "undefined" && headers[key] !== null)
-      options.headers[key] = headers[key];
+  for (const key in options.headers)
+    if (typeof options.headers[key] !== "undefined" && options.headers[key] !== null)
+      requestOptions.headers[key] = options.headers[key];
+  let body = options.body;
   if (body && typeof body !== "string")
     if ((_a = options.headers["Content-Type"]) == null ? void 0 : _a.toString().includes("application/x-www-form-urlencoded"))
       body = querystringify(body);
     else
       body = JSON.stringify(body);
   if (body && !options.headers["Content-Length"])
-    options.headers["Content-Length"] = Buffer.byteLength(body);
+    requestOptions.headers["Content-Length"] = Buffer.byteLength(body);
   const requestId = crypto.randomUUID();
   return await new Promise((resolve, reject) => {
     logger$1.debug("request %j", {
       ...options,
       body
     });
-    const req = protocol.request(options, (res) => {
-      if (downloadStream) {
-        res.pipe(downloadStream, { end: true });
-        downloadStream.on("finish", () => {
-          res.destroy();
-          downloadStream.end();
-          resolve(void 0);
-        });
-        return;
-      }
-      if (downloadFile) {
-        logger$1.debug("downloadFile");
-        const stream2 = fs.createWriteStream(downloadFile, { autoClose: true });
-        res.pipe(stream2, { end: true });
-        res.on("end", () => {
-          logger$1.debug("end");
-          res.destroy();
-        });
-        stream2.on("finish", () => {
-          stream2.end();
-          stream2.close();
-          logger$1.debug("finish");
-        });
-        stream2.on("close", () => {
-          logger$1.debug(
-            "finish",
-            res.closed,
-            res.destroyed,
-            stream2.destroyed,
-            stream2.closed,
-            req.closed,
-            req.destroyed
+    const req = protocol.request(
+      requestOptions,
+      (res) => {
+        if (options.downloadStream) {
+          options.downloadStream.on("error", (error) => {
+            logger$1.timeEnd(requestId, "response.error %j", error);
+            reject(error);
+          }).on("finish", () => {
+            logger$1.timeEnd(
+              requestId,
+              "response %s %s",
+              res.statusCode,
+              res.headers["content-type"]
+            );
+            options.downloadStream.end();
+            resolve(void 0);
+          });
+          res.pipe(options.downloadStream, { end: true });
+          return;
+        }
+        if (options.downloadFile) {
+          const stream2 = fs.createWriteStream(options.downloadFile).on("error", (error) => {
+            logger$1.timeEnd(requestId, "response.error %j", error);
+            stream2.destroy();
+            reject(error);
+          }).on("finish", () => {
+            logger$1.timeEnd(
+              requestId,
+              "response %s %s %s",
+              res.statusCode,
+              res.headers["content-type"],
+              stream2.bytesWritten
+            );
+            resolve(void 0);
+          });
+          res.pipe(stream2, { end: true });
+          return;
+        }
+        let stream = res;
+        switch (res.headers["content-encoding"]) {
+          case "br":
+            stream = res.pipe(zlib.createBrotliDecompress());
+            break;
+          case "gzip":
+            stream = res.pipe(zlib.createGunzip());
+            break;
+        }
+        const raw = [];
+        stream.on("error", (e) => {
+          logger$1.timeEnd(requestId, "response.error %j", e);
+          reject(e);
+        }).on("end", () => {
+          const data = Buffer.concat(raw).toString();
+          logger$1.timeEnd(
+            requestId,
+            "response %s %s %s %j",
+            res.statusCode,
+            res.headers["content-type"],
+            res.headers["content-encoding"],
+            data
           );
-          resolve(void 0);
-        });
-        return;
-      }
-      let stream = res;
-      switch (res.headers["content-encoding"]) {
-        case "br":
-          stream = res.pipe(zlib.createBrotliDecompress());
-          break;
-        case "gzip":
-          stream = res.pipe(zlib.createGunzip());
-          break;
-      }
-      const raw = [];
-      stream.on("data", (chunk) => raw.push(chunk));
-      stream.on("end", () => {
-        const data = Buffer.concat(raw).toString();
-        logger$1.timeEnd(
-          requestId,
-          "response %s %s %s %j",
-          res.statusCode,
-          res.headers["content-type"],
-          res.headers["content-encoding"],
-          data
-        );
-        const response = /* @__PURE__ */ Object.create(null);
-        response.request = options;
-        response.request.body = body;
-        response.statusCode = res.statusCode;
-        response.statusMessage = res.statusMessage;
-        response.headers = res.headers;
-        response.body = data;
-        if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
-          try {
-            response.body = (parse || JSON.parse)(response.body);
-            logger$1.debug("response.parse JSON");
-          } catch (error) {
-            logger$1.warn("response plain body", response.body);
-            logger$1.error(error);
+          const response = /* @__PURE__ */ Object.create(null);
+          response.request = requestOptions;
+          response.request.body = body;
+          response.statusCode = res.statusCode;
+          response.statusMessage = res.statusMessage;
+          response.headers = res.headers;
+          response.body = data;
+          if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
+            try {
+              response.body = (options.parse || JSON.parse)(response.body);
+              logger$1.debug("response.parse JSON");
+            } catch (error) {
+              logger$1.warn("response plain body", response.body);
+              logger$1.error(error);
+            }
+          if (response.statusCode >= 200 && response.statusCode < 400)
+            resolve(response);
+          else {
+            logger$1.debug("response.error %j", response);
+            reject(
+              new ResponseError(
+                `${res.statusMessage || res.statusCode} ${requestOptions.host}${requestOptions.path}`,
+                response
+              )
+            );
           }
-        if (response.statusCode >= 200 && response.statusCode < 400)
-          resolve(response);
-        else {
-          logger$1.debug("response.error %j", response);
-          reject(
-            new ResponseError(
-              `${res.statusMessage || res.statusCode} ${options.host}${options.path}`,
-              response
-            )
-          );
-        }
-      });
-      stream.on("error", (e) => {
-        logger$1.timeEnd(requestId, "response.error %j", e);
-        reject(e);
-      });
-    });
+        }).on("data", (chunk) => raw.push(chunk));
+      }
+    );
     if (body)
       req.write(body);
-    if (file) {
+    if (options.file) {
       const crlf = "\r\n";
       const boundary = `--${Math.random().toString(16)}`;
       const delimiter = `${crlf}--${boundary}`;
-      const headers2 = [
+      const headers = [
         `Content-Disposition: form-data; name="file"; filename="${path.basename(
-          file
+          options.file
         )}"${crlf}`
       ];
       const multipartBody = Buffer.concat([
-        Buffer.from(delimiter + crlf + headers2.join("") + crlf),
-        fs.readFileSync(file),
+        Buffer.from(delimiter + crlf + headers.join("") + crlf),
+        fs.readFileSync(options.file),
         Buffer.from(`${delimiter}--`)
       ]);
       req.setHeader("Content-Type", `multipart/form-data; boundary=${boundary}`);

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
+import http from 'node:http';
+import https from 'node:https';
 import { URL } from 'node:url';
 import { createWriteStream, readFileSync } from 'node:fs';
 import { basename } from 'node:path';
@@ -42,185 +42,161 @@ var ResponseError = class extends Error {
     this.body = response.body;
   }
 };
-async function request(url, {
-  headers,
-  method,
-  query,
-  body,
-  timeout,
-  auth,
-  file,
-  downloadStream,
-  downloadFile,
-  pfx,
-  passphrase,
-  agent,
-  parse,
-  logger
-} = { headers: {} }) {
+async function request(url, options = { headers: {} }) {
   var _a;
-  if (!logger)
-    logger = new Logger("request");
+  const logger = options.logger || new Logger("request");
   if (mock) {
-    logger.debug("mock %s %j", url, {
-      headers,
-      method,
-      query,
-      body
-    });
-    return mock(url, {
-      headers,
-      method,
-      query,
-      body
-    });
+    logger.debug("mock %s %j", url, options);
+    return mock(url, options);
   }
-  if (query) {
+  if (options.query) {
     if (!url.includes("?"))
       url += "?";
     else if (!url.endsWith("?"))
       url += "&";
-    url += querystringify(query);
+    url += querystringify(options.query);
   }
+  if (!options.headers)
+    options.headers = {};
   const uri = new URL(url);
   const protocol = uri.protocol === "https:" ? https : http;
   if (!uri.protocol)
     throw Error("Unknown protocol");
-  const options = {
+  const requestOptions = {
     headers: {},
     host: uri.host ? uri.host.replace(/:[0-9]+$/, "") : uri.host,
-    method: method ? method.toUpperCase() : "GET",
+    method: options.method ? options.method.toUpperCase() : "GET",
     path: uri.pathname + uri.search,
     port: uri.port || (uri.protocol === "https:" ? "443" : "80"),
-    timeout: timeout || 5e3,
-    auth,
-    pfx,
-    passphrase,
-    agent
+    timeout: options.timeout || 5e3,
+    auth: options.auth,
+    pfx: options.pfx,
+    passphrase: options.passphrase,
+    agent: options.agent
   };
-  if (!options.headers["Accept-Encoding"] && !downloadFile && !downloadStream) {
+  if (!options.headers["Accept-Encoding"] && !options.downloadFile && !options.downloadStream)
     options.headers["Accept-Encoding"] = "br,gzip";
-  }
-  for (const key in headers)
-    if (typeof headers[key] !== "undefined" && headers[key] !== null)
-      options.headers[key] = headers[key];
+  for (const key in options.headers)
+    if (typeof options.headers[key] !== "undefined" && options.headers[key] !== null)
+      requestOptions.headers[key] = options.headers[key];
+  let body = options.body;
   if (body && typeof body !== "string")
     if ((_a = options.headers["Content-Type"]) == null ? void 0 : _a.toString().includes("application/x-www-form-urlencoded"))
       body = querystringify(body);
     else
       body = JSON.stringify(body);
   if (body && !options.headers["Content-Length"])
-    options.headers["Content-Length"] = Buffer.byteLength(body);
+    requestOptions.headers["Content-Length"] = Buffer.byteLength(body);
   const requestId = randomUUID();
   return await new Promise((resolve, reject) => {
     logger.debug("request %j", {
       ...options,
       body
     });
-    const req = protocol.request(options, (res) => {
-      if (downloadStream) {
-        res.pipe(downloadStream, { end: true });
-        downloadStream.on("finish", () => {
-          res.destroy();
-          downloadStream.end();
-          resolve(void 0);
-        });
-        return;
-      }
-      if (downloadFile) {
-        logger.debug("downloadFile");
-        const stream2 = createWriteStream(downloadFile, { autoClose: true });
-        res.pipe(stream2, { end: true });
-        res.on("end", () => {
-          logger.debug("end");
-          res.destroy();
-        });
-        stream2.on("finish", () => {
-          stream2.end();
-          stream2.close();
-          logger.debug("finish");
-        });
-        stream2.on("close", () => {
-          logger.debug(
-            "finish",
-            res.closed,
-            res.destroyed,
-            stream2.destroyed,
-            stream2.closed,
-            req.closed,
-            req.destroyed
+    const req = protocol.request(
+      requestOptions,
+      (res) => {
+        if (options.downloadStream) {
+          options.downloadStream.on("error", (error) => {
+            logger.timeEnd(requestId, "response.error %j", error);
+            reject(error);
+          }).on("finish", () => {
+            logger.timeEnd(
+              requestId,
+              "response %s %s",
+              res.statusCode,
+              res.headers["content-type"]
+            );
+            options.downloadStream.end();
+            resolve(void 0);
+          });
+          res.pipe(options.downloadStream, { end: true });
+          return;
+        }
+        if (options.downloadFile) {
+          const stream2 = createWriteStream(options.downloadFile).on("error", (error) => {
+            logger.timeEnd(requestId, "response.error %j", error);
+            stream2.destroy();
+            reject(error);
+          }).on("finish", () => {
+            logger.timeEnd(
+              requestId,
+              "response %s %s %s",
+              res.statusCode,
+              res.headers["content-type"],
+              stream2.bytesWritten
+            );
+            resolve(void 0);
+          });
+          res.pipe(stream2, { end: true });
+          return;
+        }
+        let stream = res;
+        switch (res.headers["content-encoding"]) {
+          case "br":
+            stream = res.pipe(createBrotliDecompress());
+            break;
+          case "gzip":
+            stream = res.pipe(createGunzip());
+            break;
+        }
+        const raw = [];
+        stream.on("error", (e) => {
+          logger.timeEnd(requestId, "response.error %j", e);
+          reject(e);
+        }).on("end", () => {
+          const data = Buffer.concat(raw).toString();
+          logger.timeEnd(
+            requestId,
+            "response %s %s %s %j",
+            res.statusCode,
+            res.headers["content-type"],
+            res.headers["content-encoding"],
+            data
           );
-          resolve(void 0);
-        });
-        return;
-      }
-      let stream = res;
-      switch (res.headers["content-encoding"]) {
-        case "br":
-          stream = res.pipe(createBrotliDecompress());
-          break;
-        case "gzip":
-          stream = res.pipe(createGunzip());
-          break;
-      }
-      const raw = [];
-      stream.on("data", (chunk) => raw.push(chunk));
-      stream.on("end", () => {
-        const data = Buffer.concat(raw).toString();
-        logger.timeEnd(
-          requestId,
-          "response %s %s %s %j",
-          res.statusCode,
-          res.headers["content-type"],
-          res.headers["content-encoding"],
-          data
-        );
-        const response = /* @__PURE__ */ Object.create(null);
-        response.request = options;
-        response.request.body = body;
-        response.statusCode = res.statusCode;
-        response.statusMessage = res.statusMessage;
-        response.headers = res.headers;
-        response.body = data;
-        if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
-          try {
-            response.body = (parse || JSON.parse)(response.body);
-            logger.debug("response.parse JSON");
-          } catch (error) {
-            logger.warn("response plain body", response.body);
-            logger.error(error);
+          const response = /* @__PURE__ */ Object.create(null);
+          response.request = requestOptions;
+          response.request.body = body;
+          response.statusCode = res.statusCode;
+          response.statusMessage = res.statusMessage;
+          response.headers = res.headers;
+          response.body = data;
+          if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
+            try {
+              response.body = (options.parse || JSON.parse)(response.body);
+              logger.debug("response.parse JSON");
+            } catch (error) {
+              logger.warn("response plain body", response.body);
+              logger.error(error);
+            }
+          if (response.statusCode >= 200 && response.statusCode < 400)
+            resolve(response);
+          else {
+            logger.debug("response.error %j", response);
+            reject(
+              new ResponseError(
+                `${res.statusMessage || res.statusCode} ${requestOptions.host}${requestOptions.path}`,
+                response
+              )
+            );
           }
-        if (response.statusCode >= 200 && response.statusCode < 400)
-          resolve(response);
-        else {
-          logger.debug("response.error %j", response);
-          reject(
-            new ResponseError(
-              `${res.statusMessage || res.statusCode} ${options.host}${options.path}`,
-              response
-            )
-          );
-        }
-      });
-      stream.on("error", (e) => {
-        logger.timeEnd(requestId, "response.error %j", e);
-        reject(e);
-      });
-    });
+        }).on("data", (chunk) => raw.push(chunk));
+      }
+    );
     if (body)
       req.write(body);
-    if (file) {
+    if (options.file) {
       const crlf = "\r\n";
       const boundary = `--${Math.random().toString(16)}`;
       const delimiter = `${crlf}--${boundary}`;
-      const headers2 = [
+      const headers = [
         `Content-Disposition: form-data; name="file"; filename="${basename(
-          file
+          options.file
         )}"${crlf}`
       ];
       const multipartBody = Buffer.concat([
-        Buffer.from(delimiter + crlf + headers2.join("") + crlf),
-        readFileSync(file),
+        Buffer.from(delimiter + crlf + headers.join("") + crlf),
+        readFileSync(options.file),
         Buffer.from(`${delimiter}--`)
       ]);
       req.setHeader("Content-Type", `multipart/form-data; boundary=${boundary}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,10 +21,10 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/logger": "1.3.0"
+    "@faasjs/logger": "1.3.1"
   },
   "devDependencies": {
-    "@faasjs/logger": "1.3.0"
+    "@faasjs/logger": "1.3.1"
   },
   "engines": {
     "npm": ">=9.0.0",