Merge pull request #44 from philipstanislaus/fix-prototype-missing

feat: add option to assign to keep prototype, see #34

Author: philipstanislaus

README.md

@@ -70,6 +70,7 @@ You can provide a second argument to arrayToTree with configuration options. Rig
 - `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 or if the array of items contains items with a circular parent/child relationship. 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, or in the case of only circular item relationships a generic error. The function will throw an error if the number of nodes in the tree is smaller than the number of nodes in the original array. When disabled, the function will just ignore orphans and circular relationships 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}`
+- `assign`: Option that enables `Object.assign` instead of the spread operator to create an item in the tree when `dataField` is `null`. This is useful if your items have a prototype that should be maintained. If enabled and `dataField` is `null`, the original node item will be used, and the `children` property will be assigned, calling any setters on that field. If `dataField` is not `null`, this option has no effect, since the original node will be used under the `dataField` of a new object. If you are unsure whether you need to enable this, it's likely fine to leave it disabled. Default: `false`
 
 Example:
 

build/arrayToTree.d.ts

@@ -14,6 +14,7 @@ export interface Config {
         [rootParentId: string]: true;
     };
     nestedIds: boolean;
+    assign: boolean;
 }
 /**
  * Unflattens an array to a tree with runtime O(n)

build/arrayToTree.js

@@ -694,6 +694,65 @@ describe("arrayToTree", () => {
       },
     ]);
   });
+
+  it("should keep prototype if assign is enabled", () => {
+    const animal = {
+      legs() {
+        return 4;
+      },
+    };
+
+    const mom = Object.create(animal);
+    mom.id = "mom";
+    mom.parentId = null;
+    const kitty = Object.create(animal);
+    kitty.id = "kitty";
+    kitty.parentId = "mom";
+
+    const tree = arrayToTree([mom, kitty], { dataField: null, assign: true });
+
+    expect(tree).to.deep.equal([mom]);
+
+    expect(tree[0].__proto__).to.deep.equal(animal);
+
+    expect(tree[0].legs()).to.equal(4);
+  });
+
+  it("should not keep prototype if assign is disabled", () => {
+    const animal = {
+      legs() {
+        return 4;
+      },
+    };
+
+    const mom = Object.create(animal);
+    mom.id = "mom";
+    mom.parentId = null;
+    const kitty = Object.create(animal);
+    kitty.id = "kitty";
+    kitty.parentId = "mom";
+
+    const tree = arrayToTree([mom, kitty], { dataField: null, assign: false });
+
+    expect(tree).to.deep.equal([
+      {
+        id: "mom",
+        parentId: null,
+        children: [
+          {
+            id: "kitty",
+            parentId: "mom",
+            children: [],
+          },
+        ],
+      },
+    ]);
+
+    expect(mom.legs()).to.equal(4);
+
+    expect(tree[0].__proto__).to.deep.equal(Object.prototype);
+    expect(tree[0].legs).to.equal(undefined);
+  });
 });
 
 describe("countNodes", () => {

build/arrayToTree.js.map

@@ -14,6 +14,7 @@ export interface Config {
   throwIfOrphans: boolean;
   rootParentIds: { [rootParentId: string]: true }; // use an object here for fast lookups
   nestedIds: boolean;
+  assign: boolean;
 }
 
 const defaultConfig: Config = {
@@ -24,6 +25,7 @@ const defaultConfig: Config = {
   throwIfOrphans: false,
   rootParentIds: { "": true },
   nestedIds: true,
+  assign: false,
 };
 
 /**
@@ -84,6 +86,10 @@ export function arrayToTree(
     // add the current item's data to the item in the lookup table
     if (conf.dataField) {
       lookup[itemId][conf.dataField] = item;
+    } else if (conf.assign) {
+      lookup[itemId] = Object.assign(item, {
+        [conf.childrenField]: lookup[itemId][conf.childrenField],
+      });
     } else {
       lookup[itemId] = {
         ...item,

build/arrayToTree.min.js

@@ -1,6 +1,7 @@
 {
   "extends": ["tslint:latest", "tslint-config-prettier"],
   "rules": {
-    "no-implicit-dependencies": [true, "dev"]
+    "no-implicit-dependencies": [true, "dev"],
+    "prefer-object-spread": false
   }
 }