@faasjs/request 0.0.3-beta.9 → 0.0.3-beta.91

package/README.md

@@ -52,10 +52,10 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `agent?` | `boolean` | - |
-| `auth?` | `string` | The authentication credentials to use for the request.  Format: `username:password` |
+| `auth?` | `string` | The authentication credentials to use for the request. Format: `username:password` |
 | `body?` | { `[key: string]`: `any`;  } \| `string` | - |
-| `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. |
-| `file?` | `string` | Path of uploading a file to the server. |
+| `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. ```ts const stream = createWriteStream('filepath') await request('https://example.com', { downloadStream: stream }) ``` |
+| `file?` | `string` | Path of uploading a file to the server. ```ts await request('https://example.com', { file: 'filepath' }) ``` |
 | `headers?` | `http.OutgoingHttpHeaders` | - |
 | `logger?` | `Logger` | - |
 | `method?` | `string` | The HTTP method to use when making the request. Defaults to GET. |

package/dist/index.d.mts

@@ -0,0 +1,96 @@
+import * as http from 'http';
+import { Logger } from '@faasjs/logger';
+
+type Request = {
+    headers?: http.OutgoingHttpHeaders;
+    method?: string;
+    host?: string;
+    path?: string;
+    query?: http.OutgoingHttpHeaders;
+    body?: {
+        [key: string]: any;
+    };
+};
+type Response<T = any> = {
+    request?: Request;
+    statusCode?: number;
+    statusMessage?: string;
+    headers: http.OutgoingHttpHeaders;
+    body: T;
+};
+type RequestOptions = {
+    headers?: http.OutgoingHttpHeaders;
+    /**
+     * The HTTP method to use when making the request. Defaults to GET.
+     */
+    method?: string;
+    query?: {
+        [key: string]: any;
+    };
+    body?: {
+        [key: string]: any;
+    } | string;
+    timeout?: number;
+    /**
+     * The authentication credentials to use for the request.
+     *
+     * Format: `username:password`
+     */
+    auth?: string;
+    /**
+     * Path of uploading a file to the server.
+     *
+     * ```ts
+     * await request('https://example.com', { file: 'filepath' })
+     * ```
+     */
+    file?: string;
+    /**
+     * Create a write stream to download a file.
+     *
+     * ```ts
+     * const stream = createWriteStream('filepath')
+     * await request('https://example.com', { downloadStream: stream })
+     * ```
+     */
+    downloadStream?: NodeJS.WritableStream;
+    pfx?: Buffer;
+    passphrase?: string;
+    agent?: boolean;
+    /**
+     * Body parser. Defaults to `JSON.parse`.
+     */
+    parse?: (body: string) => any;
+    logger?: Logger;
+};
+type Mock = (url: string, options: RequestOptions) => Promise<Response>;
+/**
+ * Mock requests
+ * @param handler {function | null} null to disable mock
+ * @example setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
+ */
+declare function setMock(handler: Mock | null): void;
+declare function querystringify(obj: any): string;
+/**
+ * Request
+ * @param {string} url Url
+ * @param {object=} [options={}] Options
+ * @param {string} [options.method=GET] Method
+ * @param {object} [options.query={}] Query
+ * @param {object} [options.headers={}] Headers
+ * @param {object=} options.body Body
+ * @param {number=} options.timeout Timeout
+ * @param {string=} options.auth Auth, format: user:password
+ * @param {string=} options.file Upload file path
+ * @param {WritableStream=} options.downloadStream Download stream
+ * @param {Buffer=} options.pfx pfx
+ * @param {string=} options.passphrase passphrase
+ * @param {boolean=} options.agent agent
+ * @param {parse=} options.parse body parser, default is JSON.parse
+ *
+ * @returns {promise}
+ * @url https://faasjs.com/doc/request.html
+ */
+declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
+
+export { Request, RequestOptions, Response, querystringify, request, setMock };

package/dist/index.d.ts

