@aitianyu.cn/types 0.0.13 → 0.1.0

package/dist/types/index.d.ts

@@ -1,21 +1,29 @@
-/**@format */
-export { AreaCode } from "./types/AreaCode";
-export { Exception } from "./types/Exception";
-export { LogLevel, type ILog, type IPerfRecorder } from "./types/Logs";
-export { type IObjectDiffInfo, type ObjectDiffMap } from "./types/Object";
-export { PathBase } from "./types/PathBase";
-export { EncryptOption, type ICipher } from "./types/Security";
-export { TMap } from "./types/TMap";
-export { type MapOfBoolean, type MapOfStrings, type MapOfString, type MapOfType, type CallbackAction, type CallbackActionT, type IComparable, type KeyValuePair, } from "./types/Types";
-export { PathProcessorSourceLostException, PathDirectoryValidationFailException, PathDirAndFileConvertInvaild, } from "./utilities/coding/Error";
-export { type PathTargetType, Path } from "./utilities/coding/Path";
-export { ArgumentNullOrEmptyException, ObjectCloneFunctionNotSupportException, ObjectMergeStatusCheckFailedException, ObjectDiffApplyInvalidStatusException, ObjectDiffMergeFailedException, } from "./utilities/core/Errors";
-export { parseAreaCode, parseAreaString } from "./utilities/core/Language";
-export { Log, Performance } from "./utilities/core/Log";
-export { getBoolean } from "./utilities/core/TypeConvertion";
-export { ObjectCalculater } from "./utilities/core/object/Calculater";
-export { ObjectHelper } from "./utilities/core/object/Helper";
-export { ArrayHelper } from "./utilities/core/object/ArrayHelper";
-export { StringHelper } from "./utilities/core/object/StringHelper";
-export { guid } from "./utilities/security/Guid";
-export { hash } from "./utilities/security/Hash";
+/**@format */
+export { AreaCode } from "./types/AreaCode";
+export { Exception } from "./types/Exception";
+export { LogLevel, type ILog, type IPerfRecorder } from "./types/Logs";
+export { type IObjectDiffInfo, type ObjectDiffMap } from "./types/Object";
+export { PathBase } from "./types/PathBase";
+export { EncryptOption, type ICipher } from "./types/Security";
+export { TMap } from "./types/TMap";
+export { type MapOfBoolean, type MapOfStrings, type MapOfString, type MapOfType, type CallbackAction, type CallbackActionT, type IComparable, type KeyValuePair, } from "./types/Types";
+export { PathProcessorSourceLostException, PathDirectoryValidationFailException, PathDirAndFileConvertInvaild, } from "./coding/Error";
+export { type PathTargetType, Path } from "./coding/Path";
+export { ArgumentNullOrEmptyException, ObjectCloneFunctionNotSupportException, ObjectMergeStatusCheckFailedException, ObjectDiffApplyInvalidStatusException, ObjectDiffMergeFailedException, } from "./core/Errors";
+export { parseAreaCode, parseAreaString } from "./core/Language";
+export { Log, Performance } from "./core/Log";
+export { getBoolean } from "./core/TypeConvertion";
+export { ObjectCalculater } from "./core/object/Calculater";
+export { ObjectHelper } from "./core/object/ObjectHelper";
+export { ArrayHelper } from "./core/object/ArrayHelper";
+export { StringHelper } from "./core/object/StringHelper";
+export { Bytes } from "./core/object/Bytes";
+export { DataView } from "./core/object/DataView";
+export { Integer } from "./core/object/Integer";
+export { Json } from "./core/object/Json";
+export { Base32 } from "./security/Base32";
+export { guid } from "./security/Guid";
+export { hash } from "./security/Hash";
+export { QRCode } from "./security/QRCode";
+export { RSA } from "./security/RSA";
+export { SHA } from "./security/SHA";

package/dist/types/security/Base32.d.ts

