xjs-node 1.0.2 → 1.0.4

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

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { ClientOption, HttpResponse, IHttpClient, RequestOption } from "./i-http-client";
 import { Loggable } from "xjs-common";
 export declare const s_clientMode: {
@@ -25,29 +26,24 @@ export declare class HttpResolverContext implements IHttpClient {
     private _cookies?;
     get clientMode(): string;
     constructor(cmv: number, op?: ClientOption, _l?: Loggable);
-    /**
-     * 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}
-     * @returns string encoded by utf-8 as response payload.
-     */
     get(url: string, op?: RequestOption & {
         outerRedirectCount?: number;
-    }): Promise<HttpResponse>;
-    /**
-     * 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}
-     * @returns string encoded by utf-8 as response payload.
-     */
-    post(url: string, payload: any, op?: RequestOption): Promise<HttpResponse>;
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    get(url: string, op?: RequestOption & {
+        outerRedirectCount?: number;
+        responseType: "buffer";
+    }): Promise<HttpResponse<Buffer>>;
+    get(url: string, op?: RequestOption & {
+        outerRedirectCount?: number;
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & {
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    post(url: string, payload: any, op?: RequestOption & {
+        responseType: "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

@@ -97,15 +97,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}
-     * @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);
@@ -113,16 +104,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}
-     * @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);
@@ -238,9 +219,9 @@ class HttpResolverContext {
                     retBuf = zlib.gunzipSync(retBuf);
                 else if (contentEncofing == "br")
                     retBuf = zlib.brotliDecompressSync(retBuf);
-                const data = retBuf.toString("utf8");
+                const data = rc.responseType === "buffer" ? retBuf : retBuf.toString("utf8");
                 if (sc !== 2) {
-                    if (data.trim())
+                    if (xjs_common_1.UType.isString(data) && data.trim())
                         this.warn(data);
                     reject(new xjs_common_1.XjsErr(s_errCode, `Https received a error status ${res.statusCode}`));
                 }

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

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { Loggable } from "xjs-common";
 import { HttpResolverContext } from "./http-resolver-context";
 import { ClientOption, HttpResponse, IHttpClient, RequestOption } from "./i-http-client";
@@ -30,7 +31,21 @@ export declare class HttpResolver implements IHttpClient {
     newContext(op?: ClientOption): HttpResolverContext;
     get(url: string, op?: RequestOption & ClientOption & {
         redirectAsNewRequest?: boolean;
-    }): Promise<HttpResponse>;
-    post(url: string, payload: any, op?: RequestOption & ClientOption): Promise<HttpResponse>;
+        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<string>>;
+    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>>;
     private fixCmv;
 }

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

@@ -1,8 +1,15 @@
 /// <reference types="node" />
+/// <reference types="node" />
 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 {
@@ -20,16 +27,20 @@ export interface RequestOption {
      * timeout milliseconds to wait for socket inactivity. default is infinity.
      */
     timeout?: number;
+    /**
+     * type of response payload. default is string (utf-8).
+     */
+    responseType?: "string" | "buffer";
 }
-export interface HttpResponse {
+export interface HttpResponse<T = string | Buffer> {
     /**
      * http headers in the response.
      */
     headers?: IncomingHttpHeaders;
     /**
-     * string encoded by utf-8 as response payload.
+     * response payload which has a type depends on {@link RequestOption.responseType}.
      */
-    payload?: string;
+    payload?: T;
 }
 export interface IHttpClient {
     /**
@@ -41,12 +52,21 @@ export interface IHttpClient {
      * @param op.ignoreQuery {@link RequestOption.ignoreQuery}
      * @param op.downloadPath {@link RequestOption.downloadPath}
      * @param op.timeout {@link RequestOption.timeout}
+     * @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)
@@ -57,7 +77,14 @@ export interface IHttpClient {
      * @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 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.2",
+  "version": "1.0.4",
   "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",