@aitianyu.cn/types 0.0.1 → 0.0.3

package/dist/lib/index.js

@@ -1,23 +1,47 @@
 "use strict";
 /**@format */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hash = exports.guid = exports.Performance = exports.Log = exports.parseAreaString = exports.parseAreaCode = exports.ArgumentNullOrEmptyException = exports.EncryptOption = exports.LogLevel = exports.Exception = exports.AreaCode = void 0;
+exports.hash = exports.guid = exports.ObjectHelper = exports.ObjectCalculater = exports.Performance = exports.Log = exports.parseAreaString = exports.parseAreaCode = exports.ObjectDiffMergeFailedException = exports.ObjectDiffApplyInvalidStatusException = exports.ObjectMergeStatusCheckFailedException = exports.ObjectCloneFunctionNotSupportException = exports.ArgumentNullOrEmptyException = exports.Path = exports.PathDirAndFileConvertInvaild = exports.PathDirectoryValidationFailException = exports.PathProcessorSourceLostException = exports.TMap = exports.EncryptOption = exports.PathBase = exports.LogLevel = exports.Exception = exports.AreaCode = void 0;
+// src/types
 var AreaCode_1 = require("./types/AreaCode");
 Object.defineProperty(exports, "AreaCode", { enumerable: true, get: function () { return AreaCode_1.AreaCode; } });
 var Exception_1 = require("./types/Exception");
 Object.defineProperty(exports, "Exception", { enumerable: true, get: function () { return Exception_1.Exception; } });
 var Logs_1 = require("./types/Logs");
 Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return Logs_1.LogLevel; } });
+var PathBase_1 = require("./types/PathBase");
+Object.defineProperty(exports, "PathBase", { enumerable: true, get: function () { return PathBase_1.PathBase; } });
 var Security_1 = require("./types/Security");
 Object.defineProperty(exports, "EncryptOption", { enumerable: true, get: function () { return Security_1.EncryptOption; } });
