@aitianyu.cn/types 0.0.12 → 0.1.0

package/dist/types/types/Object.d.ts

@@ -1,18 +1,18 @@
-/**@format */
-import { TMap } from "./TMap";
-import { PathBase } from "./PathBase";
-/** Tianyu Object calculated different item */
-export interface IObjectDiffInfo {
-    /** different item path */
-    path: string;
-    /** the old value of this path */
-    old: any;
-    /** the new value of this path */
-    new: any;
-    /** does the change be deletion */
-    deleted?: true;
-    /** does the change be adding */
-    added?: true;
-}
-/** Different items map */
-export type ObjectDiffMap = TMap<PathBase, IObjectDiffInfo>;
+/**@format */
+import { TMap } from "./TMap";
+import { PathBase } from "./PathBase";
+/** Tianyu Object calculated different item */
+export interface IObjectDiffInfo {
+    /** different item path */
+    path: string;
+    /** the old value of this path */
+    old: any;
+    /** the new value of this path */
+    new: any;
+    /** does the change be deletion */
+    deleted?: true;
+    /** does the change be adding */
+    added?: true;
+}
+/** Different items map */
+export type ObjectDiffMap = TMap<PathBase, IObjectDiffInfo>;

package/dist/types/types/PathBase.d.ts

@@ -1,76 +1,76 @@
-/**@format */
-import { IComparable } from "./Types";
-/** Path base class */
-export declare class PathBase implements IComparable {
-    protected _dirs: string[];
-    /**
-     * Create a Path instance by specified dirs
-     *
-     * @param dirs the specified directories
-     */
-    constructor(dirs?: string[]);
-    /**
-     * Convert the path instance to string
-     *
-     * @returns return the fromatted string
-     */
-    toString(): string;
-    /**
-     * Iterator of path directories
-     *
-     * @returns return an iterator
-     */
-    [Symbol.iterator](): {
-        next: () => {
-            done: boolean;
-            value: string;
-        };
-    };
-    /**
-     * Get a directories array deep copy
-     *
-     * @returns return directories
-     */
-    getDirs(): string[];
-    /**
-     * Get a number that indicates the directories count
-     *
-     * @returns return the directories count
-     */
-    length(): number;
-    /**
-     * Append a new directory to the end of path
-     *
-     * @param dir the new directory name
-     * @returns return the new directories count
-     */
-    append(dir: string): number;
-    /**
-     * Clean all the pathes
-     */
-    clear(): void;
-    /**
-     * Remove the end directory of the path instance and return it
-     *
-     * @returns return the end of directory
-     */
-    pop(): string | undefined;
-    /**
-     * Remove the first directory of the path instance and return it
-     *
-     * @returns return the first directory
-     */
-    shift(): string | undefined;
-    /**
-     * Convert the path instance to string for object comparing
-     *
-     * @returns return the comparable string
-     */
-    getString(): string;
-    /**
-     * Get the hashcode of current path
-     *
-     * @returns always return 0
-     */
-    getHashCode(): number;
-}
+/**@format */
+import { IComparable } from "./Types";
+/** Path base class */
+export declare class PathBase implements IComparable {
+    protected _dirs: string[];
+    /**
+     * Create a Path instance by specified dirs
+     *
+     * @param dirs the specified directories
+     */
+    constructor(dirs?: string[]);
+    /**
+     * Convert the path instance to string
+     *
+     * @returns return the fromatted string
+     */
+    toString(): string;
+    /**
+     * Iterator of path directories
+     *
+     * @returns return an iterator
+     */
+    [Symbol.iterator](): {
+        next: () => {
+            done: boolean;
+            value: string;
+        };
+    };
+    /**
+     * Get a directories array deep copy
+     *
+     * @returns return directories
+     */
+    getDirs(): string[];
+    /**
+     * Get a number that indicates the directories count
+     *
+     * @returns return the directories count
+     */
+    length(): number;
+    /**
+     * Append a new directory to the end of path
+     *
+     * @param dir the new directory name
+     * @returns return the new directories count
+     */
+    append(dir: string): number;
+    /**
+     * Clean all the pathes
+     */
+    clear(): void;
+    /**
+     * Remove the end directory of the path instance and return it
+     *
+     * @returns return the end of directory
+     */
+    pop(): string | undefined;
+    /**
+     * Remove the first directory of the path instance and return it
+     *
+     * @returns return the first directory
+     */
+    shift(): string | undefined;
+    /**
+     * Convert the path instance to string for object comparing
+     *
+     * @returns return the comparable string
+     */
+    getString(): string;
+    /**
+     * Get the hashcode of current path
+     *
+     * @returns always return 0
+     */
+    getHashCode(): number;
+}

