@xn-lib/base 0.0.19 → 0.0.20

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@xn-lib/base",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/dist/types/base.utils.d.ts

@@ -1,261 +0,0 @@
-/**
- * 复制文本到剪贴板（兼容旧版浏览器）
- * @param text 要复制的文本
- */
-export declare function copy(text: string): void;
-/**
- * 复制文本到剪贴板
- * @param text 要复制的文本
- */
-export declare function copyToClipboard(text: string): void;
-/**
- * 获取剪贴板内容
- * @returns Promise<string>
- */
-export declare function getPasteContent(): Promise<string>;
-/**
- * 判断数据是否可用（不为 null/undefined 且不为空字符串）
- * @param data 要判断的数据
- * @returns boolean
- */
-export declare const isAvailableData: (data: any) => boolean;
-/**
- * 判断数组是否有内容
- * @param data 要判断的数据
- * @returns boolean
- */
-export declare const hasContentArray: (data: any) => boolean;
-/**
- * 判断是否为复杂数据类型（数组或对象）
- * @param data 要判断的数据
- * @returns boolean
- */
-export declare const isComplexData: (data: any) => boolean;
-/**
- * 从对象中筛选出有效数据
- * @param data 原始对象
- * @returns 筛选后的对象
- */
-export declare const pickAvailableData: <T extends Record<string, any>>(data: T) => Partial<T>;
-/**
- * 将列表转换为 Map 结构
- * @param key 作为 key 的字段名
- * @param list 数据列表
- * @param valueKey 作为 value 的字段名或函数
- * @returns 转换后的对象
- */
-export declare const listToMapWith: <T extends Record<string, any>, K extends keyof T>(key: K, list?: T[], valueKey?: string | ((item: T) => any)) => Record<string, any>;
-/**
- * 执行函数，如果函数不存在则返回默认值
- * @param fun 要执行的函数
- * @param defaultReturn 默认返回值
- * @param args 函数参数
- * @returns 函数执行结果或默认值
- */
-export declare function runFun<T = any, R = any>(fun: ((...args: any[]) => R) | null | undefined, defaultReturn?: T | null, ...args: any[]): T | R | null;
-/**
- * 值策略函数
- * @param map 映射对象
- * @param defaultValue 默认值
- * @returns 返回一个函数，根据 key 获取对应的值或默认值
- */
-export declare const valueStrategy: <T = any>(map?: Record<string, T>, defaultValue?: T) => (key: string) => T | undefined;
-/**
- * 条件判断函数
- * @param caseList 条件列表，每个元素为 [条件, 效果] 的元组
- * @param defaultValue 默认值
- * @returns 返回一个函数，根据条件执行对应的效果
- */
-export declare const cond: <T = any>(caseList?: Array<[((...args: any[]) => boolean) | Array<(...args: any[]) => boolean>, (...args: any[]) => T]>, defaultValue?: T | null) => (...args: any[]) => T | null;
-/**
- * 函数策略
- * @param map 函数映射对象
- * @returns 返回一个函数，根据 key 执行对应的函数
- */
-export declare const functionStrategy: <T = any>(map?: Record<string, ((...args: any[]) => T) | undefined>) => (key: string, args?: any[], defaultReturn?: T) => T | undefined;
-/**
- * 对象转换为数组
- * @param obj 原始对象
- * @param options 配置选项
- * @returns 转换后的数组
- */
-export declare const objToArray: <T = any>(obj?: Record<string, T>, options?: {
-    labelKey?: string;
-    valueKey?: string;
-}) => Array<Record<string, any>>;
-/**
- * Map 转换为 JSON 对象
- * @param map Map 对象
- * @returns 转换后的对象
- */
-export declare const mapToJson: <K extends string | number | symbol, V>(map: Map<K, V>) => Record<string, V>;
-/**
- * 转换为数组
- * @param data 要转换的数据
- * @returns 数组
- */
-export declare const toArray: <T>(data: T | T[] | null | undefined) => T[];
-/**
- * 函数包装器，返回一个返回固定值的函数
- * @param data 要返回的数据
- * @returns 返回该数据的函数
- */
-export declare const funWrap: <T>(data: T) => () => T;
-/**
- * 组合函数（类似 Koa 中间件）
- * @param fns 函数列表
- * @returns 组合后的函数
- */
-export declare const compose: (...fns: Array<(ctx: any, next: () => Promise<any>) => Promise<any>>) => (ctx: any, next?: (() => Promise<any>) | null) => Promise<any>;
-/**
- * 条件分支函数
- * @param predictFn 判断函数
- * @param successFn 成功时执行的函数
- * @param failFn 失败时执行的函数
- * @returns 返回一个函数，根据判断结果执行对应的函数
- */
-export declare const ifElse: <T = any>(predictFn: ((...params: any[]) => boolean) | null | undefined, successFn: ((...params: any[]) => T) | null | undefined, failFn: ((...params: any[]) => T) | null | undefined) => (...params: any[]) => T | null;
-/**
- * 延迟函数
- * @param time 延迟时间（毫秒）
- * @returns Promise
- */
-export declare const sleep: (time: number) => Promise<void>;
-/**
- * 从元组中转为对象（已废弃，使用 tupleToObj）
- * @deprecated 使用 tupleToObj 代替
- */
-export declare const markNameFromTuple: (names?: string[], arr?: any[]) => Record<string, any>;
-/**
- * 元组转换为对象
- * @param names 属性名数组
- * @param tuple 元组数据
- * @returns 转换后的对象
- */
-export declare const tupleToObj: (names?: string[], tuple?: any[]) => Record<string, any>;
-/**
- * 元组列表转换为对象数组
- * @param names 属性名数组
- * @param tupleList 元组列表
- * @returns 转换后的对象数组
- */
-export declare const tupleListToArray: (names?: string[], tupleList?: any[][]) => Record<string, any>[];
-/**
- * 根据数组创建选项列表
- * @param arr 原始数组
- * @returns 选项数组，每个选项包含 label 和 value
- */
-export declare const createOptionByArray: <T = string | number>(arr?: T[]) => Array<{
-    label: T;
-    value: T;
-}>;
-/**
- * 可能是函数，如果是函数则执行，否则返回原值
- * @param data 可能是函数的值
- * @param args 函数参数
- * @returns 执行结果或原值
- */
-export declare const maybeFun: <T = any>(data: T | ((...args: any[]) => T), ...args: any[]) => T;
-/**
- * 获取数据类型
- * @param value 要判断的值
- * @returns 数据类型字符串
- */
-export declare const getDataType: (value: any) => string | undefined;
-/**
- * 遍历复杂数据的回调函数类型
- */
-export interface EachComplexDataCallback {
-    (info: {
-        key: string;
-        value: any;
-        dataType: string | undefined;
-        dataPath: string[];
-        parent: any;
-    }): void;
-}
-/**
- * 遍历复杂数据
- * @param json 要遍历的数据
- * @param fn 回调函数
- */
-export declare const eachComplexData: (json: any, fn?: EachComplexDataCallback) => void;
-/**
- * 根据字段映射从数组中提取数据
- * @param array 原始数组
- * @param fieldMaps 字段映射数组，每个元素为 [旧字段名, 新字段名] 的元组
- * @returns 提取后的数组
- */
-export declare const pickDataByArray: <T extends Record<string, any>>(array?: T[], fieldMaps?: Array<[string, string]>) => Array<Record<string, any>>;
-/**
- * 重试函数配置
- */
-export interface RetryOptions {
-    maxCount?: number;
-    retryTime?: number;
-}
-/**
- * 创建重试函数
- * @param fn 要执行的函数
- * @param count 重试次数
- * @param options 重试配置
- * @returns 返回一个支持重试的函数
- */
-export declare function createRetryFun<T extends (...args: any[]) => Promise<any>>(fn: T, count: number, { maxCount, retryTime }?: RetryOptions): T;
-/**
- * 判断两个数组是否不同
- * @param arr1 数组1
- * @param arr2 数组2
- * @returns boolean
- */
-export declare const isDiffArray: <T = any>(arr1: T[], arr2: T[]) => boolean;
-/**
- * 判断是否为有效的JSON或对象
- * @param value 要判断的值
- * @returns boolean
- */
-export declare const isJsonOrObject: (value: any) => boolean;
-/**
- * 下载文件配置选项
- */
-export interface DownloadOptions {
-    /** 文件名 */
-    filename?: string;
-    /** MIME 类型 */
-    mimeType?: string;
-    /** 是否在新窗口打开（用于 URL 下载） */
-    openInNewWindow?: boolean;
-}
-/**
- * 创建临时链接下载选项
- */
-export interface CreateDownloadLinkOptions {
-    /** 文件名 */
-    filename?: string;
-    /** 链接地址 */
-    href: string;
-    /** 是否在新窗口打开 */
-    target?: string;
-    /** 下载完成后是否自动清理 URL（仅用于 Blob URL） */
-    revokeUrl?: boolean;
-}
-/**
- * 创建临时链接并触发下载
- * @param options 下载链接配置选项
- * @returns void
- */
-export declare function createDownloadLink(options: CreateDownloadLinkOptions): void;
-/**
- * 点击下载文件（支持 Blob 和 URL）
- * @param data 要下载的数据，可以是 Blob、File、URL 字符串或数据 URL
- * @param options 下载配置选项
- * @returns Promise<void>
- */
-export declare function downloadFile(data: Blob | File | string, options?: DownloadOptions): Promise<void>;
-/**
- * 从 URL 下载文件
- * @param url 文件 URL
- * @param filename 文件名
- * @returns Promise<void>
- */
-export declare function downloadFileFromUrl(url: string, filename?: string): Promise<void>;

