util-helpers 5.5.1 → 5.6.0

package/esm/VERSION.js

@@ -1,3 +1,3 @@
-var VERSION = "5.5.1";
+var VERSION = "5.6.0";
 
 export { VERSION as default };

package/esm/index.js

@@ -20,7 +20,7 @@ export { default as isHMCard } from './isHMCard.js';
 export { default as isTWCard } from './isTWCard.js';
 export { default as isSwiftCode } from './isSwiftCode.js';
 export { default as isValidNumber } from './isValidNumber.js';
-export { default as checkResult } from './checkResult.js';
+export { default as isUnifiedIdentifier } from './isUnifiedIdentifier.js';
 export { default as formatMoney } from './formatMoney.js';
 export { default as formatBankCard } from './formatBankCard.js';
 export { default as replaceChar } from './replaceChar.js';
@@ -57,6 +57,7 @@ export { default as calculateCursorPosition } from './calculateCursorPosition.js
 export { default as getExtname } from './getExtname.js';
 export { default as randomString } from './randomString.js';
 export { default as strlen } from './strlen.js';
+export { default as checkResult } from './checkResult.js';
 export { default as transformFieldNames } from './transformFieldNames.js';
 export { default as listToTree } from './listToTree.js';
 export { default as treeToList } from './treeToList.js';

package/esm/isSocialCreditCode.js

@@ -1,33 +1,5 @@
-import { toString } from 'ut2';
+import isUnifiedIdentifier from './isUnifiedIdentifier.js';
 
-var baseReg = /^[\dA-HJ-NPQRTUWXY]{2}\d{6}[\dA-HJ-NPQRTUWXY]{10}$/;
-var baseCodeArr = '0123456789ABCDEFGHJKLMNPQRTUWXY'.split('');
-function sumCheckCode(preCode) {
-    var total = 0;
-    var _loop_1 = function (i) {
-        var index = baseCodeArr.findIndex(function (item) { return item === preCode[i]; });
-        var wf = Math.pow(3, i) % 31;
-        total += index * wf;
-    };
-    for (var i = 0; i < 17; i++) {
-        _loop_1(i);
-    }
-    var remainder = total % 31;
-    var checkCodeIndex = remainder !== 0 ? 31 - remainder : 0;
-    return baseCodeArr[checkCodeIndex];
-}
-function isSocialCreditCode(value, options) {
-    var valueStr = toString(value);
-    var _a = (options || {}).checkCode, needCheckCode = _a === void 0 ? true : _a;
-    var passBaseRule = baseReg.test(valueStr);
-    if (!needCheckCode || !passBaseRule) {
-        return passBaseRule;
-    }
-    var preCode = valueStr.substring(0, 17);
-    var lastCode = valueStr.substring(valueStr.length - 1);
-    var checkCode = sumCheckCode(preCode);
-    return lastCode === checkCode;
-}
-isSocialCreditCode.sumCheckCode = sumCheckCode;
+var isSocialCreditCode = isUnifiedIdentifier;
 
 export { isSocialCreditCode as default };

package/esm/isUnifiedIdentifier.js

@@ -0,0 +1,33 @@
+import { toString } from 'ut2';
+
+var baseReg = /^[\dA-HJ-NPQRTUWXY]{2}\d{6}[\dA-HJ-NPQRTUWXY]{10}$/;
+var baseCodeArr = '0123456789ABCDEFGHJKLMNPQRTUWXY'.split('');
+function sumCheckCode(preCode) {
+    var total = 0;
+    var _loop_1 = function (i) {
+        var index = baseCodeArr.findIndex(function (item) { return item === preCode[i]; });
+        var wf = Math.pow(3, i) % 31;
+        total += index * wf;
+    };
+    for (var i = 0; i < 17; i++) {
+        _loop_1(i);
+    }
+    var remainder = total % 31;
+    var checkCodeIndex = remainder !== 0 ? 31 - remainder : 0;
+    return baseCodeArr[checkCodeIndex];
+}
+function isUnifiedIdentifier(value, options) {
+    var valueStr = toString(value);
+    var _a = (options || {}).checkCode, needCheckCode = _a === void 0 ? true : _a;
+    var passBaseRule = baseReg.test(valueStr);
+    if (!needCheckCode || !passBaseRule) {
+        return passBaseRule;
+    }
+    var preCode = valueStr.substring(0, 17);
+    var lastCode = valueStr.substring(valueStr.length - 1);
+    var checkCode = sumCheckCode(preCode);
+    return lastCode === checkCode;
+}
+isUnifiedIdentifier.sumCheckCode = sumCheckCode;
+
+export { isUnifiedIdentifier as default };

package/lib/VERSION.js

@@ -1,5 +1,5 @@
 'use strict';
 
