@itwin/components-react 3.4.0-dev.9 → 3.4.1

package/lib/esm/components-react/tree/controlled/TreeModel.js

@@ -1,311 +1,324 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Tree
- */
-var _a;
-import { immerable } from "immer";
-import _ from "lodash";
-import { assert } from "@itwin/core-bentley";
-import { CheckBoxState } from "@itwin/core-react";
-import { SparseTree } from "./internal/SparseTree";
-/**
- * Checks if object is [[TreeModelNode]]
- * @public
- */
-export function isTreeModelNode(obj) {
-    return obj !== undefined && !isTreeModelNodePlaceholder(obj) && !isTreeModelRootNode(obj);
-}
-/**
- * Checks if object is [[TreeModelNodePlaceholder]]
- * @public
- */
-export function isTreeModelNodePlaceholder(obj) {
-    return obj !== undefined && "childIndex" in obj;
-}
-/**
- * Checks if object is [[TreeModelRootNode]]
- * @public
- */
-export function isTreeModelRootNode(obj) {
-    return obj !== undefined && obj.id === undefined && !("childIndex" in obj);
-}
-/**
- * Mutable tree model which holds nodes and allows adding or removing them.
- * @public
- */
-export class MutableTreeModel {
-    constructor() {
-        this[_a] = true;
-        this._tree = new SparseTree();
-        this._rootNode = { depth: -1, id: undefined, numChildren: undefined };
-    }
-    /** Returns root node of a tree. This node is not visible and is there to allow having multiple visible root nodes. */
-    getRootNode() {
-        return this._rootNode;
-    }
-    getNode(nodeId, childIndex) {
-        if (childIndex === undefined) {
-            return this._tree.getNode(nodeId);
-        }
-        const children = this._tree.getChildren(nodeId);
-        const childId = children !== undefined ? children.get(childIndex) : undefined;
-        if (childId !== undefined) {
-            return this._tree.getNode(childId);
-        }
-        const parentNode = nodeId === undefined ? this._rootNode : this._tree.getNode(nodeId);
-        if (parentNode !== undefined) {
-            return {
-                childIndex,
-                depth: parentNode.depth + 1,
-                parentId: nodeId,
-            };
-        }
-        return undefined;
-    }
-    /** Returns children for specific parent.
-     * @param parentId id of parent node.
-     * @returns children of parent node or root nodes if undefined is passed as parent id.
-     */
-    getChildren(parentId) {
-        return this._tree.getChildren(parentId);
-    }
-    /** Returns children offset in children array for specific parent. */
-    getChildOffset(parentId, childId) {
-        return this._tree.getChildOffset(parentId, childId);
-    }
-    /**
-     * Sets children for parent node starting from the specific offset.
-     * If offset overlaps with already added nodes, the overlapping nodes are overwritten.
-     */
-    setChildren(parentId, nodeInputs, offset) {
-        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
-        if (parentNode === undefined)
-            return;
-        const children = [];
-        for (const input of nodeInputs) {
-            const child = MutableTreeModel.createTreeModelNode(parentNode, input);
-            children.push(child);
-        }
-        this._tree.setChildren(parentNode.id, children, offset);
-        MutableTreeModel.setNumChildrenForNode(parentNode, this._tree.getChildren(parentNode.id));
-    }
-    /**
-     * Inserts child in the specified position.
-     * If offset is higher then current length of children array, the length is increased.
-     */
-    insertChild(parentId, childNodeInput, offset) {
-        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
-        if (parentNode === undefined)
-            return;
-        const child = MutableTreeModel.createTreeModelNode(parentNode, childNodeInput);
-        this._tree.insertChild(parentNode.id, child, offset);
-        MutableTreeModel.setNumChildrenForNode(parentNode, this._tree.getChildren(parentNode.id));
-    }
-    /**
-     * Changes the id of target node.
-     * @returns `true` on success, `false` otherwise.
-     */
-    changeNodeId(currentId, newId) {
-        var _b, _c;
-        const node = this.getNode(currentId);
-        if (node === undefined) {
-            return false;
-        }
-        if (currentId === newId) {
-            return true;
-        }
-        const index = this.getChildOffset(node.parentId, currentId);
-        assert(index !== undefined);
-        if (!this._tree.setNodeId(node.parentId, index, newId)) {
-            return false;
-        }
-        node.id = newId; // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
-        for (const [childId] of (_c = (_b = this.getChildren(newId)) === null || _b === void 0 ? void 0 : _b.iterateValues()) !== null && _c !== void 0 ? _c : []) {
-            const child = this.getNode(childId);
-            assert(child !== undefined);
-            child.parentId = newId;
-        }
-        return true;
-    }
-    /**
-     * Transfers node along with its children to a new location. Fails if destination has undefined child count.
-     * @param sourceNodeId Node that is being moved.
-     * @param targetParentId Node that will receive a new child.
-     * @param targetIndex Insertion location among target's *current* children.
-     * @returns `true` on success, `false` otherwise.
-     */
-    moveNode(sourceNodeId, targetParentId, targetIndex) {
-        const sourceNode = this.getNode(sourceNodeId);
-        if (sourceNode === undefined) {
-            return false;
-        }
-        const targetParent = targetParentId === undefined ? this._rootNode : this.getNode(targetParentId);
-        if (targetParent === undefined || targetParent.numChildren === undefined) {
-            return false;
-        }
-        if (targetParentId !== undefined && this.areNodesRelated(sourceNodeId, targetParentId)) {
-            return false;
-        }
-        this._tree.moveNode(sourceNode.parentId, sourceNodeId, targetParentId, targetIndex);
-        const sourceParent = sourceNode.parentId === undefined ? this._rootNode : this.getNode(sourceNode.parentId);
-        assert(sourceParent !== undefined);
-        MutableTreeModel.setNumChildrenForNode(sourceParent, this._tree.getChildren(sourceNode.parentId));
-        MutableTreeModel.setNumChildrenForNode(targetParent, this._tree.getChildren(targetParentId));
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-        sourceNode.parentId = targetParentId;
-        const updateDepths = (parentId, depth) => {
-            var _b, _c;
-            const node = this.getNode(parentId);
-            assert(node !== undefined);
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-            node.depth = depth;
-            for (const [nodeId] of (_c = (_b = this.getChildren(parentId)) === null || _b === void 0 ? void 0 : _b.iterateValues()) !== null && _c !== void 0 ? _c : []) {
-                updateDepths(nodeId, depth + 1);
-            }
-        };
-        updateDepths(sourceNodeId, targetParent.depth + 1);
-        return true;
-    }
-    areNodesRelated(ancestorNodeId, descendantNodeId) {
-        const node = this.getNode(descendantNodeId);
-        if (node === undefined || node.parentId === undefined) {
-            return false;
-        }
-        return node.parentId === ancestorNodeId ? true : this.areNodesRelated(ancestorNodeId, node.parentId);
-    }
-    /**
-     * Sets the number of child nodes a parent is expected to contain. All child nodes of this parent will be subsequently
-     * removed.
-     */
-    setNumChildren(parentId, numChildren) {
-        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
-        if (parentNode === undefined) {
-            return;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-        parentNode.numChildren = numChildren;
-        this._tree.setNumChildren(parentId, numChildren !== null && numChildren !== void 0 ? numChildren : 0);
-    }
-    /** Removes children specified by id.
-     * @param parentId id of the parent node.
-     * @param child child node id or index that should be removed.
-     */
-    removeChild(parentId, child) {
-        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
-        this._tree.removeChild(parentId, child);
-        // istanbul ignore else
-        if (parentNode)
-            MutableTreeModel.setNumChildrenForNode(parentNode, this._tree.getChildren(parentNode.id));
-    }
-    /** Removes all children for parent specified by id.
-     * @param parentId id of parent node or undefined to remove root nodes.
-     */
-    clearChildren(parentId) {
-        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
-        if (parentNode !== undefined) {
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-            parentNode.numChildren = undefined;
-        }
-        this._tree.deleteSubtree(parentId, false);
-    }
-    /** Iterates over all nodes present in the tree model. */
-    *iterateTreeModelNodes(parentId) {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const _this = this;
-        function* iterateDescendants(subParentId) {
-            const children = _this.getChildren(subParentId);
-            if (children === undefined) {
-                return;
-            }
-            for (const [nodeId] of children.iterateValues()) {
-                const node = _this.getNode(nodeId);
-                if (node !== undefined) {
-                    yield node;
-                    yield* iterateDescendants(nodeId);
-                }
-            }
-        }
-        yield* iterateDescendants(parentId);
-    }
-    static setNumChildrenForNode(node, children) {
-        const numChildren = children ? children.getLength() : undefined;
-        if (node.numChildren === numChildren)
-            return;
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-        node.numChildren = numChildren;
-    }
-    static createTreeModelNode(parentNode, input) {
-        return {
-            id: input.id,
-            parentId: parentNode.id,
-            depth: parentNode.depth + 1,
-            isLoading: input.isLoading,
-            numChildren: input.numChildren,
-            description: input.description || "",
-            isExpanded: input.isExpanded,
-            label: input.label,
-            isSelected: input.isSelected,
-            checkbox: {
-                state: input.item.checkBoxState || CheckBoxState.Off,
-                isDisabled: !!input.item.isCheckboxDisabled,
-                isVisible: !!input.item.isCheckboxVisible,
-            },
-            item: _.cloneDeep(input.item),
-        };
-    }
-}
-_a = immerable;
-/**
- * Generates flat list of visible nodes in the tree model.
- * @public
- */
-export function computeVisibleNodes(model) {
-    const result = getVisibleDescendants(model, model.getRootNode());
-    return {
-        getNumNodes: () => result.length,
-        getAtIndex: (index) => {
-            return result[index];
-        },
-        getModel: () => model,
-        getNumRootNodes: () => model.getRootNode().numChildren,
-        [Symbol.iterator]: () => result[Symbol.iterator](),
-        getIndexOfNode: (nodeId) => {
-            return result.findIndex((visibleNode) => visibleNode.id === nodeId);
-        },
-    };
-}
-/**
- * Traverses the tree and collects visible descendants.
- * @internal
- */
-export function getVisibleDescendants(model, parentNode, result = []) {
-    const children = model.getChildren(parentNode.id);
-    if (!children) {
-        return result;
-    }
-    let index = 0;
-    for (const childId of children) {
-        if (childId === undefined) {
-            result.push({ parentId: parentNode.id, depth: parentNode.depth + 1, childIndex: index });
-        }
-        else {
-            const childNode = model.getNode(childId);
-            if (childNode === undefined) {
-                // node was disposed
-                result.push({ parentId: parentNode.id, depth: parentNode.depth + 1, childIndex: index });
-            }
-            else {
-                result.push(childNode);
-                if (childNode.isExpanded && childNode.numChildren !== undefined) {
-                    getVisibleDescendants(model, childNode, result);
-                }
-            }
-        }
-        ++index;
-    }
-    return result;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tree
+ */
+var _a;
+import { immerable } from "immer";
+import _ from "lodash";
+import { assert } from "@itwin/core-bentley";
+import { CheckBoxState } from "@itwin/core-react";
+import { SparseTree } from "./internal/SparseTree";
+/**
+ * Checks if object is [[TreeModelNode]]
+ * @public
+ */
+export function isTreeModelNode(obj) {
+    return obj !== undefined && !isTreeModelNodePlaceholder(obj) && !isTreeModelRootNode(obj);
+}
+/**
+ * Checks if object is [[TreeModelNodePlaceholder]]
+ * @public
+ */
+export function isTreeModelNodePlaceholder(obj) {
+    return obj !== undefined && "childIndex" in obj;
+}
+/**
+ * Checks if object is [[TreeModelRootNode]]
+ * @public
+ */
+export function isTreeModelRootNode(obj) {
+    return obj !== undefined && obj.id === undefined && !("childIndex" in obj);
+}
+/**
+ * Mutable tree model which holds nodes and allows adding or removing them.
+ * @public
+ */
+export class MutableTreeModel {
+    constructor(seed) {
+        this[_a] = true;
+        this._tree = new SparseTree();
+        this._rootNode = { depth: -1, id: undefined, numChildren: undefined };
+        if (!seed) {
+            return;
+        }
+        cloneSubree(seed, this, undefined);
+    }
+    /** Returns root node of a tree. This node is not visible and is there to allow having multiple visible root nodes. */
+    getRootNode() {
+        return this._rootNode;
+    }
+    getNode(nodeId, childIndex) {
+        if (childIndex === undefined) {
+            return this._tree.getNode(nodeId);
+        }
+        const children = this._tree.getChildren(nodeId);
+        const childId = children !== undefined ? children.get(childIndex) : undefined;
+        if (childId !== undefined) {
+            return this._tree.getNode(childId);
+        }
+        const parentNode = nodeId === undefined ? this._rootNode : this._tree.getNode(nodeId);
+        if (parentNode !== undefined) {
+            return {
+                childIndex,
+                depth: parentNode.depth + 1,
+                parentId: nodeId,
+            };
+        }
+        return undefined;
+    }
+    /** Returns children for specific parent.
+     * @param parentId id of parent node.
+     * @returns children of parent node or root nodes if undefined is passed as parent id.
+     */
+    getChildren(parentId) {
+        return this._tree.getChildren(parentId);
+    }
+    /** Returns children offset in children array for specific parent. */
+    getChildOffset(parentId, childId) {
+        return this._tree.getChildOffset(parentId, childId);
+    }
+    /**
+     * Sets children for parent node starting from the specific offset.
+     * If offset overlaps with already added nodes, the overlapping nodes are overwritten.
+     */
+    setChildren(parentId, nodeInputs, offset) {
+        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
+        if (parentNode === undefined)
+            return;
+        const children = [];
+        for (const input of nodeInputs) {
+            const child = MutableTreeModel.createTreeModelNode(parentNode, input);
+            children.push(child);
+        }
+        this._tree.setChildren(parentNode.id, children, offset);
+        MutableTreeModel.setNumChildrenForNode(parentNode, this._tree.getChildren(parentNode.id));
+    }
+    /**
+     * Inserts child in the specified position.
+     * If offset is higher then current length of children array, the length is increased.
+     */
+    insertChild(parentId, childNodeInput, offset) {
+        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
+        if (parentNode === undefined)
+            return;
+        const child = MutableTreeModel.createTreeModelNode(parentNode, childNodeInput);
+        this._tree.insertChild(parentNode.id, child, offset);
+        MutableTreeModel.setNumChildrenForNode(parentNode, this._tree.getChildren(parentNode.id));
+    }
+    /**
+     * Changes the id of target node.
+     * @returns `true` on success, `false` otherwise.
+     */
+    changeNodeId(currentId, newId) {
+        var _b, _c;
+        const node = this.getNode(currentId);
+        if (node === undefined) {
+            return false;
+        }
+        if (currentId === newId) {
+            return true;
+        }
+        const index = this.getChildOffset(node.parentId, currentId);
+        assert(index !== undefined);
+        if (!this._tree.setNodeId(node.parentId, index, newId)) {
+            return false;
+        }
+        node.id = newId; // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
+        for (const [childId] of (_c = (_b = this.getChildren(newId)) === null || _b === void 0 ? void 0 : _b.iterateValues()) !== null && _c !== void 0 ? _c : []) {
+            const child = this.getNode(childId);
+            assert(child !== undefined);
+            child.parentId = newId;
+        }
+        return true;
+    }
+    /**
+     * Transfers node along with its children to a new location. Fails if destination has undefined child count.
+     * @param sourceNodeId Node that is being moved.
+     * @param targetParentId Node that will receive a new child.
+     * @param targetIndex Insertion location among target's *current* children.
+     * @returns `true` on success, `false` otherwise.
+     */
+    moveNode(sourceNodeId, targetParentId, targetIndex) {
+        const sourceNode = this.getNode(sourceNodeId);
+        if (sourceNode === undefined) {
+            return false;
+        }
+        const targetParent = targetParentId === undefined ? this._rootNode : this.getNode(targetParentId);
+        if (targetParent === undefined || targetParent.numChildren === undefined) {
+            return false;
+        }
+        if (targetParentId !== undefined && this.areNodesRelated(sourceNodeId, targetParentId)) {
+            return false;
+        }
+        this._tree.moveNode(sourceNode.parentId, sourceNodeId, targetParentId, targetIndex);
+        const sourceParent = sourceNode.parentId === undefined ? this._rootNode : this.getNode(sourceNode.parentId);
+        assert(sourceParent !== undefined);
+        MutableTreeModel.setNumChildrenForNode(sourceParent, this._tree.getChildren(sourceNode.parentId));
+        MutableTreeModel.setNumChildrenForNode(targetParent, this._tree.getChildren(targetParentId));
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        sourceNode.parentId = targetParentId;
+        const updateDepths = (parentId, depth) => {
+            var _b, _c;
+            const node = this.getNode(parentId);
+            assert(node !== undefined);
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+            node.depth = depth;
+            for (const [nodeId] of (_c = (_b = this.getChildren(parentId)) === null || _b === void 0 ? void 0 : _b.iterateValues()) !== null && _c !== void 0 ? _c : []) {
+                updateDepths(nodeId, depth + 1);
+            }
+        };
+        updateDepths(sourceNodeId, targetParent.depth + 1);
+        return true;
+    }
+    areNodesRelated(ancestorNodeId, descendantNodeId) {
+        const node = this.getNode(descendantNodeId);
+        if (node === undefined || node.parentId === undefined) {
+            return false;
+        }
+        return node.parentId === ancestorNodeId ? true : this.areNodesRelated(ancestorNodeId, node.parentId);
+    }
+    /**
+     * Sets the number of child nodes a parent is expected to contain. All child nodes of this parent will be subsequently
+     * removed.
+     */
+    setNumChildren(parentId, numChildren) {
+        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
+        if (parentNode === undefined) {
+            return;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        parentNode.numChildren = numChildren;
+        this._tree.setNumChildren(parentId, numChildren !== null && numChildren !== void 0 ? numChildren : 0);
+    }
+    /** Removes children specified by id.
+     * @param parentId id of the parent node.
+     * @param child child node id or index that should be removed.
+     */
+    removeChild(parentId, child) {
+        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
+        this._tree.removeChild(parentId, child);
+        // istanbul ignore else
+        if (parentNode)
+            MutableTreeModel.setNumChildrenForNode(parentNode, this._tree.getChildren(parentNode.id));
+    }
+    /** Removes all children for parent specified by id.
+     * @param parentId id of parent node or undefined to remove root nodes.
+     */
+    clearChildren(parentId) {
+        const parentNode = parentId === undefined ? this._rootNode : this._tree.getNode(parentId);
+        if (parentNode !== undefined) {
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+            parentNode.numChildren = undefined;
+        }
+        this._tree.deleteSubtree(parentId, false);
+    }
+    /** Iterates over all nodes present in the tree model. */
+    *iterateTreeModelNodes(parentId) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const _this = this;
+        function* iterateDescendants(subParentId) {
+            const children = _this.getChildren(subParentId);
+            if (children === undefined) {
+                return;
+            }
+            for (const [nodeId] of children.iterateValues()) {
+                const node = _this.getNode(nodeId);
+                if (node !== undefined) {
+                    yield node;
+                    yield* iterateDescendants(nodeId);
+                }
+            }
+        }
+        yield* iterateDescendants(parentId);
+    }
+    static setNumChildrenForNode(node, children) {
+        const numChildren = children ? children.getLength() : undefined;
+        if (node.numChildren === numChildren)
+            return;
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        node.numChildren = numChildren;
+    }
+    static createTreeModelNode(parentNode, input) {
+        return {
+            id: input.id,
+            parentId: parentNode.id,
+            depth: parentNode.depth + 1,
+            isLoading: input.isLoading,
+            numChildren: input.numChildren,
+            description: input.description || "",
+            isExpanded: input.isExpanded,
+            label: input.label,
+            isSelected: input.isSelected,
+            checkbox: {
+                state: input.item.checkBoxState || CheckBoxState.Off,
+                isDisabled: !!input.item.isCheckboxDisabled,
+                isVisible: !!input.item.isCheckboxVisible,
+            },
+            item: _.cloneDeep(input.item),
+        };
+    }
+}
+_a = immerable;
+/**
+ * Generates flat list of visible nodes in the tree model.
+ * @public
+ */
+export function computeVisibleNodes(model) {
+    const result = getVisibleDescendants(model, model.getRootNode());
+    return {
+        getNumNodes: () => result.length,
+        getAtIndex: (index) => {
+            return result[index];
+        },
+        getModel: () => model,
+        getNumRootNodes: () => model.getRootNode().numChildren,
+        [Symbol.iterator]: () => result[Symbol.iterator](),
+        getIndexOfNode: (nodeId) => {
+            return result.findIndex((visibleNode) => visibleNode.id === nodeId);
+        },
+    };
+}
+/**
+ * Traverses the tree and collects visible descendants.
+ * @internal
+ */
+export function getVisibleDescendants(model, parentNode, result = []) {
+    const children = model.getChildren(parentNode.id);
+    if (!children) {
+        return result;
+    }
+    let index = 0;
+    for (const childId of children) {
+        if (childId === undefined) {
+            result.push({ parentId: parentNode.id, depth: parentNode.depth + 1, childIndex: index });
+        }
+        else {
+            const childNode = model.getNode(childId);
+            if (childNode === undefined) {
+                // node was disposed
+                result.push({ parentId: parentNode.id, depth: parentNode.depth + 1, childIndex: index });
+            }
+            else {
+                result.push(childNode);
+                if (childNode.isExpanded && childNode.numChildren !== undefined) {
+                    getVisibleDescendants(model, childNode, result);
+                }
+            }
+        }
+        ++index;
+    }
+    return result;
+}
+function cloneSubree(source, target, parentId) {
+    var _b, _c;
+    target.setNumChildren(parentId, (parentId === undefined ? source.getRootNode() : source.getNode(parentId)).numChildren);
+    for (const [childId, index] of (_c = (_b = source.getChildren(parentId)) === null || _b === void 0 ? void 0 : _b.iterateValues()) !== null && _c !== void 0 ? _c : []) {
+        const node = source.getNode(childId);
+        target.setChildren(parentId, [{ ...node, isLoading: !!node.isLoading }], index);
+        cloneSubree(source, target, childId);
+    }
+}
 //# sourceMappingURL=TreeModel.js.map