@itwin/presentation-hierarchies 0.1.0

package/lib/cjs/hierarchies/HierarchyProvider.js

@@ -0,0 +1,384 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHierarchyProvider = void 0;
+const rxjs_1 = require("rxjs");
+const core_bentley_1 = require("@itwin/core-bentley");
+const presentation_shared_1 = require("@itwin/presentation-shared");
+const HierarchyDefinition_1 = require("./HierarchyDefinition");
+const HierarchyErrors_1 = require("./HierarchyErrors");
+const HierarchyNode_1 = require("./HierarchyNode");
+const ChildNodeObservablesCache_1 = require("./internal/ChildNodeObservablesCache");
+const Common_1 = require("./internal/Common");
+const EachValueFrom_1 = require("./internal/EachValueFrom");
+const FilteringHierarchyDefinition_1 = require("./internal/FilteringHierarchyDefinition");
+const LoggingUtils_1 = require("./internal/LoggingUtils");
+const DetermineChildren_1 = require("./internal/operators/DetermineChildren");
+const Grouping_1 = require("./internal/operators/Grouping");
+const HideIfNoChildren_1 = require("./internal/operators/HideIfNoChildren");
+const HideNodesInHierarchy_1 = require("./internal/operators/HideNodesInHierarchy");
+const Partition_1 = require("./internal/operators/Partition");
+const ReduceToMergeMap_1 = require("./internal/operators/ReduceToMergeMap");
+const ShareReplayWithErrors_1 = require("./internal/operators/ShareReplayWithErrors");
+const Sorting_1 = require("./internal/operators/Sorting");
+const SubscriptionScheduler_1 = require("./internal/SubscriptionScheduler");
+const TreeNodesReader_1 = require("./internal/TreeNodesReader");
+const NodeSelectQueryFactory_1 = require("./NodeSelectQueryFactory");
+const LOGGING_NAMESPACE = `${Common_1.LOGGING_NAMESPACE}.HierarchyProvider`;
+const PERF_LOGGING_NAMESPACE = `${LOGGING_NAMESPACE}.Performance`;
+const DEFAULT_QUERY_CONCURRENCY = 10;
+const DEFAULT_QUERY_CACHE_SIZE = 1;
+/**
+ * Creates an instance of `HierarchyProvider` that creates a hierarchy based on given iModel and
+ * a hierarchy definition, which defines each hierarchy level through ECSQL queries.
+ *
+ * @beta
+ */
+function createHierarchyProvider(props) {
+    return new HierarchyProviderImpl(props);
+}
+exports.createHierarchyProvider = createHierarchyProvider;
+class HierarchyProviderImpl {
+    _imodelAccess;
+    _valuesFormatter;
+    _localizedStrings;
+    _queryScheduler;
+    _nodesCache;
+    /**
+     * Hierarchy level definitions factory used by this provider.
+     *
+     * @note This does not necessarily match the `hierarchyDefinition` passed through props when constructing
+     * the provider. For example, it may be a factory that decorates given `hierarchyDefinition` with filtering
+     * features.
+     */
+    hierarchyDefinition;
+    /**
+     * A limiting ECSQL query executor used by this provider.
+     * @see HierarchyProviderProps.queryExecutor
+     */
+    get queryExecutor() {
+        return this._imodelAccess;
+    }
+    constructor(props) {
+        this._imodelAccess = props.imodelAccess;
+        this.hierarchyDefinition = props.hierarchyDefinition;
+        if (props.filtering) {
+            const filteringDefinition = new FilteringHierarchyDefinition_1.FilteringHierarchyDefinition({
+                classHierarchy: this._imodelAccess,
+                source: this.hierarchyDefinition,
+                nodeIdentifierPaths: props.filtering.paths,
+            });
+            this.hierarchyDefinition = filteringDefinition;
+        }
+        this._valuesFormatter = props?.formatter ?? (0, presentation_shared_1.createDefaultValueFormatter)();
+        this._localizedStrings = { other: "Other", unspecified: "Not specified", ...props?.localizedStrings };
+        this._queryScheduler = new SubscriptionScheduler_1.SubscriptionScheduler(props.queryConcurrency ?? DEFAULT_QUERY_CONCURRENCY);
+        const queryCacheSize = props.queryCacheSize ?? DEFAULT_QUERY_CACHE_SIZE;
+        if (queryCacheSize !== 0) {
+            this._nodesCache = new ChildNodeObservablesCache_1.ChildNodeObservablesCache({
+                // we divide the size by 2, because each variation also counts as a query that we cache
+                size: Math.ceil(queryCacheSize / 2),
+                variationsCount: 1,
+            });
+        }
+    }
+    /**
+     * Sets `HierarchyProvider` values formatter that formats nodes' labels. If provided `undefined`, then defaults to the
+     * result of `createDefaultValueFormatter` called with default parameters.
+     */
+    setFormatter(formatter) {
+        this._valuesFormatter = formatter ?? (0, presentation_shared_1.createDefaultValueFormatter)();
+    }
+    onGroupingNodeCreated(groupingNode, props) {
+        this._nodesCache?.set({ ...props, parentNode: groupingNode }, { observable: (0, rxjs_1.from)(groupingNode.children), processingStatus: "pre-processed" });
+    }
+    createParsedQueryNodesObservable(props) {
+        (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Requesting hierarchy level definitions for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        });
+        // stream hierarchy level definitions
+        const definitions = (0, rxjs_1.from)((0, rxjs_1.defer)(async () => this.hierarchyDefinition.defineHierarchyLevel(props))).pipe((0, rxjs_1.mergeAll)(), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Received all hierarchy level definitions for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        })));
+        // pipe definitions to nodes and put "share replay" on it
+        return definitions.pipe((0, rxjs_1.mergeMap)((def) => {
+            if (HierarchyDefinition_1.HierarchyNodesDefinition.isCustomNode(def)) {
+                return (0, rxjs_1.of)(def.node);
+            }
+            return this._queryScheduler.scheduleSubscription((0, rxjs_1.of)(def.query).pipe((0, rxjs_1.map)((query) => filterQueryByInstanceKeys(query, props.filteredInstanceKeys)), (0, LoggingUtils_1.log)({
+                category: `${LOGGING_NAMESPACE}.Queries`,
+                message: /* istanbul ignore next */ (query) => `Query direct nodes for parent ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}: ${(0, LoggingUtils_1.createQueryLogMessage)(query)}`,
+            }), (0, rxjs_1.mergeMap)((query) => (0, TreeNodesReader_1.readNodes)({ queryExecutor: this.queryExecutor, query, limit: props.hierarchyLevelSizeLimit, parser: this.hierarchyDefinition.parseNode }))));
+        }), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Read all child nodes ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        })), (0, ShareReplayWithErrors_1.shareReplayWithErrors)());
+    }
+    createInitializedNodesObservable(nodes, parentNode) {
+        return nodes.pipe(
+        // we're going to be mutating the nodes, but don't want to mutate the original one, so just clone it here once
+        (0, rxjs_1.map)((node) => ({ ...node })), 
+        // set parent node keys on the parsed node
+        (0, rxjs_1.map)((node) => Object.assign(node, { parentKeys: createParentNodeKeysList(parentNode) })), 
+        // format `ConcatenatedValue` labels into string labels
+        (0, rxjs_1.mergeMap)(async (node) => applyLabelsFormatting(node, this._imodelAccess, this._valuesFormatter)), 
+        // we have `ProcessedHierarchyNode` from here
+        preProcessNodes(this.hierarchyDefinition), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Finished initializing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(parentNode)}`,
+        })), (0, ShareReplayWithErrors_1.shareReplayWithErrors)());
+    }
+    createPreProcessedNodesObservable(queryNodesObservable, props) {
+        return this.createInitializedNodesObservable(queryNodesObservable, props.parentNode).pipe((0, HideIfNoChildren_1.createHideIfNoChildrenOperator)((n) => this.getChildNodesObservables({ parentNode: n }).hasNodes), (0, HideNodesInHierarchy_1.createHideNodesInHierarchyOperator)(
+        // note: for child nodes created because of hidden parent, we want to use parent's request props (instance filter, limit)
+        (n) => this.getChildNodesObservables({ ...props, parentNode: n }).processedNodes, false), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Finished pre-processing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        })));
+    }
+    createProcessedNodesObservable(preprocessedNodesObservable, props) {
+        return preprocessedNodesObservable.pipe((0, Grouping_1.createGroupingOperator)(this._imodelAccess, props.parentNode, this._valuesFormatter, this._localizedStrings, (gn) => this.onGroupingNodeCreated(gn, props)), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Finished processing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        })));
+    }
+    createFinalizedNodesObservable(processedNodesObservable, props) {
+        return processedNodesObservable.pipe((0, DetermineChildren_1.createDetermineChildrenOperator)((n) => this.getChildNodesObservables({ parentNode: n }).hasNodes), postProcessNodes(this.hierarchyDefinition), Sorting_1.sortNodesByLabelOperator, (0, rxjs_1.map)((n) => {
+            if (HierarchyNode_1.HierarchyNode.isCustom(n) || HierarchyNode_1.HierarchyNode.isInstancesNode(n)) {
+                delete n.processingParams;
+            }
+            return Object.assign(n, {
+                children: (0, Common_1.hasChildren)(n),
+            });
+        }), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
+            category: PERF_LOGGING_NAMESPACE,
+            message: /* istanbul ignore next */ () => `Finished finalizing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        })));
+    }
+    createHasNodesObservable(preprocessedNodesObservable, possiblyKnownChildrenObservable) {
+        const loggingCategory = `${LOGGING_NAMESPACE}.HasNodes`;
+        return (0, rxjs_1.concat)((possiblyKnownChildrenObservable ?? rxjs_1.EMPTY).pipe((0, rxjs_1.filter)((n) => (0, Common_1.hasChildren)(n))), preprocessedNodesObservable).pipe((0, LoggingUtils_1.log)({ category: loggingCategory, message: /* istanbul ignore next */ (n) => `Node before mapping to 'true': ${(0, Common_1.createNodeIdentifierForLogging)(n)}` }), (0, rxjs_1.take)(1), (0, rxjs_1.map)(() => true), (0, rxjs_1.defaultIfEmpty)(false), (0, rxjs_1.catchError)((e) => {
+            (0, LoggingUtils_1.doLog)({ category: loggingCategory, message: /* istanbul ignore next */ () => `Error while determining children: ${e.message}` });
+            if (e instanceof HierarchyErrors_1.RowsLimitExceededError) {
+                return (0, rxjs_1.of)(true);
+            }
+            throw e;
+        }), (0, LoggingUtils_1.log)({ category: loggingCategory, message: /* istanbul ignore next */ (r) => `Result: ${r}` }));
+    }
+    getCachedObservableEntry(props) {
+        const loggingCategory = `${LOGGING_NAMESPACE}.GetCachedObservableEntry`;
+        const { parentNode, ...restProps } = props;
+        const cached = props.ignoreCache || !this._nodesCache ? undefined : this._nodesCache.get(props);
+        if (cached) {
+            // istanbul ignore next
+            (0, LoggingUtils_1.doLog)({
+                category: loggingCategory,
+                message: /* istanbul ignore next */ () => `Found query nodes observable for ${(0, Common_1.createNodeIdentifierForLogging)(parentNode)}`,
+            });
+            return cached;
+        }
+        // if we don't find an entry for a grouping node, we load its instances by getting a query and applying
+        // a filter based on grouped instance keys
+        let filteredInstanceKeys;
+        let parentNonGroupingNode;
+        if (parentNode) {
+            if (HierarchyNode_1.HierarchyNode.isGroupingNode(parentNode)) {
+                parentNonGroupingNode = parentNode.nonGroupingAncestor;
+                filteredInstanceKeys = parentNode.groupedInstanceKeys;
+            }
+            else {
+                // not sure why type checker doesn't pick this up
+                (0, core_bentley_1.assert)(HierarchyNode_1.HierarchyNode.isCustom(parentNode) || HierarchyNode_1.HierarchyNode.isInstancesNode(parentNode));
+                parentNonGroupingNode = parentNode;
+            }
+        }
+        const nonGroupingNodeChildrenRequestProps = {
+            ...restProps,
+            parentNode: parentNonGroupingNode,
+            ...(filteredInstanceKeys ? { filteredInstanceKeys } : undefined),
+        };
+        const value = { observable: this.createParsedQueryNodesObservable(nonGroupingNodeChildrenRequestProps), processingStatus: "none" };
+        this._nodesCache?.set(nonGroupingNodeChildrenRequestProps, value);
+        (0, LoggingUtils_1.doLog)({
+            category: loggingCategory,
+            message: /* istanbul ignore next */ () => `Saved query nodes observable for ${(0, Common_1.createNodeIdentifierForLogging)(parentNode)}`,
+        });
+        return value;
+    }
+    getChildNodesObservables(props) {
+        const entry = this.getCachedObservableEntry(props);
+        switch (entry.processingStatus) {
+            case "none": {
+                const pre = this.createPreProcessedNodesObservable(entry.observable, props);
+                const post = this.createProcessedNodesObservable(pre, props);
+                return {
+                    processedNodes: post,
+                    hasNodes: this.createHasNodesObservable(pre, entry.observable),
+                    finalizedNodes: this.createFinalizedNodesObservable(post, props),
+                };
+            }
+            case "pre-processed": {
+                const post = this.createProcessedNodesObservable(entry.observable, props);
+                return {
+                    processedNodes: post,
+                    hasNodes: this.createHasNodesObservable(entry.observable),
+                    finalizedNodes: this.createFinalizedNodesObservable(post, props),
+                };
+            }
+        }
+    }
+    /**
+     * Creates and runs a query based on provided props, then processes retrieved nodes and returns them.
+     */
+    getNodes(props) {
+        const loggingCategory = `${LOGGING_NAMESPACE}.GetNodes`;
+        const timer = new core_bentley_1.StopWatch(undefined, true);
+        let error;
+        let nodesCount = 0;
+        (0, LoggingUtils_1.doLog)({
+            category: loggingCategory,
+            message: /* istanbul ignore next */ () => `Requesting child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        });
+        return (0, EachValueFrom_1.eachValueFrom)(this.getChildNodesObservables(props).finalizedNodes.pipe((0, rxjs_1.tap)(() => ++nodesCount), (0, rxjs_1.catchError)((e) => {
+            error = e;
+            throw e;
+        }), (0, rxjs_1.finalize)(() => {
+            (0, LoggingUtils_1.doLog)({
+                category: loggingCategory,
+                message: /* istanbul ignore next */ () => error
+                    ? `Error creating child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}: ${error instanceof Error ? error.message : error.toString()}`
+                    : `Returned ${nodesCount} child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)} in ${timer.currentSeconds.toFixed(2)} s.`,
+            });
+        })));
+    }
+    getNodeInstanceKeysObs(props) {
+        const { parentNode, instanceFilter, hierarchyLevelSizeLimit = "unbounded" } = props;
+        if (parentNode && HierarchyNode_1.HierarchyNode.isGroupingNode(parentNode)) {
+            return (0, rxjs_1.from)(parentNode.groupedInstanceKeys);
+        }
+        (0, core_bentley_1.assert)(!parentNode || HierarchyNode_1.HierarchyNode.isCustom(parentNode) || HierarchyNode_1.HierarchyNode.isInstancesNode(parentNode));
+        // split the definitions based on whether they're for custom nodes or for instance nodes
+        const [customDefs, instanceDefs] = (0, Partition_1.partition)((0, rxjs_1.from)(this.hierarchyDefinition.defineHierarchyLevel({ parentNode, instanceFilter })).pipe((0, rxjs_1.mergeAll)()), HierarchyDefinition_1.HierarchyNodesDefinition.isCustomNode);
+        // query instance keys and a flag whether they should be hidden
+        const instanceKeys = instanceDefs.pipe((0, rxjs_1.mergeMap)((def) => this._queryScheduler.scheduleSubscription((0, rxjs_1.of)(def.query).pipe((0, rxjs_1.mergeMap)(async (query) => {
+            const ecsql = `
+                SELECT
+                  ${NodeSelectQueryFactory_1.NodeSelectClauseColumnNames.FullClassName},
+                  ${NodeSelectQueryFactory_1.NodeSelectClauseColumnNames.ECInstanceId},
+                  ${NodeSelectQueryFactory_1.NodeSelectClauseColumnNames.HideNodeInHierarchy}
+                FROM (
+                  ${query.ecsql}
+                )
+              `;
+            const reader = this.queryExecutor.createQueryReader({ ...query, ecsql }, { rowFormat: "Indexes", limit: hierarchyLevelSizeLimit });
+            return (0, rxjs_1.from)(reader).pipe((0, rxjs_1.map)((row) => ({
+                key: {
+                    className: (0, presentation_shared_1.normalizeFullClassName)(row[0]),
+                    id: row[1],
+                },
+                hide: !!row[2],
+            })));
+        }), (0, rxjs_1.mergeAll)()))));
+        // split the instance keys observable based on whether they should be hidden or not
+        const [visibleNodeInstanceKeys, hiddenNodeInstanceKeys] = (0, Partition_1.partition)(instanceKeys, ({ hide }) => !hide);
+        // hidden items' handling:
+        // - if a custom node is hidden, we'll want to retrieve instance keys of its children, otherwise we don't care about it,
+        // - if an instance key is hidden, we want to create a merged node similar to what we do in `createHideNodesInHierarchyOperator`
+        const hiddenParentNodes = (0, rxjs_1.merge)(customDefs.pipe((0, rxjs_1.mergeMap)((def) => (def.node.processingParams?.hideInHierarchy ? this.createInitializedNodesObservable((0, rxjs_1.of)(def.node), parentNode) : rxjs_1.EMPTY))), hiddenNodeInstanceKeys.pipe(
+        // first merge all keys by class
+        (0, ReduceToMergeMap_1.reduceToMergeMapList)(({ key }) => key.className, ({ key }) => key.id), 
+        // then, for each class, create a temp node
+        (0, rxjs_1.mergeMap)((mergedMap) => [...mergedMap.entries()].map(([className, ids]) => ({
+            key: {
+                type: "instances",
+                instanceKeys: ids.map((id) => ({ className, id })),
+            },
+            parentKeys: [],
+            label: "",
+        })))));
+        // merge visible instance keys from this level & the ones we get recursively requesting from deeper levels
+        return (0, rxjs_1.merge)(visibleNodeInstanceKeys.pipe((0, rxjs_1.map)(({ key }) => key)), hiddenParentNodes.pipe((0, rxjs_1.mergeMap)((hiddenNode) => this.getNodeInstanceKeysObs({ parentNode: hiddenNode }))));
+    }
+    /**
+     * Creates an iterator for all child hierarchy level instance keys, taking into account any hidden hierarchy levels
+     * that there may be under the given parent node.
+     */
+    getNodeInstanceKeys(props) {
+        const loggingCategory = `${LOGGING_NAMESPACE}.GetNodeInstanceKeys`;
+        (0, LoggingUtils_1.doLog)({
+            category: loggingCategory,
+            message: /* istanbul ignore next */ () => `Requesting keys for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+        });
+        return (0, EachValueFrom_1.eachValueFrom)(this.getNodeInstanceKeysObs(props));
+    }
+    /**
+     * A function that should be called when the underlying data source, used by `HierarchyProviderProps.schemaProvider`,
+     * `HierarchyProviderProps.queryExecutor` or `HierarchyProviderProps.hierarchyDefinition`, changes.
+     *
+     * Calling the function invalidates internal caches to make sure fresh data is retrieved on new requests.
+     */
+    notifyDataSourceChanged() {
+        this._nodesCache?.clear();
+    }
+}
+function preProcessNodes(hierarchyFactory) {
+    return hierarchyFactory.preProcessNode
+        ? processNodes(hierarchyFactory.preProcessNode)
+        : (o) => o;
+}
+function postProcessNodes(hierarchyFactory) {
+    return hierarchyFactory.postProcessNode ? processNodes(hierarchyFactory.postProcessNode) : (o) => o;
+}
+function processNodes(processor) {
+    return (nodes) => nodes.pipe((0, rxjs_1.mergeMap)(processor), (0, rxjs_1.filter)((n) => !!n));
+}
+async function applyLabelsFormatting(node, schemaProvider, valueFormatter) {
+    return {
+        ...node,
+        label: await (0, presentation_shared_1.formatConcatenatedValue)({
+            value: node.label,
+            schemaProvider,
+            valueFormatter,
+        }),
+    };
+}
+function createParentNodeKeysList(parentNode) {
+    if (!parentNode) {
+        return [];
+    }
+    return [...parentNode.parentKeys, parentNode.key];
+}
+function filterQueryByInstanceKeys(query, filteredInstanceKeys) {
+    if (!filteredInstanceKeys || !filteredInstanceKeys.length) {
+        return query;
+    }
+    const MAX_ALLOWED_BINDINGS = 1000;
+    // istanbul ignore else
+    if (filteredInstanceKeys.length < MAX_ALLOWED_BINDINGS) {
+        return {
+            ...query,
+            ecsql: `
+        SELECT *
+        FROM (${query.ecsql}) q
+        WHERE q.ECInstanceId IN (${filteredInstanceKeys.map(() => "?").join(",")})
+      `,
+            bindings: [...(query.bindings ?? []), ...filteredInstanceKeys.map((k) => ({ type: "id", value: k.id }))],
+        };
+    }
+    // istanbul ignore next
+    return {
+        ...query,
+        ecsql: `
+      SELECT *
+      FROM (${query.ecsql}) q
+      WHERE InVirtualSet(?, q.ECInstanceId)
+    `,
+        bindings: [...(query.bindings ?? []), { type: "idset", value: filteredInstanceKeys.map((k) => k.id) }],
+    };
+}
+//# sourceMappingURL=HierarchyProvider.js.map

