ly-utils-lib 1.0.11 → 2.4.0

package/dist/index-Ba1rjTzj.d.ts

@@ -0,0 +1,299 @@
+/**
+ * Storage Module - 浏览器存储工具
+ *
+ * 提供统一的浏览器存储操作 API
+ */
+/**
+ * 存储数据类型
+ */
+type StorageValue = string | number | boolean | null | undefined | object | unknown[];
+/**
+ * 存储选项
+ */
+interface StorageOptions {
+    /** 过期时间（毫秒），0 表示永不过期 */
+    ttl?: number;
+}
+/**
+ * Cookie 选项
+ */
+interface CookieOptions extends Cookies.CookieAttributes {
+    /** 过期天数 */
+    days?: number;
+}
+/**
+ * 设置永久缓存
+ * @param key - 缓存名称
+ * @param value - 缓存内容
+ * @param options - 存储选项
+ * @example
+ * ```ts
+ * setLocal('user', { name: 'Alice', age: 25 })
+ * setLocal('token', 'abc123', { ttl: 3600000 }) // 1小时后过期
+ * ```
+ */
+declare function setLocal<T = StorageValue>(key: string, value: T, options?: StorageOptions): void;
+/**
+ * 获取永久缓存
+ * @param key - 缓存名称
+ * @returns 缓存内容，不存在或已过期返回 undefined
+ * @example
+ * ```ts
+ * const user = getLocal<{ name: string; age: number }>('user')
+ * console.log(user?.name) // 'Alice'
+ * ```
+ */
+declare function getLocal<T = StorageValue>(key: string): T | undefined;
+/**
+ * 移除永久缓存
+ * @param key - 缓存名称
+ * @example
+ * ```ts
+ * removeLocal('user')
+ * ```
+ */
+declare function removeLocal(key: string): void;
+/**
+ * 移除全部永久缓存
+ * @example
+ * ```ts
+ * clearLocal()
+ * ```
+ */
+declare function clearLocal(): void;
+/**
+ * 获取所有 localStorage 的键
+ * @returns 键数组
+ */
+declare function getLocalKeys(): string[];
+/**
+ * 获取 localStorage 中键的数量
+ * @returns 键的数量
+ */
+declare function getLocalSize(): number;
+/**
+ * 设置临时缓存
+ * @param key - 缓存名称
+ * @param value - 缓存内容
+ * @param options - 存储选项
+ * @example
+ * ```ts
+ * setSession('temp', { data: [1, 2, 3] })
+ * setSession('session', 'abc123', { ttl: 60000 }) // 1分钟后过期
+ * ```
+ */
+declare function setSession<T = StorageValue>(key: string, value: T, options?: StorageOptions): void;
+/**
+ * 获取临时缓存
+ * @param key - 缓存名称
+ * @returns 缓存内容，不存在或已过期返回 undefined
+ * @example
+ * ```ts
+ * const temp = getSession<{ data: number[] }>('temp')
+ * console.log(temp?.data) // [1, 2, 3]
+ * ```
+ */
+declare function getSession<T = StorageValue>(key: string): T | undefined;
+/**
+ * 移除临时缓存
+ * @param key - 缓存名称
+ * @example
+ * ```ts
+ * removeSession('temp')
+ * ```
+ */
+declare function removeSession(key: string): void;
+/**
+ * 移除全部临时缓存
+ * @example
+ * ```ts
+ * clearSession()
+ * ```
+ */
+declare function clearSession(): void;
+/**
+ * 获取所有 sessionStorage 的键
+ * @returns 键数组
+ */
+declare function getSessionKeys(): string[];
+/**
+ * 获取 sessionStorage 中键的数量
+ * @returns 键的数量
+ */
+declare function getSessionSize(): number;
+/**
+ * 设置 Cookie
+ * @param key - Cookie 名称
+ * @param value - Cookie 值
+ * @param options - Cookie 选项
+ * @example
+ * ```ts
+ * setCookie('token', 'abc123', { days: 7 })
+ * setCookie('user', { name: 'Alice' }, { secure: true }) // 自动序列化对象
+ * ```
+ */
+declare function setCookie(key: string, value: string | object, options?: CookieOptions): void;
+/**
+ * 获取 Cookie
+ * @param key - Cookie 名称
+ * @returns Cookie 值，不存在返回 undefined
+ * @example
+ * ```ts
+ * const token = getCookie('token')
+ * console.log(token) // 'abc123'
+ * ```
+ */
+declare function getCookie(key: string): string | undefined;
+/**
+ * 移除 Cookie
+ * @param key - Cookie 名称
+ * @param options - Cookie 选项（需要匹配设置时的 path 和 domain）
+ * @example
+ * ```ts
+ * removeCookie('token')
+ * removeCookie('user', { path: '/', domain: '.example.com' })
+ * ```
+ */
+declare function removeCookie(key: string, options?: CookieOptions): void;
+/**
+ * 获取所有 Cookie
+ * @returns Cookie 对象
+ * @example
+ * ```ts
+ * const cookies = getAllCookies()
+ * console.log(cookies) // { token: 'abc123', user: '{"name":"Alice"}' }
+ * ```
+ */
+declare function getAllCookies(): Record<string, string>;
+/**
+ * 检查 Cookie 是否存在
+ * @param key - Cookie 名称
+ * @returns 是否存在
+ * @example
+ * ```ts
+ * if (hasCookie('token')) {
+ *   console.log('Token exists')
+ * }
+ * ```
+ */
+declare function hasCookie(key: string): boolean;
+/**
+ * 获取 JSON 格式的 Cookie
+ * @param key - Cookie 名称
+ * @returns 解析后的对象，不存在或解析失败返回 undefined
+ * @example
+ * ```ts
+ * const user = getCookieJSON<{ name: string; age: number }>('user')
+ * console.log(user?.name) // 'Alice'
+ * ```
+ */
+declare function getCookieJSON<T = object>(key: string): T | undefined;
+/**
+ * 设置 JSON 格式的 Cookie（自动序列化）
+ * @param key - Cookie 名称
+ * @param value - 对象值
+ * @param options - Cookie 选项
+ * @example
+ * ```ts
+ * setCookieJSON('user', { name: 'Alice', age: 25 }, { days: 7 })
+ * ```
+ */
+declare function setCookieJSON<T = object>(key: string, value: T, options?: CookieOptions): void;
+/**
+ * 获取所有 Cookie 的数量
+ * @returns Cookie 数量
+ * @example
+ * ```ts
+ * console.log(getCookieSize()) // 3
+ * ```
+ */
+declare function getCookieSize(): number;
+/**
+ * 存储类型
+ */
+type StorageType = 'local' | 'session' | 'cookie';
+/**
+ * 统一设置存储
+ * @param type - 存储类型
+ * @param key - 键
+ * @param value - 值
+ * @param options - 选项
+ * @example
+ * ```ts
+ * setStorage('local', 'user', { name: 'Alice' })
+ * setStorage('cookie', 'token', 'abc123', { days: 7 })
+ * ```
+ */
+declare function setStorage<T extends string | object>(type: 'local', key: string, value: T, options?: StorageOptions): void;
+declare function setStorage<T extends string | object>(type: 'session', key: string, value: T, options?: StorageOptions): void;
+declare function setStorage<T extends string | object>(type: 'cookie', key: string, value: T, options?: CookieOptions): void;
+/**
+ * 统一获取存储
+ * @param type - 存储类型
+ * @param key - 键
+ * @returns 值
+ * @example
+ * ```ts
+ * const user = getStorage<{ name: string }>('local', 'user')
+ * const token = getStorage('cookie', 'token')
+ * ```
+ */
+declare function getStorage<T = StorageValue>(type: 'local', key: string): T | undefined;
+declare function getStorage<T = StorageValue>(type: 'session', key: string): T | undefined;
+declare function getStorage(type: 'cookie', key: string): string | undefined;
+/**
+ * 统一移除存储
+ * @param type - 存储类型
+ * @param key - 键
+ * @example
+ * ```ts
+ * removeStorage('local', 'user')
+ * removeStorage('cookie', 'token')
+ * ```
+ */
+declare function removeStorage(type: StorageType, key: string): void;
+/**
+ * 统一清除存储
+ * @param type - 存储类型
+ * @example
+ * ```ts
+ * clearStorage('local')
+ * clearStorage('session')
+ * clearStorage('cookie') // 注意：cookie 只能逐个删除
+ * ```
+ */
+declare function clearStorage(type: StorageType): void;
+
+type index_CookieOptions = CookieOptions;
+type index_StorageOptions = StorageOptions;
+type index_StorageType = StorageType;
+type index_StorageValue = StorageValue;
+declare const index_clearLocal: typeof clearLocal;
+declare const index_clearSession: typeof clearSession;
+declare const index_clearStorage: typeof clearStorage;
+declare const index_getAllCookies: typeof getAllCookies;
+declare const index_getCookie: typeof getCookie;
+declare const index_getCookieJSON: typeof getCookieJSON;
+declare const index_getCookieSize: typeof getCookieSize;
+declare const index_getLocal: typeof getLocal;
+declare const index_getLocalKeys: typeof getLocalKeys;
+declare const index_getLocalSize: typeof getLocalSize;
+declare const index_getSession: typeof getSession;
+declare const index_getSessionKeys: typeof getSessionKeys;
+declare const index_getSessionSize: typeof getSessionSize;
+declare const index_getStorage: typeof getStorage;
+declare const index_hasCookie: typeof hasCookie;
+declare const index_removeCookie: typeof removeCookie;
+declare const index_removeLocal: typeof removeLocal;
+declare const index_removeSession: typeof removeSession;
+declare const index_removeStorage: typeof removeStorage;
+declare const index_setCookie: typeof setCookie;
+declare const index_setCookieJSON: typeof setCookieJSON;
+declare const index_setLocal: typeof setLocal;
+declare const index_setSession: typeof setSession;
+declare const index_setStorage: typeof setStorage;
+declare namespace index {
+  export { type index_CookieOptions as CookieOptions, type index_StorageOptions as StorageOptions, type index_StorageType as StorageType, type index_StorageValue as StorageValue, index_clearLocal as clearLocal, index_clearSession as clearSession, index_clearStorage as clearStorage, index_getAllCookies as getAllCookies, index_getCookie as getCookie, index_getCookieJSON as getCookieJSON, index_getCookieSize as getCookieSize, index_getLocal as getLocal, index_getLocalKeys as getLocalKeys, index_getLocalSize as getLocalSize, index_getSession as getSession, index_getSessionKeys as getSessionKeys, index_getSessionSize as getSessionSize, index_getStorage as getStorage, index_hasCookie as hasCookie, index_removeCookie as removeCookie, index_removeLocal as removeLocal, index_removeSession as removeSession, index_removeStorage as removeStorage, index_setCookie as setCookie, index_setCookieJSON as setCookieJSON, index_setLocal as setLocal, index_setSession as setSession, index_setStorage as setStorage };
+}
+
+export { setStorage as A, type CookieOptions as C, type StorageOptions as S, type StorageType as a, type StorageValue as b, clearLocal as c, clearSession as d, clearStorage as e, getCookie as f, getAllCookies as g, getCookieJSON as h, index as i, getCookieSize as j, getLocal as k, getLocalKeys as l, getLocalSize as m, getSession as n, getSessionKeys as o, getSessionSize as p, getStorage as q, hasCookie as r, removeCookie as s, removeLocal as t, removeSession as u, removeStorage as v, setCookie as w, setCookieJSON as x, setLocal as y, setSession as z };

