fast-tree-builder 1.0.0-alpha.2 → 1.0.0-alpha.3

package/README.md

@@ -1,17 +1,18 @@
 # fast-tree-builder
 
+[![NPM version](https://img.shields.io/npm/v/fast-tree-builder.svg)](https://npmjs.org/package/fast-tree-builder)
+[![NPM downloads](https://img.shields.io/npm/dm/fast-tree-builder.svg)](https://npmjs.org/package/fast-tree-builder)
 [![Build Status](https://github.com/lionel87/fast-tree-builder/actions/workflows/build.yaml/badge.svg)](https://github.com/lionel87/fast-tree-builder/actions/workflows/build.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/lionel87/fast-tree-builder/badge.svg?branch=master)](https://coveralls.io/github/lionel87/fast-tree-builder?branch=master)
-![npms.io (quality)](https://img.shields.io/npms-io/quality-score/fast-tree-builder?label=quality)
-![Maintenance](https://img.shields.io/maintenance/yes/2024)
+![Maintenance](https://img.shields.io/maintenance/yes/2025)
 
 `fast-tree-builder` is an npm package that allows you to efficiently build trees from iterable data structures. With its optimized algorithm, strong TypeScript typings, and customizable node structure, it provides a reliable solution for organizing and manipulating hierarchical data.
 
 ## Prerequisites
 
 - You have a list of items,
-- where each item is identifiable by a unique value,
-- and the items are connected via a *parent* OR a *childred* relation.
+- each item is identifiable by a unique id,
+- the items are connected via a *parent id* OR *children ids*.
 
 ## Features
 

package/index.d.ts

@@ -1,37 +1,37 @@
-type TreeNode<T, D extends string | number | symbol | false, P extends string | number | symbol | false, C extends string | number | symbol> = (D extends false ? (P extends false ? T & {
-    [k in C]?: TreeNode<T, D, P, C>[];
-} : T & {
-    [k in Exclude<P, false>]?: TreeNode<T, D, P, C>;
+type TreeNode<TInputData, TDataKey extends string | number | symbol | false, TParentKey extends string | number | symbol | false, TChildrenKey extends string | number | symbol> = (TDataKey extends false ? (TParentKey extends false ? TInputData & {
+    [k in TChildrenKey]?: TreeNode<TInputData, TDataKey, TParentKey, TChildrenKey>[];
+} : TInputData & {
+    [k in Exclude<TParentKey, false>]?: TreeNode<TInputData, TDataKey, TParentKey, TChildrenKey>;
 } & {
-    [k in C]?: TreeNode<T, D, P, C>[];
-}) : (P extends false ? {
-    [k in Exclude<D, false>]: T;
+    [k in TChildrenKey]?: TreeNode<TInputData, TDataKey, TParentKey, TChildrenKey>[];
+}) : (TParentKey extends false ? {
+    [k in Exclude<TDataKey, false>]: TInputData;
 } & {
-    [k in C]?: TreeNode<T, D, P, C>[];
+    [k in TChildrenKey]?: TreeNode<TInputData, TDataKey, TParentKey, TChildrenKey>[];
 } : {
-    [k in Exclude<D, false>]: T;
+    [k in Exclude<TDataKey, false>]: TInputData;
 } & {
-    [k in Exclude<P, false>]?: TreeNode<T, D, P, C>;
+    [k in Exclude<TParentKey, false>]?: TreeNode<TInputData, TDataKey, TParentKey, TChildrenKey>;
 } & {
-    [k in C]?: TreeNode<T, D, P, C>[];
+    [k in TChildrenKey]?: TreeNode<TInputData, TDataKey, TParentKey, TChildrenKey>[];
 }));
 type KeyReturnType<T, P extends keyof T | ((item: T) => any)> = P extends ((item: T) => infer R) ? R : P extends keyof T ? T[P] : never;
-declare function buildTree<T extends (D extends false ? object : unknown), K extends keyof T | ((item: T) => any), M extends (D extends false ? object : unknown) = T, D extends string | number | symbol | false = 'data', P extends string | number | symbol | false = 'parent', C extends string | number | symbol = 'children'>(items: Iterable<T>, options?: {
+declare function buildTree<TInputData extends (TDataKey extends false ? object : unknown), TKey extends keyof TInputData | ((item: TInputData) => any), TMappedData extends (TDataKey extends false ? object : unknown) = TInputData, TDataKey extends string | number | symbol | false = 'data', TParentKey extends string | number | symbol | false = 'parent', TChildrenKey extends string | number | symbol = 'children'>(items: Iterable<TInputData>, options?: {
     mode?: 'parent' | 'children';
-    key?: K;
-    parentKey?: keyof T | ((item: T) => KeyReturnType<T, K>);
-    childrenKey?: keyof T | ((item: T) => KeyReturnType<T, K>);
-    nodeDataKey?: D;
-    nodeParentKey?: P;
-    nodeChildrenKey?: C;
+    key?: TKey;
+    parentKey?: keyof TInputData | ((item: TInputData) => KeyReturnType<TInputData, TKey>);
+    childrenKey?: keyof TInputData | ((item: TInputData) => KeyReturnType<TInputData, TKey>);
+    nodeDataKey?: TDataKey;
+    nodeParentKey?: TParentKey;
+    nodeChildrenKey?: TChildrenKey;
     mapNodeData?: {
-        (item: T): M;
+        (item: TInputData): TMappedData;
     };
     validRootKeys?: Iterable<unknown>;
     validRootParentKeys?: Iterable<unknown>;
     validateTree?: boolean;
 }): {
-    roots: TreeNode<M extends undefined ? T : M, D, P, C>[];
-    nodes: Map<KeyReturnType<T, K>, TreeNode<M extends undefined ? T : M, D, P, C>>;
+    roots: TreeNode<TMappedData extends undefined ? TInputData : TMappedData, TDataKey, TParentKey, TChildrenKey>[];
+    nodes: Map<KeyReturnType<TInputData, TKey>, TreeNode<TMappedData extends undefined ? TInputData : TMappedData, TDataKey, TParentKey, TChildrenKey>>;
 };
 export default buildTree;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-tree-builder",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.3",
   "description": "Efficiently construct highly customizable bi-directional tree structures from iterable data.",
   "type": "module",
   "module": "./index.js",
@@ -23,9 +23,9 @@
     "coverage": "c8 -r text -r text-summary -r lcov --include \"*.js\" npm test"
   },
   "devDependencies": {
-    "c8": "^9.1.0",
-    "chokidar": "^3.5.3",
-    "mocha": "^10.2.0",
+    "c8": "^10.1.3",
+    "chokidar": "^4.0.3",
+    "mocha": "^11.1.0",
     "typescript": "^5.3.3"
   },
   "homepage": "https://github.com/lionel87/fast-tree-builder#readme",