@@ -0,0 +1,42 @@
+/** @format */
+/**
+ * Base32 Encoding Type
+ *
+ * @field RFC3548
+ * @field RFC4648
+ * @field RFC4648-HEX
+ * @field Crockford
+ */
+export type EncodingType = "RFC3548" | "RFC4648" | "RFC4648-HEX" | "Crockford";
+/** Base32 Encoding Lib */
+export declare class Base32 {
+    private static RFC4648_CHS;
+    private static RFC4648_HEX_CHS;
+    private static CROCKFORD_CHS;
+    /**
+     * To encode the buffer to be a Base32 encoded string
+     *
+     * @param data input source buffer
+     * @param encoding encoding type
+     * @returns return the encoded string
+     */
+    static encode(data: ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray, encoding: EncodingType): string;
+    /**
+     * Decode the input string to be an array buffer
+     *
+     * @param input source string
+     * @param encoding encoding type
+     * @returns return the target array buffer
+     */
+    static decode(input: string, encoding: EncodingType): ArrayBuffer;
+    /**
+     * Get a random string which is encoded by given encoding type
+     *
+     * @param size random bytes size
+     * @param encoding encoding type
+     * @returns return encoded random string
+     */
+    static random(size: number, encoding?: EncodingType): string;
+    private static getAlphabet;
+    private static readChar;
+}

package/dist/types/security/Guid.d.ts

@@ -0,0 +1,4 @@
+/**@format */
+export type GuidType = "none" | "default";
+/** Generate a Guid value string */
+export declare function guid(type?: GuidType): string;

package/dist/types/{utilities/security → security}/Hash.d.ts

@@ -1,3 +1,3 @@
-/**@format */
-/** Generate a hash code number of the string */
-export declare function hash(source: string): number;
+/**@format */
+/** Generate a hash code number of the string */
+export declare function hash(source: string): number;

package/dist/types/security/QRCode.d.ts

@@ -0,0 +1,11 @@
+/** @format */
+/** QR code Lib */
+export declare class QRCode {
+    /**
+     * Async getting a base64 URL of given text
+     *
+     * @param text source text
+     * @returns return base64 URL string
+     */
+    static getURL(text: string): Promise<string>;
+}

package/dist/types/security/RSA.d.ts

@@ -0,0 +1,68 @@
+/** @format */
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { RSAKeyPairOptions } from "crypto";
+/**
+ * RSA Key formatting type
+ *
+ * @field pem string formatting key
+ * @field der buffer data key
+ */
+export type RSAKeyFormatType = "pem" | "der";
+/** RSA key generation Map */
+export interface RSAKeyGenerationMap {
+    pem: string;
+    der: Buffer;
+}
+/** RSA Key generation return type */
+export type RSAKeyGenerationReturnType<K extends RSAKeyFormatType> = RSAKeyGenerationMap[K];
+/** RSA Generation result */
+export interface RSAGenerationResult<priKey extends RSAKeyFormatType, pubKey extends RSAKeyFormatType> {
+    /** RSA private key */
+    privateKey: RSAKeyGenerationReturnType<priKey>;
+    /** RSA public key */
+    publicKey: RSAKeyGenerationReturnType<pubKey>;
+}
+/** RSA Lib */
+export declare class RSA {
+    /**
+     * To get a new RSA public key and private key
+     *
+     * @param options RSA key generation option
+     * @returns return new RSA key
+     */
+    static new<priKey extends RSAKeyFormatType = "pem", pubKey extends RSAKeyFormatType = "pem">(options: RSAKeyPairOptions<priKey, pubKey>): RSAGenerationResult<priKey, pubKey>;
+    /**
+     * To encode a value with public key, the encoded data can be decoded by private key
+     *
+     * @param data input data
+     * @param publicKey encoding public key
+     * @returns return encoded buffer
+     */
+    static encodepub(data: globalThis.DataView, publicKey: string | Buffer): Buffer;
+    /**
+     * To encode a value with private key, the encoded data can be decoded by public key
+     *
+     * @param data input data
+     * @param publicKey encoding private key
+     * @returns return encoded buffer
+     */
+    static encodepri(data: globalThis.DataView, privateKey: string | Buffer): Buffer;
+    /**
+     * To decode a value with public key, the value is encoded by private key
+     *
+     * @param data input data
+     * @param publicKey decoding public key
+     * @returns return decoded buffer
+     */
+    static decodepub(data: globalThis.DataView, publicKey: string | Buffer): Buffer;
+    /**
+     * To decode a value with private key, the value is encoded by public key
+     *
+     * @param data input data
+     * @param privateKey decoding private key
+     * @returns return decoded buffer
+     */
+    static decodepri(data: globalThis.DataView, privateKey: string | Buffer): Buffer;
+}

