jqtree 1.8.5 → 1.8.6

package/src/node.ts

@@ -4,20 +4,20 @@ import { Position } from "./position";
 type IterateCallback = (node: Node, level: number) => boolean;
 
 export class Node implements INode {
-    public id?: NodeId;
-    public name: string;
+    [key: string]: unknown;
+
     public children: Node[];
-    public parent: Node | null;
+    public element?: HTMLElement;
+    public id?: NodeId;
     public idMapping: Map<NodeId, Node>;
-    public tree?: Node;
-    public nodeClass?: typeof Node;
-    public load_on_demand: boolean;
-    public is_open: boolean;
-    public element: HTMLElement;
     public is_loading: boolean;
+    public is_open: boolean;
     public isEmptyFolder: boolean;
-
-    [key: string]: unknown;
+    public load_on_demand: boolean;
+    public name: string;
+    public nodeClass?: typeof Node;
+    public parent: Node | null;
+    public tree?: Node;
 
     constructor(
         nodeData: NodeData | null = null,
@@ -44,76 +44,59 @@ export class Node implements INode {
         }
     }
 
-    /*
-    Set the data of this node.
+    private createNode(nodeData?: NodeData): Node {
+        const nodeClass = this.getNodeClass();
+        return new nodeClass(nodeData);
+    }
 
-    setData(string): set the name of the node
-    setData(object): set attributes of the node
+    private doRemoveChild(node: Node): void {
+        this.children.splice(this.getChildIndex(node), 1);
+        this.tree?.removeNodeFromIndex(node);
+    }
 
-    Examples:
-        setData('node1')
+    private getNodeClass(): typeof Node {
+        return this.nodeClass ?? this.tree?.nodeClass ?? Node;
+    }
 
-        setData({ name: 'node1', id: 1});
+    // Load children data from nodeInfo if it has children
+    private loadChildrenFromData(nodeInfo: NodeData) {
+        if (isNodeRecordWithChildren(nodeInfo) && nodeInfo.children.length) {
+            this.loadFromData(nodeInfo.children);
+        }
+    }
 
-        setData({ name: 'node2', id: 2, color: 'green'});
+    private setParent(parent: Node): void {
+        this.parent = parent;
+        this.tree = parent.tree;
+        this.tree?.addNodeToIndex(this);
+    }
 
-    * This is an internal function; it is not in the docs
-    * Does not remove existing node values
-    */
-    public setData(o: NodeData | null): void {
-        if (!o) {
-            return;
-        } else 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];
+    public addAfter(nodeInfo: NodeData): Node | null {
+        if (!this.parent) {
+            return null;
+        } else {
+            const node = this.createNode(nodeInfo);
 
-                    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;
-                    }
-                }
-            }
+            const childIndex = this.parent.getChildIndex(this);
+            this.parent.addChildAtPosition(node, childIndex + 1);
+
+            node.loadChildrenFromData(nodeInfo);
+            return node;
         }
     }
 
