cvitool 1.0.754 → 1.0.755

package/build/src/cutil.d.ts

@@ -14,6 +14,32 @@ interface getMediaFileTypeRes {
     type: 'image' | 'video' | 'audio' | 'unknow';
     extname: 'jpg' | 'png' | 'webp' | 'bmp' | 'heic' | 'gif' | 'mp3' | 'wav' | 'pcm' | 'flac' | 'm4a' | 'aac' | 'mp4' | 'mov' | 'flv' | 'mkv' | 'avi' | 'webm' | 'ogg' | 'm4v' | 'wmv' | 'unknow';
 }
+interface validateParams {
+    required: boolean;
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array';
+    allowEmpty?: boolean;
+    allowNull?: boolean;
+    enums?: any[];
+    regex?: string | string[];
+    range?: [number, number];
+    subType?: 'string' | 'number' | 'boolean' | 'object' | 'array';
+    subValidate?: validateParams | {
+        [key: string]: validateParams;
+    };
+}
+declare const RegStr: {
+    zzs: string;
+    zxs: (digit: number) => string;
+    zrs: string;
+    fzs: string;
+    fxs: (digit: number) => string;
+    zs: string;
+    uri: string;
+    url: string;
+    emali: string;
+    mobilePhoneNumber: string;
+    idNumber: string;
+};
 /**
  * 获取一个随机字符串
  * @param length 字符串长度
@@ -101,4 +127,19 @@ declare function readJsonFileSync(path: string, toObj?: boolean): CustomObject |
  * @returns
  */
 declare function uuid(): string;
-export { randomStringOptions, getMediaFileTypeRes, CustomObject, randomString, encryptCBC, decryptCBC, md5, execCmdCommand, getValueType, getMediaFileType, checkURLResource, writeJsonFileSync, readJsonFileSync, uuid };
+/**
+ * 参数校验
+ * @param value
+ * @param rule
+ * @returns
+ */
+declare function validate(value: {
+    [key: string]: any;
+}, rule: {
+    [key: string]: validateParams;
+}): {
+    message: string;
+    field: string;
+    pass: boolean;
+};
+export { randomStringOptions, getMediaFileTypeRes, CustomObject, randomString, encryptCBC, decryptCBC, md5, execCmdCommand, getValueType, getMediaFileType, checkURLResource, writeJsonFileSync, readJsonFileSync, uuid, validate, RegStr };

package/build/src/cutil.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegStr = void 0;
 exports.randomString = randomString;
 exports.encryptCBC = encryptCBC;
 exports.decryptCBC = decryptCBC;
@@ -20,10 +21,25 @@ exports.checkURLResource = checkURLResource;
 exports.writeJsonFileSync = writeJsonFileSync;
 exports.readJsonFileSync = readJsonFileSync;
 exports.uuid = uuid;
+exports.validate = validate;
 const crypto_1 = require("crypto");
 const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const hgo = require("./hgo");
