tree-element 0.1.1 → 0.3.0

package/lib/node.js

@@ -26,37 +26,62 @@ prefix-private-members: all
  * :::
  */
 class Node {
-  /** @hidden */
+  /**
+  @hidden
+  */
 
-  /** The child nodes. */
+  /**
+  The child nodes.
+  */
   children;
-  /** The `li` element, once the node is rendered. */
+  /** The `li` element, once the node is rendered. Nodes inside a closed
+   * folder are rendered when the folder is opened. */
   element;
-  /** The id from the node data. */
+  /**
+  The id from the node data.
+  */
   id;
-  /** @hidden */
+  /**
+  @hidden
+  */
   idMapping;
-  /** Whether the node's children are being fetched. */
+  /**
+  Whether the node's children are being fetched.
+  */
   is_loading;
-  /** Whether the folder is open. */
+  /**
+  Whether the folder is open.
+  */
   is_open;
-  /** Whether the node data had an empty `children` array. */
+  /**
+  Whether the node data had an empty `children` array.
+  */
   isEmptyFolder;
-  /** Whether the children still have to be fetched. */
-  load_on_demand;
-  /** The label. Also settable from the `label` key in node data. */
-  name;
-  /** @hidden */
+  /**
+  Whether the children still have to be fetched.
+  */
+  load_on_demand = false;
+  /**
+  The label. Also settable from the `label` key in node data.
+  */
+  name = "";
+  /**
+  @hidden
+  */
   nodeClass;
-  /** The parent; `null` for the root node. */
+  /**
+  The parent; `null` for the root node.
+  */
   parent;
-  /** The root node. */
+  /**
+  The root node.
+  */
   tree;
 
-  /** @hidden */
+  /**
+  @hidden
+  */
   constructor(nodeData = null, isRoot = false, nodeClass = Node) {
-    this.name = "";
-    this.load_on_demand = false;
     this.isEmptyFolder = nodeData != null && isNodeRecordWithChildren(nodeData) && nodeData.children.length === 0;
     this.setData(nodeData);
     this.children = [];
@@ -79,15 +104,14 @@ class Node {
    * @group Changing the tree
    */
   addAfter(nodeInfo) {
-    if (!this.parent) {
-      return null;
-    } else {
-      const node = this._createNode(nodeInfo);
-      const childIndex = this.parent.getChildIndex(this);
+    if (this.parent) {
+      let node = this._createNode(nodeInfo);
+      let childIndex = this.parent.getChildIndex(this);
       this.parent.addChildAtPosition(node, childIndex + 1);
       node._loadChildrenFromData(nodeInfo);
       return node;
     }
+    return null;
   }
 
   /**
@@ -97,15 +121,14 @@ class Node {
    * @group Changing the tree
    */
   addBefore(nodeInfo) {
-    if (!this.parent) {
-      return null;
-    } else {
-      const node = this._createNode(nodeInfo);
-      const childIndex = this.parent.getChildIndex(this);
+    if (this.parent) {
+      let node = this._createNode(nodeInfo);
+      let childIndex = this.parent.getChildIndex(this);
       this.parent.addChildAtPosition(node, childIndex);
       node._loadChildrenFromData(nodeInfo);
       return node;
     }
+    return null;
   }
 
   /**
@@ -129,7 +152,9 @@ class Node {
     node._setParent(this);
   }
 
-  /** @hidden */
+  /**
+  @hidden
+  */
   addNodeToIndex(node) {
     if (node.id != null) {
       this.idMapping?.set(node.id, node);
@@ -143,21 +168,20 @@ class Node {
    * @group Changing the tree
    */
   addParent(nodeInfo) {
-    if (!this.parent) {
-      return null;
-    } else {
-      const newParent = this._createNode(nodeInfo);
+    if (this.parent) {
+      let newParent = this._createNode(nodeInfo);
       if (this.tree) {
         newParent._setParent(this.tree);
       }
-      const originalParent = this.parent;
-      for (const child of originalParent.children) {
+      let originalParent = this.parent;
+      for (let child of originalParent.children) {
         newParent.addChild(child);
       }
       originalParent.children = [];
       originalParent.addChild(newParent);
       return newParent;
     }
+    return null;
   }
 
   /**
@@ -167,7 +191,7 @@ class Node {
    * @group Changing the tree
    */
   append(nodeInfo) {
-    const node = this._createNode(nodeInfo);
+    let node = this._createNode(nodeInfo);
     this.addChild(node);
     node._loadChildrenFromData(nodeInfo);
     return node;
@@ -185,7 +209,7 @@ class Node {
    * @group Searching
    */
   filter(f) {
-    const result = [];
+    let result = [];
     this.iterate(node => {
       if (f(node)) {
         result.push(node);
@@ -220,14 +244,15 @@ class Node {
    * @group Reading data back
    */
   getData(includeParent = false) {
-    const getDataFromNodes = nodes => {
+    let getDataFromNodes = nodes => {
       return nodes.map(node => {
-        const tmpNode = {};
-        for (const k in node) {
-          if (["parent", "children", "element", "idMapping", "load_on_demand", "nodeClass", "tree", "isEmptyFolder"].indexOf(k) === -1 && Object.prototype.hasOwnProperty.call(node, k)) {
-            const v = node[k];
-            tmpNode[k] = v;
+        let tmpNode = {};
+        for (let k in node) {
+          if (["children", "element", "idMapping", "isEmptyFolder", "load_on_demand", "nodeClass", "parent", "tree"].includes(k) || !Object.prototype.hasOwnProperty.call(node, k)) {
+            continue;
           }
+          let v = node[k];
+          tmpNode[k] = v;
         }
         if (node.hasChildren()) {
           tmpNode.children = getDataFromNodes(node.children);
@@ -235,11 +260,7 @@ class Node {
         return tmpNode;
       });
     };
-    if (includeParent) {
-      return getDataFromNodes([this]);
-    } else {
-      return getDataFromNodes(this.children);
-    }
+    return getDataFromNodes(includeParent ? [this] : this.children);
   }
 
   /**
@@ -249,16 +270,11 @@ class Node {
    * @group Moving around the tree
    */
   getLastChild() {
-    if (!this.hasChildren()) {
-      return null;
-    } else {
-      const lastChild = this.children[this.children.length - 1];
-      if (!(lastChild.hasChildren() && lastChild.is_open)) {
-        return lastChild;
-      } else {
-        return lastChild.getLastChild();
-      }
+    if (this.hasChildren()) {
+      let lastChild = this.children[this.children.length - 1];
+      return lastChild.hasChildren() && lastChild.is_open ? lastChild.getLastChild() : lastChild;
     }
+    return null;
   }
 
   /**
@@ -268,7 +284,7 @@ class Node {
    */
   getLevel() {
     let level = 0;
-    let node = this; // eslint-disable-line @typescript-eslint/no-this-alias
+    let node = this; // eslint-disable-line @typescript-eslint/no-this-alias, unicorn/no-this-assignment
 
     while (node.parent) {
       level += 1;
@@ -286,16 +302,12 @@ class Node {
   getNextNode(includeChildren = true) {
     if (includeChildren && this.hasChildren()) {
       return this.children[0] ?? null;
-    } else if (!this.parent) {
-      return null;
-    } else {
-      const nextSibling = this.getNextSibling();
-      if (nextSibling) {
-        return nextSibling;
-      } else {
-        return this.parent.getNextNode(false);
-      }
     }
+    if (this.parent) {
+      let nextSibling = this.getNextSibling();
+      return nextSibling ?? this.parent.getNextNode(false);
+    }
+    return null;
   }
 
   /**
@@ -304,16 +316,11 @@ class Node {
    * @group Moving around the tree
    */
   getNextSibling() {
-    if (!this.parent) {
-      return null;
-    } else {
-      const nextIndex = this.parent.getChildIndex(this) + 1;
-      if (nextIndex < this.parent.children.length) {
-        return this.parent.children[nextIndex] ?? null;
-      } else {
-        return null;
-      }
+    if (this.parent) {
+      let nextIndex = this.parent.getChildIndex(this) + 1;
+      return nextIndex < this.parent.children.length ? this.parent.children[nextIndex] ?? null : null;
     }
+    return null;
   }
 
   /**
@@ -326,20 +333,17 @@ class Node {
     if (this.hasChildren() && this.is_open) {
       // First child
       return this.children[0] ?? null;
-    } else {
-      if (!this.parent) {
-        return null;
-      } else {
-        const nextSibling = this.getNextSibling();
-        if (nextSibling) {
-          // Next sibling
-          return nextSibling;
-        } else {
-          // Next node of parent
-          return this.parent.getNextNode(false);
-        }
+    }
+    if (this.parent) {
+      let nextSibling = this.getNextSibling();
+      if (nextSibling) {
+        // Next sibling
+        return nextSibling;
       }
+      // Next node of parent
+      return this.parent.getNextNode(false);
     }
+    return null;
   }
 
   /**
@@ -352,12 +356,12 @@ class Node {
     this.iterate(node => {
       if (result) {
         return false;
-      } else if (callback(node)) {
+      }
+      if (callback(node)) {
         result = node;
         return false;
-      } else {
-        return true;
       }
+      return true;
     });
     return result;
   }
@@ -387,7 +391,7 @@ class Node {
    * @group Searching
    */
   getNodeByNameMustExist(name) {
-    const node = this.getNodeByCallback(n => n.name === name);
+    let node = this.getNodeByCallback(n => n.name === name);
     if (!node) {
       throw new Error(`Node with name ${name} not found`);
     }
@@ -413,12 +417,12 @@ class Node {
     // Return parent except if it is the root node
     if (!this.parent) {
       return null;
-    } else if (!this.parent.parent) {
-      // Root node -> null
-      return null;
-    } else {
+    }
+    if (this.parent.parent) {
       return this.parent;
     }
+    // Root node -> null
+    return null;
   }
 
   /**
@@ -428,18 +432,14 @@ class Node {
    * @group Moving around the tree
    */
   getPreviousNode() {
-    if (!this.parent) {
-      return null;
-    } else {
-      const previousSibling = this.getPreviousSibling();
+    if (this.parent) {
+      let previousSibling = this.getPreviousSibling();
       if (!previousSibling) {
         return this.getParent();
-      } else if (previousSibling.hasChildren()) {
-        return previousSibling.getLastChild();
-      } else {
-        return previousSibling;
       }
+      return previousSibling.hasChildren() ? previousSibling.getLastChild() : previousSibling;
     }
+    return null;
   }
 
   /**
@@ -448,16 +448,11 @@ class Node {
    * @group Moving around the tree
    */
   getPreviousSibling() {
-    if (!this.parent) {
-      return null;
-    } else {
-      const previousIndex = this.parent.getChildIndex(this) - 1;
-      if (previousIndex >= 0) {
-        return this.parent.children[previousIndex] ?? null;
-      } else {
-        return null;
-      }
+    if (this.parent) {
+      let previousIndex = this.parent.getChildIndex(this) - 1;
+      return previousIndex >= 0 ? this.parent.children[previousIndex] ?? null : null;
     }
+    return null;
   }
 
   /**
@@ -467,20 +462,19 @@ class Node {
    * @group Moving around the tree
    */
   getPreviousVisibleNode() {
-    if (!this.parent) {
-      return null;
-    } else {
-      const previousSibling = this.getPreviousSibling();
+    if (this.parent) {
+      let previousSibling = this.getPreviousSibling();
       if (!previousSibling) {
         return this.getParent();
-      } else if (!previousSibling.hasChildren() || !previousSibling.is_open) {
+      }
+      if (!previousSibling.hasChildren() || !previousSibling.is_open) {
         // Previous sibling
         return previousSibling;
-      } else {
-        // Last child of previous sibling
-        return previousSibling.getLastChild();
       }
+      // Last child of previous sibling
+      return previousSibling.getLastChild();
     }
+    return null;
   }
 
   /**
@@ -498,15 +492,15 @@ class Node {
    * @hidden
    */
   initFromData(data) {
-    const addNode = nodeData => {
+    let addNode = nodeData => {
       this.setData(nodeData);
       if (isNodeRecordWithChildren(nodeData) && nodeData.children.length) {
         addChildren(nodeData.children);
       }
     };
-    const addChildren = childrenData => {
-      for (const child of childrenData) {
-        const node = this._createNode();
+    let addChildren = childrenData => {
+      for (let child of childrenData) {
+        let node = this._createNode();
         node.initFromData(child);
         this.addChild(node);
       }
@@ -553,9 +547,9 @@ class Node {
    * @group Searching
    */
   iterate(callback) {
-    const _iterate = (node, level) => {
-      for (const child of node.children) {
-        const result = callback(child, level);
+    let _iterate = (node, level) => {
+      for (let child of node.children) {
+        let result = callback(child, level);
         if (result && child.hasChildren()) {
           _iterate(child, level + 1);
         }
@@ -571,8 +565,8 @@ class Node {
    */
   loadFromData(data) {
     this.removeChildren();
-    for (const childData of data) {
-      const node = this._createNode(childData);
+    for (let childData of data) {
+      let node = this._createNode(childData);
       this.addChild(node);
       if (isNodeRecordWithChildren(childData)) {
         node.loadFromData(childData.children);
@@ -594,32 +588,31 @@ class Node {
       // - Node is parent of target node
       // - Or, parent is empty
       return false;
-    } else {
-      movedNode.parent._doRemoveChild(movedNode);
-      switch (position) {
-        case "after":
-          {
-            if (targetNode.parent) {
-              targetNode.parent.addChildAtPosition(movedNode, targetNode.parent.getChildIndex(targetNode) + 1);
-              return true;
-            }
-            return false;
-          }
-        case "before":
-          {
-            if (targetNode.parent) {
-              targetNode.parent.addChildAtPosition(movedNode, targetNode.parent.getChildIndex(targetNode));
-              return true;
-            }
-            return false;
+    }
+    movedNode.parent._doRemoveChild(movedNode);
+    switch (position) {
+      case "after":
+        {
+          if (targetNode.parent) {
+            targetNode.parent.addChildAtPosition(movedNode, targetNode.parent.getChildIndex(targetNode) + 1);
+            return true;
           }
-        case "inside":
-          {
-            // move inside as first child
-            targetNode.addChildAtPosition(movedNode, 0);
+          return false;
+        }
+      case "before":
+        {
+          if (targetNode.parent) {
+            targetNode.parent.addChildAtPosition(movedNode, targetNode.parent.getChildIndex(targetNode));
             return true;
           }
-      }
+          return false;
+        }
+      case "inside":
+        {
+          // move inside as first child
+          targetNode.addChildAtPosition(movedNode, 0);
+          return true;
+        }
     }
   }
 
@@ -630,7 +623,7 @@ class Node {
    * @group Changing the tree
    */
   prepend(nodeInfo) {
-    const node = this._createNode(nodeInfo);
+    let node = this._createNode(nodeInfo);
     this.addChildAtPosition(node, 0);
     node._loadChildrenFromData(nodeInfo);
     return node;
@@ -642,10 +635,11 @@ class Node {
    * @group Changing the tree
    */
   remove() {
-    if (this.parent) {
-      this.parent.removeChild(this);
-      this.parent = null;
+    if (!this.parent) {
+      return;
     }
+    this.parent.removeChild(this);
+    this.parent = null;
   }
 
   /**
@@ -672,7 +666,9 @@ class Node {
     this.children = [];
   }
 
-  /** @hidden */
+  /**
+  @hidden
+  */
   removeNodeFromIndex(node) {
     if (node.id != null) {
       this.idMapping?.delete(node.id);
@@ -689,27 +685,29 @@ class Node {
   setData(o) {
     if (!o) {
       return;
-    } else if (typeof o === "string") {
+    }
+    if (typeof o === "string") {
       this.name = o;
     } else if (typeof o === "object") {
-      for (const key in o) {
-        if (Object.prototype.hasOwnProperty.call(o, key)) {
-          const value = o[key];
-          if (key === "label" || key === "name") {
-            // You can use the 'label' key instead of 'name'; this is a legacy feature
-            if (typeof value === "string") {
-              this.name = value;
-            }
-          } else if (key !== "children" && key !== "parent") {
-            // You can't update the children or the parent using this function
-            this[key] = value;
+      for (let key in o) {
+        if (!Object.prototype.hasOwnProperty.call(o, key)) {
+          continue;
+        }
+        let value = o[key];
+        if (key === "label" || key === "name") {
+          // You can use the 'label' key instead of 'name'; this is a legacy feature
+          if (typeof value === "string") {
+            this.name = value;
           }
+        } else if (key !== "children" && key !== "parent") {
+          // You can't update the children or the parent using this function
+          this[key] = value;
         }
       }
     }
   }
   _createNode(nodeData) {
-    const nodeClass = this._getNodeClass();
+    let nodeClass = this._getNodeClass();
     return new nodeClass(nodeData);
   }
   _doRemoveChild(node) {