xjs-common 9.1.6 → 10.0.0

package/README.md

@@ -1,14 +1,13 @@
 [![npm][npm-badge]][npm-url] [![CI][ci-badge]][ci-url]
 
 # Overview
-Library modules for nodejs + typescript that bundled general-purpose implementations.  
+Library modules for typescript that bundled general-purpose implementations.  
 This module is very simple, therefore it has no dependencies.
 
 # Install
 ```
 npm i xjs-common
 ```
-**NOTE**: The versions <= `v6.2.0` was unpublished. If you has been used these versions, please update to the version >= `v7.0.0`.
 
 # Code example (only part)
 ### Miscellaneous utilities.
@@ -22,8 +21,12 @@ import { checkPortAvailability, delay, int2array, UFile, UHttp, retry } from "xj
     // [ 0, 1, 2, 3, 4 ]
     console.log(int2array(5));
 
-    if (await checkPortAvailability(8080)) console.log("available.");
-    else console.log("not available.");
+    // runs callback with customizable retry.
+    retry(async () => { }, { count: 2 });
+
+    // utility types
+    let maybeArray: MaybeArray<number> = 0; // also number array is applicable.
+    let logger: Loggable = console; // object implements log/warn/error is applicable.
 
     // true
     console.log(UHttp.isHttpSuccess(204));
@@ -32,13 +35,6 @@ import { checkPortAvailability, delay, int2array, UFile, UHttp, retry } from "xj
     console.log(UHttp.concatParamsWithEncoding("https://aaa.com", { p1: "a", p2: ["1", "2"] }));
     // p1=a&p2=1&p2=2
     console.log(UHttp.concatParamsWithEncoding(null, { p1: "a", p2: ["1", "2"] }));
-
-    // runs callback with customizable retry.
-    retry(async () => { }, { count: 2 });
-
-    // concatenate file path and make directory if doesn't already exist.
-    UFile.mkdir("path/to/dir");
-    UFile.mkdir(["path", "to", "dir"]);
 })();
 ```
 ### Array utilities.
@@ -94,37 +90,6 @@ import { UString } from "xjs-common";
     console.log(UString.simpleTime({ date: getJSTDate(), unit: TimeUnit.Day }));
 })();
 ```