package/dist/types/types/Security.d.ts

@@ -1,23 +1,23 @@
-/**@format */
-/** Encrypt Option Type */
-export declare enum EncryptOption {
-    Encryption = 0,
-    Decryption = 1
-}
-/** An Interface of the Cipher */
-export interface ICipher {
-    /**
-     * To encode the source value
-     *
-     * @param source the source value
-     * @returns return the encoded value
-     */
-    encryption(source: number[]): number[];
-    /**
-     * To decode the encoded value
-     *
-     * @param source the encoded value
-     * @returns return the decoded value
-     */
-    decryption(source: number[]): number[];
-}
+/**@format */
+/** Encrypt Option Type */
+export declare enum EncryptOption {
+    Encryption = 0,
+    Decryption = 1
+}
+/** An Interface of the Cipher */
+export interface ICipher {
+    /**
+     * To encode the source value
+     *
+     * @param source the source value
+     * @returns return the encoded value
+     */
+    encryption(source: number[]): number[];
+    /**
+     * To decode the encoded value
+     *
+     * @param source the encoded value
+     * @returns return the decoded value
+     */
+    decryption(source: number[]): number[];
+}

package/dist/types/types/TMap.d.ts

@@ -1,80 +1,80 @@
-/**@format */
-import { IComparable } from "./Types";
-/**
- * Tianyu Map
- * Support Customized Object type
- */
-export declare class TMap<K extends IComparable, V> {
-    private _map;
-    private _kMap;
-    /**
-     * Create an empty Tianyu Map Instance
-     */
-    constructor();
-    /**
-     * Clean the Map instance
-     */
-    clear(): void;
-    /**
-     * Delete a specified item from the instance
-     *
-     * @param key The key of the item
-     * @returns return true if deleted successful and return false if failed
-     */
-    delete(key: K): boolean;
-    /**
-     * Executes a provided function once per each key/value pair in the Map, in insertion order.
-     *
-     * @param callbackfn provided execution function
-     * @param thisArg additional args
-     */
-    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
-    /**
-     * Returns a specified element from the Map object. If the value that is associated to the provided key is an object,
-     * then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
-     *
-     * @param key The key of the value
-     * @returns Returns the element associated with the specified key.
-     *          If no element is associated with the specified key, undefined is returned.
-     */
-    get(key: K): V | undefined;
-    /**
-     * Get a boolean value indicates whether an element with the specified key exists or not.
-     *
-     * @param key The key what wants to search
-     * @returns return true if the value is found
-     */
-    has(key: K): boolean;
-    /**
-     * Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
-     *
-     * @param key The key of new element
-     * @param value The value of new element
-     * @returns return the instance that is current instance
-     */
-    set(key: K, value: V): this;
-    /**
-     * Get a number of elements in the Map
-     *
-     * @returns return the count of elements
-     */
-    size(): number;
-    /**
-     * Get all keys of the Map
-     *
-     * @returns return a keys iterator
-     */
-    keys(): IterableIterator<K>;
-    /**
-     * Get all values of the Map
-     *
-     * @returns return a values iterator
-     */
-    values(): IterableIterator<V>;
-    /**
-     * Get an Iterator of the Map
-     *
-     * @returns return an iterator object
-     */
-    [Symbol.iterator](): Iterator<[K | undefined, V | undefined]>;
-}
+/**@format */
+import { IComparable } from "./Types";
+/**
+ * Tianyu Map
+ * Support Customized Object type
+ */
+export declare class TMap<K extends IComparable, V> {
+    private _map;
+    private _kMap;
+    /**
+     * Create an empty Tianyu Map Instance
+     */
+    constructor();
+    /**
+     * Clean the Map instance
+     */
+    clear(): void;
+    /**
+     * Delete a specified item from the instance
+     *
+     * @param key The key of the item
+     * @returns return true if deleted successful and return false if failed
+     */
+    delete(key: K): boolean;
+    /**
+     * Executes a provided function once per each key/value pair in the Map, in insertion order.
+     *
+     * @param callbackfn provided execution function
+     * @param thisArg additional args
+     */
+    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
+    /**
+     * Returns a specified element from the Map object. If the value that is associated to the provided key is an object,
+     * then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
+     *
+     * @param key The key of the value
+     * @returns Returns the element associated with the specified key.
+     *          If no element is associated with the specified key, undefined is returned.
+     */
+    get(key: K): V | undefined;
+    /**
+     * Get a boolean value indicates whether an element with the specified key exists or not.
+     *
+     * @param key The key what wants to search
+     * @returns return true if the value is found
+     */
+    has(key: K): boolean;
+    /**
+     * Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
+     *
+     * @param key The key of new element
+     * @param value The value of new element
+     * @returns return the instance that is current instance
+     */
+    set(key: K, value: V): this;
+    /**
+     * Get a number of elements in the Map
+     *
+     * @returns return the count of elements
+     */
+    size(): number;
+    /**
+     * Get all keys of the Map
+     *
+     * @returns return a keys iterator
+     */
+    keys(): IterableIterator<K>;
+    /**
+     * Get all values of the Map
+     *
+     * @returns return a values iterator
+     */
+    values(): IterableIterator<V>;
+    /**
+     * Get an Iterator of the Map
+     *
+     * @returns return an iterator object
+     */
+    [Symbol.iterator](): Iterator<[K | undefined, V | undefined]>;
+}

