@okutils/array-to-tree 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2016-2022 Philipp Alferov.
+Copyright (c) 2025-present Luke Na.
+
+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,157 @@
+# @oktils/array-to-tree
+
+[![npm version](https://img.shields.io/npm/v/@oktils/array-to-tree.svg)](https://www.npmjs.com/package/@oktils/array-to-tree)
+[![license](https://img.shields.io/npm/l/@oktils/array-to-tree.svg)](LICENSE)
+
+A TypeScript utility library for converting a flat array structure into a hierarchical tree structure based on parent-child relationships.
+
+This project is based on [alferov/array-to-tree](https://github.com/alferov/array-to-tree), with modernizations, feature enhancements, and bug fixes applied to the original code.
+
+> [!IMPORTANT]
+>
+> Currently in Alpha stage. Bugs or breaking changes may occur.
+
+## Features
+
+- **Modern**: Written in modern TypeScript and ES for better type support.
+- **Functional**: Adopts a functional programming paradigm, does not mutate the original data, and avoids side effects.
+- **Configurable**: Allows customization of field names and other behaviors to adapt to different data structures.
+
+## Installation
+
+```bash
+# Using pnpm
+pnpm add @oktils/array-to-tree
+
+# Using yarn
+yarn add @oktils/array-to-tree
+
+# Using npm
+npm install @oktils/array-to-tree
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { arrayToTree } from "@oktils/array-to-tree";
+
+const data = [
+  { id: 1, name: "A", parentId: null },
+  { id: 2, name: "B", parentId: 1 },
+  { id: 3, name: "C", parentId: 1 },
+  { id: 4, name: "D", parentId: 2 },
+  { id: 5, name: "E", parentId: null },
+];
+
+const tree = arrayToTree(data);
+
+console.log(tree);
+```
+
+Output:
+
+```json
+[
+  {
+    "id": 1,
+    "name": "A",
+    "parentId": null,
+    "children": [
+      {
+        "id": 2,
+        "name": "B",
+        "parentId": 1,
+        "children": [
+          {
+            "id": 4,
+            "name": "D",
+            "parentId": 2
+          }
+        ]
+      },
+      {
+        "id": 3,
+        "name": "C",
+        "parentId": 1
+      }
+    ]
+  },
+  {
+    "id": 5,
+    "name": "E",
+    "parentId": null
+  }
+]
+```
+
+### API
+
+`arrayToTree(data, options?)`
+
+- `data`: `Record<string, any>[]` - A flat array containing the data.
+- `options`: `ArrayToTreeOptions` (optional) - A configuration options object.
+
+### Configuration Options
+
+You can pass an `options` object to customize field names and other behaviors.
+
+```typescript
+// src/types/options.ts
+export interface ArrayToTreeOptions {
+  childrenId?: string;
+  customId?: string;
+  parentId?: string;
+  rootId?: string;
+  allowSelfAsParent?: boolean;
+}
+```
+
+| Option              | Type      | Default                               | Description                                                                                                                           |
+| ------------------- | --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `customId`          | `string`  | `'id'`                                | Specifies the field name for the unique identifier of a node.                                                                         |
+| `parentId`          | `string`  | `'parentId'`                          | Specifies the field name for associating with the parent node.                                                                        |
+| `childrenId`        | `string`  | `'children'`                          | Specifies the field name for the array of child nodes in the generated tree.                                                          |
+| `allowSelfAsParent` | `boolean` | `false`                               | Whether to allow a node's `parentId` to be equal to its own `id`.                                                                     |
+| `rootId`            | `string`  | `'__ARRAY_TO_TREE_VIRTUAL_ROOT_ID__'` | An internal virtual root ID, which usually does not need to be changed. The `parentId` of root nodes should be `null` or `undefined`. |
+
+#### Example: Using Custom Fields
+
+```typescript
+import { arrayToTree } from "@oktils/array-to-tree";
+
+const data = [
+  { key: "node-1", parent: null, title: "Node 1" },
+  { key: "node-2", parent: "node-1", title: "Node 2" },
+];
+
+const tree = arrayToTree(data, {
+  customId: "key",
+  parentId: "parent",
+  childrenId: "nodes",
+});
+```
+
+##### Output
+
+```json
+[
+  {
+    "key": "node-1",
+    "parent": null,
+    "title": "Node 1",
+    "nodes": [
+      {
+        "key": "node-2",
+        "parent": "node-1",
+        "title": "Node 2"
+      }
+    ]
+  }
+]
+```
+
+## 📄 License
+
+[MIT](LICENSE) © Luke Na

package/README.zh-CN.md

@@ -0,0 +1,157 @@
+# @oktils/array-to-tree
+
+[![npm version](https://img.shields.io/npm/v/@oktils/array-to-tree.svg)](https://www.npmjs.com/package/@oktils/array-to-tree)
+[![license](https://img.shields.io/npm/l/@oktils/array-to-tree.svg)](LICENSE)
+
+一个 TypeScript 工具库，用于将扁平的数组结构通过父子关系转换为层级树结构。
+
+这个项目基于 [alferov/array-to-tree](https://github.com/alferov/array-to-tree)，并针对原始代码做了现代化改造、功能增强和一些错误修复。
+
+> [!IMPORTANT]
+>
+> 目前处于 Alpha 阶段，可能会存在 bug 或不兼容的变更。
+
+## 特性
+
+- **现代化**：使用现代 TypeScript 和 ES 编写，提供更好的类型支持。
+- **函数式编程**：采用函数式编程范式，不修改原始数据，避免副作用。
+- **可配置**：允许自定义字段名和其他行为，适应不同的数据结构。
+
+## 安装
+
+```bash
+# 使用 pnpm
+pnpm add @oktils/array-to-tree
+
+# 使用 yarn
+yarn add @oktils/array-to-tree
+
+# 使用 npm
+npm install @oktils/array-to-tree
+```
+
+## 使用方法
+
+### 基本用法
+
+```typescript
+import { arrayToTree } from "@oktils/array-to-tree";
+
+const data = [
+  { id: 1, name: "A", parentId: null },
+  { id: 2, name: "B", parentId: 1 },
+  { id: 3, name: "C", parentId: 1 },
+  { id: 4, name: "D", parentId: 2 },
+  { id: 5, name: "E", parentId: null },
+];
+
+const tree = arrayToTree(data);
+
+console.log(tree);
+```
+
+##### 输出结果
+
+```json
+[
+  {
+    "id": 1,
+    "name": "A",
+    "parentId": null,
+    "children": [
+      {
+        "id": 2,
+        "name": "B",
+        "parentId": 1,
+        "children": [
+          {
+            "id": 4,
+            "name": "D",
+            "parentId": 2
+          }
+        ]
+      },
+      {
+        "id": 3,
+        "name": "C",
+        "parentId": 1
+      }
+    ]
+  },
+  {
+    "id": 5,
+    "name": "E",
+    "parentId": null
+  }
+]
+```
+
+### API
+
+`arrayToTree(data, options?)`
+
+- `data`: `Record<string, any>[]` - 包含数据的扁平数组。
+- `options`: `ArrayToTreeOptions` (可选) - 配置选项对象。
+
+### 配置选项
+
+您可以传入一个 `options` 对象来自定义字段名和其他行为。
+
+```typescript
+// src/types/options.ts
+export interface ArrayToTreeOptions {
+  childrenId?: string;
+  customId?: string;
+  parentId?: string;
+  rootId?: string;
+  allowSelfAsParent?: boolean;
+}
+```
+
+| 选项                | 类型      | 默认值                                | 描述                                                                                  |
+| ------------------- | --------- | ------------------------------------- | ------------------------------------------------------------------------------------- |
+| `customId`          | `string`  | `'id'`                                | 指定节点唯一标识的字段名。                                                            |
+| `parentId`          | `string`  | `'parentId'`                          | 指定关联父节点的字段名。                                                              |
+| `childrenId`        | `string`  | `'children'`                          | 指定生成的树中用于存放子节点数组的字段名。                                            |
+| `allowSelfAsParent` | `boolean` | `false`                               | 是否允许一个节点的 `parentId` 等于它自身的 `id`。                                     |
+| `rootId`            | `string`  | `'__ARRAY_TO_TREE_VIRTUAL_ROOT_ID__'` | 内部使用的虚拟根 ID，通常不需要修改。根节点的 `parentId` 应为 `null` 或 `undefined`。 |
+
+#### 示例：使用自定义字段
+
+```typescript
+import { arrayToTree } from "@oktils/array-to-tree";
+
+const data = [
+  { key: "node-1", parent: null, title: "Node 1" },
+  { key: "node-2", parent: "node-1", title: "Node 2" },
+];
+
+const tree = arrayToTree(data, {
+  customId: "key",
+  parentId: "parent",
+  childrenId: "nodes",
+});
+```
+
+输出结果:
+
+```json
+[
+  {
+    "key": "node-1",
+    "parent": null,
+    "title": "Node 1",
+    "nodes": [
+      {
+        "key": "node-2",
+        "parent": "node-1",
+        "title": "Node 2"
+      }
+    ]
+  }
+]
+```
+
+## 📄 许可证
+
+[MIT](LICENSE) © Luke Na

package/dist/cjs/index.js

@@ -0,0 +1,2 @@
+"use strict";class r extends Error{constructor(r){super(r),this.name="ArrayToTreeError"}}const t=(r,e,n,o)=>Array.isArray(e)?e.map(e=>{const s={...e},a=r[e[n]];return a&&(s[o]=t(r,a,n,o)),s}):[],e=(r,t)=>{const e=t.split(/[.[\]]/g);let n=r;for(const r of e){if(null===n)return null;if(void 0===n)return null;const t=r.replace(/['"]/g,"");""!==t.trim()&&(n=n[t])}return void 0===n?null:n};exports.ArrayToTreeError=r,exports.arrayToTree=(n,o)=>{const s=(r=>({allowSelfAsParent:(r=r??{}).allowSelfAsParent??!1,childrenId:r.childrenId??"children",customId:r.customId??"id",parentId:r.parentId??"parentId",rootId:r.rootId??"__ARRAY_TO_TREE_VIRTUAL_ROOT_ID__"}))(o);if(!Array.isArray(n))throw new r("Expected an array but got an invalid argument.");const a=((t,n)=>{const o={};for(const e of t){const t=e[n.customId];if(null!=t&&Object.hasOwn(o,t))throw new r(`Duplicate node id "${t}" detected.`);o[t]=e}return t.reduce((t,s)=>{const a=e(s,n.customId);let c=e(s,n.parentId);if(c===a){if(!n.allowSelfAsParent)throw new r(`Node "${a}" cannot be its own parent (self reference found).`);c=n.rootId}return c&&Object.hasOwn(o,c)||(c=n.rootId),c&&Object.hasOwn(t,c)?(t[c].push(s),t):(t[c]=[s],t)},{})})(n,s);return t(a,a[s.rootId],s.customId,s.childrenId)};
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../../src/errors/array-to-tree-error.ts","../../../../src/internal/create-tree.ts","../../../../src/internal/get.ts","../../../../src/utils/array-to-tree.ts","../../../../src/internal/resolve-options.ts","../../../../src/internal/group-by-parents.ts"],"sourcesContent":["export class ArrayToTreeError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = \"ArrayToTreeError\";\n  }\n}\n","export const createTree = (\n  grouped: Record<string, any[]>,\n  rootNodes: any[],\n  customId: string,\n  childrenProperty: string,\n) => {\n  if (!Array.isArray(rootNodes)) {\n    return [];\n  }\n\n  return rootNodes.map((node) => {\n    const newNode = { ...node };\n    const children = grouped[node[customId]];\n    if (children) {\n      newNode[childrenProperty] = createTree(\n        grouped,\n        children,\n        customId,\n        childrenProperty,\n      );\n    }\n    return newNode;\n  });\n};\n","/**\n * This code is modified from the radash project.\n * @see https://github.com/sodiray/radash\n */\nexport const get = (value: any, path: string) => {\n  const segments = path.split(/[.[\\]]/g);\n  let current: any = value;\n  for (const key of segments) {\n    if (current === null) return null;\n    if (current === undefined) return null;\n    const dequoted = key.replace(/['\"]/g, \"\");\n    if (dequoted.trim() === \"\") continue;\n    current = current[dequoted];\n  }\n  if (current === undefined) return null;\n  return current;\n};\n","import { ArrayToTreeError } from \"../errors\";\nimport { createTree, groupByParents, resolveOptions } from \"../internal\";\nimport type {\n  ArrayToTreeOptions,\n  NormalizedArrayToTreeOptions,\n} from \"../types\";\n\nexport const arrayToTree = (\n  data: Record<string, any>[],\n  options?: ArrayToTreeOptions,\n) => {\n  const normalizeOptions = resolveOptions(\n    options,\n  ) as NormalizedArrayToTreeOptions;\n\n  if (!Array.isArray(data)) {\n    throw new ArrayToTreeError(\n      \"Expected an array but got an invalid argument.\",\n    );\n  }\n\n  const grouped = groupByParents(data, normalizeOptions);\n\n  return createTree(\n    grouped,\n    grouped[normalizeOptions.rootId],\n    normalizeOptions.customId,\n    normalizeOptions.childrenId,\n  );\n};\n","import type { ArrayToTreeOptions } from \"../types\";\n\nexport const resolveOptions = (\n  options?: ArrayToTreeOptions,\n): Required<ArrayToTreeOptions> => {\n  options = options ?? {};\n  return {\n    allowSelfAsParent: options.allowSelfAsParent ?? false,\n    childrenId: options.childrenId ?? \"children\",\n    customId: options.customId ?? \"id\",\n    parentId: options.parentId ?? \"parentId\",\n    rootId: options.rootId ?? \"__ARRAY_TO_TREE_VIRTUAL_ROOT_ID__\",\n  };\n};\n","import { ArrayToTreeError } from \"../errors\";\nimport type { NormalizedArrayToTreeOptions } from \"../types\";\nimport { get } from \"./get\";\n\nexport const groupByParents = (\n  array: Record<string, any>[],\n  options: NormalizedArrayToTreeOptions,\n) => {\n  const arrayById: Record<string, any> = {};\n  for (const item of array) {\n    const key = item[options.customId];\n    if (key != null && Object.hasOwn(arrayById, key)) {\n      throw new ArrayToTreeError(`Duplicate node id \"${key}\" detected.`);\n    }\n    arrayById[key] = item;\n  }\n\n  return array.reduce((prev, item) => {\n    const id = get(item, options.customId);\n    let parentId = get(item, options.parentId);\n\n    // Handle self-referencing nodes\n    if (parentId === id) {\n      if (!options.allowSelfAsParent) {\n        throw new ArrayToTreeError(\n          `Node \"${id}\" cannot be its own parent (self reference found).`,\n        );\n      }\n      parentId = options.rootId;\n    }\n\n    if (!parentId || !Object.hasOwn(arrayById, parentId)) {\n      parentId = options.rootId;\n    }\n\n    if (parentId && Object.hasOwn(prev, parentId)) {\n      prev[parentId].push(item);\n      return prev;\n    }\n\n    prev[parentId] = [item];\n    return prev;\n  }, {});\n};\n"],"names":["ArrayToTreeError","Error","constructor","message","super","this","name","createTree","grouped","rootNodes","customId","childrenProperty","Array","isArray","map","node","newNode","children","get","value","path","segments","split","current","key","undefined","dequoted","replace","trim","data","options","normalizeOptions","allowSelfAsParent","childrenId","parentId","rootId","resolveOptions","array","arrayById","item","Object","hasOwn","reduce","prev","id","push","groupByParents"],"mappings":"aAAM,MAAOA,UAAyBC,MACpC,WAAAC,CAAYC,GACVC,MAAMD,GACNE,KAAKC,KAAO,kBACd,ECJK,MAAMC,EAAa,CACxBC,EACAC,EACAC,EACAC,IAEKC,MAAMC,QAAQJ,GAIZA,EAAUK,IAAKC,IACpB,MAAMC,EAAU,IAAKD,GACfE,EAAWT,EAAQO,EAAKL,IAS9B,OARIO,IACFD,EAAQL,GAAoBJ,EAC1BC,EACAS,EACAP,EACAC,IAGGK,IAdA,GCHEE,EAAM,CAACC,EAAYC,KAC9B,MAAMC,EAAWD,EAAKE,MAAM,WAC5B,IAAIC,EAAeJ,EACnB,IAAK,MAAMK,KAAOH,EAAU,CAC1B,GAAgB,OAAZE,EAAkB,OAAO,KAC7B,QAAgBE,IAAZF,EAAuB,OAAO,KAClC,MAAMG,EAAWF,EAAIG,QAAQ,QAAS,IACd,KAApBD,EAASE,SACbL,EAAUA,EAAQG,GACpB,CACA,YAAgBD,IAAZF,EAA8B,KAC3BA,kDCRkB,CACzBM,EACAC,KAEA,MAAMC,ECTsB,CAC5BD,IAGO,CACLE,mBAFFF,EAAUA,GAAW,CAAA,GAEQE,oBAAqB,EAChDC,WAAYH,EAAQG,YAAc,WAClCvB,SAAUoB,EAAQpB,UAAY,KAC9BwB,SAAUJ,EAAQI,UAAY,WAC9BC,OAAQL,EAAQK,QAAU,sCDAHC,CACvBN,GAGF,IAAKlB,MAAMC,QAAQgB,GACjB,MAAM,IAAI7B,EACR,kDAIJ,MAAMQ,EEjBsB,EAC5B6B,EACAP,KAEA,MAAMQ,EAAiC,CAAA,EACvC,IAAK,MAAMC,KAAQF,EAAO,CACxB,MAAMb,EAAMe,EAAKT,EAAQpB,UACzB,GAAW,MAAPc,GAAegB,OAAOC,OAAOH,EAAWd,GAC1C,MAAM,IAAIxB,EAAiB,sBAAsBwB,gBAEnDc,EAAUd,GAAOe,CACnB,CAEA,OAAOF,EAAMK,OAAO,CAACC,EAAMJ,KACzB,MAAMK,EAAK1B,EAAIqB,EAAMT,EAAQpB,UAC7B,IAAIwB,EAAWhB,EAAIqB,EAAMT,EAAQI,UAGjC,GAAIA,IAAaU,EAAI,CACnB,IAAKd,EAAQE,kBACX,MAAM,IAAIhC,EACR,SAAS4C,uDAGbV,EAAWJ,EAAQK,MACrB,CAMA,OAJKD,GAAaM,OAAOC,OAAOH,EAAWJ,KACzCA,EAAWJ,EAAQK,QAGjBD,GAAYM,OAAOC,OAAOE,EAAMT,IAClCS,EAAKT,GAAUW,KAAKN,GACbI,IAGTA,EAAKT,GAAY,CAACK,GACXI,IACN,CAAA,IFrBaG,CAAejB,EAAME,GAErC,OAAOxB,EACLC,EACAA,EAAQuB,EAAiBI,QACzBJ,EAAiBrB,SACjBqB,EAAiBE"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+class r extends Error{constructor(r){super(r),this.name="ArrayToTreeError"}}const t=(r,e,n,o)=>Array.isArray(e)?e.map(e=>{const d={...e},s=r[e[n]];return s&&(d[o]=t(r,s,n,o)),d}):[],e=(r,t)=>{const e=t.split(/[.[\]]/g);let n=r;for(const r of e){if(null===n)return null;if(void 0===n)return null;const t=r.replace(/['"]/g,"");""!==t.trim()&&(n=n[t])}return void 0===n?null:n},n=(n,o)=>{const d=(r=>({allowSelfAsParent:(r=r??{}).allowSelfAsParent??!1,childrenId:r.childrenId??"children",customId:r.customId??"id",parentId:r.parentId??"parentId",rootId:r.rootId??"__ARRAY_TO_TREE_VIRTUAL_ROOT_ID__"}))(o);if(!Array.isArray(n))throw new r("Expected an array but got an invalid argument.");const s=((t,n)=>{const o={};for(const e of t){const t=e[n.customId];if(null!=t&&Object.hasOwn(o,t))throw new r(`Duplicate node id "${t}" detected.`);o[t]=e}return t.reduce((t,d)=>{const s=e(d,n.customId);let c=e(d,n.parentId);if(c===s){if(!n.allowSelfAsParent)throw new r(`Node "${s}" cannot be its own parent (self reference found).`);c=n.rootId}return c&&Object.hasOwn(o,c)||(c=n.rootId),c&&Object.hasOwn(t,c)?(t[c].push(d),t):(t[c]=[d],t)},{})})(n,d);return t(s,s[d.rootId],d.customId,d.childrenId)};export{r as ArrayToTreeError,n as arrayToTree};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../../src/errors/array-to-tree-error.ts","../../../../src/internal/create-tree.ts","../../../../src/internal/get.ts","../../../../src/utils/array-to-tree.ts","../../../../src/internal/resolve-options.ts","../../../../src/internal/group-by-parents.ts"],"sourcesContent":["export class ArrayToTreeError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = \"ArrayToTreeError\";\n  }\n}\n","export const createTree = (\n  grouped: Record<string, any[]>,\n  rootNodes: any[],\n  customId: string,\n  childrenProperty: string,\n) => {\n  if (!Array.isArray(rootNodes)) {\n    return [];\n  }\n\n  return rootNodes.map((node) => {\n    const newNode = { ...node };\n    const children = grouped[node[customId]];\n    if (children) {\n      newNode[childrenProperty] = createTree(\n        grouped,\n        children,\n        customId,\n        childrenProperty,\n      );\n    }\n    return newNode;\n  });\n};\n","/**\n * This code is modified from the radash project.\n * @see https://github.com/sodiray/radash\n */\nexport const get = (value: any, path: string) => {\n  const segments = path.split(/[.[\\]]/g);\n  let current: any = value;\n  for (const key of segments) {\n    if (current === null) return null;\n    if (current === undefined) return null;\n    const dequoted = key.replace(/['\"]/g, \"\");\n    if (dequoted.trim() === \"\") continue;\n    current = current[dequoted];\n  }\n  if (current === undefined) return null;\n  return current;\n};\n","import { ArrayToTreeError } from \"../errors\";\nimport { createTree, groupByParents, resolveOptions } from \"../internal\";\nimport type {\n  ArrayToTreeOptions,\n  NormalizedArrayToTreeOptions,\n} from \"../types\";\n\nexport const arrayToTree = (\n  data: Record<string, any>[],\n  options?: ArrayToTreeOptions,\n) => {\n  const normalizeOptions = resolveOptions(\n    options,\n  ) as NormalizedArrayToTreeOptions;\n\n  if (!Array.isArray(data)) {\n    throw new ArrayToTreeError(\n      \"Expected an array but got an invalid argument.\",\n    );\n  }\n\n  const grouped = groupByParents(data, normalizeOptions);\n\n  return createTree(\n    grouped,\n    grouped[normalizeOptions.rootId],\n    normalizeOptions.customId,\n    normalizeOptions.childrenId,\n  );\n};\n","import type { ArrayToTreeOptions } from \"../types\";\n\nexport const resolveOptions = (\n  options?: ArrayToTreeOptions,\n): Required<ArrayToTreeOptions> => {\n  options = options ?? {};\n  return {\n    allowSelfAsParent: options.allowSelfAsParent ?? false,\n    childrenId: options.childrenId ?? \"children\",\n    customId: options.customId ?? \"id\",\n    parentId: options.parentId ?? \"parentId\",\n    rootId: options.rootId ?? \"__ARRAY_TO_TREE_VIRTUAL_ROOT_ID__\",\n  };\n};\n","import { ArrayToTreeError } from \"../errors\";\nimport type { NormalizedArrayToTreeOptions } from \"../types\";\nimport { get } from \"./get\";\n\nexport const groupByParents = (\n  array: Record<string, any>[],\n  options: NormalizedArrayToTreeOptions,\n) => {\n  const arrayById: Record<string, any> = {};\n  for (const item of array) {\n    const key = item[options.customId];\n    if (key != null && Object.hasOwn(arrayById, key)) {\n      throw new ArrayToTreeError(`Duplicate node id \"${key}\" detected.`);\n    }\n    arrayById[key] = item;\n  }\n\n  return array.reduce((prev, item) => {\n    const id = get(item, options.customId);\n    let parentId = get(item, options.parentId);\n\n    // Handle self-referencing nodes\n    if (parentId === id) {\n      if (!options.allowSelfAsParent) {\n        throw new ArrayToTreeError(\n          `Node \"${id}\" cannot be its own parent (self reference found).`,\n        );\n      }\n      parentId = options.rootId;\n    }\n\n    if (!parentId || !Object.hasOwn(arrayById, parentId)) {\n      parentId = options.rootId;\n    }\n\n    if (parentId && Object.hasOwn(prev, parentId)) {\n      prev[parentId].push(item);\n      return prev;\n    }\n\n    prev[parentId] = [item];\n    return prev;\n  }, {});\n};\n"],"names":["ArrayToTreeError","Error","constructor","message","super","this","name","createTree","grouped","rootNodes","customId","childrenProperty","Array","isArray","map","node","newNode","children","get","value","path","segments","split","current","key","undefined","dequoted","replace","trim","arrayToTree","data","options","normalizeOptions","allowSelfAsParent","childrenId","parentId","rootId","resolveOptions","array","arrayById","item","Object","hasOwn","reduce","prev","id","push","groupByParents"],"mappings":"AAAM,MAAOA,UAAyBC,MACpC,WAAAC,CAAYC,GACVC,MAAMD,GACNE,KAAKC,KAAO,kBACd,ECJK,MAAMC,EAAa,CACxBC,EACAC,EACAC,EACAC,IAEKC,MAAMC,QAAQJ,GAIZA,EAAUK,IAAKC,IACpB,MAAMC,EAAU,IAAKD,GACfE,EAAWT,EAAQO,EAAKL,IAS9B,OARIO,IACFD,EAAQL,GAAoBJ,EAC1BC,EACAS,EACAP,EACAC,IAGGK,IAdA,GCHEE,EAAM,CAACC,EAAYC,KAC9B,MAAMC,EAAWD,EAAKE,MAAM,WAC5B,IAAIC,EAAeJ,EACnB,IAAK,MAAMK,KAAOH,EAAU,CAC1B,GAAgB,OAAZE,EAAkB,OAAO,KAC7B,QAAgBE,IAAZF,EAAuB,OAAO,KAClC,MAAMG,EAAWF,EAAIG,QAAQ,QAAS,IACd,KAApBD,EAASE,SACbL,EAAUA,EAAQG,GACpB,CACA,YAAgBD,IAAZF,EAA8B,KAC3BA,GCRIM,EAAc,CACzBC,EACAC,KAEA,MAAMC,ECTsB,CAC5BD,IAGO,CACLE,mBAFFF,EAAUA,GAAW,CAAA,GAEQE,oBAAqB,EAChDC,WAAYH,EAAQG,YAAc,WAClCxB,SAAUqB,EAAQrB,UAAY,KAC9ByB,SAAUJ,EAAQI,UAAY,WAC9BC,OAAQL,EAAQK,QAAU,sCDAHC,CACvBN,GAGF,IAAKnB,MAAMC,QAAQiB,GACjB,MAAM,IAAI9B,EACR,kDAIJ,MAAMQ,EEjBsB,EAC5B8B,EACAP,KAEA,MAAMQ,EAAiC,CAAA,EACvC,IAAK,MAAMC,KAAQF,EAAO,CACxB,MAAMd,EAAMgB,EAAKT,EAAQrB,UACzB,GAAW,MAAPc,GAAeiB,OAAOC,OAAOH,EAAWf,GAC1C,MAAM,IAAIxB,EAAiB,sBAAsBwB,gBAEnDe,EAAUf,GAAOgB,CACnB,CAEA,OAAOF,EAAMK,OAAO,CAACC,EAAMJ,KACzB,MAAMK,EAAK3B,EAAIsB,EAAMT,EAAQrB,UAC7B,IAAIyB,EAAWjB,EAAIsB,EAAMT,EAAQI,UAGjC,GAAIA,IAAaU,EAAI,CACnB,IAAKd,EAAQE,kBACX,MAAM,IAAIjC,EACR,SAAS6C,uDAGbV,EAAWJ,EAAQK,MACrB,CAMA,OAJKD,GAAaM,OAAOC,OAAOH,EAAWJ,KACzCA,EAAWJ,EAAQK,QAGjBD,GAAYM,OAAOC,OAAOE,EAAMT,IAClCS,EAAKT,GAAUW,KAAKN,GACbI,IAGTA,EAAKT,GAAY,CAACK,GACXI,IACN,CAAA,IFrBaG,CAAejB,EAAME,GAErC,OAAOzB,EACLC,EACAA,EAAQwB,EAAiBI,QACzBJ,EAAiBtB,SACjBsB,EAAiBE"}

package/dist/types/index.d.ts

@@ -0,0 +1,17 @@
+declare class ArrayToTreeError extends Error {
+    constructor(message: string);
+}
+
+interface ArrayToTreeOptions {
+    childrenId?: string;
+    customId?: string;
+    parentId?: string;
+    rootId?: string;
+    allowSelfAsParent?: boolean;
+}
+type NormalizedArrayToTreeOptions = Required<ArrayToTreeOptions>;
+
+declare const arrayToTree: (data: Record<string, any>[], options?: ArrayToTreeOptions) => any[];
+
+export { ArrayToTreeError, arrayToTree };
+export type { ArrayToTreeOptions, NormalizedArrayToTreeOptions };

package/package.json

@@ -0,0 +1,65 @@
+{
+  "author": {
+    "email": "narukeu@outlook.com",
+    "name": "Luke Na",
+    "url": "https://narukeu.github.io"
+  },
+  "bugs": {
+    "url": "https://github.com/okutils/array-to-tree/issues"
+  },
+  "description": "A TypeScript utility to convert a flat array into a hierarchical tree via parent-child relationships.",
+  "devDependencies": {
+    "@biomejs/biome": "2.2.5",
+    "@jest/globals": "^30.2.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/node": "^24.6.2",
+    "jest": "^30.2.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.52.4",
+    "rollup-plugin-dts": "^6.2.3",
+    "rollup-plugin-node-externals": "^8.1.1",
+    "ts-jest": "^29.4.4",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js",
+    "types": "./dist/types/index.d.ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/okutils/array-to-tree",
+  "keywords": [
+    "array",
+    "tree",
+    "typescript",
+    "utility"
+  ],
+  "license": "MIT",
+  "name": "@okutils/array-to-tree",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/okutils/array-to-tree.git"
+  },
+  "scripts": {
+    "build": "pnpm clean && rollup -c",
+    "clean": "rimraf dist",
+    "dev": "rollup -c -w",
+    "format": "biome format --write",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "test": "jest",
+    "type-check": "tsc --noEmit"
+  },
+  "type": "module",
+  "version": "0.0.1-alpha.1"
+}