@itwin/components-react 4.17.1 → 5.0.0-dev.2

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

@@ -0,0 +1,348 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { cloneDeep } from "lodash";
+import { assert } from "@itwin/core-bentley";
+import { SparseTree } from "./internal/SparseTree.js";
+import { CheckBoxState } from "../../common/CheckBoxState.js";
+/**
+ * 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) {
+        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 this.getChildren(newId)?.iterateValues() ?? []) {
+            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) => {
+            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 this.getChildren(parentId)?.iterateValues() ??
+                []) {
+                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 ?? 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);
+        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,
+            isSelectionDisabled: input.item.isSelectionDisabled,
+            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.
+ * @public
+ */
+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) {
+    target.setNumChildren(parentId, (parentId === undefined ? source.getRootNode() : source.getNode(parentId))
+        .numChildren);
+    for (const [childId, index] of source
+        .getChildren(parentId)
+        ?.iterateValues() ?? []) {
+        const node = source.getNode(childId);
+        target.setChildren(parentId, [{ ...node, isLoading: !!node.isLoading }], index);
+        cloneSubree(source, target, childId);
+    }
+}
+//# sourceMappingURL=TreeModel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TreeModel.js","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeModel.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAQ7C,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AA4H9D;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,GAAkC;IAElC,OAAO,CACL,GAAG,KAAK,SAAS;QACjB,CAAC,0BAA0B,CAAC,GAAG,CAAC;QAChC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CACxC,GAAkC;IAElC,OAAO,GAAG,KAAK,SAAS,IAAI,YAAY,IAAI,GAAG,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAkC;IAElC,OAAO,CACL,GAAG,KAAK,SAAS;QAChB,GAAyB,CAAC,EAAE,KAAK,SAAS;QAC3C,CAAC,CAAC,YAAY,IAAI,GAAG,CAAC,CACvB,CAAC;AACJ,CAAC;AAkDD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAU3B,YAAmB,IAAgB;QAT5B,QAAW,GAAG,IAAI,CAAC;QAElB,UAAK,GAAG,IAAI,UAAU,EAAwB,CAAC;QAC/C,cAAS,GAAsB;YACrC,KAAK,EAAE,CAAC,CAAC;YACT,EAAE,EAAE,SAAS;YACb,WAAW,EAAE,SAAS;SACvB,CAAC;QAGA,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO;QACT,CAAC;QAED,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,sHAAsH;IAC/G,WAAW;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAUM,OAAO,CACZ,MAA0B,EAC1B,UAAmB;QAEnB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAO,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,OAAO,GACX,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAChE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,UAAU,GACd,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO;gBACL,UAAU;gBACV,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,CAAC;gBAC3B,QAAQ,EAAE,MAAM;aACjB,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,WAAW,CAChB,QAA4B;QAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,qEAAqE;IAC9D,cAAc,CACnB,QAA4B,EAC5B,OAAe;QAEf,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,WAAW,CAChB,QAA4B,EAC5B,UAAgC,EAChC,MAAc;QAEd,MAAM,UAAU,GACd,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,UAAU,KAAK,SAAS;YAAE,OAAO;QAErC,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACtE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxD,gBAAgB,CAAC,qBAAqB,CACpC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CACtC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,WAAW,CAChB,QAA4B,EAC5B,cAAkC,EAClC,MAAc;QAEd,MAAM,UAAU,GACd,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,UAAU,KAAK,SAAS;YAAE,OAAO;QAErC,MAAM,KAAK,GAAG,gBAAgB,CAAC,mBAAmB,CAChD,UAAU,EACV,cAAc,CACf,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACrD,gBAAgB,CAAC,qBAAqB,CACpC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CACtC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAAiB,EAAE,KAAa;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC5D,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,CAAC;QAEA,IAAI,CAAC,EAAa,GAAG,KAAK,CAAC,CAAC,uEAAuE;QACpG,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;YACvE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;YAC3B,KAAK,CAAC,QAAmB,GAAG,KAAK,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CACb,YAAoB,EACpB,cAAkC,EAClC,WAAmB;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC9C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,YAAY,GAChB,cAAc,KAAK,SAAS;YAC1B,CAAC,CAAC,IAAI,CAAC,SAAS;YAChB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACnC,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IACE,cAAc,KAAK,SAAS;YAC5B,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,cAAc,CAAC,EAClD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,QAAQ,CACjB,UAAU,CAAC,QAAQ,EACnB,YAAY,EACZ,cAAc,EACd,WAAW,CACZ,CAAC;QAEF,MAAM,YAAY,GAChB,UAAU,CAAC,QAAQ,KAAK,SAAS;YAC/B,CAAC,CAAC,IAAI,CAAC,SAAS;YAChB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;QACnC,gBAAgB,CAAC,qBAAqB,CACpC,YAAY,EACZ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAC5C,CAAC;QACF,gBAAgB,CAAC,qBAAqB,CACpC,YAAY,EACZ,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC,CACvC,CAAC;QAEF,4EAA4E;QAC3E,UAAU,CAAC,QAA+B,GAAG,cAAc,CAAC;QAE7D,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,KAAa,EAAE,EAAE;YACvD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;YAC3B,4EAA4E;YAC3E,IAAI,CAAC,KAAgB,GAAG,KAAK,CAAC;YAC/B,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE;gBAChE,EAAE,EAAE,CAAC;gBACL,YAAY,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YAClC,CAAC;QACH,CAAC,CAAC;QAEF,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,eAAe,CACrB,cAAsB,EACtB,gBAAwB;QAExB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC5C,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,KAAK,cAAc;YACrC,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,cAAc,CACnB,QAA4B,EAC5B,WAA+B;QAE/B,MAAM,UAAU,GACd,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,4EAA4E;QAC3E,UAAU,CAAC,WAAkC,GAAG,WAAW,CAAC;QAC7D,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,WAAW,CAChB,QAA4B,EAC5B,KAAsB;QAEtB,MAAM,UAAU,GACd,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAExC,IAAI,UAAU;YACZ,gBAAgB,CAAC,qBAAqB,CACpC,UAAU,EACV,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CACtC,CAAC;IACN,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,QAA4B;QAC/C,MAAM,UAAU,GACd,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,4EAA4E;YAC3E,UAAU,CAAC,WAAkC,GAAG,SAAS,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,yDAAyD;IAClD,CAAC,qBAAqB,CAC3B,QAAiB;QAEjB,4DAA4D;QAC5D,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,QAAQ,CAAC,CAAC,kBAAkB,CAC1B,WAA+B;YAE/B,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAChD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,OAAO;YACT,CAAC;YAED,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,aAAa,EAAE,EAAE,CAAC;gBAChD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,MAAM,IAAI,CAAC;oBACX,KAAK,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBACpC,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAClC,IAA8C,EAC9C,QAAyC;QAEzC,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAChE,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW;YAAE,OAAO;QAE7C,4EAA4E;QAC3E,IAAI,CAAC,WAAkC,GAAG,WAAW,CAAC;IACzD,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAChC,UAA6C,EAC7C,KAAyB;QAEzB,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,QAAQ,EAAE,UAAU,CAAC,EAAE;YACvB,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,CAAC;YAE3B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,WAAW,EAAE,KAAK,CAAC,WAAW;YAE9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;YACpC,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,mBAAmB,EAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB;YAEnD,QAAQ,EAAE;gBACR,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,GAAG;gBACpD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB;gBAC3C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB;aAC1C;YAED,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;SAC5B,CAAC;IACJ,CAAC;CACF;KAtWS,SAAS;AAwWnB;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAgB;IAClD,MAAM,MAAM,GAAG,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IACjE,OAAO;QACL,WAAW,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM;QAChC,UAAU,EAAE,CACV,KAAa,EACyC,EAAE;YACxD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK;QACrB,eAAe,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,WAAW;QACtD,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;QAClD,cAAc,EAAE,CAAC,MAAc,EAAU,EAAE;YACzC,OAAO,MAAM,CAAC,SAAS,CACrB,CAAC,WAAW,EAAE,EAAE,CAAE,WAA6B,CAAC,EAAE,KAAK,MAAM,CAC9D,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAgB,EAChB,UAA6C,EAC7C,SAA0D,EAAE;IAE5D,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,UAAU,CAAC,EAAE;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,CAAC;gBAC3B,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACzC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,oBAAoB;gBACpB,MAAM,CAAC,IAAI,CAAC;oBACV,QAAQ,EAAE,UAAU,CAAC,EAAE;oBACvB,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,CAAC;oBAC3B,UAAU,EAAE,KAAK;iBAClB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACvB,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;oBAChE,qBAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC;QACH,CAAC;QACD,EAAE,KAAK,CAAC;IACV,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,WAAW,CAClB,MAAiB,EACjB,MAAwB,EACxB,QAA4B;IAE5B,MAAM,CAAC,cAAc,CACnB,QAAQ,EACR,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAE,CAAC;SACxE,WAAW,CACf,CAAC;IACF,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM;SAClC,WAAW,CAAC,QAAQ,CAAC;QACtB,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAE,CAAC;QACtC,MAAM,CAAC,WAAW,CAChB,QAAQ,EACR,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,EAC1C,KAAK,CACN,CAAC;QACF,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tree\n */\n\nimport { immerable } from \"immer\";\nimport { cloneDeep } from \"lodash\";\nimport { assert } from \"@itwin/core-bentley\";\nimport type { PropertyRecord } from \"@itwin/appui-abstract\";\nimport type {\n  DelayLoadedTreeNodeItem,\n  ImmediatelyLoadedTreeNodeItem,\n  TreeNodeItem,\n} from \"../TreeDataProvider.js\";\nimport type { SparseArray } from \"./internal/SparseTree.js\";\nimport { SparseTree } from \"./internal/SparseTree.js\";\nimport { CheckBoxState } from \"../../common/CheckBoxState.js\";\n\n/**\n * Immutable data structure that describes tree node.\n * @public\n */\nexport interface TreeModelNode {\n  readonly id: string;\n  readonly parentId: string | undefined;\n  readonly depth: number;\n\n  readonly isLoading?: boolean;\n  readonly numChildren: number | undefined;\n\n  readonly description: string | undefined;\n  readonly isExpanded: boolean;\n  readonly label: PropertyRecord;\n  readonly isSelected: boolean;\n  readonly isSelectionDisabled?: boolean;\n\n  /** Specifies that node is in editing mode. It holds callbacks that are used by node editor. */\n  readonly editingInfo?: TreeModelNodeEditingInfo;\n\n  readonly checkbox: CheckBoxInfo;\n\n  readonly item: TreeNodeItem;\n}\n\n/**\n * Immutable data structure that describes checkbox info.\n * @public\n */\nexport interface CheckBoxInfo {\n  readonly state: CheckBoxState;\n  readonly tooltip?: string;\n  readonly isDisabled: boolean;\n  readonly isVisible: boolean;\n}\n\n/**\n * Mutable data structure that describes tree node.\n * @public\n */\nexport interface MutableTreeModelNode extends TreeModelNode {\n  isLoading: boolean;\n\n  description: string;\n  isExpanded: boolean;\n  label: PropertyRecord;\n  isSelected: boolean;\n  isSelectionDisabled?: boolean;\n\n  /** Specifies that node is in editing mode. It holds callbacks that are used by node editor. */\n  editingInfo?: TreeModelNodeEditingInfo;\n\n  checkbox: MutableCheckBoxInfo;\n\n  item: TreeNodeItem;\n}\n\n/**\n * Data structure that holds callbacks used for tree node editing.\n * @public\n */\nexport interface TreeModelNodeEditingInfo {\n  onCommit: (node: TreeModelNode, newValue: string) => void;\n  onCancel: () => void;\n}\n\n/**\n * Mutable data structure that describes checkbox info.\n * @public\n */\nexport interface MutableCheckBoxInfo extends CheckBoxInfo {\n  state: CheckBoxState;\n  tooltip?: string;\n  isDisabled: boolean;\n  isVisible: boolean;\n}\n\n/**\n * Data structure that describes tree node placeholder.\n * @public\n */\nexport interface TreeModelNodePlaceholder {\n  readonly childIndex: number;\n  readonly depth: number;\n  readonly parentId?: string;\n}\n\n/**\n * Data structure that describes tree root node.\n * @public\n */\nexport interface TreeModelRootNode {\n  readonly depth: -1;\n  readonly id: undefined;\n  readonly numChildren: number | undefined;\n}\n\n/**\n * Data structure that describes input used to create tree node.\n * @public\n */\nexport interface TreeModelNodeInput {\n  readonly description?: string;\n  readonly isExpanded: boolean;\n  readonly id: string;\n  readonly item: TreeNodeItem;\n  readonly label: PropertyRecord;\n  readonly isLoading: boolean;\n  readonly numChildren?: number;\n  readonly isSelected: boolean;\n}\n\n/**\n * Type definition of all tree model nodes.\n * @public\n */\nexport type TreeModelNodeType =\n  | TreeModelNode\n  | TreeModelNodePlaceholder\n  | TreeModelRootNode;\n\n/**\n * Checks if object is [[TreeModelNode]]\n * @public\n */\nexport function isTreeModelNode(\n  obj: TreeModelNodeType | undefined\n): obj is TreeModelNode {\n  return (\n    obj !== undefined &&\n    !isTreeModelNodePlaceholder(obj) &&\n    !isTreeModelRootNode(obj)\n  );\n}\n\n/**\n * Checks if object is [[TreeModelNodePlaceholder]]\n * @public\n */\nexport function isTreeModelNodePlaceholder(\n  obj: TreeModelNodeType | undefined\n): obj is TreeModelNodePlaceholder {\n  return obj !== undefined && \"childIndex\" in obj;\n}\n\n/**\n * Checks if object is [[TreeModelRootNode]]\n * @public\n */\nexport function isTreeModelRootNode(\n  obj: TreeModelNodeType | undefined\n): obj is TreeModelRootNode {\n  return (\n    obj !== undefined &&\n    (obj as TreeModelRootNode).id === undefined &&\n    !(\"childIndex\" in obj)\n  );\n}\n\n/**\n * Type definition of tree node item data.\n * @public\n */\nexport type TreeNodeItemData = ImmediatelyLoadedTreeNodeItem &\n  DelayLoadedTreeNodeItem;\n\n/**\n * Data structure that describes set of visible tree nodes as a flat list.\n * @public\n */\nexport interface VisibleTreeNodes\n  extends Iterable<TreeModelNode | TreeModelNodePlaceholder> {\n  getNumNodes(): number;\n  getAtIndex(\n    index: number\n  ): TreeModelNode | TreeModelNodePlaceholder | undefined;\n  getModel(): TreeModel;\n  getNumRootNodes(): number | undefined;\n  getIndexOfNode(nodeId: string): number;\n}\n\n/**\n * Data structure that describes tree model.\n * @public\n */\nexport interface TreeModel {\n  getRootNode(): TreeModelRootNode;\n\n  getNode(id: string): TreeModelNode | undefined;\n  getNode(\n    parentId: string | undefined,\n    childIndex: number\n  ): TreeModelNode | TreeModelNodePlaceholder | undefined;\n  getNode(\n    nodeId: string | undefined,\n    childIndex?: number\n  ): TreeModelNode | TreeModelNodePlaceholder | TreeModelRootNode | undefined;\n\n  getChildren(parentId: string | undefined): SparseArray<string> | undefined;\n  getChildOffset(\n    parentId: string | undefined,\n    childId: string\n  ): number | undefined;\n\n  iterateTreeModelNodes(parentId?: string): IterableIterator<TreeModelNode>;\n}\n\n/**\n * Mutable tree model which holds nodes and allows adding or removing them.\n * @public\n */\nexport class MutableTreeModel implements TreeModel {\n  public [immerable] = true;\n\n  private _tree = new SparseTree<MutableTreeModelNode>();\n  private _rootNode: TreeModelRootNode = {\n    depth: -1,\n    id: undefined,\n    numChildren: undefined,\n  };\n\n  public constructor(seed?: TreeModel) {\n    if (!seed) {\n      return;\n    }\n\n    cloneSubree(seed, this, undefined);\n  }\n\n  /** Returns root node of a tree. This node is not visible and is there to allow having multiple visible root nodes. */\n  public getRootNode(): TreeModelRootNode {\n    return this._rootNode;\n  }\n\n  /** Returns tree node or placeholder for node that is not loaded yet.\n   * @returns node, node placeholder or undefined if node is not found in model.\n   */\n  public getNode(id: string): MutableTreeModelNode | undefined;\n  public getNode(\n    parentId: string | undefined,\n    childIndex: number\n  ): MutableTreeModelNode | TreeModelNodePlaceholder | undefined;\n  public getNode(\n    nodeId: string | undefined,\n    childIndex?: number\n  ): MutableTreeModelNode | TreeModelNodePlaceholder | undefined {\n    if (childIndex === undefined) {\n      return this._tree.getNode(nodeId!);\n    }\n\n    const children = this._tree.getChildren(nodeId);\n    const childId =\n      children !== undefined ? children.get(childIndex) : undefined;\n    if (childId !== undefined) {\n      return this._tree.getNode(childId);\n    }\n\n    const parentNode =\n      nodeId === undefined ? this._rootNode : this._tree.getNode(nodeId);\n    if (parentNode !== undefined) {\n      return {\n        childIndex,\n        depth: parentNode.depth + 1,\n        parentId: nodeId,\n      };\n    }\n\n    return undefined;\n  }\n\n  /** Returns children for specific parent.\n   * @param parentId id of parent node.\n   * @returns children of parent node or root nodes if undefined is passed as parent id.\n   */\n  public getChildren(\n    parentId: string | undefined\n  ): SparseArray<string> | undefined {\n    return this._tree.getChildren(parentId);\n  }\n\n  /** Returns children offset in children array for specific parent. */\n  public getChildOffset(\n    parentId: string | undefined,\n    childId: string\n  ): number | undefined {\n    return this._tree.getChildOffset(parentId, childId);\n  }\n\n  /**\n   * Sets children for parent node starting from the specific offset.\n   * If offset overlaps with already added nodes, the overlapping nodes are overwritten.\n   */\n  public setChildren(\n    parentId: string | undefined,\n    nodeInputs: TreeModelNodeInput[],\n    offset: number\n  ): void {\n    const parentNode =\n      parentId === undefined ? this._rootNode : this._tree.getNode(parentId);\n    if (parentNode === undefined) return;\n\n    const children: MutableTreeModelNode[] = [];\n    for (const input of nodeInputs) {\n      const child = MutableTreeModel.createTreeModelNode(parentNode, input);\n      children.push(child);\n    }\n\n    this._tree.setChildren(parentNode.id, children, offset);\n    MutableTreeModel.setNumChildrenForNode(\n      parentNode,\n      this._tree.getChildren(parentNode.id)\n    );\n  }\n\n  /**\n   * Inserts child in the specified position.\n   * If offset is higher then current length of children array, the length is increased.\n   */\n  public insertChild(\n    parentId: string | undefined,\n    childNodeInput: TreeModelNodeInput,\n    offset: number\n  ): void {\n    const parentNode =\n      parentId === undefined ? this._rootNode : this._tree.getNode(parentId);\n    if (parentNode === undefined) return;\n\n    const child = MutableTreeModel.createTreeModelNode(\n      parentNode,\n      childNodeInput\n    );\n\n    this._tree.insertChild(parentNode.id, child, offset);\n    MutableTreeModel.setNumChildrenForNode(\n      parentNode,\n      this._tree.getChildren(parentNode.id)\n    );\n  }\n\n  /**\n   * Changes the id of target node.\n   * @returns `true` on success, `false` otherwise.\n   */\n  public changeNodeId(currentId: string, newId: string): boolean {\n    const node = this.getNode(currentId);\n    if (node === undefined) {\n      return false;\n    }\n\n    if (currentId === newId) {\n      return true;\n    }\n\n    const index = this.getChildOffset(node.parentId, currentId);\n    assert(index !== undefined);\n\n    if (!this._tree.setNodeId(node.parentId, index, newId)) {\n      return false;\n    }\n\n    (node.id as string) = newId; // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion\n    for (const [childId] of this.getChildren(newId)?.iterateValues() ?? []) {\n      const child = this.getNode(childId);\n      assert(child !== undefined);\n      (child.parentId as string) = newId;\n    }\n\n    return true;\n  }\n\n  /**\n   * Transfers node along with its children to a new location. Fails if destination has undefined child count.\n   * @param sourceNodeId Node that is being moved.\n   * @param targetParentId Node that will receive a new child.\n   * @param targetIndex Insertion location among target's *current* children.\n   * @returns `true` on success, `false` otherwise.\n   */\n  public moveNode(\n    sourceNodeId: string,\n    targetParentId: string | undefined,\n    targetIndex: number\n  ): boolean {\n    const sourceNode = this.getNode(sourceNodeId);\n    if (sourceNode === undefined) {\n      return false;\n    }\n\n    const targetParent =\n      targetParentId === undefined\n        ? this._rootNode\n        : this.getNode(targetParentId);\n    if (targetParent === undefined || targetParent.numChildren === undefined) {\n      return false;\n    }\n\n    if (\n      targetParentId !== undefined &&\n      this.areNodesRelated(sourceNodeId, targetParentId)\n    ) {\n      return false;\n    }\n\n    this._tree.moveNode(\n      sourceNode.parentId,\n      sourceNodeId,\n      targetParentId,\n      targetIndex\n    );\n\n    const sourceParent =\n      sourceNode.parentId === undefined\n        ? this._rootNode\n        : this.getNode(sourceNode.parentId);\n    assert(sourceParent !== undefined);\n    MutableTreeModel.setNumChildrenForNode(\n      sourceParent,\n      this._tree.getChildren(sourceNode.parentId)\n    );\n    MutableTreeModel.setNumChildrenForNode(\n      targetParent,\n      this._tree.getChildren(targetParentId)\n    );\n\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    (sourceNode.parentId as string | undefined) = targetParentId;\n\n    const updateDepths = (parentId: string, depth: number) => {\n      const node = this.getNode(parentId);\n      assert(node !== undefined);\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n      (node.depth as number) = depth;\n      for (const [nodeId] of this.getChildren(parentId)?.iterateValues() ??\n        []) {\n        updateDepths(nodeId, depth + 1);\n      }\n    };\n\n    updateDepths(sourceNodeId, targetParent.depth + 1);\n    return true;\n  }\n\n  private areNodesRelated(\n    ancestorNodeId: string,\n    descendantNodeId: string\n  ): boolean {\n    const node = this.getNode(descendantNodeId);\n    if (node === undefined || node.parentId === undefined) {\n      return false;\n    }\n\n    return node.parentId === ancestorNodeId\n      ? true\n      : this.areNodesRelated(ancestorNodeId, node.parentId);\n  }\n\n  /**\n   * Sets the number of child nodes a parent is expected to contain. All child nodes of this parent will be subsequently\n   * removed.\n   */\n  public setNumChildren(\n    parentId: string | undefined,\n    numChildren: number | undefined\n  ): void {\n    const parentNode =\n      parentId === undefined ? this._rootNode : this._tree.getNode(parentId);\n    if (parentNode === undefined) {\n      return;\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    (parentNode.numChildren as number | undefined) = numChildren;\n    this._tree.setNumChildren(parentId, numChildren ?? 0);\n  }\n\n  /** Removes children specified by id.\n   * @param parentId id of the parent node.\n   * @param child child node id or index that should be removed.\n   */\n  public removeChild(\n    parentId: string | undefined,\n    child: string | number\n  ): void {\n    const parentNode =\n      parentId === undefined ? this._rootNode : this._tree.getNode(parentId);\n    this._tree.removeChild(parentId, child);\n\n    if (parentNode)\n      MutableTreeModel.setNumChildrenForNode(\n        parentNode,\n        this._tree.getChildren(parentNode.id)\n      );\n  }\n\n  /** Removes all children for parent specified by id.\n   * @param parentId id of parent node or undefined to remove root nodes.\n   */\n  public clearChildren(parentId: string | undefined) {\n    const parentNode =\n      parentId === undefined ? this._rootNode : this._tree.getNode(parentId);\n    if (parentNode !== undefined) {\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n      (parentNode.numChildren as number | undefined) = undefined;\n    }\n    this._tree.deleteSubtree(parentId, false);\n  }\n\n  /** Iterates over all nodes present in the tree model. */\n  public *iterateTreeModelNodes(\n    parentId?: string\n  ): IterableIterator<MutableTreeModelNode> {\n    // eslint-disable-next-line @typescript-eslint/no-this-alias\n    const _this = this;\n    function* iterateDescendants(\n      subParentId: string | undefined\n    ): IterableIterator<MutableTreeModelNode> {\n      const children = _this.getChildren(subParentId);\n      if (children === undefined) {\n        return;\n      }\n\n      for (const [nodeId] of children.iterateValues()) {\n        const node = _this.getNode(nodeId);\n        if (node !== undefined) {\n          yield node;\n          yield* iterateDescendants(nodeId);\n        }\n      }\n    }\n\n    yield* iterateDescendants(parentId);\n  }\n\n  private static setNumChildrenForNode(\n    node: TreeModelRootNode | MutableTreeModelNode,\n    children: SparseArray<string> | undefined\n  ) {\n    const numChildren = children ? children.getLength() : undefined;\n    if (node.numChildren === numChildren) return;\n\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    (node.numChildren as number | undefined) = numChildren;\n  }\n\n  private static createTreeModelNode(\n    parentNode: TreeModelNode | TreeModelRootNode,\n    input: TreeModelNodeInput\n  ): MutableTreeModelNode {\n    return {\n      id: input.id,\n      parentId: parentNode.id,\n      depth: parentNode.depth + 1,\n\n      isLoading: input.isLoading,\n      numChildren: input.numChildren,\n\n      description: input.description || \"\",\n      isExpanded: input.isExpanded,\n      label: input.label,\n      isSelected: input.isSelected,\n      isSelectionDisabled: input.item.isSelectionDisabled,\n\n      checkbox: {\n        state: input.item.checkBoxState || CheckBoxState.Off,\n        isDisabled: !!input.item.isCheckboxDisabled,\n        isVisible: !!input.item.isCheckboxVisible,\n      },\n\n      item: cloneDeep(input.item),\n    };\n  }\n}\n\n/**\n * Generates flat list of visible nodes in the tree model.\n * @public\n */\nexport function computeVisibleNodes(model: TreeModel): VisibleTreeNodes {\n  const result = getVisibleDescendants(model, model.getRootNode());\n  return {\n    getNumNodes: () => result.length,\n    getAtIndex: (\n      index: number\n    ): TreeModelNode | TreeModelNodePlaceholder | undefined => {\n      return result[index];\n    },\n    getModel: () => model,\n    getNumRootNodes: () => model.getRootNode().numChildren,\n    [Symbol.iterator]: () => result[Symbol.iterator](),\n    getIndexOfNode: (nodeId: string): number => {\n      return result.findIndex(\n        (visibleNode) => (visibleNode as TreeModelNode).id === nodeId\n      );\n    },\n  };\n}\n\n/**\n * Traverses the tree and collects visible descendants.\n * @public\n */\nexport function getVisibleDescendants(\n  model: TreeModel,\n  parentNode: TreeModelNode | TreeModelRootNode,\n  result: Array<TreeModelNode | TreeModelNodePlaceholder> = []\n): Array<TreeModelNode | TreeModelNodePlaceholder> {\n  const children = model.getChildren(parentNode.id);\n  if (!children) {\n    return result;\n  }\n\n  let index = 0;\n  for (const childId of children) {\n    if (childId === undefined) {\n      result.push({\n        parentId: parentNode.id,\n        depth: parentNode.depth + 1,\n        childIndex: index,\n      });\n    } else {\n      const childNode = model.getNode(childId);\n      if (childNode === undefined) {\n        // node was disposed\n        result.push({\n          parentId: parentNode.id,\n          depth: parentNode.depth + 1,\n          childIndex: index,\n        });\n      } else {\n        result.push(childNode);\n        if (childNode.isExpanded && childNode.numChildren !== undefined) {\n          getVisibleDescendants(model, childNode, result);\n        }\n      }\n    }\n    ++index;\n  }\n\n  return result;\n}\n\nfunction cloneSubree(\n  source: TreeModel,\n  target: MutableTreeModel,\n  parentId: string | undefined\n): void {\n  target.setNumChildren(\n    parentId,\n    (parentId === undefined ? source.getRootNode() : source.getNode(parentId)!)\n      .numChildren\n  );\n  for (const [childId, index] of source\n    .getChildren(parentId)\n    ?.iterateValues() ?? []) {\n    const node = source.getNode(childId)!;\n    target.setChildren(\n      parentId,\n      [{ ...node, isLoading: !!node.isLoading }],\n      index\n    );\n    cloneSubree(source, target, childId);\n  }\n}\n"]}