@@ -39,10 +39,19 @@ type RequestOptions = {
     auth?: string;
     /**
      * Path of uploading a file to the server.
+     *
+     * ```ts
+     * await request('https://example.com', { file: 'filepath' })
+     * ```
      */
     file?: string;
     /**
      * Create a write stream to download a file.
+     *
+     * ```ts
+     * const stream = createWriteStream('filepath')
+     * await request('https://example.com', { downloadStream: stream })
+     * ```
      */
     downloadStream?: NodeJS.WritableStream;
     pfx?: Buffer;

package/dist/index.js

@@ -1,42 +1,34 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+'use strict';
+
+var http = require('http');
+var https = require('https');
+var url = require('url');
+var fs = require('fs');
+var path = require('path');
+var logger = require('@faasjs/logger');
+
+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]; }
+        });
+      }
+    });
   }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var http__namespace = /*#__PURE__*/_interopNamespace(http);
+var https__namespace = /*#__PURE__*/_interopNamespace(https);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  querystringify: () => querystringify,
-  request: () => request,
-  setMock: () => setMock
-});
-module.exports = __toCommonJS(src_exports);
-var http = __toESM(require("http"));
-var https = __toESM(require("https"));
-var import_url = require("url");
-var import_fs = require("fs");
-var import_path = require("path");
-var import_logger = require("@faasjs/logger");
 var mock = null;
 function setMock(handler) {
   mock = handler;
@@ -60,7 +52,7 @@ function querystringify(obj) {
   }
   return pairs.length ? pairs.join("&") : "";
 }
