@faasjs/request 0.0.3-beta.86 → 0.0.3-beta.87

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.js

@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));

package/package.json

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