@szkj/utils 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,401 @@
+interface MaskOptions {
+    /**
+     * Number of characters to keep from the start.
+     */
+    start?: number;
+    /**
+     * Number of characters to keep from the end.
+     */
+    end?: number;
+    /**
+     * Character used to replace hidden content.
+     */
+    maskChar?: string;
+    /**
+     * Fixed mask length. When omitted, the hidden content length is used.
+     */
+    maskLength?: number;
+}
+
+interface UniversalMaskOptions extends MaskOptions {
+    /**
+     * Zero-based range to mask. The end index is not included.
+     */
+    range?: [number, number];
+    /**
+     * Regular expression used to find content that should be masked.
+     */
+    pattern?: RegExp;
+    /**
+     * Replacement used with pattern. When omitted, every matched
+     * character is replaced with maskChar.
+     */
+    replacement?: string | ((match: string) => string);
+}
+declare function mask(value: string, options?: UniversalMaskOptions): string;
+
+type MaskNameOptions = MaskOptions;
+declare function maskName(name: string, options?: MaskNameOptions): string;
+
+type MaskPhoneOptions = MaskOptions;
+declare function maskPhone(phone: string, options?: MaskPhoneOptions): string;
+
+type MaskFixedPhoneOptions = MaskOptions;
+declare function maskFixedPhone(phone: string, options?: MaskFixedPhoneOptions): string;
+
+type MaskEmailOptions = Omit<MaskOptions, 'end'>;
+declare function maskEmail(email: string, options?: MaskEmailOptions): string;
+
+type MaskIdCardOptions = MaskOptions;
+declare function maskIdCard(idCard: string, options?: MaskIdCardOptions): string;
+
+type MaskBankCardOptions = MaskOptions;
+declare function maskBankCard(cardNo: string, options?: MaskBankCardOptions): string;
+
+interface MaskAddressOptions extends Pick<MaskOptions, 'maskChar' | 'maskLength'> {
+    keepLength?: number;
+}
+declare function maskAddress(address: string, options?: MaskAddressOptions): string;
+
+type MaskPassportOptions = MaskOptions;
+declare function maskPassport(passport: string, options?: MaskPassportOptions): string;
+
+type MaskCarPlateOptions = MaskOptions;
+declare function maskCarPlate(plate: string, options?: MaskCarPlateOptions): string;
+
+interface MaskIpOptions extends Pick<MaskOptions, 'maskChar'> {
+    segment?: number;
+}
+declare function maskIp(ip: string, options?: MaskIpOptions): string;
+
+type MaskAccountOptions = MaskOptions;
+declare function maskAccount(account: string, options?: MaskAccountOptions): string;
+
+type MaskSecretOptions = MaskOptions;
+declare function maskSecret(secret: string, options?: MaskSecretOptions): string;
+
+declare const REGEXP_PHONE: RegExp;
+declare const REGEXP_FIXED_PHONE: RegExp;
+declare const REGEXP_EMAIL: RegExp;
+declare const REGEXP_ID_CARD: RegExp;
+declare const REGEXP_BANK_CARD: RegExp;
+declare const REGEXP_PASSPORT: RegExp;
+declare const REGEXP_CAR_PLATE: RegExp;
+declare const REGEXP_URL: RegExp;
+declare const REGEXP_IPV4: RegExp;
+declare const REGEXP_IPV6: RegExp;
+declare const REGEXP_PORT: RegExp;
+declare const REGEXP_CHINESE: RegExp;
+declare const REGEXP_POSTAL_CODE: RegExp;
+declare const REGEXP_QQ: RegExp;
+declare const REGEXP_USERNAME: RegExp;
+declare const REGEXP_PASSWORD: RegExp;
+declare const REGEXP_STRONG_PASSWORD: RegExp;
+declare const REGEXP_INTEGER: RegExp;
+declare const REGEXP_POSITIVE_INTEGER: RegExp;
+declare const REGEXP_DECIMAL: RegExp;
+declare const REGEXP_AMOUNT: RegExp;
+declare const regexp: {
+    readonly phone: RegExp;
+    readonly fixedPhone: RegExp;
+    readonly email: RegExp;
+    readonly idCard: RegExp;
+    readonly bankCard: RegExp;
+    readonly passport: RegExp;
+    readonly carPlate: RegExp;
+    readonly url: RegExp;
+    readonly ipv4: RegExp;
+    readonly ipv6: RegExp;
+    readonly port: RegExp;
+    readonly chinese: RegExp;
+    readonly postalCode: RegExp;
+    readonly qq: RegExp;
+    readonly username: RegExp;
+    readonly password: RegExp;
+    readonly strongPassword: RegExp;
+    readonly integer: RegExp;
+    readonly positiveInteger: RegExp;
+    readonly decimal: RegExp;
+    readonly amount: RegExp;
+};
+type RegexpKey = keyof typeof regexp;
+declare function testRegexp(value: string, pattern: RegExp): boolean;
+declare const isPhone: (value: string) => boolean;
+declare const isFixedPhone: (value: string) => boolean;
+declare const isEmail: (value: string) => boolean;
+declare const isIdCard: (value: string) => boolean;
+declare const isBankCard: (value: string) => boolean;
+declare const isPassport: (value: string) => boolean;
+declare const isCarPlate: (value: string) => boolean;
+declare const isUrl: (value: string) => boolean;
+declare const isIpv4: (value: string) => boolean;
+declare const isIpv6: (value: string) => boolean;
+declare const isPort: (value: string) => boolean;
+declare const isChinese: (value: string) => boolean;
+declare const isPostalCode: (value: string) => boolean;
+declare const isQq: (value: string) => boolean;
+declare const isUsername: (value: string) => boolean;
+declare const isPassword: (value: string) => boolean;
+declare const isStrongPassword: (value: string) => boolean;
+declare const isInteger: (value: string) => boolean;
+declare const isPositiveInteger: (value: string) => boolean;
+declare const isDecimal: (value: string) => boolean;
+declare const isAmount: (value: string) => boolean;
+
+interface CacheStorage {
+    length: number;
+    key(index: number): string | null;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+interface CacheOptions {
+    prefix?: string;
+    ttl?: number;
+    storage?: CacheStorage;
+}
+interface CacheSetOptions {
+    ttl?: number;
+}
+interface Cache {
+    set<T>(key: string, value: T, options?: CacheSetOptions): void;
+    get<T = unknown>(key: string): T | undefined;
+    has(key: string): boolean;
+    remove(key: string): void;
+    clear(): void;
+    keys(): string[];
+    size(): number;
+}
+declare function createCache(options?: CacheOptions): Cache;
+declare const cache: Cache;
+
+interface AesOptions {
+    iv?: string;
+    mode?: 'CBC' | 'CFB' | 'CTR' | 'ECB' | 'OFB';
+    padding?: 'Pkcs7' | 'Iso97971' | 'AnsiX923' | 'Iso10126' | 'ZeroPadding' | 'NoPadding';
+    keyMode?: 'utf8' | 'passphrase';
+}
+interface RsaOptions {
+    publicKey?: string;
+    privateKey?: string;
+}
+interface Sm2Options {
+    cipherMode?: 0 | 1;
+}
+interface Sm4Options {
+    mode?: 'ecb' | 'cbc';
+    iv?: string;
+    padding?: 'pkcs#5' | 'pkcs#7' | 'none';
+    output?: 'string' | 'array';
+}
+interface CryptoOptions {
+    aesKey?: string;
+    aesOptions?: AesOptions;
+    rsaPublicKey?: string;
+    rsaPrivateKey?: string;
+    sm2PublicKey?: string;
+    sm2PrivateKey?: string;
+    sm2Options?: Sm2Options;
+    sm4Key?: string;
+    sm4Options?: Sm4Options;
+}
+interface CryptoInstance {
+    encrypt(value: string, secret?: string): string;
+    decrypt(value: string, secret?: string): string;
+    encryptAes(value: string, secret?: string): string;
+    decryptAes(value: string, secret?: string): string;
+    encryptRsa(value: string, publicKey?: string): string;
+    decryptRsa(value: string, privateKey?: string): string;
+    encryptSm2(value: string, publicKey?: string): string;
+    decryptSm2(value: string, privateKey?: string): string;
+    encryptSm4(value: string, key?: string): string | number[];
+    decryptSm4(value: string | number[], key?: string): string;
+}
+declare function createCrypto(options?: CryptoOptions): CryptoInstance;
+declare function encrypt(value: string, secret: string, options?: AesOptions): string;
+declare function decrypt(value: string, secret: string, options?: AesOptions): string;
+declare function encryptAes(value: string, secret: string, options?: AesOptions): string;
+declare function decryptAes(value: string, secret: string, options?: AesOptions): string;
+declare function encryptRsa(value: string, publicKey: string): string;
+declare function decryptRsa(value: string, privateKey: string): string;
+declare function encryptSm2(value: string, publicKey: string, options?: Sm2Options): string;
+declare function decryptSm2(value: string, privateKey: string, options?: Sm2Options): string;
+declare function encryptSm4(value: string, key: string, options?: Sm4Options): string | number[];
+declare function decryptSm4(value: string | number[], key: string, options?: Sm4Options): string;
+declare function md5(value: string): string;
+declare function sha256(value: string): string;
+declare function toBase64(value: string): string;
+declare function fromBase64(value: string): string;
+
+type DateValue = Date | string | number;
+declare function toDate(value: DateValue): Date;
+declare function isValidDate(value: DateValue): boolean;
+declare function formatDate(value: DateValue, pattern?: string): string;
+declare function startOfDay(value: DateValue): Date;
+declare function endOfDay(value: DateValue): Date;
+declare function addDays(value: DateValue, amount: number): Date;
+declare function diffDays(left: DateValue, right: DateValue): number;
+declare function diffHours(left: DateValue, right: DateValue): number;
+declare function fromNow(value: DateValue, now?: DateValue): string;
+
+interface FormatMoneyOptions {
+    precision?: number;
+    symbol?: string;
+    thousand?: string;
+    decimal?: string;
+}
+interface FormatPercentOptions {
+    precision?: number;
+    multiplier?: number;
+}
+declare function toFixedSafe(value: number, precision?: number): string;
+declare function formatThousands(value: number | string, separator?: string): string;
+declare function formatMoney(value: number, options?: FormatMoneyOptions): string;
+declare function formatPercent(value: number, options?: FormatPercentOptions): string;
+declare function formatFileSize(bytes: number, precision?: number): string;
+declare function clamp(value: number, min: number, max: number): number;
+
+type TreeKey = string | number;
+type TreeNode = Record<string, unknown>;
+interface TreeOptions {
+    idKey?: string;
+    parentKey?: string;
+    childrenKey?: string;
+}
+declare function listToTree<T extends TreeNode>(list: T[], options?: TreeOptions): T[];
+declare function treeToList<T extends TreeNode>(tree: T[], options?: Pick<TreeOptions, 'childrenKey'>): T[];
+declare function findTreeNode<T extends TreeNode>(tree: T[], predicate: (node: T) => boolean, options?: Pick<TreeOptions, 'childrenKey'>): T | undefined;
+declare function filterTree<T extends TreeNode>(tree: T[], predicate: (node: T) => boolean, options?: Pick<TreeOptions, 'childrenKey'>): T[];
+declare function getTreePath<T extends TreeNode>(tree: T[], predicate: (node: T) => boolean, options?: Pick<TreeOptions, 'childrenKey'>): T[];
+declare function getTreeLeaves<T extends TreeNode>(tree: T[], options?: Pick<TreeOptions, 'childrenKey'>): T[];
+
+interface StorageLike {
+    length: number;
+    key(index: number): string | null;
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+    clear?(): void;
+}
+interface StorageOptions {
+    namespace?: string;
+    ttl?: number;
+    storage?: StorageLike;
+    encrypt?: (value: string) => string;
+    decrypt?: (value: string) => string;
+}
+interface StorageSetOptions {
+    ttl?: number;
+}
+interface StorageInstance {
+    set<T>(key: string, value: T, options?: StorageSetOptions): void;
+    get<T = unknown>(key: string): T | undefined;
+    getRaw(key: string): string | undefined;
+    has(key: string): boolean;
+    remove(key: string): void;
+    clear(): void;
+    keys(): string[];
+    size(): number;
+}
+declare function createStorage(options?: StorageOptions): StorageInstance;
+declare const localStore: StorageInstance;
+declare const sessionStore: StorageInstance;
+
+interface CopyTextOptions {
+    onSuccess?: () => void;
+    onError?: (error: unknown) => void;
+}
+declare function copyText(text: string, options?: CopyTextOptions): Promise<boolean>;
+
+interface DownloadOptions {
+    filename?: string;
+    mimeType?: string;
+}
+declare function downloadBlob(blob: Blob, options?: DownloadOptions): void;
+declare function downloadText(text: string, filename?: string): void;
+declare function downloadJSON(data: unknown, filename?: string): void;
+interface DownloadStreamOptions extends DownloadOptions {
+    onProgress?: (loaded: number, total: number) => void;
+    onError?: (error: unknown) => void;
+}
+declare function downloadStream(response: Response, options?: DownloadStreamOptions): Promise<void>;
+
+declare function fileToBase64(file: File): Promise<string>;
+declare function base64ToBlob(base64: string, mimeType?: string): Blob;
+declare function getFileExtension(filename: string): string;
+
+declare function deepClone<T>(obj: T): T;
+declare function deepMerge<T extends Record<string, unknown>>(target: T, ...sources: Array<Partial<Record<string, unknown>>>): T;
+declare function removeEmptyValues<T extends Record<string, unknown>>(obj: T, options?: {
+    removeNull?: boolean;
+    removeUndefined?: boolean;
+    removeEmptyString?: boolean;
+    removeEmptyArray?: boolean;
+    removeEmptyObject?: boolean;
+}): Partial<T>;
+declare function pick<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+declare function omit<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+declare function flatten(obj: Record<string, unknown>, prefix?: string, result?: Record<string, unknown>): Record<string, unknown>;
+declare function unflatten(obj: Record<string, unknown>): Record<string, unknown>;
+
+declare function flattenArray<T>(arr: unknown[], depth?: number): T[];
+declare function chunk<T>(arr: T[], size: number): T[][];
+declare function unique<T>(arr: T[]): T[];
+declare function uniqueBy<T>(arr: T[], key: keyof T | ((item: T) => unknown)): T[];
+declare function groupBy<T>(arr: T[], key: keyof T | ((item: T) => unknown)): Record<string, T[]>;
+declare function intersection<T>(arr1: T[], arr2: T[]): T[];
+declare function difference<T>(arr1: T[], arr2: T[]): T[];
+declare function shuffle<T>(arr: T[]): T[];
+declare function sortBy<T>(arr: T[], key: keyof T | ((item: T) => unknown), order?: 'asc' | 'desc'): T[];
+declare function sum(arr: number[]): number;
+declare function average(arr: number[]): number;
+declare function maxBy<T>(arr: T[], key: keyof T | ((item: T) => number)): T | undefined;
+declare function minBy<T>(arr: T[], key: keyof T | ((item: T) => number)): T | undefined;
+declare function moveItem<T>(arr: T[], fromIndex: number, toIndex: number): T[];
+declare function swapItems<T>(arr: T[], index1: number, index2: number): T[];
+
+declare function isEmpty(str: unknown): boolean;
+declare function isNotEmpty(str: unknown): boolean;
+declare function capitalize(str: string): string;
+declare function uncapitalize(str: string): string;
+declare function camelCase(str: string): string;
+declare function pascalCase(str: string): string;
+declare function kebabCase(str: string): string;
+declare function snakeCase(str: string): string;
+declare function truncate(str: string, maxLength: number, suffix?: string): string;
+declare function generateUUID(): string;
+declare function escapeHtml(str: string): string;
+declare function unescapeHtml(str: string): string;
+declare function parseQueryString(url: string): Record<string, string>;
+declare function stringifyQueryString(params: Record<string, string | number | boolean | undefined | null>): string;
+declare function buildUrl(baseUrl: string, params: Record<string, string | number | boolean | undefined | null>): string;
+
+interface DebounceOptions {
+    wait?: number;
+    leading?: boolean;
+    trailing?: boolean;
+}
+type AnyFunction = (...args: any[]) => any;
+interface DebouncedFunc<T extends AnyFunction> {
+    (...args: Parameters<T>): ReturnType<T> | undefined;
+    cancel: () => void;
+    flush: () => ReturnType<T> | undefined;
+    pending: () => boolean;
+}
+declare function debounce<T extends AnyFunction>(func: T, options?: DebounceOptions): DebouncedFunc<T>;
+interface ThrottleOptions {
+    wait?: number;
+    leading?: boolean;
+    trailing?: boolean;
+}
+interface ThrottledFunc<T extends AnyFunction> {
+    (...args: Parameters<T>): ReturnType<T> | undefined;
+    cancel: () => void;
+    flush: () => ReturnType<T> | undefined;
+    pending: () => boolean;
+}
+declare function throttle<T extends AnyFunction>(func: T, options?: ThrottleOptions): ThrottledFunc<T>;
+
+declare function get<T = any>(obj: any, path: string | string[], defaultValue?: T): T | undefined;
+
+export { type AesOptions, type Cache, type CacheOptions, type CacheSetOptions, type CacheStorage, type CopyTextOptions, type CryptoInstance, type CryptoOptions, type DateValue, type DebounceOptions, type DebouncedFunc, type DownloadOptions, type DownloadStreamOptions, type FormatMoneyOptions, type FormatPercentOptions, type MaskAccountOptions, type MaskAddressOptions, type MaskBankCardOptions, type MaskCarPlateOptions, type MaskEmailOptions, type MaskFixedPhoneOptions, type MaskIdCardOptions, type MaskIpOptions, type MaskNameOptions, type MaskOptions, type MaskPassportOptions, type MaskPhoneOptions, type MaskSecretOptions, REGEXP_AMOUNT, REGEXP_BANK_CARD, REGEXP_CAR_PLATE, REGEXP_CHINESE, REGEXP_DECIMAL, REGEXP_EMAIL, REGEXP_FIXED_PHONE, REGEXP_ID_CARD, REGEXP_INTEGER, REGEXP_IPV4, REGEXP_IPV6, REGEXP_PASSPORT, REGEXP_PASSWORD, REGEXP_PHONE, REGEXP_PORT, REGEXP_POSITIVE_INTEGER, REGEXP_POSTAL_CODE, REGEXP_QQ, REGEXP_STRONG_PASSWORD, REGEXP_URL, REGEXP_USERNAME, type RegexpKey, type RsaOptions, type Sm2Options, type Sm4Options, type StorageInstance, type StorageLike, type StorageOptions, type StorageSetOptions, type ThrottleOptions, type ThrottledFunc, type TreeKey, type TreeNode, type TreeOptions, type UniversalMaskOptions, addDays, average, base64ToBlob, buildUrl, cache, camelCase, capitalize, chunk, clamp, copyText, createCache, createCrypto, createStorage, debounce, decrypt, decryptAes, decryptRsa, decryptSm2, decryptSm4, deepClone, deepMerge, diffDays, diffHours, difference, downloadBlob, downloadJSON, downloadStream, downloadText, encrypt, encryptAes, encryptRsa, encryptSm2, encryptSm4, endOfDay, escapeHtml, fileToBase64, filterTree, findTreeNode, flatten, flattenArray, formatDate, formatFileSize, formatMoney, formatPercent, formatThousands, fromBase64, fromNow, generateUUID, get, getFileExtension, getTreeLeaves, getTreePath, groupBy, intersection, isAmount, isBankCard, isCarPlate, isChinese, isDecimal, isEmail, isEmpty, isFixedPhone, isIdCard, isInteger, isIpv4, isIpv6, isNotEmpty, isPassport, isPassword, isPhone, isPort, isPositiveInteger, isPostalCode, isQq, isStrongPassword, isUrl, isUsername, isValidDate, kebabCase, listToTree, localStore, mask, maskAccount, maskAddress, maskBankCard, maskCarPlate, maskEmail, maskFixedPhone, maskIdCard, maskIp, maskName, maskPassport, maskPhone, maskSecret, maxBy, md5, minBy, moveItem, omit, parseQueryString, pascalCase, pick, regexp, removeEmptyValues, sessionStore, sha256, shuffle, snakeCase, sortBy, startOfDay, stringifyQueryString, sum, swapItems, testRegexp, throttle, toBase64, toDate, toFixedSafe, treeToList, truncate, uncapitalize, unescapeHtml, unflatten, unique, uniqueBy };