package/dist/types/types/Types.d.ts

@@ -1,25 +1,25 @@
-/**@format */
-/**A record object type of boolean */
-export type MapOfBoolean = Record<string, boolean>;
-/**A record object type of string array */
-export type MapOfStrings = Record<string, string[]>;
-/**A record object type of string */
-export type MapOfString = Record<string, string>;
-/**A record object type of customized */
-export type MapOfType<T> = Record<string, T>;
-/** no parameter call back function */
-export type CallbackAction = () => void;
-/** call back function with customized type parameter */
-export type CallbackActionT<T> = (value: T) => void;
-/** A key value pair to include a key and a value */
-export type KeyValuePair<K, V> = {
-    key: K;
-    value: V;
-};
-/** Tianyu Comparable Interface */
-export interface IComparable {
-    /** Get a string what can indicate the object unified */
-    getString(): string;
-    /** Get a number which is the hash value of the object instance */
-    getHashCode(): number;
-}
+/**@format */
+/**A record object type of boolean */
+export type MapOfBoolean = Record<string, boolean>;
+/**A record object type of string array */
+export type MapOfStrings = Record<string, string[]>;
+/**A record object type of string */
+export type MapOfString = Record<string, string>;
+/**A record object type of customized */
+export type MapOfType<T> = Record<string, T>;
+/** no parameter call back function */
+export type CallbackAction = () => void;
+/** call back function with customized type parameter */
+export type CallbackActionT<T> = (value: T) => void;
+/** A key value pair to include a key and a value */
+export interface KeyValuePair<K, V> {
+    key: K;
+    value: V;
+}
+/** Tianyu Comparable Interface */
+export interface IComparable {
+    /** Get a string what can indicate the object unified */
+    getString(): string;
+    /** Get a number which is the hash value of the object instance */
+    getHashCode(): number;
+}

package/dist/types/types/index.d.ts

@@ -1,9 +1,9 @@
-/**@format */
-export { AreaCode } from "./AreaCode";
-export { Exception } from "./Exception";
-export { LogLevel, type ILog, type IPerfRecorder } from "./Logs";
-export { type IObjectDiffInfo, type ObjectDiffMap } from "./Object";
-export { PathBase } from "./PathBase";
-export { EncryptOption, type ICipher } from "./Security";
-export { TMap } from "./TMap";
-export { type MapOfBoolean, type MapOfStrings, type MapOfString, type MapOfType, type CallbackAction, type CallbackActionT, type IComparable, } from "./Types";
+/**@format */
+export { AreaCode } from "./AreaCode";
+export { Exception } from "./Exception";
+export { LogLevel, type ILog, type IPerfRecorder } from "./Logs";
+export { type IObjectDiffInfo, type ObjectDiffMap } from "./Object";
+export { PathBase } from "./PathBase";
+export { EncryptOption, type ICipher } from "./Security";
+export { TMap } from "./TMap";
+export { type MapOfBoolean, type MapOfStrings, type MapOfString, type MapOfType, type CallbackAction, type CallbackActionT, type IComparable, } from "./Types";