package/lib/components-react/tree/controlled/TreeModelSource.d.ts

@@ -0,0 +1,35 @@
+/** @packageDocumentation
+ * @module Tree
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import type { TreeModel } from "./TreeModel.js";
+import { MutableTreeModel } from "./TreeModel.js";
+/**
+ * Data structure that describes changes which happened to the tree model
+ * @public
+ */
+export interface TreeModelChanges {
+    addedNodeIds: string[];
+    modifiedNodeIds: string[];
+    removedNodeIds: string[];
+}
+/**
+ * Controls tree model.
+ * It is used to modify model and inform when tree model changes.
+ * @public
+ */
+export declare class TreeModelSource {
+    private _model;
+    /** Event that is emitted every time tree model is changed. */
+    onModelChanged: BeUiEvent<[TreeModel, TreeModelChanges]>;
+    constructor(_model?: MutableTreeModel);
+    /**
+     * Modifies tree model using provided callback.
+     * If changes to tree model is detected then onModelChanged event is emitted.
+     */
+    modifyModel(callback: (model: MutableTreeModel) => void): void;
+    /** Returns tree model. */
+    getModel(): TreeModel;
+    private collectModelChanges;
+}
+//# sourceMappingURL=TreeModelSource.d.ts.map

package/lib/components-react/tree/controlled/TreeModelSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeModelSource.d.ts","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeModelSource.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;GAIG;AACH,qBAAa,eAAe;IAId,OAAO,CAAC,MAAM;IAH1B,8DAA8D;IACvD,cAAc,2CAAkD;gBAEnD,MAAM,GAAE,gBAAyC;IAErE;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,GAAG,IAAI;IAoBrE,0BAA0B;IACnB,QAAQ,IAAI,SAAS;IAI5B,OAAO,CAAC,mBAAmB;CAyC5B"}

