@faasjs/request 0.0.3-beta.99 → 0.0.4-beta.2

package/README.md

@@ -54,7 +54,8 @@ ___
 | `agent?` | `boolean` | - |
 | `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. ```ts const stream = createWriteStream('filepath') await request('https://example.com', { downloadStream: stream }) ``` |
+| `downloadFile?` | `string` | Path of downloading a file from the server. ```ts await request('https://example.com', { downloadFile: 'filepath' }) ``` |
+| `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. ```ts import { createWriteStream } from 'fs' 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` | - |
@@ -111,10 +112,6 @@ ___
 
 Request
 
-**`Url`**
-
-https://faasjs.com/doc/request.html
-
 #### Type parameters
 
 | Name | Type |
@@ -132,6 +129,10 @@ https://faasjs.com/doc/request.html
 
 `Promise`<[`Response`](#response)<`T`\>\>
 
+**`Url`**
+
+https://faasjs.com/doc/request.html
+
 ___
 
 ### setMock
@@ -140,12 +141,6 @@ ___
 
 Mock requests
 
-**`Example`**
-
-```ts
-setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
-```
-
 #### Parameters
 
 | Name | Type | Description |
@@ -155,3 +150,9 @@ setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200,
 #### Returns
 
 `void`
+
+**`Example`**
+
+```ts
+setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
+```

package/dist/index.d.mts

@@ -49,11 +49,21 @@ type RequestOptions = {
      * Create a write stream to download a file.
      *
      * ```ts
+     * import { createWriteStream } from 'fs'
+     *
      * const stream = createWriteStream('filepath')
      * await request('https://example.com', { downloadStream: stream })
      * ```
      */
     downloadStream?: NodeJS.WritableStream;
+    /**
+     * Path of downloading a file from the server.
+     *
+     * ```ts
+     * await request('https://example.com', { downloadFile: 'filepath' })
+     * ```
+     */
+    downloadFile?: string;
     pfx?: Buffer;
     passphrase?: string;
     agent?: boolean;
@@ -83,6 +93,7 @@ declare function querystringify(obj: any): string;
  * @param {string=} options.auth Auth, format: user:password
  * @param {string=} options.file Upload file path
  * @param {WritableStream=} options.downloadStream Download stream
+ * @param {string=} options.downloadFile Download to file
  * @param {Buffer=} options.pfx pfx
  * @param {string=} options.passphrase passphrase
  * @param {boolean=} options.agent agent
@@ -91,6 +102,6 @@ declare function querystringify(obj: any): string;
  * @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>>;
+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>>;
 
 export { Request, RequestOptions, Response, querystringify, request, setMock };

package/dist/index.d.ts

@@ -49,11 +49,21 @@ type RequestOptions = {
      * Create a write stream to download a file.
      *
      * ```ts
+     * import { createWriteStream } from 'fs'
+     *
      * const stream = createWriteStream('filepath')
      * await request('https://example.com', { downloadStream: stream })
      * ```
      */
     downloadStream?: NodeJS.WritableStream;
+    /**
+     * Path of downloading a file from the server.
+     *
+     * ```ts
+     * await request('https://example.com', { downloadFile: 'filepath' })
+     * ```
+     */
+    downloadFile?: string;
     pfx?: Buffer;
     passphrase?: string;
     agent?: boolean;
@@ -83,6 +93,7 @@ declare function querystringify(obj: any): string;
  * @param {string=} options.auth Auth, format: user:password
  * @param {string=} options.file Upload file path
  * @param {WritableStream=} options.downloadStream Download stream
+ * @param {string=} options.downloadFile Download to file
  * @param {Buffer=} options.pfx pfx
  * @param {string=} options.passphrase passphrase
  * @param {boolean=} options.agent agent
@@ -91,6 +102,6 @@ declare function querystringify(obj: any): string;
  * @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>>;
+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>>;
 
 export { Request, RequestOptions, Response, querystringify, request, setMock };

package/dist/index.js

@@ -47,7 +47,7 @@ function querystringify(obj) {
       value = encodeURIComponent(value);
       if (key === null || value === null)
         continue;
-      pairs.push(key + "=" + value);
+      pairs.push(`${key}=${value}`);
     }
   }
   return pairs.length ? pairs.join("&") : "";
@@ -61,12 +61,14 @@ async function request(url$1, {
   auth,
   file,
   downloadStream,
+  downloadFile,
   pfx,
   passphrase,
   agent,
   parse,
   logger: logger$1
 } = { headers: {} }) {
+  var _a;
   if (!logger$1)
     logger$1 = new logger.Logger("request");
   if (mock) {
@@ -99,7 +101,7 @@ async function request(url$1, {
     host: uri.host ? uri.host.replace(/:[0-9]+$/, "") : uri.host,
     method: method ? method.toUpperCase() : "GET",
     path: uri.pathname + uri.search,
-    port: uri.port,
+    port: uri.port || (uri.protocol === "https:" ? "443" : "80"),
     timeout,
     auth,
     pfx,
@@ -110,7 +112,7 @@ async function request(url$1, {
     if (typeof headers[key] !== "undefined" && headers[key] !== null)
       options.headers[key] = headers[key];
   if (body && typeof body !== "string")
-    if (options.headers["Content-Type"] && options.headers["Content-Type"].toString().includes("application/x-www-form-urlencoded"))
+    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);
@@ -124,9 +126,11 @@ async function request(url$1, {
     const req = protocol.request(options, function(res) {
       if (downloadStream) {
         res.pipe(downloadStream);
-        downloadStream.on("finish", function() {
-          resolve(void 0);
-        });
+        downloadStream.on("finish", () => resolve(void 0));
+      } else if (downloadFile) {
+        const stream = fs.createWriteStream(downloadFile);
+        res.pipe(stream);
+        stream.on("finish", () => resolve(void 0));
       } else {
         const raw = [];
         res.on("data", (chunk) => {
@@ -134,7 +138,13 @@ async function request(url$1, {
         });
         res.on("end", () => {
           const data = Buffer.concat(raw).toString();
-          logger$1.timeEnd(url$1, "response %s %s %s", res.statusCode, res.headers["content-type"], data);
+          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;
@@ -166,13 +176,17 @@ async function request(url$1, {
       const crlf = "\r\n";
       const boundary = `--${Math.random().toString(16)}`;
       const delimiter = `${crlf}--${boundary}`;
-      const headers2 = [`Content-Disposition: form-data; name="file"; filename="${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),
         fs.readFileSync(file),
         Buffer.from(`${delimiter}--`)
       ]);
-      req.setHeader("Content-Type", "multipart/form-data; boundary=" + boundary);
+      req.setHeader("Content-Type", `multipart/form-data; boundary=${boundary}`);
       req.setHeader("Content-Length", multipartBody.length);
       req.write(multipartBody);
     }

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import * as http from 'http';
 import * as https from 'https';
 import { URL } from 'url';
-import { readFileSync } from 'fs';
+import { createWriteStream, readFileSync } from 'fs';
 import { basename } from 'path';
 import { Logger } from '@faasjs/logger';
 
@@ -24,7 +24,7 @@ function querystringify(obj) {
       value = encodeURIComponent(value);
       if (key === null || value === null)
         continue;
-      pairs.push(key + "=" + value);
+      pairs.push(`${key}=${value}`);
     }
   }
   return pairs.length ? pairs.join("&") : "";
@@ -38,12 +38,14 @@ async function request(url, {
   auth,
   file,
   downloadStream,
+  downloadFile,
   pfx,
   passphrase,
   agent,
   parse,
   logger
 } = { headers: {} }) {
+  var _a;
   if (!logger)
     logger = new Logger("request");
   if (mock) {
@@ -76,7 +78,7 @@ async function request(url, {
     host: uri.host ? uri.host.replace(/:[0-9]+$/, "") : uri.host,
     method: method ? method.toUpperCase() : "GET",
     path: uri.pathname + uri.search,
-    port: uri.port,
+    port: uri.port || (uri.protocol === "https:" ? "443" : "80"),
     timeout,
     auth,
     pfx,
@@ -87,7 +89,7 @@ async function request(url, {
     if (typeof headers[key] !== "undefined" && headers[key] !== null)
       options.headers[key] = headers[key];
   if (body && typeof body !== "string")
-    if (options.headers["Content-Type"] && options.headers["Content-Type"].toString().includes("application/x-www-form-urlencoded"))
+    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);
@@ -101,9 +103,11 @@ async function request(url, {
     const req = protocol.request(options, function(res) {
       if (downloadStream) {
         res.pipe(downloadStream);
-        downloadStream.on("finish", function() {
-          resolve(void 0);
-        });
+        downloadStream.on("finish", () => resolve(void 0));
+      } else if (downloadFile) {
+        const stream = createWriteStream(downloadFile);
+        res.pipe(stream);
+        stream.on("finish", () => resolve(void 0));
       } else {
         const raw = [];
         res.on("data", (chunk) => {
@@ -111,7 +115,13 @@ 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);
+          logger.timeEnd(
+            url,
+            "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;
@@ -143,13 +153,17 @@ 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="${basename(file)}"${crlf}`];
+      const headers2 = [
+        `Content-Disposition: form-data; name="file"; filename="${basename(
+          file
+        )}"${crlf}`
+      ];
       const multipartBody = Buffer.concat([
         Buffer.from(delimiter + crlf + headers2.join("") + crlf),
         readFileSync(file),
         Buffer.from(`${delimiter}--`)
       ]);
-      req.setHeader("Content-Type", "multipart/form-data; boundary=" + boundary);
+      req.setHeader("Content-Type", `multipart/form-data; boundary=${boundary}`);
       req.setHeader("Content-Length", multipartBody.length);
       req.write(multipartBody);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "0.0.3-beta.99",
+  "version": "0.0.4-beta.2",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,11 +20,14 @@
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "@faasjs/logger": "0.0.3-beta.99"
+  "peerDependencies": {
+    "@faasjs/logger": "0.0.4-beta.2"
+  },
+  "devDependencies": {
+    "@faasjs/logger": "0.0.4-beta.2"
   },
   "engines": {
-    "npm": ">=8.0.0",
-    "node": ">=16.0.0"
+    "npm": ">=9.0.0",
+    "node": ">=18.0.0"
   }
 }