package/lib/cjs/hierarchies/HierarchyProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyProvider.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,+BAkBc;AACd,sDAAwD;AAExD,oEAWoC;AACpC,+DAAiH;AACjH,uDAA2D;AAC3D,mDASyB;AAGzB,oFAAyI;AACzI,8CAA6H;AAC7H,4DAAyD;AACzD,0FAAuF;AACvF,0DAA4E;AAC5E,8EAAyF;AACzF,4DAAuE;AACvE,4EAAuF;AACvF,oFAA+F;AAC/F,8DAA2D;AAC3D,4EAA6E;AAC7E,sFAAmF;AACnF,0DAAwE;AACxE,4EAAyE;AACzE,gEAAuD;AAEvD,qEAAuE;AAEvE,MAAM,iBAAiB,GAAG,GAAG,0BAAsB,oBAAoB,CAAC;AACxE,MAAM,sBAAsB,GAAG,GAAG,iBAAiB,cAAc,CAAC;AAClE,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AA2GnC;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,KAA6B;IACnE,OAAO,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAFD,0DAEC;AAED,MAAM,qBAAqB;IACjB,aAAa,CAA4E;IACzF,gBAAgB,CAA2B;IAC3C,iBAAiB,CAAoC;IACrD,eAAe,CAAwB;IACvC,WAAW,CAA6B;IAEhD;;;;;;OAMG;IACa,mBAAmB,CAAsB;IAEzD;;;OAGG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,YAAmB,KAA6B;QAC9C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,mBAAmB,GAAG,IAAI,2DAA4B,CAAC;gBAC3D,cAAc,EAAE,IAAI,CAAC,aAAa;gBAClC,MAAM,EAAE,IAAI,CAAC,mBAAmB;gBAChC,mBAAmB,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK;aAC3C,CAAC,CAAC;YACH,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,gBAAgB,GAAG,KAAK,EAAE,SAAS,IAAI,IAAA,iDAA2B,GAAE,CAAC;QAC1E,IAAI,CAAC,iBAAiB,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,CAAC;QACtG,IAAI,CAAC,eAAe,GAAG,IAAI,6CAAqB,CAAC,KAAK,CAAC,gBAAgB,IAAI,yBAAyB,CAAC,CAAC;QAEtG,MAAM,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,wBAAwB,CAAC;QACxE,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,WAAW,GAAG,IAAI,qDAAyB,CAAC;gBAC/C,uFAAuF;gBACvF,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;gBACnC,eAAe,EAAE,CAAC;aACnB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAA+C;QACjE,IAAI,CAAC,gBAAgB,GAAG,SAAS,IAAI,IAAA,iDAA2B,GAAE,CAAC;IACrE,CAAC;IAEO,qBAAqB,CAAC,YAA4C,EAAE,KAA6B;QACvG,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,IAAA,WAAI,EAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,CAAC;IAChJ,CAAC;IAEO,gCAAgC,CACtC,KAA2H;QAE3H,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,8CAA8C,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SAC3I,CAAC,CAAC;QACH,qCAAqC;QACrC,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,IAAA,YAAK,EAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CACpG,IAAA,eAAQ,GAAE,EACV,IAAA,eAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,gDAAgD,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SAC7I,CAAC,CACH,CACF,CAAC;QACF,yDAAyD;QACzD,OAAO,WAAW,CAAC,IAAI,CACrB,IAAA,eAAQ,EAAC,CAAC,GAAG,EAAwC,EAAE;YACrD,IAAI,8CAAwB,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,OAAO,IAAA,SAAE,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YACD,OAAO,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAC9C,IAAA,SAAE,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAChB,IAAA,UAAG,EAAC,CAAC,KAAK,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC,EAC5E,IAAA,kBAAG,EAAC;gBACF,QAAQ,EAAE,GAAG,iBAAiB,UAAU;gBACxC,OAAO,EAAE,0BAA0B,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5C,iCAAiC,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,KAAK,IAAA,oCAAqB,EAAC,KAAK,CAAC,EAAE;aACvH,CAAC,EACF,IAAA,eAAQ,EAAC,CAAC,KAAK,EAAE,EAAE,CACjB,IAAA,2BAAS,EAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,uBAAuB,EAAE,MAAM,EAAE,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,CAAC,CAC1I,CACF,CACF,CAAC;QACJ,CAAC,CAAC,EACF,IAAA,eAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,wBAAwB,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SACrH,CAAC,CACH,EACD,IAAA,6CAAqB,GAAE,CACxB,CAAC;IACJ,CAAC;IAEO,gCAAgC,CAAC,KAAsC,EAAE,UAA2C;QAC1H,OAAO,KAAK,CAAC,IAAI;QACf,8GAA8G;QAC9G,IAAA,UAAG,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC5B,0CAA0C;QAC1C,IAAA,UAAG,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACxF,uDAAuD;QACvD,IAAA,eAAQ,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAChG,6CAA6C;QAC7C,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,EACzC,IAAA,eAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,yCAAyC,IAAA,uCAA8B,EAAC,UAAU,CAAC,EAAE;SAChI,CAAC,CACH,EACD,IAAA,6CAAqB,GAAE,CACxB,CAAC;IACJ,CAAC;IAEO,iCAAiC,CACvC,oBAAgD,EAChD,KAA6B;QAE7B,OAAO,IAAI,CAAC,gCAAgC,CAAC,oBAAoB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CACvF,IAAA,iDAA8B,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAChG,IAAA,yDAAkC;QAChC,yHAAyH;QACzH,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,cAAc,EAChF,KAAK,CACN,EACD,IAAA,eAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,2CAA2C,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SACxI,CAAC,CACH,CACF,CAAC;IACJ,CAAC;IAEO,8BAA8B,CACpC,2BAA+D,EAC/D,KAA6B;QAE7B,OAAO,2BAA2B,CAAC,IAAI,CACrC,IAAA,iCAAsB,EAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE,EAAE,CACjH,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,KAAK,CAAC,CACtC,EACD,IAAA,eAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,uCAAuC,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SACpI,CAAC,CACH,CACF,CAAC;IACJ,CAAC;IAEO,8BAA8B,CACpC,wBAA4D,EAC5D,KAA6B;QAE7B,OAAO,wBAAwB,CAAC,IAAI,CAClC,IAAA,mDAA+B,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EACjG,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAC1C,kCAAwB,EACxB,IAAA,UAAG,EAAC,CAAC,CAAC,EAAiB,EAAE;YACvB,IAAI,6BAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,6BAAa,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClE,OAAO,CAAC,CAAC,gBAAgB,CAAC;YAC5B,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE;gBACtB,QAAQ,EAAE,IAAA,oBAAW,EAAC,CAAC,CAAC;aACzB,CAAC,CAAC;QACL,CAAC,CAAC,EACF,IAAA,eAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,sBAAsB;YAChC,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,uCAAuC,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SACpI,CAAC,CACH,CACF,CAAC;IACJ,CAAC;IAEO,wBAAwB,CAC9B,2BAA+D,EAC/D,+BAA4D;QAE5D,MAAM,eAAe,GAAG,GAAG,iBAAiB,WAAW,CAAC;QACxD,OAAO,IAAA,aAAM,EAAC,CAAC,+BAA+B,IAAI,YAAK,CAAC,CAAC,IAAI,CAAC,IAAA,aAAM,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,oBAAW,EAAC,CAAC,CAAC,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,IAAI,CAC7H,IAAA,kBAAG,EAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kCAAkC,IAAA,uCAA8B,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EACpJ,IAAA,WAAI,EAAC,CAAC,CAAC,EACP,IAAA,UAAG,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EACf,IAAA,qBAAc,EAAC,KAAK,CAAC,EACrB,IAAA,iBAAU,EAAC,CAAC,CAAQ,EAAE,EAAE;YACtB,IAAA,oBAAK,EAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,qCAAqC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACjI,IAAI,CAAC,YAAY,wCAAsB,EAAE,CAAC;gBACxC,OAAO,IAAA,SAAE,EAAC,IAAI,CAAC,CAAC;YAClB,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,EACF,IAAA,kBAAG,EAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAC9F,CAAC;IACJ,CAAC;IAEO,wBAAwB,CAAC,KAA6B;QAC5D,MAAM,eAAe,GAAG,GAAG,iBAAiB,2BAA2B,CAAC;QACxE,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,EAAE,GAAG,KAAK,CAAC;QAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChG,IAAI,MAAM,EAAE,CAAC;YACX,uBAAuB;YACvB,IAAA,oBAAK,EAAC;gBACJ,QAAQ,EAAE,eAAe;gBACzB,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,oCAAoC,IAAA,uCAA8B,EAAC,UAAU,CAAC,EAAE;aAC3H,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,uGAAuG;QACvG,0CAA0C;QAC1C,IAAI,oBAA+C,CAAC;QACpD,IAAI,qBAAgF,CAAC;QACrF,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,6BAAa,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7C,qBAAqB,GAAG,UAAU,CAAC,mBAAmB,CAAC;gBACvD,oBAAoB,GAAG,UAAU,CAAC,mBAAmB,CAAC;YACxD,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,IAAA,qBAAM,EAAC,6BAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,6BAAa,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;gBACxF,qBAAqB,GAAG,UAAU,CAAC;YACrC,CAAC;QACH,CAAC;QAED,MAAM,mCAAmC,GAAG;YAC1C,GAAG,SAAS;YACZ,UAAU,EAAE,qBAAqB;YACjC,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE,CAAC;QACF,MAAM,KAAK,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,gCAAgC,CAAC,mCAAmC,CAAC,EAAE,gBAAgB,EAAE,MAAe,EAAE,CAAC;QAC5I,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAClE,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,eAAe;YACzB,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,oCAAoC,IAAA,uCAA8B,EAAC,UAAU,CAAC,EAAE;SAC3H,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,wBAAwB,CAAC,KAAkF;QACjH,MAAM,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QACnD,QAAQ,KAAK,CAAC,gBAAgB,EAAE,CAAC;YAC/B,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,GAAG,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;gBAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,8BAA8B,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC7D,OAAO;oBACL,cAAc,EAAE,IAAI;oBACpB,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,KAAK,CAAC,UAAU,CAAC;oBAC9D,cAAc,EAAE,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,CAAC;iBACjE,CAAC;YACJ,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,IAAI,GAAG,IAAI,CAAC,8BAA8B,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;gBAC1E,OAAO;oBACL,cAAc,EAAE,IAAI;oBACpB,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC;oBACzD,cAAc,EAAE,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,CAAC;iBACjE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,KAA6B;QAC3C,MAAM,eAAe,GAAG,GAAG,iBAAiB,WAAW,CAAC;QACxD,MAAM,KAAK,GAAG,IAAI,wBAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAU,CAAC;QACf,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,eAAe;YACzB,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,8BAA8B,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SAC3H,CAAC,CAAC;QACH,OAAO,IAAA,6BAAa,EAClB,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,IAAI,CACtD,IAAA,UAAG,EAAC,GAAG,EAAE,CAAC,EAAE,UAAU,CAAC,EACvB,IAAA,iBAAU,EAAC,CAAC,CAAC,EAAE,EAAE;YACf,KAAK,GAAG,CAAC,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,EACF,IAAA,eAAQ,EAAC,GAAG,EAAE;YACZ,IAAA,oBAAK,EAAC;gBACJ,QAAQ,EAAE,eAAe;gBACzB,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CACvC,KAAK;oBACH,CAAC,CAAC,kCAAkC,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE;oBACpJ,CAAC,CAAC,YAAY,UAAU,oBAAoB,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;aAC5I,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CACF,CAAC;IACJ,CAAC;IAEO,sBAAsB,CAAC,KAAkD;QAC/E,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,uBAAuB,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC;QAEpF,IAAI,UAAU,IAAI,6BAAa,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3D,OAAO,IAAA,WAAI,EAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC9C,CAAC;QAED,IAAA,qBAAM,EAAC,CAAC,UAAU,IAAI,6BAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,6BAAa,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;QAEvG,wFAAwF;QACxF,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,IAAA,qBAAS,EAC1C,IAAA,WAAI,EAAC,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAA,eAAQ,GAAE,CAAC,EACpG,8CAAwB,CAAC,YAAY,CACtC,CAAC;QAEF,+DAA+D;QAC/D,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CACpC,IAAA,eAAQ,EAAC,CAAC,GAAG,EAAE,EAAE,CACf,IAAI,CAAC,eAAe,CAAC,oBAAoB,CACvC,IAAA,SAAE,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAChB,IAAA,eAAQ,EAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACvB,MAAM,KAAK,GAAG;;oBAER,oDAA2B,CAAC,aAAa;oBACzC,oDAA2B,CAAC,YAAY;oBACxC,oDAA2B,CAAC,mBAAmB;;oBAE/C,KAAK,CAAC,KAAK;;eAEhB,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC;YACnI,OAAO,IAAA,WAAI,EAAC,MAAM,CAAC,CAAC,IAAI,CACtB,IAAA,UAAG,EAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACZ,GAAG,EAAE;oBACH,SAAS,EAAE,IAAA,4CAAsB,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC;oBACzC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;iBACX;gBACD,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;aACf,CAAC,CAAC,CACJ,CAAC;QACJ,CAAC,CAAC,EACF,IAAA,eAAQ,GAAE,CACX,CACF,CACF,CACF,CAAC;QACF,mFAAmF;QACnF,MAAM,CAAC,uBAAuB,EAAE,sBAAsB,CAAC,GAAG,IAAA,qBAAS,EAAC,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAEvG,0BAA0B;QAC1B,wHAAwH;QACxH,gIAAgI;QAChI,MAAM,iBAAiB,GAAG,IAAA,YAAK,EAC7B,UAAU,CAAC,IAAI,CACb,IAAA,eAAQ,EAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,IAAA,SAAE,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,YAAK,CAAC,CAAC,CAC1I,EACD,sBAAsB,CAAC,IAAI;QACzB,gCAAgC;QAChC,IAAA,uCAAoB,EAClB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,EAC1B,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CACpB;QACD,2CAA2C;QAC3C,IAAA,eAAQ,EACN,CAAC,SAAS,EAA0D,EAAE,CACpE,CAAC,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAClD,GAAG,EAAE;gBACH,IAAI,EAAE,WAAW;gBACjB,YAAY,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;aACnD;YACD,UAAU,EAAE,EAAE;YACd,KAAK,EAAE,EAAE;SACV,CAAC,CAAC,CACN,CACF,CACF,CAAC;QAEF,0GAA0G;QAC1G,OAAO,IAAA,YAAK,EACV,uBAAuB,CAAC,IAAI,CAAC,IAAA,UAAG,EAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EACnD,iBAAiB,CAAC,IAAI,CAAC,IAAA,eAAQ,EAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAC1G,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,KAAkD;QAC3E,MAAM,eAAe,GAAG,GAAG,iBAAiB,sBAAsB,CAAC;QACnE,IAAA,oBAAK,EAAC;YACJ,QAAQ,EAAE,eAAe;YACzB,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,uBAAuB,IAAA,uCAA8B,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE;SACpH,CAAC,CAAC;QACH,OAAO,IAAA,6BAAa,EAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,uBAAuB;QAC5B,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;CACF;AAED,SAAS,eAAe,CAAC,gBAAqC;IAC5D,OAAO,gBAAgB,CAAC,cAAc;QACpC,CAAC,CAAC,YAAY,CAAC,gBAAgB,CAAC,cAAc,CAAC;QAC/C,CAAC,CAAC,CAAC,CAA4E,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1F,CAAC;AAED,SAAS,gBAAgB,CAAC,gBAAqC;IAC7D,OAAO,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAqC,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1I,CAAC;AAED,SAAS,YAAY,CAAQ,SAAsD;IACjF,OAAO,CAAC,KAAwB,EAAE,EAAE,CAClC,KAAK,CAAC,IAAI,CACR,IAAA,eAAQ,EAAC,SAAS,CAAC,EACnB,IAAA,aAAM,EAAC,CAAC,CAAC,EAAc,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAC/B,CAAC;AACN,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,IAAW,EACX,cAAgC,EAChC,cAAwC;IAExC,OAAO;QACL,GAAG,IAAI;QACP,KAAK,EAAE,MAAM,IAAA,6CAAuB,EAAC;YACnC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,cAAc;YACd,cAAc;SACf,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,UAA2C;IAC3E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,CAAC,GAAG,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAoB,EAAE,oBAA+C;IACtG,IAAI,CAAC,oBAAoB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,oBAAoB,GAAG,IAAI,CAAC;IAClC,uBAAuB;IACvB,IAAI,oBAAoB,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACvD,OAAO;YACL,GAAG,KAAK;YACR,KAAK,EAAE;;gBAEG,KAAK,CAAC,KAAK;mCACQ,oBAAoB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;OACzE;YACD,QAAQ,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SACvH,CAAC;IACJ,CAAC;IACD,uBAAuB;IACvB,OAAO;QACL,GAAG,KAAK;QACR,KAAK,EAAE;;cAEG,KAAK,CAAC,KAAK;;KAEpB;QACD,QAAQ,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;KACvG,CAAC;AACJ,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\nimport {\n  catchError,\n  concat,\n  defaultIfEmpty,\n  defer,\n  EMPTY,\n  filter,\n  finalize,\n  from,\n  map,\n  merge,\n  mergeAll,\n  mergeMap,\n  Observable,\n  ObservableInput,\n  of,\n  take,\n  tap,\n} from \"rxjs\";\nimport { assert, StopWatch } from \"@itwin/core-bentley\";\nimport { GenericInstanceFilter } from \"@itwin/core-common\";\nimport {\n  ConcatenatedValue,\n  createDefaultValueFormatter,\n  ECClassHierarchyInspector,\n  ECSchemaProvider,\n  ECSqlBinding,\n  ECSqlQueryDef,\n  formatConcatenatedValue,\n  InstanceKey,\n  IPrimitiveValueFormatter,\n  normalizeFullClassName,\n} from \"@itwin/presentation-shared\";\nimport { DefineHierarchyLevelProps, HierarchyDefinition, HierarchyNodesDefinition } from \"./HierarchyDefinition\";\nimport { RowsLimitExceededError } from \"./HierarchyErrors\";\nimport {\n  HierarchyNode,\n  NonGroupingHierarchyNode,\n  ParentHierarchyNode,\n  ParsedHierarchyNode,\n  ProcessedCustomHierarchyNode,\n  ProcessedGroupingHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n} from \"./HierarchyNode\";\nimport { HierarchyNodeIdentifiersPath } from \"./HierarchyNodeIdentifier\";\nimport { InstancesNodeKey } from \"./HierarchyNodeKey\";\nimport { CachedNodesObservableEntry, ChildNodeObservablesCache, ParsedQueryNodesObservable } from \"./internal/ChildNodeObservablesCache\";\nimport { LOGGING_NAMESPACE as CommonLoggingNamespace, createNodeIdentifierForLogging, hasChildren } from \"./internal/Common\";\nimport { eachValueFrom } from \"./internal/EachValueFrom\";\nimport { FilteringHierarchyDefinition } from \"./internal/FilteringHierarchyDefinition\";\nimport { createQueryLogMessage, doLog, log } from \"./internal/LoggingUtils\";\nimport { createDetermineChildrenOperator } from \"./internal/operators/DetermineChildren\";\nimport { createGroupingOperator } from \"./internal/operators/Grouping\";\nimport { createHideIfNoChildrenOperator } from \"./internal/operators/HideIfNoChildren\";\nimport { createHideNodesInHierarchyOperator } from \"./internal/operators/HideNodesInHierarchy\";\nimport { partition } from \"./internal/operators/Partition\";\nimport { reduceToMergeMapList } from \"./internal/operators/ReduceToMergeMap\";\nimport { shareReplayWithErrors } from \"./internal/operators/ShareReplayWithErrors\";\nimport { sortNodesByLabelOperator } from \"./internal/operators/Sorting\";\nimport { SubscriptionScheduler } from \"./internal/SubscriptionScheduler\";\nimport { readNodes } from \"./internal/TreeNodesReader\";\nimport { LimitingECSqlQueryExecutor } from \"./LimitingECSqlQueryExecutor\";\nimport { NodeSelectClauseColumnNames } from \"./NodeSelectQueryFactory\";\n\nconst LOGGING_NAMESPACE = `${CommonLoggingNamespace}.HierarchyProvider`;\nconst PERF_LOGGING_NAMESPACE = `${LOGGING_NAMESPACE}.Performance`;\nconst DEFAULT_QUERY_CONCURRENCY = 10;\nconst DEFAULT_QUERY_CACHE_SIZE = 1;\n\n/**\n * Props for the `HierarchyProvider.getNodes` call.\n * @beta\n */\nexport interface GetHierarchyNodesProps {\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: ParentHierarchyNode | undefined;\n\n  /** Optional hierarchy level filter. Has no effect if `parentNode` is a `GroupingNode`. */\n  instanceFilter?: GenericInstanceFilter;\n\n  /**\n   * Optional hierarchy level size limit override. This value is passed to `LimitingECSqlQueryExecutor` used\n   * by this provider to override query rows limit per hierarchy level. If not provided, defaults to whatever\n   * is used by the limiting query executor.\n   *\n   * Has no effect if `parentNode` is a `GroupingNode`.\n   */\n  hierarchyLevelSizeLimit?: number | \"unbounded\";\n\n  /** When set to true ignores the cache and fetches the nodes again. */\n  ignoreCache?: boolean;\n}\n\n/**\n * An interface for a hierarchy provider knows how to create child nodes for a given parent node.\n * @beta\n */\nexport interface HierarchyProvider {\n  /** Gets nodes for the specified parent node. */\n  getNodes(props: GetHierarchyNodesProps): AsyncIterableIterator<HierarchyNode>;\n\n  /** Gets instance keys for the specified parent node. */\n  getNodeInstanceKeys(props: Omit<GetHierarchyNodesProps, \"ignoreCache\">): AsyncIterableIterator<InstanceKey>;\n\n  /** Notifies the provider that the underlying data source has changed and caches should be invalidated. */\n  notifyDataSourceChanged(): void;\n\n  /**\n   * Overrides the property value formatter used by the hierarchy provider. Setting to `undefined`\n   * resets the formatter to the result of `createDefaultValueFormatter` called with default parameters.\n   */\n  setFormatter(formatter: IPrimitiveValueFormatter | undefined): void;\n}\n\n/**\n * Defines the strings used by hierarchy provider.\n */\ninterface HierarchyProviderLocalizedStrings {\n  /**\n   * A string for \"Unspecified\". Used for labels of property grouping nodes\n   * that group by an empty value.\n   */\n  unspecified: string;\n\n  /**\n   * A string for \"Other\". Used for label of a range property grouping node that\n   * groups values which don't fit into any other range.\n   */\n  other: string;\n}\n\n/**\n * Props for `createHierarchyProvider`.\n */\ninterface HierarchyProviderProps {\n  /**\n   * An object that provides access to iModel's data and metadata.\n   *\n   * @see `ECSchemaProvider`\n   * @see `LimitingECSqlQueryExecutor`\n   * @see `ECClassHierarchyInspector`\n   */\n  imodelAccess: ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector;\n\n  /**\n   * A function that returns a hierarchy definition, describing how the hierarchy that the provider should be create. The\n   * function is called once during the provider's construction.\n   */\n  hierarchyDefinition: HierarchyDefinition;\n\n  /** Maximum number of queries that the provider attempts to execute in parallel. Defaults to `10`. */\n  queryConcurrency?: number;\n  /**\n   * The amount of queries whose results are stored in-memory for quick retrieval. Defaults to `1`,\n   * which means only results of the last run query are cached.\n   */\n  queryCacheSize?: number;\n\n  /**\n   * A values formatter for formatting node labels. Defaults to the\n   * result of `createDefaultValueFormatter` called with default parameters.\n   */\n  formatter?: IPrimitiveValueFormatter;\n\n  /** A set of localized strings to use. Defaults to English strings. */\n  localizedStrings?: Partial<HierarchyProviderLocalizedStrings>;\n\n  /** Props for filtering the hierarchy. */\n  filtering?: {\n    /** A list of node identifiers from root to target node. */\n    paths: HierarchyNodeIdentifiersPath[];\n  };\n}\n\n/**\n * Creates an instance of `HierarchyProvider` that creates a hierarchy based on given iModel and\n * a hierarchy definition, which defines each hierarchy level through ECSQL queries.\n *\n * @beta\n */\nexport function createHierarchyProvider(props: HierarchyProviderProps): HierarchyProvider {\n  return new HierarchyProviderImpl(props);\n}\n\nclass HierarchyProviderImpl implements HierarchyProvider {\n  private _imodelAccess: ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector;\n  private _valuesFormatter: IPrimitiveValueFormatter;\n  private _localizedStrings: HierarchyProviderLocalizedStrings;\n  private _queryScheduler: SubscriptionScheduler;\n  private _nodesCache?: ChildNodeObservablesCache;\n\n  /**\n   * Hierarchy level definitions factory used by this provider.\n   *\n   * @note This does not necessarily match the `hierarchyDefinition` passed through props when constructing\n   * the provider. For example, it may be a factory that decorates given `hierarchyDefinition` with filtering\n   * features.\n   */\n  public readonly hierarchyDefinition: HierarchyDefinition;\n\n  /**\n   * A limiting ECSQL query executor used by this provider.\n   * @see HierarchyProviderProps.queryExecutor\n   */\n  public get queryExecutor(): LimitingECSqlQueryExecutor {\n    return this._imodelAccess;\n  }\n\n  public constructor(props: HierarchyProviderProps) {\n    this._imodelAccess = props.imodelAccess;\n    this.hierarchyDefinition = props.hierarchyDefinition;\n    if (props.filtering) {\n      const filteringDefinition = new FilteringHierarchyDefinition({\n        classHierarchy: this._imodelAccess,\n        source: this.hierarchyDefinition,\n        nodeIdentifierPaths: props.filtering.paths,\n      });\n      this.hierarchyDefinition = filteringDefinition;\n    }\n    this._valuesFormatter = props?.formatter ?? createDefaultValueFormatter();\n    this._localizedStrings = { other: \"Other\", unspecified: \"Not specified\", ...props?.localizedStrings };\n    this._queryScheduler = new SubscriptionScheduler(props.queryConcurrency ?? DEFAULT_QUERY_CONCURRENCY);\n\n    const queryCacheSize = props.queryCacheSize ?? DEFAULT_QUERY_CACHE_SIZE;\n    if (queryCacheSize !== 0) {\n      this._nodesCache = new ChildNodeObservablesCache({\n        // we divide the size by 2, because each variation also counts as a query that we cache\n        size: Math.ceil(queryCacheSize / 2),\n        variationsCount: 1,\n      });\n    }\n  }\n\n  /**\n   * Sets `HierarchyProvider` values formatter that formats nodes' labels. If provided `undefined`, then defaults to the\n   * result of `createDefaultValueFormatter` called with default parameters.\n   */\n  public setFormatter(formatter: IPrimitiveValueFormatter | undefined) {\n    this._valuesFormatter = formatter ?? createDefaultValueFormatter();\n  }\n\n  private onGroupingNodeCreated(groupingNode: ProcessedGroupingHierarchyNode, props: GetHierarchyNodesProps) {\n    this._nodesCache?.set({ ...props, parentNode: groupingNode }, { observable: from(groupingNode.children), processingStatus: \"pre-processed\" });\n  }\n\n  private createParsedQueryNodesObservable(\n    props: DefineHierarchyLevelProps & { hierarchyLevelSizeLimit?: number | \"unbounded\"; filteredInstanceKeys?: InstanceKey[] },\n  ): ParsedQueryNodesObservable {\n    doLog({\n      category: PERF_LOGGING_NAMESPACE,\n      message: /* istanbul ignore next */ () => `Requesting hierarchy level definitions for ${createNodeIdentifierForLogging(props.parentNode)}`,\n    });\n    // stream hierarchy level definitions\n    const definitions = from(defer(async () => this.hierarchyDefinition.defineHierarchyLevel(props))).pipe(\n      mergeAll(),\n      finalize(() =>\n        doLog({\n          category: PERF_LOGGING_NAMESPACE,\n          message: /* istanbul ignore next */ () => `Received all hierarchy level definitions for ${createNodeIdentifierForLogging(props.parentNode)}`,\n        }),\n      ),\n    );\n    // pipe definitions to nodes and put \"share replay\" on it\n    return definitions.pipe(\n      mergeMap((def): ObservableInput<ParsedHierarchyNode> => {\n        if (HierarchyNodesDefinition.isCustomNode(def)) {\n          return of(def.node);\n        }\n        return this._queryScheduler.scheduleSubscription(\n          of(def.query).pipe(\n            map((query) => filterQueryByInstanceKeys(query, props.filteredInstanceKeys)),\n            log({\n              category: `${LOGGING_NAMESPACE}.Queries`,\n              message: /* istanbul ignore next */ (query) =>\n                `Query direct nodes for parent ${createNodeIdentifierForLogging(props.parentNode)}: ${createQueryLogMessage(query)}`,\n            }),\n            mergeMap((query) =>\n              readNodes({ queryExecutor: this.queryExecutor, query, limit: props.hierarchyLevelSizeLimit, parser: this.hierarchyDefinition.parseNode }),\n            ),\n          ),\n        );\n      }),\n      finalize(() =>\n        doLog({\n          category: PERF_LOGGING_NAMESPACE,\n          message: /* istanbul ignore next */ () => `Read all child nodes ${createNodeIdentifierForLogging(props.parentNode)}`,\n        }),\n      ),\n      shareReplayWithErrors(),\n    );\n  }\n\n  private createInitializedNodesObservable(nodes: Observable<ParsedHierarchyNode>, parentNode: ParentHierarchyNode | undefined) {\n    return nodes.pipe(\n      // we're going to be mutating the nodes, but don't want to mutate the original one, so just clone it here once\n      map((node) => ({ ...node })),\n      // set parent node keys on the parsed node\n      map((node) => Object.assign(node, { parentKeys: createParentNodeKeysList(parentNode) })),\n      // format `ConcatenatedValue` labels into string labels\n      mergeMap(async (node) => applyLabelsFormatting(node, this._imodelAccess, this._valuesFormatter)),\n      // we have `ProcessedHierarchyNode` from here\n      preProcessNodes(this.hierarchyDefinition),\n      finalize(() =>\n        doLog({\n          category: PERF_LOGGING_NAMESPACE,\n          message: /* istanbul ignore next */ () => `Finished initializing child nodes for ${createNodeIdentifierForLogging(parentNode)}`,\n        }),\n      ),\n      shareReplayWithErrors(),\n    );\n  }\n\n  private createPreProcessedNodesObservable(\n    queryNodesObservable: ParsedQueryNodesObservable,\n    props: GetHierarchyNodesProps,\n  ): Observable<ProcessedHierarchyNode> {\n    return this.createInitializedNodesObservable(queryNodesObservable, props.parentNode).pipe(\n      createHideIfNoChildrenOperator((n) => this.getChildNodesObservables({ parentNode: n }).hasNodes),\n      createHideNodesInHierarchyOperator(\n        // note: for child nodes created because of hidden parent, we want to use parent's request props (instance filter, limit)\n        (n) => this.getChildNodesObservables({ ...props, parentNode: n }).processedNodes,\n        false,\n      ),\n      finalize(() =>\n        doLog({\n          category: PERF_LOGGING_NAMESPACE,\n          message: /* istanbul ignore next */ () => `Finished pre-processing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,\n        }),\n      ),\n    );\n  }\n\n  private createProcessedNodesObservable(\n    preprocessedNodesObservable: Observable<ProcessedHierarchyNode>,\n    props: GetHierarchyNodesProps,\n  ): Observable<ProcessedHierarchyNode> {\n    return preprocessedNodesObservable.pipe(\n      createGroupingOperator(this._imodelAccess, props.parentNode, this._valuesFormatter, this._localizedStrings, (gn) =>\n        this.onGroupingNodeCreated(gn, props),\n      ),\n      finalize(() =>\n        doLog({\n          category: PERF_LOGGING_NAMESPACE,\n          message: /* istanbul ignore next */ () => `Finished processing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,\n        }),\n      ),\n    );\n  }\n\n  private createFinalizedNodesObservable(\n    processedNodesObservable: Observable<ProcessedHierarchyNode>,\n    props: GetHierarchyNodesProps,\n  ): Observable<HierarchyNode> {\n    return processedNodesObservable.pipe(\n      createDetermineChildrenOperator((n) => this.getChildNodesObservables({ parentNode: n }).hasNodes),\n      postProcessNodes(this.hierarchyDefinition),\n      sortNodesByLabelOperator,\n      map((n): HierarchyNode => {\n        if (HierarchyNode.isCustom(n) || HierarchyNode.isInstancesNode(n)) {\n          delete n.processingParams;\n        }\n        return Object.assign(n, {\n          children: hasChildren(n),\n        });\n      }),\n      finalize(() =>\n        doLog({\n          category: PERF_LOGGING_NAMESPACE,\n          message: /* istanbul ignore next */ () => `Finished finalizing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,\n        }),\n      ),\n    );\n  }\n\n  private createHasNodesObservable(\n    preprocessedNodesObservable: Observable<ProcessedHierarchyNode>,\n    possiblyKnownChildrenObservable?: ParsedQueryNodesObservable,\n  ): Observable<boolean> {\n    const loggingCategory = `${LOGGING_NAMESPACE}.HasNodes`;\n    return concat((possiblyKnownChildrenObservable ?? EMPTY).pipe(filter((n) => hasChildren(n))), preprocessedNodesObservable).pipe(\n      log({ category: loggingCategory, message: /* istanbul ignore next */ (n) => `Node before mapping to 'true': ${createNodeIdentifierForLogging(n)}` }),\n      take(1),\n      map(() => true),\n      defaultIfEmpty(false),\n      catchError((e: Error) => {\n        doLog({ category: loggingCategory, message: /* istanbul ignore next */ () => `Error while determining children: ${e.message}` });\n        if (e instanceof RowsLimitExceededError) {\n          return of(true);\n        }\n        throw e;\n      }),\n      log({ category: loggingCategory, message: /* istanbul ignore next */ (r) => `Result: ${r}` }),\n    );\n  }\n\n  private getCachedObservableEntry(props: GetHierarchyNodesProps): CachedNodesObservableEntry {\n    const loggingCategory = `${LOGGING_NAMESPACE}.GetCachedObservableEntry`;\n    const { parentNode, ...restProps } = props;\n    const cached = props.ignoreCache || !this._nodesCache ? undefined : this._nodesCache.get(props);\n    if (cached) {\n      // istanbul ignore next\n      doLog({\n        category: loggingCategory,\n        message: /* istanbul ignore next */ () => `Found query nodes observable for ${createNodeIdentifierForLogging(parentNode)}`,\n      });\n      return cached;\n    }\n\n    // if we don't find an entry for a grouping node, we load its instances by getting a query and applying\n    // a filter based on grouped instance keys\n    let filteredInstanceKeys: InstanceKey[] | undefined;\n    let parentNonGroupingNode: ParentHierarchyNode<NonGroupingHierarchyNode> | undefined;\n    if (parentNode) {\n      if (HierarchyNode.isGroupingNode(parentNode)) {\n        parentNonGroupingNode = parentNode.nonGroupingAncestor;\n        filteredInstanceKeys = parentNode.groupedInstanceKeys;\n      } else {\n        // not sure why type checker doesn't pick this up\n        assert(HierarchyNode.isCustom(parentNode) || HierarchyNode.isInstancesNode(parentNode));\n        parentNonGroupingNode = parentNode;\n      }\n    }\n\n    const nonGroupingNodeChildrenRequestProps = {\n      ...restProps,\n      parentNode: parentNonGroupingNode,\n      ...(filteredInstanceKeys ? { filteredInstanceKeys } : undefined),\n    };\n    const value = { observable: this.createParsedQueryNodesObservable(nonGroupingNodeChildrenRequestProps), processingStatus: \"none\" as const };\n    this._nodesCache?.set(nonGroupingNodeChildrenRequestProps, value);\n    doLog({\n      category: loggingCategory,\n      message: /* istanbul ignore next */ () => `Saved query nodes observable for ${createNodeIdentifierForLogging(parentNode)}`,\n    });\n    return value;\n  }\n\n  private getChildNodesObservables(props: GetHierarchyNodesProps & { hierarchyLevelSizeLimit?: number | \"unbounded\" }) {\n    const entry = this.getCachedObservableEntry(props);\n    switch (entry.processingStatus) {\n      case \"none\": {\n        const pre = this.createPreProcessedNodesObservable(entry.observable, props);\n        const post = this.createProcessedNodesObservable(pre, props);\n        return {\n          processedNodes: post,\n          hasNodes: this.createHasNodesObservable(pre, entry.observable),\n          finalizedNodes: this.createFinalizedNodesObservable(post, props),\n        };\n      }\n      case \"pre-processed\": {\n        const post = this.createProcessedNodesObservable(entry.observable, props);\n        return {\n          processedNodes: post,\n          hasNodes: this.createHasNodesObservable(entry.observable),\n          finalizedNodes: this.createFinalizedNodesObservable(post, props),\n        };\n      }\n    }\n  }\n\n  /**\n   * Creates and runs a query based on provided props, then processes retrieved nodes and returns them.\n   */\n  public getNodes(props: GetHierarchyNodesProps): AsyncIterableIterator<HierarchyNode> {\n    const loggingCategory = `${LOGGING_NAMESPACE}.GetNodes`;\n    const timer = new StopWatch(undefined, true);\n    let error: any;\n    let nodesCount = 0;\n    doLog({\n      category: loggingCategory,\n      message: /* istanbul ignore next */ () => `Requesting child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,\n    });\n    return eachValueFrom(\n      this.getChildNodesObservables(props).finalizedNodes.pipe(\n        tap(() => ++nodesCount),\n        catchError((e) => {\n          error = e;\n          throw e;\n        }),\n        finalize(() => {\n          doLog({\n            category: loggingCategory,\n            message: /* istanbul ignore next */ () =>\n              error\n                ? `Error creating child nodes for ${createNodeIdentifierForLogging(props.parentNode)}: ${error instanceof Error ? error.message : error.toString()}`\n                : `Returned ${nodesCount} child nodes for ${createNodeIdentifierForLogging(props.parentNode)} in ${timer.currentSeconds.toFixed(2)} s.`,\n          });\n        }),\n      ),\n    );\n  }\n\n  private getNodeInstanceKeysObs(props: Omit<GetHierarchyNodesProps, \"ignoreCache\">): Observable<InstanceKey> {\n    const { parentNode, instanceFilter, hierarchyLevelSizeLimit = \"unbounded\" } = props;\n\n    if (parentNode && HierarchyNode.isGroupingNode(parentNode)) {\n      return from(parentNode.groupedInstanceKeys);\n    }\n\n    assert(!parentNode || HierarchyNode.isCustom(parentNode) || HierarchyNode.isInstancesNode(parentNode));\n\n    // split the definitions based on whether they're for custom nodes or for instance nodes\n    const [customDefs, instanceDefs] = partition(\n      from(this.hierarchyDefinition.defineHierarchyLevel({ parentNode, instanceFilter })).pipe(mergeAll()),\n      HierarchyNodesDefinition.isCustomNode,\n    );\n\n    // query instance keys and a flag whether they should be hidden\n    const instanceKeys = instanceDefs.pipe(\n      mergeMap((def) =>\n        this._queryScheduler.scheduleSubscription(\n          of(def.query).pipe(\n            mergeMap(async (query) => {\n              const ecsql = `\n                SELECT\n                  ${NodeSelectClauseColumnNames.FullClassName},\n                  ${NodeSelectClauseColumnNames.ECInstanceId},\n                  ${NodeSelectClauseColumnNames.HideNodeInHierarchy}\n                FROM (\n                  ${query.ecsql}\n                )\n              `;\n              const reader = this.queryExecutor.createQueryReader({ ...query, ecsql }, { rowFormat: \"Indexes\", limit: hierarchyLevelSizeLimit });\n              return from(reader).pipe(\n                map((row) => ({\n                  key: {\n                    className: normalizeFullClassName(row[0]),\n                    id: row[1],\n                  },\n                  hide: !!row[2],\n                })),\n              );\n            }),\n            mergeAll(),\n          ),\n        ),\n      ),\n    );\n    // split the instance keys observable based on whether they should be hidden or not\n    const [visibleNodeInstanceKeys, hiddenNodeInstanceKeys] = partition(instanceKeys, ({ hide }) => !hide);\n\n    // hidden items' handling:\n    // - if a custom node is hidden, we'll want to retrieve instance keys of its children, otherwise we don't care about it,\n    // - if an instance key is hidden, we want to create a merged node similar to what we do in `createHideNodesInHierarchyOperator`\n    const hiddenParentNodes = merge(\n      customDefs.pipe(\n        mergeMap((def) => (def.node.processingParams?.hideInHierarchy ? this.createInitializedNodesObservable(of(def.node), parentNode) : EMPTY)),\n      ),\n      hiddenNodeInstanceKeys.pipe(\n        // first merge all keys by class\n        reduceToMergeMapList(\n          ({ key }) => key.className,\n          ({ key }) => key.id,\n        ),\n        // then, for each class, create a temp node\n        mergeMap(\n          (mergedMap): Array<ParentHierarchyNode & { key: InstancesNodeKey }> =>\n            [...mergedMap.entries()].map(([className, ids]) => ({\n              key: {\n                type: \"instances\",\n                instanceKeys: ids.map((id) => ({ className, id })),\n              },\n              parentKeys: [],\n              label: \"\",\n            })),\n        ),\n      ),\n    );\n\n    // merge visible instance keys from this level & the ones we get recursively requesting from deeper levels\n    return merge(\n      visibleNodeInstanceKeys.pipe(map(({ key }) => key)),\n      hiddenParentNodes.pipe(mergeMap((hiddenNode) => this.getNodeInstanceKeysObs({ parentNode: hiddenNode }))),\n    );\n  }\n\n  /**\n   * Creates an iterator for all child hierarchy level instance keys, taking into account any hidden hierarchy levels\n   * that there may be under the given parent node.\n   */\n  public getNodeInstanceKeys(props: Omit<GetHierarchyNodesProps, \"ignoreCache\">): AsyncIterableIterator<InstanceKey> {\n    const loggingCategory = `${LOGGING_NAMESPACE}.GetNodeInstanceKeys`;\n    doLog({\n      category: loggingCategory,\n      message: /* istanbul ignore next */ () => `Requesting keys for ${createNodeIdentifierForLogging(props.parentNode)}`,\n    });\n    return eachValueFrom(this.getNodeInstanceKeysObs(props));\n  }\n\n  /**\n   * A function that should be called when the underlying data source, used by `HierarchyProviderProps.schemaProvider`,\n   * `HierarchyProviderProps.queryExecutor` or `HierarchyProviderProps.hierarchyDefinition`, changes.\n   *\n   * Calling the function invalidates internal caches to make sure fresh data is retrieved on new requests.\n   */\n  public notifyDataSourceChanged() {\n    this._nodesCache?.clear();\n  }\n}\n\nfunction preProcessNodes(hierarchyFactory: HierarchyDefinition) {\n  return hierarchyFactory.preProcessNode\n    ? processNodes(hierarchyFactory.preProcessNode)\n    : (o: Observable<ProcessedCustomHierarchyNode | ProcessedInstanceHierarchyNode>) => o;\n}\n\nfunction postProcessNodes(hierarchyFactory: HierarchyDefinition) {\n  return hierarchyFactory.postProcessNode ? processNodes(hierarchyFactory.postProcessNode) : (o: Observable<ProcessedHierarchyNode>) => o;\n}\n\nfunction processNodes<TNode>(processor: (node: TNode) => Promise<TNode | undefined>) {\n  return (nodes: Observable<TNode>) =>\n    nodes.pipe(\n      mergeMap(processor),\n      filter((n): n is TNode => !!n),\n    );\n}\n\nasync function applyLabelsFormatting<TNode extends { label: string | ConcatenatedValue }>(\n  node: TNode,\n  schemaProvider: ECSchemaProvider,\n  valueFormatter: IPrimitiveValueFormatter,\n): Promise<TNode & { label: string }> {\n  return {\n    ...node,\n    label: await formatConcatenatedValue({\n      value: node.label,\n      schemaProvider,\n      valueFormatter,\n    }),\n  };\n}\n\nfunction createParentNodeKeysList(parentNode: ParentHierarchyNode | undefined) {\n  if (!parentNode) {\n    return [];\n  }\n  return [...parentNode.parentKeys, parentNode.key];\n}\n\nfunction filterQueryByInstanceKeys(query: ECSqlQueryDef, filteredInstanceKeys: InstanceKey[] | undefined): ECSqlQueryDef {\n  if (!filteredInstanceKeys || !filteredInstanceKeys.length) {\n    return query;\n  }\n  const MAX_ALLOWED_BINDINGS = 1000;\n  // istanbul ignore else\n  if (filteredInstanceKeys.length < MAX_ALLOWED_BINDINGS) {\n    return {\n      ...query,\n      ecsql: `\n        SELECT *\n        FROM (${query.ecsql}) q\n        WHERE q.ECInstanceId IN (${filteredInstanceKeys.map(() => \"?\").join(\",\")})\n      `,\n      bindings: [...(query.bindings ?? []), ...filteredInstanceKeys.map((k): ECSqlBinding => ({ type: \"id\", value: k.id }))],\n    };\n  }\n  // istanbul ignore next\n  return {\n    ...query,\n    ecsql: `\n      SELECT *\n      FROM (${query.ecsql}) q\n      WHERE InVirtualSet(?, q.ECInstanceId)\n    `,\n    bindings: [...(query.bindings ?? []), { type: \"idset\", value: filteredInstanceKeys.map((k) => k.id) }],\n  };\n}\n"]}