package/dist/index-Bg1ise7y.d.cts

@@ -0,0 +1,253 @@
+import * as cryptoJs from 'crypto-js';
+
+/**
+ * 加密解密模块
+ * 基于 crypto-js 提供常用的加密解密功能
+ */
+
+/**
+ * 加密模式类型
+ */
+type CryptoMode = any;
+/**
+ * 填充方式类型
+ */
+type CryptoPadding = any;
+/**
+ * MD5 加密
+ * @param message 要加密的消息
+ * @returns MD5 哈希值
+ */
+declare const md5: (message: string) => string;
+/**
+ * SHA1 加密
+ * @param message 要加密的消息
+ * @returns SHA1 哈希值
+ */
+declare const sha1: (message: string) => string;
+/**
+ * SHA256 加密
+ * @param message 要加密的消息
+ * @returns SHA256 哈希值
+ */
+declare const sha256: (message: string) => string;
+/**
+ * SHA512 加密
+ * @param message 要加密的消息
+ * @returns SHA512 哈希值
+ */
+declare const sha512: (message: string) => string;
+/**
+ * Hmac-MD5 加密
+ * @param message 要加密的消息
+ * @param key 密钥
+ * @returns Hmac-MD5 哈希值
+ */
+declare const hmacMD5: (message: string, key: string) => string;
+/**
+ * Hmac-SHA1 加密
+ * @param message 要加密的消息
+ * @param key 密钥
+ * @returns Hmac-SHA1 哈希值
+ */
+declare const hmacSHA1: (message: string, key: string) => string;
+/**
+ * Hmac-SHA256 加密
+ * @param message 要加密的消息
+ * @param key 密钥
+ * @returns Hmac-SHA256 哈希值
+ */
+declare const hmacSHA256: (message: string, key: string) => string;
+/**
+ * Hmac-SHA512 加密
+ * @param message 要加密的消息
+ * @param key 密钥
+ * @returns Hmac-SHA512 哈希值
+ */
+declare const hmacSHA512: (message: string, key: string) => string;
+/**
+ * AES 加密
+ * @param message 要加密的消息
+ * @param key 密钥（16/24/32 字节）
+ * @param iv 初始向量（可选，16 字节）
+ * @param mode 加密模式（默认 CBC）
+ * @param padding 填充方式（默认 Pkcs7）
+ * @returns 加密后的密文（Base64 格式）
+ */
+declare const aesEncrypt: (message: string, key: string, iv?: string, mode?: CryptoMode, padding?: CryptoPadding) => string;
+/**
+ * AES 解密
+ * @param ciphertext 密文（Base64 格式）
+ * @param key 密钥（16/24/32 字节）
+ * @param iv 初始向量（可选，16 字节）
+ * @param mode 加密模式（默认 CBC）
+ * @param padding 填充方式（默认 Pkcs7）
+ * @returns 解密后的明文
+ */
+declare const aesDecrypt: (ciphertext: string, key: string, iv?: string, mode?: CryptoMode, padding?: CryptoPadding) => string;
+/**
+ * DES 加密
+ * @param message 要加密的消息
+ * @param key 密钥（8 字节）
+ * @param iv 初始向量（可选，8 字节）
+ * @param mode 加密模式（默认 CBC）
+ * @param padding 填充方式（默认 Pkcs7）
+ * @returns 加密后的密文（Base64 格式）
+ */
+declare const desEncrypt: (message: string, key: string, iv?: string, mode?: CryptoMode, padding?: CryptoPadding) => string;
+/**
+ * DES 解密
+ * @param ciphertext 密文（Base64 格式）
+ * @param key 密钥（8 字节）
+ * @param iv 初始向量（可选，8 字节）
+ * @param mode 加密模式（默认 CBC）
+ * @param padding 填充方式（默认 Pkcs7）
+ * @returns 解密后的明文
+ */
+declare const desDecrypt: (ciphertext: string, key: string, iv?: string, mode?: CryptoMode, padding?: CryptoPadding) => string;
+/**
+ * Triple DES (3DES) 加密
+ * @param message 要加密的消息
+ * @param key 密钥（24 字节）
+ * @param iv 初始向量（可选，8 字节）
+ * @param mode 加密模式（默认 CBC）
+ * @param padding 填充方式（默认 Pkcs7）
+ * @returns 加密后的密文（Base64 格式）
+ */
+declare const tripleDesEncrypt: (message: string, key: string, iv?: string, mode?: CryptoMode, padding?: CryptoPadding) => string;
+/**
+ * Triple DES (3DES) 解密
+ * @param ciphertext 密文（Base64 格式）
+ * @param key 密钥（24 字节）
+ * @param iv 初始向量（可选，8 字节）
+ * @param mode 加密模式（默认 CBC）
+ * @param padding 填充方式（默认 Pkcs7）
+ * @returns 解密后的明文
+ */
+declare const tripleDesDecrypt: (ciphertext: string, key: string, iv?: string, mode?: CryptoMode, padding?: CryptoPadding) => string;
+/**
+ * RC4 加密
+ * @param message 要加密的消息
+ * @param key 密钥
+ * @returns 加密后的密文（Base64 格式）
+ */
+declare const rc4Encrypt: (message: string, key: string) => string;
+/**
+ * RC4 解密
+ * @param ciphertext 密文（Base64 格式）
+ * @param key 密钥
+ * @returns 解密后的明文
+ */
+declare const rc4Decrypt: (ciphertext: string, key: string) => string;
+/**
+ * Rabbit 加密
+ * @param message 要加密的消息
+ * @param key 密钥
+ * @returns 加密后的密文（Base64 格式）
+ */
+declare const rabbitEncrypt: (message: string, key: string) => string;
+/**
+ * Rabbit 解密
+ * @param ciphertext 密文（Base64 格式）
+ * @param key 密钥
+ * @returns 解密后的明文
+ */
+declare const rabbitDecrypt: (ciphertext: string, key: string) => string;
+/**
+ * Base64 编码
+ * @param message 要编码的消息
+ * @returns Base64 编码后的字符串
+ */
+declare const base64Encode: (message: string) => string;
+/**
+ * Base64 解码
+ * @param encoded Base64 编码的字符串
+ * @returns 解码后的原始消息
+ */
+declare const base64Decode: (encoded: string) => string;
+/**
+ * UTF-8 编码
+ * @param message 要编码的消息
+ * @returns UTF-8 编码后的字符串
+ */
+declare const utf8Encode: (message: string) => string;
+/**
+ * UTF-8 解码
+ * @param encoded UTF-8 编码的字符串
+ * @returns 解码后的原始消息
+ */
+declare const utf8Decode: (encoded: string) => string;
+/**
+ * Hex 编码
+ * @param message 要编码的消息
+ * @returns Hex 编码后的字符串
+ */
+declare const hexEncode: (message: string) => string;
+/**
+ * Hex 解码
+ * @param encoded Hex 编码的字符串
+ * @returns 解码后的原始消息
+ */
+declare const hexDecode: (encoded: string) => string;
+/**
+ * 生成随机密钥
+ * @param length 密钥长度（字节）
+ * @returns 随机密钥（Base64 格式）
+ */
+declare const generateKey: (length?: number) => string;
+/**
+ * 生成随机 IV（初始向量）
+ * @param length IV 长度（字节，默认 16）
+ * @returns 随机 IV（Base64 格式）
+ */
+declare const generateIV: (length?: number) => string;
+/**
+ * PBKDF2 密钥派生
+ * @param password 密码
+ * @param salt 盐值
+ * @param iterations 迭代次数
+ * @param keySize 密钥长度（字节）
+ * @returns 派生的密钥（Hex 格式）
+ */
+declare const pbkdf2: (password: string, salt: string, iterations?: number, keySize?: number) => string;
+/**
+ * 生成 UUID v4
+ * @returns UUID 字符串
+ */
+declare const uuid: () => string;
+
+type index_CryptoMode = CryptoMode;
+type index_CryptoPadding = CryptoPadding;
+declare const index_aesDecrypt: typeof aesDecrypt;
+declare const index_aesEncrypt: typeof aesEncrypt;
+declare const index_base64Decode: typeof base64Decode;
+declare const index_base64Encode: typeof base64Encode;
+declare const index_desDecrypt: typeof desDecrypt;
+declare const index_desEncrypt: typeof desEncrypt;
+declare const index_generateIV: typeof generateIV;
+declare const index_generateKey: typeof generateKey;
+declare const index_hexDecode: typeof hexDecode;
+declare const index_hexEncode: typeof hexEncode;
+declare const index_hmacMD5: typeof hmacMD5;
+declare const index_hmacSHA1: typeof hmacSHA1;
+declare const index_hmacSHA256: typeof hmacSHA256;
+declare const index_hmacSHA512: typeof hmacSHA512;
+declare const index_md5: typeof md5;
+declare const index_pbkdf2: typeof pbkdf2;
+declare const index_rabbitDecrypt: typeof rabbitDecrypt;
+declare const index_rabbitEncrypt: typeof rabbitEncrypt;
+declare const index_rc4Decrypt: typeof rc4Decrypt;
+declare const index_rc4Encrypt: typeof rc4Encrypt;
+declare const index_sha1: typeof sha1;
+declare const index_sha256: typeof sha256;
+declare const index_sha512: typeof sha512;
+declare const index_tripleDesDecrypt: typeof tripleDesDecrypt;
+declare const index_tripleDesEncrypt: typeof tripleDesEncrypt;
+declare const index_utf8Decode: typeof utf8Decode;
+declare const index_utf8Encode: typeof utf8Encode;
+declare const index_uuid: typeof uuid;
+declare namespace index {
+  export { cryptoJs as CryptoJS, type index_CryptoMode as CryptoMode, type index_CryptoPadding as CryptoPadding, index_aesDecrypt as aesDecrypt, index_aesEncrypt as aesEncrypt, index_base64Decode as base64Decode, index_base64Encode as base64Encode, index_desDecrypt as desDecrypt, index_desEncrypt as desEncrypt, index_generateIV as generateIV, index_generateKey as generateKey, index_hexDecode as hexDecode, index_hexEncode as hexEncode, index_hmacMD5 as hmacMD5, index_hmacSHA1 as hmacSHA1, index_hmacSHA256 as hmacSHA256, index_hmacSHA512 as hmacSHA512, index_md5 as md5, index_pbkdf2 as pbkdf2, index_rabbitDecrypt as rabbitDecrypt, index_rabbitEncrypt as rabbitEncrypt, index_rc4Decrypt as rc4Decrypt, index_rc4Encrypt as rc4Encrypt, index_sha1 as sha1, index_sha256 as sha256, index_sha512 as sha512, index_tripleDesDecrypt as tripleDesDecrypt, index_tripleDesEncrypt as tripleDesEncrypt, index_utf8Decode as utf8Decode, index_utf8Encode as utf8Encode, index_uuid as uuid };
+}
+
+export { tripleDesEncrypt as A, utf8Decode as B, type CryptoMode as C, utf8Encode as D, uuid as E, type CryptoPadding as a, aesDecrypt as b, aesEncrypt as c, base64Decode as d, base64Encode as e, desDecrypt as f, desEncrypt as g, generateIV as h, index as i, generateKey as j, hexDecode as k, hexEncode as l, hmacMD5 as m, hmacSHA1 as n, hmacSHA256 as o, hmacSHA512 as p, md5 as q, pbkdf2 as r, rabbitDecrypt as s, rabbitEncrypt as t, rc4Decrypt as u, rc4Encrypt as v, sha1 as w, sha256 as x, sha512 as y, tripleDesDecrypt as z };