+const RegStr = {
+    zzs: '^[1-9]\\d*$',
+    zxs: (digit) => `^(0|[1-9]\\d*)(\\.\\d{1,${digit}})$`,
+    zrs: '^(0|[1-9]\\d*)$',
+    fzs: '^-[1-9]\\d*$',
+    fxs: (digit) => `^-(0|[1-9]\\d*)(\\.\\d{1,${digit}})$`,
+    zs: '^(0|-?[1-9]\\d*)$',
+    uri: '^[a-zA-z]+://\\S+$',
+    url: '^(https?)://([a-z\\d-]+)(\\.[a-z\\d-]+)*/\\S*$',
+    emali: '^\\w+([-+.]\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$',
+    mobilePhoneNumber: '^1[3-9]\\d{9}$',
+    idNumber: '^\\d{17}[\\dXx]$'
+};
+exports.RegStr = RegStr;
 /**
  * 获取一个随机字符串
  * @param length 字符串长度
@@ -373,3 +389,105 @@ function readJsonFileSync(path, toObj = true) {
 function uuid() {
     return (0, crypto_1.randomUUID)().replace(/-/g, '');
 }
+/**
+ * 参数校验
+ * @param value
+ * @param rule
+ * @returns
+ */
+function validate(value, rule) {
+    const result = {
+        message: '',
+        field: '',
+        pass: true
+    };
+    for (const filedName in rule) {
+        const filedValidate = rule[filedName];
+        const filedValue = value[filedName];
+        result.field = filedName;
+        const { required, type, allowEmpty = false, allowNull = false, enums = [], regex, subType, subValidate, range } = filedValidate;
+        if (required && filedValue === undefined) {
+            result.message = 'filed required';
+            result.pass = false;
+            return result;
+        }
+        if (filedValue !== undefined) {
+            if (!allowNull && filedValue === null) {
+                result.message = 'filed value can not null';
+                result.pass = false;
+                return result;
+            }
+            if (filedValue !== null) {
+                if (getValueType(filedValue) !== type) {
+                    result.message = `filed type must be: ${type}`;
+                    result.pass = false;
+                    return result;
+                }
+                if ((type === 'string' && !allowEmpty && filedValue === '') ||
+                    (type === 'array' && !allowEmpty && filedValue.length === 0) ||
+                    (type === 'object' && !allowEmpty && Object.keys(filedValue).length === 0)) {
+                    result.message = 'filed value can not empty';
+                    result.pass = false;
+                    return result;
+                }
+                if (['string', 'number'].includes(type) && enums.length && !enums.includes(filedValue)) {
+                    result.message = `filed value must one of: [${enums.join(', ')}]`;
+                    result.pass = false;
+                    return result;
+                }
+                if (['string', 'number'].includes(type) && regex) {
+                    if (getValueType(regex) === 'string' && !new RegExp(regex).test(String(filedValue))) {
+                        result.message = 'filed value is not pass regex';
+                        result.pass = false;
+                        return result;
+                    }
+                    if (getValueType(regex) === 'array' && regex.every(regexStr => !new RegExp(regexStr).test(String(filedValue)))) {
+                        result.message = 'filed value is not pass regex';
+                        result.pass = false;
+                        return result;
+                    }
+                }
+                if (['string', 'number'].includes(type) && range && range.length === 2 && range[0] <= range[1]) {
+                    if (type === 'number' && (filedValue < range[0] || filedValue > range[1])) {
+                        result.message = `filed value is not in range [${range[0]}, ${range[1]}]`;
+                        result.pass = false;
+                        return result;
+                    }
+                    if (type === 'string') {
+                        const len = filedValue.length;
+                        if (len < range[0] || len > range[1]) {
+                            result.message = `filed value length not in range [${range[0]}, ${range[1]}]`;
+                            result.pass = false;
+                            return result;
+                        }
+                    }
+                }
+                if (type === 'object' && subValidate) {
+                    const res = validate(filedValue, subValidate);
+                    if (!res.pass) {
+                        return res;
+                    }
+                }
+                if (type === 'array' && subType) {
+                    for (const subValue of filedValue) {
+                        if (getValueType(subValue) !== subType) {
+                            result.message = `filed type must be: ${type}`;
+                            result.pass = false;
+                            return result;
+                        }
+                    }
+                }
+                if (type === 'array' && subType === 'object' && subValidate) {
+                    for (const subValue of filedValue) {
+                        const res = validate(subValue, subValidate);
+                        if (!res.pass) {
+                            return res;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    result.field = '';
+    return result;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cvitool",
-  "version": "1.0.754",
+  "version": "1.0.755",
   "description": "cvitool",
   "main": "index.js",
   "scripts": {

package/src/cutil.ts

@@ -30,6 +30,32 @@ interface getMediaFileTypeRes {
     extname: 'jpg' | 'png' | 'webp' | 'bmp' | 'heic' | 'gif' | 'mp3' | 'wav' | 'pcm' | 'flac' | 'm4a' | 'aac' | 'mp4' | 'mov' | 'flv' | 'mkv' | 'avi' | 'webm' | 'ogg' | 'm4v' | 'wmv' | 'unknow'
 }
 
+interface validateParams {
+    required: boolean,
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array',
+    allowEmpty?: boolean,
+    allowNull?: boolean,
+    enums?: any[],
+    regex?: string | string[],
+    range?: [number, number],
+    subType?: 'string' | 'number' | 'boolean' | 'object' | 'array',
+    subValidate?: validateParams | { [key: string]: validateParams }
+}
+
+const RegStr = {
+    zzs: '^[1-9]\\d*$',
+    zxs: (digit: number) => `^(0|[1-9]\\d*)(\\.\\d{1,${digit}})$`,
+    zrs: '^(0|[1-9]\\d*)$',
+    fzs: '^-[1-9]\\d*$',
+    fxs: (digit: number) => `^-(0|[1-9]\\d*)(\\.\\d{1,${digit}})$`,
+    zs: '^(0|-?[1-9]\\d*)$',
+    uri: '^[a-zA-z]+://\\S+$',
+    url: '^(https?)://([a-z\\d-]+)(\\.[a-z\\d-]+)*/\\S*$',
+    emali: '^\\w+([-+.]\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$',
+    mobilePhoneNumber: '^1[3-9]\\d{9}$',
+    idNumber: '^\\d{17}[\\dXx]$'
+};
+
 /**
  * 获取一个随机字符串
  * @param length 字符串长度
@@ -379,6 +405,111 @@ function uuid() {
     return randomUUID().replace(/-/g, '');
 }
 
+/**
+ * 参数校验
+ * @param value
+ * @param rule
+ * @returns
+ */
+function validate(value: { [key: string]: any }, rule: { [key: string]: validateParams }): { message: string, field: string, pass: boolean } {
+    const result = {
+        message: '',
+        field: '',
+        pass: true
+    };
+    for (const filedName in rule) {
+        const filedValidate = rule[filedName];
+        const filedValue = value[filedName];
+        result.field = filedName;
+        const { required, type, allowEmpty = false, allowNull = false, enums = [], regex, subType, subValidate, range } = filedValidate;
+        if (required && filedValue === undefined) {
+            result.message = 'filed required';
+            result.pass = false;
+            return result;
+        }
+        if (filedValue !== undefined) {
+            if (!allowNull && filedValue === null) {
+                result.message = 'filed value can not null';
+                result.pass = false;
+                return result;
+            }
+            if (filedValue !== null) {
+                if (getValueType(filedValue) !== type) {
+                    result.message = `filed type must be: ${type}`;
+                    result.pass = false;
+                    return result;
+                }
+                if (
+                    (type === 'string' && !allowEmpty && filedValue === '') ||
+                    (type === 'array' && !allowEmpty && (filedValue as any[]).length === 0) ||
+                    (type === 'object' && !allowEmpty && Object.keys(filedValue).length === 0)
+                ) {
+                    result.message = 'filed value can not empty';
+                    result.pass = false;
+                    return result;
+                }
+                if (['string', 'number'].includes(type) && enums.length && !enums.includes(filedValue)) {
+                    result.message = `filed value must one of: [${enums.join(', ')}]`;
+                    result.pass = false;
+                    return result;
+                }
+                if (['string', 'number'].includes(type) && regex) {
+                    if (getValueType(regex) === 'string' && !new RegExp(regex as string).test(String(filedValue))) {
+                        result.message = 'filed value is not pass regex';
+                        result.pass = false;
+                        return result;
+                    }
+                    if (getValueType(regex) === 'array' && (regex as string[]).every(regexStr => !new RegExp(regexStr).test(String(filedValue)))) {
+                        result.message = 'filed value is not pass regex';
+                        result.pass = false;
+                        return result;
+                    }
+                }
+                if (['string', 'number'].includes(type) && range && range.length === 2 && range[0] <= range[1]) {
+                    if (type === 'number' && (filedValue < range[0] || filedValue > range[1])) {
+                        result.message = `filed value is not in range [${range[0]}, ${range[1]}]`;
+                        result.pass = false;
+                        return result;
+                    }
+                    if (type === 'string') {
+                        const len = (filedValue as string).length;
+                        if (len < range[0] || len > range[1]) {
+                            result.message = `filed value length not in range [${range[0]}, ${range[1]}]`;
+                            result.pass = false;
+                            return result;
+                        }
+                    }
+                }
+                if (type === 'object' && subValidate) {
+                    const res = validate(filedValue, subValidate as { [key: string]: validateParams });
+                    if (!res.pass) {
+                        return res;
+                    }
+                }
+                if (type === 'array' && subType) {
+                    for (const subValue of filedValue) {
+                        if (getValueType(subValue) !== subType) {
+                            result.message = `filed type must be: ${type}`;
+                            result.pass = false;
+                            return result;
+                        }
+                    }
+                }
+                if (type === 'array' && subType === 'object' && subValidate) {
+                    for (const subValue of filedValue) {
+                        const res = validate(subValue, subValidate as { [key: string]: validateParams });
+                        if (!res.pass) {
+                            return res;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    result.field = '';
+    return result;
+}
+
 export {
     randomStringOptions,
     getMediaFileTypeRes,
@@ -393,5 +524,7 @@ export {
     checkURLResource,
     writeJsonFileSync,
     readJsonFileSync,
-    uuid
+    uuid,
+    validate,
+    RegStr
 };