package/lib/cjs/hierarchies/LimitingECSqlQueryExecutor.d.ts

@@ -0,0 +1,21 @@
+import { ECSqlQueryDef, ECSqlQueryExecutor, ECSqlQueryReaderOptions } from "@itwin/presentation-shared";
+/**
+ * An interface for something that knows how to create a limiting ECSQL query reader.
+ * @beta
+ */
+export interface LimitingECSqlQueryExecutor {
+    /**
+     * Creates a query reader for given query, but makes sure it doesn't return more than the configured
+     * limit of rows.
+     * @throws `RowsLimitExceededError` when the query returns more than configured limit of rows.
+     */
+    createQueryReader(query: ECSqlQueryDef, config?: ECSqlQueryReaderOptions & {
+        limit?: number | "unbounded";
+    }): ReturnType<ECSqlQueryExecutor["createQueryReader"]>;
+}
+/**
+ * Creates an `LimitingECSqlQueryExecutor` that throws `RowsLimitExceededError` if the query exceeds given amount of rows.
+ * @beta
+ */
+export declare function createLimitingECSqlQueryExecutor(baseExecutor: ECSqlQueryExecutor, defaultLimit: number | "unbounded"): LimitingECSqlQueryExecutor;
+//# sourceMappingURL=LimitingECSqlQueryExecutor.d.ts.map

