util-helpers 4.13.1 → 4.14.1

package/lib/utils/type/isSymbol.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _isType = _interopRequireDefault(require("./isType"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 /**
  * 检查值是否为Symbol
  *
@@ -28,6 +25,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 function isSymbol(value) {
   return (0, _isType["default"])(value, 'Symbol');
 }
-
 var _default = isSymbol;
 exports["default"] = _default;

package/lib/utils/type/isType.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var toString = Object.prototype.toString;
+
 /**
  * 检测值的 `toString` 类型
  *
@@ -14,10 +15,8 @@ var toString = Object.prototype.toString;
  * @param {string} typename 类型名称
  * @returns {boolean} 返回值的 `toString` 类型是否匹配
  */
-
 function isType(value, typename) {
   return toString.call(value) === "[object ".concat(typename, "]");
 }
-
 var _default = isType;
 exports["default"] = _default;

package/lib/utils/type/isUndefined.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 /**
  * 检查值是否为Undefined
  *
@@ -27,6 +26,5 @@ exports["default"] = void 0;
 function isUndefined(value) {
   return value === void 0;
 }
-
 var _default = isUndefined;
 exports["default"] = _default;

package/lib/utils/type/isWeakMap.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _isType = _interopRequireDefault(require("./isType"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 /**
  * 检查值是否为WeakMap
  *
@@ -28,6 +25,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 function isWeakMap(value) {
   return (0, _isType["default"])(value, 'WeakMap');
 }
-
 var _default = isWeakMap;
 exports["default"] = _default;

package/lib/utils/type/isWeakSet.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _isType = _interopRequireDefault(require("./isType"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 /**
  * 检查值是否为WeakSet
  *
@@ -28,6 +25,5 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 function isWeakSet(value) {
   return (0, _isType["default"])(value, 'WeakSet');
 }
-
 var _default = isWeakSet;
 exports["default"] = _default;

package/lib/validatePassword.js

@@ -4,15 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _devWarn = _interopRequireDefault(require("./utils/devWarn"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var regNumber = /[\d]/;
 var regLowerCaseLetter = /[a-z]/;
 var regUpperCaseLetter = /[A-Z]/;
 var regAllNumberAndLetter = /[\d|a-z]/gi;
+
 /**
  * 是否包含数字
  *
@@ -20,10 +18,10 @@ var regAllNumberAndLetter = /[\d|a-z]/gi;
  * @param {string} val 检查的值
  * @returns {boolean} 是否包含数字
  */
-
 function hasNumber(val) {
   return regNumber.test(val);
 }
+
 /**
  * 是否包含小写字母
  *
@@ -31,11 +29,10 @@ function hasNumber(val) {
  * @param {string} val 检测的值
  * @returns {boolean} 是否包含小写字母
  */
-
-
 function hasLowerCaseLetter(val) {
   return regLowerCaseLetter.test(val);
 }
+
 /**
  * 是否包含大写字母
  *
@@ -43,11 +40,10 @@ function hasLowerCaseLetter(val) {
  * @param {string} val 检测的值
  * @returns {boolean} 是否包含大写字母
  */
-
-
 function hasUpperCaseLetter(val) {
   return regUpperCaseLetter.test(val);
 }
+
 /**
  * 是否为十六进制
  *
@@ -55,11 +51,10 @@ function hasUpperCaseLetter(val) {
  * @param {string} val 检测的值
  * @returns {boolean} 是否为十六进制
  */
-
-
 function hasHex(val) {
   return val.indexOf('\\x') > -1 || val.indexOf("\\u") > -1;
 }
+
 /**
  * 是否包含特殊字符
  *
@@ -68,35 +63,28 @@ function hasHex(val) {
  * @param {string} chars 特殊字符
  * @returns {boolean} 是否包含特殊字符
  */
-
-
 function hasSpecialCharacter(val, chars) {
   if (!chars || !val) {
     return false;
   }
-
   var specialChars = val.replace(regAllNumberAndLetter, '');
-
   if (!specialChars) {
     return false;
   }
-
   var regChars = hasHex(chars) ? new RegExp("[".concat(chars, "]")) : null;
-
   if (regChars) {
     return regChars.test(specialChars);
   }
-
   var ret = false;
   specialChars.split('').some(function (charItem) {
     if (chars.indexOf(charItem) > -1) {
       ret = true;
     }
-
     return ret;
   });
   return ret;
 }
+
 /**
  * 是否包含非法字符
  *
@@ -105,37 +93,30 @@ function hasSpecialCharacter(val, chars) {
  * @param {string} chars 特殊字符
  * @returns {boolean} 是否包含非法字符
  */
-
-
 function hasUnallowableCharacter(val, chars) {
   if (!val) {
     return false;
   }
-
   var specialChars = val.replace(regAllNumberAndLetter, '');
-
   if (!specialChars) {
     return false;
   } else if (!chars) {
     return true;
   }
-
   var regChars = hasHex(chars) ? new RegExp("[^".concat(chars, "]")) : null;
-
   if (regChars) {
     return regChars.test(specialChars);
   }
-
   var ret = false;
   specialChars.split('').some(function (charItem) {
     if (chars.indexOf(charItem) === -1) {
       ret = true;
     }
-
     return ret;
   });
   return ret;
 }
+
 /**
  * @typedef {Object} PasswordContaines - 验证密码的包含内容
  * @property {boolean} number - 包含数字
@@ -224,40 +205,36 @@ function hasUnallowableCharacter(val, chars) {
  *   }
  * }
  */
-
-
 function validatePassword(value) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var _options$level = options.level,
-      level = _options$level === void 0 ? 2 : _options$level,
-      _options$ignoreCase = options.ignoreCase,
-      ignoreCase = _options$ignoreCase === void 0 ? false : _options$ignoreCase,
-      _options$special = options.special,
-      special = _options$special === void 0 ? '\\x21-\\x2F\\x3A-\\x40\\x5B-\\x60\\x7B-\\x7E' : _options$special;
+    level = _options$level === void 0 ? 2 : _options$level,
+    _options$ignoreCase = options.ignoreCase,
+    ignoreCase = _options$ignoreCase === void 0 ? false : _options$ignoreCase,
+    _options$special = options.special,
+    special = _options$special === void 0 ? '\\x21-\\x2F\\x3A-\\x40\\x5B-\\x60\\x7B-\\x7E' : _options$special;
   var valStr = value;
-
   if (typeof value !== 'string') {
     (0, _devWarn["default"])("[validatePassword] value must be a string.");
     valStr = '';
   }
-
-  var currentLevel = 0; // 包含数字
-
-  var containesNumber = hasNumber(valStr); // 包含小写字母
-
-  var containesLowerCaseLetter = hasLowerCaseLetter(valStr); // 包含大写字母
-
-  var containesUpperCaseLetter = hasUpperCaseLetter(valStr); // 包含特殊字符
-
-  var containesSpecialCharacter = hasSpecialCharacter(valStr, special); // 包含非法字符，即含有非数字字母特殊字符以外的其他字符
-
+  var currentLevel = 0;
+
+  // 包含数字
+  var containesNumber = hasNumber(valStr);
+  // 包含小写字母
+  var containesLowerCaseLetter = hasLowerCaseLetter(valStr);
+  // 包含大写字母
+  var containesUpperCaseLetter = hasUpperCaseLetter(valStr);
+  // 包含特殊字符
+  var containesSpecialCharacter = hasSpecialCharacter(valStr, special);
+  // 包含非法字符，即含有非数字字母特殊字符以外的其他字符
   var containesUnallowableCharacter = hasUnallowableCharacter(valStr, special);
-
   if (containesNumber) {
     currentLevel += 1;
-  } // 不区分大小写
-
+  }
 
+  // 不区分大小写
   if (ignoreCase) {
     if (containesLowerCaseLetter || containesUpperCaseLetter) {
       currentLevel += 1;
@@ -267,17 +244,15 @@ function validatePassword(value) {
     if (containesLowerCaseLetter) {
       currentLevel += 1;
     }
-
     if (containesUpperCaseLetter) {
       currentLevel += 1;
     }
   }
-
   if (containesSpecialCharacter) {
     currentLevel += 1;
-  } // 验证结果
-
+  }
 
+  // 验证结果
   var validated = currentLevel >= level && !containesUnallowableCharacter;
   return {
     validated: validated,
@@ -291,6 +266,5 @@ function validatePassword(value) {
     }
   };
 }
-
 var _default = validatePassword;
 exports["default"] = _default;

package/lib/waitTime.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 /**
  * 等待时间返回 Promise 。常用于异步方法中延时。
  *
@@ -31,6 +30,5 @@ function waitTime() {
     setTimeout(resolve, time);
   });
 }
-
 var _default = waitTime;
 exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.13.1",
+  "version": "4.14.1",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -61,22 +61,23 @@
     "@babel/plugin-transform-modules-commonjs": "^7.14.0",
     "@babel/plugin-transform-runtime": "^7.13.15",
     "@babel/preset-env": "^7.9.0",
+    "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^19.0.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
     "@rollup/plugin-replace": "^5.0.1",
-    "@types/jest": "^26.0.23",
-    "babel-jest": "^27.0.2",
-    "babel-plugin-inline-json": "^2.1.0",
+    "@types/jest": "^29.2.4",
+    "babel-jest": "^29.3.1",
     "babel-plugin-minify-replace": "^0.5.0",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "docdash": "^1.2.0",
     "eslint": "^7.32.0",
     "husky": "^4.3.6",
-    "jest": "^27.0.4",
+    "jest": "^29.3.1",
+    "jest-environment-jsdom": "^29.3.1",
     "jsdoc": "^3.6.3",
     "lint-staged": "^11.1.2",
     "prettier": "^2.3.2",

package/types/bytesToSize.d.ts

@@ -6,6 +6,8 @@ export default bytesToSize;
  * @alias module:Processor.bytesToSize
  * @since 3.8.0
  * @param {number} bytes 字节大小
+ * @param {Object} [options] 配置项
+ * @param {string} [options.spaceMark=' '] 间隔字符
  * @returns {string} 存储单位值
  * @example
  *
@@ -14,5 +16,11 @@ export default bytesToSize;
  * bytesToSize(3.213243*1024*1024); // 3.21 MB
  * bytesToSize(1024*1024*1024); // 1 GB
  *
+ * // 自定义间隔符号
+ * bytesToSize(0, { spaceMark: '' }); // 0B
+ * bytesToSize(1024, { spaceMark: '' }); // 1KB
+ *
  */
-declare function bytesToSize(bytes: number): string;
+declare function bytesToSize(bytes: number, options?: {
+    spaceMark?: string | undefined;
+} | undefined): string;

package/types/findTreeNode.d.ts

@@ -0,0 +1,26 @@
+export default findTreeNode;
+/**
+ * 查找树结构数据节点
+ *
+ * @static
+ * @alias module:Other.findTreeNode
+ * @since 4.14.0
+ * @template {any} T
+ * @template {(item: T) => boolean} F
+ * @param {T[]} tree 树结构数据
+ * @param {F} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy 将返回该节点
+ * @param {string} [childrenField='children'] 子级字段名
+ * @returns {T|undefined}
+ * @example
+ * const menus = [{ "id": "1", "name": "首页", "code": "trade", "pid": null }, { "id": "2", "name": "交易管理", "code": "trade", "pid": null, "children": [{ "id": "3", "name": "交易查询", "code": "trade-1", "pid": "2", "children": [{ "id": "4", "name": "交易查询-查询操作", "code": "trade-1-1", "pid": "3" }] }] }, { "id": "5", "name": "权限管理", "code": "authorization", "pid": null, "children": [{ "id": "6", "name": "角色管理", "code": "authorization-1", "pid": "5" }, { "id": "7", "name": "用户管理", "code": "authorization-2", "pid": "5" }] }];
+ *
+ * findTreeNode(menus, item=>item.id === '2');
+ * // {"id":"2","name":"交易管理","code":"trade","pid":null,"children":[{"id":"3","name":"交易查询","code":"trade-1","pid":"2","children":[{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"}]}]}
+ *
+ * findTreeNode(menus, item=>item.id === '7');
+ * // {"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}
+ *
+ * findTreeNode(menus, item=>item.id === 'not found');
+ * // undefined
+ */
+declare function findTreeNode<T extends unknown, F extends (item: T) => boolean>(tree: T[], predicate: F, childrenField?: string | undefined): T | undefined;

package/types/findTreeSelect.d.ts

@@ -0,0 +1,26 @@
+export default findTreeSelect;
+/**
+ * 查找包含当前节点的所有父级节点
+ *
+ * @static
+ * @alias module:Other.findTreeSelect
+ * @since 4.14.0
+ * @template {any} T
+ * @template {(item: T) => boolean} F
+ * @param {T[]} tree 树结构数据
+ * @param {F} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy 将返回包含该节点的所有父级节点
+ * @param {string} [childrenField='children'] 子级字段名
+ * @returns {T[]}
+ * @example
+ * const menus = [{ "id": "1", "name": "首页", "code": "trade", "pid": null }, { "id": "2", "name": "交易管理", "code": "trade", "pid": null, "children": [{ "id": "3", "name": "交易查询", "code": "trade-1", "pid": "2", "children": [{ "id": "4", "name": "交易查询-查询操作", "code": "trade-1-1", "pid": "3" }] }] }, { "id": "5", "name": "权限管理", "code": "authorization", "pid": null, "children": [{ "id": "6", "name": "角色管理", "code": "authorization-1", "pid": "5" }, { "id": "7", "name": "用户管理", "code": "authorization-2", "pid": "5" }] }];
+ *
+ * findTreeSelect(menus, item => item.id === '2');
+ * // [{"id":"2","name":"交易管理","code":"trade","pid":null,"children":[{"id":"3","name":"交易查询","code":"trade-1","pid":"2","children":[{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"}]}]}]
+ *
+ * findTreeSelect(menus, item => item.id === '7');
+ * // [{"id":"5","name":"权限管理","code":"authorization","pid":null,"children":[{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]
+ *
+ * findTreeSelect(menus, item => item.id === 'not found');
+ * // []
+ */
+declare function findTreeSelect<T extends unknown, F extends (item: T) => boolean>(tree: T[], predicate: F, childrenField?: string | undefined): T[];

package/types/formatBankCard.d.ts

@@ -7,7 +7,7 @@ export default formatBankCard;
  * @since 1.1.0
  * @param {string} bankCardNo 要处理的字符串
  * @param {Object} [options] 配置项
- * @param {string} [options.char=" "] 间隔字符
+ * @param {string} [options.spaceMark=' '] 间隔字符
  * @param {number} [options.length=4] 间隔长度
  * @returns {string} 格式化的银行卡号
  * @example
@@ -22,10 +22,10 @@ export default formatBankCard;
  * formatBankCard('6228********890'); // 6228 **** **** 890
  *
  * // 16位银行卡，"-"间隔
- * formatBankCard('6228480402564890', {char: '-'}); // 6228-4804-0256-4890
+ * formatBankCard('6228480402564890', {spaceMark: '-'}); // 6228-4804-0256-4890
  *
  */
 declare function formatBankCard(bankCardNo?: string, options?: {
-    char?: string | undefined;
+    spaceMark?: string | undefined;
     length?: number | undefined;
 } | undefined): string;

package/types/formatMobile.d.ts

@@ -7,16 +7,16 @@ export default formatMobile;
  * @since 4.5.0
  * @param {string} mobileNo 手机号码
  * @param {object} [options] 配置项
- * @param {string} [options.char=' '] 间隔字符
+ * @param {string} [options.spaceMark=' '] 间隔字符
  * @returns {string} 格式化后的手机号码
  * @example
  *
  * formatMobile('13345678900'); // 133 4567 8900
- * formatMobile('13345678900', { char: '-' }); // 133-4567-8900
+ * formatMobile('13345678900', { spaceMark: '-' }); // 133-4567-8900
  *
  * // 脱敏手机号码
  * formatMobile('133****1234'); // 133 **** 1234
- * formatMobile('133****1234', { char: '-' }); // 133-****-1234
+ * formatMobile('133****1234', { spaceMark: '-' }); // 133-****-1234
  *
  * // 手机号码位数不够
  * formatMobile('133'); // 133
@@ -25,5 +25,5 @@ export default formatMobile;
  *
  */
 declare function formatMobile(mobileNo: string, options?: {
-    char?: string | undefined;
+    spaceMark?: string | undefined;
 } | undefined): string;

package/types/index.d.ts

@@ -33,6 +33,11 @@ export { default as normalizeString } from "./normalizeString";
 export { default as safeDate } from "./safeDate";
 export { default as formatMobile } from "./formatMobile";
 export { default as padZero } from "./padZero";
+export { default as transformFieldNames } from "./transformFieldNames";
+export { default as listToTree } from "./listToTree";
+export { default as treeToList } from "./treeToList";
+export { default as findTreeNode } from "./findTreeNode";
+export { default as findTreeSelect } from "./findTreeSelect";
 export { default as plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";

package/types/isIdCard.d.ts

@@ -5,6 +5,8 @@ export default isIdCard;
  * @static
  * @alias module:Validator.isIdCard
  * @since 1.1.0
+ * @see 参考 {@link https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码|中华人民共和国公民身份号码}
+ * @see 参考 {@link https://baike.baidu.com/item/居民身份证号码|居民身份证号码}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.loose=false] 宽松模式，支持15位身份证号码

package/types/isUrl.d.ts

@@ -26,6 +26,8 @@ export default isUrl;
  * isUrl('a.b:8080'); // true
  * isUrl('p://a.b'); // true
  * isUrl('p://a.b:8888'); // true
+ * isUrl('中文域名.中文后缀'); // true
+ * isUrl('中文域名.cn'); // true
  *
  */
 declare function isUrl(value: any): boolean;

package/types/listToTree.d.ts

@@ -0,0 +1,43 @@
+export default listToTree;
+/**
+ * 列表数据转树结构
+ *
+ * @static
+ * @alias module:Processor.listToTree
+ * @since 4.14.0
+ * @template {Record<string,any>} [T=Record<string,any>]
+ * @template {*} [R=T&Record<string,any>]
+ * @param {T[]} list 列表数据
+ * @param {object} options 配置项
+ * @param {string} [options.keyField='id'] 当前数据的键值字段名称
+ * @param {string} [options.parentField='pid'] 当前数据的父级字段名称
+ * @param {string} [options.childrenField='children'] 子级字段名称
+ * @param {'none'|'null'|'array'} [options.emptyChildrenValue='none'] 子级为空时的值，none表示删除该子级，null表示为null，array表示为[]。
+ * @param {'spread'|'self'} [options.nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
+ * @returns {R[]} 树结构
+ * @example
+ *
+ * const menus = [
+ *   { id: '1', name: '首页', code: 'trade', pid: null },
+ *   { id: '2', name: '交易管理', code: 'trade', pid: null },
+ *   { id: '3', name: '交易查询', code: 'trade-1', pid: '2' },
+ *   { id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' },
+ *   { id: '5', name: '权限管理', code: 'authorization', pid: null },
+ *   { id: '6', name: '角色管理', code: 'authorization-1', pid: '5' },
+ *   { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }
+ * ];
+ * listToTree(menus);
+ * // [{"id":"1","name":"首页","code":"trade","pid":null},{"id":"2","name":"交易管理","code":"trade","pid":null,"children":[{"id":"3","name":"交易查询","code":"trade-1","pid":"2","children":[{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"}]}]},{"id":"5","name":"权限管理","code":"authorization","pid":null,"children":[{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]}]
+ *
+ * // 自定义子级字段名
+ * listToTree(basicMenus, { childrenField: 'childs' });
+ * // [{"id":"1","name":"首页","code":"trade","pid":null},{"id":"2","name":"交易管理","code":"trade","pid":null,"childs":[{"id":"3","name":"交易查询","code":"trade-1","pid":"2","childs":[{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"}]}]},{"id":"5","name":"权限管理","code":"authorization","pid":null,"childs":[{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]}]
+ *
+ */
+declare function listToTree<T extends Record<string, any> = Record<string, any>, R extends unknown = T & Record<string, any>>(list: T[], options?: {
+    keyField?: string | undefined;
+    parentField?: string | undefined;
+    childrenField?: string | undefined;
+    emptyChildrenValue?: "none" | "null" | "array" | undefined;
+    nodeAssign?: "spread" | "self" | undefined;
+}): R[];

package/types/transformFieldNames.d.ts

@@ -0,0 +1,35 @@
+export default transformFieldNames;
+/**
+ * 转换字段名，返回一个转换字段后的值，不改变原值。
+ *
+ * @static
+ * @alias module:Processor.transformFieldNames
+ * @since 4.14.0
+ * @template {*} D
+ * @template {Record<string, keyof D>} F
+ * @template {string} C
+ * @param {D[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenFieldName
+ * @param {F} fieldNames 字段名映射
+ * @param {C} [childrenFieldName] 子级数据字段名
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
+ * @returns {import('./transformFieldNames.type.js').TransformFieldNames<D, F, C>}
+ * @example
+ *
+ * const options = [{code: '1', name: 'one'},{code:'2', name:'two'}];
+ * const newOptions = transformFieldNames(options, {label: 'name', value: 'code'});
+ * // [{value: '1', label: 'one'},{value:'2', label:'two'}]
+ *
+ * // 嵌套数据，指定子级字段名 children
+ * const options2 = [{code: '1', name: 'one'},{code:'2', name:'two', children: [{code:'2-1', name:'two-one', children: [{code: '2-1-1', name:'two-one-one'}]}]}];
+ * const newOptions2 = transformFieldNames(options2, {label: 'name', value: 'code'}, 'children');
+ * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one', children: [{value: '2-1-1', label:'two-one-one'}]}]}]
+ *
+ * const options3 = [{code: '1', name: 'one'},{code:'2', name:'two', childs: [{code:'2-1', name:'two-one'}]}];
+ * const newOptions3 = transformFieldNames(options3, {label: 'name', value: 'code'}, 'childs');
+ * // [{value: '1', label: 'one'},{value:'2', label:'two', childs: [{value: '2-1', label:'two-one'}]}]
+ *
+ * // 嵌套数据，并替换子集字段名
+ * const newOptions4 = transformFieldNames(options3, {label: 'name', value: 'code', children: 'childs'}, 'childs');
+ * // [{value: '1', label: 'one'},{value:'2', label:'two', children: [{value: '2-1', label:'two-one'}]}]
+ */
+declare function transformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string>(data: D[], fieldNames: F, childrenFieldName?: C | undefined, nodeAssign?: "spread" | "self" | undefined): import("./transformFieldNames.type.js").TransformFieldNames<D, F, C>;

package/types/transformFieldNames.type.d.ts

@@ -0,0 +1,2 @@
+export type ExchangeFieldNames<D extends unknown, F extends Record<string, keyof D>> = Omit<D, F[keyof F]> & { [P in keyof F]: D[F[P]]; };
+export type TransformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string> = (C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[];

package/types/treeToList.d.ts

@@ -0,0 +1,20 @@
+export default treeToList;
+/**
+ * 树结构转列表数据
+ *
+ * @static
+ * @alias module:Processor.treeToList
+ * @since 4.14.0
+ * @template {Record<string,any>} T
+ * @template {keyof T} K
+ * @template {Omit<T, K>} R
+ * @param {T[]} tree 列表数据
+ * @param {K} childrenField 子级字段名称
+ * @returns {R[]} 列表数据
+ * @example
+ * const menus = [{ "id": "1", "name": "首页", "code": "trade", "pid": null }, { "id": "2", "name": "交易管理", "code": "trade", "pid": null, "children": [{ "id": "3", "name": "交易查询", "code": "trade-1", "pid": "2", "children": [{ "id": "4", "name": "交易查询-查询操作", "code": "trade-1-1", "pid": "3" }] }] }, { "id": "5", "name": "权限管理", "code": "authorization", "pid": null, "children": [{ "id": "6", "name": "角色管理", "code": "authorization-1", "pid": "5" }, { "id": "7", "name": "用户管理", "code": "authorization-2", "pid": "5" }] }];
+ *
+ * treeToList(menus, 'children'));
+ * // [{"id":"1","name":"首页","code":"trade","pid":null},{"id":"2","name":"交易管理","code":"trade","pid":null},{"id":"3","name":"交易查询","code":"trade-1","pid":"2"},{"id":"4","name":"交易查询-查询操作","code":"trade-1-1","pid":"3"},{"id":"5","name":"权限管理","code":"authorization","pid":null},{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]
+ */
+declare function treeToList<T extends Record<string, any>, K extends keyof T, R extends Omit<T, K>>(tree: T[], childrenField: K): R[];