util-helpers 4.9.0 → 4.10.2

package/README.md

@@ -70,6 +70,7 @@ formatMoney('1000'); // => 1,000.00
   - [isVehicle](https://doly-dev.github.io/util-helpers/module-Validator.html#.isVehicle) - 车牌号
   - [isBankCard](https://doly-dev.github.io/util-helpers/module-Validator.html#.isBankCard) - 银行卡
   - [isSocialCreditCode](https://doly-dev.github.io/util-helpers/module-Validator.html#.isSocialCreditCode) - 统一社会信用代码，也叫三证合一组织代码
+  - [isSwiftCode](https://doly-dev.github.io/util-helpers/module-Validator.html#.isSwiftCode) - Swift Code
   - [isPassword](https://doly-dev.github.io/util-helpers/module-Validator.html#.isPassword) 密码强度
   - [isPassport](https://doly-dev.github.io/util-helpers/module-Validator.html#.isPassport) - 护照号
   - [isPromiseLike](https://doly-dev.github.io/util-helpers/module-Validator.html#.isPromiseLike) - 类似 Promise 对象
@@ -82,6 +83,7 @@ formatMoney('1000'); // => 1,000.00
 - 其他
   - [calculateCursorPosition](https://doly-dev.github.io/util-helpers/module-Other.html#.calculateCursorPosition) - 计算光标位置
   - [randomString](https://doly-dev.github.io/util-helpers/module-Other.html#.randomString) - 随机字符串
+  - [strlen](https://doly-dev.github.io/util-helpers/module-Other.html#.strlen) - 字符长度
   - [waitTime](https://doly-dev.github.io/util-helpers/module-Other.html#.waitTime) - 等待时间返回 Promise
 
 ## 精选第三方工具库

package/dist/util-helpers.js

@@ -4,6 +4,62 @@
   (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.utilHelpers = {}));
 }(this, (function (exports) { 'use strict';
 
+  /**
+   * 检查值是否为Undefined
+   *
+   * @static
+   * @alias module:Type.isUndefined
+   * @since 1.1.0
+   * @param {*} value 检查值
+   * @returns {boolean} 是否为Undefined
+   * @example
+   *
+   * isUndefined(undefined)
+   * // => true
+   *
+   * isUndefined(void 0)
+   * // => true
+   *
+   * isUndefined(null)
+   * // => false
+   */
+  function isUndefined(value) {
+    return value === void 0;
+  }
+
+  /**
+   * 检查值是否为Null
+   *
+   * @static
+   * @alias module:Type.isNull
+   * @since 1.1.0
+   * @param {*} value 检查值
+   * @returns {boolean} 是否为Null
+   * @example
+   *
+   * isNull(null)
+   * // => true
+   *
+   * isNull(void 0)
+   * // => false
+   */
+  function isNull(value) {
+    return value === null;
+  }
+
+  /**
+   * 检查值是否为 undefined 或 null
+   *
+   * @static
+   * @alias module:Type.isNaN
+   * @since 4.3.0
+   * @param {*} value 检查值
+   * @returns {boolean} 是否为 undefined 或 null
+   */
+  function isNil(value) {
+    return isUndefined(value) || isNull(value);
+  }
+
   const toString = Object.prototype.toString;
 
   /**
@@ -49,6 +105,33 @@
     return isString(value) ? value : String(value);
   }
 
+  /**
+   * 规整化字符串。如果值为 undefined 或 null 将转为空字符串，如果值不是字符串类型将转为字符串。
+   *
+   * @static
+   * @alias module:Processor.normalizeString
+   * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
+   * @since 4.3.0
+   * @param {*} value 待处理的值
+   * @returns {string} 规整化的值
+   * @example
+   * normalizeString(); // ''
+   * normalizeString(undefined); // ''
+   * normalizeString(void 0); // ''
+   * normalizeString(null); // ''
+   *
+   * normalizeString(true); // 'true'
+   * normalizeString(NaN); // 'NaN'
+   * normalizeString(1); // '1'
+   * normalizeString('a'); // 'a'
+   */
+  function normalizeString(value) {
+    if (isNil(value)) {
+      return '';
+    }
+    return convertToString(value);
+  }
+
   // 手机号码 11位数字，以1开头，第二位是3456789其中一个，后面再加9个数字
   const reg$d = /^1[3456789]\d{9}$/;
 
@@ -70,7 +153,7 @@
    *
    */
   function isMobile(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$d.test(valueStr);
   }
 
@@ -101,7 +184,7 @@
    *
    */
   function isTelephone(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$c.test(valueStr);
   }
 
@@ -126,7 +209,7 @@
    *
    */
   function isPostcode(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$b.test(valueStr);
   }
 
@@ -185,7 +268,7 @@
    *
    */
   function isIdCard(value, { loose = false, checkCode = true } = {}) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     if (valueStr.length === 15 && loose) {
       return regIdCard$1.test(valueStr);
     }
@@ -221,7 +304,7 @@
    *
    */
   function isEmail(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$a.test(valueStr);
   }
 
@@ -246,7 +329,7 @@
    *
    */
   function isQQ(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$9.test(valueStr);
   }
 
@@ -271,7 +354,7 @@
    *
    */
   function isWX(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$8.test(valueStr);
   }
 
@@ -306,7 +389,7 @@
    *
    */
   function isVehicle(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$7.test(valueStr);
   }
 
@@ -362,7 +445,7 @@
    *
    */
   function isBankCard(value, { loose = false, luhn = false } = {}) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     const validateResult = loose ? regLoose.test(valueStr) : reg$6.test(valueStr);
 
     if (validateResult && luhn) {
@@ -433,7 +516,7 @@
    *
    */
   function isSocialCreditCode(value, { loose = false } = {}) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
 
     const passBaseRule = baseReg$1.test(valueStr);
 
@@ -770,12 +853,12 @@
     return validatePassword(value, { level, ignoreCase, special }).validated;
   }
 
-  // 护照号 9位，包括首字母和数字；支持 普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ)、澳门特区护照(MA)
-  const reg$5 = /^((e[\da-z])|(de)|(se)|(pe)|(k[\da-z])|(kj)|(ma))[\da-z]{7}$/i;
+  // 护照号 9位，包括首字母和数字；支持 普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ/H*)、澳门特区护照(MA/MB/M*)
+  const reg$5 = /^((e[\da-z])|(de)|(se)|(pe)|([khm][\da-z]))[\da-z]{7}$/i;
 
   /**
    * 检测值是否为护照号
-   * 支持普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ)、澳门特区护照(MA)
+   * 支持普通护照(E*)、外交护照(DE)、公务护照(SE)、公务普通护照(PE)、香港特区护照(K/KJ/H*)、澳门特区护照(MA/MB/M*)，注意不区分大小写
    *
    * @static
    * @alias module:Validator.isPassport
@@ -793,7 +876,7 @@
    *
    */
   function isPassport(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$5.test(valueStr);
   }
 
@@ -863,7 +946,7 @@
    *
    */
   function isChinese(value, { loose = false } = {}) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     const reg = new RegExp(loose ? looseChineseRegExp : chineseRegExp, supportRegExpUnicode ? 'u' : undefined);
     return reg.test(valueStr);
   }
@@ -895,7 +978,7 @@
    *
    */
   function isIPv4(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$4.test(valueStr);
   }
 
@@ -951,7 +1034,7 @@
    *
    */
   function isIPv6(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$3.test(valueStr);
   }
 
@@ -991,7 +1074,7 @@
    * // => true
    */
   function isUrl(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$2.test(valueStr);
   }
 
@@ -1058,7 +1141,7 @@
    * // => true
    */
   function isBusinessLicense(value, { loose = false } = {}) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
 
     const passBaseRule = baseReg.test(valueStr);
 
@@ -1126,12 +1209,15 @@
    * isHMCard('M32031177') // true
    */
   function isHMCard(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return regHMCard.test(valueStr);
   }
 
-  // 台湾居民来往大陆通行证正则，支持一次性短期台胞证
-  const regTWCard = /^(\d{8}|[\da-z]{10})$/i;
+  // 台湾居民来往大陆通行证正则
+  const regTWCard = /^\d{8}$/i;
+
+  // 一次性短期台胞证
+  const singleRegTWCard = /^[\da-z]{10,12}$/i;
 
   /**
    * 检测值是否为台湾居民来往大陆通行证，俗称台胞证。
@@ -1141,17 +1227,23 @@
    * @since 4.0.0
    * @see 参考 {@link https://zh.wikipedia.org/wiki/台湾居民来往大陆通行证|台湾居民来往大陆通行证}
    * @param {*} value 要检测的值
+   * @param {Object} [options] 配置项
+   * @param {boolean} [options.loose=false] 宽松模式。如果为true，表示支持一次性短期通行证
    * @returns {boolean} 是否为台湾居民来往大陆通行证
    * @example
    * isTWCard('12345678') // true
    * isTWCard('07257456') // true
    *
    * // 一次性短期
-   * isTWCard('F290299977') // true
+   * isTWCard('F290299977') // false
+   * isTWCard('F290299977', { loose: true }) // true
    */
-  function isTWCard(value) {
-    const valueStr = convertToString(value);
-    return regTWCard.test(valueStr);
+  function isTWCard(value, { loose = false } = {}) {
+    const valueStr = normalizeString(value);
+    if (regTWCard.test(valueStr)) {
+      return true;
+    }
+    return loose ? singleRegTWCard.test(valueStr) : false;
   }
 
   const reg$1 = /^[A-Z]{6}[A-Z\d]{2}(?:[A-Z\d]{3})?$/;
@@ -1165,9 +1257,19 @@
    * @since 4.9.0
    * @param {*} value 要检测的值
    * @returns {boolean} 值是否为 Swift Code
+   * @example
+   *
+   * isSwiftCode('DEUTDEFF') //  true
+   * isSwiftCode('deutdeff') //  false
+   *
+   * isSwiftCode('BKTWTWTP010') //  true
+   * isSwiftCode('010BKTWTWTP') //  false
+   *
+   * isSwiftCode('ICBKCNBJBJM') //  true
+   *
    */
   function isSwiftCode(value) {
-    const valueStr = convertToString(value);
+    const valueStr = normalizeString(value);
     return reg$1.test(valueStr);
   }
 
@@ -1472,89 +1574,6 @@
     return symbol + formatInt(intStr, thousand) + formatDec(decStr, precision, decimal);
   };
 
-  /**
-   * 检查值是否为Undefined
-   *
-   * @static
-   * @alias module:Type.isUndefined
-   * @since 1.1.0
-   * @param {*} value 检查值
-   * @returns {boolean} 是否为Undefined
-   * @example
-   *
-   * isUndefined(undefined)
-   * // => true
-   *
-   * isUndefined(void 0)
-   * // => true
-   *
-   * isUndefined(null)
-   * // => false
-   */
-  function isUndefined(value) {
-    return value === void 0;
-  }
-
-  /**
-   * 检查值是否为Null
-   *
-   * @static
-   * @alias module:Type.isNull
-   * @since 1.1.0
-   * @param {*} value 检查值
-   * @returns {boolean} 是否为Null
-   * @example
-   *
-   * isNull(null)
-   * // => true
-   *
-   * isNull(void 0)
-   * // => false
-   */
-  function isNull(value) {
-    return value === null;
-  }
-
-  /**
-   * 检查值是否为 undefined 或 null
-   *
-   * @static
-   * @alias module:Type.isNaN
-   * @since 4.3.0
-   * @param {*} value 检查值
-   * @returns {boolean} 是否为 undefined 或 null
-   */
-  function isNil(value) {
-    return isUndefined(value) || isNull(value);
-  }
-
-  /**
-   * 规整化字符串。如果值为 undefined 或 null 将转为空字符串，如果值不是字符串类型将转为字符串。
-   *
-   * @static
-   * @alias module:Processor.normalizeString
-   * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
-   * @since 4.3.0
-   * @param {*} value 待处理的值
-   * @returns {string} 规整化的值
-   * @example
-   * normalizeString(); // ''
-   * normalizeString(undefined); // ''
-   * normalizeString(void 0); // ''
-   * normalizeString(null); // ''
-   *
-   * normalizeString(true); // 'true'
-   * normalizeString(NaN); // 'NaN'
-   * normalizeString(1); // '1'
-   * normalizeString('a'); // 'a'
-   */
-  function normalizeString(value) {
-    if (isNil(value)) {
-      return '';
-    }
-    return convertToString(value);
-  }
-
   /**
    * 格式化银行卡号
    *
@@ -2637,7 +2656,7 @@
    * @alias module:Other.randomString
    * @since 4.8.0
    * @param {number} [len=0] 长度
-   * @param {string} [optionalChars] 允许的字符，默认为数字和大小写字母
+   * @param {string} [optionalChars='0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'] 允许的字符，默认为数字和大小写字母
    * @returns {string} 随机字符串
    * @example
    * randomString(5); // slk23
@@ -2654,6 +2673,38 @@
     return internalRandomString(len, realChars);
   }
 
+  /**
+   * 获取字符长度。中文汉字占2个字符，英文占1个字符，特殊如emoji占4个字符。
+   *
+   * @static
+   * @alias module:Other.strlen
+   * @since 4.10.0
+   * @param {string} str 字符串
+   * @returns {number} 字符长度
+   * @example
+   *
+   * strlen('你好a'); // 5
+   * strlen('你好，世界！'); // 12
+   * strlen('严両丞丽'); // 8
+   * strlen('abcde'); // 5
+   * strlen('𠮷'); // 4
+   * strlen('🍎'); // 4
+   *
+   */
+  function strlen(str) {
+    const realStr = normalizeString(str);
+    let len = 0;
+    for (let i = 0; i < realStr.length; i++) {
+      const c = realStr.charCodeAt(i);
+      if ((c >= 0x0001 && c <= 0x007e) || (0xff60 <= c && c <= 0xff9f)) {
+        len++;
+      } else {
+        len += 2;
+      }
+    }
+    return len;
+  }
+
   exports.blobToDataURL = blobToDataURL;
   exports.bytesToSize = bytesToSize;
   exports.calculateCursorPosition = calculateCursorPosition;
@@ -2695,6 +2746,7 @@
   exports.safeDate = safeDate;
   exports.setDataURLPrefix = setDataURLPrefix;
   exports.setDisableWarning = setDisableWarning;
+  exports.strlen = strlen;
   exports.times = times;
   exports.validatePassword = validatePassword;
   exports.waitTime = waitTime;