package/lib/cjs/hierarchies/LimitingECSqlQueryExecutor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LimitingECSqlQueryExecutor.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/LimitingECSqlQueryExecutor.ts"],"names":[],"mappings":"AAMA,OAAO,EAEL,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EAExB,MAAM,4BAA4B,CAAC;AAKpC;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,iBAAiB,CACf,KAAK,EAAE,aAAa,EACpB,MAAM,CAAC,EAAE,uBAAuB,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,GAClE,UAAU,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC;CACxD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,GAAG,WAAW,GAAG,0BAA0B,CA4CjJ"}

package/lib/cjs/hierarchies/LimitingECSqlQueryExecutor.js

@@ -0,0 +1,100 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLimitingECSqlQueryExecutor = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const presentation_shared_1 = require("@itwin/presentation-shared");
+const HierarchyErrors_1 = require("./HierarchyErrors");
+const Common_1 = require("./internal/Common");
+const LoggingUtils_1 = require("./internal/LoggingUtils");
+/**
+ * Creates an `LimitingECSqlQueryExecutor` that throws `RowsLimitExceededError` if the query exceeds given amount of rows.
+ * @beta
+ */
+function createLimitingECSqlQueryExecutor(baseExecutor, defaultLimit) {
+    return {
+        async *createQueryReader(query, config) {
+            const { limit: configLimit, ...restConfig } = config ?? {};
+            const limit = configLimit ?? defaultLimit;
+            const perfLogger = createQueryPerformanceLogger();
+            const releaseMainThread = (0, presentation_shared_1.createMainThreadReleaseOnTimePassedHandler)();
+            // handle "unbounded" case without a buffer
+            const reader = baseExecutor.createQueryReader({ ...query, ecsql: addLimit(query.ecsql, limit) }, restConfig);
+            if (limit === "unbounded") {
+                try {
+                    for await (const row of reader) {
+                        await releaseMainThread();
+                        perfLogger.onStep();
+                        yield row;
+                    }
+                }
+                finally {
+                    perfLogger.onComplete();
+                }
+                return;
+            }
+            // avoid streaming until we know the number of rows is okay
+            const buffer = [];
+            try {
+                for await (const row of reader) {
+                    await releaseMainThread();
+                    perfLogger.onStep();
+                    buffer.push(row);
+                    if (buffer.length > limit) {
+                        throw new HierarchyErrors_1.RowsLimitExceededError(limit);
+                    }
+                }
+            }
+            finally {
+                perfLogger.onComplete();
+            }
+            for (const row of buffer) {
+                await releaseMainThread();
+                yield row;
+            }
+        },
+    };
+}
+exports.createLimitingECSqlQueryExecutor = createLimitingECSqlQueryExecutor;
+function addLimit(ecsql, limit) {
+    if (limit === "unbounded") {
+        return ecsql;
+    }
+    return `
+    SELECT *
+    FROM (${ecsql})
+    LIMIT ${limit + 1}
+  `;
+}
+const LOGGING_NAMESPACE = `${Common_1.LOGGING_NAMESPACE}.QueryPerformance`;
+function createQueryPerformanceLogger(firstStepWarningThreshold = 3000, allRowsWarningThreshold = 5000) {
+    let firstStep = true;
+    let rowsCount = 0;
+    const timer = new core_bentley_1.StopWatch(undefined, true);
+    return {
+        onStep() {
+            if (firstStep) {
+                // istanbul ignore next
+                (0, LoggingUtils_1.doLog)({
+                    category: LOGGING_NAMESPACE,
+                    severity: timer.current.milliseconds >= firstStepWarningThreshold ? "warning" : "trace",
+                    message: () => `First step took ${timer.currentSeconds} s.`,
+                });
+                firstStep = false;
+            }
+            ++rowsCount;
+        },
+        onComplete() {
+            // istanbul ignore next
+            (0, LoggingUtils_1.doLog)({
+                category: LOGGING_NAMESPACE,
+                severity: timer.current.milliseconds >= allRowsWarningThreshold ? "warning" : "trace",
+                message: () => `Query took ${timer.currentSeconds} s. for ${rowsCount} rows.`,
+            });
+        },
+    };
+}
+//# sourceMappingURL=LimitingECSqlQueryExecutor.js.map