-async function request(url, {
+async function request(url$1, {
   headers,
   method,
   query,
@@ -73,26 +65,33 @@ async function request(url, {
   passphrase,
   agent,
   parse,
-  logger
+  logger: logger$1
 } = { headers: {} }) {
-  if (!logger)
-    logger = new import_logger.Logger("request");
-  if (mock)
-    return mock(url, {
+  if (!logger$1)
+    logger$1 = 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
+    });
+  }
   if (query) {
-    if (!url.includes("?"))
-      url += "?";
-    else if (!url.endsWith("?"))
-      url += "&";
-    url += querystringify(query);
+    if (!url$1.includes("?"))
+      url$1 += "?";
+    else if (!url$1.endsWith("?"))
+      url$1 += "&";
+    url$1 += querystringify(query);
   }
-  const uri = new import_url.URL(url);
-  const protocol = uri.protocol === "https:" ? https : http;
+  const uri = new url.URL(url$1);
+  const protocol = uri.protocol === "https:" ? https__namespace : http__namespace;
   if (!uri.protocol)
     throw Error("Unknown protocol");
   const options = {
@@ -118,7 +117,7 @@ async function request(url, {
   if (body && !options.headers["Content-Length"])
     options.headers["Content-Length"] = Buffer.byteLength(body);
   return await new Promise(function(resolve, reject) {
-    logger.debug("request %j", {
+    logger$1.debug("request %j", {
       ...options,
       body
     });
@@ -135,8 +134,8 @@ async function request(url, {
         });
         res.on("end", () => {
           const data = Buffer.concat(raw).toString();
-          logger.timeEnd(url, "response %s %s %s", res.statusCode, res.headers["content-type"], data);
-          const response = /* @__PURE__ */ Object.create(null);
+          logger$1.timeEnd(url$1, "response %s %s %s", res.statusCode, res.headers["content-type"], data);
+          const response = res.statusCode >= 200 && res.statusCode < 400 ? /* @__PURE__ */ Object.create(null) : new Error();
           response.request = options;
           response.request.body = body;
           response.statusCode = res.statusCode;
@@ -145,8 +144,8 @@ async function request(url, {
           response.body = data;
           if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
             try {
-              response.body = parse ? parse(response.body) : JSON.parse(response.body);
-              logger.debug("response.parse JSON");
+              response.body = (parse || JSON.parse)(response.body);
+              logger$1.debug("response.parse JSON");
             } catch (error) {
               console.warn("response plain body", response.body);
               console.error(error);
@@ -154,7 +153,8 @@ async function request(url, {
           if (response.statusCode >= 200 && response.statusCode < 400)
             resolve(response);
           else {
-            logger.debug("response.error %j", response);
+            logger$1.debug("response.error %j", response);
+            response.message = `${res.statusMessage || res.statusCode} ${options.host}${options.path}`;
             reject(response);
           }
         });
@@ -166,10 +166,10 @@ async function request(url, {
       const crlf = "\r\n";
       const boundary = `--${Math.random().toString(16)}`;
       const delimiter = `${crlf}--${boundary}`;
-      const headers2 = [`Content-Disposition: form-data; name="file"; filename="${(0, import_path.basename)(file)}"${crlf}`];
+      const headers2 = [`Content-Disposition: form-data; name="file"; filename="${path.basename(file)}"${crlf}`];
       const multipartBody = Buffer.concat([
         Buffer.from(delimiter + crlf + headers2.join("") + crlf),
-        (0, import_fs.readFileSync)(file),
+        fs.readFileSync(file),
         Buffer.from(`${delimiter}--`)
       ]);
       req.setHeader("Content-Type", "multipart/form-data; boundary=" + boundary);
@@ -177,16 +177,14 @@ async function request(url, {
       req.write(multipartBody);
     }
     req.on("error", function(e) {
-      logger.timeEnd(url, "response.error %j", e);
+      logger$1.timeEnd(url$1, "response.error %j", e);
       reject(e);
     });
-    logger.time(url);
+    logger$1.time(url$1);
     req.end();
   });
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  querystringify,
-  request,
-  setMock
-});
+
+exports.querystringify = querystringify;
+exports.request = request;
+exports.setMock = setMock;

package/dist/index.mjs

@@ -1,10 +1,11 @@
+import * as http from 'http';
+import * as https from 'https';
+import { URL } from 'url';
+import { readFileSync } from 'fs';
+import { basename } from 'path';
+import { Logger } from '@faasjs/logger';
+
 // src/index.ts
-import * as http from "http";
-import * as https from "https";
-import { URL } from "url";
-import { readFileSync } from "fs";
-import { basename } from "path";
-import { Logger } from "@faasjs/logger";
 var mock = null;
 function setMock(handler) {
   mock = handler;
@@ -45,13 +46,20 @@ async function request(url, {
 } = { headers: {} }) {
   if (!logger)
     logger = new Logger("request");
-  if (mock)
+  if (mock) {
+    logger.debug("mock %s %j", url, {
+      headers,
+      method,
+      query,
+      body
+    });
     return mock(url, {
       headers,
       method,
       query,
       body
     });
+  }
   if (query) {
     if (!url.includes("?"))
       url += "?";
@@ -104,7 +112,7 @@ async function request(url, {
         res.on("end", () => {
           const data = Buffer.concat(raw).toString();
           logger.timeEnd(url, "response %s %s %s", res.statusCode, res.headers["content-type"], data);
-          const response = /* @__PURE__ */ Object.create(null);
+          const response = res.statusCode >= 200 && res.statusCode < 400 ? /* @__PURE__ */ Object.create(null) : new Error();
           response.request = options;
           response.request.body = body;
           response.statusCode = res.statusCode;
@@ -113,7 +121,7 @@ async function request(url, {
           response.body = data;
           if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
             try {
-              response.body = parse ? parse(response.body) : JSON.parse(response.body);
+              response.body = (parse || JSON.parse)(response.body);
               logger.debug("response.parse JSON");
             } catch (error) {
               console.warn("response plain body", response.body);
@@ -123,6 +131,7 @@ async function request(url, {
             resolve(response);
           else {
             logger.debug("response.error %j", response);
+            response.message = `${res.statusMessage || res.statusCode} ${options.host}${options.path}`;
             reject(response);
           }
         });
@@ -152,8 +161,5 @@ async function request(url, {
     req.end();
   });
 }
-export {
-  querystringify,
-  request,
-  setMock
-};
+
+export { querystringify, request, setMock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "0.0.3-beta.9",
+  "version": "0.0.3-beta.91",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,14 +15,13 @@
   },
   "funding": "https://github.com/sponsors/faasjs",
   "scripts": {
-    "build": "tsup-node src/index.ts --format esm,cjs",
-    "build:types": "tsup-node src/index.ts --dts-only"
+    "build": "tsup-node src/index.ts --config ../../tsup.config.json"
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@faasjs/logger": "^0.0.3-beta.9"
+    "@faasjs/logger": "^0.0.3-beta.91"
   },
   "engines": {
     "npm": ">=8.0.0",