feat: add forEachMap utils func

Author: chandq

docs/gen-api-docs.md

@@ -20,15 +20,15 @@ npm install -g @microsoft/api-extractor @microsoft/api-documenter
 
 1. Init api-extractor
 
-   enter root directory of project
+   enter into root directory of project
 
 ```bash
 api-extractor init
 ```
 
 after exec completely, will generate `api-extractor.json` file
 
-2. generate API JSON file for api markdown
+2. Generate API JSON file for api markdown
 
 ```bash
 api-extractor run --local --verbose

package.json

@@ -37,8 +37,9 @@
     "lib"
   ],
   "keywords": [
-    "typescript",
-    "js-utils"
+    "sculp-js",
+    "js-utils",
+    "typescript"
   ],
   "engines": {
     "node": ">=16"

src/tree.ts

@@ -6,7 +6,7 @@ export interface IFieldOptions {
 const defaultFieldOptions = { keyField: 'key', childField: 'children', pidField: 'pid' };
 
 /**
- * 自定义深度优先遍历函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+ * 深度优先遍历函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
  * @param {ArrayLike<V>} tree  树形数据
  * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
  * @param {string} children 定制子元素的key
@@ -25,7 +25,7 @@ export function forEachDeep<V>(
   ) => boolean | void,
   children: string = 'children',
   isReverse = false
-) {
+): void {
   let level = 0,
     isBreak = false;
   const walk = (arr: ArrayLike<V>, parent: V | null) => {
@@ -71,6 +71,85 @@ export function forEachDeep<V>(
   };
   walk(tree, null);
 }
+
+/**
+ * 深度优先遍历的Map函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+ * @param {ArrayLike<V>} tree  树形数据
+ * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
+ * @param {string} children 定制子元素的key
+ * @param {boolean} isReverse  是否反向遍历
+ * @returns {any[]} 新的一棵树
+ */
+export function forEachMap<V>(
+  tree: ArrayLike<V>,
+  iterator: (
+    val: V,
+    i: number,
+    currentArr: ArrayLike<V>,
+    tree: ArrayLike<V>,
+    parent: V | null,
+    level: number
+  ) => boolean | any,
+  children: string = 'children',
+  isReverse = false
+): any[] {
+  let level = 0,
+    isBreak = false;
+  const newTree = [];
+  const walk = (arr: ArrayLike<V>, parent: V | null, newTree: any[]) => {
+    if (isReverse) {
+      for (let i = arr.length - 1; i >= 0; i--) {
+        if (isBreak) {
+          break;
+        }
+        const re = iterator(arr[i], i, arr, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
+        }
+        newTree.push(re);
+        // @ts-ignore
+        if (arr[i] && Array.isArray(arr[i][children])) {
+          ++level;
+          newTree[newTree.length - 1][children] = [];
+          // @ts-ignore
+          walk(arr[i][children], arr[i], newTree[newTree.length - 1][children]);
+        } else {
+          // children非有效数组时，移除该属性字段
+          delete re[children];
+        }
+      }
+    } else {
+      for (let i = 0; i < arr.length; i++) {
+        if (isBreak) {
+          break;
+        }
+        const re = iterator(arr[i], i, arr, tree, parent, level);
+        if (re === false) {
+          isBreak = true;
+          break;
+        } else if (re === true) {
+          continue;
+        }
+        newTree.push(re);
+        // @ts-ignore
+        if (arr[i] && Array.isArray(arr[i][children])) {
+          ++level;
+          newTree[newTree.length - 1][children] = [];
+          // @ts-ignore
+          walk(arr[i][children], arr[i], newTree[newTree.length - 1][children]);
+        } else {
+          // children非有效数组时，移除该属性字段
+          delete re[children];
+        }
+      }
+    }
+  };
+  walk(tree, null, newTree);
+  return newTree;
+}
 export type IdLike = number | string;
 export interface ITreeConf {
   id: string | number;

test/tree.test.ts

@@ -1,5 +1,5 @@
 import { cloneDeep } from '../src/object';
-import { formatTree, searchTreeById, forEachDeep, buildTree } from '../src/tree';
+import { formatTree, searchTreeById, forEachDeep, buildTree, forEachMap } from '../src/tree';
 
 test('searchTreeById', () => {
   const tree = [
@@ -217,3 +217,107 @@ test('forEachDeep: insert tree item', () => {
     { id: 3, name: 'row3' }
   ]);
 });
+
+test('forEachMap', () => {
+  const tree = [
+    { id: 1, name: 'row1', age: 1 },
+    {
+      id: 2,
+      name: 'row2',
+      age: 2,
+      children: [{ id: 21, name: 'row2-1', age: 21 }]
+    },
+    { id: 3, name: 'row3' }
+  ];
+
+  let res1: any[] = [];
+  let res2: any[] = [];
+  let res3: any[] = [];
+  let res4: any[] = [];
+  let res5: any[] = [];
+
+  res1 = forEachMap(tree, ({ id, name, children }) => {
+    return { key: id, label: name, children };
+  });
+  expect(res1).toEqual([
+    { key: 1, label: 'row1' },
+    {
+      key: 2,
+      label: 'row2',
+      children: [{ key: 21, label: 'row2-1' }]
+    },
+    { key: 3, label: 'row3' }
+  ]);
+
+  // reverse traversal
+  res2 = forEachMap(
+    tree,
+    ({ id, name, children }) => {
+      return { key: id, label: name, children };
+    },
+    'children',
+    true
+  );
+
+  expect(res2).toEqual([
+    { key: 3, label: 'row3' },
+    {
+      key: 2,
+      label: 'row2',
+      children: [{ key: 21, label: 'row2-1' }]
+    },
+    { key: 1, label: 'row1' }
+  ]);
+  // test continue
+  res3 = forEachMap(tree, ({ id, name, children }) => {
+    if (id === 21) {
+      return true;
+    }
+    return { key: id, label: name, children, job: `job-${id}` };
+  });
+  expect(res3).toEqual([
+    { key: 1, label: 'row1', job: 'job-1' },
+    {
+      key: 2,
+      label: 'row2',
+      job: 'job-2',
+      children: []
+    },
+    { key: 3, label: 'row3', job: 'job-3' }
+  ]);
+
+  // test break
+  res4 = forEachMap(tree, ({ id, name, children }) => {
+    if (id === 21) {
+      return false;
+    }
+    return { key: id, label: name, children };
+  });
+  expect(res4).toEqual([
+    { key: 1, label: 'row1' },
+    {
+      key: 2,
+      label: 'row2',
+      children: []
+    }
+  ]);
+  // test insert tree item
+  res5 = forEachMap(tree, ({ id, name, children }, i, currentArr: any) => {
+    if (id === 21) {
+      currentArr.push({ id: 22, name: 'row2-2' });
+    }
+    return { key: id, label: name, children };
+  });
+  expect(res5).toEqual([
+    { key: 1, label: 'row1' },
+    {
+      key: 2,
+      label: 'row2',
+      children: [
+        { key: 21, label: 'row2-1' },
+        { key: 22, label: 'row2-2' }
+      ]
+    },
+    { key: 3, label: 'row3' }
+  ]);
+});