package/lib/cjs/hierarchies/LimitingECSqlQueryExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LimitingECSqlQueryExecutor.js","sourceRoot":"","sources":["../../../src/hierarchies/LimitingECSqlQueryExecutor.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAAgD;AAChD,oEAMoC;AACpC,uDAA2D;AAC3D,8CAAgF;AAChF,0DAAgD;AAkBhD;;;GAGG;AACH,SAAgB,gCAAgC,CAAC,YAAgC,EAAE,YAAkC;IACnH,OAAO;QACL,KAAK,CAAC,CAAC,iBAAiB,CAAC,KAAoB,EAAE,MAAmE;YAChH,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;YAC3D,MAAM,KAAK,GAAG,WAAW,IAAI,YAAY,CAAC;YAC1C,MAAM,UAAU,GAAG,4BAA4B,EAAE,CAAC;YAClD,MAAM,iBAAiB,GAAG,IAAA,gEAA0C,GAAE,CAAC;YAEvE,2CAA2C;YAC3C,MAAM,MAAM,GAAG,YAAY,CAAC,iBAAiB,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YAC7G,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;wBAC/B,MAAM,iBAAiB,EAAE,CAAC;wBAC1B,UAAU,CAAC,MAAM,EAAE,CAAC;wBACpB,MAAM,GAAG,CAAC;oBACZ,CAAC;gBACH,CAAC;wBAAS,CAAC;oBACT,UAAU,CAAC,UAAU,EAAE,CAAC;gBAC1B,CAAC;gBACD,OAAO;YACT,CAAC;YAED,2DAA2D;YAC3D,MAAM,MAAM,GAAoB,EAAE,CAAC;YACnC,IAAI,CAAC;gBACH,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;oBAC/B,MAAM,iBAAiB,EAAE,CAAC;oBAC1B,UAAU,CAAC,MAAM,EAAE,CAAC;oBACpB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACjB,IAAI,MAAM,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;wBAC1B,MAAM,IAAI,wCAAsB,CAAC,KAAK,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,UAAU,CAAC,UAAU,EAAE,CAAC;YAC1B,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,MAAM,iBAAiB,EAAE,CAAC;gBAC1B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AA5CD,4EA4CC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,KAA2B;IAC1D,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO;;YAEG,KAAK;YACL,KAAK,GAAG,CAAC;GAClB,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GAAG,GAAG,0BAAsB,mBAAmB,CAAC;AACvE,SAAS,4BAA4B,CAAC,yBAAyB,GAAG,IAAI,EAAE,uBAAuB,GAAG,IAAI;IACpG,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,KAAK,GAAG,IAAI,wBAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO;QACL,MAAM;YACJ,IAAI,SAAS,EAAE,CAAC;gBACd,uBAAuB;gBACvB,IAAA,oBAAK,EAAC;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,IAAI,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;oBACvF,OAAO,EAAE,GAAG,EAAE,CAAC,mBAAmB,KAAK,CAAC,cAAc,KAAK;iBAC5D,CAAC,CAAC;gBACH,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;YACD,EAAE,SAAS,CAAC;QACd,CAAC;QACD,UAAU;YACR,uBAAuB;YACvB,IAAA,oBAAK,EAAC;gBACJ,QAAQ,EAAE,iBAAiB;gBAC3B,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,IAAI,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;gBACrF,OAAO,EAAE,GAAG,EAAE,CAAC,cAAc,KAAK,CAAC,cAAc,WAAW,SAAS,QAAQ;aAC9E,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,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\nimport { StopWatch } from \"@itwin/core-bentley\";\nimport {\n  createMainThreadReleaseOnTimePassedHandler,\n  ECSqlQueryDef,\n  ECSqlQueryExecutor,\n  ECSqlQueryReaderOptions,\n  ECSqlQueryRow,\n} from \"@itwin/presentation-shared\";\nimport { RowsLimitExceededError } from \"./HierarchyErrors\";\nimport { LOGGING_NAMESPACE as CommonLoggingNamespace } from \"./internal/Common\";\nimport { doLog } from \"./internal/LoggingUtils\";\n\n/**\n * An interface for something that knows how to create a limiting ECSQL query reader.\n * @beta\n */\nexport interface LimitingECSqlQueryExecutor {\n  /**\n   * Creates a query reader for given query, but makes sure it doesn't return more than the configured\n   * limit of rows.\n   * @throws `RowsLimitExceededError` when the query returns more than configured limit of rows.\n   */\n  createQueryReader(\n    query: ECSqlQueryDef,\n    config?: ECSqlQueryReaderOptions & { limit?: number | \"unbounded\" },\n  ): ReturnType<ECSqlQueryExecutor[\"createQueryReader\"]>;\n}\n\n/**\n * Creates an `LimitingECSqlQueryExecutor` that throws `RowsLimitExceededError` if the query exceeds given amount of rows.\n * @beta\n */\nexport function createLimitingECSqlQueryExecutor(baseExecutor: ECSqlQueryExecutor, defaultLimit: number | \"unbounded\"): LimitingECSqlQueryExecutor {\n  return {\n    async *createQueryReader(query: ECSqlQueryDef, config?: ECSqlQueryReaderOptions & { limit?: number | \"unbounded\" }) {\n      const { limit: configLimit, ...restConfig } = config ?? {};\n      const limit = configLimit ?? defaultLimit;\n      const perfLogger = createQueryPerformanceLogger();\n      const releaseMainThread = createMainThreadReleaseOnTimePassedHandler();\n\n      // handle \"unbounded\" case without a buffer\n      const reader = baseExecutor.createQueryReader({ ...query, ecsql: addLimit(query.ecsql, limit) }, restConfig);\n      if (limit === \"unbounded\") {\n        try {\n          for await (const row of reader) {\n            await releaseMainThread();\n            perfLogger.onStep();\n            yield row;\n          }\n        } finally {\n          perfLogger.onComplete();\n        }\n        return;\n      }\n\n      // avoid streaming until we know the number of rows is okay\n      const buffer: ECSqlQueryRow[] = [];\n      try {\n        for await (const row of reader) {\n          await releaseMainThread();\n          perfLogger.onStep();\n          buffer.push(row);\n          if (buffer.length > limit) {\n            throw new RowsLimitExceededError(limit);\n          }\n        }\n      } finally {\n        perfLogger.onComplete();\n      }\n\n      for (const row of buffer) {\n        await releaseMainThread();\n        yield row;\n      }\n    },\n  };\n}\n\nfunction addLimit(ecsql: string, limit: number | \"unbounded\") {\n  if (limit === \"unbounded\") {\n    return ecsql;\n  }\n  return `\n    SELECT *\n    FROM (${ecsql})\n    LIMIT ${limit + 1}\n  `;\n}\n\nconst LOGGING_NAMESPACE = `${CommonLoggingNamespace}.QueryPerformance`;\nfunction createQueryPerformanceLogger(firstStepWarningThreshold = 3000, allRowsWarningThreshold = 5000) {\n  let firstStep = true;\n  let rowsCount = 0;\n  const timer = new StopWatch(undefined, true);\n  return {\n    onStep() {\n      if (firstStep) {\n        // istanbul ignore next\n        doLog({\n          category: LOGGING_NAMESPACE,\n          severity: timer.current.milliseconds >= firstStepWarningThreshold ? \"warning\" : \"trace\",\n          message: () => `First step took ${timer.currentSeconds} s.`,\n        });\n        firstStep = false;\n      }\n      ++rowsCount;\n    },\n    onComplete() {\n      // istanbul ignore next\n      doLog({\n        category: LOGGING_NAMESPACE,\n        severity: timer.current.milliseconds >= allRowsWarningThreshold ? \"warning\" : \"trace\",\n        message: () => `Query took ${timer.currentSeconds} s. for ${rowsCount} rows.`,\n      });\n    },\n  };\n}\n"]}

package/lib/cjs/hierarchies/Logging.d.ts

@@ -0,0 +1,13 @@
+import { ILogger } from "@itwin/presentation-shared";
+/**
+ * Set logger to use by this package. By default the package uses a no-op logger.
+ * @beta
+ */
+export declare function setLogger(logger: ILogger | undefined): void;
+/**
+ * Get logger used by this package.
+ * @see `setLogger`
+ * @beta
+ */
+export declare function getLogger(): ILogger;
+//# sourceMappingURL=Logging.d.ts.map