@xn-lib/base 0.0.31 → 0.1.2

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

@@ -0,0 +1,212 @@
+type CommonOption = {
+    label: string;
+    value: any;
+    disabled?: boolean;
+    [key: string]: any;
+};
+/**
+ * 两个数相乘
+ * @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;
+export declare function thousandMark(value: number): string;
+export declare function percentage(value: number): string;
+export declare function objectToOptions(obj: Record<string, string>): {
+    value: string;
+    label: string;
+}[];
+export declare function listToOptions<T extends object>(list: T[], labelKey: keyof T, valueKey: keyof T, options?: {
+    mapFn?: (item: T, index: number) => Record<string, any>;
+}): CommonOption[] & Record<string, any>;
+export {};

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

@@ -0,0 +1,157 @@
+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

@@ -0,0 +1,6 @@
+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

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

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

@@ -0,0 +1,66 @@
+/**
+ * 递归遍历树形数据的选项
+ */
+export interface RecursionTreeOptions<T = any> {
+    /** 子节点的键名，默认为 'children' */
+    childrenKey?: string;
+    /** 访问每个节点时的回调函数 */
+    visit?: (item: T, parent: T | null, index: number, path: T[]) => void;
+    /** 停止遍历的条件函数，返回 true 时停止遍历 */
+    stop?: (item: T) => boolean;
+}
+/**
+ * 递归遍历树形数据
+ * @param data 树形数据，可以是数组或单个对象
+ * @param options 遍历选项
+ * @returns void
+ */
+export declare const recursionTree: <T extends Record<string, any> = any>(data?: T | T[], options?: RecursionTreeOptions<T>) => void;
+/**
+ * 数组转树形结构的选项
+ */
+export interface ArrayToTreeOptions<T = any> {
+    /** 父节点的键名，默认为 'parentId' */
+    parentKey?: string;
+    /** 子节点的键名，默认为 'children' */
+    childrenKey?: string;
+    /** 格式化每个节点的函数 */
+    formatItem?: (item: T) => T;
+}
+/**
+ * 将扁平数组转换为树形结构
+ * @param list 扁平数组
+ * @param options 转换选项
+ * @returns 树形结构的根节点数组
+ */
+export declare const arrayToTree: <T extends Record<string, any> = any>(list?: T[], options?: ArrayToTreeOptions<T>) => T[];
+/**
+ * 过滤树形数据的选项
+ */
+export interface FilterTreeOptions {
+    /** 子节点的键名，默认为 'children' */
+    childrenKey?: string;
+}
+/**
+ * 过滤树形数据
+ * @param tree 树形数据数组
+ * @param fn 过滤函数，返回 true 保留该节点
+ * @param options 过滤选项
+ * @returns 过滤后的树形数据
+ */
+export declare const filterTree: <T extends Record<string, any> = any>(tree: T[], fn: (item: T, index: number) => boolean, options?: FilterTreeOptions) => T[];
+/**
+ * 映射树形数据的选项
+ */
+export interface MapTreeOptions {
+    /** 子节点的键名，默认为 'children' */
+    childrenKey?: string;
+}
+/**
+ * 映射树形数据（转换每个节点）
+ * @param tree 树形数据数组
+ * @param fn 映射函数，返回转换后的节点
+ * @param options 映射选项
+ * @returns 映射后的树形数据
+ */
+export declare const mapTree: <T extends Record<string, any> = any, R = T>(tree: T[], fn: (item: T, index: number) => R, options?: MapTreeOptions) => R[];

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

@@ -0,0 +1,94 @@
+/**
+ * 各类数据及类型的校验
+ * */
+/**
+ * 校验是否为有效的url
+ * 仅格式校验，不做严各的真实性校验
+ * @param {string} content url内容
+ * @return {boolean}
+ * */
+export declare function isURL(content: string): boolean;
+/**
+ * 是否为数字
+ * 范围：正负数、浮点数
+ * @param value 数值
+ * @param floatLength 小数位数，默认不限
+ * */
+export declare function isNumber(value: any, floatLength?: number): boolean;
+/**
+ * 是否为整数
+ * 范围：正负数
+ * @param {any} value 数值
+ * @return {boolean}
+ */
+export declare function isInteger(value: any): boolean;
+/**
+ * 是否为非0的有效数字
+ * @param value 数值
+ */
+export declare function isNumberNot0(value: number | string): boolean;
+/**
+ * 是否为浮点数字
+ * @description 范围：正整数、浮点正数（无符号）
+ * @param value 必选，被校验的值 (.11 这样的数字在校验时会自动转为0.11)
+ * @param length 可选，浮点位数，默认 2
+ * */
+export declare function isFloat(value: string, length?: number): boolean;
+/**
+ * 是否为正整数
+ * @description 范围：正整数
+ * @param value 必选，被校验的值
+ * */
+export declare function isPositiveFloat(value: string): boolean;
+/**
+ * 是否为空
+ * @param target 目标对象
+ * @return {boolean}
+ */
+export declare function isEmpty(target: any): boolean;
+/**
+ * 是否为Object对象
+ * @param {any} target 需要校验的目标
+ * @param {Boolean} [isEmpty] 是否允许为空对象
+ * @return {boolean}
+ * */
+export declare function isObject(target: any, isEmpty?: boolean): boolean;
+/**
+ * 是否为空Object对象
+ * @param {any} target 需要校验的目标
+ * @return {boolean}
+ * */
+export declare function isEmptyObject(target: any): boolean;
+/**
+ * 判断空值，'undefined'、null、''
+ * @param {any} value 任意形式的值
+ * */
+export declare function isEmptyValue(value: any): boolean;
+export declare function isFunc(func: any): boolean;
+export declare function isUndefined(value: any): value is undefined;
+export declare function isString(value: any): value is string;
+export declare function isMobilePhone(value: any): boolean;
+export declare function isEmail(value: any): boolean;
+export declare function isChinese(string: any): RegExpExecArray | null;
+export declare function isPromise(target: any): boolean;
+export declare function isBlob(value: any): boolean;
+export declare function isColor(value: string): boolean;
+export declare const compareNumberAb: (a?: string, b?: string, label?: string, isAmount?: boolean) => string;
+export declare const replaceSpaceAndChineseComma: (value: string) => string;
+export declare const Regs: {
+    ios: RegExp;
+    android: RegExp;
+    harmony: RegExp;
+    wechat: RegExp;
+    alipay: RegExp;
+    chrome: RegExp;
+    phone: RegExp;
+};
+export declare function getDeviceInfo(): {
+    os: Record<any, any>;
+    browser: Record<any, any>;
+};
+export declare function detect(ua: string): {
+    os: Record<any, any>;
+    browser: Record<any, any>;
+};

package/package.json

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