-var VERSION = "5.5.1";
+var VERSION = "5.6.0";
 
 module.exports = VERSION;

package/lib/index.js

@@ -22,7 +22,7 @@ var isHMCard = require('./isHMCard.js');
 var isTWCard = require('./isTWCard.js');
 var isSwiftCode = require('./isSwiftCode.js');
 var isValidNumber = require('./isValidNumber.js');
-var checkResult = require('./checkResult.js');
+var isUnifiedIdentifier = require('./isUnifiedIdentifier.js');
 var formatMoney = require('./formatMoney.js');
 var formatBankCard = require('./formatBankCard.js');
 var replaceChar = require('./replaceChar.js');
@@ -59,6 +59,7 @@ var calculateCursorPosition = require('./calculateCursorPosition.js');
 var getExtname = require('./getExtname.js');
 var randomString = require('./randomString.js');
 var strlen = require('./strlen.js');
+var checkResult = require('./checkResult.js');
 var transformFieldNames = require('./transformFieldNames.js');
 var listToTree = require('./listToTree.js');
 var treeToList = require('./treeToList.js');
@@ -94,7 +95,7 @@ exports.isHMCard = isHMCard;
 exports.isTWCard = isTWCard;
 exports.isSwiftCode = isSwiftCode;
 exports.isValidNumber = isValidNumber;
-exports.checkResult = checkResult;
+exports.isUnifiedIdentifier = isUnifiedIdentifier;
 exports.formatMoney = formatMoney;
 exports.formatBankCard = formatBankCard;
 exports.replaceChar = replaceChar;
@@ -131,6 +132,7 @@ exports.calculateCursorPosition = calculateCursorPosition;
 exports.getExtname = getExtname;
 exports.randomString = randomString;
 exports.strlen = strlen;
+exports.checkResult = checkResult;
 exports.transformFieldNames = transformFieldNames;
 exports.listToTree = listToTree;
 exports.treeToList = treeToList;

package/lib/isSocialCreditCode.js

@@ -1,35 +1,7 @@
 'use strict';
 
-var ut2 = require('ut2');
+var isUnifiedIdentifier = require('./isUnifiedIdentifier.js');
 
-var baseReg = /^[\dA-HJ-NPQRTUWXY]{2}\d{6}[\dA-HJ-NPQRTUWXY]{10}$/;
-var baseCodeArr = '0123456789ABCDEFGHJKLMNPQRTUWXY'.split('');
-function sumCheckCode(preCode) {
-    var total = 0;
-    var _loop_1 = function (i) {
-        var index = baseCodeArr.findIndex(function (item) { return item === preCode[i]; });
-        var wf = Math.pow(3, i) % 31;
-        total += index * wf;
-    };
-    for (var i = 0; i < 17; i++) {
-        _loop_1(i);
-    }
-    var remainder = total % 31;
-    var checkCodeIndex = remainder !== 0 ? 31 - remainder : 0;
-    return baseCodeArr[checkCodeIndex];
-}
-function isSocialCreditCode(value, options) {
-    var valueStr = ut2.toString(value);
-    var _a = (options || {}).checkCode, needCheckCode = _a === void 0 ? true : _a;
-    var passBaseRule = baseReg.test(valueStr);
-    if (!needCheckCode || !passBaseRule) {
-        return passBaseRule;
-    }
-    var preCode = valueStr.substring(0, 17);
-    var lastCode = valueStr.substring(valueStr.length - 1);
-    var checkCode = sumCheckCode(preCode);
-    return lastCode === checkCode;
-}
-isSocialCreditCode.sumCheckCode = sumCheckCode;
+var isSocialCreditCode = isUnifiedIdentifier;
 
 module.exports = isSocialCreditCode;

package/lib/isUnifiedIdentifier.js

@@ -0,0 +1,35 @@
+'use strict';
+
+var ut2 = require('ut2');
+
+var baseReg = /^[\dA-HJ-NPQRTUWXY]{2}\d{6}[\dA-HJ-NPQRTUWXY]{10}$/;
+var baseCodeArr = '0123456789ABCDEFGHJKLMNPQRTUWXY'.split('');
+function sumCheckCode(preCode) {
+    var total = 0;
+    var _loop_1 = function (i) {
+        var index = baseCodeArr.findIndex(function (item) { return item === preCode[i]; });
+        var wf = Math.pow(3, i) % 31;
+        total += index * wf;
+    };
+    for (var i = 0; i < 17; i++) {
+        _loop_1(i);
+    }
+    var remainder = total % 31;
+    var checkCodeIndex = remainder !== 0 ? 31 - remainder : 0;
+    return baseCodeArr[checkCodeIndex];
+}
+function isUnifiedIdentifier(value, options) {
+    var valueStr = ut2.toString(value);
+    var _a = (options || {}).checkCode, needCheckCode = _a === void 0 ? true : _a;
+    var passBaseRule = baseReg.test(valueStr);
+    if (!needCheckCode || !passBaseRule) {
+        return passBaseRule;
+    }
+    var preCode = valueStr.substring(0, 17);
+    var lastCode = valueStr.substring(valueStr.length - 1);
+    var checkCode = sumCheckCode(preCode);
+    return lastCode === checkCode;
+}
+isUnifiedIdentifier.sumCheckCode = sumCheckCode;
+
+module.exports = isUnifiedIdentifier;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "5.5.1",
+  "version": "5.6.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/index.d.ts

