ph-utils 0.10.2 → 0.11.1

package/README.md

@@ -1,7 +1,7 @@
-## ph-utils
-
-整理了 js 前后端开发(web + nodejs)时常用的一些工具；[详细文档](https://gitee.com/towardly/ph/wikis/Home?sort_id=4035190)
-
-### 包含如下工具文件
-
-`index` 基础工具类、`date` 跟日期相关的工具类、`file` 文件操作相关工具类[**服务端**]、`server` 服务端工具类、`validator` 数据验证、`dom` 浏览器节点操作相关[**前端**]、`web` 一些只适用于前端相关的工具、`color` 颜色相关工具
+## ph-utils
+
+整理了 js 前后端开发(web + nodejs)时常用的一些工具；[详细文档](https://gitee.com/towardly/ph/wikis/Home?sort_id=4035190)
+
+### 包含如下工具文件
+
+`index` 基础工具类、`date` 跟日期相关的工具类、`file` 文件操作相关工具类[**服务端**]、`server` 服务端工具类、`validator` 数据验证、`dom` 浏览器节点操作相关[**前端**]、`web` 一些只适用于前端相关的工具、`color` 颜色相关工具

package/lib/array.d.ts

@@ -59,14 +59,14 @@ export declare function symmetricDifference<T>(...arrs: T[][]): T[];
  * @param a2
  * @returns
  */
-export declare function isSubsetOf<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): boolean;
+export declare function isSubsetOf<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): any;
 /**
  * 返回一个布尔值，指示给定集合中的所有元素是否都在此集合中。
  * @param arr1
  * @param arr2
  * @returns
  */
-export declare function isSupersetOf<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): boolean;
+export declare function isSupersetOf<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): any;
 /**
  * 返回一个布尔值，指示此集合是否与给定集合没有公共元素。
  *
@@ -76,4 +76,4 @@ export declare function isSupersetOf<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>):
  * @param arr2
  * @returns
  */
-export declare function isDisjointFrom<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): boolean;
+export declare function isDisjointFrom<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): any;

package/lib/dom.d.ts

@@ -156,7 +156,7 @@ export declare function formatClass(classObj: (boolean | string | undefined | nu
  * @param styleObj - 样式对象，可以是字符串数组或键值对对象。
  * @returns 格式化后的 CSS 样式字符串。
  */
-export declare function formatStyle(styleObj: (string | undefined | null | "")[] | Record<string, string>): string;
+export declare function formatStyle(styleObj: (string | undefined | null | "")[] | Record<string, string | undefined | null>): string;
 /**
  * 对指定的 HTML 元素应用显示过渡效果。
  * @param target - 要应用过渡效果的 HTML 元素。

package/lib/dom.js

@@ -333,8 +333,9 @@ export function formatStyle(styleObj) {
     }
     else {
         for (const key in styleObj) {
-            if (styleObj[key]) {
-                styleStr += `${key}:${styleObj[key]};`;
+            const value = styleObj[key];
+            if (value) {
+                styleStr += `${key}:${value};`;
             }
         }
     }

package/lib/server.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import type { SpawnOptions } from "node:child_process";
 /**
  * 执行命令

package/lib/theme.js

@@ -19,10 +19,10 @@ export async function initTheme() {
     if ($themeStyle == null) {
         $themeStyle = document.createElement("style");
         $themeStyle.id = "theme-style";
-        $themeStyle.innerHTML = `
-      :root{color-scheme:light dark;}
-      html.light{color-scheme: light;}
-      html.dark {color-scheme: dark;}
+        $themeStyle.innerHTML = `
+      :root{color-scheme:light dark;}
+      html.light{color-scheme: light;}
+      html.dark {color-scheme: dark;}
     `;
         document.head.appendChild($themeStyle);
     }

package/lib/validator.d.ts

@@ -11,10 +11,13 @@ export type RuleType = string | RegExp | ((v: any) => boolean) | (RegExp | strin
     message?: string;
 });
 export interface SchemaType {
+    /** 数据字段 */
     key: string;
+    /** 是否必须 */
     required?: boolean;
-    type?: string | ((v: any) => void);
+    /** 验证规则列表 */
     rules?: RuleType[];
+    /** 错误信息 */
     message?: string;
 }
 /**
@@ -42,6 +45,8 @@ declare class Validator {
      * validator.validateKey().then(res => {})
      */
     constructor(schemas: SchemaType[]);
+    addSchemas(schemas: SchemaType[]): void;
+    addSchema(schema: SchemaType): void;
     /**
      * 进行数据验证
      * @param data 待验证的数据
@@ -57,6 +62,7 @@ declare class Validator {
      */
     validateKey(key: string, value: any, data?: any): Promise<boolean>;
     private _validateRule;
+    private _parseSchemaRules;
     private _parseStringRule;
 }
 export default Validator;