package/dist/types/data.utils.d.ts

@@ -1,196 +0,0 @@
-/**
- * 两个数相乘
- * @param a 数字a
- * @param b 数字b
- * @param [fractionDigits] 截取的小数位数
- * */
-export declare function abMultiply(a: number, b: number, fractionDigits?: number | false): string | number;
-/**
- * 两个数相除
- * @param a 分子
- * @param b 分母
- * @param percentage 是否为百分比的数值，是则乘以100
- * @param fractionDigits 截取的小数位数，默认2，为false时不截取，为true时截取1位
- * */
-export declare function abDivide(a: number, b: number, percentage?: boolean, fractionDigits?: number | false): string | number;
-/**
- * 金额转元，需要除以 ÷ 1000
- * */
-export declare function amountToYuan(price: string | number): number;
-/**
- * 金额转元，并且格式化（用于展示）。
- * @param price 原始金额（厘）
- * @param fractionDigits 保留小数的位数，默认2
- * */
-export declare function formatAmountToYuan(price: number, fractionDigits?: number): string;
-/**
- * 元转金额，需要乘以 × 1000
- * */
-export declare function yuanToAmount(price: string | number): number;
-/**
- * 百分比率转数字（× 100，用于整数值的存储）例如：0.1 -> 100
- * */
-export declare function rateToNumber(rate: string | number): string | number;
-/**
- * 数字转百分比率（÷ 100，用于展示），例如：100 -> 0.1
- * */
-export declare function numberToRate(number: string | number): number;
-/**
- * 比率转百分比（× 100，用于“新”比率的展示、编辑，默认保留 4 位小数）例如：0.010086 -> 1.0086
- * */
-export declare function rateToPercentage(rate: string | number, fractionDigits?: number): number;
-/**
- * 百分比转比率（÷ 100，用于“新”比率的存储）例如：1.0086 -> 0.010086
- * */
-export declare function percentageToRate(rate: string | number): number;
-/**
- * 百分比率格式化，（× 100，保留2位小数，加%，用于展示）例如：0.01 -> 1.00%
- * */
-export declare function formatRate(rate: string | number): string;
-/**
- * 替换字符串文本的值
- * @param content - 原始内容，如果是数字类型则先转为字符串
- * @param searchValue - 被替换的内容，可以是正则
- * @param replaceValue - 新的内容
- */
-export declare function replaceText(content: any, searchValue?: string | RegExp, replaceValue?: string): string;
-/**
- * 转换文件大小
- * -- 按单位转换，例如：字节数(bytes) / 1024 返回为 KB
- * @param size 原始数值，例如字节
- * @param units 单位
- * @param fractionDigits 截取位数
- * @param emptyValue 默认值
- * */
-export declare function transformFileSize(size?: number, units?: number, fractionDigits?: number, emptyValue?: string): string;
-/**
- * 驼峰字符串转换为下划线
- * @param {string} str 原始字符串
- * @return {string}
- * */
-export declare function convertToLowerCase(str: string): string;
-/**
- * 下划线字符串转为换驼峰
- * @param {string} str 原始字符串
- * @return {string}
- * */
-export declare function convertToUpperCase(str: string): string;
-/**
- * 获取某个对象属性的值，支持多级查找
- * @param obj 被查找的对象
- * @param _keys 要查找的属性名称，列如：1, 'a.b', 'b.0.a', ['a', 'b']
- * @param defaultValue 找不属性时的默认值
- * @return {any}
- * */
-export declare function getValue(obj: Record<string, any>, _keys: number | string | string[], defaultValue?: any): any;
-/**
- * 根据已有的值，查找所有父级的值列表
- * @param data 数据列表
- * @param value 当前值
- * @param key 值的属性名，默认`id`
- * @param parentKey 父级的属性名，默认`parentId`
- * @return V[] 返回值列表
- * */
-export declare function getValuesForTree<T extends Record<any, any>, V>(data: T[], value: V, key?: string, parentKey?: string): V[];
-/**
- * 查找对象列表中对应的某一项的值
- * @param list 对象列表
- * @param key 匹配的属性名
- * @param value 当前值
- * @param useKey 读取指定的属性（成功匹配后，直接返回其属性值）
- * @return 匹配项的值 或 原始值
- * */
-export declare function findItemValue<T extends Record<any, any>>(list: T[], key: string, value: any, useKey?: string): any;
-/**
- * 移除对象列表中的某一项（匹配的属性值）
- * @param list 对象列表
- * @param key 匹配的属性名
- * @param value 当前值
- * */
-export declare function removeItem<T extends Record<any, any>>(list: T[], key: string, value: any): void;
-/**
- * 移除列表中的某个值
- * @param list 值列表
- * @param value 当前值
- * */
-export declare function removeValue<T>(list: T[], value: T): void;
-/**
- * 获取静态字典列表中某项的标题
- * @param list 数据列表
- * @param value 当前值
- * @param defaultValue 默认值
- * */
-export declare function getDictLabel(list: Record<any, any>[], value: any, defaultValue?: string): string;
-/**
- * 根据属性名查找数组中所有重复项
- * @param list 原始数组
- * @param props 需要要校验的属性，可以是多个（值的匹配方式为"且"）
- * @return {[]} 重复项的数组
- * */
-export declare function findRepeatedItems<T extends Record<string, any>>(list: T[], props: string | string[]): T[];
-export declare function parseJsonStr(text: any): any;
-export declare function toJsonString(data: any, notEmpty?: boolean): string;
-/**
- * 修剪字符串类型的数据，清除两端空格
- * 如果是 Object，其所有属性 JSON 类型的字符串也会被修剪
- * @param {any} data 原始数据
- * @return any
- * */
-export declare function trimDataValues(data: any): any;
-export declare function removeEmptyString(value: string): string;
-/**
- * 针对 GET 请求时，过滤空值的条件
- * @param params 原始对象
- * @param isTrim 是否需要剔除`字符串类型的值`两端的空格
- * */
-export declare function removeEmptyProps(params: any, isTrim?: boolean): any;
-/**
- * 数字四舍五入
- * @param number 原始数值
- * @param precision 精度，默认0
- * */
-export declare function round(number: number, precision?: number): number;
-/**
- * 截取浮点数字的小数
- * @param number 原始数值
- * @param fractionDigits 截取的位数，默认2（普通的四舍五入）
- * */
-export declare function toFixed(number: number, fractionDigits?: number): string;
-/**
- * 数字格式化
- * 例如：888888.88 -> 888,888.88
- * @param value 数值
- * @param p 分隔开的位数，默认3
- * */
-export declare function formatNumber(value: number | string, p?: number): string;
-/**
- * 拆分字符串为数组
- * @param str 原始字符串
- * @param separator 分隔符
- * */
-export declare function splitString(str: string, separator: string | RegExp): string[];
-/**
- * 拆分字符串形式的数据为数组
- * @param str 原始字符串
- * */
-export declare function splitStringData(str: string): string[];
-/**
- * 补充24个小时段的数据
- * @param hoursData 已存在的小时段数据
- * @param padData 填充的数据
- * @param needPadAfter 是否需要补充当前小时段之后的数据（例如：今日数据的当前时段）
- * */
-export declare function paddingHoursData<T extends Record<any, any>>(hoursData: T[], padData: T, needPadAfter?: boolean): T[];
-export declare function getNumberValue(value: any, defaultValue?: number): number | undefined;
-/**
- * 格式化字符串列表
- * @param str 原始字符串
- * @description 将中文逗号转为英文逗号，空格转为英文逗号，过滤空值，最后用英文逗号连接
- */
-export declare function formatStringList(str: string): string;
-/**
- * 格式化金额显示
- * @param value 金额值
- * @param defaultValue 默认值
- */
-export declare function formatAmount(value: number | string, defaultValue?: string): string;

