ph-utils 0.20.0 → 1.0.0

package/lib/index.d.ts

@@ -1,15 +1,160 @@
+//#region src/common.d.ts
 /**
  * 验证参数是否为空
  * @param str               待验证的参数
  * @param ignoreWhitespace  如果是字符串是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
  */
-export declare function isBlank(str?: any, ignoreWhitespace?: boolean): boolean;
+declare function isBlank(str?: any, ignoreWhitespace?: boolean): boolean;
 /**
- * 屏蔽手机号，中间部分用 * 展示
+ * 屏蔽手机号，中间部分用 * 展示（保持向后兼容）
  * @param mobile 待屏蔽的手机号
- * @returns 屏蔽后的手机号，例如：123 **** 1234
+ * @param placeholder 遮掩字符，默认: '*'
+ * @returns 屏蔽后的手机号，例如：138****5678
  */
-export declare function shieldMobile(mobile: string): string;
+declare function shieldMobile(mobile: string, placeholder?: string): string;
+/**
+ * 通用的字符串遮掩配置
+ */
+interface ShieldOptions {
+  /** 需要遮掩的字符串 */
+  str: string;
+  /** 开始保留的字符数（从开头计数），默认: 3 */
+  startKeep?: number;
+  /** 结束保留的字符数（从结尾计数），默认: 4 */
+  endKeep?: number;
+  /** 遮掩字符，默认: '*' */
+  placeholder?: string;
+  /** 是否在遮掩部分前后添加空格，默认: false */
+  addSpaces?: boolean;
+  /** 自定义遮掩逻辑函数，如果提供则忽略其他配置 */
+  customShield?: (str: string) => string;
+  /** 最大输出长度，超过则截断，默认: 不限制 */
+  maxLength?: number;
+  /** 截断时是否显示省略号，默认: true */
+  showEllipsis?: boolean;
+  /** 省略号字符，默认: '...' */
+  ellipsis?: string;
+}
+/**
+ * 通用字符串遮掩函数
+ * @param options 配置参数
+ * @returns 遮掩后的字符串
+ *
+ * @example
+ * // 基本遮掩: 13812345678 -> 138****5678
+ * shieldString({ str: '13812345678' })
+ *
+ * @example
+ * // 限制长度: 64位字符串 -> 只显示前20位
+ * shieldString({
+ *   str: '1234567890123456789012345678901234567890123456789012345678901234',
+ *   startKeep: 8,
+ *   endKeep: 8,
+ *   maxLength: 20
+ * })
+ * // 结果: 12345678****87654321
+ *
+ * @example
+ * // 带省略号截断
+ * shieldString({
+ *   str: '1234567890123456789012345678901234567890123456789012345678901234',
+ *   startKeep: 8,
+ *   endKeep: 8,
+ *   maxLength: 15,
+ *   showEllipsis: true
+ * })
+ * // 结果: 12345678...8765
+ */
+declare function shieldString(options: ShieldOptions): string;
+/**
+ * 简化版：遮掩并限制长度
+ * @param str 待遮掩的字符串
+ * @param options 配置选项
+ * @returns 遮掩并截断后的字符串
+ *
+ * @example
+ * // 遮掩手机号并限制显示长度
+ * shieldWithLimit('13812345678', { maxLength: 8 }) // 138****78
+ *
+ * @example
+ * // 遮掩长字符串
+ * shieldWithLimit('12345678901234567890', {
+ *   startKeep: 4,
+ *   endKeep: 4,
+ *   maxLength: 12
+ * }) // 1234****7890
+ */
+declare function shieldWithLimit(str: string, options: Omit<ShieldOptions, "str"> & {
+  maxLength: number;
+}): string;
+/**
+ * 智能摘要：根据重要性自动调整保留位数
+ * @param str 待处理的字符串
+ * @param maxLength 最大输出长度
+ * @param placeholder 遮掩字符
+ * @returns 摘要后的字符串
+ *
+ * @example
+ * // 长字符串自动摘要
+ * smartSummary('12345678901234567890', 10) // 1234****90
+ *
+ * @example
+ * // 短字符串不变
+ * smartSummary('12345', 10) // 12345
+ */
+declare function smartSummary(str: string, maxLength: number, placeholder?: string): string;
+/**
+ * 屏蔽邮箱
+ * @param email 待屏蔽的邮箱
+ * @param placeholder 遮掩字符，默认: '*'
+ * @returns 屏蔽后的邮箱，例如：exa****@email.com
+ */
+declare function shieldEmail(email: string, placeholder?: string): string;
+/**
+ * 屏蔽身份证号
+ * @param idCard 待屏蔽的身份证号
+ * @param placeholder 遮掩字符，默认: '*'
+ * @returns 屏蔽后的身份证号，例如：110101********1234
+ */
+declare function shieldIdCard(idCard: string, placeholder?: string): string;
+/**
+ * 屏蔽银行卡号（带空格格式化）
+ * @param bankCard 待屏蔽的银行卡号
+ * @param placeholder 遮掩字符，默认: '*'
+ * @returns 屏蔽后的银行卡号，例如：622848 **** **** 9018
+ */
+declare function shieldBankCard(bankCard: string, placeholder?: string): string;
+/**
+ * 屏蔽姓名
+ * @param name 待屏蔽的姓名
+ * @param placeholder 遮掩字符，默认: '*'
+ * @returns 屏蔽后的姓名，例如：张** 或 张*三
+ */
+declare function shieldName(name: string, placeholder?: string): string;
+/**
+ * 检测敏感信息并智能遮掩（支持长度控制）
+ * @param str 待检测的字符串
+ * @param placeholder 遮掩字符，默认: '*'
+ * @param maxLength 最大输出长度，默认: 不限制
+ * @returns 遮掩后的字符串，自动识别类型
+ *
+ * @example
+ * // 手机号：138****5678
+ * smartShield('13812345678')
+ *
+ * @example
+ * // 邮箱：exa****@email.com
+ * smartShield('example@email.com')
+ *
+ * @example
+ * // 身份证：110101********1234
+ * smartShield('110101199001011234')
+ *
+ * @example
+ * // 限制长度
+ * smartShield('13812345678', '*', 8) // 138****78
+ */
+declare function smartShield(str: string, placeholder?: string, maxLength?: number): string;
 /**
  * 验证参数是否是数字
  * @param str 待验证的字符串
@@ -18,34 +163,34 @@ export declare function shieldMobile(mobile: string): string;
  * @param numericParam.isFloat 是否是小数, 默认: true
  * @returns true 是数字, false 不是数字
  */
