ph-utils 0.4.6 → 0.4.8

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/index.d.ts

@@ -50,6 +50,13 @@ interface RandomConfig {
  *  1. 生成指定长度的随机数
  *  2. 生成介于 [min, max] 之间的随机数
  * @param opts 生成随机数的配置
+ *
+ * @example <caption>1. 生成指定长度的随机字符串</caption>
+ * random(1); // 长度为 1 的随机字符串
+ *
+ * @example <caption>2. 生成纯数字且不能为0长度为1的随机字符</caption>
+ * random({ length: 1, hasLetter: false, firstIsZero: false })
+ *
  * @returns
  */
 export declare function random(opts: number | RandomConfig): string | number;

package/lib/index.js

@@ -58,6 +58,13 @@ export function isBoolean(str) {
  *  1. 生成指定长度的随机数
  *  2. 生成介于 [min, max] 之间的随机数
  * @param opts 生成随机数的配置
+ *
+ * @example <caption>1. 生成指定长度的随机字符串</caption>
+ * random(1); // 长度为 1 的随机字符串
+ *
+ * @example <caption>2. 生成纯数字且不能为0长度为1的随机字符</caption>
+ * random({ length: 1, hasLetter: false, firstIsZero: false })
+ *
  * @returns
  */
 export function random(opts) {
@@ -74,12 +81,11 @@ export function random(opts) {
         }
         const len = typeof opts === "object" ? opts.length : opts;
         /* 生成指定长度的随机数 */
-        const charLens = RANDOM_CHARS.length;
         let chars = RANDOM_CHARS;
         if (typeof opts === "object" && opts.hasLetter === false) {
             chars = NUMBER_RANDOM_CHARTS;
         }
-        const resRandom = Array.from({ length: len }, () => chars.charAt(Math.floor(Math.random() * charLens))).join("");
+        const resRandom = Array.from({ length: len }, () => chars.charAt(random({ min: 0, max: 9, hasEnd: true }))).join("");
         if (typeof opts === "object" &&
             opts.firstIsZero === false &&
             resRandom.indexOf("0") === 0) {

package/lib/validator.d.ts

@@ -2,7 +2,7 @@
  * 数据验证器
  */
 interface RuleItem {
-    rule: RegExp | ((v: any) => boolean) | 'required';
+    rule: RegExp | ((v: any) => boolean) | "required";
     message: string;
     sameKey?: string;
 }
@@ -18,7 +18,7 @@ export interface SchemaType {
     message?: string;
 }
 /**
- * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
+ * 数据验证器
  */
 declare class Validator {
     rules: {
@@ -40,7 +40,10 @@ declare class Validator {
      * @param key   指定待验证的 key
      * @param value 待验证的数据
      */
-    validateKey(key: string, value: any, data?: any): Promise<boolean>;
+    validateKey(key: string, value: any, data?: any): Promise<{
+        key: string;
+        value: any;
+    }>;
     private _validateRule;
     private _parseStringRule;
 }

package/lib/validator.js

@@ -3,17 +3,17 @@
  */
 // 默认的错误提示信息
 const defaultMsgs = {
-    mobile: '请输入正确的手机号',
-    same: '两次输入不一致',
-    required: '%s为必填字段',
+    mobile: "请输入正确的手机号",
+    same: "两次输入不一致",
+    required: "%s为必填字段",
 };
-const defaultMsg = '请输入正确的数据';
+const defaultMsg = "请输入正确的数据";
 // 一些常用的验证正则
 const ruleRegexs = {
     /** 验证跟其余数据相等的正则，一般用于验证再次输入密码 */
     same: /^same:(.+)$/i,
     /** 验证手机号的正则表达式 */
-    mobile: /^1[34578]\d{9}$/,
+    mobile: /^1[345678]\d{9}$/,
     /** 非空验证的正则表达式 */
     required: /^\S{1}.*/,
 };
@@ -36,12 +36,12 @@ class ValidateError extends Error {
     key;
     constructor(key, msg) {
         super(msg);
-        this.name = 'ValidateError';
+        this.name = "ValidateError";
         this.key = key;
     }
 }
 /**
- * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
+ * 数据验证器
  */
 class Validator {
     rules;
@@ -56,22 +56,23 @@ class Validator {
             let rules = [];
             let rule = schema.rules;
             if (rule != null) {
-                if (typeof rule === 'string') {
+                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') {
+                        if (typeof ruleItem === "string") {
                             rules.push(...this._parseStringRule(ruleItem, schema.message));
                         }
-                        else if (ruleItem instanceof RegExp || typeof ruleItem === 'function') {
+                        else if (ruleItem instanceof RegExp ||
+                            typeof ruleItem === "function") {
                             rules.push({
                                 rule: ruleItem,
                                 message: schema.message || defaultMsg,
                             });
                         }
                         else {
-                            if (typeof ruleItem.rule === 'string') {
+                            if (typeof ruleItem.rule === "string") {
                                 rules.push(...this._parseStringRule(ruleItem.rule, ruleItem.message));
                             }
                             else {
@@ -87,8 +88,9 @@ class Validator {
                     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));
+            if (schema.required === true &&
+                (rules == null || rules.findIndex((r) => r.rule === "required") === -1)) {
+                rules.push(...this._parseStringRule("required", schema.message));
             }
             parsedRules[schema.key] = rules;
         }
@@ -99,57 +101,54 @@ class Validator {
      * @param data 待验证的数据
      * @returns
      */
-    validate(data) {
-        return new Promise((resolve, reject) => {
-            let errMsg = '';
-            let errKey = '';
-            for (let key in this.rules) {
-                // eslint-disable-next-line no-prototype-builtins
-                if (this.rules.hasOwnProperty(key)) {
-                    errMsg = this._validateRule(this.rules[key], data[key], data);
-                    if (errMsg !== '') {
-                        errKey = key;
-                        errMsg = errMsg.replace('%s', key);
-                        break;
-                    }
+    async validate(data) {
+        let errMsg = "";
+        let errKey = "";
+        for (let key in this.rules) {
+            // eslint-disable-next-line no-prototype-builtins
+            if (this.rules.hasOwnProperty(key)) {
+                errMsg = this._validateRule(this.rules[key], data[key], data);
+                if (errMsg !== "") {
+                    errKey = key;
+                    errMsg = errMsg.replace("%s", key);
+                    break;
                 }
             }
-            if (errMsg === '') {
-                resolve(true);
-            }
-            else {
-                reject(new ValidateError(errKey, errMsg));
-            }
-        });
+        }
+        if (errMsg === "") {
+            return true;
+        }
+        else {
+            throw new ValidateError(errKey, errMsg);
+        }
     }
     /**
      * 只验证指定 key 的数据格式
      * @param key   指定待验证的 key
      * @param value 待验证的数据
      */
-    validateKey(key, value, data) {
-        return new Promise((resolve, reject) => {
-            let keyRules = this.rules[key];
-            let errMsg = this._validateRule(keyRules, value, data);
-            if (errMsg !== '') {
-                errMsg = errMsg.replace('%s', key);
-                reject(new ValidateError(key, errMsg));
-            }
-            else {
-                resolve(true);
-            }
-        });
+    async validateKey(key, value, data) {
+        let keyRules = this.rules[key];
+        let errMsg = this._validateRule(keyRules, value, data);
+        if (errMsg !== "") {
+            errMsg = errMsg.replace("%s", key);
+            throw new ValidateError(key, errMsg);
+        }
+        else {
+            return { key, value };
+        }
     }
     _validateRule(rules, value, data) {
-        let errMsg = '';
+        this.validateKey("", 1).catch((err) => { });
+        let errMsg = "";
         for (let rule of rules) {
             // 如果数据为空，则判断是否是必填
-            if (rule.rule === 'required') {
+            if (rule.rule === "required") {
                 if (value == null || !ruleFns.pattern(ruleRegexs.required, value)) {
                     errMsg = rule.message;
                 }
             }
-            if (typeof rule.rule === 'function') {
+            if (typeof rule.rule === "function") {
                 if (!rule.rule(value)) {
                     errMsg = rule.message;
                 }
@@ -161,7 +160,7 @@ class Validator {
                     }
                 }
             }
-            else if (rule.rule === 'required') {
+            else if (rule.rule === "required") {
                 if (!ruleFns.pattern(ruleRegexs.required, String(value))) {
                     errMsg = rule.message;
                 }
@@ -171,7 +170,7 @@ class Validator {
                     errMsg = rule.message;
                 }
             }
-            if (errMsg !== '') {
+            if (errMsg !== "") {
                 break;
             }
         }
@@ -179,7 +178,7 @@ class Validator {
     }
     _parseStringRule(rule, ruleErrMsg) {
         let rules = [];
-        let trule = rule.split('|');
+        let trule = rule.split("|");
         for (let r of trule) {
             let message = ruleErrMsg;
             let rrule = null;
@@ -192,11 +191,11 @@ class Validator {
                     if (m != null) {
                         sameKey = m[1];
                     }
-                    message = message || defaultMsgs['same'];
+                    message = message || defaultMsgs["same"];
                 }
             }
-            else if (rule === 'required') {
-                rrule = 'required';
+            else if (rule === "required") {
+                rrule = "required";
                 message = message || ruleErrMsg || defaultMsgs.required;
                 // eslint-disable-next-line no-prototype-builtins
             }

package/package.json

@@ -52,7 +52,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.4.6",
+  "version": "0.4.8",
   "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);
-}