package/lib/validator.js

@@ -61,51 +61,16 @@ class Validator {
      * validator.validateKey().then(res => {})
      */
     constructor(schemas) {
-        let parsedRules = {};
+        this.rules = {};
+        this.addSchemas(schemas);
+    }
+    addSchemas(schemas) {
         for (let schema of schemas) {
-            // 解析规则
-            let rules = [];
-            let rule = schema.rules;
-            if (rule != null) {
-                if (typeof rule === "string") {
-                    rules = rules.concat(this._parseStringRule(rule, schema.message));
-                }
-                else if (rule instanceof Array) {
-                    for (let ruleItem of rule) {
-                        if (typeof ruleItem === "string") {
-                            rules.push(...this._parseStringRule(ruleItem, schema.message));
-                        }
-                        else if (ruleItem instanceof RegExp ||
-                            typeof ruleItem === "function") {
-                            rules.push({
-                                rule: ruleItem,
-                                message: schema.message || defaultMsg,
-                            });
-                        }
-                        else {
-                            if (typeof ruleItem.rule === "string") {
-                                rules.push(...this._parseStringRule(ruleItem.rule, ruleItem.message));
-                            }
-                            else {
-                                rules.push({
-                                    rule: ruleItem.rule,
-                                    message: ruleItem.message || defaultMsg,
-                                });
-                            }
-                        }
-                    }
-                }
-                else {
-                    rules.push({ rule, message: defaultMsg });
-                }
-            }
-            if (schema.required === true &&
-                (rules == null || rules.findIndex((r) => r.rule === "required") === -1)) {
-                rules.push(...this._parseStringRule("required", schema.message));
-            }
-            parsedRules[schema.key] = rules;
+            this.rules[schema.key] = this._parseSchemaRules(schema);
         }
-        this.rules = parsedRules;
+    }
+    addSchema(schema) {
+        this.rules[schema.key] = this._parseSchemaRules(schema);
     }
     /**
      * 进行数据验证
@@ -117,15 +82,12 @@ class Validator {
         return new Promise((resolve, reject) => {
             const errors = [];
             for (let key in this.rules) {
-                // eslint-disable-next-line no-prototype-builtins
-                if (this.rules.hasOwnProperty(key)) {
-                    let errMsg = this._validateRule(this.rules[key], data[key], data);
-                    if (errMsg !== "") {
-                        errMsg = errMsg.replace("%s", key);
-                        errors.push({ message: errMsg, key });
-                        if (all)
-                            break;
-                    }
+                let errMsg = this._validateRule(this.rules[key], data[key], data);
+                if (errMsg !== "") {
+                    errMsg = errMsg.replace("%s", key);
+                    errors.push({ message: errMsg, key });
+                    if (all)
+                        break;
                 }
             }
             if (errors.length === 0) {
@@ -145,6 +107,10 @@ class Validator {
     async validateKey(key, value, data) {
         return new Promise((resolve, reject) => {
             let keyRules = this.rules[key];
+            if (keyRules == null) {
+                resolve(true);
+                return;
+            }
             let errMsg = this._validateRule(keyRules, value, data);
             if (errMsg !== "") {
                 errMsg = errMsg.replace("%s", key);
@@ -164,7 +130,7 @@ class Validator {
                     errMsg = rule.message;
                 }
             }
-            if (typeof rule.rule === "function") {
+            else if (typeof rule.rule === "function") {
                 if (!rule.rule(value)) {
                     errMsg = rule.message;
                 }
@@ -176,13 +142,8 @@ class Validator {
                     }
                 }
             }
-            else if (rule.rule === "required") {
-                if (!ruleFns.pattern(ruleRegexs.required, String(value))) {
-                    errMsg = rule.message;
-                }
-            }
             else {
-                if (!ruleFns.pattern(rule.rule, String(value))) {
+                if (!ruleFns.pattern(rule.rule, value)) {
                     errMsg = rule.message;
                 }
             }
@@ -192,6 +153,48 @@ class Validator {
         }
         return errMsg;
     }
+    _parseSchemaRules(schema) {
+        // 解析规则
+        let rules = [];
+        let rule = schema.rules;
+        if (schema.required === true) {
+            rules.push(...this._parseStringRule("required", schema.message));
+        }
+        if (rule != null) {
+            if (typeof rule === "string") {
+                rules = rules.concat(this._parseStringRule(rule, schema.message));
+            }
+            else if (rule instanceof Array) {
+                for (let ruleItem of rule) {
+                    if (typeof ruleItem === "string") {
+                        rules.push(...this._parseStringRule(ruleItem, schema.message));
+                    }
+                    else if (ruleItem instanceof RegExp ||
+                        typeof ruleItem === "function") {
+                        rules.push({
+                            rule: ruleItem,
+                            message: schema.message || defaultMsg,
+                        });
+                    }
+                    else {
+                        if (typeof ruleItem.rule === "string") {
+                            rules.push(...this._parseStringRule(ruleItem.rule, ruleItem.message));
+                        }
+                        else {
+                            rules.push({
+                                rule: ruleItem.rule,
+                                message: ruleItem.message || defaultMsg,
+                            });
+                        }
+                    }
+                }
+            }
+            else {
+                rules.push({ rule, message: defaultMsg });
+            }
+        }
+        return rules;
+    }
     _parseStringRule(rule, ruleErrMsg) {
         let rules = [];
         let trule = rule.split("|");
@@ -199,7 +202,11 @@ class Validator {
             let message = ruleErrMsg;
             let rrule = null;
             let sameKey;
-            if (ruleRegexs.same.test(r)) {
+            if (rule === "required") {
+                rrule = "required";
+                message = message || ruleErrMsg || defaultMsgs.required;
+            }
+            else if (ruleRegexs.same.test(r)) {
                 let m = r.match(ruleRegexs.same);
                 if (m != null) {
                     rrule = ruleRegexs.same;
@@ -210,12 +217,7 @@ class Validator {
                     message = message || defaultMsgs["same"];
                 }
             }
-            else if (rule === "required") {
-                rrule = "required";
-                message = message || ruleErrMsg || defaultMsgs.required;
-                // eslint-disable-next-line no-prototype-builtins
-            }
-            else if (ruleRegexs.hasOwnProperty(r)) {
+            else if (Object.hasOwn(ruleRegexs, r)) {
                 rrule = ruleRegexs[r];
                 message = message || defaultMsgs[r];
             }

package/package.json

@@ -68,7 +68,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.10.2",
+  "version": "0.11.1",
   "type": "module",
   "repository": {
     "type": "git",

package/lib/clipboard.d.ts

@@ -1,11 +0,0 @@
-/**
- * 复制数据, 可以从多种类型的数据
- *    1. 直接复制文本: await copy("待复制的文本")
- *    2. 复制节点上的 data-copy-text:
- *      <button data-copy-text="这是待复制的文本">复制</button>
- *      await copy(e.target) // or await copy("#a") or await copy(document.querySelector('#a'))
- *    3. 直接复制节点本身数据: await copy('#a')
- * @param {string | HTMLElement} source 复制源, 从中解析待复制的数据
- * @returns {Promise<boolean>} 是否复制成功
- */
-export declare function copy(source: string | HTMLElement): Promise<boolean>;

package/lib/clipboard.js

@@ -1,101 +0,0 @@
-/**
- * 创建一个临时节点缓存待复制数据
- * @param {String} value - 待复制文本
- * @return {HTMLElement}
- */
-function createFakeElement(value) {
-    const fakeElement = document.createElement("textarea");
-    fakeElement.style.border = "0";
-    fakeElement.style.padding = "0";
-    fakeElement.style.margin = "0";
-    fakeElement.style.position = "absolute";
-    fakeElement.style.left = "-9999px";
-    fakeElement.style.top = "-9999";
-    fakeElement.setAttribute("readonly", "");
-    fakeElement.value = value;
-    return fakeElement;
-}
-/** 通过执行 execCommand 来执行复制 */
-function copyFromCommand(text) {
-    // 添加节点
-    const fakeEl = createFakeElement(text);
-    document.body.append(fakeEl);
-    fakeEl.focus();
-    fakeEl.select();
-    // 执行复制
-    const res = document.execCommand("copy");
-    fakeEl.remove(); // 删除节点
-    return Promise.resolve(res);
-}
-/** 使用 navigator.clipboard 复制 */
-function copyFromClipboard(text) {
-    const theClipboard = navigator.clipboard;
-    if (theClipboard != null) {
-        return theClipboard
-            .writeText(text)
-            .then(() => {
-            Promise.resolve(true);
-        })
-            .catch(() => Promise.resolve(false));
-    }
-    return Promise.resolve(false);
-}
-/** 解析待复制的文本 */
-function parseCopyText(source) {
-    let copyText = null; // 待复制文本
-    let sourceEl = null;
-    // 获取待复制数据
-    if (typeof source === "string") {
-        // 从节点拿数据
-        if (source.startsWith("#") || source.startsWith(".")) {
-            sourceEl = document.querySelector(source);
-            if (sourceEl == null) {
-                copyText = source;
-            }
-        }
-        else {
-            copyText = source;
-        }
-    }
-    if (source instanceof HTMLElement) {
-        sourceEl = source;
-    }
-    // 从节点获取待复制数据
-    if (sourceEl != null) {
-        if (sourceEl.hasAttribute("data-copy-text")) {
-            copyText = sourceEl.getAttribute("data-copy-text");
-        }
-        else {
-            const tagName = sourceEl.tagName;
-            if (tagName === "INPUT" || tagName === "TEXTAREA") {
-                copyText = sourceEl.value;
-            }
-            else {
-                copyText = sourceEl.textContent;
-            }
-        }
-    }
-    return copyText;
-}
-/**
- * 复制数据, 可以从多种类型的数据
- *    1. 直接复制文本: await copy("待复制的文本")
- *    2. 复制节点上的 data-copy-text:
- *      <button data-copy-text="这是待复制的文本">复制</button>
- *      await copy(e.target) // or await copy("#a") or await copy(document.querySelector('#a'))
- *    3. 直接复制节点本身数据: await copy('#a')
- * @param {string | HTMLElement} source 复制源, 从中解析待复制的数据
- * @returns {Promise<boolean>} 是否复制成功
- */
-export async function copy(source) {
-    // 待复制文本
-    const copyText = parseCopyText(source);
-    if (copyText == null) {
-        return Promise.resolve(false);
-    }
-    const v = await copyFromClipboard(copyText);
-    if (v === false) {
-        return copyFromCommand(copyText);
-    }
-    return Promise.resolve(true);
-}