@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/ElementTreeWalker.js

@@ -0,0 +1,421 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Elements
+ */
+import { assert, DbResult, Logger, LogLevel } from "@itwin/core-bentley";
+import { IModel } from "@itwin/core-common";
+import { BackendLoggerCategory } from "./BackendLoggerCategory";
+import { DefinitionContainer, DefinitionElement, DefinitionPartition, Element, Subject } from "./Element";
+import { IModelDb } from "./IModelDb";
+import { DefinitionModel, Model } from "./Model";
+const loggerCategory = `${BackendLoggerCategory.IModelDb}.ElementTreeWalker`;
+function sortChildrenBeforeParents(iModel, ids) {
+    const children = [];
+    const parents = [];
+    for (const eid of ids) {
+        const parentId = iModel.elements.queryParent(eid);
+        if (parentId !== undefined && ids.includes(parentId))
+            children.push(eid);
+        else
+            parents.push(eid);
+    }
+    if (children.length === 0)
+        return [parents];
+    return [...sortChildrenBeforeParents(iModel, children), parents];
+}
+function isModelEmpty(iModel, modelId) {
+    return iModel.withPreparedStatement(`select count(*) from ${Element.classFullName} where Model.Id = ?`, (stmt) => {
+        stmt.bindId(1, modelId);
+        stmt.step();
+        return stmt.getValue(0).getInteger() === 0;
+    });
+}
+function isDefinitionModel(model) {
+    return (model.id !== IModel.repositoryModelId) && (model instanceof DefinitionModel);
+}
+var ElementPruningClassification;
+(function (ElementPruningClassification) {
+    ElementPruningClassification[ElementPruningClassification["PRUNING_CLASS_Normal"] = 0] = "PRUNING_CLASS_Normal";
+    ElementPruningClassification[ElementPruningClassification["PRUNING_CLASS_Subject"] = 1] = "PRUNING_CLASS_Subject";
+    ElementPruningClassification[ElementPruningClassification["PRUNING_CLASS_Definition"] = 2] = "PRUNING_CLASS_Definition";
+    ElementPruningClassification[ElementPruningClassification["PRUNING_CLASS_DefinitionPartition"] = 3] = "PRUNING_CLASS_DefinitionPartition";
+})(ElementPruningClassification || (ElementPruningClassification = {}));
+function classifyElementForPruning(iModel, elementId) {
+    const el = iModel.elements.getElement(elementId);
+    // DefinitionContainer is submodeled by a DefinitionModel and so it must be classified as PRUNING_CLASS_DefinitionPartition for tree-walking purposes.
+    // Since DefinitionContainer is-a DefinitionElement the (el instanceof DefinitionElement) case below would classify it as PRUNING_CLASS_Definition.
+    // That is why we special-case it here.
+    if (el instanceof DefinitionContainer)
+        return ElementPruningClassification.PRUNING_CLASS_DefinitionPartition;
+    return (el instanceof Subject) ? ElementPruningClassification.PRUNING_CLASS_Subject :
+        (el instanceof DefinitionElement) ? ElementPruningClassification.PRUNING_CLASS_Definition :
+            (el instanceof DefinitionPartition) ? ElementPruningClassification.PRUNING_CLASS_DefinitionPartition :
+                ElementPruningClassification.PRUNING_CLASS_Normal;
+}
+/** Records the path that a tree search took to reach an element or model. This object is immutable.
+ * @beta
+ */
+export class ElementTreeWalkerScope {
+    topElement = "";
+    /** path of parent elements and enclosing models */
+    path = [];
+    /** cached info about the immediately enclosing model (i.e., the last model in path) */
+    enclosingModelInfo;
+    constructor(arg1, arg2) {
+        if (typeof arg1 === "string") {
+            // normal constructor
+            assert(arg2 instanceof Model);
+            this.topElement = arg1;
+            this.path.push(this.enclosingModelInfo = { model: arg2, isDefinitionModel: isDefinitionModel(arg2) });
+        }
+        else if (arg1 instanceof ElementTreeWalkerScope) {
+            // copy-like constructor
+            this.topElement = arg1.topElement;
+            this.path = [...arg1.path];
+            if (typeof arg2 === "string") {
+                // with new parent
+                this.path.push(arg2);
+                this.enclosingModelInfo = arg1.enclosingModelInfo;
+            }
+            else {
+                // with new enclosing model
+                this.path.push(this.enclosingModelInfo = { model: arg2, isDefinitionModel: isDefinitionModel(arg2) });
+            }
+        }
+        else {
+            throw new Error("invalid constructor signature");
+        }
+    }
+    get enclosingModel() { return this.enclosingModelInfo.model; }
+    get inDefinitionModel() { return this.enclosingModelInfo.isDefinitionModel; } // NB: this will return false for the RepositoryModel!
+    get inRepositoryModel() { return this.enclosingModelInfo.model.id === IModelDb.repositoryModelId; }
+    static createTopScope(iModel, topElementId) {
+        const topElement = iModel.elements.getElement(topElementId);
+        const topElementModel = iModel.models.getModel(topElement.model);
+        return new ElementTreeWalkerScope(topElementId, topElementModel);
+    }
+    fmtItem(v) {
+        if (typeof v === "string")
+            return `element ${v}`;
+        return `model ${v.model.id} ${v.isDefinitionModel ? "(DEFN)" : ""}`;
+    }
+    toString() {
+        return `[ ${this.path.map((v) => this.fmtItem(v)).join(" / ")} ]`;
+    }
+}
+function fmtElement(iModel, elementId) {
+    const el = iModel.elements.getElement(elementId);
+    return `${el.id} ${el.classFullName} ${el.getDisplayLabel()}`;
+}
+function fmtModel(model) {
+    return `${model.id} ${model.classFullName} ${model.name}`;
+}
+let isTraceEnabledChecked = -1;
+function isTraceEnabled() {
+    if (isTraceEnabledChecked === -1)
+        isTraceEnabledChecked = Logger.isEnabled(loggerCategory, LogLevel.Trace) ? 1 : 0;
+    return isTraceEnabledChecked === 1;
+}
+function logElement(op, iModel, elementId, scope, logChildren) {
+    if (!isTraceEnabled())
+        return;
+    Logger.logTrace(loggerCategory, `${op} ${fmtElement(iModel, elementId)} ${scope ? scope.toString() : ""}`);
+    if (logChildren)
+        iModel.elements.queryChildren(elementId).forEach((c) => logElement(" - ", iModel, c, undefined, true));
+}
+function logModel(op, iModel, modelId, scope, logElements) {
+    if (!isTraceEnabled())
+        return;
+    const model = iModel.models.getModel(modelId);
+    Logger.logTrace(loggerCategory, `${op} ${fmtModel(model)} ${scope ? scope.toString() : ""}`);
+    if (logElements) {
+        iModel.withPreparedStatement(`select ecinstanceid from ${Element.classFullName} where Model.Id = ?`, (stmt) => {
+            stmt.bindId(1, modelId);
+            while (stmt.step() === DbResult.BE_SQLITE_ROW) {
+                logElement(" - ", iModel, stmt.getValue(0).getId());
+            }
+        });
+    }
+}
+/** Does a depth-first search on the tree defined by an element and its sub-models and children.
+ * Sub-models are visited before their modeled elements, and children are visited before their parents.
+ *
+ * The following callbacks allow the subclass to exclude elements and sub-trees from the search:
+ *  * [[ElementTreeBottomUp.shouldExploreModel]], [[ElementTreeBottomUp.shouldExploreChildren]]
+ *  * [[ElementTreeBottomUp.shouldVisitElement]], [[ElementTreeBottomUp.shouldVisitModel]]
+ *
+ * The [[ElementTreeBottomUp.visitElement]] and [[ElementTreeBottomUp.visitModel]] callbacks allow
+ * the subclass to process the elements and models that are encountered in the search.
+ * @beta
+ */
+export class ElementTreeBottomUp {
+    _iModel;
+    constructor(_iModel) {
+        this._iModel = _iModel;
+    }
+    /** Return true if the search should recurse into this model  */
+    shouldExploreModel(_model, _scope) { return true; }
+    /** Return true if the search should recurse into the children (if any) of this element  */
+    shouldExploreChildren(_parentId, _scope) { return true; }
+    /** Return true if the search should visit this element  */
+    shouldVisitElement(_elementId, _scope) { return true; }
+    /** Return true if the search should visit this model  */
+    shouldVisitModel(_model, _scope) { return true; }
+    /** The main tree-walking function */
+    processElementTree(element, scope) {
+        const subModel = this._iModel.models.tryGetModel(element);
+        if (subModel !== undefined) {
+            if (this.shouldExploreModel(subModel, scope))
+                this._processSubModel(subModel, scope);
+            if (this.shouldVisitModel(subModel, scope))
+                this.visitModel(subModel, scope);
+        }
+        if (this.shouldExploreChildren(element, scope))
+            this._processChildren(element, scope);
+        if (this.shouldVisitElement(element, scope))
+            this.visitElement(element, scope);
+    }
+    /** process the children of the specified parent element */
+    _processChildren(parentElement, parentScope) {
+        const children = this._iModel.elements.queryChildren(parentElement);
+        if (children.length === 0)
+            return;
+        const childrenScope = new ElementTreeWalkerScope(parentScope, parentElement);
+        for (const childElement of children)
+            this.processElementTree(childElement, childrenScope);
+    }
+    /** process the elements in the specified model */
+    _processSubModel(model, parenScope) {
+        const scope = new ElementTreeWalkerScope(parenScope, model);
+        // Visit only the top-level parents. processElementTree will visit their children (bottom-up).
+        model.iModel.withPreparedStatement(`select ECInstanceId from bis:Element where Model.id=? and Parent.Id is null`, (stmt) => {
+            stmt.bindId(1, model.id);
+            while (stmt.step() === DbResult.BE_SQLITE_ROW) {
+                const elementId = stmt.getValue(0).getId();
+                this.processElementTree(elementId, scope);
+            }
+        });
+    }
+}
+/** Helper class that manages the deletion of definitions and subjects */
+class SpecialElements {
+    definitionModels = [];
+    definitions = [];
+    subjects = [];
+    recordSpecialElement(iModel, elementId) {
+        // Defer Definitions and Subjects
+        const cls = classifyElementForPruning(iModel, elementId);
+        if (cls === ElementPruningClassification.PRUNING_CLASS_Subject) {
+            this.subjects.push(elementId);
+            return true;
+        }
+        else if (cls === ElementPruningClassification.PRUNING_CLASS_Definition) {
+            this.definitions.push(elementId);
+            return true;
+        }
+        else if (cls === ElementPruningClassification.PRUNING_CLASS_DefinitionPartition) {
+            this.definitionModels.push(elementId);
+            return true;
+        }
+        return false; // not a special element
+    }
+    /** Delete special elements - This calls Elements.deleteDefinitionElements to process the collected definition elements as a group and then
+     * calls Models.deleteModel on collected definition models. It then deletes all collected Subjects by calling Element.deleteElement on them.
+     * @note Caller must ensure that the special elements were recorded in a depth-first search.
+     */
+    deleteSpecialElements(iModel) {
+        // It's dangerous to pass a mixture of SubCategories and Categories to deleteDefinitionElements.
+        // That function will delete the Categories first, which automatically deletes all their child
+        // SubCategories (in native code). If a SubCategory in the list is one of those children, then
+        // deleteDefinitionElements will try and fail with an exception to delete that SubCategory in a subsequent step.
+        // To work around this, we delete the SubCategories first, then everything else.
+        // A similar problem occurs when you pass other kinds of elements to deleteDefinitionElements, where some are
+        // children and others are parents. deleteDefinitionElements does not preserve the order that you specify,
+        // and it does not process children before parents.
+        for (const definitions of sortChildrenBeforeParents(iModel, this.definitions)) {
+            if (isTraceEnabled())
+                definitions.forEach((e) => logElement("try delete", iModel, e));
+            iModel.elements.deleteDefinitionElements(definitions); // will not delete definitions that are still in use.
+        }
+        for (const m of this.definitionModels) {
+            if (!isModelEmpty(iModel, m)) {
+                logModel("Model not empty - cannot delete - may contain Definitions that are still in use", iModel, m, undefined, true);
+            }
+            else {
+                logModel("delete", iModel, m);
+                iModel.models.deleteModel(m);
+                iModel.elements.deleteElement(m);
+            }
+        }
+        for (const e of this.subjects) {
+            if (iModel.elements.queryChildren(e).length !== 0) {
+                logElement("Subject still has children - cannot delete - may have child DefinitionModels", iModel, e, undefined, true);
+            }
+            else {
+                logElement("delete", iModel, e);
+                iModel.elements.deleteElement(e);
+            }
+        }
+    }
+}
+/** Deletes an entire element tree, including sub-models and child elements.
+ * Items are deleted in bottom-up order. Definitions and Subjects are deleted after normal elements.
+ * Call deleteNormalElements on each tree. Then call deleteSpecialElements.
+ * @see deleteElementTree for a simple way to use this class.
+ * @beta
+ */
+export class ElementTreeDeleter extends ElementTreeBottomUp {
+    _special = new SpecialElements();
+    shouldExploreModel(_model) { return true; }
+    shouldVisitElement(_elementId) { return true; }
+    visitModel(model, _scope) {
+        if (isDefinitionModel(model))
+            return; // we recorded definition models in visitElement when we encountered the DefinitionPartition elements.
+        // visitElement has already deleted the elements in the model. So, now it's safe to delete the model itself.
+        logModel("delete", this._iModel, model.id, _scope);
+        model.delete();
+    }
+    visitElement(elementId, _scope) {
+        if (!this._special.recordSpecialElement(this._iModel, elementId)) {
+            logElement("delete", this._iModel, elementId, _scope);
+            this._iModel.elements.deleteElement(elementId);
+        }
+    }
+    /**
+     * Delete the "normal" elements and record the special elements for deferred processing.
+     * @param topElement The parent of the sub-tree to be deleted. Top element itself is also deleted.
+     * @param scope How the parent was found
+     * @see deleteSpecialElements
+     */
+    deleteNormalElements(topElement, scope) {
+        const topScope = scope ?? ElementTreeWalkerScope.createTopScope(this._iModel, topElement);
+        this.processElementTree(topElement, topScope); //
+    }
+    /** Delete all special elements that were found and deferred by deleteNormalElements. Call this
+     * function once after all element trees are processed by deleteNormalElements.
+     */
+    deleteSpecialElements() {
+        this._special.deleteSpecialElements(this._iModel);
+    }
+}
+/** Does a breadth-first search on the tree defined by an element and its sub-models and children.
+ * Parents are visited first, then children, then sub-models.
+ * The subclass can "prune" sub-trees from the search. When a sub-tree is "pruned" the search does *not* recurse into it.
+ * If a sub-tree is not pruned, then the search does recurse into it.
+ * @beta
+ */
+class ElementTreeTopDown {
+    _iModel;
+    constructor(_iModel) {
+        this._iModel = _iModel;
+    }
+    /** Should the search *not* recurse into this sub-tree? */
+    shouldPrune(_elementId, _scope) { return false; }
+    processElementTree(element, scope) {
+        if (this.shouldPrune(element, scope)) {
+            this.prune(element, scope);
+            return;
+        }
+        this._processChildren(element, scope);
+        const subModel = this._iModel.models.tryGetModel(element);
+        if (subModel !== undefined) {
+            this._processSubModel(subModel, scope);
+        }
+    }
+    _processChildren(element, scope) {
+        let parentScope;
+        for (const childElement of this._iModel.elements.queryChildren(element)) {
+            if (parentScope === undefined)
+                parentScope = new ElementTreeWalkerScope(scope, element);
+            this.processElementTree(childElement, parentScope);
+        }
+    }
+    _processSubModel(subModel, scope) {
+        const subModelScope = new ElementTreeWalkerScope(scope, subModel);
+        // Visit only the top-level parents. processElementTree will recurse into their children.
+        this._iModel.withPreparedStatement(`select ECInstanceId from bis:Element where Model.id=? and Parent.Id is null`, (stmt) => {
+            stmt.bindId(1, subModel.id);
+            while (stmt.step() === DbResult.BE_SQLITE_ROW) {
+                const elementId = stmt.getValue(0).getId();
+                this.processElementTree(elementId, subModelScope);
+            }
+        });
+    }
+}
+/** Performs a breadth-first search to visit elements in top-down order.
+ * When the supplied filter function chooses an element, ElementTreeDeleter is used to delete it and its sub-tree.
+ * @beta
+ */
+export class ElementSubTreeDeleter extends ElementTreeTopDown {
+    _treeDeleter;
+    _shouldPruneCb;
+    /** Construct an ElementSubTreeDeleter.
+     * @param iModel The iModel
+     * @param topElement Where to start the search.
+     * @param shouldPruneCb Callback that selects sub-trees that should be deleted.
+     * @see deleteElementSubTrees for a simple way to use this class.
+     */
+    constructor(iModel, shouldPruneCb) {
+        super(iModel);
+        this._treeDeleter = new ElementTreeDeleter(this._iModel);
+        this._shouldPruneCb = shouldPruneCb;
+    }
+    shouldPrune(elementId, scope) { return this._shouldPruneCb(elementId, scope); }
+    prune(elementId, scope) {
+        this._treeDeleter.deleteNormalElements(elementId, scope);
+    }
+    /** Traverses the tree of elements beginning with the top element, and deletes all selected sub-trees.
+     * Normal elements are deleted. Any special elements that are encountered are deferred.
+     * Call deleteSpecialElementSubTrees after all top elements have been processed. */
+    deleteNormalElementSubTrees(topElement, scope) {
+        const topScope = scope ?? ElementTreeWalkerScope.createTopScope(this._iModel, topElement);
+        this.processElementTree(topElement, topScope); // deletes normal elements and their sub-trees, defers special elements
+    }
+    /** Delete all special elements and their sub-trees that were found in the course of processing.
+     * The sub-trees were already expanded by ElementTreeDeleter.deleteNormalElements.
+     */
+    deleteSpecialElementSubTrees() {
+        this._treeDeleter.deleteSpecialElements();
+    }
+}
+/** @internal */
+export function deleteElementTree(arg0, arg1) {
+    let maxPasses;
+    let iModel;
+    let topElement;
+    if (arg0 instanceof IModelDb) {
+        assert(typeof arg1 === "string");
+        iModel = arg0;
+        topElement = arg1;
+    }
+    else {
+        iModel = arg0.iModel;
+        topElement = arg0.topElement;
+        maxPasses = arg0.maxPasses;
+    }
+    maxPasses = maxPasses ?? 5;
+    let pass = 0;
+    do {
+        const del = new ElementTreeDeleter(iModel);
+        del.deleteNormalElements(topElement);
+        del.deleteSpecialElements();
+    } while ((iModel.elements.tryGetElement(topElement) !== undefined) && (++pass < maxPasses));
+}
+/** Deletes all element sub-trees that are selected by the supplied filter. Uses ElementSubTreeDeleter.
+ * If the filter selects the top element itself, then the entire tree (including the top element) is deleted.
+ * That has the same effect as calling [[deleteElementTree]] on the top element.
+ * @note The caller may have to call this function multiple times if there are multiple layers of dependencies among definition elements.
+ * @param iModel The iModel
+ * @param topElement Where to start the search.
+ * @param filter Callback that selects sub-trees that should be deleted.
+ * @beta
+ */
+export function deleteElementSubTrees(iModel, topElement, filter) {
+    const del = new ElementSubTreeDeleter(iModel, filter);
+    del.deleteNormalElementSubTrees(topElement);
+    del.deleteSpecialElementSubTrees();
+}
+//# sourceMappingURL=ElementTreeWalker.js.map

