gxxc-util 1.0.0

package/dist/esm/modules/other.js

@@ -0,0 +1,231 @@
+import printJS from 'print-js';
+import * as detectBrowser from 'detect-browser';
+import dayjs from 'dayjs';
+import quarterOfYear from 'dayjs/plugin/quarterOfYear';
+import 'dayjs/locale/zh-cn';
+
+dayjs.extend(quarterOfYear);
+dayjs.locale("zh-cn");
+/**
+ * 函数"sys_print"接受具有“url”属性的对象，并使用它通过“printJS”函数打印文档。
+ * @param props - `props` 参数是一个具有单个属性 `url` 的对象，该属性是一个字符串。
+ */
+const sys_print = (props) => {
+    printJS(props?.url);
+};
+const BrowserNameVersion = [
+    { name: "chrome", version: 88 },
+    { name: "safari", version: 14 },
+    { name: "firefox", version: 78 },
+    { name: "opera", version: 74 },
+    { name: "edge-chromium", version: 88 },
+];
+/**
+ * 函数"sys_detectBrowser"检查浏览器版本，版本在当前系统兼容之外，将弹出提示
+ */
+const sys_detectBrowser = () => {
+    const browser = detectBrowser.detect();
+    if (browser) {
+        let isShowAlert = false;
+        const currentBrowser = BrowserNameVersion?.filter((item) => item.name === browser.name)?.[0];
+        if (currentBrowser?.version && browser?.version && parseInt(browser?.version) < currentBrowser?.version) {
+            isShowAlert = true;
+        }
+        if (isShowAlert) {
+            alert("您当前的浏览器版本较低，请考虑升级浏览器版本或使用其他浏览器以获取最佳体验。");
+        }
+    }
+};
+/**
+ * 函数“win_dynamic_fontSize”根据当前屏幕宽度计算并设置文档的字体大小。
+ */
+const win_dynamic_fontSize = () => {
+    const screenWidth = window.innerWidth || document.documentElement.clientWidth || document.body.clientWidth;
+    const baseScreenWidth = 1920;
+    const baseFontSize = 16;
+    const fontSize = (screenWidth / baseScreenWidth) * baseFontSize;
+    document.documentElement.style.fontSize = fontSize + "px";
+};
+// 废弃
+const tem_compare_version = (version1, version2) => {
+    const v1Array = version1.split(".").map(Number);
+    const v2Array = version2.split(".").map(Number);
+    for (let i = 0; i < Math.max(v1Array.length, v2Array.length); i++) {
+        const v1Part = v1Array[i] || 0;
+        const v2Part = v2Array[i] || 0;
+        if (v1Part > v2Part) {
+            return true;
+        }
+        else if (v1Part < v2Part) {
+            return false;
+        }
+    }
+    return true;
+};
+/**
+ * 新的表头数据转译
+ * @param {KeyVal} keyVal 接口返回的存在的表头
+ * @param {TableHeaderItem} cache 存储
+ * @param {TableHeaderItem} initial 默认
+ */
+const tem_get_tableHeader = (keyVal, cache, initial) => {
+    const returnList = [];
+    const transformList = [];
+    if (keyVal) {
+        Object.keys(keyVal)?.forEach((key) => {
+            const item = {};
+            item.key = key;
+            item.name = keyVal[key];
+            transformList.push(item);
+        });
+    }
+    transformList.forEach((i) => {
+        initial?.forEach((j) => {
+            if (cache?.length > 0 && initial?.length === cache?.length) {
+                cache?.forEach((k) => {
+                    if (i?.key === j?.key && i?.key === k?.key) {
+                        i = { ...i, ...j, ...k };
+                        i.width = j?.width;
+                        i.sort = k?.sort ? k?.sort : j.sort;
+                        i.selected = k?.selected === undefined ? true : k?.selected;
+                        returnList.push(i);
+                    }
+                });
+            }
+            else {
+                if (i?.key === j?.key) {
+                    i = { ...i, ...j };
+                    i.selected = true;
+                    returnList.push(i);
+                }
+            }
+        });
+    });
+    if (initial[initial.length - 1]?.key === "operate") {
+        returnList.push(initial[initial.length - 1]);
+    }
+    returnList.sort((a, b) => {
+        return (a?.sort ?? 1) - (b?.sort ?? 2);
+    });
+    return returnList;
+};
+/**
+ * 获取枚举配置
+ * @param {*} value 当前value值
+ * @param {*} array  当前枚举配置
+ */
+const getOptionConfig = (value, array) => {
+    if (!!value || value === 0) {
+        const findItem = array?.find((item) => item.value === value);
+        return findItem ? findItem : {};
+    }
+    else {
+        return {};
+    }
+};
+/**
+ * 获取url 文件名 除后缀名以外的地址名  后缀名
+ * @param {*} url 地址
+ */
+const getUrlConfig = (url) => {
+    if (!!url) {
+        const urlObj = new URL(url);
+        const path = urlObj.pathname;
+        const fileName = decodeURIComponent(path.substring(path.lastIndexOf("/") + 1));
+        const suffix = fileName.substring(fileName.lastIndexOf(".") + 1);
+        const prefixPath = url.substring(0, url.lastIndexOf("."));
+        return {
+            fileName: fileName ?? "",
+            prefix: prefixPath ?? "",
+            suffix: suffix ?? "",
+        };
+    }
+    else {
+        return null;
+    }
+};
+/**
+ * timejs 依赖于 dayjs 构建，形成管理时间的工具函数
+ * TypeScript 中的 `timejs` 函数接受一个参数 `props`，并返回使用 `props` 调用 `dayjs` 的结果。
+ * @param {any} props - `timejs` 函数中的 `props` 参数预计为 `any` 类型，这意味着它可以接受任何数据类型作为其值。
+ *
+ * @returns `timejs` 函数正在返回使用 `props` 参数调用 `dayjs` 函数的结果。
+ */
+const timejs = (props, props1, props2) => {
+    return dayjs(props, props1, props2);
+};
+/**
+ * 从视频地址中提取第一帧作为预览图（base64 格式）
+ * @param videoUrl 视频地址（支持跨域或 Blob URL）
+ * @param frameTime 预览帧时间点（number）
+ * @returns 返回一个Promise，成功时返回 base64 图片，失败返回空字符串
+ */
+const video_preview = (videoUrl, frameTime = 0.1) => {
+    return new Promise((resolve) => {
+        // 参数校验：无效地址或非法时间直接返回空
+        if (!videoUrl || typeof videoUrl !== "string" || frameTime < 0) {
+            return resolve("");
+        }
+        // 创建 video 元素用于加载视频
+        const video = document.createElement("video");
+        video.crossOrigin = "anonymous"; // 解决跨域问题
+        video.src = videoUrl; // 设置视频地址
+        video.muted = true; // 静音播放，避免浏览器限制
+        // 超时控制：10 秒内未完成则中断并返回空
+        const timeout = setTimeout(() => {
+            cleanup();
+            resolve("");
+        }, 10000);
+        // 清理函数：释放资源
+        const cleanup = () => {
+            clearTimeout(timeout); // 清除超时定时器
+            video.pause(); // 暂停播放
+            video.removeAttribute("src"); // 清除 src 属性
+            video.load(); // 重新加载资源（释放内存）
+        };
+        // 视频元数据加载完成后触发
+        video.onloadedmetadata = () => {
+            // 如果宽高为 0，说明视频未正确加载
+            if (video.videoWidth === 0 || video.videoHeight === 0) {
+                return resolve("");
+            }
+            // 设置到指定帧位置
+            video.currentTime = frameTime;
+        };
+        // seeked 事件表示视频已经跳转到目标时间点（即已准备好绘制）
+        video.onseeked = () => {
+            try {
+                // 创建 canvas 用于绘制视频帧
+                const canvas = document.createElement("canvas");
+                canvas.width = video.videoWidth;
+                canvas.height = video.videoHeight;
+                // 获取 canvas 的绘图上下文
+                const ctx = canvas.getContext("2d");
+                if (!ctx)
+                    return resolve("");
+                // 将当前帧绘制到 canvas 上
+                ctx.drawImage(video, 0, 0, canvas.width, canvas.height);
+                // 将 canvas 内容转换为 base64 图片
+                const imgUrl = canvas.toDataURL("image/jpeg");
+                // 清理资源并返回结果
+                cleanup();
+                resolve(imgUrl);
+            }
+            catch (error) {
+                console.error("Canvas draw error:", error);
+                // 绘制过程中出错，清理并返回空
+                cleanup();
+                resolve("");
+            }
+        };
+        // 视频加载错误处理
+        video.onerror = () => {
+            cleanup();
+            resolve("");
+        };
+        // 开始加载视频
+        video.load();
+    });
+};
+
+export { getOptionConfig, getUrlConfig, sys_detectBrowser, sys_print, tem_compare_version, tem_get_tableHeader, timejs, video_preview, win_dynamic_fontSize };

