ph-utils 0.2.3 → 0.2.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Tenny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/date.js

@@ -100,10 +100,10 @@ function startOf(date, unit, isEnd = false) {
 exports.startOf = startOf;
 /**
  * 日期加上指定时间后的日期
- * @param date  指定的日期
- * @param num   需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit  需要添加的单位，date - 加减天数
- * @param fmt   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ * @param date {Date | number | string | null}  指定的日期
+ * @param num {number}  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit {string}  需要添加的单位，date - 加减天数
+ * @param fmt {string}   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
  * @returns {Date | string} 如果传递了 fmt 参数，则返回 string，否则返回 Date
  */
 function add(date, num, unit, fmt) {

package/lib/dom.d.ts

@@ -41,7 +41,7 @@ export declare function transform(element: HTMLElement, value: string): void;
  * @param {function}    event     事件处理函数
  * @param {boolean}     onceOrConfig  是否是只运行一次的处理函数或者配置，其中 eventFlag 为 string，如果配置该项，则表明为委托事件
  */
-export declare function on(element: HTMLElement, listener: string, fn: (e: Event, target?: HTMLElement, flag?: string) => void, once?: boolean | {
+export declare function on<T extends Event>(element: HTMLElement, listener: string, fn: (e: T, target?: HTMLElement, flag?: string) => void, once?: boolean | {
     once?: boolean;
     eventFlag?: string;
     eventStop?: boolean;

package/lib/index.d.ts

@@ -6,7 +6,7 @@
  * @param str               待验证的字符串
  * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
  */
-export declare function isBlank(str?: string, ignoreWhitespace?: boolean): boolean;
+export declare function isBlank(str?: string | null, ignoreWhitespace?: boolean): boolean;
 /**
  * 屏蔽手机号，中间部分用 * 展示
  * @param mobile 待屏蔽的手机号

package/lib/index_m.d.ts

@@ -6,7 +6,7 @@
  * @param str               待验证的字符串
  * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
  */
-export declare function isBlank(str?: string, ignoreWhitespace?: boolean): boolean;
+export declare function isBlank(str?: string | null, ignoreWhitespace?: boolean): boolean;
 /**
  * 屏蔽手机号，中间部分用 * 展示
  * @param mobile 待屏蔽的手机号

package/lib/server.js

@@ -59,7 +59,7 @@ module.exports = {
             options = { ...(options || {}) };
             const errorName = options.errorName || 'ExecError';
             delete options.errorName;
-            (0, child_process_1.exec)(cmd, options, (error, stdout, stderr) => {
+            child_process_1.exec(cmd, options, (error, stdout, stderr) => {
                 let err = null;
                 let rs = null;
                 if (error) {

package/lib/validator.d.ts

@@ -1,8 +1,20 @@
+/**
+ * 数据验证器
+ */
 interface RuleItem {
     rule: RegExp | ((v: any) => boolean);
     message: string;
     sameKey?: string;
 }
+export declare type RuleType = string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
+    rule: string | RegExp | ((v: any) => boolean);
+    message?: string;
+});
+export interface SchemaType {
+    key: string;
+    type?: string | ((v: any) => void);
+    rules: RuleType[];
+}
 /**
  * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
  */
@@ -17,14 +29,7 @@ declare class Validator {
      * 构造数据验证转换器
      * @param schemas 配置验证转换规则
      */
-    constructor(schemas: {
-        key: string;
-        type?: string | ((v: any) => void);
-        rules: string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
-            rule: string | RegExp | ((v: any) => boolean);
-            message?: string;
-        })[];
-    }[]);
+    constructor(schemas: SchemaType[]);
     /**
      * 进行数据验证，同时根据 type 进行数据类型转换
      * @param data 待验证的数据

package/lib/validator.js

@@ -53,9 +53,11 @@ const typeFns = {
 };
 class ValidateError extends Error {
     name;
-    constructor(msg) {
+    key;
+    constructor(key, msg) {
         super(msg);
         this.name = 'ValidateError';
+        this.key = key;
     }
 }
 /**
@@ -95,7 +97,7 @@ class Validator {
                     }
                     else {
                         if (typeof ruleItem.rule === 'string') {
-                            rules = rules.concat(this._parseStringRule(ruleItem.rule));
+                            rules = rules.concat(this._parseStringRule(ruleItem.rule, ruleItem.message));
                         }
                         else {
                             rules.push({ rule: ruleItem.rule, message: ruleItem.message || defaultMsg });
@@ -119,6 +121,7 @@ class Validator {
     validate(data) {
         return new Promise((resolve, reject) => {
             let errMsg = '';
+            let errKey = '';
             let resData = {};
             for (let key in this.rules) {
                 if ({}.hasOwnProperty.call(this.rules, key)) {
@@ -127,6 +130,7 @@ class Validator {
                         resData[key] = this._conversionType(this.types[key], data[key]);
                     }
                     else {
+                        errKey = key;
                         errMsg = errMsg.replace('%s', key);
                         break;
                     }
@@ -136,7 +140,7 @@ class Validator {
                 resolve(resData);
             }
             else {
-                reject(new ValidateError(errMsg));
+                reject(new ValidateError(errKey, errMsg));
             }
         });
     }
@@ -154,7 +158,7 @@ class Validator {
             }
             else {
                 errMsg = errMsg.replace('%s', key);
-                reject(new ValidateError(errMsg));
+                reject(new ValidateError(key, errMsg));
             }
         });
     }
@@ -192,7 +196,7 @@ class Validator {
         }
         return errMsg;
     }
-    _parseStringRule(rule) {
+    _parseStringRule(rule, ruleErrMsg) {
         let rules = [];
         let trule = rule.split('|');
         for (let r of trule) {
@@ -211,6 +215,7 @@ class Validator {
                 rrule = ruleRegexs[r];
                 message = defaultMsgs[r] || defaultMsg;
             }
+            message = ruleErrMsg || message;
             rules.push({ rule: rrule, message: message, sameKey });
         }
         return rules;

package/lib/validator_m.d.ts

@@ -1,8 +1,20 @@
+/**
+ * 数据验证器
+ */
 interface RuleItem {
     rule: RegExp | ((v: any) => boolean);
     message: string;
     sameKey?: string;
 }
+export declare type RuleType = string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
+    rule: string | RegExp | ((v: any) => boolean);
+    message?: string;
+});
+export interface SchemaType {
+    key: string;
+    type?: string | ((v: any) => void);
+    rules: RuleType[];
+}
 /**
  * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
  */
@@ -17,14 +29,7 @@ declare class Validator {
      * 构造数据验证转换器
      * @param schemas 配置验证转换规则
      */
-    constructor(schemas: {
-        key: string;
-        type?: string | ((v: any) => void);
-        rules: string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
-            rule: string | RegExp | ((v: any) => boolean);
-            message?: string;
-        })[];
-    }[]);
+    constructor(schemas: SchemaType[]);
     /**
      * 进行数据验证，同时根据 type 进行数据类型转换
      * @param data 待验证的数据

package/lib/validator_m.js

@@ -51,9 +51,10 @@ const typeFns = {
     },
 };
 class ValidateError extends Error {
-    constructor(msg) {
+    constructor(key, msg) {
         super(msg);
         this.name = 'ValidateError';
+        this.key = key;
     }
 }
 /**
@@ -91,7 +92,7 @@ class Validator {
                     }
                     else {
                         if (typeof ruleItem.rule === 'string') {
-                            rules = rules.concat(this._parseStringRule(ruleItem.rule));
+                            rules = rules.concat(this._parseStringRule(ruleItem.rule, ruleItem.message));
                         }
                         else {
                             rules.push({ rule: ruleItem.rule, message: ruleItem.message || defaultMsg });
@@ -115,6 +116,7 @@ class Validator {
     validate(data) {
         return new Promise((resolve, reject) => {
             let errMsg = '';
+            let errKey = '';
             let resData = {};
             for (let key in this.rules) {
                 if ({}.hasOwnProperty.call(this.rules, key)) {
@@ -123,6 +125,7 @@ class Validator {
                         resData[key] = this._conversionType(this.types[key], data[key]);
                     }
                     else {
+                        errKey = key;
                         errMsg = errMsg.replace('%s', key);
                         break;
                     }
@@ -132,7 +135,7 @@ class Validator {
                 resolve(resData);
             }
             else {
-                reject(new ValidateError(errMsg));
+                reject(new ValidateError(errKey, errMsg));
             }
         });
     }
@@ -150,7 +153,7 @@ class Validator {
             }
             else {
                 errMsg = errMsg.replace('%s', key);
-                reject(new ValidateError(errMsg));
+                reject(new ValidateError(key, errMsg));
             }
         });
     }
@@ -188,7 +191,7 @@ class Validator {
         }
         return errMsg;
     }
-    _parseStringRule(rule) {
+    _parseStringRule(rule, ruleErrMsg) {
         let rules = [];
         let trule = rule.split('|');
         for (let r of trule) {
@@ -207,6 +210,7 @@ class Validator {
                 rrule = ruleRegexs[r];
                 message = defaultMsgs[r] || defaultMsg;
             }
+            message = ruleErrMsg || message;
             rules.push({ rule: rrule, message: message, sameKey });
         }
         return rules;

package/lib/web.js

@@ -1,7 +1,7 @@
 /**
  * web(浏览器) 端工具类
  */
-import { isBlank, isBoolean, isNumeric } from './index';
+import { isBlank, isBoolean, isNumeric } from './index_m';
 /**
  * 解析 Form 表单中的 input 元素的数据为 JSON 格式，key: input-name；value: input-value
  * @param form {object} Form 节点对象

package/package.json

@@ -5,7 +5,7 @@
   "module": "lib/index_m.js",
   "types": "lib/index.d.ts",
   "browser": "lib/index_m.js",
-  "version": "0.2.3",
+  "version": "0.2.7",
   "repository": {
     "type": "git",
     "url": "git+https//gitee.com/towardly/ph.git",