+var TMap_1 = require("./types/TMap");
+Object.defineProperty(exports, "TMap", { enumerable: true, get: function () { return TMap_1.TMap; } });
+// utilities
+// coding
+var Error_1 = require("./utilities/coding/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("./utilities/coding/Path");
+Object.defineProperty(exports, "Path", { enumerable: true, get: function () { return Path_1.Path; } });
+// core
 var Errors_1 = require("./utilities/core/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("./utilities/core/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("./utilities/core/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("./utilities/core/object/Calculater");
+Object.defineProperty(exports, "ObjectCalculater", { enumerable: true, get: function () { return Calculater_1.ObjectCalculater; } });
+var Helper_1 = require("./utilities/core/object/Helper");
+Object.defineProperty(exports, "ObjectHelper", { enumerable: true, get: function () { return Helper_1.ObjectHelper; } });
+// security
 var Guid_1 = require("./utilities/security/Guid");
 Object.defineProperty(exports, "guid", { enumerable: true, get: function () { return Guid_1.guid; } });
 var Hash_1 = require("./utilities/security/Hash");

package/dist/lib/types/AreaCode.js

@@ -2,6 +2,7 @@
 /**@format */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AreaCode = void 0;
+/** International Area name and its code */
 var AreaCode;
 (function (AreaCode) {
     AreaCode[AreaCode["unknown"] = 0] = "unknown";

package/dist/lib/types/Exception.js

@@ -2,10 +2,16 @@
 /**@format */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Exception = void 0;
+/** Exception base class */
 class Exception extends Error {
     constructor(msg, options) {
         super(msg, options);
     }
+    /**
+     * Get a string of the Exception object
+     *
+     * @returns return an error message
+     */
     toString() {
         return this.message;
     }

package/dist/lib/types/Logs.js

@@ -2,12 +2,19 @@
 /**@format */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogLevel = void 0;
+/** Tianyu Log Level */
 var LogLevel;
 (function (LogLevel) {
+    /** Debug mode log */
     LogLevel[LogLevel["DEBUG"] = 0] = "DEBUG";
+    /** error msg */
     LogLevel[LogLevel["ERROR"] = 1] = "ERROR";
+    /** fatal error msg */
     LogLevel[LogLevel["FATAL"] = 2] = "FATAL";
+    /** info log */
     LogLevel[LogLevel["INFO"] = 3] = "INFO";
+    /** warning log */
     LogLevel[LogLevel["WARNING"] = 4] = "WARNING";
+    /** default log */
     LogLevel[LogLevel["LOG"] = 5] = "LOG";
 })(LogLevel = exports.LogLevel || (exports.LogLevel = {}));

package/dist/lib/types/Object.js

@@ -0,0 +1,3 @@
+"use strict";
+/**@format */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types/PathBase.js

@@ -0,0 +1,109 @@
+"use strict";
+/**@format */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathBase = void 0;
+/** Path base class */
+class PathBase {
+    _dirs;
+    /**
+     * Create a Path instance by specified dirs
+     *
+     * @param dirs the specified directories
+     */
+    constructor(dirs) {
+        this._dirs = (dirs && [...dirs]) || [];
+    }
+    /**
+     * Convert the path instance to string
+     *
+     * @returns return the fromatted string
+     */
+    toString() {
+        if (0 === this._dirs.length) {
+            return "";
+        }
+        return this._dirs.join("/");
+    }
+    /**
+     * Iterator of path directories
+     *
+     * @returns return an iterator
+     */
+    [Symbol.iterator]() {
+        let index = 0;
+        return {
+            next: () => {
+                if (index < this._dirs.length) {
+                    return { done: false, value: this._dirs[index++] };
+                }
+                else {
+                    return { done: true, value: "" };
+                }
+            },
+        };
+    }
+    /**
+     * Get a directories array deep copy
+     *
+     * @returns return directories
+     */
+    getDirs() {
+        return this._dirs.concat();
+    }
+    /**
+     * Get a number that indicates the directories count
+     *
+     * @returns return the directories count
+     */
+    length() {
+        return this._dirs.length;
+    }
+    /**
+     * Append a new directory to the end of path
+     *
+     * @param dir the new directory name
+     * @returns return the new directories count
+     */
+    append(dir) {
+        return this._dirs.push(dir);
+    }
+    /**
+     * Clean all the pathes
+     */
+    clear() {
+        this._dirs = [];
+    }
+    /**
+     * Remove the end directory of the path instance and return it
+     *
+     * @returns return the end of directory
+     */
+    pop() {
+        return this._dirs.pop();
+    }
+    /**
+     * Remove the first directory of the path instance and return it
+     *
+     * @returns return the first directory
+     */
+    shift() {
+        return this._dirs.shift();
+    }
+    /**
+     * Convert the path instance to string for object comparing
+     *
+     * @returns return the comparable string
+     */
+    getString() {
+        return this.toString();
+    }
+    /**
+     * Get the hashcode of current path
+     *
+     * @returns always return 0
+     */
+    getHashCode() {
+        return 0;
+    }
+}
+exports.PathBase = PathBase;

package/dist/lib/types/Security.js

@@ -2,6 +2,7 @@
 /**@format */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EncryptOption = void 0;
+/** Encrypt Option Type */
 var EncryptOption;
 (function (EncryptOption) {
     EncryptOption[EncryptOption["Encryption"] = 0] = "Encryption";

package/dist/lib/types/TMap.js

@@ -0,0 +1,138 @@
+"use strict";
+/**@format */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TMap = void 0;
+/**
+ * Tianyu Map
+ * Support Customized Object type
+ */
+class TMap {
+    _map;
+    _kMap;
+    /**
+     * Create an empty Tianyu Map Instance
+     */
+    constructor() {
+        this._map = new Map();
+        this._kMap = new Map();
+    }
+    /**
+     * Clean the Map instance
+     */
+    clear() {
+        this._map.clear();
+        this._kMap.clear();
+    }
+    /**
+     * 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) {
+        const keyString = key.getString();
+        return this._map.delete(keyString) && this._kMap.delete(keyString);
+    }
+    /**
+     * 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, thisArg) {
+        const runMap = new Map();
+        this._map.forEach((value, key, map) => {
+            const keyObj = this._kMap.get(key);
+            if (!!!keyObj) {
+                return;
+            }
+            runMap.set(keyObj, value);
+            callbackfn(value, keyObj, runMap);
+        }, thisArg);
+    }
+    /**
+     * 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) {
+        const keyString = key.getString();
+        return this._map.get(keyString);
+    }
+    /**
+     * 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) {
+        const keyString = key.getString();
+        return this._kMap.has(keyString);
+    }
+    /**
+     * 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, value) {
+        const keyString = key.getString();
+        this._map.set(keyString, value);
+        this._kMap.set(keyString, key);
+        return this;
+    }
+    /**
+     * Get a number of elements in the Map
+     *
+     * @returns return the count of elements
+     */
+    size() {
+        return this._kMap.size;
+    }
+    /**
+     * Get all keys of the Map
+     *
+     * @returns return a keys iterator
+     */
+    keys() {
+        return this._kMap.values();
+    }
+    /**
+     * Get all values of the Map
+     *
+     * @returns return a values iterator
+     */
+    values() {
+        return this._map.values();
+    }
+    /**
+     * Get an Iterator of the Map
+     *
+     * @returns return an iterator object
+     */
+    [Symbol.iterator]() {
+        const keys = this._map.entries();
+        const iteratorObj = {
+            next: () => {
+                const keyNext = keys.next();
+                if (keyNext.done) {
+                    return {
+                        done: true,
+                        value: [undefined, undefined],
+                    };
+                }
+                const value = [this._kMap.get(keyNext.value[0]), keyNext.value[1]];
+                return {
+                    done: false,
+                    value: value,
+                };
+            },
+        };
+        return iteratorObj;
+    }
+}
+exports.TMap = TMap;

package/dist/lib/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/**@format */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TMap = exports.EncryptOption = exports.PathBase = exports.LogLevel = exports.Exception = exports.AreaCode = void 0;
+// src
+var AreaCode_1 = require("./AreaCode");
+Object.defineProperty(exports, "AreaCode", { enumerable: true, get: function () { return AreaCode_1.AreaCode; } });
+var Exception_1 = require("./Exception");
+Object.defineProperty(exports, "Exception", { enumerable: true, get: function () { return Exception_1.Exception; } });
+var Logs_1 = require("./Logs");
+Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return Logs_1.LogLevel; } });
+var PathBase_1 = require("./PathBase");
+Object.defineProperty(exports, "PathBase", { enumerable: true, get: function () { return PathBase_1.PathBase; } });
+var Security_1 = require("./Security");
+Object.defineProperty(exports, "EncryptOption", { enumerable: true, get: function () { return Security_1.EncryptOption; } });
+var TMap_1 = require("./TMap");
+Object.defineProperty(exports, "TMap", { enumerable: true, get: function () { return TMap_1.TMap; } });

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

@@ -0,0 +1,44 @@
+"use strict";
+/**@format */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathDirAndFileConvertInvaild = exports.PathDirectoryValidationFailException = exports.PathProcessorSourceLostException = void 0;
+const Exception_1 = require("../../types/Exception");
+/**
+ * Source lost exception of Path Processor.
+ * Exception will be thrown if the path is file but the file field is not specified
+ */
+class PathProcessorSourceLostException extends Exception_1.Exception {
+    constructor(msg) {
+        super(msg);
+    }
+    toString() {
+        return `路径处理器 - 指定的参数 ( path.file ) 为空`;
+    }
+}
+exports.PathProcessorSourceLostException = PathProcessorSourceLostException;
+/**
+ * Path directory name is not valid.
+ * Exception will be thrown if the path name has the invalid char
+ */
+class PathDirectoryValidationFailException extends Exception_1.Exception {
+    constructor(msg) {
+        super(msg);
+    }
+    toString() {
+        return `路径处理器 - 指定的路径目录 ( ${this.message} ) 无效`;
+    }
+}
+exports.PathDirectoryValidationFailException = PathDirectoryValidationFailException;
+/**
+ * Path is file or directory but target type is not.
+ * Exception will be thrown if the path is file(directory) but try to convert to directory(file)
+ */
+class PathDirAndFileConvertInvaild extends Exception_1.Exception {
+    constructor(path, type) {
+        super(`${path} 为 ${type === "directory" ? "目录" : "文件"}`);
+    }
+    toString() {
+        return `路径处理器 - 不能将文件与目录相互转换 ( ${this.message} ) `;
+    }
+}
+exports.PathDirAndFileConvertInvaild = PathDirAndFileConvertInvaild;

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

@@ -0,0 +1,198 @@
+"use strict";
+/**@format */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Path = void 0;
+const PathBase_1 = require("../../types/PathBase");
+const Error_1 = require("./Error");
+const __charInDirValidation = {
+    "/": { file: false, dir: false },
+    ".": { file: true, dir: false },
+};
+function _dirNameChecker(dir) {
+    if (!dir)
+        return "drop";
+    for (const ch of dir) {
+        const validation = __charInDirValidation[ch];
+        if (validation && !validation.dir) {
+            return "invalid";
+        }
+    }
+    return "valid";
+}
+function _dirFileTypeChecker(src) {
+    if (!src)
+        return "drop";
+    let dirType = false;
+    let fileType = false;
+    for (const char of src) {
+        const validation = __charInDirValidation[char];
+        if (dirType) {
+            if (validation && !validation.dir)
+                return "invalid";
+        }
+        else if (fileType) {
+            if (validation && !validation.file)
+                return "invalid";
+        }
+        else {
+            if (validation) {
+                if (validation.dir && !validation.file)
+                    dirType = true;
+                else if (!validation.dir && validation.file)
+                    fileType = true;
+                else if (!validation.dir && !validation.file)
+                    return "invalid";
+            }
+        }
+    }
+    if ((!dirType && !fileType) || dirType)
+        return "directory";
+    else
+        return "file";
+}
+function _parsePathFromString(src) {
+    const path = {
+        dirs: [],
+        file: undefined,
+        type: "directory",
+    };
+    if (!src) {
+        return path;
+    }
+    const prsedSrc = src.trim();
+    const srcSplit = prsedSrc.split("/");
+    if (srcSplit.length === 0) {
+        return path;
+    }
+    for (let i = 0; i < srcSplit.length - 1; ++i) {
+        const dir = srcSplit[i];
+        const validation = _dirNameChecker(dir);
+        if (validation === "invalid") {
+            throw new Error_1.PathDirectoryValidationFailException(dir);
+        }
+        if (validation === "valid") {
+            path.dirs.push(dir);
+        }
+    }
+    const lastDir = srcSplit[srcSplit.length - 1];
+    const dirType = _dirFileTypeChecker(lastDir);
+    if (dirType === "directory") {
+        path.dirs.push(lastDir);
+    }
+    else if (dirType === "file") {
+        path.file = lastDir;
+        path.type = "file";
+    }
+    return path;
+}
+/** Path */
+class Path extends PathBase_1.PathBase {
+    _type;
+    _file;
+    /**
+     * Create a new Path instance
+     *
+     * @param dirs the directory names
+     * @param type indicate which type the Path is
+     * @param file the file name if the type is file
+     */
+    constructor(dirs, type, file) {
+        super();
+        if (typeof dirs === "string") {
+            const parsePath = _parsePathFromString(dirs);
+            if (type && type != parsePath.type) {
+                throw new Error_1.PathDirAndFileConvertInvaild(dirs, parsePath.type);
+            }
+            this._dirs = parsePath.dirs;
+            type = parsePath.type;
+            file = parsePath.file;
+        }
+        else if (Array.isArray(dirs)) {
+            this._dirs = dirs;
+        }
+        this._type = type || (file && "file") || "directory";
+        this._file = file;
+    }
+    /**
+     * Convert the path to a string
+     *
+     * @returns return the string
+     */
+    toString() {
+        if (this.getType() === "file" && !!!this.getFile()) {
+            throw new Error_1.PathProcessorSourceLostException();
+        }
+        if (this.length() === 0 && !!!this.getFile()) {
+            return "";
+        }
+        const dirs = [];
+        for (const dirItem of this._dirs) {
+            const validation = _dirNameChecker(dirItem);
+            if (validation === "invalid") {
+                throw new Error_1.PathDirectoryValidationFailException(dirItem);
+            }
+            if (validation === "valid") {
+                dirs.push(dirItem);
+            }
+        }
+        const file = this.getFile();
+        if (!!file)
+            dirs.push(file);
+        if (dirs.length === 0) {
+            return "";
+        }
+        return dirs.join("/");
+    }
+    /**
+     * Set the target type
+     *
+     * @param type new type
+     */
+    setType(type) {
+        this._type = type;
+    }
+    /**
+     * Get the path type of current instance
+     *
+     * @returns return the path type
+     */
+    getType() {
+        return this._type;
+    }
+    /**
+     * Set the path file name
+     *
+     * @param file the new file name
+     * @returns return the old file name
+     */
+    setFile(file) {
+        const oldFile = this._file;
+        this._file = file;
+        return oldFile;
+    }
+    /**
+     * Get the file name of current instance
+     *
+     * @returns return the file name
+     */
+    getFile() {
+        return this._file;
+    }
+    /**
+     * IComparable impl to get a string what equals to current instance
+     *
+     * @returns return the string
+     */
+    getString() {
+        return this.toString();
+    }
+    /**
+     * Get a hash code of current instance
+     *
+     * @returns always return 0
+     */
+    getHashCode() {
+        return 0;
+    }
+}
+exports.Path = Path;

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

@@ -0,0 +1,10 @@
+"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; } });