package/lib/components-react/tree/controlled/TreeModelSource.js

@@ -0,0 +1,79 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
+import { produce } from "immer";
+import { BeUiEvent } from "@itwin/core-bentley";
+import { MutableTreeModel } from "./TreeModel.js";
+/**
+ * Controls tree model.
+ * It is used to modify model and inform when tree model changes.
+ * @public
+ */
+export class TreeModelSource {
+    constructor(_model = new MutableTreeModel()) {
+        this._model = _model;
+        /** Event that is emitted every time tree model is changed. */
+        this.onModelChanged = new BeUiEvent();
+    }
+    /**
+     * Modifies tree model using provided callback.
+     * If changes to tree model is detected then onModelChanged event is emitted.
+     */
+    modifyModel(callback) {
+        let changes = {
+            addedNodeIds: [],
+            modifiedNodeIds: [],
+            removedNodeIds: [],
+        };
+        const newModel = produce(this._model, (draft) => callback(draft), (patches) => {
+            changes = this.collectModelChanges(patches);
+        });
+        if (newModel !== this._model) {
+            this._model = newModel;
+            this.onModelChanged.emit([this._model, changes]);
+        }
+    }
+    /** Returns tree model. */
+    getModel() {
+        return this._model;
+    }
+    collectModelChanges(modelPatches) {
+        const addedNodeIds = [];
+        const modifiedNodeIds = new Set();
+        const removedNodeIds = [];
+        for (const patch of modelPatches) {
+            if (patch.path.length >= 3 &&
+                patch.path[0] === "_tree" &&
+                patch.path[1] === "_idToNode") {
+                const nodeId = patch.path[2];
+                if (patch.path.length > 3) {
+                    // Modification occured somewhere inside a node
+                    modifiedNodeIds.add(nodeId);
+                    continue;
+                }
+                // Modification occured directly on _idToNode object
+                switch (patch.op) {
+                    case "add":
+                        addedNodeIds.push(nodeId);
+                        break;
+                    case "remove":
+                        removedNodeIds.push(nodeId);
+                        break;
+                    case "replace":
+                        modifiedNodeIds.add(nodeId);
+                        break;
+                }
+            }
+        }
+        return {
+            addedNodeIds,
+            modifiedNodeIds: [...modifiedNodeIds],
+            removedNodeIds,
+        };
+    }
+}
+//# sourceMappingURL=TreeModelSource.js.map