package/package.json

@@ -1,51 +1,57 @@
-{
-    "name": "@aitianyu.cn/types",
-    "version": "0.0.12",
-    "private": false,
-    "description": "Common modules (types, functions, classes) for aitianyu",
-    "main": "./dist/lib/index.js",
-    "types": "./dist/types/index.d.ts",
-    "exports": {
-        ".": "./dist/lib/index.js",
-        "./types": "./dist/lib/types/index.js",
-        "./coding": "./dist/lib/utilities/coding/index.js",
-        "./core": "./dist/lib/utilities/core/index.js",
-        "./security": "./dist/lib/utilities/security/index.js"
-    },
-    "files": [
-        "dist"
-    ],
-    "type": "commonjs",
-    "keywords": [
-        "aitianyu.cn",
-        "base type",
-        "common lib"
-    ],
-    "scripts": {
-        "start": "ts-node packages/index.ts",
-        "build": "npm run before-build && npm run compiler && npm run copy-lib && npm run copy-types && npm run after-build",
-        "compiler": "tsc && tsc-alias",
-        "copy-lib": "copyfiles -u 2 \"build/src/**/*.js\" \"dist/lib\"",
-        "copy-types": "copyfiles -u 2 \"build/src/**/*.d.ts\" \"dist/types\"",
-        "before-build": "rimraf ./dist ./build",
-        "after-build": "rimraf ./build",
-        "test": "jest --no-cache --verbose",
-        "test-all": "jest --no-cache --verbose --coverage",
-        "test-coverage": "jest --no-cache --coverage"
-    },
-    "author": "dev@aitianyu.cn",
-    "license": "ISC",
-    "devDependencies": {
-        "@types/jest": "^29.2.4",
-        "@types/node": "^18.11.15",
-        "copyfiles": "^2.4.1",
-        "jest": "^29.3.1",
-        "jest-html-reporters": "^3.0.11",
-        "perf_hooks": "0.0.1",
-        "rimraf": "^3.0.2",
-        "ts-jest": "^29.0.3",
-        "ts-node": "^10.9.1",
-        "tsc-alias": "^1.8.2",
-        "typescript": "^4.9.3"
-    }
-}
+{
+    "name": "@aitianyu.cn/types",
+    "version": "0.1.0",
+    "private": false,
+    "description": "Common modules (types, functions, classes) for aitianyu",
+    "main": "./dist/lib/index.js",
+    "types": "./dist/types/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "type": "commonjs",
+    "keywords": [
+        "aitianyu.cn",
+        "base type",
+        "common lib"
+    ],
+    "scripts": {
+        "start": "ts-node packages/index.ts",
+        "build": "eslint \"./\" --quiet && npm run before-build && npm run compiler && npm run copy-lib && npm run copy-types && npm run after-build",
+        "compiler": "tsc && tsc-alias",
+        "copy-lib": "copyfiles -u 2 \"build/src/**/*.js\" \"dist/lib\"",
+        "copy-types": "copyfiles -u 2 \"build/src/**/*.d.ts\" \"dist/types\"",
+        "before-build": "rimraf ./dist ./build",
+        "after-build": "rimraf ./build",
+        "test": "jest --no-cache --verbose",
+        "test-all": "jest --no-cache --verbose --coverage && npm run eslint-report",
+        "test-coverage": "jest --no-cache --coverage",
+        "eslint": "eslint . --format json --output-file \"./test/__report__/eslint/eslint-report.json\"",
+        "eslint-report": "eslint . --format html --output-file \"./test/__report__/eslint/eslint-report.html\""
+    },
+    "author": "dev@aitianyu.cn",
+    "license": "ISC",
+    "devDependencies": {
+        "@eslint/compat": "^1.3.1",
+        "@stylistic/eslint-plugin": "^5.2.2",
+        "@types/jest": "^29.2.4",
+        "@types/node": "^18.11.15",
+        "@types/qrcode": "^1.5.5",
+        "@typescript-eslint/eslint-plugin": "^8.38.0",
+        "copyfiles": "^2.4.1",
+        "eslint": "^9.32.0",
+        "eslint-plugin-import": "^2.32.0",
+        "jest": "^29.3.1",
+        "jest-html-reporters": "^3.0.11",
+        "jiti": "^2.5.1",
+        "perf_hooks": "0.0.1",
+        "rimraf": "^3.0.2",
+        "ts-jest": "^29.0.3",
+        "ts-node": "^10.9.1",
+        "tsc-alias": "^1.8.2",
+        "typescript": "^4.9.3",
+        "typescript-eslint": "^8.38.0"
+    },
+    "dependencies": {
+        "qrcode": "^1.5.4"
+    }
+}

