tree-processor 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 tree-processor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,249 @@
+# tree-processor
+
+树结构数据处理工具，目前已支持 mapTree、filterTree、findTree、pushTree、unshiftTree、popTree、shiftTree、someTree、everyTree、atTree、indexOfTree、atIndexOfTree、nodeDepthMap 和 dedupTree。每个方法的最后一个参数可以自定义 children 和 id 的属性名。
+
+## 安装教程
+
+```bash
+yarn add tree-processor
+# 或
+npm i tree-processor
+```
+
+## 使用说明
+
+### 引入
+
+#### 默认导入（推荐用于需要多个方法的场景）
+
+```javascript
+// ES Module
+import t from 'tree-processor'
+
+// CommonJS
+const t = require('tree-processor')
+```
+
+#### 按需导入（推荐用于只需要少量方法的场景，支持 tree-shaking）
+
+```javascript
+// ES Module - 按需导入单个方法
+import { mapTree, filterTree, findTree } from 'tree-processor'
+
+// ES Module - 按需导入类型
+import type { TreeNode, TreeData, FieldNames } from 'tree-processor'
+
+// CommonJS - 按需导入
+const { mapTree, filterTree } = require('tree-processor')
+```
+
+**按需导入的优势：**
+- ✅ 支持 tree-shaking，只打包使用的代码，减小打包体积
+- ✅ 更好的代码提示和类型检查
+- ✅ 更清晰的依赖关系
+
+### 示例树结构数据
+
+以下示例数据将用于后续所有方法的演示：
+
+```javascript
+const treeData = [
+  {
+    id: 1,
+    name: 'node1',
+    children: [
+      {
+        id: 2,
+        name: 'node2',
+        children: [
+          { id: 4, name: 'node4' },
+          { id: 5, name: 'node5' },
+        ],
+      },
+      {
+        id: 3,
+        name: 'node3',
+        children: [{ id: 6, name: 'node6' }],
+      },
+    ],
+  },
+];
+```
+
+### mapTree（遍历树结构数据的方法）
+
+遍历树结构数据，对每个节点执行回调函数。
+
+```javascript
+t.mapTree(treeData, (item) => {
+    console.log(item)
+})
+```
+
+### filterTree（树结构数据的filter方法）
+
+过滤树结构数据，返回满足条件的节点。
+
+```javascript
+const values = ['node1', 'node2', 'node3'];
+const result = t.filterTree(treeData, (item) => {
+    return values.includes(item.name)
+})
+
+console.log(result)
+```
+
+### findTree（树结构数据的find方法）
+
+查找树结构数据中满足条件的第一个节点。
+
+```javascript
+const result = t.findTree(treeData, (item) => {
+    return item.hasOwnProperty('children')
+})
+
+console.log(result)
+```
+
+### pushTree（在指定节点下添加子节点到末尾）
+
+targetParentId 为目标节点的 id，newNode 为往该节点添加的数据。
+
+```javascript
+t.pushTree(treeData, targetParentId, newNode);
+
+console.log(treeData)
+```
+
+### unshiftTree（在指定节点下添加子节点到开头）
+
+targetParentId 为目标节点的 id，newNode 为往该节点添加的数据。
+
+```javascript
+t.unshiftTree(treeData, targetParentId, newNode);
+
+console.log(treeData)
+```
+
+### popTree（删除指定节点下的最后一个子节点）
+
+rootId 为目标节点的 id，此方法可删除 rootId 下的最后一个子节点。
+
+```javascript
+t.popTree(treeData, rootId);
+
+console.log(treeData)
+```
+
+### shiftTree（删除指定节点下的第一个子节点）
+
+rootId 为目标节点的 id，此方法可删除 rootId 下的第一个子节点。
+
+```javascript
+t.shiftTree(treeData, rootId);
+
+console.log(treeData)
+```
+
+### someTree（树结构数据的some方法）
+
+检查树结构数据中是否存在满足条件的节点。
+
+```javascript
+const result = t.someTree(treeData, item => item.name === 'jack')
+
+console.log(result)
+```
+
+### everyTree（树结构数据的every方法）
+
+检查树结构数据中是否所有节点都满足条件。
+
+```javascript
+const result = t.everyTree(treeData, item => item.age >= 18)
+
+console.log(result)
+```
+
+### atTree（根据父节点ID和子节点索引获取节点）
+
+parentId 为指定父节点的 id，nodeIndex 为子节点的索引，可传负数，和数组的 at 方法一样。
+
+```javascript
+const result = t.atTree(treeData, parentId, nodeIndex)
+
+console.log(result)
+```
+
+### indexOfTree（返回从根节点到目标节点的索引路径）
+
+返回一个数组，值为从根节点开始到 targetId 所在节点的索引，返回值可以传入 atIndexOfTree 的第二个参数进行取值。
+
+```javascript
+const result = t.indexOfTree(treeData, targetId)
+
+console.log(result)
+```
+
+### atIndexOfTree（根据索引路径获取节点）
+
+传入节点数据的下标数组，返回节点数据。
+
+```javascript
+const result = t.atIndexOfTree(treeData, [0, 1, 0])
+
+console.log(result)
+```
+
+### nodeDepthMap（返回节点ID到深度的映射）
+
+返回一个字典，键代表节点的 id，值代表该节点在数据的第几层。
+
+```javascript
+const result = t.nodeDepthMap(treeData)
+
+console.log(result)
+```
+
+### dedupTree（树结构对象数组去重方法）
+
+树结构对象数组去重方法，第一个参数为需要去重的数据，第二个参数为以哪个键去重。
+
+```javascript
+const result = t.dedupTree(treeData, 'id')
+
+console.log(result)
+```
+
+## 自定义字段名
+
+所有方法都支持自定义 children 和 id 的属性名，通过最后一个参数传入配置对象：
+
+```javascript
+const fieldNames = { children: 'subNodes', id: 'nodeId' };
+const result = t.findTree(treeData, (item) => item.nodeId === 2, fieldNames);
+```
+
+## 开发
+
+```bash
+# 安装依赖
+npm install
+
+# 运行测试
+npm test
+
+# 构建项目
+npm run build
+```
+
+## 技术栈
+
+- **Rollup** - 模块打包工具
+- **Vitest** - 单元测试框架
+- **Terser** - JavaScript 压缩工具
+- **TypeScript** - 类型支持
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,150 @@
+/**
+ * 树结构数据处理的字段名配置
+ */
+export interface FieldNames {
+    children: string;
+    id: string;
+}
+/**
+ * 树节点类型
+ */
+export type TreeNode = Record<string, any>;
+/**
+ * 树结构数据（数组形式）
+ */
+export type TreeData = TreeNode[];
+/**
+ * 遍历树结构数据，对每个节点执行回调函数
+ * @param tree 树结构数据
+ * @param callback 回调函数，接收节点作为参数
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回映射后的扁平数组
+ */
+export declare function mapTree(tree: TreeData, callback: (node: TreeNode) => any, fieldNames?: FieldNames): any[];
+/**
+ * 过滤树结构数据，返回满足条件的节点
+ * @param tree 树结构数据
+ * @param filterFn 过滤函数
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回满足条件的节点数组
+ */
+export declare function filterTree(tree: TreeData, filterFn: (node: TreeNode, index: number) => boolean, fieldNames?: FieldNames): TreeData;
+/**
+ * 查找树结构数据中满足条件的第一个节点
+ * @param tree 树结构数据
+ * @param conditionFn 条件函数
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回找到的节点，未找到返回 null
+ */
+export declare function findTree(tree: TreeData, conditionFn: (node: TreeNode) => boolean, fieldNames?: FieldNames): TreeNode | null;
+/**
+ * 在指定父节点下添加子节点（添加到末尾）
+ * @param tree 树结构数据
+ * @param targetParentId 目标父节点ID
+ * @param newNode 新节点
+ * @param fieldNames 自定义字段名配置
+ * @returns 是否成功添加
+ */
+export declare function pushTree(tree: TreeData, targetParentId: any, newNode: TreeNode, fieldNames?: FieldNames): boolean;
+/**
+ * 在指定父节点下添加子节点（添加到开头）
+ * @param tree 树结构数据
+ * @param targetParentId 目标父节点ID
+ * @param newNode 新节点
+ * @param fieldNames 自定义字段名配置
+ * @returns 是否成功添加
+ */
+export declare function unshiftTree(tree: TreeData, targetParentId: any, newNode: TreeNode, fieldNames?: FieldNames): boolean;
+/**
+ * 删除指定节点下的最后一个子节点
+ * @param tree 树结构数据
+ * @param rootId 目标节点ID
+ * @param fieldNames 自定义字段名配置
+ * @returns 是否成功删除
+ */
+export declare function popTree(tree: TreeData, rootId: any, fieldNames?: FieldNames): boolean;
+/**
+ * 删除指定节点下的第一个子节点
+ * @param tree 树结构数据
+ * @param rootId 目标节点ID
+ * @param fieldNames 自定义字段名配置
+ * @returns 是否成功删除
+ */
+export declare function shiftTree(tree: TreeData, rootId: any, fieldNames?: FieldNames): boolean;
+/**
+ * 检查树结构数据中是否存在满足条件的节点
+ * @param tree 树结构数据
+ * @param filterFn 过滤函数
+ * @param fieldNames 自定义字段名配置
+ * @returns 如果存在满足条件的节点返回 true，否则返回 false
+ */
+export declare function someTree(tree: TreeData, filterFn: (node: TreeNode) => boolean, fieldNames?: FieldNames): boolean;
+/**
+ * 检查树结构数据中是否所有节点都满足条件
+ * @param tree 树结构数据
+ * @param filterFn 过滤函数
+ * @param fieldNames 自定义字段名配置
+ * @returns 如果所有节点都满足条件返回 true，否则返回 false
+ */
+export declare function everyTree(tree: TreeData, filterFn: (node: TreeNode) => boolean, fieldNames?: FieldNames): boolean;
+/**
+ * 根据父节点ID和子节点索引获取节点（支持负数索引）
+ * @param tree 树结构数据
+ * @param parentId 父节点ID
+ * @param nodeIndex 子节点索引（支持负数）
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回找到的节点，未找到返回 null
+ */
+export declare function atTree(tree: TreeData, parentId: any, nodeIndex: number, fieldNames?: FieldNames): TreeNode | null;
+/**
+ * 返回从根节点到目标节点的索引路径
+ * @param tree 树结构数据
+ * @param targetId 目标节点ID
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回索引路径数组，未找到返回 null
+ */
+export declare function indexOfTree(tree: TreeData, targetId: any, fieldNames?: FieldNames): number[] | null;
+/**
+ * 根据索引路径获取节点
+ * @param tree 树结构数据
+ * @param path 索引路径数组
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回找到的节点，未找到返回 null
+ */
+export declare function atIndexOfTree(tree: TreeData, path: number[], fieldNames?: FieldNames): TreeNode | null;
+/**
+ * 返回节点ID到深度的映射字典
+ * @param tree 树结构数据
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回节点ID到深度的映射对象
+ */
+export declare function nodeDepthMap(tree: TreeData, fieldNames?: FieldNames): Record<string, number>;
+/**
+ * 树结构数据去重
+ * @param tree 树结构数据
+ * @param key 用于去重的键名
+ * @param fieldNames 自定义字段名配置
+ * @returns 返回去重后的树结构数据
+ */
+export declare function dedupTree(tree: TreeData, key: string, fieldNames?: FieldNames): TreeData;
+/**
+ * 默认导出对象，包含所有方法
+ */
+declare const treeProcessor: {
+    mapTree: typeof mapTree;
+    filterTree: typeof filterTree;
+    findTree: typeof findTree;
+    pushTree: typeof pushTree;
+    unshiftTree: typeof unshiftTree;
+    popTree: typeof popTree;
+    shiftTree: typeof shiftTree;
+    someTree: typeof someTree;
+    everyTree: typeof everyTree;
+    atTree: typeof atTree;
+    indexOfTree: typeof indexOfTree;
+    atIndexOfTree: typeof atIndexOfTree;
+    nodeDepthMap: typeof nodeDepthMap;
+    dedupTree: typeof dedupTree;
+};
+export default treeProcessor;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;CACZ;AAUD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAC;AAElC;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,EACjC,UAAU,GAAE,UAAgC,GAC3C,GAAG,EAAE,CAeP;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,EACpD,UAAU,GAAE,UAAgC,GAC3C,QAAQ,CAiBV;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,QAAQ,EACd,WAAW,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,EACxC,UAAU,GAAE,UAAgC,GAC3C,QAAQ,GAAG,IAAI,CAcjB;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,QAAQ,EACd,cAAc,EAAE,GAAG,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,GAAE,UAAgC,GAC3C,OAAO,CAqBT;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,QAAQ,EACd,cAAc,EAAE,GAAG,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,GAAE,UAAgC,GAC3C,OAAO,CAqBT;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,GAAG,EACX,UAAU,GAAE,UAAgC,GAC3C,OAAO,CAsBT;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,GAAG,EACX,UAAU,GAAE,UAAgC,GAC3C,OAAO,CAsBT;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,EACrC,UAAU,GAAE,UAAgC,GAC3C,OAAO,CAaT;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,EACrC,UAAU,GAAE,UAAgC,GAC3C,OAAO,CAaT;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,GAAG,EACb,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,UAAgC,GAC3C,QAAQ,GAAG,IAAI,CAqCjB;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,GAAG,EACb,UAAU,GAAE,UAAgC,GAC3C,MAAM,EAAE,GAAG,IAAI,CAsBjB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,MAAM,EAAE,EACd,UAAU,GAAE,UAAgC,GAC3C,QAAQ,GAAG,IAAI,CA4BjB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,QAAQ,EACd,UAAU,GAAE,UAAgC,GAC3C,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAexB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,QAAQ,EACd,GAAG,EAAE,MAAM,EACX,UAAU,GAAE,UAAgC,GAC3C,QAAQ,CA+BV;AAED;;GAEG;AACH,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;CAelB,CAAC;AAEF,eAAe,aAAa,CAAC"}