vap1 0.4.7 → 0.5.0

package/utils/Renders/_define.js

@@ -1,17 +1,82 @@
 "use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getList = exports.convertValue = exports.getValue = void 0;
+exports.getList = exports.convertValue = exports.getValue = exports.getStyles = void 0;
 var react_1 = __importDefault(require("react"));
 var lodash_1 = __importDefault(require("lodash"));
 var Const_1 = require("../Const");
-var getValue = function (txt, options) {
+var getStyles = function (value, options) {
+    if (options == null || options.onlyText)
+        return [undefined, undefined];
+    var clazz = [];
+    if (options.className) {
+        if (lodash_1.default.isString(options.className)) {
+            clazz.push(options.className);
+        }
+        else if (lodash_1.default.isFunction(options.className)) {
+            clazz.push(options.className(value));
+        }
+    }
+    if (options.bold) {
+        if (lodash_1.default.isBoolean(options.bold)) {
+            clazz.push('font-bold');
+        }
+        else if (lodash_1.default.isFunction(options.bold) && options.bold(value)) {
+            clazz.push('font-bold');
+        }
+    }
+    ;
+    if (options.italic) {
+        if (lodash_1.default.isBoolean(options.italic)) {
+            clazz.push('font-italic');
+        }
+        else if (lodash_1.default.isFunction(options.italic) && options.italic(value)) {
+            clazz.push('font-italic');
+        }
+    }
+    if (options.underline) {
+        if (lodash_1.default.isBoolean(options.underline)) {
+            clazz.push('font-underline');
+        }
+        else if (lodash_1.default.isFunction(options.underline) && options.underline(value)) {
+            clazz.push('font-underline');
+        }
+    }
+    var style = undefined;
+    if (options.color) {
+        if (lodash_1.default.isString(options.color)) {
+            style = { color: options.color };
+        }
+        else if (lodash_1.default.isFunction(options.color)) {
+            style = { color: options.color(value) };
+        }
+    }
+    return [clazz.length ? clazz.join(' ') : undefined, style];
+};
+exports.getStyles = getStyles;
+var getValue = function (label, value, options) {
     if (options == null)
-        return txt || Const_1.NONE;
+        return label || Const_1.NONE;
     var str;
-    if (txt == null) {
+    if (label == null) {
         if (options.default)
             return options.default;
         if (options.format) {
@@ -19,24 +84,18 @@ var getValue = function (txt, options) {
         }
     }
     else {
-        str = txt;
+        str = label;
     }
     if (options.len && str.length > options.len) {
         str = str.substring(0, options.len) + '...';
     }
-    var clazz = [];
-    if (options.className)
-        clazz.push(options.className);
-    if (options.bold)
-        clazz.push('font-bold');
-    if (options.italic)
-        clazz.push('font-italic');
-    if (options.underline)
-        clazz.push('font-underline');
-    var style = options.color ? { color: options.color } : undefined;
-    if (options.onlyText || (clazz.length == 0 && style == undefined))
+    if (options.onlyText)
         return str;
-    return react_1.default.createElement("span", { className: clazz.join(' '), style: style, title: txt }, str);
+    var _a = __read((0, exports.getStyles)(value, options), 2), clazz = _a[0], style = _a[1];
+    if (clazz || style) {
+        return react_1.default.createElement("span", { className: clazz, style: style, title: label }, str);
+    }
+    return str;
 };
 exports.getValue = getValue;
 var convertValue = function (value, config) {

package/utils/StringUtil.d.ts

@@ -1,132 +1,362 @@
 import { spellMatch } from './py';
 import type { MatchPatterns } from './py';
+/**
+ * 邮箱地址正则表达式
+ */
 export declare const REG_EMAIL: RegExp;
+/**
+ * 手机号码正则表达式
+ */
 export declare const REG_PHONE: RegExp;
+/**
+ * 固定电话正则表达式
+ */
 export declare const REG_TELEPHONE: RegExp;
+/**
+ * 英文字母集合
+ */
 export declare const LETTERS: Set<string>;
+/**
+ * IPv4地址正则表达式
+ */
 export declare const REG_IPV4: RegExp;
+/**
+ * IPv6地址正则表达式
+ */
 export declare const REG_IPV6: RegExp;
+/**
+ * URL地址正则表达式
+ */
 export declare const REG_URL: RegExp;
+/**
+ * 端口号正则表达式
+ */
 export declare const REG_PORT: RegExp;
 /**
- * 是否为一个手机号码
-*/
+ * 判断是否为手机号码
+ * @param txt - 待验证的字符串
+ * @returns 是否为有效的手机号码
+ *
+ * @example
+ * isMobilePhone('13812345678') // => true
+ * isMobilePhone('1381234567') // => false
+ */
 export declare const isMobilePhone: (txt: string) => boolean;
 /**
- * 是否为一个固话号码
-*/
+ * 判断是否为固定电话号码
+ * @param txt - 待验证的字符串
+ * @returns 是否为有效的固定电话号码
+ *
+ * @example
+ * isTelePhone('010-12345678') // => true
+ * isTelePhone('010123456789') // => false
+ */
 export declare const isTelePhone: (txt: string) => boolean;
 /**
- * 是否为一个Email地址
-*/
+ * 判断是否为Email地址
+ * @param txt - 待验证的字符串
+ * @returns 是否为有效的Email地址
+ *
+ * @example
+ * isEmail('user@example.com') // => true
+ * isEmail('invalid.email') // => false
+ */
 export declare const isEmail: (txt: string) => boolean;
 /**
- * 是否为一个URL地址
-*/
+ * 判断是否为URL地址
+ * @param txt - 待验证的字符串
+ * @returns 是否为有效的URL地址
+ *
+ * @example
+ * isURL('https://www.example.com') // => true
+ * isURL('invalid-url') // => false
+ */
 export declare const isURL: (txt: string) => boolean;
 /**
- * 是否为一个Mac地址
-*/
+ * 判断是否为MAC地址
+ * @param txt - 待验证的字符串
+ * @returns 是否为有效的MAC地址
+ *
+ * @example
+ * isMAC('00:11:22:33:44:55') // => true
+ * isMAC('00-11-22-33-44-55') // => true
+ * isMAC('001122334455') // => true
+ * isMAC('invalid-mac') // => false
+ */
 export declare const isMAC: (txt: string) => boolean;
 /**
- * 是否为一个电话号码，支持固定电话和手机
-*/
+ * 判断是否为电话号码(支持固定电话和手机)
+ * @param txt - 待验证的字符串
+ * @returns 是否为有效的电话号码
+ *
+ * @example
+ * isPhone('13812345678') // => true
+ * isPhone('010-12345678') // => true
+ * isPhone('invalid-phone') // => false
+ */
 export declare const isPhone: (txt: string) => boolean;
 type IP_VERSION = '' | '4' | '6';
+/**
+ * 判断是否为IPv4地址
+ * @param str - 待验证的字符串
+ * @returns 是否为有效的IPv4地址
+ *
+ * @example
+ * isIP4('192.168.1.1') // => true
+ * isIP4('256.1.2.3') // => false
+ */
 export declare const isIP4: (str: string) => boolean;
+/**
+ * 判断是否为IPv6地址
+ * @param str - 待验证的字符串
+ * @returns 是否为有效的IPv6地址
+ *
+ * @example
+ * isIP6('2001:0db8:85a3:0000:0000:8a2e:0370:7334') // => true
+ * isIP6('invalid-ipv6') // => false
+ */
 export declare const isIP6: (str: string) => boolean;
 /**
- * 判断是否是一个 IP 地址，默认
- * @param str : 要判断的字符串
- * @param version : IP版本，默认为 IP4, 如果要同时 4，6， 传 空字串 ：''
-*/
+ * 判断是否为IP地址
+ * @param str - 待验证的字符串
+ * @param version - IP版本('4'|'6'|'')，默认为'4'。空字符串表示同时支持IPv4和IPv6
+ * @returns 是否为有效的IP地址
+ *
+ * @example
+ * isIP('192.168.1.1', '4') // => true
+ * isIP('2001:0db8:85a3:0000:0000:8a2e:0370:7334', '6') // => true
+ * isIP('192.168.1.1', '') // => true
+ */
 export declare const isIP: (str: string, version?: IP_VERSION) => boolean;
 export declare const REG_ID_18: RegExp;
 export declare const REG_ID_15: RegExp;
 /**
- * 判断是否是一个18位身份证号
- * @param txt : 要判断的字符串
- * @param strict : 是否开启严格校验，默认开启
-*/
+ * 判断是否为18位身份证号
+ * @param txt - 待验证的字符串
+ * @param strict - 是否开启严格校验，默认为true
+ * @returns 是否为有效的18位身份证号
+ *
+ * @example
+ * isId18('110101199001011234') // => true
+ * isId18('11010119900101123X') // => true
+ * isId18('invalid-id', false) // => false
+ */
 export declare const isId18: (txt: string, strict?: boolean) => boolean;
 /**
- * 判断是否是一个15位身份证号
- * @param txt : 要判断的字符串
- * @param strict : 是否开启严格校验，默认开启，
- *  15位身份证号，只会判定省份与年份，不检验哈希，性别
+ * 判断是否为15位身份证号
+ * @param txt - 待验证的字符串
+ * @param strict - 是否开启严格校验，默认为true
+ * @returns 是否为有效的15位身份证号
  *
-*/
+ * @example
+ * isId15('110101900101123') // => true
+ * isId15('invalid-id', false) // => false
+ */
 export declare const isId15: (txt: string, strict?: boolean) => boolean;
 /**
- * 判断是否是一个身份证号，支持18位和15位
- * @param txt : 要判断的字符串
- * @param strict : 是否开启严格校验，默认开启
-*/
+ * 判断是否为身份证号(支持15位和18位)
+ * @param txt - 待验证的字符串
+ * @param strict - 是否开启严格校验，默认为true
+ * @returns 是否为有效的身份证号
+ *
+ * @example
+ * isId('110101199001011234') // => true
+ * isId('110101900101123') // => true
+ * isId('invalid-id', false) // => false
+ */
 export declare const isId: (txt: string, strict?: boolean) => boolean;
 /**
- * 生成一个唯一 ID 标识
-*/
+ * 生成唯一ID标识
+ * @returns 生成的唯一ID字符串
+ *
+ * @example
+ * genKey() // => "1a2b3c"
+ */
 export declare const genKey: () => string;
 /**
- * 生成uuid
-*/
+ * 生成UUID
+ * @returns 生成的UUID字符串
+ *
+ * @example
+ * uuid() // => "550e8400-e29b-41d4-a716-446655440000"
+ */
 export declare const uuid: () => string;
 /**
- * 是否是一个 BTC 地址
-*/
+ * 判断是否为BTC地址
+ * @param str - 待验证的字符串
+ * @returns 是否为有效的BTC地址
+ *
+ * @example
+ * isBTCAddress('1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2') // => true
+ * isBTCAddress('invalid-address') // => false
+ */
 export declare const isBTCAddress: (str: string) => boolean;
 /**
- * 说明：不能判断 变量类型，为 vap 内置识别方法
- * 可为 Boolean 的有字符串有 0 / 1 / true / false / yes / no
- * 通过 getBoolean 可获取到对应的 bool 值
-*/
+ * 判断字符串是否可以转换为布尔值
+ * @param str - 待验证的字符串
+ * @returns 是否可以转换为布尔值
+ *
+ * @example
+ * isBoolean('true') // => true
+ * isBoolean('yes') // => true
+ * isBoolean('0') // => true
+ * isBoolean('invalid') // => false
+ */
 export declare const isBoolean: (str: string) => boolean;
 /**
- * 清空首尾空格，并小写
-*/
+ * 清空字符串首尾空格并转换为小写
+ * @param str - 输入字符串
+ * @returns 处理后的字符串
+ *
+ * @example
+ * trimLower('  Hello World  ') // => "hello world"
+ */
 export declare const trimLower: (str: string) => string;
 export { spellMatch };
 /**
- * 搜索，用于高亮，通常与 HighLight 结合使用，或只使用 HighLight 组件
-*/
+ * 搜索文本并返回匹配结果，用于高亮显示
+ * @param sentence - 待搜索的文本
+ * @param keyword - 搜索关键词
+ * @returns 匹配结果数组
+ *
+ * @example
+ * searchText('Hello World', 'world') // => [{hit: false, text: 'Hello '}, {hit: true, text: 'World'}]
+ */
 export declare const searchText: (sentence: string, keyword: string) => MatchPatterns[];
 /**
- * 拼 className
-*/
+ * 合并CSS类名
+ * @param base - 基础类名数组
+ * @param classNameProps - 额外的类名
+ * @returns 合并后的类名字符串
+ *
+ * @example
+ * className(['btn', 'primary'], 'large') // => "btn primary large"
+ */
 export declare const className: (base: string[], classNameProps?: string) => string;
+/**
+ * 替换字符串中所有匹配的内容
+ * @param text - 原始字符串
+ * @param keyword - 要替换的关键词或正则表达式
+ * @param replaceText - 替换后的文本
+ * @returns 替换后的字符串
+ *
+ * @example
+ * replaceAll('hello world', 'o', '0') // => "hell0 w0rld"
+ */
 export declare const replaceAll: (text: string, keyword: string | RegExp, replaceText: string) => string;
 /**
- * 试图转px的值
- * 300px -> 300
-*/
+ * 将字符串转换为像素值
+ * @param str - 输入的数字或字符串
+ * @returns 转换后的像素值数字
+ *
+ * @example
+ * px('300px') // => 300
+ * px(300) // => 300
+ * px('invalid') // => 0
+ */
 export declare const px: (str: number | string) => number;
 /**
- * 复制字符串
-*/
+ * 复制文本到剪贴板
+ * @param text - 要复制的文本
+ * @param onCopied - 复制成功后的回调函数
+ *
+ * @example
+ * copy('Hello World', (text) => console.log(`Copied: ${text}`))
+ */
 export declare const copy: (text: string, onCopied?: (txt: any) => void) => void;
 /**
- * 获取字符串
-*/
+ * 获取字符串值，空字符串返回默认值
+ * @param txt - 输入字符串
+ * @param defaultValue - 默认值
+ * @returns 处理后的字符串
+ *
+ * @example
+ * getString('  hello  ') // => "hello"
+ * getString('', 'default') // => "default"
+ */
 export declare const getString: (txt: string, defaultValue?: string) => string;
 /**
  * 获取布尔值
-*/
+ * @param key - 输入字符串
+ * @param defaultValue - 默认值
+ * @returns 转换后的布尔值
+ *
+ * @example
+ * getBoolean('true') // => true
+ * getBoolean('yes') // => true
+ * getBoolean('invalid', true) // => true
+ */
 export declare const getBoolean: (key: string, defaultValue?: boolean) => boolean;
 /**
- * 获取数字
-*/
+ * 获取整数值
+ * @param txt - 输入字符串
+ * @param defaultValue - 默认值
+ * @returns 转换后的整数
+ *
+ * @example
+ * getInteger('123') // => 123
+ * getInteger('invalid', 0) // => 0
+ */
 export declare const getInteger: (txt: string, defaultValue?: number) => number;
 /**
- * 获取浮点数
-*/
+ * 获取浮点数值
+ * @param txt - 输入字符串
+ * @param defaultValue - 默认值
+ * @returns 转换后的浮点数
+ *
+ * @example
+ * getFloat('123.45') // => 123.45
+ * getFloat('invalid', 0) // => 0
+ */
 export declare const getFloat: (txt: string, defaultValue?: number) => number;
+/**
+ * 获取文件名
+ * @param uri - 文件路径
+ * @returns 文件名
+ *
+ * @example
+ * getFileName('/path/to/file.txt') // => "file.txt"
+ */
 export declare const getFileName: (uri: string) => string;
 /**
- * 获取文件后缀名，并以小写的形式返回
-*/
+ * 获取文件后缀名
+ * @param fileName - 文件名
+ * @returns 小写的文件后缀名
+ *
+ * @example
+ * getSuffix('image.JPG') // => "jpg"
+ */
 export declare const getSuffix: (fileName: string) => string;
-type FileType = 'image' | 'pdf' | 'doc' | 'excel' | 'ppt' | 'zip' | 'video' | 'audio' | 'unknown';
+type FileType = 'image' | 'pdf' | 'doc' | 'excel' | 'ppt' | 'zip' | 'video' | 'xml' | 'audio' | 'unknown';
 /**
- * 获取文件类及 icon
-*/
+ * 获取文件类型和对应的图标
+ * @param fileName - 文件名
+ * @returns [文件类型, 图标名称]
+ *
+ * @example
+ * getFileType('document.pdf') // => ['pdf', 'file-pdf']
+ * getFileType('image.jpg') // => ['image', 'file-image']
+ */
 export declare const getFileType: (fileName: string) => [FileType, string];
+/**
+ * 计算占比
+ * @param count - 分子
+ * @param total - 分母
+ * @returns 比率(0-1之间的小数)
+ *
+ * @example
+ * ratio(4, 10) // => 0.4
+ * ratio(0, 10) // => 0
+ */
+export declare const ratio: (count: number, total: number) => number;
+/**
+ * 计算增长率
+ * @param current - 当前值
+ * @param prev - 上一个值
+ * @returns 增长率(-1到1之间的小数)
+ *
+ * @example
+ * rise(120, 100) // => 0.2
+ * rise(80, 100) // => -0.2
+ */
+export declare const rise: (current: number, prev: number) => number;