util-helpers 4.14.0 → 4.15.0

package/lib/listToTree.js

@@ -57,6 +57,7 @@ function processEmptyChildren(arr) {
  * @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
  * 
@@ -86,7 +87,9 @@ function listToTree(list) {
     _options$childrenFiel2 = options.childrenField,
     childrenField = _options$childrenFiel2 === void 0 ? 'children' : _options$childrenFiel2,
     _options$emptyChildre2 = options.emptyChildrenValue,
-    emptyChildrenValue = _options$emptyChildre2 === void 0 ? 'none' : _options$emptyChildre2;
+    emptyChildrenValue = _options$emptyChildre2 === void 0 ? 'none' : _options$emptyChildre2,
+    _options$nodeAssign = options.nodeAssign,
+    nodeAssign = _options$nodeAssign === void 0 ? 'spread' : _options$nodeAssign;
 
   /** @type {R[]} */
   var tree = [];
@@ -95,7 +98,7 @@ function listToTree(list) {
   var record = {};
   list.forEach(function (item) {
     if ((0, _type.isObject)(item)) {
-      var newItem = _objectSpread({}, item);
+      var newItem = nodeAssign === 'spread' ? _objectSpread({}, item) : item;
 
       /** @type {string} */
       var id = newItem[keyField];

package/lib/transformFieldNames.doc.js

@@ -13,9 +13,10 @@ exports["default"] = void 0;
  * @static
  * @alias module:Processor.transformFieldNames
  * @since 4.14.0
- * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenFieldName
+ * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
  * @param {object} fieldNames 字段名映射
- * @param {string} [childrenFieldName] 子级数据字段名
+ * @param {string} [childrenField] 子级数据字段名
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
  * @returns {object[]}
  * @example
  * 
@@ -36,6 +37,6 @@ exports["default"] = void 0;
  * 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'}]}]
  */
-function transformFieldNames(data, fieldNames, childrenFieldName) {}
+function transformFieldNames(data, fieldNames, childrenField) {}
 var _default = transformFieldNames;
 exports["default"] = _default;

package/lib/transformFieldNames.js

@@ -20,9 +20,10 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
  * @template {*} D
  * @template {Record<string, keyof D>} F
  * @template {string} C
- * @param {D[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenFieldName
+ * @param {D[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
  * @param {F} fieldNames 字段名映射
- * @param {C} [childrenFieldName] 子级数据字段名
+ * @param {C} [childrenField] 子级数据字段名
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
  * @returns {import('./transformFieldNames.type.js').TransformFieldNames<D, F, C>}
  * @example
  * 
@@ -43,7 +44,8 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
  * 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'}]}]
  */
-function transformFieldNames(data, fieldNames, childrenFieldName) {
+function transformFieldNames(data, fieldNames, childrenField) {
+  var nodeAssign = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'spread';
   if (!Array.isArray(data)) {
     return data;
   }
@@ -64,15 +66,15 @@ function transformFieldNames(data, fieldNames, childrenFieldName) {
       if (!(0, _type.isObject)(item)) {
         return item;
       }
-      var newItem = _objectSpread({}, item);
+      var newItem = nodeAssign === 'spread' ? _objectSpread({}, item) : item;
       /** @type {Array.<string>} */
       var delKeys = [];
 
       // 树形数据子节点
       // @ts-ignore
-      if (childrenFieldName && Array.isArray(newItem[childrenFieldName]) && newItem[childrenFieldName].length > 0) {
+      if (childrenField && Array.isArray(newItem[childrenField]) && newItem[childrenField].length > 0) {
         // @ts-ignore
-        newItem[childrenFieldName] = recusion(newItem[childrenFieldName].slice());
+        newItem[childrenField] = recusion(newItem[childrenField].slice());
       }
 
       // 替换字段名

package/lib/utils/config.js

@@ -24,5 +24,5 @@ function setDisableWarning(bool) {
 }
 
 // eslint-disable-next-line no-undef
-var version = "4.14.0";
+var version = "4.15.0";
 exports.version = version;

package/package.json

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

package/types/calculateCursorPosition.d.ts

@@ -5,8 +5,6 @@ export default calculateCursorPosition;
  * @static
  * @alias module:Other.calculateCursorPosition
  * @since 4.6.0
- * @see 格式化手机号码 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMobile|formatMobile}
- * @see 格式化银行卡号 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatBankCard|formatBankCard}
  * @see h5示例 {@link https://2950v9.csb.app/|点击查看}
  * @see react示例 {@link https://33ccy9.csb.app/|点击查看}
  * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd

package/types/filterTree.d.ts

@@ -0,0 +1,28 @@
+export default filterTree;
+/**
+ * 过滤/筛选树节点。<br/><br/>如果某节点被过滤掉，它的子节点也一并抛弃
+ *
+ * @static
+ * @alias module:Processor.filterTree
+ * @since 4.15.0
+ * @template {any} T
+ * @template {(item: T) => boolean} F
+ * @param {T[]} tree 树结构数据
+ * @param {F} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy ，结果将包含该节点
+ * @param {string} [childrenField='children'] 子级字段名
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
+ * @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" }] }];
+ *
+ * filterTree(menus, item=>item.name.indexOf('管理') > -1);
+ * // [{"id":"2","name":"交易管理","code":"trade","pid":null,"children":[]},{"id":"5","name":"权限管理","code":"authorization","pid":null,"children":[{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]}]
+ *
+ * // 如果某节点被过滤掉，它的子节点也一并抛弃
+ * filterTree(menus, item=>item.id === '7');
+ * // []
+ *
+ * filterTree(menus, item=>item.id === 'not found');
+ * // []
+ */
+declare function filterTree<T extends unknown, F extends (item: T) => boolean>(tree: T[], predicate: F, childrenField?: string | undefined, nodeAssign?: "spread" | "self" | undefined): T[];

package/types/findTreeNode.d.ts

@@ -8,7 +8,7 @@ export default findTreeNode;
  * @template {any} T
  * @template {(item: T) => boolean} F
  * @param {T[]} tree 树结构数据
- * @param {F} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy 将返回该节点
+ * @param {F} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 Truthy ，将返回该节点
  * @param {string} [childrenField='children'] 子级字段名
  * @returns {T|undefined}
  * @example

package/types/findTreeNodes.d.ts

@@ -0,0 +1,29 @@
+export default findTreeNodes;
+/**
+ * 查找树结构数据多个节点
+ *
+ * @static
+ * @alias module:Other.findTreeNodes
+ * @since 4.15.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" }] }];
+ *
+ * findTreeNodes(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"}]}]}]
+ *
+ * findTreeNodes(menus, item=>item.name.indexOf('管理') > -1);
+ * // [{"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"}]},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"},{"id":"6","name":"角色管理","code":"authorization-1","pid":"5"}]
+ *
+ * findTreeNodes(menus, item=>item.id === '1' || item.id === '7');
+ * // [{"id":"1","name":"首页","code":"trade","pid":null},{"id":"7","name":"用户管理","code":"authorization-2","pid":"5"}]
+ *
+ * findTreeNodes(menus, item=>item.id === 'not found');
+ * // []
+ */
+declare function findTreeNodes<T extends unknown, F extends (item: T) => boolean>(tree: T[], predicate: F, childrenField?: string | undefined): T[];

package/types/index.d.ts

@@ -36,8 +36,7 @@ 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 filterTree } from "./filterTree";
 export { default as plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";
@@ -47,4 +46,7 @@ export { default as waitTime } from "./waitTime";
 export { default as calculateCursorPosition } from "./calculateCursorPosition";
 export { default as randomString } from "./randomString";
 export { default as strlen } from "./strlen";
+export { default as findTreeNode } from "./findTreeNode";
+export { default as findTreeNodes } from "./findTreeNodes";
+export { default as findTreeSelect } from "./findTreeSelect";
 export { setDisableWarning, version } from "./utils/config";

package/types/listToTree.d.ts

@@ -13,6 +13,7 @@ export default listToTree;
  * @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
  *
@@ -38,4 +39,5 @@ declare function listToTree<T extends Record<string, any> = Record<string, any>,
     parentField?: string | undefined;
     childrenField?: string | undefined;
     emptyChildrenValue?: "none" | "null" | "array" | undefined;
+    nodeAssign?: "spread" | "self" | undefined;
 }): R[];

package/types/transformFieldNames.d.ts

@@ -8,9 +8,10 @@ export default transformFieldNames;
  * @template {*} D
  * @template {Record<string, keyof D>} F
  * @template {string} C
- * @param {D[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenFieldName
+ * @param {D[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
  * @param {F} fieldNames 字段名映射
- * @param {C} [childrenFieldName] 子级数据字段名
+ * @param {C} [childrenField] 子级数据字段名
+ * @param {'spread'|'self'} [nodeAssign='spread'] 节点赋值方式。spread表示使用展开运算符创建新值，self表示使用自身对象。
  * @returns {import('./transformFieldNames.type.js').TransformFieldNames<D, F, C>}
  * @example
  *
@@ -31,4 +32,4 @@ export default transformFieldNames;
  * 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): import("./transformFieldNames.type.js").TransformFieldNames<D, F, C>;
+declare function transformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string>(data: D[], fieldNames: F, childrenField?: C | undefined, nodeAssign?: "spread" | "self" | undefined): import("./transformFieldNames.type.js").TransformFieldNames<D, F, C>;