package/dist/lib/utilities/coding/index.js

@@ -1,10 +0,0 @@
-"use strict";
-/**@format */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Path = exports.PathDirAndFileConvertInvaild = exports.PathDirectoryValidationFailException = exports.PathProcessorSourceLostException = void 0;
-var Error_1 = require("./Error");
-Object.defineProperty(exports, "PathProcessorSourceLostException", { enumerable: true, get: function () { return Error_1.PathProcessorSourceLostException; } });
-Object.defineProperty(exports, "PathDirectoryValidationFailException", { enumerable: true, get: function () { return Error_1.PathDirectoryValidationFailException; } });
-Object.defineProperty(exports, "PathDirAndFileConvertInvaild", { enumerable: true, get: function () { return Error_1.PathDirAndFileConvertInvaild; } });
-var Path_1 = require("./Path");
-Object.defineProperty(exports, "Path", { enumerable: true, get: function () { return Path_1.Path; } });

package/dist/lib/utilities/core/index.js

@@ -1,21 +0,0 @@
-"use strict";
-/**@format */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectHelper = exports.ObjectCalculater = exports.Performance = exports.Log = exports.parseAreaString = exports.parseAreaCode = exports.ObjectDiffMergeFailedException = exports.ObjectDiffApplyInvalidStatusException = exports.ObjectMergeStatusCheckFailedException = exports.ObjectCloneFunctionNotSupportException = exports.ArgumentNullOrEmptyException = void 0;
-var Errors_1 = require("./Errors");
-Object.defineProperty(exports, "ArgumentNullOrEmptyException", { enumerable: true, get: function () { return Errors_1.ArgumentNullOrEmptyException; } });
-Object.defineProperty(exports, "ObjectCloneFunctionNotSupportException", { enumerable: true, get: function () { return Errors_1.ObjectCloneFunctionNotSupportException; } });
-Object.defineProperty(exports, "ObjectMergeStatusCheckFailedException", { enumerable: true, get: function () { return Errors_1.ObjectMergeStatusCheckFailedException; } });
-Object.defineProperty(exports, "ObjectDiffApplyInvalidStatusException", { enumerable: true, get: function () { return Errors_1.ObjectDiffApplyInvalidStatusException; } });
-Object.defineProperty(exports, "ObjectDiffMergeFailedException", { enumerable: true, get: function () { return Errors_1.ObjectDiffMergeFailedException; } });
-var Language_1 = require("./Language");
-Object.defineProperty(exports, "parseAreaCode", { enumerable: true, get: function () { return Language_1.parseAreaCode; } });
-Object.defineProperty(exports, "parseAreaString", { enumerable: true, get: function () { return Language_1.parseAreaString; } });
-var Log_1 = require("./Log");
-Object.defineProperty(exports, "Log", { enumerable: true, get: function () { return Log_1.Log; } });
-Object.defineProperty(exports, "Performance", { enumerable: true, get: function () { return Log_1.Performance; } });
-//// object
-var Calculater_1 = require("./object/Calculater");
-Object.defineProperty(exports, "ObjectCalculater", { enumerable: true, get: function () { return Calculater_1.ObjectCalculater; } });
-var Helper_1 = require("./object/Helper");
-Object.defineProperty(exports, "ObjectHelper", { enumerable: true, get: function () { return Helper_1.ObjectHelper; } });

package/dist/lib/utilities/core/object/StringHelper.js

@@ -1,22 +0,0 @@
-"use strict";
-/**@format */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringHelper = void 0;
-class StringHelper {
-    static format(source, args) {
-        if (!args) {
-            return source;
-        }
-        const argument = Array.isArray(args) ? args : [args];
-        return source.replace(/('')|\{([0-9]+(?:\s*,[^{}]*)?)\}|[{}]/g, (_match, $1, $2, _$3) => {
-            if ($1) {
-                return "'";
-            }
-            else if ($2) {
-                return String(argument[parseInt($2, 10)]);
-            }
-            return "";
-        });
-    }
-}
-exports.StringHelper = StringHelper;