package/dist/types/security/SHA.d.ts

@@ -0,0 +1,40 @@
+/** @format */
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import Stream from "stream";
+/** SHA Lib */
+export declare class SHA {
+    /**
+     * Calculate SHA256 code of data based on specified string encoding.
+     *
+     * @param data source data
+     * @param encoding string encoding type, default encoding type is 'utf-8', only used when data type is string
+     * @returns return the SHA256 code buffer
+     */
+    static sha256(data: string | Buffer, encoding?: NodeJS.BufferEncoding): Buffer;
+    /**
+     * Calculate SHA512 code of data based on specified string encoding.
+     *
+     * @param data source data
+     * @param encoding string encoding type, default encoding type is 'utf-8', only used when data type is string
+     * @returns return the SHA256 code buffer
+     */
+    static sha512(data: string | Buffer, encoding?: NodeJS.BufferEncoding): Buffer;
+    private static sha;
+    /**
+     * Calculate SHA256 code of data based on a stream
+     *
+     * @param stream data stream
+     * @returns return the encoded buffer
+     */
+    static stream256(stream: Stream): Promise<Buffer>;
+    /**
+     * Calculate SHA512 code of data based on a stream
+     *
+     * @param stream data stream
+     * @returns return the encoded buffer
+     */
+    static stream512(stream: Stream): Promise<Buffer>;
+    private static streamSHA;
+}

package/dist/types/types/AreaCode.d.ts