package/lib/components-react/tree/controlled/TreeModelSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeModelSource.js","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeModelSource.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAYlD;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAI1B,YAAoB,SAA2B,IAAI,gBAAgB,EAAE;QAAjD,WAAM,GAAN,MAAM,CAA2C;QAHrE,8DAA8D;QACvD,mBAAc,GAAG,IAAI,SAAS,EAAiC,CAAC;IAEC,CAAC;IAEzE;;;OAGG;IACI,WAAW,CAAC,QAA2C;QAC5D,IAAI,OAAO,GAAqB;YAC9B,YAAY,EAAE,EAAE;YAChB,eAAe,EAAE,EAAE;YACnB,cAAc,EAAE,EAAE;SACnB,CAAC;QACF,MAAM,QAAQ,GAAG,OAAO,CACtB,IAAI,CAAC,MAAM,EACX,CAAC,KAAuB,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC5C,CAAC,OAAgB,EAAE,EAAE;YACnB,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC,CACF,CAAC;QAEF,IAAI,QAAQ,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YACvB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,0BAA0B;IACnB,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEO,mBAAmB,CAAC,YAAqB;QAC/C,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;QAC1C,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,IACE,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC;gBACtB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO;gBACzB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,WAAW,EAC7B,CAAC;gBACD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;gBAEvC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1B,+CAA+C;oBAC/C,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAC5B,SAAS;gBACX,CAAC;gBAED,oDAAoD;gBACpD,QAAQ,KAAK,CAAC,EAAE,EAAE,CAAC;oBACjB,KAAK,KAAK;wBACR,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBAC1B,MAAM;oBAER,KAAK,QAAQ;wBACX,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBAC5B,MAAM;oBAER,KAAK,SAAS;wBACZ,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;wBAC5B,MAAM;gBACV,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO;YACL,YAAY;YACZ,eAAe,EAAE,CAAC,GAAG,eAAe,CAAC;YACrC,cAAc;SACf,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tree\n */\n\nimport type { Patch } from \"immer\";\nimport { produce } from \"immer\";\nimport { BeUiEvent } from \"@itwin/core-bentley\";\nimport type { TreeModel } from \"./TreeModel.js\";\nimport { MutableTreeModel } from \"./TreeModel.js\";\n\n/**\n * Data structure that describes changes which happened to the tree model\n * @public\n */\nexport interface TreeModelChanges {\n  addedNodeIds: string[];\n  modifiedNodeIds: string[];\n  removedNodeIds: string[];\n}\n\n/**\n * Controls tree model.\n * It is used to modify model and inform when tree model changes.\n * @public\n */\nexport class TreeModelSource {\n  /** Event that is emitted every time tree model is changed. */\n  public onModelChanged = new BeUiEvent<[TreeModel, TreeModelChanges]>();\n\n  constructor(private _model: MutableTreeModel = new MutableTreeModel()) {}\n\n  /**\n   * Modifies tree model using provided callback.\n   * If changes to tree model is detected then onModelChanged event is emitted.\n   */\n  public modifyModel(callback: (model: MutableTreeModel) => void): void {\n    let changes: TreeModelChanges = {\n      addedNodeIds: [],\n      modifiedNodeIds: [],\n      removedNodeIds: [],\n    };\n    const newModel = produce(\n      this._model,\n      (draft: MutableTreeModel) => callback(draft),\n      (patches: Patch[]) => {\n        changes = this.collectModelChanges(patches);\n      }\n    );\n\n    if (newModel !== this._model) {\n      this._model = newModel;\n      this.onModelChanged.emit([this._model, changes]);\n    }\n  }\n\n  /** Returns tree model. */\n  public getModel(): TreeModel {\n    return this._model;\n  }\n\n  private collectModelChanges(modelPatches: Patch[]): TreeModelChanges {\n    const addedNodeIds: string[] = [];\n    const modifiedNodeIds = new Set<string>();\n    const removedNodeIds: string[] = [];\n    for (const patch of modelPatches) {\n      if (\n        patch.path.length >= 3 &&\n        patch.path[0] === \"_tree\" &&\n        patch.path[1] === \"_idToNode\"\n      ) {\n        const nodeId = patch.path[2] as string;\n\n        if (patch.path.length > 3) {\n          // Modification occured somewhere inside a node\n          modifiedNodeIds.add(nodeId);\n          continue;\n        }\n\n        // Modification occured directly on _idToNode object\n        switch (patch.op) {\n          case \"add\":\n            addedNodeIds.push(nodeId);\n            break;\n\n          case \"remove\":\n            removedNodeIds.push(nodeId);\n            break;\n\n          case \"replace\":\n            modifiedNodeIds.add(nodeId);\n            break;\n        }\n      }\n    }\n\n    return {\n      addedNodeIds,\n      modifiedNodeIds: [...modifiedNodeIds],\n      removedNodeIds,\n    };\n  }\n}\n"]}