@@ -25,7 +25,7 @@ export { default as isHMCard } from './isHMCard';
 export { default as isTWCard } from './isTWCard';
 export { default as isSwiftCode } from './isSwiftCode';
 export { default as isValidNumber } from './isValidNumber';
-export { default as checkResult } from './checkResult';
+export { default as isUnifiedIdentifier } from './isUnifiedIdentifier';
 /**
  * 数据处理
  *
@@ -117,6 +117,7 @@ export { default as calculateCursorPosition } from './calculateCursorPosition';
 export { default as getExtname } from './getExtname';
 export { default as randomString } from './randomString';
 export { default as strlen } from './strlen';
+export { default as checkResult } from './checkResult';
 /**
  * 树结构数据查询、过滤、转换等处理方法
  *

package/types/isBusinessLicense.d.ts

@@ -4,9 +4,11 @@ type Options = {
 /**
  * 检测值是否为营业执照号，也叫工商注册号。由14位数字本体码和1位数字校验码组成，其中本体码从左至右依次为：6位首次登记机关码、8位顺序码。
  *
+ * @private
  * @alias module:Validator.isBusinessLicense
  * @since 3.5.0
  * @see {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html GS15—2006 工商行政管理市场主体注册号编制规则}
+ * @deprecated 即将废弃。
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，默认`true`。如果为false，不校验校验位。

package/types/isSocialCreditCode.d.ts

@@ -1,12 +1,12 @@
-type Options = {
-    checkCode?: boolean;
-};
+import isUnifiedIdentifier from './isUnifiedIdentifier';
 /**
  * 检测值是否为统一社会信用代码，也叫三证合一组织代码。由18位数字和大写字母组成，不使用I、O、Z、S、V。
  *
+ * @private
  * @alias module:Validator.isSocialCreditCode
  * @since 1.1.0
  * @see {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则 GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
+ * @deprecated 即将废弃，请使用 `isUnifiedIdentifier` 替代。
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
@@ -22,8 +22,5 @@ type Options = {
  * isSocialCreditCode('91350100M000100Y', { checkCode: false }); // false
  *
  */
-declare function isSocialCreditCode(value: any, options?: Options): boolean;
-declare namespace isSocialCreditCode {
-    var sumCheckCode: (preCode: string) => string;
-}
+declare const isSocialCreditCode: typeof isUnifiedIdentifier;
 export default isSocialCreditCode;

package/types/isUnifiedIdentifier.d.ts

@@ -0,0 +1,30 @@
+type Options = {
+    checkCode?: boolean;
+};
+/**
+ * 检测值是否为统一社会信用代码，也叫三证合一组织代码。由18位数字和大写字母组成，不使用I、O、Z、S、V。
+ *
+ * @alias module:Validator.isUnifiedIdentifier
+ * @since 5.6.0
+ * @see {@link https://zh.wikisource.org/zh-hans/GB_32100-2015_法人和其他组织统一社会信用代码编码规则 GB 32100-2015 法人和其他组织统一社会信用代码编码规则}
+ * @see {@link https://std.samr.gov.cn/gb/search/gbDetailed?id=71F772D808D6D3A7E05397BE0A0AB82A 法人和其他组织统一社会信用代码编码规则}
+ * @param {*} value 要检测的值
+ * @param {Object} [options] 配置项
+ * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，如果为false，不校验校验位。
+ * @returns {boolean} 值是否为统一社会信用代码
+ * @example
+ *
+ * isUnifiedIdentifier('91350100M000100Y43'); // true
+ * isUnifiedIdentifier('91350100M000100Y4A'); // false
+ *
+ * // 不校验校验位，长度和类型还是有校验的
+ * isUnifiedIdentifier('91350100M000100Y4A', { checkCode: false }); // true
+ * isUnifiedIdentifier('91350100M000100YIO', { checkCode: false }); // false
+ * isUnifiedIdentifier('91350100M000100Y', { checkCode: false }); // false
+ *
+ */
+declare function isUnifiedIdentifier(value: any, options?: Options): boolean;
+declare namespace isUnifiedIdentifier {
+    var sumCheckCode: (preCode: string) => string;
+}
+export default isUnifiedIdentifier;