@@ -1,135 +1,135 @@
-/**@format */
-/** International Area name and its code */
-export declare enum AreaCode {
-    unknown = 0,
-    af_ZA = 1078,
-    sq_AL = 1052,
-    am_AM = 1118,
-    ar_DZ = 5121,
-    ar_BH = 15361,
-    ar_EG = 3073,
-    ar_IQ = 2049,
-    ar_JO = 11265,
-    ar_KW = 13313,
-    ar_LB = 12289,
-    ar_LY = 4097,
-    ar_MA = 6145,
-    ar_OM = 8193,
-    ar_QA = 16385,
-    ar_SA = 1025,
-    ar_SY = 10241,
-    ar_TN = 7169,
-    ar_AE = 14337,
-    ar_YE = 9217,
-    hy_AM = 1067,
-    as_AS = 1101,
-    az_AZ_Cyrl = 2092,
-    az_AZ_Latn = 2093,
-    eu_ES = 1069,
-    be_BY = 1059,
-    bg_BG = 1026,
-    ca_ES = 1027,
-    zh_HK = 3076,
-    zh_MO = 5124,
-    zh_CN = 2052,
-    zh_SG = 4100,
-    zh_TW = 1028,
-    hr_HR = 1050,
-    cd_CZ = 1029,
-    da_DK = 1030,
-    nl_BE = 2067,
-    nl_NL = 1043,
-    en_AU = 3081,
-    en_BZ = 10249,
-    en_CA = 4105,
-    en_CB = 9225,
-    en_IE = 6153,
-    en_IN = 16393,
-    en_JM = 8201,
-    en_NZ = 5129,
-    en_PH = 13321,
-    en_ZA = 7177,
-    en_TT = 11273,
-    en_ZW = 12297,
-    en_US = 1033,
-    en_UK = 2057,
-    et_EE = 1061,
-    fo_FO = 1080,
-    fi_FI = 1035,
-    fr_BE = 2060,
-    fr_CA = 11276,
-    fr_FR = 1036,
-    fr_LU = 5132,
-    fr_MC = 6156,
-    fr_CH = 4108,
-    gl_ES = 1110,
-    de_AT = 3079,
-    de_DE = 1031,
-    de_LI = 5127,
-    de_LU = 4103,
-    de_CH = 2055,
-    gu_IN = 1095,
-    he_IL = 1037,
-    hi_IN = 1081,
-    hu_HU = 1038,
-    is_IS = 1039,
-    id_ID = 1057,
-    it_IT = 1040,
-    it_CH = 2064,
-    ja_JP = 1041,
-    kn_IN = 1099,
-    kk_KZ = 1087,
-    ko_KR = 1042,
-    ky_KZ = 1088,
-    lv_LV = 1062,
-    lt_LT = 1063,
-    ms_BN = 2110,
-    ms_MY = 1086,
-    mr_IN = 1102,
-    mn_MN = 2128,
-    nb_NO = 1044,
-    nn_NO = 2068,
-    pl_PL = 1045,
-    pt_BR = 1046,
-    pt_PT = 2070,
-    pa_IN = 1094,
-    ro_MO = 2072,
-    ro_RO = 1048,
-    ru_RU = 1049,
-    ru_MO = 2073,
-    sa_IN = 1103,
-    sr_SP_Cyrl = 3098,
-    sr_SP_Latn = 2074,
-    sk_SK = 1051,
-    sl_SI = 1060,
-    es_AR = 11274,
-    es_BO = 16394,
-    es_CL = 13322,
-    es_CO = 9226,
-    es_CR = 5130,
-    es_DO = 7178,
-    es_EC = 12298,
-    es_SV = 17418,
-    es_GT = 4106,
-    es_HN = 18442,
-    es_MX = 2058,
-    es_NI = 19466,
-    es_PA = 6154,
-    es_PY = 15370,
-    es_PE = 10250,
-    es_PR = 20490,
-    es_ES = 1034,
-    es_UY = 14346,
-    es_VE = 8202,
-    sw_KE = 1089,
-    sv_FI = 2077,
-    sv_SE = 1053,
-    ta_IN = 1097,
-    tt_RU = 1092,
-    te_IN = 1098,
-    th_TH = 1054,
-    tr_TR = 1055,
-    uz_UZ_Cyrl = 2115,
-    uz_UZ_Latn = 1091,
-    vi_VN = 1066
-}
+/**@format */
+/** International Area name and its code */
+export declare enum AreaCode {
+    unknown = 0,
+    af_ZA = 1078,
+    sq_AL = 1052,
+    am_AM = 1118,
+    ar_DZ = 5121,
+    ar_BH = 15361,
+    ar_EG = 3073,
+    ar_IQ = 2049,
+    ar_JO = 11265,
+    ar_KW = 13313,
+    ar_LB = 12289,
+    ar_LY = 4097,
+    ar_MA = 6145,
+    ar_OM = 8193,
+    ar_QA = 16385,
+    ar_SA = 1025,
+    ar_SY = 10241,
+    ar_TN = 7169,
+    ar_AE = 14337,
+    ar_YE = 9217,
+    hy_AM = 1067,
+    as_AS = 1101,
+    az_AZ_Cyrl = 2092,
+    az_AZ_Latn = 2093,
+    eu_ES = 1069,
+    be_BY = 1059,
+    bg_BG = 1026,
+    ca_ES = 1027,
+    zh_HK = 3076,
+    zh_MO = 5124,
+    zh_CN = 2052,
+    zh_SG = 4100,
+    zh_TW = 1028,
+    hr_HR = 1050,
+    cd_CZ = 1029,
+    da_DK = 1030,
+    nl_BE = 2067,
+    nl_NL = 1043,
+    en_AU = 3081,
+    en_BZ = 10249,
+    en_CA = 4105,
+    en_CB = 9225,
+    en_IE = 6153,
+    en_IN = 16393,
+    en_JM = 8201,
+    en_NZ = 5129,
+    en_PH = 13321,
+    en_ZA = 7177,
+    en_TT = 11273,
+    en_ZW = 12297,
+    en_US = 1033,
+    en_UK = 2057,
+    et_EE = 1061,
+    fo_FO = 1080,
+    fi_FI = 1035,
+    fr_BE = 2060,
+    fr_CA = 11276,
+    fr_FR = 1036,
+    fr_LU = 5132,
+    fr_MC = 6156,
+    fr_CH = 4108,
+    gl_ES = 1110,
+    de_AT = 3079,
+    de_DE = 1031,
+    de_LI = 5127,
+    de_LU = 4103,
+    de_CH = 2055,
+    gu_IN = 1095,
+    he_IL = 1037,
+    hi_IN = 1081,
+    hu_HU = 1038,
+    is_IS = 1039,
+    id_ID = 1057,
+    it_IT = 1040,
+    it_CH = 2064,
+    ja_JP = 1041,
+    kn_IN = 1099,
+    kk_KZ = 1087,
+    ko_KR = 1042,
+    ky_KZ = 1088,
+    lv_LV = 1062,
+    lt_LT = 1063,
+    ms_BN = 2110,
+    ms_MY = 1086,
+    mr_IN = 1102,
+    mn_MN = 2128,
+    nb_NO = 1044,
+    nn_NO = 2068,
+    pl_PL = 1045,
+    pt_BR = 1046,
+    pt_PT = 2070,
+    pa_IN = 1094,
+    ro_MO = 2072,
+    ro_RO = 1048,
+    ru_RU = 1049,
+    ru_MO = 2073,
+    sa_IN = 1103,
+    sr_SP_Cyrl = 3098,
+    sr_SP_Latn = 2074,
+    sk_SK = 1051,
+    sl_SI = 1060,
+    es_AR = 11274,
+    es_BO = 16394,
+    es_CL = 13322,
+    es_CO = 9226,
+    es_CR = 5130,
+    es_DO = 7178,
+    es_EC = 12298,
+    es_SV = 17418,
+    es_GT = 4106,
+    es_HN = 18442,
+    es_MX = 2058,
+    es_NI = 19466,
+    es_PA = 6154,
+    es_PY = 15370,
+    es_PE = 10250,
+    es_PR = 20490,
+    es_ES = 1034,
+    es_UY = 14346,
+    es_VE = 8202,
+    sw_KE = 1089,
+    sv_FI = 2077,
+    sv_SE = 1053,
+    ta_IN = 1097,
+    tt_RU = 1092,
+    te_IN = 1098,
+    th_TH = 1054,
+    tr_TR = 1055,
+    uz_UZ_Cyrl = 2115,
+    uz_UZ_Latn = 1091,
+    vi_VN = 1066
+}