package/dist/esm/modules/validation.js

@@ -0,0 +1,178 @@
+// 数字文本
+const val_number = (_, value) => {
+    if (value) {
+        if (/\s/.test(value)) {
+            return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+        }
+        else if (isNaN(Number(value))) {
+            return Promise.reject(new Error("请输入有效的数字文本！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 两位小数点百分比
+const val_two_percent = (_, value) => {
+    if (value) {
+        if (/\s/.test(value)) {
+            return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+        }
+        else if (isNaN(Number(value))) {
+            return Promise.reject(new Error("请输入有效的数字文本！"));
+        }
+        else if (Number(value) <= 0 || Number(value) >= 100) {
+            return Promise.reject(new Error("范围必须在0到100之间！"));
+        }
+        else if (!/^\d+(\.\d{1,2})?$/.test(value)) {
+            return Promise.reject(new Error("最多支持两位小数！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 三位小数点百分比
+const val_three_percent = (_, value) => {
+    if (value) {
+        if (/\s/.test(value)) {
+            return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+        }
+        else if (isNaN(Number(value))) {
+            return Promise.reject(new Error("请输入有效的数字文本！"));
+        }
+        else if (Number(value) <= 0 || Number(value) >= 100) {
+            return Promise.reject(new Error("范围必须在0到100之间！"));
+        }
+        else if (!/^\d+(\.\d{1,3})?$/.test(value)) {
+            return Promise.reject(new Error("最多支持三位小数！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 金额文本 支持到小数点后两位
+const val_amount = (_, value) => {
+    if (value) {
+        if (/\s/.test(value)) {
+            return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+        }
+        else if (isNaN(Number(value))) {
+            return Promise.reject(new Error("请输入有效的数字文本！"));
+        }
+        else if (!/^\d+(\.\d{1,2})?$/.test(value)) {
+            return Promise.reject(new Error("最多支持两位小数！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 身份证
+const val_idcard = (_rule, value) => {
+    if (value) {
+        const idCardRegex = /^[1-9]\d{5}(18|19|20)\d{2}(0[1-9]|10|11|12)(0[1-9]|[1-2]\d|30|31)\d{3}[0-9X]$/;
+        if (/\s/.test(value)) {
+            return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+        }
+        else if (!idCardRegex.test(value)) {
+            return Promise.reject(new Error("身份证号格式不正确！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 手机号
+const val_phone = (_, value) => {
+    if (value) {
+        const phoneRegex = /^1[0-9]{10}$/;
+        if (/\s/.test(value)) {
+            return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+        }
+        else if (!phoneRegex.test(value)) {
+            return Promise.reject(new Error("手机号格式不正确！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 联系电话校验（只校验座机格式   例如 010-12345678    010 12345678  （010）12345678）
+const val_landline = (_, value) => {
+    if (value) {
+        const landlinePhoneRegex = /^[\d\s()-]+$/;
+        if (!landlinePhoneRegex.test(value)) {
+            return Promise.reject(new Error("联系电话格式不正确！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+// 邮箱校验
+const val_email = (_, value) => {
+    if (!value || value === "/") {
+        return Promise.resolve();
+    }
+    if (/\s/.test(value)) {
+        return Promise.reject(new Error("请去除文本前后及内容中的空格！"));
+    }
+    else {
+        const emailRegex = /^[\p{L}\d_\-.]+@[\p{L}\d-]+(\.[\p{L}\d-]+)*\.[\p{L}]{2,}$/u;
+        if (!emailRegex.test(value)) {
+            return Promise.reject(new Error("邮箱格式不正确！"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+};
+//空格校验
+const val_space = (_, value) => {
+    if (!value) {
+        return Promise.resolve();
+    }
+    else if (/\s/.test(value)) {
+        return Promise.reject(new Error("文本内容包含空格！"));
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+//前后空格
+const val_beforeAfter_space = (_, value) => {
+    if (!value) {
+        return Promise.resolve();
+    }
+    else if (/^\s|\s$/g.test(value)) {
+        return Promise.reject(new Error("文本内容前后包含空格！"));
+    }
+    else {
+        return Promise.resolve();
+    }
+};
+
+export { val_amount, val_beforeAfter_space, val_email, val_idcard, val_landline, val_number, val_phone, val_space, val_three_percent, val_two_percent };

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export { author_passwordCheck, author_router_add, author_router_filter, author_rsa, author_strict, author_traceId } from './modules/author.js';
+export { city_code_text, city_options, city_two_code_text } from './modules/cityOptions.js';
+export { get_multiple_color, hex_to_rgb, reduce_opacity, rgb_to_hex, theme_change } from './modules/color.js';
+export { demo } from './modules/demo.js';
+export { file_calculate_md5, file_load, file_open } from './modules/file.js';
+export { num_expand, num_expand_100, num_reduce_100, num_text, num_unit } from './modules/number.js';
+export { getOptionConfig, getUrlConfig, sys_detectBrowser, sys_print, tem_compare_version, tem_get_tableHeader, timejs, video_preview, win_dynamic_fontSize } from './modules/other.js';
+export { val_amount, val_beforeAfter_space, val_email, val_idcard, val_landline, val_number, val_phone, val_space, val_three_percent, val_two_percent } from './modules/validation.js';

package/dist/types/modules/author.d.ts

@@ -0,0 +1,95 @@
+import { ResourceItem } from '../types/index.js';
+
+/**
+ * 生成TraceId
+ * @param {string} origin 请求源（请求发起方）
+ * @param {string} url 请求url
+ * @returns - traceId，例如 "os-os-1d677771-4e85-460d-b669-682077a5067f"
+ */
+declare const author_traceId: (origin: string, url: string) => string;
+/**
+ * 严格匹配当前按钮权限
+ * @param {ResourceItem[]} list 当前的页面权限
+ * @param {number} id 当前的按钮权限
+ * @returns {boolean} 是否存在该权限 true/false
+ */
+declare const author_strict: (list: ResourceItem[], id: number) => boolean;
+/**
+ * 计算密码强度，返回等级
+ * @param {string} str 当前密码
+ * @returns {number} 强度等级
+ */
+declare const author_passwordCheck: (str: string) => number;
+/** 菜单类型 */
+interface MenuInformation {
+    menuid?: number;
+    menuId?: number;
+    parentid?: number;
+    parentId?: number;
+    parentname?: string;
+    parentName?: string;
+    resourcelist?: ResourceList[];
+    resourceList?: ResourceList[];
+    sort?: number;
+    label?: string;
+    key?: string;
+    icon?: any;
+    element?: any;
+    children?: any;
+}
+/** 按钮类型 */
+interface ResourceList {
+    resourceId: number;
+    resourceName?: string;
+    key?: string;
+    element?: any;
+    more?: boolean;
+}
+/**
+ * 处理接口的路由数据，将本地的路由信息补充进去
+ * 数据层面：既处理数据问题，也解决浏览器关于menuId，resourceList等字段驼峰大小写的警告
+ * 业务层面：处理的的数据存储到localstore中，便于系统使用
+ * @param {Array} origin 接口的路由信息
+ * @param {Array} local 本地的路由信息
+ * @returns {Array} 适配到项目的路由树
+ */
+declare const author_router_filter: (origin: MenuInformation[], local: MenuInformation[]) => ({
+    key: string | undefined;
+    menuid: number | undefined;
+    label: string | undefined;
+    resourcelist: ResourceList[] | undefined;
+    children: any;
+} | null)[];
+/**
+ * 处理缓存的路由数据，将本地的路由信息补充进去
+ * 数据层面：既处理数据问题，也将DOM元素打进当前函数
+ * 业务层面：可以在当前函数中使用DOM元素，用于渲染
+ * @param {Array} origin 接口的路由信息
+ * @param {Array} local 本地的路由信息
+ * @returns {Array} 用于渲染的路由树
+ */
+declare const author_router_add: (origin: MenuInformation[], local: MenuInformation[]) => ({
+    resourcelist: ResourceList[] | undefined;
+    menuid?: number;
+    menuId?: number;
+    parentid?: number;
+    parentId?: number;
+    parentname?: string;
+    parentName?: string;
+    resourceList?: ResourceList[];
+    sort?: number;
+    label?: string;
+    key?: string;
+    icon?: any;
+    element?: any;
+    children?: any;
+} | null)[];
+/**
+ * RSA数据加密处理，用于密码加密传输
+ * @param {String} pubKey 公钥
+ * @param {String} password 密码
+ * @returns {String} 加密后的数据，吐出为十六进制
+ */
+declare const author_rsa: (pubKey: string, password: string) => string;
+
+export { author_passwordCheck, author_router_add, author_router_filter, author_rsa, author_strict, author_traceId };

package/dist/types/modules/cityOptions.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 城市选择器
+ * <Cascader/> 组件内使用 options={cityOptions} 引入省市区
+ */
+declare const city_options: (level?: string) => ({
+    label: string;
+    value: string;
+    children?: undefined;
+} | {
+    label: string;
+    value: string;
+    children: {
+        label: string;
+        value: string;
+    }[];
+})[];
+/**
+ * 编码转城市
+ */
+declare const city_two_code_text: (provinceId: string, cityId?: string) => string;
+/**
+ * 编码转城市，默认三级
+ */
+declare const city_code_text: (provinceId: string, cityId?: string, districtId?: string) => string;
+
+export { city_code_text, city_options, city_two_code_text };

package/dist/types/modules/color.d.ts

@@ -0,0 +1,34 @@
+import { RgbColor } from '../types/index.js';
+
+/**
+ * 函数“hex_to_rgb”将十六进制颜色代码转换为 RGB 颜色数组。
+ * @param {string} hex - 十六进制颜色代码，例如“#FFA500”
+ * @returns 包含从输入提供的十六进制颜色代码转换而来的 RGB 值的数组。
+ */
+declare const hex_to_rgb: (hex: string) => RgbColor;
+/**
+ * 函数“reduce_opacity”将十六进制颜色透明度改变，得到同等规则下的颜色。
+ * @param rgb - RGB颜色代码，例如 [ 22, 34, 55 ]
+ * @returns - RGB颜色代码，例如 [ 69, 78, 95 ]
+ */
+declare const reduce_opacity: (rgb: RgbColor, opacity: number) => RgbColor;
+/**
+ * 该函数将 RGB 颜色数组转换为十六进制颜色代码。
+ * @param rgb - 参数 `rgb` 应该是一个数字数组，表示 RGB 颜色模型中颜色的红色、绿色和蓝色值。
+ * @returns 十六进制颜色代码。
+ */
+declare const rgb_to_hex: (rgb: RgbColor) => string;
+/**
+ * 该函数将颜色转成一种颜色的多种透明度的
+ * @param value rgb或者十六进制
+ * @param  {number} opacity 透明度
+ * @returns 十六进制颜色代码
+ */
+declare const get_multiple_color: (value: string | null, opacity: number) => string;
+/**
+ * 该函数用于生成主题颜色。
+ * @param value - 主题颜色值
+ */
+declare const theme_change: (value: string) => void;
+
+export { get_multiple_color, hex_to_rgb, reduce_opacity, rgb_to_hex, theme_change };

package/dist/types/modules/demo.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 函数“demo”将字符串“123”记录到控制台。
+ */
+declare const demo: () => boolean;
+
+export { demo };

package/dist/types/modules/file.d.ts

@@ -0,0 +1,25 @@
+interface IProps {
+    url: string;
+    name?: string;
+}
+/**
+ * 函数“file_calculate_md5”读取一个文件，计算其 MD5 哈希值，并将哈希值作为 Promise 返回。
+ * @param {any} file - `file_calculate_md5` 函数将文件作为输入，并使用 CryptoJS 库计算文件内容的 MD5 哈希值。`file` 参数表示要计算 MD5
+ * 哈希值的文件。
+ * @returns 一旦文件被读取并处理完毕，`file_calculate_md5` 函数就会返回一个 Promise，该 Promise 会使用文件内容的 MD5 哈希值进行解析。
+ */
+declare const file_calculate_md5: (file: any) => Promise<unknown>;
+/**
+ * 函数 "file_open" 打开一个文件，如果该文件再浏览器无法预览，会实现下载功能
+ * @param {string} url 必填参数，传入的文件的url
+ * @param {string=} name 可选参数，传入的文件的文件名。如果不提供，默认使用URL中的文件名
+ */
+declare const file_open: (props: IProps) => void;
+/**
+ * 函数 "file_load" 下载一个文件
+ * @param {string} url 必填参数，传入的文件的url
+ * @param {string=} name 可选参数，传入的文件的文件名。如果不提供，默认使用URL中的文件名
+ */
+declare const file_load: (props: IProps) => Promise<void> | undefined;
+
+export { file_calculate_md5, file_load, file_open };

package/dist/types/modules/number.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 单位扩大固定倍数
+ * @param {*} amount 当前金额
+ * @param {*} unit 转换单位，默认100
+ * @param {*} accuracy 保留几位小数，默认2位
+ */
+declare const num_expand: (amount: any, unit?: number, accuracy?: number) => any;
+/**
+ * 单位扩大两位，一般用于（分->元）（百分数->数）
+ * @param {*} amount 当前金额
+ * @param {*} accuracy 保留几位小数，默认2位
+ */
+declare const num_expand_100: (amount: any, accuracy?: number) => any;
+declare const num_unit: (amount: any) => any;
+/**
+ * 单位缩小两位，一般用于（元->分）（数->百分数）
+ * @param {*} amount 当前金额
+ */
+declare const num_reduce_100: (amount: any) => any;
+/**
+ * @description 数字转中文数码
+ *
+ * @param {Number|String}   num     数字[正整数]
+ * @param {String}          type    文本类型，lower|upper，默认upper
+ *
+ * @example number2text(100000000) => "壹亿元整"
+ */
+declare const num_text: (number: any, type?: string) => string | false;
+
+export { num_expand, num_expand_100, num_reduce_100, num_text, num_unit };