@faasjs/request 4.7.2 → 5.0.0-beta.2

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@faasjs/request",
-  "version": "4.7.2",
+  "version": "5.0.0-beta.2",
   "license": "MIT",
+  "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/index.d.mts",
+        "types": "./dist/index.d.ts",
         "default": "./dist/index.mjs"
       },
       "require": {
@@ -28,16 +29,16 @@
   },
   "funding": "https://github.com/sponsors/faasjs",
   "scripts": {
-    "build": "tsup-node src/index.ts --config ../../tsup.config.json"
+    "build": "tsup-node src/index.ts --config ../../tsup.config.ts"
   },
   "files": [
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/logger": "4.7.2"
+    "@faasjs/logger": "5.0.0-beta.2"
   },
   "devDependencies": {
-    "@faasjs/logger": "4.7.2"
+    "@faasjs/logger": "5.0.0-beta.2"
   },
   "engines": {
     "node": ">=22.0.0",

package/dist/index.d.mts

@@ -1,134 +0,0 @@
-import { OutgoingHttpHeaders } from 'node:http';
-import https from 'node:https';
-import { Logger } from '@faasjs/logger';
-
-/**
- * FaasJS's request module.
- *
- * [![License: MIT](https://img.shields.io/npm/l/@faasjs/request.svg)](https://github.com/faasjs/faasjs/blob/main/packages/request/LICENSE)
- * [![NPM Version](https://img.shields.io/npm/v/@faasjs/request.svg)](https://www.npmjs.com/package/@faasjs/request)
- *
- * ## Install
- *
- * ```sh
- * npm install @faasjs/request
- * ```
- * @packageDocumentation
- */
-
-type Request = {
-    headers?: OutgoingHttpHeaders;
-    method?: string;
-    host?: string;
-    path?: string;
-    query?: OutgoingHttpHeaders;
-    body?: {
-        [key: string]: any;
-    };
-};
-type Response<T = any> = {
-    request?: Request;
-    statusCode?: number;
-    statusMessage?: string;
-    headers: OutgoingHttpHeaders;
-    body: T;
-};
-type RequestOptions = {
-    headers?: 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 in milliseconds, @default 5000 */
-    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
-     * 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;
-    /**
-     * Body parser. Defaults to `JSON.parse`.
-     */
-    parse?: (body: string) => any;
-    logger?: Logger;
-} & Pick<https.RequestOptions, 'pfx' | 'passphrase' | 'agent'>;
-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;
-/**
- * ResponseError class
- */
-declare class ResponseError extends Error {
-    response: Response;
-    request: Request;
-    statusCode: number;
-    statusMessage: string;
-    headers: OutgoingHttpHeaders;
-    body: any;
-    constructor(message: string, response: Response<any>);
-}
-/**
- * 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 {string=} options.downloadFile Download to file
- * @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, options?: RequestOptions): Promise<Response<T>>;
-
-export { type Request, type RequestOptions, type Response, ResponseError, querystringify, request, setMock };