package/dist/types/types/Exception.d.ts

@@ -1,11 +1,11 @@
-/**@format */
-/** Exception base class */
-export declare class Exception extends Error {
-    constructor(msg?: string, options?: ErrorOptions);
-    /**
-     * Get a string of the Exception object
-     *
-     * @returns return an error message
-     */
-    toString(): string;
-}
+/**@format */
+/** Exception base class */
+export declare class Exception extends Error {
+    constructor(msg?: string, options?: ErrorOptions);
+    /**
+     * Get a string of the Exception object
+     *
+     * @returns return an error message
+     */
+    toString(): string;
+}

package/dist/types/types/Logs.d.ts

@@ -1,64 +1,64 @@
-/**@format */
-/** Tianyu Log Level */
-export declare enum LogLevel {
-    /** Debug mode log */
-    DEBUG = 0,
-    /** error msg */
-    ERROR = 1,
-    /** fatal error msg */
-    FATAL = 2,
-    /** info log */
-    INFO = 3,
-    /** warning log */
-    WARNING = 4,
-    /** default log */
-    LOG = 5
-}
-/** Tianyu Log Interface */
-export interface ILog {
-    /**
-     * Write a console log with specified log level
-     *
-     * @param msg the message body
-     * @param level the console log level, if not be specified, to print as default log
-     * @param timer a boolean value indicates whether needs to add a timestamp for the log
-     */
-    log(msg: string, level?: LogLevel, timer?: boolean): void;
-    /**
-     * Write a console info log
-     * @param msg the message body
-     * @param timer a boolean value indicates whether needs to add a timestamp for the log
-     */
-    info(msg: string, timer?: boolean): void;
-    /**
-     * Write a console warning log
-     * @param msg the message body
-     * @param timer a boolean value indicates whether needs to add a timestamp for the log
-     */
-    warn(msg: string, timer?: boolean): void;
-    /**
-     * Write a console debug log
-     * @param msg the message body
-     * @param timer a boolean value indicates whether needs to add a timestamp for the log
-     */
-    debug(msg: string, timer?: boolean): void;
-    /**
-     * Write a console error message
-     * @param msg the message body
-     * @param timer a boolean value indicates whether needs to add a timestamp for the log
-     */
-    error(msg: string, timer?: boolean): void;
-    /**
-     * Write a console fatal message
-     * @param msg the message body
-     * @param timer a boolean value indicates whether needs to add a timestamp for the log
-     */
-    fatal(msg: string, timer?: boolean): void;
-}
-/** Tianyu Performance recorder */
-export interface IPerfRecorder {
-    /** the recording id */
-    id: string;
-    /** the start time number */
-    start: number;
-}
+/**@format */
+/** Tianyu Log Level */
+export declare enum LogLevel {
+    /** Debug mode log */
+    DEBUG = 0,
+    /** error msg */
+    ERROR = 1,
+    /** fatal error msg */
+    FATAL = 2,
+    /** info log */
+    INFO = 3,
+    /** warning log */
+    WARNING = 4,
+    /** default log */
+    LOG = 5
+}
+/** Tianyu Log Interface */
+export interface ILog {
+    /**
+     * Write a console log with specified log level
+     *
+     * @param msg the message body
+     * @param level the console log level, if not be specified, to print as default log
+     * @param timer a boolean value indicates whether needs to add a timestamp for the log
+     */
+    log(msg: string, level?: LogLevel, timer?: boolean): void;
+    /**
+     * Write a console info log
+     * @param msg the message body
+     * @param timer a boolean value indicates whether needs to add a timestamp for the log
+     */
+    info(msg: string, timer?: boolean): void;
+    /**
+     * Write a console warning log
+     * @param msg the message body
+     * @param timer a boolean value indicates whether needs to add a timestamp for the log
+     */
+    warn(msg: string, timer?: boolean): void;
+    /**
+     * Write a console debug log
+     * @param msg the message body
+     * @param timer a boolean value indicates whether needs to add a timestamp for the log
+     */
+    debug(msg: string, timer?: boolean): void;
+    /**
+     * Write a console error message
+     * @param msg the message body
+     * @param timer a boolean value indicates whether needs to add a timestamp for the log
+     */
+    error(msg: string, timer?: boolean): void;
+    /**
+     * Write a console fatal message
+     * @param msg the message body
+     * @param timer a boolean value indicates whether needs to add a timestamp for the log
+     */
+    fatal(msg: string, timer?: boolean): void;
+}
+/** Tianyu Performance recorder */
+export interface IPerfRecorder {
+    /** the recording id */
+    id: string;
+    /** the start time number */
+    start: number;
+}