-    /*
-    Create tree from data.
-
-    Structure of data is:
-    [
-        {
-            name: 'node1',
-            children: [
-                { name: 'child1' },
-                { name: 'child2' }
-            ]
-        },
-        {
-            name: 'node2'
-        }
-    ]
-    */
-    public loadFromData(data: NodeData[]): Node {
-        this.removeChildren();
+    public addBefore(nodeInfo: NodeData): Node | null {
+        if (!this.parent) {
+            return null;
+        } else {
+            const node = this.createNode(nodeInfo);
 
-        for (const childData of data) {
-            const node = this.createNode(childData);
-            this.addChild(node);
+            const childIndex = this.parent.getChildIndex(this);
+            this.parent.addChildAtPosition(node, childIndex);
 
-            if (isNodeRecordWithChildren(childData)) {
-                node.loadFromData(childData.children);
-            }
+            node.loadChildrenFromData(nodeInfo);
+            return node;
         }
-
-        return this;
     }
 
     /*
@@ -141,128 +124,62 @@ export class Node implements INode {
         node.setParent(this);
     }
 
-    /*
-    Remove child. This also removes the children of the node.
-
-    tree.removeChild(tree.children[0]);
-    */
-    public removeChild(node: Node): void {
-        // remove children from the index
-        node.removeChildren();
-
-        this.doRemoveChild(node);
+    public addNodeToIndex(node: Node): void {
+        if (node.id != null) {
+            this.idMapping.set(node.id, node);
+        }
     }
 
-    /*
-    Get child index.
-
-    var index = getChildIndex(node);
-    */
-    public getChildIndex(node: Node): number {
-        return this.children.indexOf(node);
-    }
+    public addParent(nodeInfo: NodeData): Node | null {
+        if (!this.parent) {
+            return null;
+        } else {
+            const newParent = this.createNode(nodeInfo);
 
-    /*
-    Does the tree have children?
+            if (this.tree) {
+                newParent.setParent(this.tree);
+            }
+            const originalParent = this.parent;
 
-    if (tree.hasChildren()) {
-        //
-    }
-    */
-    public hasChildren(): boolean {
-        return this.children.length !== 0;
-    }
+            for (const child of originalParent.children) {
+                newParent.addChild(child);
+            }
 
-    public isFolder(): boolean {
-        return this.hasChildren() || this.load_on_demand;
+            originalParent.children = [];
+            originalParent.addChild(newParent);
+            return newParent;
+        }
     }
 
-    /*
-    Iterate over all the nodes in the tree.
-
-    Calls callback with (node, level).
-
-    The callback must return true to continue the iteration on current node.
-
-    tree.iterate(
-        function(node, level) {
-           console.log(node.name);
+    public append(nodeInfo: NodeData): Node {
+        const node = this.createNode(nodeInfo);
+        this.addChild(node);
 
-           // stop iteration after level 2
-           return (level <= 2);
-        }
-    );
+        node.loadChildrenFromData(nodeInfo);
+        return node;
+    }
 
-    */
-    public iterate(callback: IterateCallback): void {
-        const _iterate = (node: Node, level: number): void => {
-            if (node.children) {
-                for (const child of node.children) {
-                    const result = callback(child, level);
+    public filter(f: (node: Node) => boolean): Node[] {
+        const result: Node[] = [];
 
-                    if (result && child.hasChildren()) {
-                        _iterate(child, level + 1);
-                    }
-                }
+        this.iterate((node: Node) => {
+            if (f(node)) {
+                result.push(node);
             }
-        };
 
-        _iterate(this, 0);
+            return true;
+        });
+
+        return result;
     }
 
     /*
-    Move node relative to another node.
-
-    Argument position: Position.BEFORE, Position.AFTER or Position.Inside
+    Get child index.
 
-    // move node1 after node2
-    tree.moveNode(node1, node2, Position.AFTER);
+    var index = getChildIndex(node);
     */
-    public moveNode(
-        movedNode: Node,
-        targetNode: Node,
-        position: Position,
-    ): boolean {
-        if (!movedNode.parent || movedNode.isParentOf(targetNode)) {
-            // - Node is parent of target node
-            // - Or, parent is empty
-            return false;
-        } else {
-            movedNode.parent.doRemoveChild(movedNode);
-
-            switch (position) {
-                case Position.After: {
-                    if (targetNode.parent) {
-                        targetNode.parent.addChildAtPosition(
-                            movedNode,
-                            targetNode.parent.getChildIndex(targetNode) + 1,
-                        );
-                        return true;
-                    }
-                    return false;
-                }
-
-                case Position.Before: {
-                    if (targetNode.parent) {
-                        targetNode.parent.addChildAtPosition(
-                            movedNode,
-                            targetNode.parent.getChildIndex(targetNode),
-                        );
-                        return true;
-                    }
-                    return false;
-                }
-
-                case Position.Inside: {
-                    // move inside as first child
-                    targetNode.addChildAtPosition(movedNode, 0);
-                    return true;
-                }
-
-                default:
-                    return false;
-            }
-        }
+    public getChildIndex(node: Node): number {
+        return this.children.indexOf(node);
     }
 
     /*
@@ -293,7 +210,7 @@ export class Node implements INode {
                 }
 
                 if (node.hasChildren()) {
-                    tmpNode["children"] = getDataFromNodes(node.children);
+                    tmpNode.children = getDataFromNodes(node.children);
                 }
 
                 return tmpNode;
@@ -307,121 +224,22 @@ export class Node implements INode {
         }
     }
 
-    public getNodeByName(name: string): Node | null {
-        return this.getNodeByCallback((node: Node) => node.name === name);
-    }
-
-    public getNodeByNameMustExist(name: string): Node {
-        const node = this.getNodeByCallback((n: Node) => n.name === name);
-
-        if (!node) {
-            throw `Node with name ${name} not found`;
-        }
-
-        return node;
-    }
-
-    public getNodeByCallback(callback: (node: Node) => boolean): Node | null {
-        let result: Node | null = null;
-
-        this.iterate((node: Node) => {
-            if (result) {
-                return false;
-            } else if (callback(node)) {
-                result = node;
-                return false;
-            } else {
-                return true;
-            }
-        });
-
-        return result;
-    }
-
-    public addAfter(nodeInfo: NodeData): Node | null {
-        if (!this.parent) {
-            return null;
-        } else {
-            const node = this.createNode(nodeInfo);
-
-            const childIndex = this.parent.getChildIndex(this);
-            this.parent.addChildAtPosition(node, childIndex + 1);
-
-            node.loadChildrenFromData(nodeInfo);
-            return node;
-        }
-    }
-
-    public addBefore(nodeInfo: NodeData): Node | null {
-        if (!this.parent) {
-            return null;
-        } else {
-            const node = this.createNode(nodeInfo);
-
-            const childIndex = this.parent.getChildIndex(this);
-            this.parent.addChildAtPosition(node, childIndex);
-
-            node.loadChildrenFromData(nodeInfo);
-            return node;
-        }
-    }
-
-    public addParent(nodeInfo: NodeData): Node | null {
-        if (!this.parent) {
+    public getLastChild(): Node | null {
+        if (!this.hasChildren()) {
             return null;
         } else {
-            const newParent = this.createNode(nodeInfo);
-
-            if (this.tree) {
-                newParent.setParent(this.tree);
-            }
-            const originalParent = this.parent;
+            const lastChild = this.children[this.children.length - 1];
 
-            for (const child of originalParent.children) {
-                newParent.addChild(child);
+            if (!lastChild) {
+                return null;
             }
 
-            originalParent.children = [];
-            originalParent.addChild(newParent);
-            return newParent;
-        }
-    }
-
-    public remove(): void {
-        if (this.parent) {
-            this.parent.removeChild(this);
-            this.parent = null;
-        }
-    }
-
-    public append(nodeInfo: NodeData): Node {
-        const node = this.createNode(nodeInfo);
-        this.addChild(node);
-
-        node.loadChildrenFromData(nodeInfo);
-        return node;
-    }
-
-    public prepend(nodeInfo: NodeData): Node {
-        const node = this.createNode(nodeInfo);
-        this.addChildAtPosition(node, 0);
-
-        node.loadChildrenFromData(nodeInfo);
-        return node;
-    }
-
-    public isParentOf(node: Node): boolean {
-        let parent = node.parent;
-
-        while (parent) {
-            if (parent === this) {
-                return true;
+            if (!(lastChild.hasChildren() && lastChild.is_open)) {
+                return lastChild;
+            } else {
+                return lastChild.getLastChild();
             }
-
-            parent = parent.parent;
         }
-
-        return false;
     }
 
     public getLevel(): number {
@@ -436,40 +254,18 @@ export class Node implements INode {
         return level;
     }
 
-    public getNodeById(nodeId: NodeId): Node | null {
-        return this.idMapping.get(nodeId) || null;
-    }
-
-    public addNodeToIndex(node: Node): void {
-        if (node.id != null) {
-            this.idMapping.set(node.id, node);
-        }
-    }
-
-    public removeNodeFromIndex(node: Node): void {
-        if (node.id != null) {
-            this.idMapping.delete(node.id);
-        }
-    }
-
-    public removeChildren(): void {
-        this.iterate((child: Node) => {
-            this.tree?.removeNodeFromIndex(child);
-            return true;
-        });
-
-        this.children = [];
-    }
-
-    public getPreviousSibling(): Node | null {
-        if (!this.parent) {
+    public getNextNode(includeChildren = true): Node | null {
+        if (includeChildren && this.hasChildren()) {
+            return this.children[0] ?? null;
+        } else if (!this.parent) {
             return null;
         } else {
-            const previousIndex = this.parent.getChildIndex(this) - 1;
-            if (previousIndex >= 0) {
-                return this.parent.children[previousIndex] || null;
+            const nextSibling = this.getNextSibling();
+
+            if (nextSibling) {
+                return nextSibling;
             } else {
-                return null;
+                return this.parent.getNextNode(false);
             }
         }
     }
@@ -480,51 +276,17 @@ export class Node implements INode {
         } else {
             const nextIndex = this.parent.getChildIndex(this) + 1;
             if (nextIndex < this.parent.children.length) {
-                return this.parent.children[nextIndex] || null;
+                return this.parent.children[nextIndex] ?? null;
             } else {
                 return null;
             }
         }
     }
 
-    public getNodesByProperty(key: string, value: unknown): Node[] {
-        return this.filter((node: Node) => node[key] === value);
-    }
-
-    public filter(f: (node: Node) => boolean): Node[] {
-        const result: Node[] = [];
-
-        this.iterate((node: Node) => {
-            if (f(node)) {
-                result.push(node);
-            }
-
-            return true;
-        });
-
-        return result;
-    }
-
-    public getNextNode(includeChildren = true): Node | null {
-        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);
-            }
-        }
-    }
-
     public getNextVisibleNode(): Node | null {
         if (this.hasChildren() && this.is_open) {
             // First child
-            return this.children[0] || null;
+            return this.children[0] ?? null;
         } else {
             if (!this.parent) {
                 return null;
@@ -541,6 +303,57 @@ export class Node implements INode {
         }
     }
 
+    public getNodeByCallback(callback: (node: Node) => boolean): Node | null {
+        let result: Node | null = null;
+
+        this.iterate((node: Node) => {
+            if (result) {
+                return false;
+            } else if (callback(node)) {
+                result = node;
+                return false;
+            } else {
+                return true;
+            }
+        });
+
+        return result;
+    }
+
+    public getNodeById(nodeId: NodeId): Node | null {
+        return this.idMapping.get(nodeId) ?? null;
+    }
+
+    public getNodeByName(name: string): Node | null {
+        return this.getNodeByCallback((node: Node) => node.name === name);
+    }
+
+    public getNodeByNameMustExist(name: string): Node {
+        const node = this.getNodeByCallback((n: Node) => n.name === name);
+
+        if (!node) {
+            throw new Error(`Node with name ${name} not found`);
+        }
+
+        return node;
+    }
+
+    public getNodesByProperty(key: string, value: unknown): Node[] {
+        return this.filter((node: Node) => node[key] === value);
+    }
+
+    public getParent(): Node | null {
+        // 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 {
+            return this.parent;
+        }
+    }
+
     public getPreviousNode(): Node | null {
         if (!this.parent) {
             return null;
@@ -557,6 +370,19 @@ export class Node implements INode {
         }
     }
 
+    public getPreviousSibling(): Node | null {
+        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;
+            }
+        }
+    }
+
     public getPreviousVisibleNode(): Node | null {
         if (!this.parent) {
             return null;
@@ -578,34 +404,15 @@ export class Node implements INode {
         }
     }
 
-    public getParent(): Node | null {
-        // 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 {
-            return this.parent;
-        }
-    }
-
-    public getLastChild(): Node | null {
-        if (!this.hasChildren()) {
-            return null;
-        } else {
-            const lastChild = this.children[this.children.length - 1];
-
-            if (!lastChild) {
-                return null;
-            }
+    /*
+    Does the tree have children?
 
-            if (!(lastChild.hasChildren() && lastChild.is_open)) {
-                return lastChild;
-            } else {
-                return lastChild?.getLastChild();
-            }
-        }
+    if (tree.hasChildren()) {
+        //
+    }
+    */
+    public hasChildren(): boolean {
+        return this.children.length !== 0;
     }
 
     // Init Node from data without making it the root of the tree
@@ -632,30 +439,221 @@ export class Node implements INode {
         addNode(data);
     }
 
-    private setParent(parent: Node): void {
-        this.parent = parent;
-        this.tree = parent.tree;
-        this.tree?.addNodeToIndex(this);
+    public isFolder(): boolean {
+        return this.hasChildren() || this.load_on_demand;
     }
 
-    private doRemoveChild(node: Node): void {
-        this.children.splice(this.getChildIndex(node), 1);
-        this.tree?.removeNodeFromIndex(node);
+    public isParentOf(node: Node): boolean {
+        let parent = node.parent;
+
+        while (parent) {
+            if (parent === this) {
+                return true;
+            }
+
+            parent = parent.parent;
+        }
+
+        return false;
     }
 
-    private getNodeClass(): typeof Node {
-        return this.nodeClass || this?.tree?.nodeClass || Node;
+    /*
+    Iterate over all the nodes in the tree.
+
+    Calls callback with (node, level).
+
+    The callback must return true to continue the iteration on current node.
+
+    tree.iterate(
+        function(node, level) {
+           console.log(node.name);
+
+           // stop iteration after level 2
+           return (level <= 2);
+        }
+    );
+
+    */
+    public iterate(callback: IterateCallback): void {
+        const _iterate = (node: Node, level: number): void => {
+            for (const child of node.children) {
+                const result = callback(child, level);
+
+                if (result && child.hasChildren()) {
+                    _iterate(child, level + 1);
+                }
+            }
+        };
+
+        _iterate(this, 0);
     }
 
-    private createNode(nodeData?: NodeData): Node {
-        const nodeClass = this.getNodeClass();
-        return new nodeClass(nodeData);
+    /*
+    Create tree from data.
+
+    Structure of data is:
+    [
+        {
+            name: 'node1',
+            children: [
+                { name: 'child1' },
+                { name: 'child2' }
+            ]
+        },
+        {
+            name: 'node2'
+        }
+    ]
+    */
+    public loadFromData(data: NodeData[]): this {
+        this.removeChildren();
+
+        for (const childData of data) {
+            const node = this.createNode(childData);
+            this.addChild(node);
+
+            if (isNodeRecordWithChildren(childData)) {
+                node.loadFromData(childData.children);
+            }
+        }
+
+        return this;
     }
 
-    // Load children data from nodeInfo if it has children
-    private loadChildrenFromData(nodeInfo: NodeData) {
-        if (isNodeRecordWithChildren(nodeInfo) && nodeInfo.children.length) {
-            this.loadFromData(nodeInfo.children);
+    /*
+    Move node relative to another node.
+
+    Argument position: Position.BEFORE, Position.AFTER or Position.Inside
+
+    // move node1 after node2
+    tree.moveNode(node1, node2, Position.AFTER);
+    */
+    public moveNode(
+        movedNode: Node,
+        targetNode: Node,
+        position: Position,
+    ): boolean {
+        if (!movedNode.parent || movedNode.isParentOf(targetNode)) {
+            // - Node is parent of target node
+            // - Or, parent is empty
+            return false;
+        } else {
+            movedNode.parent.doRemoveChild(movedNode);
+
+            switch (position) {
+                case Position.After: {
+                    if (targetNode.parent) {
+                        targetNode.parent.addChildAtPosition(
+                            movedNode,
+                            targetNode.parent.getChildIndex(targetNode) + 1,
+                        );
+                        return true;
+                    }
+                    return false;
+                }
+
+                case Position.Before: {
+                    if (targetNode.parent) {
+                        targetNode.parent.addChildAtPosition(
+                            movedNode,
+                            targetNode.parent.getChildIndex(targetNode),
+                        );
+                        return true;
+                    }
+                    return false;
+                }
+
+                case Position.Inside: {
+                    // move inside as first child
+                    targetNode.addChildAtPosition(movedNode, 0);
+                    return true;
+                }
+
+                default:
+                    return false;
+            }
+        }
+    }
+
+    public prepend(nodeInfo: NodeData): Node {
+        const node = this.createNode(nodeInfo);
+        this.addChildAtPosition(node, 0);
+
+        node.loadChildrenFromData(nodeInfo);
+        return node;
+    }
+
+    public remove(): void {
+        if (this.parent) {
+            this.parent.removeChild(this);
+            this.parent = null;
+        }
+    }
+
+    /*
+    Remove child. This also removes the children of the node.
+
+    tree.removeChild(tree.children[0]);
+    */
+    public removeChild(node: Node): void {
+        // remove children from the index
+        node.removeChildren();
+
+        this.doRemoveChild(node);
+    }
+
+    public removeChildren(): void {
+        this.iterate((child: Node) => {
+            this.tree?.removeNodeFromIndex(child);
+            return true;
+        });
+
+        this.children = [];
+    }
+
+    public removeNodeFromIndex(node: Node): void {
+        if (node.id != null) {
+            this.idMapping.delete(node.id);
+        }
+    }
+
+    /*
+    Set the data of this node.
+
+    setData(string): set the name of the node
+    setData(object): set attributes of the node
+
+    Examples:
+        setData('node1')
+
+        setData({ name: 'node1', id: 1});
+
+        setData({ name: 'node2', id: 2, color: 'green'});
+
+    * This is an internal function; it is not in the docs
+    * Does not remove existing node values
+    */
+    public setData(o: NodeData | null): void {
+        if (!o) {
+            return;
+        } else 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;
+                    }
+                }
+            }
         }
     }
 }