package/lib/esm/ElementTreeWalker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ElementTreeWalker.js","sourceRoot":"","sources":["../../src/ElementTreeWalker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAyB,MAAM,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAChG,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1G,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,cAAc,GAAG,GAAG,qBAAqB,CAAC,QAAQ,oBAAoB,CAAC;AAK7E,SAAS,yBAAyB,CAAC,MAAgB,EAAE,GAAc;IACjE,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,QAAQ,KAAK,SAAS,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAClD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;;YAEnB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QACvB,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnB,OAAO,CAAC,GAAG,yBAAyB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,YAAY,CAAC,MAAgB,EAAE,OAAmB;IACzD,OAAO,MAAM,CAAC,qBAAqB,CAAC,wBAAwB,OAAO,CAAC,aAAa,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE;QAC/G,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAY;IACrC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,YAAY,eAAe,CAAC,CAAC;AACvF,CAAC;AAED,IAAK,4BAA0J;AAA/J,WAAK,4BAA4B;IAAG,+GAAwB,CAAA;IAAE,iHAAyB,CAAA;IAAE,uHAA4B,CAAA;IAAE,yIAAqC,CAAA;AAAE,CAAC,EAA1J,4BAA4B,KAA5B,4BAA4B,QAA8H;AAE/J,SAAS,yBAAyB,CAAC,MAAgB,EAAE,SAAqB;IACxE,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,sJAAsJ;IACtJ,mJAAmJ;IACnJ,uCAAuC;IACvC,IAAI,EAAE,YAAY,mBAAmB;QACnC,OAAO,4BAA4B,CAAC,iCAAiC,CAAC;IACxE,OAAO,CAAC,EAAE,YAAY,OAAO,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;QACnF,CAAC,EAAE,YAAY,iBAAiB,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,wBAAwB,CAAC,CAAC;YACzF,CAAC,EAAE,YAAY,mBAAmB,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,iCAAiC,CAAC,CAAC;gBACpG,4BAA4B,CAAC,oBAAoB,CAAC;AAC1D,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,sBAAsB;IACjB,UAAU,GAAe,EAAE,CAAC;IAC5C,mDAAmD;IACnC,IAAI,GAAmD,EAAE,CAAC;IAC1E,uFAAuF;IACvE,kBAAkB,CAA6B;IAI/D,YAAY,IAAyC,EAAE,IAAwB;QAC7E,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,qBAAqB;YACrB,MAAM,CAAC,IAAI,YAAY,KAAK,CAAC,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxG,CAAC;aAAM,IAAI,IAAI,YAAY,sBAAsB,EAAE,CAAC;YAClD,wBAAwB;YACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;YAClC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,kBAAkB;gBAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACN,2BAA2B;gBAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACxG,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,IAAW,cAAc,KAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5E,IAAW,iBAAiB,KAAc,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,sDAAsD;IACpJ,IAAW,iBAAiB,KAAc,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAE5G,MAAM,CAAC,cAAc,CAAC,MAAgB,EAAE,YAAwB;QACrE,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QAC5D,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACjE,OAAO,IAAI,sBAAsB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IACnE,CAAC;IAEO,OAAO,CAAC,CAA0C;QACxD,IAAI,OAAO,CAAC,KAAK,QAAQ;YACvB,OAAO,WAAW,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACtE,CAAC;IAEM,QAAQ;QACb,OAAO,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACpE,CAAC;CACF;AAED,SAAS,UAAU,CAAC,MAAgB,EAAE,SAAqB;IACzD,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjD,OAAO,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,aAAa,IAAI,EAAE,CAAC,eAAe,EAAE,EAAE,CAAC;AAChE,CAAC;AAED,SAAS,QAAQ,CAAC,KAAY;IAC5B,OAAO,GAAG,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;AAC5D,CAAC;AAED,IAAI,qBAAqB,GAAG,CAAC,CAAC,CAAC;AAE/B,SAAS,cAAc;IACrB,IAAI,qBAAqB,KAAK,CAAC,CAAC;QAC9B,qBAAqB,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnF,OAAO,qBAAqB,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,UAAU,CAAC,EAAU,EAAE,MAAgB,EAAE,SAAqB,EAAE,KAA8B,EAAE,WAAqB;IAC5H,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO;IAET,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAE3G,IAAI,WAAW;QACb,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;AAC3G,CAAC;AAED,SAAS,QAAQ,CAAC,EAAU,EAAE,MAAgB,EAAE,OAAmB,EAAE,KAA8B,EAAE,WAAqB;IACxH,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO;IACT,MAAM,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACrD,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAE7F,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,CAAC,qBAAqB,CAAC,4BAA4B,OAAO,CAAC,aAAa,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5G,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YACxB,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC9C,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YACtD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,mBAAmB;IACjB;IAAtB,YAAsB,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;IAAI,CAAC;IAE5C,gEAAgE;IACtD,kBAAkB,CAAC,MAAa,EAAE,MAA8B,IAAa,OAAO,IAAI,CAAC,CAAC,CAAC;IACrG,2FAA2F;IACjF,qBAAqB,CAAC,SAAqB,EAAE,MAA8B,IAAa,OAAO,IAAI,CAAC,CAAC,CAAC;IAChH,2DAA2D;IACjD,kBAAkB,CAAC,UAAsB,EAAE,MAA8B,IAAa,OAAO,IAAI,CAAC,CAAC,CAAC;IAC9G,yDAAyD;IAC/C,gBAAgB,CAAC,MAAa,EAAE,MAA8B,IAAa,OAAO,IAAI,CAAC,CAAC,CAAC;IAQnG,qCAAqC;IAC3B,kBAAkB,CAAC,OAAmB,EAAE,KAA6B;QAC7E,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAQ,OAAO,CAAC,CAAC;QACjE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC;gBAC1C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAEzC,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC;gBACxC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,KAAK,CAAC;YAC5C,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAExC,IAAI,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC;YACzC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,2DAA2D;IACnD,gBAAgB,CAAC,aAAyB,EAAE,WAAmC;QACrF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACpE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YACvB,OAAO;QAET,MAAM,aAAa,GAAG,IAAI,sBAAsB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAE7E,KAAK,MAAM,YAAY,IAAI,QAAQ;YACjC,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;IAED,kDAAkD;IAC1C,gBAAgB,CAAC,KAAY,EAAE,UAAkC;QACvE,MAAM,KAAK,GAAG,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC5D,8FAA8F;QAC9F,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,6EAA6E,EAAE,CAAC,IAAI,EAAE,EAAE;YACzH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC3C,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,yEAAyE;AACzE,MAAM,eAAe;IACZ,gBAAgB,GAAc,EAAE,CAAC;IACjC,WAAW,GAAc,EAAE,CAAC;IAC5B,QAAQ,GAAc,EAAE,CAAC;IAEzB,oBAAoB,CAAC,MAAgB,EAAE,SAAqB;QACjE,iCAAiC;QACjC,MAAM,GAAG,GAAG,yBAAyB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACzD,IAAI,GAAG,KAAK,4BAA4B,CAAC,qBAAqB,EAAE,CAAC;YAC/D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,IAAI,GAAG,KAAK,4BAA4B,CAAC,wBAAwB,EAAE,CAAC;YACzE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,IAAI,GAAG,KAAK,4BAA4B,CAAC,iCAAiC,EAAE,CAAC;YAClF,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC,CAAC,wBAAwB;IACxC,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,MAAgB;QAC3C,gGAAgG;QAChG,8FAA8F;QAC9F,8FAA8F;QAC9F,gHAAgH;QAChH,gFAAgF;QAChF,6GAA6G;QAC7G,0GAA0G;QAC1G,mDAAmD;QACnD,KAAK,MAAM,WAAW,IAAI,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9E,IAAI,cAAc,EAAE;gBAClB,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;YAElE,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC,qDAAqD;QAC9G,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC7B,QAAQ,CAAC,iFAAiF,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC1H,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBAC7B,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClD,UAAU,CAAC,8EAA8E,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YACzH,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;gBAChC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;IACH,CAAC;CAEF;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,mBAAmB;IAC/C,QAAQ,GAAoB,IAAI,eAAe,EAAE,CAAC;IAEzC,kBAAkB,CAAC,MAAa,IAAa,OAAO,IAAI,CAAC,CAAC,CAAC;IAC3D,kBAAkB,CAAC,UAAsB,IAAa,OAAO,IAAI,CAAC,CAAC,CAAC;IAEpE,UAAU,CAAC,KAAY,EAAE,MAA8B;QACxE,IAAI,iBAAiB,CAAC,KAAK,CAAC;YAC1B,OAAO,CAAC,sGAAsG;QAEhH,4GAA4G;QAC5G,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,KAAK,CAAC,MAAM,EAAE,CAAC;IACjB,CAAC;IAEkB,YAAY,CAAC,SAAqB,EAAE,MAA8B;QACnF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;YACjE,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACtD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,UAAsB,EAAE,KAA8B;QAChF,MAAM,QAAQ,GAAG,KAAK,IAAI,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1F,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE;IACnD,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CAEF;AAED;;;;;GAKG;AACH,MAAe,kBAAkB;IACT;IAAtB,YAAsB,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;IAAI,CAAC;IAE5C,0DAA0D;IAChD,WAAW,CAAC,UAAsB,EAAE,MAA8B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAI9F,kBAAkB,CAAC,OAAmB,EAAE,KAA6B;QAE7E,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAQ,OAAO,CAAC,CAAC;QACjE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,OAAmB,EAAE,KAA6B;QACzE,IAAI,WAA+C,CAAC;QACpD,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YACxE,IAAI,WAAW,KAAK,SAAS;gBAC3B,WAAW,GAAG,IAAI,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC3D,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,QAAe,EAAE,KAA6B;QACrE,MAAM,aAAa,GAAG,IAAI,sBAAsB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAClE,yFAAyF;QACzF,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,6EAA6E,EAAE,CAAC,IAAI,EAAE,EAAE;YACzH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC5B,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC3C,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACpD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CAEF;AAUD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,kBAAkB;IACnD,YAAY,CAAqB;IACjC,cAAc,CAA6B;IAEnD;;;;;OAKG;IACH,YAAmB,MAAgB,EAAE,aAAyC;QAC5E,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAEkB,WAAW,CAAC,SAAqB,EAAE,KAA6B,IAAa,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAErI,KAAK,CAAC,SAAqB,EAAE,KAA6B;QAClE,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED;;uFAEmF;IAC5E,2BAA2B,CAAC,UAAsB,EAAE,KAA8B;QACvF,MAAM,QAAQ,GAAG,KAAK,IAAI,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1F,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,uEAAuE;IACxH,CAAC;IAED;;OAEG;IACI,4BAA4B;QACjC,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,CAAC;IAC5C,CAAC;CACF;AA2BD,gBAAgB;AAChB,MAAM,UAAU,iBAAiB,CAAC,IAAsC,EAAE,IAAiB;IACzF,IAAI,SAAS,CAAC;IACd,IAAI,MAAgB,CAAC;IACrB,IAAI,UAAsB,CAAC;IAC3B,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;QAC7B,MAAM,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;QACjC,MAAM,GAAG,IAAI,CAAC;QACd,UAAU,GAAG,IAAI,CAAC;IACpB,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACrB,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAC7B,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,SAAS,GAAG,SAAS,IAAI,CAAC,CAAC;IAC3B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,GAAG,CAAC;QACF,MAAM,GAAG,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3C,GAAG,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACrC,GAAG,CAAC,qBAAqB,EAAE,CAAC;IAC9B,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,EAAE;AAC9F,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAgB,EAAE,UAAsB,EAAE,MAAkC;IAChH,MAAM,GAAG,GAAG,IAAI,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtD,GAAG,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC;IAC5C,GAAG,CAAC,4BAA4B,EAAE,CAAC;AACrC,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 Elements\n */\nimport { assert, DbResult, Id64Array, Id64String, Logger, LogLevel } from \"@itwin/core-bentley\";\nimport { IModel } from \"@itwin/core-common\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { DefinitionContainer, DefinitionElement, DefinitionPartition, Element, Subject } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { DefinitionModel, Model } from \"./Model\";\n\nconst loggerCategory = `${BackendLoggerCategory.IModelDb}.ElementTreeWalker`;\n\n/** @beta */\nexport interface ElementTreeWalkerModelInfo { model: Model, isDefinitionModel: boolean }\n\nfunction sortChildrenBeforeParents(iModel: IModelDb, ids: Id64Array): Array<Id64Array> {\n  const children: Id64Array = [];\n  const parents: Id64Array = [];\n  for (const eid of ids) {\n    const parentId = iModel.elements.queryParent(eid);\n    if (parentId !== undefined && ids.includes(parentId))\n      children.push(eid);\n    else\n      parents.push(eid);\n  }\n\n  if (children.length === 0)\n    return [parents];\n\n  return [...sortChildrenBeforeParents(iModel, children), parents];\n}\n\nfunction isModelEmpty(iModel: IModelDb, modelId: Id64String): boolean {\n  return iModel.withPreparedStatement(`select count(*) from ${Element.classFullName} where Model.Id = ?`, (stmt) => {\n    stmt.bindId(1, modelId);\n    stmt.step();\n    return stmt.getValue(0).getInteger() === 0;\n  });\n}\n\nfunction isDefinitionModel(model: Model): boolean {\n  return (model.id !== IModel.repositoryModelId) && (model instanceof DefinitionModel);\n}\n\nenum ElementPruningClassification { PRUNING_CLASS_Normal = 0, PRUNING_CLASS_Subject = 1, PRUNING_CLASS_Definition = 2, PRUNING_CLASS_DefinitionPartition = 3, }\n\nfunction classifyElementForPruning(iModel: IModelDb, elementId: Id64String): ElementPruningClassification {\n  const el = iModel.elements.getElement(elementId);\n  // DefinitionContainer is submodeled by a DefinitionModel and so it must be classified as PRUNING_CLASS_DefinitionPartition for tree-walking purposes.\n  // Since DefinitionContainer is-a DefinitionElement the (el instanceof DefinitionElement) case below would classify it as PRUNING_CLASS_Definition.\n  // That is why we special-case it here.\n  if (el instanceof DefinitionContainer)\n    return ElementPruningClassification.PRUNING_CLASS_DefinitionPartition;\n  return (el instanceof Subject) ? ElementPruningClassification.PRUNING_CLASS_Subject :\n    (el instanceof DefinitionElement) ? ElementPruningClassification.PRUNING_CLASS_Definition :\n      (el instanceof DefinitionPartition) ? ElementPruningClassification.PRUNING_CLASS_DefinitionPartition :\n        ElementPruningClassification.PRUNING_CLASS_Normal;\n}\n\n/** Records the path that a tree search took to reach an element or model. This object is immutable.\n * @beta\n */\nexport class ElementTreeWalkerScope {\n  public readonly topElement: Id64String = \"\";\n  /** path of parent elements and enclosing models */\n  public readonly path: Array<Id64String | ElementTreeWalkerModelInfo> = [];\n  /** cached info about the immediately enclosing model (i.e., the last model in path) */\n  public readonly enclosingModelInfo: ElementTreeWalkerModelInfo;\n\n  constructor(topElement: Id64String, model: Model);\n  constructor(enclosingScope: ElementTreeWalkerScope, newScope: Id64String | Model);\n  constructor(arg1: Id64String | ElementTreeWalkerScope, arg2: Model | Id64String) {\n    if (typeof arg1 === \"string\") {\n      // normal constructor\n      assert(arg2 instanceof Model);\n      this.topElement = arg1;\n      this.path.push(this.enclosingModelInfo = { model: arg2, isDefinitionModel: isDefinitionModel(arg2) });\n    } else if (arg1 instanceof ElementTreeWalkerScope) {\n      // copy-like constructor\n      this.topElement = arg1.topElement;\n      this.path = [...arg1.path];\n      if (typeof arg2 === \"string\") {\n        // with new parent\n        this.path.push(arg2);\n        this.enclosingModelInfo = arg1.enclosingModelInfo;\n      } else {\n        // with new enclosing model\n        this.path.push(this.enclosingModelInfo = { model: arg2, isDefinitionModel: isDefinitionModel(arg2) });\n      }\n    } else {\n      throw new Error(\"invalid constructor signature\");\n    }\n  }\n\n  public get enclosingModel(): Model { return this.enclosingModelInfo.model; }\n  public get inDefinitionModel(): boolean { return this.enclosingModelInfo.isDefinitionModel; } // NB: this will return false for the RepositoryModel!\n  public get inRepositoryModel(): boolean { return this.enclosingModelInfo.model.id === IModelDb.repositoryModelId; }\n\n  public static createTopScope(iModel: IModelDb, topElementId: Id64String) {\n    const topElement = iModel.elements.getElement(topElementId);\n    const topElementModel = iModel.models.getModel(topElement.model);\n    return new ElementTreeWalkerScope(topElementId, topElementModel);\n  }\n\n  private fmtItem(v: Id64String | ElementTreeWalkerModelInfo): string {\n    if (typeof v === \"string\")\n      return `element ${v}`;\n    return `model ${v.model.id} ${v.isDefinitionModel ? \"(DEFN)\" : \"\"}`;\n  }\n\n  public toString(): string {\n    return `[ ${this.path.map((v) => this.fmtItem(v)).join(\" / \")} ]`;\n  }\n}\n\nfunction fmtElement(iModel: IModelDb, elementId: Id64String): string {\n  const el = iModel.elements.getElement(elementId);\n  return `${el.id} ${el.classFullName} ${el.getDisplayLabel()}`;\n}\n\nfunction fmtModel(model: Model): string {\n  return `${model.id} ${model.classFullName} ${model.name}`;\n}\n\nlet isTraceEnabledChecked = -1;\n\nfunction isTraceEnabled(): boolean {\n  if (isTraceEnabledChecked === -1)\n    isTraceEnabledChecked = Logger.isEnabled(loggerCategory, LogLevel.Trace) ? 1 : 0;\n  return isTraceEnabledChecked === 1;\n}\n\nfunction logElement(op: string, iModel: IModelDb, elementId: Id64String, scope?: ElementTreeWalkerScope, logChildren?: boolean): void {\n  if (!isTraceEnabled())\n    return;\n\n  Logger.logTrace(loggerCategory, `${op} ${fmtElement(iModel, elementId)} ${scope ? scope.toString() : \"\"}`);\n\n  if (logChildren)\n    iModel.elements.queryChildren(elementId).forEach((c) => logElement(\" - \", iModel, c, undefined, true));\n}\n\nfunction logModel(op: string, iModel: IModelDb, modelId: Id64String, scope?: ElementTreeWalkerScope, logElements?: boolean): void {\n  if (!isTraceEnabled())\n    return;\n  const model: Model = iModel.models.getModel(modelId);\n  Logger.logTrace(loggerCategory, `${op} ${fmtModel(model)} ${scope ? scope.toString() : \"\"}`);\n\n  if (logElements) {\n    iModel.withPreparedStatement(`select ecinstanceid from ${Element.classFullName} where Model.Id = ?`, (stmt) => {\n      stmt.bindId(1, modelId);\n      while (stmt.step() === DbResult.BE_SQLITE_ROW) {\n        logElement(\" - \", iModel, stmt.getValue(0).getId());\n      }\n    });\n  }\n}\n\n/** Does a depth-first search on the tree defined by an element and its sub-models and children.\n * Sub-models are visited before their modeled elements, and children are visited before their parents.\n *\n * The following callbacks allow the subclass to exclude elements and sub-trees from the search:\n *  * [[ElementTreeBottomUp.shouldExploreModel]], [[ElementTreeBottomUp.shouldExploreChildren]]\n *  * [[ElementTreeBottomUp.shouldVisitElement]], [[ElementTreeBottomUp.shouldVisitModel]]\n *\n * The [[ElementTreeBottomUp.visitElement]] and [[ElementTreeBottomUp.visitModel]] callbacks allow\n * the subclass to process the elements and models that are encountered in the search.\n * @beta\n */\nexport abstract class ElementTreeBottomUp {\n  constructor(protected _iModel: IModelDb) { }\n\n  /** Return true if the search should recurse into this model  */\n  protected shouldExploreModel(_model: Model, _scope: ElementTreeWalkerScope): boolean { return true; }\n  /** Return true if the search should recurse into the children (if any) of this element  */\n  protected shouldExploreChildren(_parentId: Id64String, _scope: ElementTreeWalkerScope): boolean { return true; }\n  /** Return true if the search should visit this element  */\n  protected shouldVisitElement(_elementId: Id64String, _scope: ElementTreeWalkerScope): boolean { return true; }\n  /** Return true if the search should visit this model  */\n  protected shouldVisitModel(_model: Model, _scope: ElementTreeWalkerScope): boolean { return true; }\n\n  /** Called to visit a model */\n  protected abstract visitModel(model: Model, scope: ElementTreeWalkerScope): void;\n\n  /** Called to visit an element */\n  protected abstract visitElement(elementId: Id64String, scope: ElementTreeWalkerScope): void;\n\n  /** The main tree-walking function */\n  protected processElementTree(element: Id64String, scope: ElementTreeWalkerScope) {\n    const subModel = this._iModel.models.tryGetModel<Model>(element);\n    if (subModel !== undefined) {\n      if (this.shouldExploreModel(subModel, scope))\n        this._processSubModel(subModel, scope);\n\n      if (this.shouldVisitModel(subModel, scope))\n        this.visitModel(subModel, scope);\n    }\n\n    if (this.shouldExploreChildren(element, scope))\n      this._processChildren(element, scope);\n\n    if (this.shouldVisitElement(element, scope))\n      this.visitElement(element, scope);\n  }\n\n  /** process the children of the specified parent element */\n  private _processChildren(parentElement: Id64String, parentScope: ElementTreeWalkerScope): void {\n    const children = this._iModel.elements.queryChildren(parentElement);\n    if (children.length === 0)\n      return;\n\n    const childrenScope = new ElementTreeWalkerScope(parentScope, parentElement);\n\n    for (const childElement of children)\n      this.processElementTree(childElement, childrenScope);\n  }\n\n  /** process the elements in the specified model */\n  private _processSubModel(model: Model, parenScope: ElementTreeWalkerScope): void {\n    const scope = new ElementTreeWalkerScope(parenScope, model);\n    // Visit only the top-level parents. processElementTree will visit their children (bottom-up).\n    model.iModel.withPreparedStatement(`select ECInstanceId from bis:Element where Model.id=? and Parent.Id is null`, (stmt) => {\n      stmt.bindId(1, model.id);\n      while (stmt.step() === DbResult.BE_SQLITE_ROW) {\n        const elementId = stmt.getValue(0).getId();\n        this.processElementTree(elementId, scope);\n      }\n    });\n  }\n}\n\n/** Helper class that manages the deletion of definitions and subjects */\nclass SpecialElements {\n  public definitionModels: Id64Array = [];\n  public definitions: Id64Array = [];\n  public subjects: Id64Array = [];\n\n  public recordSpecialElement(iModel: IModelDb, elementId: Id64String): boolean {\n    // Defer Definitions and Subjects\n    const cls = classifyElementForPruning(iModel, elementId);\n    if (cls === ElementPruningClassification.PRUNING_CLASS_Subject) {\n      this.subjects.push(elementId);\n      return true;\n    } else if (cls === ElementPruningClassification.PRUNING_CLASS_Definition) {\n      this.definitions.push(elementId);\n      return true;\n    } else if (cls === ElementPruningClassification.PRUNING_CLASS_DefinitionPartition) {\n      this.definitionModels.push(elementId);\n      return true;\n    }\n    return false; // not a special element\n  }\n\n  /** Delete special elements - This calls Elements.deleteDefinitionElements to process the collected definition elements as a group and then\n   * calls Models.deleteModel on collected definition models. It then deletes all collected Subjects by calling Element.deleteElement on them.\n   * @note Caller must ensure that the special elements were recorded in a depth-first search.\n   */\n  public deleteSpecialElements(iModel: IModelDb) {\n    // It's dangerous to pass a mixture of SubCategories and Categories to deleteDefinitionElements.\n    // That function will delete the Categories first, which automatically deletes all their child\n    // SubCategories (in native code). If a SubCategory in the list is one of those children, then\n    // deleteDefinitionElements will try and fail with an exception to delete that SubCategory in a subsequent step.\n    // To work around this, we delete the SubCategories first, then everything else.\n    // A similar problem occurs when you pass other kinds of elements to deleteDefinitionElements, where some are\n    // children and others are parents. deleteDefinitionElements does not preserve the order that you specify,\n    // and it does not process children before parents.\n    for (const definitions of sortChildrenBeforeParents(iModel, this.definitions)) {\n      if (isTraceEnabled())\n        definitions.forEach((e) => logElement(\"try delete\", iModel, e));\n\n      iModel.elements.deleteDefinitionElements(definitions); // will not delete definitions that are still in use.\n    }\n\n    for (const m of this.definitionModels) {\n      if (!isModelEmpty(iModel, m)) {\n        logModel(\"Model not empty - cannot delete - may contain Definitions that are still in use\", iModel, m, undefined, true);\n      } else {\n        logModel(\"delete\", iModel, m);\n        iModel.models.deleteModel(m);\n        iModel.elements.deleteElement(m);\n      }\n    }\n\n    for (const e of this.subjects) {\n      if (iModel.elements.queryChildren(e).length !== 0) {\n        logElement(\"Subject still has children - cannot delete - may have child DefinitionModels\", iModel, e, undefined, true);\n      } else {\n        logElement(\"delete\", iModel, e);\n        iModel.elements.deleteElement(e);\n      }\n    }\n  }\n\n}\n\n/** Deletes an entire element tree, including sub-models and child elements.\n * Items are deleted in bottom-up order. Definitions and Subjects are deleted after normal elements.\n * Call deleteNormalElements on each tree. Then call deleteSpecialElements.\n * @see deleteElementTree for a simple way to use this class.\n * @beta\n */\nexport class ElementTreeDeleter extends ElementTreeBottomUp {\n  protected _special: SpecialElements = new SpecialElements();\n\n  protected override shouldExploreModel(_model: Model): boolean { return true; }\n  protected override shouldVisitElement(_elementId: Id64String): boolean { return true; }\n\n  protected override visitModel(model: Model, _scope: ElementTreeWalkerScope): void {\n    if (isDefinitionModel(model))\n      return; // we recorded definition models in visitElement when we encountered the DefinitionPartition elements.\n\n    // visitElement has already deleted the elements in the model. So, now it's safe to delete the model itself.\n    logModel(\"delete\", this._iModel, model.id, _scope);\n    model.delete();\n  }\n\n  protected override visitElement(elementId: Id64String, _scope: ElementTreeWalkerScope): void {\n    if (!this._special.recordSpecialElement(this._iModel, elementId)) {\n      logElement(\"delete\", this._iModel, elementId, _scope);\n      this._iModel.elements.deleteElement(elementId);\n    }\n  }\n\n  /**\n   * Delete the \"normal\" elements and record the special elements for deferred processing.\n   * @param topElement The parent of the sub-tree to be deleted. Top element itself is also deleted.\n   * @param scope How the parent was found\n   * @see deleteSpecialElements\n   */\n  public deleteNormalElements(topElement: Id64String, scope?: ElementTreeWalkerScope): void {\n    const topScope = scope ?? ElementTreeWalkerScope.createTopScope(this._iModel, topElement);\n    this.processElementTree(topElement, topScope); //\n  }\n\n  /** Delete all special elements that were found and deferred by deleteNormalElements. Call this\n   * function once after all element trees are processed by deleteNormalElements.\n   */\n  public deleteSpecialElements(): void {\n    this._special.deleteSpecialElements(this._iModel);\n  }\n\n}\n\n/** Does a breadth-first search on the tree defined by an element and its sub-models and children.\n * Parents are visited first, then children, then sub-models.\n * The subclass can \"prune\" sub-trees from the search. When a sub-tree is \"pruned\" the search does *not* recurse into it.\n * If a sub-tree is not pruned, then the search does recurse into it.\n * @beta\n */\nabstract class ElementTreeTopDown {\n  constructor(protected _iModel: IModelDb) { }\n\n  /** Should the search *not* recurse into this sub-tree? */\n  protected shouldPrune(_elementId: Id64String, _scope: ElementTreeWalkerScope): boolean { return false; }\n\n  protected abstract prune(_elementId: Id64String, _scope: ElementTreeWalkerScope): void;\n\n  protected processElementTree(element: Id64String, scope: ElementTreeWalkerScope) {\n\n    if (this.shouldPrune(element, scope)) {\n      this.prune(element, scope);\n      return;\n    }\n\n    this._processChildren(element, scope);\n\n    const subModel = this._iModel.models.tryGetModel<Model>(element);\n    if (subModel !== undefined) {\n      this._processSubModel(subModel, scope);\n    }\n  }\n\n  private _processChildren(element: Id64String, scope: ElementTreeWalkerScope) {\n    let parentScope: ElementTreeWalkerScope | undefined;\n    for (const childElement of this._iModel.elements.queryChildren(element)) {\n      if (parentScope === undefined)\n        parentScope = new ElementTreeWalkerScope(scope, element);\n      this.processElementTree(childElement, parentScope);\n    }\n  }\n\n  private _processSubModel(subModel: Model, scope: ElementTreeWalkerScope) {\n    const subModelScope = new ElementTreeWalkerScope(scope, subModel);\n    // Visit only the top-level parents. processElementTree will recurse into their children.\n    this._iModel.withPreparedStatement(`select ECInstanceId from bis:Element where Model.id=? and Parent.Id is null`, (stmt) => {\n      stmt.bindId(1, subModel.id);\n      while (stmt.step() === DbResult.BE_SQLITE_ROW) {\n        const elementId = stmt.getValue(0).getId();\n        this.processElementTree(elementId, subModelScope);\n      }\n    });\n  }\n\n}\n\n/** Signature of the filter function used by ElementSubTreeDeleter.\n * @param elementId The sub-tree parent element.\n * @param scope The path followed by the top-down search to the element\n * @return true if the element and its children and sub-models should be deleted.\n * @beta\n */\nexport type ElementSubTreeDeleteFilter = (elementId: Id64String, scope: ElementTreeWalkerScope) => boolean;\n\n/** Performs a breadth-first search to visit elements in top-down order.\n * When the supplied filter function chooses an element, ElementTreeDeleter is used to delete it and its sub-tree.\n * @beta\n */\nexport class ElementSubTreeDeleter extends ElementTreeTopDown {\n  private _treeDeleter: ElementTreeDeleter;\n  private _shouldPruneCb: ElementSubTreeDeleteFilter;\n\n  /** Construct an ElementSubTreeDeleter.\n   * @param iModel The iModel\n   * @param topElement Where to start the search.\n   * @param shouldPruneCb Callback that selects sub-trees that should be deleted.\n   * @see deleteElementSubTrees for a simple way to use this class.\n   */\n  public constructor(iModel: IModelDb, shouldPruneCb: ElementSubTreeDeleteFilter) {\n    super(iModel);\n    this._treeDeleter = new ElementTreeDeleter(this._iModel);\n    this._shouldPruneCb = shouldPruneCb;\n  }\n\n  protected override shouldPrune(elementId: Id64String, scope: ElementTreeWalkerScope): boolean { return this._shouldPruneCb(elementId, scope); }\n\n  protected prune(elementId: Id64String, scope: ElementTreeWalkerScope): void {\n    this._treeDeleter.deleteNormalElements(elementId, scope);\n  }\n\n  /** Traverses the tree of elements beginning with the top element, and deletes all selected sub-trees.\n   * Normal elements are deleted. Any special elements that are encountered are deferred.\n   * Call deleteSpecialElementSubTrees after all top elements have been processed. */\n  public deleteNormalElementSubTrees(topElement: Id64String, scope?: ElementTreeWalkerScope) {\n    const topScope = scope ?? ElementTreeWalkerScope.createTopScope(this._iModel, topElement);\n    this.processElementTree(topElement, topScope); // deletes normal elements and their sub-trees, defers special elements\n  }\n\n  /** Delete all special elements and their sub-trees that were found in the course of processing.\n   * The sub-trees were already expanded by ElementTreeDeleter.deleteNormalElements.\n   */\n  public deleteSpecialElementSubTrees() {\n    this._treeDeleter.deleteSpecialElements();\n  }\n}\n\n/** Arguments supplied to [[deleteElementTree]].\n * @beta\n */\nexport interface DeleteElementTreeArgs {\n  /** The iModel containing the elements to delete. */\n  iModel: IModelDb;\n  /** The Id of the root element of the tree to delete. */\n  topElement: Id64String;\n  /** The maximum number of passes to make when deleting definition elements.\n   * Default: 5\n   */\n  maxPasses?: number;\n}\n\n/** Deletes an element tree starting with the specified top element. The top element is also deleted. Uses ElementTreeDeleter.\n * @param iModel The iModel\n * @param topElement The parent of the sub-tree\n * @beta\n */\nexport function deleteElementTree(iModel: IModelDb, topElement: Id64String): void;\n/** Deletes an element tree starting with the specified top element. The top element is also deleted. Uses ElementTreeDeleter.\n * @param args Specifies the iModel and top element.\n * @beta\n */\nexport function deleteElementTree(args: DeleteElementTreeArgs): void;\n/** @internal */\nexport function deleteElementTree(arg0: DeleteElementTreeArgs | IModelDb, arg1?: Id64String): void {\n  let maxPasses;\n  let iModel: IModelDb;\n  let topElement: Id64String;\n  if (arg0 instanceof IModelDb) {\n    assert(typeof arg1 === \"string\");\n    iModel = arg0;\n    topElement = arg1;\n  } else {\n    iModel = arg0.iModel;\n    topElement = arg0.topElement;\n    maxPasses = arg0.maxPasses;\n  }\n\n  maxPasses = maxPasses ?? 5;\n  let pass = 0;\n  do {\n    const del = new ElementTreeDeleter(iModel);\n    del.deleteNormalElements(topElement);\n    del.deleteSpecialElements();\n  } while ((iModel.elements.tryGetElement(topElement) !== undefined) && (++pass < maxPasses));\n}\n\n/** Deletes all element sub-trees that are selected by the supplied filter. Uses ElementSubTreeDeleter.\n * If the filter selects the top element itself, then the entire tree (including the top element) is deleted.\n * That has the same effect as calling [[deleteElementTree]] on the top element.\n * @note The caller may have to call this function multiple times if there are multiple layers of dependencies among definition elements.\n * @param iModel The iModel\n * @param topElement Where to start the search.\n * @param filter Callback that selects sub-trees that should be deleted.\n * @beta\n */\nexport function deleteElementSubTrees(iModel: IModelDb, topElement: Id64String, filter: ElementSubTreeDeleteFilter): void {\n  const del = new ElementSubTreeDeleter(iModel, filter);\n  del.deleteNormalElementSubTrees(topElement);\n  del.deleteSpecialElementSubTrees();\n}\n"]}