-export declare function isNumeric(str: string, numericParam?: {
-    isPositive?: boolean;
-    isFloat?: boolean;
+declare function isNumeric(str: string, numericParam?: {
+  isPositive?: boolean;
+  isFloat?: boolean;
 }): boolean;
 /**
  * 验证参数是否是Boolean 类型
  * @param str 待验证的字符串
  * @returns
  */
-export declare function isBoolean(str: string): boolean;
+declare function isBoolean(str: string): boolean;
 /** 生成随机数的选项 */
 interface RandomStringOption {
-    /** 生成指定长度的随机字符串 */
-    length: number;
-    /** 是否包含英文字母, 默认为: true */
-    hasLetter?: boolean;
-    /** 生成纯数字的随机数时, 首位是否允许为 0, 默认为: true */
-    firstIsZero?: boolean;
+  /** 生成指定长度的随机字符串 */
+  length: number;
+  /** 是否包含英文字母, 默认为: true */
+  hasLetter?: boolean;
+  /** 生成纯数字的随机数时, 首位是否允许为 0, 默认为: true */
+  firstIsZero?: boolean;
 }
 interface RangeRandomOption {
-    /** 配合 max 生成 [min~max] 之间的随机数 */
-    min: number;
-    /** 配合 min 生成 [min~max] 之间的随机数 */
-    max: number;
-    /** 生成的随机数，是否包含 max, 默认: false */
-    hasEnd?: boolean;
-    /** 生成的随机数是否是整数, 默认: true */
-    isInteger?: boolean;
+  /** 配合 max 生成 [min~max] 之间的随机数 */
+  min: number;
+  /** 配合 max 生成 [min~max] 之间的随机数 */
+  max: number;
+  /** 生成的随机数，是否包含 max, 默认: false */
+  hasEnd?: boolean;
+  /** 生成的随机数是否是整数, 默认: true */
+  isInteger?: boolean;
 }
 /**
  * 生成指定长度的随机数
@@ -55,7 +200,7 @@ interface RangeRandomOption {
  * @example <caption>1. 生成指定长度的随机字符串</caption>
  * random(1); // 长度为 1 的随机字符串
  */
-export declare function random(len: number): string;
+declare function random(len: number): string;
 /**
  * 生成介于 [min, max] 之间的随机数
  *
@@ -65,7 +210,7 @@ export declare function random(len: number): string;
  * @param option.hasEnd 生成的随机数，是否包含 max, 默认: false
  * @param option.isInteger 生成的随机数是否是整数, 默认: true
  */
-export declare function random(option: RangeRandomOption): number;
+declare function random(option: RangeRandomOption): number;
 /**
  * 生成指定长度随机数
  *
@@ -77,40 +222,19 @@ export declare function random(option: RangeRandomOption): number;
  * @example <caption>2. 生成纯数字且首位不能为0长度为1的随机字符</caption>
  * random({ length: 1, hasLetter: false, firstIsZero: false })
  */
-export declare function random(option: RandomStringOption): string;
-/**
- * 带有错误名称标记的错误类型
- */
-export declare class BaseError extends Error {
-    /**
-     * 错误名称，类似于 Java 中的不同的 Exception[NullPointerException]；
-     * 增加 name 字段，表明不同的错误，当需要根据不同的错误执行不同的处理的时候，会很有用
-     */
-    name: string;
-    /**
-     * 构造一个 name = BaseError 的错误信息
-     * @param message 错误描述
-     */
-    constructor(message: string);
-    /**
-     *
-     * @param name 错误名称
-     * @param message 错误描述
-     */
-    constructor(name: string, message: string);
-}
+declare function random(option: RandomStringOption): string;
 /**
  * 将金额数字格式化为金额格式显示并且会保留两位小数[去除多余的位数，不是四舍五入，而是直接舍去]  1234523432.23 => 123,123,123.23
  * @param {number} number 待转换的金额数字
  * @return string
  */
-export declare function formatMoney(number: number): string;
+declare function formatMoney(number: number): string;
 /**
  * 将风格由大写风格转换为下划线风格: HelloWorld -> hello-world
  * @param name 命名, 例如: HelloWorld
  * @param connector 连接符, 默认为: _
  */
-export declare function snakeCaseStyle(name: string, connector?: string): string;
+declare function snakeCaseStyle(name: string, connector?: string): string;
 /**
  * 对数字进行四舍五入处理
  * @param num 需要进行四舍五入的数字
@@ -121,21 +245,19 @@ export declare function snakeCaseStyle(name: string, connector?: string): string
  *        2: 向下取整
  * @returns 返回经过指定方式舍入后的数字
  */
-export declare function round(num: number, precision?: number, roundType?: 0 | 1 | 2): number;
+declare function round(num: number, precision?: number, roundType?: 0 | 1 | 2): number;
 /**
  * 反转字符串
  */
-export declare function reverseStr(str: string): string;
+declare function reverseStr(str: string): string;
 /** 数据格式化配置 */
 interface FormDataConfig<T> {
-    /** 配置需要转换为数字的字段 */
-    numberFields?: (keyof T)[];
-    /** 配置需要转换为字符串的字段 */
-    stringFields?: (keyof T)[];
-    /** 自定义的格式化 */
-    formatter?: {
-        [K in keyof T]?: "number" | "string" | ((value: any) => number | string);
-    };
+  /** 配置需要转换为数字的字段 */
+  numberFields?: (keyof T)[];
+  /** 配置需要转换为字符串的字段 */
+  stringFields?: (keyof T)[];
+  /** 自定义的格式化 */
+  formatter?: { [K in keyof T]?: "number" | "string" | ((value: any) => number | string); };
 }
 /**
  * 嵌套的 json 指定 key 数据
@@ -143,12 +265,444 @@ interface FormDataConfig<T> {
  * @param keys 待获取的数据 key, 可以通过 [.] 获取嵌套数据, 例如: a.b.c
  * @returns
  */
-export declare function getJSONValue(data: Record<string, any>, keystr: string): Record<string, any> | null;
+declare function getJSONValue(data: Record<string, any>, keystr: string): Record<string, any> | null;
 /**
  * 数据格式化主要用于数据类型转换
  * @param data 待转换数据类型的数据
  * @param config 转换配置
  * @returns
  */
-export declare function formatData<T extends Record<string, any>>(data: T, config?: FormDataConfig<T>): T;
-export {};
+declare function formatData<T extends Record<string, any>>(data: T, config?: FormDataConfig<T>): T;
+//#endregion
+//#region src/date.d.ts
+/**
+ * 将日期格式化为指定形式的字符串
+ * @param date      日期
+ * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时(24时制), MM - 分钟, ss - 秒, S - 毫秒, 默认: yyyy-mm-dd HH:MM:ss
+ */
+declare function format(date?: Date | string | number | null, pattern?: string): string;
+/**
+ * 将指定的参数解析为日期对象(Date)
+ * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
+ * @param date 待解析的日期参数
+ */
+declare function parse(date?: Date | string | number | null): Date;
+/**
+ * 设置日期的开始或者结束的点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date[D]、Minute[M], 默认为 Date
+ * @param isEnd true则为 endOf
+ */
+declare function dateOf(date?: Date | string | number | null, unit?: string, isEnd?: boolean): Date;
+/**
+ * 设置日期的开始的点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date[D]、Minute[M], 默认为 Date
+ * @returns
+ */
+declare function startOf(date?: Date | string | number | null, unit?: string): Date;
+/**
+ * 设置日期的结束点
+ * @param date 日期，能够被 parse 解析的日期
+ * @param unit 单位，Date[D]、Minute[M], 默认为 Date
+ * @returns
+ */
+declare function endOf(date?: Date | string | number | null, unit?: string): Date;
+/**
+ * 获取时间戳
+ * @param ctime 时间
+ * @param pre 精度, s - 精确到秒, ms - 精确到毫秒, 默认: s
+ * @returns
+ */
+declare function timestamp(ctime?: Date | string | number, pre?: "s" | "ms"): number;
+/**
+ * 日期加上指定时间后的日期
+ * @param date 指定的日期
+ * @param num  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit 需要添加的单位，date、month、year、hours、minute、second
+ *
+ * 查阅文档: {@link https://gitee.com/towardly/ph/wikis/utils/date ph-utils}
+ *
+ * @example <caption>1. 分钟加1并格式化显示时间</caption>
+ *
+ * add(new Date(), 1, 'minute', 'HHMMss')
+ */
+declare function add(date: Date | string | number | null, num: number, unit: string): Date;
+/**
+ * 日期加上指定时间后的日期
+ * @param date    指定的日期, 传递为 null ，则表示为当前日期
+ * @param num     需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit    需要添加的单位，date - 加减天数
+ * @param fmt     如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ *
+ * #### 1. 前一天的日期字符串形式
+ * ```javascript
+ * add(new Date(), -1, 'Date', 'yyyy-mm-dd')
+ * ```
+ */
+declare function add(date: Date | string | number | null, num: number, unit: string, fmt: string): string;
+//#endregion
+//#region src/color.d.ts
+type RGBColorObject = {
+  r: number;
+  g: number;
+  b: number;
+  a?: number;
+};
+type HSVColorObject = {
+  h: number;
+  s: number;
+  v: number;
+};
+type ColorType = string | RGBColorObject | HSVColorObject;
+/**
+ * 将输入的颜色值转换为RGB对象格式。
+ * @param color 可以是字符串, 也可以是一个 HSV 对象[一个包含 h、s、v 属性的对象]
+ * @returns 返回一个包含r、g、b和a（透明度）属性的RGB对象。
+ * @throws 如果输入的字符串不是有效的颜色表示，则抛出错误。
+ */
+declare function toRgb(color: ColorType): RGBColorObject;
+/**
+ * 将颜色转换为HSV颜色模型。
+ * @param color - 字符串或者RGB对象
+ * @returns 返回一个包含h、s、v属性的对象，代表HSV颜色值，其中h是色相（取值范围0到360），s是饱和度（取值范围0到1），v是明度（取值范围0到1）。
+ */
+declare function toHsv(color: ColorType): HSVColorObject;
+/**
+ * 将RGB颜色对象转换为十六进制颜色字符串。
+ * @param rgb - 包含红色(r), 绿色(g), 蓝色(b)成分的对象。
+ * @returns 返回一个表示RGB颜色的十六进制字符串，例如"#FF0000"。
+ */
+declare function rgbToHex(rgb: RGBColorObject): string;
+/**
+ * 将颜色转换为 16 进制字符串
+ * @param color - 颜色, 可以 rgb(0,0,0),rgba(0,0,0,0)字符串, 也可以是 rgb、hsv对象
+ * @returns 返回颜色的十六进制字符串，例如"#FF0000"
+ */
+declare function toHex(color: ColorType): string;
+/**
+ * 调整给定颜色深[darken]浅[lighten]
+ * @param color - 输入的颜色，可以是任意颜色表示方式
+ * @param level - 调整深浅级别, 可以是小数。默认: 1
+ * @param light - 控制调整的方向。如果为true，[lighten] 变浅，如果为false，[darken] 变深。默认: true
+ * 1. 颜色变浅
+ * adjust('#4998f4', 3, true)
+ * @returns 返回调整后颜色的十六进制字符串表示。
+ */
+declare function adjust(color: ColorType, level?: number, light?: boolean): string;
+//#endregion
+//#region src/array.d.ts
+/**
+ * 数组排序（不修改原数组，返回新数组）
+ * @param arr 待排序数组
+ * @param order 排序方向: "asc" - 升序（默认）, "desc" - 降序
+ * @param orderKey 如果数组元素是对象，指定按哪个字段排序；为 null 时按元素本身排序
+ * @returns 排序后的新数组
+ */
+declare function order<T>(arr: T[], order?: "asc" | "desc", orderKey?: keyof T | null): T[];
+/** 重载：所有参数为 Set 时，返回 Set */
+declare function intersection<T>(...arrs: Set<T>[]): Set<T>;
+/** 重载：所有参数为 Array 时，返回 Array */
+declare function intersection<T>(...arrs: T[][]): T[];
+/** 重载：所有参数为 Set 时，返回 Set */
+declare function difference<T>(...arrs: Set<T>[]): Set<T>;
+/** 重载：所有参数为 Array 时，返回 Array */
+declare function difference<T>(...arrs: T[][]): T[];
+/** 重载：所有参数为 Set 时，返回 Set */
+declare function union<T>(...arrs: Set<T>[]): Set<T>;
+/** 重载：所有参数为 Array 时，返回 Array */
+declare function union<T>(...arrs: T[][]): T[];
+/** 重载：所有参数为 Set 时，返回 Set */
+declare function symmetricDifference<T>(...arrs: Set<T>[]): Set<T>;
+/** 重载：所有参数为 Array 时，返回 Array */
+declare function symmetricDifference<T>(...arrs: T[][]): T[];
+/**
+ * 判断 a1 是否是 a2 的子集（a1 的所有元素是否都在 a2 中）
+ * - 优先使用原生 ES2025 Set.prototype.isSubsetOf
+ * - 数组模式使用 Set.has 替代 includes，性能优化
+ * @param a1 待判断集合（可能是子集）
+ * @param a2 目标集合（可能是超集）
+ * @returns a1 ⊆ a2 时返回 true
+ */
+declare function isSubsetOf<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): boolean;
+/**
+ * 判断 a1 是否是 a2 的超集（a2 的所有元素是否都在 a1 中）
+ * 逻辑等价于：a2 是 a1 的子集
+ * @param a1 待判断集合（可能是超集）
+ * @param a2 目标集合（可能是子集）
+ * @returns a1 ⊇ a2 时返回 true
+ */
+declare function isSupersetOf<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): boolean;
+/**
+ * 判断两个集合是否没有公共元素（不相交）
+ * - 优先使用原生 ES2025 Set.prototype.isDisjointFrom
+ * - 数组模式使用 Set.has 替代 includes，性能优化
+ * @param a1 集合 1
+ * @param a2 集合 2
+ * @returns 两集合无交集时返回 true
+ */
+declare function isDisjointFrom<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): boolean;
+//#endregion
+//#region src/id.d.ts
+type SnowflakeIDInfo = {
+  value: string;
+  timeOffset: bigint;
+  timestamp: number;
+  machineId: bigint;
+  sequence: bigint;
+  epoch: number;
+  version: string | undefined;
+};
+/** 雪花ID, 推荐在全局构造一个对象用于生成id */
+declare class SnowflakeID {
+  private static readonly SEQUENCE_MASK;
+  private static readonly TIMESTAMP_MASK;
+  private static readonly MACHINE_MASK;
+  private static readonly SHIFT_TIMESTAMP;
+  private static readonly SHIFT_MACHINE;
+  private static readonly MAX_MACHINE_ID;
+  private static readonly DEFAULT_MAX_CLOCK_TOLERANCE;
+  private static readonly MAX_ID;
+  private static readonly STATES;
+  /** 机器码, 默认为: 1 */
+  readonly machineId: bigint;
+  /** 起始时间戳, 默认为：1288834974657 */
+  readonly epoch: bigint;
+  /** 版本号, 默认为: 0 */
+  private _version;
+  /** 允许的最大时钟回拨毫秒数, 默认为: 5 */
+  readonly maxClockTolerance: number;
+  private readonly _state;
+  /**
+   * 构造函数
+   *
+   * @param machineId 机器标识，默认为1
+   * @param epoch 时间戳起始值，默认为1288834974657
+   * @param maxClockTolerance 允许的最大时钟回拨毫秒数，默认为5
+   */
+  constructor(machineId?: number, epoch?: number, maxClockTolerance?: number);
+  get version(): number;
+  set version(version: number);
+  /**
+   * 生成雪花ID
+   *
+   * @returns 返回生成的唯一ID字符串
+   * @throws 如果时钟回拨超过容差阈值，抛出错误
+   */
+  generate(): string;
+  parse(snowflakeID: string, epoch?: number, includeVersion?: boolean): SnowflakeIDInfo;
+}
+/** 将uuid转换为更简单的唯一标记id */
+declare class ShortUUID {
+  private alphabet;
+  /**
+   * 构造函数，用于初始化字母表
+   * @param {string} [alphabet] - 可选参数，用于指定自定义字母表
+   * 如果提供了alphabet参数，则将其设置为实例的字母表属性
+   * 如果未提供alphabet参数，则使用默认值
+   */
+  constructor(alphabet?: string);
+  /**
+   * 将UUID字符串进行编码处理
+   * @param uuid - 需要编码的UUID字符串
+   * @returns 编码后的字符串
+   */
+  encode(uuid: string, alphabet?: string): string;
+  /**
+   * 解码短UUID字符串，将其转换为UUID整数和十六进制格式
+   * @param shortUUID - 需要解码的短UUID字符串
+   * @returns 返回包含UUID整数和十六进制格式的对象
+   */
+  decode(shortUUID: string, alphabet?: string): {
+    uuidInt: bigint;
+    uuid: string;
+  };
+  private _stringToInt;
+  private _intToString;
+  private _uuidHexToInt;
+  private _uuidIntToHex;
+}
+//#endregion
+//#region src/crypto.d.ts
+/**
+ * 将原始的二进制数据转换为 Hex String
+ * @param bf 待转换的原始数据
+ * @param upper 是否需要转换为大写
+ * @returns
+ */
+declare function bufferToHex(bf: ArrayBuffer | Uint8Array, upper?: boolean): string;
+/**
+ * SHA 哈希算法
+ * @param message     待进行 hash 的数据
+ * @param upper       是否转换为大写, 默认为: false
+ * @param algorithm   hash算法, 支持: SHA-1、SHA-256、SHA-384、SHA-512; 默认为: SHA-256
+ * @returns
+ */
+declare function sha(message: string | ArrayBuffer, upper?: boolean, algorithm?: string): Promise<string>;
+/**
+ * 哈希算法
+ * @param message     待进行 hash 的数据
+ * @param upper       是否转换为大写, 默认为: false
+ * @param algorithm   hash算法, 支持: SHA-1、SHA-256、SHA-384、SHA-512; 默认为: SHA-256
+ * @returns
+ */
+declare function hash(message: string | ArrayBuffer, upper?: boolean, algorithm?: string): Promise<string>;
+type HMACAlgorithm = "SHA-256" | "SHA-512";
+/**
+ * 使用 HMAC 算法计算消息的哈希值
+ * @param message - 需要计算哈希的消息字符串
+ * @param secret - 用于生成 HMAC 的密钥
+ * @param algorithm - HMAC 使用的哈希算法,默认为 "SHA-256"
+ * @param upper - 是否将结果转换为大写,默认为 false
+ * @returns 返回十六进制格式的 HMAC 哈希值
+ */
+declare function hmacHash(message: string, secret: string, algorithm?: HMACAlgorithm, upper?: boolean): Promise<string>;
+/** 返回结果类似 */
+type AlgorithmResType = "hex" | "hexUpper" | "base64" | "raw";
+/**
+ * AES 加密
+ * @param message 待加密的数据
+ * @param key 加解密密钥
+ * @param encode 加密后的数据转换的形式, hex - 转换为16进制字符串, hexUpper - 转换为16进制且大写, base64 - 转换为 base64 形式
+ * @param iv 加解密向量
+ * @returns [加密数据,向量]
+ */
+declare function aesEncrypt(message: string, key: string, encode?: AlgorithmResType, iv?: null | Uint8Array | string): Promise<{
+  ciphertext: string | ArrayBuffer;
+  iv: string;
+  key: string;
+}>;
+/**
+ * AES 解密
+ * @param message 加密后的数据
+ * @param key     解密密钥
+ * @param iv      向量
+ * @param encode  加密后数据的形式: hex | base64
+ * @returns
+ */
+declare function aesDecrypt(message: Uint8Array | string, key: string, iv: string, encode?: AlgorithmResType): Promise<string>;
+/**
+ * RSA 加密
+ * @param key     公钥
+ * @param message 待加密数据
+ * @param encode  返回类型
+ * @returns
+ */
+declare function rsaEncrypt(message: string, publicKey: string, encode?: AlgorithmResType): Promise<string | ArrayBuffer>;
+/**
+ * RSA 解密
+ * @param key     私钥, 根据私钥解密
+ * @param message 加密后的数据
+ * @param encode  加密后的数据形式
+ * @returns
+ */
+declare function rsaDecrypt(privateKey: string, message: Uint8Array | string, encode?: AlgorithmResType): Promise<string>;
+//#endregion
+//#region src/base-codec.d.ts
+declare class BaseCodec {
+  protected readonly alphabet: string;
+  protected readonly base: bigint;
+  protected readonly name: string;
+  constructor(name: string, alphabet: string);
+  protected intToBytes(value: bigint): Uint8Array;
+  protected bytesToInt(bytes: Uint8Array): bigint;
+  protected concatBytes(...arrays: Uint8Array[]): Uint8Array;
+  protected bytesToUtf8(bytes: Uint8Array): string;
+  protected utf8ToBytes(str: string): Uint8Array;
+  protected bytesToHex(bytes: Uint8Array): string;
+  protected encodeFromBytes(input: Uint8Array): string;
+  protected decodeToBytes(input: string): Uint8Array;
+  /** 将非负 bigint 编码为字符串 */
+  encodeFromInt(value: bigint): string;
+  /** 先将字符串转换为 UTF-8 字节，再编码 */
+  encodeFromStr(value: string): string;
+  /** 根据参数类型将 bigint 或字符串编码 */
+  encode(value: bigint | string): string;
+  /** 解码为非负 bigint */
+  decodeToInt(value: string): bigint;
+  /** 解码为 UTF-8 字符串 */
+  decodeToStr(value: string): string;
+  /** 默认解码为 UTF-8 字符串 */
+  decode(value: string): string;
+  /** 将字节数组转换为十六进制字符串 */
+  bufferToHex(value: Uint8Array): string;
+}
+declare class Base32 extends BaseCodec {
+  constructor();
+}
+declare class Base62 extends BaseCodec {
+  constructor();
+}
+//#endregion
+//#region src/validator.d.ts
+interface RuleItem {
+  rule: RegExp | ((v: any) => boolean) | "required";
+  message: string;
+  sameKey?: string;
+}
+type RuleType = string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
+  rule: string | RegExp | ((v: any) => boolean);
+  message?: string;
+});
+interface SchemaType {
+  /** 数据字段 */
+  key: string;
+  /** 是否必须 */
+  required?: boolean;
+  /** 验证规则列表 */
+  rules?: RuleType[];
+  /** 错误信息 */
+  message?: string;
+}
+/**
+ * 数据验证器
+ */
+declare class Validator {
+  rules: Record<string, RuleItem[]>;
+  /**
+   * 构造数据验证转换器
+   *
+   * See {@link https://gitee.com/towardly/ph/wikis/utils/validator|Validator文档}.
+   *
+   * @param schemas 配置验证转换规则
+   *
+   * @example
+   *
+   * const validator = new Validator([
+   *  { key: 'mobile', rules: ['required', 'mobile'] },
+   *  { key: 'code': rules: /^\d{6}$/, message: '请输入正确的验证码' },
+   *  { key: 'confirmPassword', rules: ['required', 'same:password'] }
+   * ])
+   * // 验证某一个字段
+   * validator.validateKey().then(res => {})
+   */
+  constructor(schemas: SchemaType[]);
+  addSchemas(schemas: SchemaType[]): void;
+  addSchema(schema: SchemaType): void;
+  setSchema(schema: SchemaType): void;
+  setSchemas(schemas: SchemaType[]): void;
+  removeSchema(key: string): void;
+  hasSchema(key: string): boolean;
+  /**
+   * 进行数据验证
+   * @param data 待验证的数据
+   * @param all 是否全部验证, false - 只要验证错误一个则停止验证
+   * @returns
+   */
+  validate(data: any, all?: boolean): boolean;
+  /**
+   * 只验证指定 key 的数据格式
+   * @param key   指定待验证的 key
+   * @param value 待验证的数据
+   * @param data 原始数据，当验证确认密码时需要使用
+   */
+  validateKey(key: string, value: any, data?: any): {
+    key: string;
+    value: any;
+  };
+  private _validateRule;
+  private _parseSchemaRules;
+  private _parseStringRule;
+}
+//#endregion
+export { Base32, Base62, type RuleType, type SchemaType, ShortUUID, SnowflakeID, Validator, add, adjust, aesDecrypt, aesEncrypt, bufferToHex, dateOf, difference, endOf, format, formatData, formatMoney, getJSONValue, hash, hmacHash, intersection, isBlank, isBoolean, isDisjointFrom, isNumeric, isSubsetOf, isSupersetOf, order, parse, random, reverseStr, rgbToHex, round, rsaDecrypt, rsaEncrypt, sha, shieldBankCard, shieldEmail, shieldIdCard, shieldMobile, shieldName, shieldString, shieldWithLimit, smartShield, smartSummary, snakeCaseStyle, startOf, symmetricDifference, timestamp, toHex, toHsv, toRgb, union };