@maiyunnet/kebab 9.1.3 → 9.2.0

package/lib/undici/request.js

@@ -0,0 +1,120 @@
+import * as lUndici from '#kebab/lib/undici.js';
+export class Request {
+    /** --- get 或 post 的数据 --- */
+    _data = undefined;
+    /** --- 访问的 URL --- */
+    _url = '';
+    /** --- 要传递的参数 --- */
+    _opt = {};
+    constructor(url) {
+        this._url = url;
+    }
+    /**
+     * --- 设置 get 或 post 的数据 ---
+     * @param data 数据
+     */
+    data(data) {
+        this._data = data;
+        return this;
+    }
+    /**
+     * --- 设置 get 或 post 请求 ---
+     * @param method
+     */
+    method(method) {
+        this._opt['method'] = method;
+        return this;
+    }
+    /**
+     * --- method get 方法别名 ---
+     */
+    get() {
+        return this.method('GET');
+    }
+    /**
+     * --- method post 方法别名 ---
+     */
+    post() {
+        return this.method('POST');
+    }
+    /**
+     * --- 设置提交模式，json 还是普通 form ---
+     * @param type
+     */
+    type(type) {
+        this._opt['type'] = type;
+        return this;
+    }
+    /**
+     * --- type json 方法别名 ---
+     */
+    json() {
+        return this.type('json');
+    }
+    /**
+     * --- 设置请求有效期 ---
+     * @param timeout 秒
+     */
+    timeout(timeout) {
+        this._opt['timeout'] = timeout;
+        return this;
+    }
+    /**
+     * --- 设置是否跟随请求方的 location，留空为跟随，不设置为不跟随 ---
+     * @param follow
+     */
+    follow(follow = 5) {
+        this._opt['follow'] = follow;
+        return this;
+    }
+    /**
+     * --- 设置域名 -> ip的对应键值，就像电脑里的 hosts 一样 ---
+     * @param hosts
+     */
+    hosts(hosts) {
+        this._opt['hosts'] = hosts;
+        return this;
+    }
+    /**
+     * --- 设置后将直接保存到本地文件，不会返回，save 为本地实体路径 ---
+     * @param save
+     */
+    save(save) {
+        this._opt['save'] = save;
+        return this;
+    }
+    /**
+     * --- 设置使用的本地网卡 IP ---
+     * @param addr
+     */
+    local(addr) {
+        this._opt['local'] = addr;
+        return this;
+    }
+    /**
+     * --- 批量设置提交的 headers ---
+     * @param headers
+     */
+    headers(headers) {
+        this._opt['headers'] = headers;
+        return this;
+    }
+    /**
+     * --- 设置单条 header ---
+     * @param name
+     * @param val
+     */
+    setHeader(name, val) {
+        this._opt['headers'] ??= {};
+        this._opt['headers'][name] = val;
+        return this;
+    }
+    /**
+     * --- 发起请求 ---
+     * @param cookie
+     */
+    request(cookie) {
+        this._opt.cookie = cookie;
+        return lUndici.request(this._url, this._data, this._opt);
+    }
+}

package/lib/undici/response.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2020-4-9 15:33:06
+ * Last: 2020-4-12 11:12:03, 2022-09-10 12:43:23, 2022-12-25 15:12:57, 2023-9-26 14:20:41
+ */
+import * as undici from 'undici';
+import * as zlib from 'zlib';
+import * as lUndici from '#kebab/lib/undici.js';
+export declare class Response {
+    /** --- httpClient 请求对象 --- */
+    private readonly _req;
+    /** --- 返回的 headers --- */
+    headers: lUndici.THttpHeaders | null;
+    error: Error | null;
+    /** --- 用户自定义的 content 内容 --- */
+    private _content;
+    constructor(req: undici.Dispatcher.ResponseData | null);
+    /**
+     * --- 读取所有内容到内存 ---
+     */
+    getContent(): Promise<Buffer | null>;
+    /** --- 读取所有内容为文本 --- */
+    getText(): Promise<string | null>;
+    /** --- 读取所有内容为 JSON --- */
+    getJson(): Promise<any>;
+    /**
+     * --- 用户自定义的 content 内容 ---
+     * @param v 内容值
+     */
+    setContent(v: string | Buffer): void;
+    /**
+     * --- 获取响应读取流对象 ---
+     */
+    getStream(): (import("undici/types/readable").default & undici.Dispatcher.BodyMixin) | zlib.Gunzip | zlib.Inflate | zlib.BrotliDecompress | null;
+    /**
+     * --- 获取原生响应读取流对象 ---
+     */
+    getRawStream(): (import("undici/types/readable").default & undici.Dispatcher.BodyMixin) | null;
+}

package/lib/undici/response.js