package/lib/esm/Entity.d.ts

@@ -0,0 +1,142 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { EntityProps, EntityReferenceSet, PropertyCallback } from "@itwin/core-common";
+import type { IModelDb } from "./IModelDb";
+import { Schema } from "./Schema";
+import { EntityClass, PropertyHandler, SchemaItemKey } from "@itwin/ecschema-metadata";
+/** Represents one of the fundamental building block in an [[IModelDb]]: as an [[Element]], [[Model]], or [[Relationship]].
+ * Every subclass of Entity represents one BIS [ECClass]($ecschema-metadata).
+ * An Entity is typically instantiated from an [EntityProps]($common) and can be converted back to this representation via [[Entity.toJSON]].
+ * @public
+ */
+export declare class Entity {
+    /** An immutable property used to discriminate between [[Entity]] and [EntityProps]($common), used to inform the TypeScript compiler that these two types
+     * are never substitutable for one another. To obtain an EntityProps from an Entity, use [[Entity.toJSON]].
+     */
+    readonly isInstanceOfEntity: true;
+    /** The Schema that defines this class. */
+    static schema: typeof Schema;
+    private get _ctor();
+    /** The name of the BIS class associated with this class.
+     * @note Every subclass of Entity **MUST** override this method to identify its BIS class.
+     * Failure to do so will ordinarily result in an error when the class is registered, since there may only
+     * be one JavaScript class for a given BIS class (usually the errant class will collide with its superclass.)
+     */
+    static get className(): string;
+    /** Serves as a unique identifier for this class. Typed variant of [[classFullName]].
+     * @beta
+     */
+    static get schemaItemKey(): SchemaItemKey;
+    private _metadata?;
+    /** When working with an Entity it can be useful to set property values directly, bypassing the compiler's type checking.
+     * This property makes such code slightly less tedious to read and write.
+     * @internal
+     */
+    get asAny(): any;
+    /** The name of the BIS Schema that defines this class */
+    get schemaName(): string;
+    /** The name of the BIS class associated with this class. */
+    get className(): string;
+    /** The [[IModelDb]] that contains this Entity */
+    iModel: IModelDb;
+    /** The Id of this Entity. May be invalid if the Entity has not yet been saved in the database. */
+    id: Id64String;
+    protected constructor(props: EntityProps, iModel: IModelDb);
+    /** Invoke the constructor of the specified `Entity` subclass.
+     * @internal
+     */
+    static instantiate(subclass: typeof Entity, props: EntityProps, iModel: IModelDb): Entity;
+    /** Obtain the JSON representation of this Entity. Subclasses of [[Entity]] typically override this method to return their corresponding sub-type of [EntityProps]($common) -
+     * for example, [[GeometricElement.toJSON]] returns a [GeometricElementProps]($common).
+     */
+    toJSON(): EntityProps;
+    /** Call a function for each property of this Entity.
+     * @param func The callback to be invoked on each property
+     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
+     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
+     * @deprecated in 5.0. Please use `forEach` to get the metadata and iterate over the properties instead.
+     *
+     * @example
+     * ```typescript
+     * // Deprecated method
+     * entity.forEachProperty((name, propMetaData) => {
+     *   console.log(`Property name: ${name}, Property type: ${propMetaData.primitiveType}`);
+     * });
+     *
+     * // New method
+     * entity.forEach((name, property) => {
+     *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
+     * });
+     * ```
+     */
+    forEachProperty(func: PropertyCallback, includeCustom?: boolean): void;
+    /**
+     * Call a function for each property of this Entity.
+     * @param func The callback to be invoked on each property.
+     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
+     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
+     * @throws Error if metadata for the class cannot be retrieved.
+     *
+     * @example
+     * ```typescript
+     * entity.forEach((name, property) => {
+     *   console.log(`Property name: ${name}, Property type: ${property.propertyType}`);
+     * });
+     * ```
+     */
+    forEach(func: PropertyHandler, includeCustom?: boolean): void;
+    /** Get the full BIS class name of this Entity in the form "schema:class" */
+    static get classFullName(): string;
+    /** Get the full BIS class name of this Entity in the form "schema:class". */
+    get classFullName(): string;
+    /**
+     * Get the item key used by the ecschema-metadata package to identify this entity class
+     * @beta
+     */
+    get schemaItemKey(): SchemaItemKey;
+    /** query metadata for this entity class from the iModel's schema
+     * @throws [[IModelError]] if there is a problem querying the schema
+     * @returns The metadata for the current entity
+     * @beta
+     */
+    getMetaData(): Promise<EntityClass>;
+    /** @internal */
+    static get protectedOperations(): string[];
+    /** return whether this Entity class is a subclass of another Entity class
+     * @note the subclass-ness is checked according to JavaScript inheritance, to check the underlying raw EC class's
+     * inheritance, you can use [ECClass.is]($ecschema-metadata)
+     * @note this should have a type of `is<T extends typeof Entity>(otherClass: T): this is T` but can't because of
+     * typescript's restriction on the `this` type in static methods
+     */
+    static is(otherClass: typeof Entity): boolean;
+    /** whether this JavaScript class was generated for this ECClass because there was no registered custom implementation
+     * ClassRegistry overrides this when generating a class
+     * @internal
+     */
+    static get isGeneratedClass(): boolean;
+    /** Get the set of this entity's *entity references*, [EntityReferenceSet]($backend). An *entity reference* is any id
+     * stored on the entity, in its EC properties or json fields.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @see this.collectReferenceIds
+     * @beta
+     */
+    getReferenceIds(): EntityReferenceSet;
+    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
+     * A *reference* is any entity referenced by this entity's EC Data, including json fields.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @param _referenceIds The Id64Set to populate with reference Ids.
+     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
+     * @see getReferenceIds
+     * @beta
+     */
+    protected collectReferenceIds(_referenceIds: EntityReferenceSet): void;
+}
+/** Parameter type that can accept both abstract constructor types and non-abstract constructor types for `instanceof` to test.
+ * @public
+ */
+export type EntityClassType<T> = Function & {
+    prototype: T;
+};
+//# sourceMappingURL=Entity.d.ts.map