-### Enhanced http client.
-```ts
-import { HttpResolver, s_clientMode } from "xjs-common";
-
-(async () => {
-    // can customize logging. (default is console.)
-    // const http = new HttpResolver(chromeMajorVersion, logger);
-    const http = new HttpResolver();
-
-    // implicitly corresponds to cookies and redirect, and do randomization.
-    let res = await http.get("https://begyyal.net");
-    const { payload, headers } = res;
-
-    // use proxy by passing the configuration.
-    const proxy = { server: "proxy.sample.com", port: 8080, auth: { name: "prx", pass: "****" } }
-    res = await http.post("https://begyyal.net", { proxy });
-
-    // switch tls ciphers order pattern by passing clientMode. (default is random between chrome or firefox.)
-    res = await http.get("https://begyyal.net", { mode: s_clientMode.chrome });
-
-    // download a file when [Content-Disposition: attachment] exists in the response.
-    await http.get("https://begyyal.net/a.txt", { downloadPath: "/path/to/store" });
-
-    // if you want to keep some states of requests (and suppress to randomize), it can create new context to do.
-    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.
-    res = await context.post("https://begyyal.net/2", { a: "b" });
-})();
-```
 ### Mark method as transaction.  
 **NOTE**: this feature uses decorator, so requires `"experimentalDecorators": true` in tsconfig.
 ```ts
@@ -216,9 +181,7 @@ XJS throws error with `code` property which has one of the following numbers.
 |10|`func/u`|
 |20|`func/u-string`|
 |30|`func/u-type` (include `func/decorator/d-type`) |
-|40|`func/u-file` |
 |100|`func/decorator/transaction`|
-|200|`prcs/http/http-resolver`|
 
 # License
 [Apache-License](./LICENSE)

package/dist/func/u.d.ts

@@ -1,10 +1,9 @@
-import { Loggable, MaybeArray } from "../const/types";
+import { Loggable } from "../const/types";
 export declare function getJSTDate(d?: Date): Date;
 export declare function delay(sec: number): Promise<void>;
 export declare function int2array(size: number): number[];
 export declare function array2map<K, T>(array: T[], keyGen: (e: T) => K): Map<K, T[]>;
 export declare function bitor(...bit: number[]): number;
-export declare function checkPortAvailability(port: number): Promise<boolean>;
 export interface RetryOption<T = void | Promise<void>> {
     count?: number;
     logger?: Loggable;
@@ -23,4 +22,3 @@ export declare function retry<T>(cb: () => T, op?: RetryOption<void>): T;
 export declare function retry<T>(cb: () => T, op?: RetryOption<Promise<void>>): Promise<T>;
 export declare function retry<T>(cb: () => Promise<T>, op?: RetryOption<void>): Promise<T>;
 export declare function retry<T>(cb: () => Promise<T>, op?: RetryOption<Promise<void>>): Promise<T>;
-export declare function joinPath(...p: MaybeArray<string>[]): string;

package/dist/func/u.js

@@ -1,32 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.joinPath = exports.retry = exports.checkPortAvailability = exports.bitor = exports.array2map = exports.int2array = exports.delay = exports.getJSTDate = void 0;
-const path = __importStar(require("path"));
+exports.retry = exports.bitor = exports.array2map = exports.int2array = exports.delay = exports.getJSTDate = void 0;
 const xjs_err_1 = require("../obj/xjs-err");
-const u_type_1 = require("./u-type");
 const s_errCode = 10;
 function getJSTDate(d) {
     return new Date((d ? d.getTime() : Date.now()) + 9 * 60 * 60 * 1000);
@@ -59,15 +34,6 @@ function bitor(...bit) {
     return bit.reduce((a, b) => a | b);
 }
 exports.bitor = bitor;
-function checkPortAvailability(port) {
-    return new Promise(resolve => {
-        const server = require('net').createServer();
-        server.once('error', () => resolve(false))
-            .once('listening', () => { server.close(); resolve(true); })
-            .listen(port);
-    });
-}
-exports.checkPortAvailability = checkPortAvailability;
 ;
 function retry(cb, op) {
     const l = op?.logger ?? console;
@@ -108,7 +74,3 @@ function retry(cb, op) {
     return prcs(initialCount);
 }
 exports.retry = retry;
-function joinPath(...p) {
-    return path.join(...p.flatMap(u_type_1.UType.takeAsArray));
-}
-exports.joinPath = joinPath;

package/dist/index.d.ts

@@ -7,12 +7,8 @@ export * from "./func/u";
 export * from "./func/u-obj";
 export * from "./func/u-string";
 export * from "./func/u-array";
-export * from "./func/u-file";
 export * from "./func/u-http";
 export * from "./func/u-type";
 export * from "./func/decorator/transaction";
 export { DType } from "./func/decorator/d-type";
 export * from "./obj/xjs-err";
-export { HttpResolver } from "./prcs/http/http-resolver";
-export { s_clientMode } from "./prcs/http/http-resolver-context";
-export { IHttpClient } from "./prcs/http/i-http-client";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.s_clientMode = exports.HttpResolver = exports.DType = void 0;
+exports.DType = void 0;
 __exportStar(require("./const/types"), exports);
 __exportStar(require("./const/time-unit"), exports);
 __exportStar(require("./const/gender"), exports);
@@ -24,14 +24,9 @@ __exportStar(require("./func/u"), exports);
 __exportStar(require("./func/u-obj"), exports);
 __exportStar(require("./func/u-string"), exports);
 __exportStar(require("./func/u-array"), exports);
-__exportStar(require("./func/u-file"), exports);
 __exportStar(require("./func/u-http"), exports);
 __exportStar(require("./func/u-type"), exports);
 __exportStar(require("./func/decorator/transaction"), exports);
 var d_type_1 = require("./func/decorator/d-type");
 Object.defineProperty(exports, "DType", { enumerable: true, get: function () { return d_type_1.DType; } });
 __exportStar(require("./obj/xjs-err"), exports);
-var http_resolver_1 = require("./prcs/http/http-resolver");
-Object.defineProperty(exports, "HttpResolver", { enumerable: true, get: function () { return http_resolver_1.HttpResolver; } });
-var http_resolver_context_1 = require("./prcs/http/http-resolver-context");
-Object.defineProperty(exports, "s_clientMode", { enumerable: true, get: function () { return http_resolver_context_1.s_clientMode; } });

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

@@ -1,7 +1,19 @@
-import { ClientMode } from "./http-resolver";
 import { ClientOption, HttpResponse, IHttpClient, RequestOption } from "./i-http-client";
 import { Loggable } from "../../const/types";
-export declare const s_clientMode: Record<string, ClientMode>;
+export declare const s_clientMode: {
+    nodejs: {
+        id: number;
+        cipherOrder: any;
+    };
+    chrome: {
+        id: number;
+        cipherOrder: number[];
+    };
+    firefox: {
+        id: number;
+        cipherOrder: number[];
+    };
+};
 export declare class HttpResolverContext implements IHttpClient {
     readonly cmv: number;
     private _l;

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

@@ -96,10 +96,11 @@ class HttpResolverContext {
         this.cmv = cmv;
         this._l = _l;
         this._mode = op?.mode ?? u_array_1.UArray.randomPick([exports.s_clientMode.chrome, exports.s_clientMode.firefox]);
-        if (this._mode.id > 0)
-            this._ciphers = this.createCiphers(this._mode);
         this._proxyConfig = op?.proxy;
-        this._chHeaders = s_mode2headers.get(this._mode)(this.cmv);
+        if (this._mode.id > 0) {
+            this._ciphers = this.createCiphers(this._mode);
+            this._chHeaders = s_mode2headers.get(this._mode)(this.cmv);
+        }
     }
     /**
      * request GET to the url.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "xjs-common",
-  "version": "9.1.6",
-  "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
+  "version": "10.0.0",
+  "description": "library modules for typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",
     "url": "https://github.com/begyyal/xjs_commons"
   },
   "keywords": [
-    "nodejs",
+    "javascript",
     "typescript",
     "utility"
   ],
@@ -24,8 +24,7 @@
   "main": "./dist/index",
   "types": "./dist/index.d.ts",
   "devDependencies": {
-    "@types/node": "^20.3.1",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5"
   }
-}
+}