@@ -0,0 +1,111 @@
+import * as zlib from 'zlib';
+import * as lBuffer from '#kebab/lib/buffer.js';
+import * as lText from '#kebab/lib/text.js';
+export class Response {
+    /** --- httpClient 请求对象 --- */
+    _req = null;
+    /** --- 返回的 headers --- */
+    headers = null;
+    error = null;
+    /** --- 用户自定义的 content 内容 --- */
+    _content = null;
+    constructor(req) {
+        this._req = req;
+    }
+    /**
+     * --- 读取所有内容到内存 ---
+     */
+    async getContent() {
+        if (this._content) {
+            return this._content;
+        }
+        try {
+            const stream = this.getStream();
+            if (!stream) {
+                return null;
+            }
+            return this._req ? await lBuffer.getFull(stream) : null;
+        }
+        catch {
+            return null;
+        }
+    }
+    /** --- 读取所有内容为文本 --- */
+    async getText() {
+        try {
+            const buf = await this.getContent();
+            if (!buf) {
+                return null;
+            }
+            return buf.toString('utf-8');
+        }
+        catch {
+            return null;
+        }
+    }
+    /** --- 读取所有内容为 JSON --- */
+    async getJson() {
+        try {
+            const text = await this.getText();
+            if (!text) {
+                return null;
+            }
+            return lText.parseJson(text);
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * --- 用户自定义的 content 内容 ---
+     * @param v 内容值
+     */
+    setContent(v) {
+        this._content = typeof v === 'string' ? Buffer.from(v) : v;
+    }
+    /**
+     * --- 获取响应读取流对象 ---
+     */
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    getStream() {
+        try {
+            // --- 要解压 ---
+            if (!this._req || !this.headers) {
+                return null;
+            }
+            const enc = this.headers['content-encoding'];
+            if ((enc !== 'gzip') && (enc !== 'deflate') && (enc !== 'br')) {
+                return this._req.body;
+            }
+            // --- gzip ---
+            if (this.headers['content-encoding'] === 'gzip') {
+                return this._req.body.pipe(zlib.createGunzip());
+            }
+            // --- deflate ---
+            if (this.headers['content-encoding'] === 'deflate') {
+                return this._req.body.pipe(zlib.createInflate());
+            }
+            // --- br ---
+            if (this.headers['content-encoding'] === 'br') {
+                return this._req.body.pipe(zlib.createBrotliDecompress());
+            }
+            // --- 不知道 ---
+            return this._req.body;
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * --- 获取原生响应读取流对象 ---
+     */
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    getRawStream() {
+        try {
+            return this._req ? this._req.body : null;
+        }
+        catch {
+            return null;
+        }
+    }
+}

package/lib/undici.d.ts

@@ -0,0 +1,174 @@
+import * as undici from 'undici';
+import * as stream from 'stream';
+import * as http from 'http';
+import * as http2 from 'http2';
+import * as kebab from '#kebab/index.js';
+import * as lCookie from '#kebab/lib/cookie.js';
+import * as sCtr from '#kebab/sys/ctr.js';
+import * as lFd from './undici/formdata.js';
+import * as lRequest from './undici/request.js';
+import * as lResponse from './undici/response.js';
+/** --- 获取代理 agent --- */
+export declare function getProxyAgent(url: string): undici.ProxyAgent;
+/**
+ * --- 创建一个请求对象 ---
+ * @param u
+ */
+export declare function open(u: string): lRequest.Request;
+/**
+ * --- 发起一个 get 请求 ---
+ * @param u 请求的 URL
+ * @param opt 参数
+ */
+export declare function get(u: string, opt?: IRequestOptions): Promise<lResponse.Response>;
+/**
+ * --- 发起一个 post 请求 ---
+ * @param u 请求的 URL
+ * @param data 要发送的数据
+ * @param opt 参数
+ */
+export declare function post(u: string, data: Record<string, kebab.Json> | Buffer | string | stream.Readable, opt?: IRequestOptions): Promise<lResponse.Response>;
+/**
+ * --- 发起 JSON 请求 ---
+ * @param u 网址
+ * @param data 数据
+ * @param opt 选项
+ */
+export declare function postJson(u: string, data: kebab.Json[] | Record<string, kebab.Json>, opt?: IRequestOptions): Promise<lResponse.Response>;
+/**
+ * --- 发起 JSON 请求并解析 JSON 响应 ---
+ * @param u 网址
+ * @param data 数据
+ * @param opt 选项
+ * @returns JSON 数据，失败时返回 null
+ */
+export declare function postJsonResponseJson(u: string, data: kebab.Json[] | Record<string, kebab.Json>, opt?: IRequestOptions): Promise<kebab.Json | null>;
+/**
+ * --- 发起 GET 请求并解析 JSON 响应 ---
+ * @param u 网址
+ * @param opt 选项
+ * @returns JSON 数据，失败时返回 null
+ */
+export declare function getResponseJson(u: string, opt?: IRequestOptions): Promise<kebab.Json | null>;
+/**
+ * --- 发起一个完全兼容 fetch 的请求 ---
+ * @param input 请求的 URL 或 Request 对象
+ * @param init 增加 mproxy、hosts
+ */
+export declare function fetch(input: string | URL | Request, init?: RequestInit & {
+    /** --- 正向 mproxy 代理，url 如 https://xxx/abc --- */
+    'mproxy'?: {
+        'url': string;
+        'auth': string;
+        'data'?: kebab.Json;
+    };
+    /** --- 自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host --- */
+    'hosts'?: Record<string, string> | string;
+}): Promise<Response>;
+/**
+ * --- 发起一个请求 ---
+ * @param opt 配置项
+ */
+export declare function request(u: string, data?: Record<string, kebab.Json> | Buffer | string | stream.Readable, opt?: IRequestOptions): Promise<lResponse.Response>;
+/**
+ * --- 创建 FormData 对象 ---
+ */
+export declare function getFormData(): lFd.FormData;
+/**
+ * --- 剔除不代理的 header，返回新的 header ---
+ * @param headers 剔除前的 header
+ * @param res 直接设置头部而不返回，可置空
+ * @param filter 返回 true 则留下
+ */
+export declare function filterHeaders(headers: http.IncomingHttpHeaders | http2.IncomingHttpHeaders | THttpHeaders, res?: http2.Http2ServerResponse | http.ServerResponse, filter?: (h: string) => boolean): Record<string, string | string[]>;
+/**
+ * --- 正向 mproxy 代理，注意提前处理不要自动处理 post 数据，读取 get 的 url 为实际请求地址 ---
+ * --- get: url, auth ---
+ * @param ctr 当前控制器
+ * @param auth 校验字符串，读取 get 的 auth 和本参数做比对
+ * @param opt 参数
+ */
+export declare function mproxy(ctr: sCtr.Ctr, auth: string, opt?: IMproxyOptions): Promise<number>;
+/**
+ * --- 获取 mproxy 的附加数据 ---
+ * @param ctr 当前控制器
+ */
+export declare function mproxyData(ctr: sCtr.Ctr): kebab.Json;
+/**
+ * --- 反向代理，注意提前处理不要自动处理 post 数据，将本服务器的某个路由反代到其他网址 ---
+ * @param ctr 当前控制器
+ * @param route 要反代的路由
+ * @param opt 参数
+ */
+export declare function rproxy(ctr: sCtr.Ctr, route: Record<string, string>, opt?: IRproxyOptions): Promise<boolean>;
+/** --- 请求的传入参数选项 --- */
+export interface IRequestOptions {
+    'method'?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'OPTIONS';
+    'type'?: 'form' | 'json';
+    /** --- 秒数，默认 10 秒 --- */
+    'timeout'?: number;
+    /** --- 追踪 location 次数，0 为不追踪，默认为 0 --- */
+    'follow'?: number;
+    /** --- 自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host --- */
+    'hosts'?: Record<string, string> | string;
+    'save'?: string;
+    'local'?: string;
+    'headers'?: THttpHeaders;
+    /** --- 正向 mproxy 代理，url 如 https://xxx/abc --- */
+    'mproxy'?: {
+        'url': string;
+        'auth': string;
+        'data'?: kebab.Json;
+        /** --- 落地端自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host --- */
+        'hosts'?: Record<string, string> | string;
+    };
+    /** --- 连接是否保持长连接（即是否允许复用），默认为 true --- */
+    'keep'?: boolean;
+    /** --- 复用池名/Agent，默认为 default --- */
+    'reuse'?: string | undici.ProxyAgent | undici.Agent;
+    /** --- cookie 托管对象 --- */
+    'cookie'?: Record<string, lCookie.ICookie>;
+    /** --- 若有异常写入文件日志，默认为 true --- */
+    'log'?: boolean;
+}
+/** --- 正向代理请求的传入参数选项 --- */
+export interface IMproxyOptions {
+    /** --- 秒数 --- */
+    'timeout'?: number;
+    'follow'?: number;
+    /** --- 自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host --- */
+    'hosts'?: Record<string, string> | string;
+    'local'?: string;
+    'headers'?: THttpHeaders;
+    /** --- 过滤 header，返回 true 则留下 --- */
+    filter?: (h: string) => boolean;
+    /** --- 默认为 default --- */
+    'reuse'?: string | undici.ProxyAgent | undici.Agent;
+}
+/** --- 反向代理请求的传入参数选项 --- */
+export interface IRproxyOptions {
+    /** --- 秒数 --- */
+    'timeout'?: number;
+    'follow'?: number;
+    /** --- 自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host --- */
+    'hosts'?: Record<string, string> | string;
+    'local'?: string;
+    'headers'?: THttpHeaders;
+    /** --- 过滤 header，返回 true 则留下 --- */
+    filter?: (h: string) => boolean;
+    /** --- 正向 mproxy 代理，url 如 https://xxx/abc --- */
+    'mproxy'?: {
+        'url': string;
+        'auth': string;
+        'data'?: kebab.Json;
+        /** --- 落地端自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host --- */
+        'hosts'?: Record<string, string> | string;
+    };
+    /** --- 默认为 default --- */
+    'reuse'?: string | undici.ProxyAgent | undici.Agent;
+}
+/** --- http headers --- */
+export type THttpHeaders = http.IncomingHttpHeaders & {
+    'http-code'?: number;
+    'http-url'?: string;
+};