xjs-node 1.0.3 → 1.0.5

package/README.md

@@ -58,7 +58,7 @@ import { HttpResolver, s_clientMode } from "xjs-node";
     const context = http.newContext();
     res = await context.get("https://begyyal.net/1");
     // this request sends with cookies that is set by precedent requests. 
-    // in POST, payload is treated as json if it is an object.
+    // in POST, payload is treated as json if it is an object. (but also Stream is acceptable.)
     res = await context.post("https://begyyal.net/2", { a: "b" });
 })();
 ```

package/dist/prcs/http/http-resolver-context.d.ts

@@ -1,7 +1,5 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { OutgoingHttpHeaders, IncomingHttpHeaders } from "http";
-import { ClientOption, IHttpClient } from "./i-http-client";
+import { ClientOption, HttpResponse, IHttpClient, RequestOption } from "./i-http-client";
 import { Loggable } from "xjs-common";
 export declare const s_clientMode: {
     nodejs: {
@@ -28,70 +26,24 @@ export declare class HttpResolverContext implements IHttpClient {
     private _cookies?;
     get clientMode(): string;
     constructor(cmv: number, op?: ClientOption, _l?: Loggable);
-    get(url: string, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
-    } & {
+    get(url: string, op?: RequestOption & {
         outerRedirectCount?: number;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    get(url: string, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
         responseType: "string";
-    } & {
+    }): Promise<HttpResponse<string>>;
+    get(url: string, op?: RequestOption & {
         outerRedirectCount?: number;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    get(url: string, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
         responseType: "buffer";
-    } & {
+    }): Promise<HttpResponse<Buffer>>;
+    get(url: string, op?: RequestOption & {
         outerRedirectCount?: number;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: Buffer;
-    }>;
-    post(url: string, payload: any, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    post(url: string, payload: any, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & {
         responseType: "string";
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    post(url: string, payload: any, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & {
         responseType: "buffer";
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: Buffer;
-    }>;
+    }): Promise<HttpResponse<Buffer>>;
+    post(url: string, payload: any, op?: RequestOption): Promise<HttpResponse<string>>;
     private createProxyAgent;
     private getIn;
     private postIn;

package/dist/prcs/http/http-resolver-context.js

@@ -35,6 +35,7 @@ const async_hooks_1 = require("async_hooks");
 const u_file_1 = require("../../func/u-file");
 const u_1 = require("../../func/u");
 const xjs_common_1 = require("xjs-common");
+const stream_1 = require("stream");
 exports.s_clientMode = {
     nodejs: { id: 0, cipherOrder: null },
     chrome: { id: 1, cipherOrder: [2, 0, 1] },
@@ -44,36 +45,36 @@ const s_errCode = 1200;
 const s_redirectLimit = 5;
 const s_mode2headers = new Map([
     [exports.s_clientMode.firefox, (cmv) => ({
-            "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
-            "Accept-Encoding": "gzip, deflate, br",
-            "Accept-Language": "en-US,en;q=0.5",
-            "Sec-Fetch-Dest": "document",
-            "Sec-Fetch-Mode": "navigate",
-            "Sec-Fetch-Site": "none",
-            "Sec-Fetch-User": "?1",
-            "Upgrade-Insecure-Requests": "1",
-            "User-Agent": `Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:${cmv}.0) Gecko/20100101 Firefox/${cmv}.0`
+            "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
+            "accept-encoding": "gzip, deflate, br",
+            "accept-language": "en-US,en;q=0.5",
+            "sec-fetch-dest": "document",
+            "sec-fetch-mode": "navigate",
+            "sec-fetch-site": "none",
+            "sec-fetch-user": "?1",
+            "upgrade-insecure-requests": "1",
+            "user-agent": `Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:${cmv}.0) Gecko/20100101 Firefox/${cmv}.0`
         })],
     [exports.s_clientMode.chrome, (cmv) => {
             const uad = cmv < 130
                 ? `"Not/A)Brand";v="8", "Chromium";v="${cmv}", "Google Chrome";v="${cmv}"`
                 : `"Chromium";v="${cmv}", "Not:A-Brand";v="24", "Google Chrome";v="${cmv}"`;
             const ch = {
-                "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
-                "Accept-Encoding": "gzip, deflate, br, zstd",
-                "Accept-Language": "en-US,en;q=0.9",
-                "Sec-Ch-Ua": uad,
-                "Sec-Ch-Ua-Mobile": "?0",
-                "Sec-Ch-Ua-Platform": '"Windows"',
-                "Sec-Fetch-Dest": "document",
-                "Sec-Fetch-Mode": "navigate",
-                "Sec-Fetch-Site": "none",
-                "Sec-Fetch-User": "?1",
-                "Upgrade-Insecure-Requests": "1",
-                "User-Agent": `Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/${cmv}.0.0.0 Safari/537.36`
+                "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
+                "accept-encoding": "gzip, deflate, br, zstd",
+                "accept-language": "en-US,en;q=0.9",
+                "sec-ch-ua": uad,
+                "sec-ch-ua-mobile": "?0",
+                "sec-ch-ua-platform": '"Windows"',
+                "sec-fetch-dest": "document",
+                "sec-fetch-mode": "navigate",
+                "sec-fetch-site": "none",
+                "sec-fetch-user": "?1",
+                "upgrade-insecure-requests": "1",
+                "user-agent": `Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/${cmv}.0.0.0 Safari/537.36`
             };
             if (cmv >= 124)
-                ch["Priority"] = "u=0, i";
+                ch["priority"] = "u=0, i";
             return ch;
         }]
 ]);
@@ -97,16 +98,6 @@ class HttpResolverContext {
             this._chHeaders = s_mode2headers.get(this._mode)(this.cmv);
         }
     }
-    /**
-     * request GET to the url.
-     * @param url target url.
-     * @param op.headers http headers.
-     * @param op.ignoreQuery {@link RequestOption.ignoreQuery}
-     * @param op.downloadPath {@link RequestOption.downloadPath}
-     * @param op.timeout {@link RequestOption.timeout}
-     * @param op.responseType {@link RequestOption.responseType}
-     * @returns string encoded by utf-8 as response payload.
-     */
     async get(url, op) {
         const u = new url_1.URL(url);
         const proxyAgent = this._proxyConfig && await this.createProxyAgent(u);
@@ -114,17 +105,6 @@ class HttpResolverContext {
         Object.assign(rc, op);
         return await this._als.run(rc, this.getIn, u).finally(() => proxyAgent?.destroy());
     }
-    /**
-     * request POST to the url.
-     * @param url target url.
-     * @param payload request payload. if this is an object, it is treated as json.
-     * @param op.headers http headers.
-     * @param op.ignoreQuery {@link RequestOption.ignoreQuery}
-     * @param op.downloadPath {@link RequestOption.downloadPath}
-     * @param op.timeout {@link RequestOption.timeout}
-     * @param op.responseType {@link RequestOption.responseType}
-     * @returns string encoded by utf-8 as response payload.
-     */
     async post(url, payload, op) {
         const u = new url_1.URL(url);
         const proxyAgent = this._proxyConfig && await this.createProxyAgent(u);
@@ -137,7 +117,7 @@ class HttpResolverContext {
         return new Promise((resolve, reject) => {
             const headers = {};
             if (conf.auth)
-                headers['Proxy-Authorization'] = `Basic ${Buffer.from(conf.auth.name + ':' + conf.auth.pass).toString('base64')}`;
+                headers['proxy-authorization'] = `Basic ${Buffer.from(conf.auth.name + ':' + conf.auth.pass).toString('base64')}`;
             const req = (0, http_1.request)({
                 host: conf.server,
                 port: conf.port,
@@ -162,19 +142,22 @@ class HttpResolverContext {
         const params = {};
         const rc = this._als.getStore();
         params.method = xjs_common_1.HttpMethod.Get;
-        params.headers = rc.headers ?? {};
+        params.headers = xjs_common_1.UHttp.normalizeHeaders(rc.headers);
         return await this.reqHttps(u, params);
     };
     postIn = async (u, payload) => {
         const params = {};
         const rc = this._als.getStore();
         params.method = xjs_common_1.HttpMethod.Post;
-        params.headers = rc.headers ?? {};
+        params.headers = xjs_common_1.UHttp.normalizeHeaders(rc.headers);
         let p = payload;
-        if (xjs_common_1.UType.isObject(payload)) {
+        if (p instanceof stream_1.Stream) {
+            params.headers["content-type"] ??= "application/octet-stream";
+        }
+        else if (xjs_common_1.UType.isObject(payload)) {
             p = JSON.stringify(payload);
-            params.headers["Content-Length"] = p.length;
-            params.headers["Content-Type"] = "application/json";
+            params.headers["content-length"] = p.length;
+            params.headers["content-type"] = "application/json";
         }
         return await this.reqHttps(u, params, p);
     };
@@ -199,7 +182,10 @@ class HttpResolverContext {
                 reject(new xjs_common_1.XjsErr(s_errCode, "The http request timeout, maybe server did not respond."));
             });
             if (payload)
-                req.write(payload);
+                if (payload instanceof stream_1.Stream)
+                    payload.pipe(req);
+                else
+                    req.write(payload);
             req.end();
         });
     }

package/dist/prcs/http/http-resolver.d.ts

@@ -1,9 +1,7 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { Loggable } from "xjs-common";
 import { HttpResolverContext } from "./http-resolver-context";
-import { ClientOption, IHttpClient } from "./i-http-client";
-import { IncomingHttpHeaders, OutgoingHttpHeaders } from "http";
+import { ClientOption, HttpResponse, IHttpClient, RequestOption } from "./i-http-client";
 export interface ClientMode {
     id: number;
     cipherOrder: number[];
@@ -31,69 +29,23 @@ export declare class HttpResolver implements IHttpClient {
      * @returns a http client as new context.
      */
     newContext(op?: ClientOption): HttpResolverContext;
-    get(url: string, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
-    } & ClientOption & {
+    get(url: string, op?: RequestOption & ClientOption & {
         redirectAsNewRequest?: boolean;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    get(url: string, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
         responseType: "string";
-    } & ClientOption & {
+    }): Promise<HttpResponse<string>>;
+    get(url: string, op?: RequestOption & ClientOption & {
         redirectAsNewRequest?: boolean;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    get(url: string, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
         responseType: "buffer";
-    } & ClientOption & {
+    }): Promise<HttpResponse<Buffer>>;
+    get(url: string, op?: RequestOption & ClientOption & {
         redirectAsNewRequest?: boolean;
-    }): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: Buffer;
-    }>;
-    post(url: string, payload: any, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
-    } & ClientOption): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    post(url: string, payload: any, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & ClientOption & {
         responseType: "string";
-    } & ClientOption): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: string;
-    }>;
-    post(url: string, payload: any, op?: {
-        headers?: OutgoingHttpHeaders;
-        ignoreQuery?: boolean;
-        downloadPath?: string;
-        timeout?: number;
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & ClientOption & {
         responseType: "buffer";
-    } & ClientOption): Promise<{
-        headers?: IncomingHttpHeaders;
-        payload: Buffer;
-    }>;
+    }): Promise<HttpResponse<Buffer>>;
+    post(url: string, payload: any, op?: RequestOption & ClientOption): Promise<HttpResponse<string>>;
     private fixCmv;
 }

package/dist/prcs/http/i-http-client.d.ts

@@ -3,7 +3,13 @@
 import { IncomingHttpHeaders, OutgoingHttpHeaders } from "http";
 import { ClientMode, ProxyConfig } from "./http-resolver";
 export interface ClientOption {
+    /**
+     * {@link s_clientMode} that is imitated. default is random between chrome or firefox.
+     */
     mode?: ClientMode;
+    /**
+     * proxy configuration.
+     */
     proxy?: ProxyConfig;
 }
 export interface RequestOption {
@@ -26,7 +32,7 @@ export interface RequestOption {
      */
     responseType?: "string" | "buffer";
 }
-export interface HttpResponse {
+export interface HttpResponse<T = string | Buffer> {
     /**
      * http headers in the response.
      */
@@ -34,7 +40,7 @@ export interface HttpResponse {
     /**
      * response payload which has a type depends on {@link RequestOption.responseType}.
      */
-    payload?: string | Buffer;
+    payload?: T;
 }
 export interface IHttpClient {
     /**
@@ -49,14 +55,22 @@ export interface IHttpClient {
      * @param op.responseType {@link RequestOption.responseType}
      * @param op.redirectAsNewRequest handle redirect as new request. this may be efficient when using proxy which is implemented reverse proxy.
      * @returns http response. {@link HttpResponse}
-     */
+    */
+    get(url: string, op?: RequestOption & ClientOption & {
+        redirectAsNewRequest?: boolean;
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    get(url: string, op?: RequestOption & ClientOption & {
+        redirectAsNewRequest?: boolean;
+        responseType: "buffer";
+    }): Promise<HttpResponse<Buffer>>;
     get(url: string, op?: RequestOption & ClientOption & {
         redirectAsNewRequest?: boolean;
-    }): Promise<HttpResponse>;
+    }): Promise<HttpResponse<string>>;
     /**
      * request POST to the url with new context.
      * @param url target url. (currently https only)
-     * @param payload request payload. if this is an object, it is treated as json.
+     * @param payload request payload. if this is a Stream, pipe will be used, otherwise if an object, this is treated as json.
      * @param op.headers http headers.
      * @param op.mode {@link s_clientMode} that is imitated. default is random between chrome or firefox.
      * @param op.proxy proxy configuration.
@@ -66,5 +80,11 @@ export interface IHttpClient {
      * @param op.responseType {@link RequestOption.responseType}
      * @returns http response. {@link HttpResponse}
      */
-    post(url: string, payload: any, op?: RequestOption & ClientOption): Promise<HttpResponse>;
+    post(url: string, payload: any, op?: RequestOption & ClientOption & {
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & ClientOption & {
+        responseType: "buffer";
+    }): Promise<HttpResponse<Buffer>>;
+    post(url: string, payload: any, op?: RequestOption & ClientOption): Promise<HttpResponse<string>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xjs-node",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",
@@ -29,6 +29,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "xjs-common": "^10.1.0"
+    "xjs-common": "^10.1.3"
   }
 }