fast-tree-builder 2.0.0-beta.6 → 2.0.1

package/index.d.cts

@@ -8,10 +8,10 @@ type TreeNode<TValue, TValueKey extends PropertyKey | false, TParentKey extends
     [k in Exclude<TDepthKey, false>]: number;
 });
 type AccessorReturnType<O, P extends (keyof O) | ((item: O) => any)> = P extends ((item: O) => infer R) ? R : P extends (keyof O) ? O[P] : never;
-type ObjectKeysOfIterableProperties<T> = {
+type ObjectKeysOfIterableProperties<T> = 0 extends (1 & T) ? PropertyKey : {
     [K in keyof T]: T[K] extends (Iterable<unknown> & object) | null | undefined ? K : never;
 }[keyof T];
-declare function buildTree<TIdAccessor extends (keyof NoInfer<TInputValue>) | ((item: NoInfer<TInputValue>) => unknown), TValueKey extends PropertyKey | false = 'value', TParentKey extends PropertyKey | false = 'parent', TChildrenKey extends PropertyKey = 'children', TDepthKey extends PropertyKey | false = false, TInputValue extends (TValueKey extends false ? object : TIdAccessor extends PropertyKey ? object : unknown) = any, TResolvedValue extends (TValueKey extends false ? object : unknown) = TInputValue>(items: Iterable<TInputValue>, options: {
+declare function buildTree<TIdAccessor extends NoInfer<keyof TInputValue> | ((item: NoInfer<TInputValue>) => unknown), TValueKey extends PropertyKey | false = 'value', TParentKey extends PropertyKey | false = 'parent', TChildrenKey extends PropertyKey = 'children', TDepthKey extends PropertyKey | false = false, TInputValue extends (TValueKey extends false ? object : TIdAccessor extends PropertyKey ? object : unknown) = any, TResolvedValue extends (TValueKey extends false ? object : unknown) = TInputValue>(items: Iterable<TInputValue>, options: {
     /**
      * A string key or function used to get the item's unique identifier.
      */
@@ -69,13 +69,11 @@ declare function buildTree<TIdAccessor extends (keyof NoInfer<TInputValue>) | ((
      */
     validateTree?: boolean;
     /**
-     * Validates referential integrity of the input.
+     * When true, verifies all parentId or childIds resolve to real items.
+     * Only `null` and `undefined` are acceptable as parent id for root nodes in parentId mode.
+     * Every item in the children list must resolve to a real item in childIds mode.
      *
-     * In strict mode:
-     * - All parent and child references must point to existing items in the input.
-     * - Root items must have their `parentId` unset, `null`, or `undefined`.
-     *
-     * Any invalid or missing references will result in an error during tree construction.
+     * Errors are thrown on invalid references.
      *
      * Defaults to `false`.
      */
@@ -92,14 +90,14 @@ declare function buildTree<TIdAccessor extends (keyof NoInfer<TInputValue>) | ((
      *
      * Either `parentId` or `childIds` must be provided.
      */
-    childIds: ObjectKeysOfIterableProperties<NoInfer<TInputValue>> | ((item: NoInfer<TInputValue>) => (Iterable<unknown> & object) | null | undefined);
+    childIds: NoInfer<ObjectKeysOfIterableProperties<TInputValue>> | ((item: NoInfer<TInputValue>) => (Iterable<unknown> & object) | null | undefined);
 } | {
     /**
      * A string key or function used to get the item's parent identifier.
      *
      * Either `parentId` or `childIds` must be provided.
      */
-    parentId: (keyof NoInfer<TInputValue>) | ((item: NoInfer<TInputValue>) => unknown);
+    parentId: NoInfer<keyof TInputValue> | ((item: NoInfer<TInputValue>) => unknown);
     /**
      * A string key or function to retrieve a list of child identifiers from an item.
      *

package/index.d.mts

@@ -8,10 +8,10 @@ type TreeNode<TValue, TValueKey extends PropertyKey | false, TParentKey extends
     [k in Exclude<TDepthKey, false>]: number;
 });
 type AccessorReturnType<O, P extends (keyof O) | ((item: O) => any)> = P extends ((item: O) => infer R) ? R : P extends (keyof O) ? O[P] : never;
-type ObjectKeysOfIterableProperties<T> = {
+type ObjectKeysOfIterableProperties<T> = 0 extends (1 & T) ? PropertyKey : {
     [K in keyof T]: T[K] extends (Iterable<unknown> & object) | null | undefined ? K : never;
 }[keyof T];
-export default function buildTree<TIdAccessor extends (keyof NoInfer<TInputValue>) | ((item: NoInfer<TInputValue>) => unknown), TValueKey extends PropertyKey | false = 'value', TParentKey extends PropertyKey | false = 'parent', TChildrenKey extends PropertyKey = 'children', TDepthKey extends PropertyKey | false = false, TInputValue extends (TValueKey extends false ? object : TIdAccessor extends PropertyKey ? object : unknown) = any, TResolvedValue extends (TValueKey extends false ? object : unknown) = TInputValue>(items: Iterable<TInputValue>, options: {
+export default function buildTree<TIdAccessor extends NoInfer<keyof TInputValue> | ((item: NoInfer<TInputValue>) => unknown), TValueKey extends PropertyKey | false = 'value', TParentKey extends PropertyKey | false = 'parent', TChildrenKey extends PropertyKey = 'children', TDepthKey extends PropertyKey | false = false, TInputValue extends (TValueKey extends false ? object : TIdAccessor extends PropertyKey ? object : unknown) = any, TResolvedValue extends (TValueKey extends false ? object : unknown) = TInputValue>(items: Iterable<TInputValue>, options: {
     /**
      * A string key or function used to get the item's unique identifier.
      */
@@ -69,13 +69,11 @@ export default function buildTree<TIdAccessor extends (keyof NoInfer<TInputValue
      */
     validateTree?: boolean;
     /**
-     * Validates referential integrity of the input.
+     * When true, verifies all parentId or childIds resolve to real items.
+     * Only `null` and `undefined` are acceptable as parent id for root nodes in parentId mode.
+     * Every item in the children list must resolve to a real item in childIds mode.
      *
-     * In strict mode:
-     * - All parent and child references must point to existing items in the input.
-     * - Root items must have their `parentId` unset, `null`, or `undefined`.
-     *
-     * Any invalid or missing references will result in an error during tree construction.
+     * Errors are thrown on invalid references.
      *
      * Defaults to `false`.
      */
@@ -92,14 +90,14 @@ export default function buildTree<TIdAccessor extends (keyof NoInfer<TInputValue
      *
      * Either `parentId` or `childIds` must be provided.
      */
-    childIds: ObjectKeysOfIterableProperties<NoInfer<TInputValue>> | ((item: NoInfer<TInputValue>) => (Iterable<unknown> & object) | null | undefined);
+    childIds: NoInfer<ObjectKeysOfIterableProperties<TInputValue>> | ((item: NoInfer<TInputValue>) => (Iterable<unknown> & object) | null | undefined);
 } | {
     /**
      * A string key or function used to get the item's parent identifier.
      *
      * Either `parentId` or `childIds` must be provided.
      */
-    parentId: (keyof NoInfer<TInputValue>) | ((item: NoInfer<TInputValue>) => unknown);
+    parentId: NoInfer<keyof TInputValue> | ((item: NoInfer<TInputValue>) => unknown);
     /**
      * A string key or function to retrieve a list of child identifiers from an item.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-tree-builder",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.1",
   "description": "Easily construct highly customizable bi-directional tree structures from iterable data.",
   "types": "./index.d.mts",
   "module": "./index.mjs",