package/dist/types/date.utils.d.ts

@@ -1,157 +0,0 @@
-import { Dayjs } from 'dayjs';
-export type DateParam = number | string | Date | null;
-export type DateInput = number | string | Date | Dayjs | null | undefined;
-/**
- * 路由查询参数类型
- */
-export interface LocationQuery {
-    startDate?: string | string[];
-    endDate?: string | string[];
-    [key: string]: string | string[] | undefined;
-}
-/**
- * 请求参数类型
- */
-export interface RequestParams {
-    rptDtBegin?: string;
-    rptDtEnd?: string;
-    [key: string]: any;
-}
-/**
- * 日期快捷选项类型
- */
-export interface DatePickerShortcut {
-    text: string;
-    value: () => [string, string];
-}
-/**
- * 创建一个日期对象
- * @param time 可用的日期参数
- * @returns Date 对象
- */
-export declare function newDate(time: DateParam): Date;
-/**
- * 获取当前页面的默认`范围日期`
- * - 首先，尝试读取路由中的参数
- * - 其次，创建当前日期
- * @param query 路由 query 对象。为 null 时表示使用当前时间
- * @param fmt 自定义格式。传入字符串格式时作用于开始和结束、数组时对应开始和结束、固定格式类型（例如需要查询 `daily`每日 或 `hour`小时 的数据）
- * @returns 日期范围数组 [开始日期, 结束日期]
- */
-export declare function getDefaultDates(query: LocationQuery | null, fmt?: 'daily' | 'hour' | string | string[]): string[];
-/**
- * 设置接口请求的范围日期
- * - 为结束日期增加 1个月 或 1天 或 1小时
- * @param params 请求参数的对象
- * @param type 增加的类型
- * @param fmt 处理后的日期格式
- * @returns 处理后的请求参数对象
- */
-export declare function setRequestDates(params: RequestParams, type: 'month' | 'daily' | 'hour', fmt?: string): RequestParams;
-/**
- * 判断两个日期是否为同一天
- * @param start 开始日期
- * @param end 结束日期
- * @returns boolean
- */
-export declare function isSameDate(start: DateParam, end: DateParam): boolean;
-/**
- * 获取两个日期的间隔时间（天数）
- * @param start 开始日期
- * @param end 结束日期
- * @returns 间隔天数
- */
-export declare function getRangeDays(start: DateParam, end: DateParam): number;
-/**
- * 格式化日期为 YYYY-MM-DD 格式
- * @param time 可用的日期
- * @returns 格式化后的日期字符串
- */
-export declare function formatDateToYMD(time?: DateParam): string;
-/**
- * 格式化日期为 YYYY-MM 格式
- * @param time 可用的日期
- * @returns 格式化后的日期字符串
- */
-export declare function formatDateToYM(time?: DateParam): string;
-/**
- * 格式化日期
- * @param time 可用的日期
- * @param fmt 格式，默认 YYYY-MM-DD HH:mm:ss
- * @param padZero 是否`月日时分秒`小于10时填充0，默认填充(可传入字符串指定)。例如 06-01 09:02
- * @returns 格式化后的日期字符串
- */
-export declare function formatDate(time: DateParam, fmt?: string, padZero?: string | boolean): string;
-/**
- * 设置某个日期的月份
- * @param time 可用的日期
- * @param months 需要增加的月数，默认0（支持负数，例如：上个月`-1`）
- * @param fmt 格式，请查看 formatDate()
- * @param dayValue 从 1 到 31 之间的整数，月份中的第几天（JavaScript 1.3 版本之前），默认 1
- * @returns 格式化后的日期字符串
- */
-export declare function setMonths(time: DateParam, months?: number, fmt?: string, dayValue?: number): string;
-/**
- * 为某个日期增加 n 天
- * @param time 可用的日期
- * @param days 需要增加的天数，默认1
- * @param fmt 格式，请查看 formatDate()
- * @returns 格式化后的日期字符串或 Date 对象
- */
-export declare function addDays(time: DateParam, days?: number, fmt?: string): string | Date;
-/**
- * 为某个日期增加 n 小时 -- 适用于精确到小时的范围日期
- * @param time 可用的日期
- * @param hours 需要增加的小时，默认1
- * @param fmt 格式，请查看 formatDate()
- * @returns 格式化后的日期字符串或 Date 对象
- */
-export declare function addHours(time: DateParam, hours?: number, fmt?: string): string | Date;
-/**
- * 为某个日期增加秒数
- * @param time 可用的日期
- * @param seconds 需要增加的秒数
- * @param fmt 格式，请查看 formatDate()
- * @returns 格式化后的日期字符串或 Date 对象
- */
-export declare function addSeconds(time: DateParam, seconds: number, fmt?: string): string | Date;
-/**
- * 获取范围日期的快捷选取的配置
- * @param configs 快捷选项配置数组，每个元素为 [天数, 文本] 的元组
- * @returns 日期快捷选项数组
- */
-export declare function getPickerShortcuts(configs?: [number, string][]): DatePickerShortcut[];
-/**
- * 校验两个日期的天数是否超出范围（默认最大 93 天）
- * @param begin 开始日期
- * @param end 结束日期
- * @param maxDays 最大天数，默认 93
- * @returns 错误信息字符串，如果未超出范围则返回 undefined
- */
-export declare function validateDatesRange(begin: string, end: string, maxDays?: number): string | undefined;
-/**
- * 判断是否为 10 位数字的秒级 unix 时间戳
- * @param v 日期输入
- * @returns boolean
- */
-export declare function isUnix(v: DateInput): boolean;
-/**
- * 将任意输入标准化为 Dayjs 对象
- * @param v 日期输入
- * @returns Dayjs 对象
- */
-export declare const standardTime: (v: DateInput) => Dayjs;
-/**
- * 格式化时间，默认 'YYYY-MM-DD HH:mm:ss'
- * 返回 undefined/null 时原样返回
- * @param v 日期输入
- * @param format 日期格式，默认 'YYYY-MM-DD HH:mm:ss'
- * @returns 格式化后的日期字符串，或 undefined/null
- */
-export declare const formatTime: (v: DateInput, format?: string) => string | undefined | null;
-/**
- * 转为 unix 时间戳（秒）
- * @param date 日期输入
- * @returns Unix 时间戳（秒）
- */
-export declare function toUnix(date: DateInput): number;

package/dist/types/index.d.ts

@@ -1,6 +0,0 @@
-export * from './md5.utils';
-export * from './data.utils';
-export * from './validate.utils';
-export * from './base.utils';
-export * from './tree.utils';
-export * from './date.utils';

package/dist/types/md5.utils.d.ts

@@ -1,2 +0,0 @@
-export declare function createJsonMd5(json?: {}): string | null;
-export declare function createMd5(content?: string): string;