package/lib/esm/Entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../../src/Entity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,gBAAgB,EAAoB,MAAM,oBAAoB,CAAC;AACzG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEvF;;;;GAIG;AACH,qBAAa,MAAM;IACjB;;OAEG;IACH,SAAgB,kBAAkB,OAAiB;IACnD,0CAA0C;IAC1C,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO,KAAK,KAAK,GAA+D;IAEhF;;;;OAIG;IACH,WAAkB,SAAS,IAAI,MAAM,CAAqB;IAE1D;;OAEG;IACH,WAAkB,aAAa,IAAI,aAAa,CAG/C;IAED,OAAO,CAAC,SAAS,CAAC,CAAc;IAEhC;;;OAGG;IACH,IAAW,KAAK,IAAI,GAAG,CAAiB;IAExC,yDAAyD;IACzD,IAAW,UAAU,IAAI,MAAM,CAAyC;IAExE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,MAAM,CAAiC;IAE/D,iDAAiD;IAC1C,MAAM,EAAE,QAAQ,CAAC;IAExB,kGAAkG;IAC3F,EAAE,EAAE,UAAU,CAAC;IAGtB,SAAS,aAAa,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ;IAQ1D;;OAEG;WACW,WAAW,CAAC,QAAQ,EAAE,OAAO,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM;IAIhG;;OAEG;IACI,MAAM,IAAI,WAAW;IAU5B;;;;;;;;;;;;;;;;;;OAkBG;IAEI,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,aAAa,GAAE,OAAc;IAK5E;;;;;;;;;;;;;OAaG;IACI,OAAO,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,GAAE,OAAc;IAWnE,4EAA4E;IAC5E,WAAkB,aAAa,IAAI,MAAM,CAA0D;IAEnG,6EAA6E;IAC7E,IAAW,aAAa,IAAI,MAAM,CAAqC;IACvE;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,CAAqC;IAE9E;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC;IAahD,gBAAgB;IAChB,WAAkB,mBAAmB,IAAI,MAAM,EAAE,CAAe;IAEhE;;;;;OAKG;WACW,EAAE,CAAC,UAAU,EAAE,OAAO,MAAM,GAAG,OAAO;IAKpD;;;OAGG;IACH,WAAkB,gBAAgB,YAAoB;IAEtD;;;;;OAKG;IACI,eAAe,IAAI,kBAAkB;IAM5C;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,kBAAkB,GAAG,IAAI;CAGvE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,QAAQ,GAAG;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAC"}