feat: add option to disable nested ids

Author: philipstanislaus

README.md

@@ -66,10 +66,11 @@ You can provide a second argument to arrayToTree with configuration options. Rig
 
 - `id`: key of the id field of the item. Also works with nested properties (e. g. `"nested.parentId"`). Default: `"id"`.
 - `parentId`: key of the parent's id field of the item. Also works with nested properties (e. g. `"nested.parentId"`). Default: `"parentId"`.
+- `nestedIds`: option to enable/disable nested ids. Default: `true`.
 - `childrenField`: key which will contain all child nodes of the parent node. Default: `"children"`
 - `dataField`: key which will contain all properties/data of the original items. Set to null if you don't want a container. Default: `"data"`
 - `throwIfOrphans`: option to throw an error if the array of items contains one or more items that have no parents in the array. This option has a small runtime penalty, so it's disabled by default. When enabled, the function will throw an error containing the parentIds that were not found in the items array. When disabled, the function will just ignore orphans and not add them to the tree. Default: `false`
-- `rootParentIds`: Object with parent ids as keys and `true` as values that should be considered the top or root elements of the tree. This is useful when your tree is a subset of full tree, which means there is no item whose parent id is one of `undefined`, `null` or `''`. The array you pass in will be replace the default value. `undefined` and `null` are always considered to be rootParentIds. For more details, see [#23](https://github.com/philipstanislaus/performant-array-to-tree/issues/23). Default: `{'': true}`
+- `rootParentIds`: object with parent ids as keys and `true` as values that should be considered the top or root elements of the tree. This is useful when your tree is a subset of full tree, which means there is no item whose parent id is one of `undefined`, `null` or `''`. The array you pass in will be replace the default value. `undefined` and `null` are always considered to be rootParentIds. For more details, see [#23](https://github.com/philipstanislaus/performant-array-to-tree/issues/23). Default: `{'': true}`
 
 Example:
 

src/arrayToTree.spec.ts

@@ -81,6 +81,33 @@ describe("arrayToTree", () => {
     ]);
   });
 
+  it("should work with nested objects and a custom key with dots if nested properties are disabled", () => {
+    expect(
+      arrayToTree(
+        [
+          { '.key': "4", 'my.parent': null, custom: "abc" },
+          { '.key': "31", 'my.parent': "4", custom: "12" },
+          { '.key': "1941", 'my.parent': "418", custom: "de" },
+          { '.key': "1", 'my.parent': "418", custom: "ZZZz" },
+          { '.key': "418", 'my.parent': null, custom: "ü" },
+        ],
+        { id: '.key', parentId: 'my.parent', childrenField: "nodes", nestedIds: false }
+      )
+    ).to.deep.equal([
+      {
+        data: { '.key': "4", 'my.parent': null, custom: "abc" },
+        nodes: [{ data: { '.key': "31", 'my.parent': "4", custom: "12" }, nodes: [] }],
+      },
+      {
+        data: { '.key': "418", 'my.parent': null, custom: "ü" },
+        nodes: [
+          { data: { '.key': "1941", 'my.parent': "418", custom: "de" }, nodes: [] },
+          { data: { '.key': "1", 'my.parent': "418", custom: "ZZZz" }, nodes: [] },
+        ],
+      },
+    ]);
+  });
+
   it("should ignore objects if parentId does not exist", () => {
     expect(
       arrayToTree([

src/arrayToTree.ts

@@ -17,6 +17,7 @@ export interface Config {
   childrenField: string;
   throwIfOrphans: boolean;
   rootParentIds: { [rootParentId: string]: true }; // use an object here for fast lookups
+  nestedIds: boolean;
 }
 
 const defaultConfig: Config = {
@@ -26,6 +27,7 @@ const defaultConfig: Config = {
   childrenField: "children",
   throwIfOrphans: false,
   rootParentIds: { "": true },
+  nestedIds: true,
 };
 
 /**
@@ -54,8 +56,8 @@ export function arrayToTree(
   // in the lookup object and fill it with the data of the parent later
   // if an item has no parentId, add it as a root element to rootItems
   for (const item of items) {
-    const itemId = getNestedProperty(item, conf.id);
-    const parentId = getNestedProperty(item, conf.parentId);
+    const itemId = conf.nestedIds ? getNestedProperty(item, conf.id) : item[conf.id];
+    const parentId = conf.nestedIds ? getNestedProperty(item, conf.parentId) : item[conf.parentId];
 
     if (conf.rootParentIds[itemId]) {
       throw new Error(