@itwin/presentation-hierarchies 2.0.0-alpha.0 → 2.0.0-alpha.10

package/lib/cjs/hierarchies/imodel/FilteringHierarchyDefinition.js

@@ -1,270 +0,0 @@
-"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.ECSQL_COLUMN_NAME_FilterClassName = exports.ECSQL_COLUMN_NAME_FilterECInstanceId = exports.FilteringHierarchyDefinition = void 0;
-exports.applyECInstanceIdsFilter = applyECInstanceIdsFilter;
-exports.applyECInstanceIdsSelector = applyECInstanceIdsSelector;
-const rxjs_1 = require("rxjs");
-const HierarchyFiltering_js_1 = require("../HierarchyFiltering.js");
-const HierarchyNodeIdentifier_js_1 = require("../HierarchyNodeIdentifier.js");
-const Partition_js_1 = require("../internal/operators/Partition.js");
-const IModelHierarchyDefinition_js_1 = require("./IModelHierarchyDefinition.js");
-const IModelHierarchyNode_js_1 = require("./IModelHierarchyNode.js");
-const NodeSelectQueryFactory_js_1 = require("./NodeSelectQueryFactory.js");
-const TreeNodesReader_js_1 = require("./TreeNodesReader.js");
-/** @internal */
-class FilteringHierarchyDefinition {
-    _imodelAccess;
-    _source;
-    _nodeIdentifierPaths;
-    _nodesParser;
-    constructor(props) {
-        this._imodelAccess = props.imodelAccess;
-        this._source = props.source;
-        this._nodeIdentifierPaths = props.nodeIdentifierPaths;
-        this._nodesParser = props.nodesParser ?? this._source.parseNode ?? TreeNodesReader_js_1.defaultNodesParser;
-    }
-    get preProcessNode() {
-        return async (node) => {
-            const processedNode = this._source.preProcessNode ? await this._source.preProcessNode(node) : node;
-            if (processedNode?.processingParams?.hideInHierarchy && processedNode.filtering?.isFilterTarget && !processedNode.filtering.hasFilterTargetAncestor) {
-                // we want to hide target nodes if they have `hideInHierarchy` param, but only if they're not under another filter target
-                return undefined;
-            }
-            return processedNode;
-        };
-    }
-    shouldExpandGroupingNode(node) {
-        for (const child of node.children) {
-            /* c8 ignore next 3 */
-            if (!child.filtering) {
-                continue;
-            }
-            if (child.filtering.isFilterTarget) {
-                const childAutoExpand = child.filtering.filterTargetOptions?.autoExpand;
-                // If child is a filter target and is has no `autoExpand` flag, then it's always to be expanded.
-                if (childAutoExpand === true) {
-                    return true;
-                }
-                // If it's not an object and not `true`, then it's falsy - continue looking
-                if (typeof childAutoExpand !== "object") {
-                    continue;
-                }
-                // If grouping node's child has `autoExpandUntil` flag,
-                // auto-expand the grouping node only if it's depth is lower than that of the grouping node in associated with the target.
-                const nodeDepth = node.parentKeys.length;
-                const filterTargetDepth = childAutoExpand.depth;
-                if (nodeDepth < filterTargetDepth) {
-                    return true;
-                }
-            }
-            if (!child.filtering.filteredChildrenIdentifierPaths) {
-                /* c8 ignore next */
-                continue;
-            }
-            for (const path of child.filtering.filteredChildrenIdentifierPaths) {
-                if ("path" in path && path.options?.autoExpand) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-    get postProcessNode() {
-        return async (node) => {
-            const processedNode = this._source.postProcessNode ? await this._source.postProcessNode(node) : node;
-            // instance nodes get the auto-expand flag in `parseNode`, but grouping ones need to be handled during post-processing
-            if (IModelHierarchyNode_js_1.ProcessedHierarchyNode.isGroupingNode(node) && this.shouldExpandGroupingNode(node)) {
-                Object.assign(processedNode, { autoExpand: true });
-            }
-            return processedNode;
-        };
-    }
-    get parseNode() {
-        return async (row, parentNode) => {
-            const parsedNode = await this._nodesParser(row);
-            const filteringHelper = (0, HierarchyFiltering_js_1.createHierarchyFilteringHelper)(this._nodeIdentifierPaths, parentNode);
-            const nodeExtraProps = row[exports.ECSQL_COLUMN_NAME_FilterECInstanceId] && row[exports.ECSQL_COLUMN_NAME_FilterClassName]
-                ? await (async () => {
-                    const rowInstanceKey = { className: row[exports.ECSQL_COLUMN_NAME_FilterClassName], id: row[exports.ECSQL_COLUMN_NAME_FilterECInstanceId] };
-                    return filteringHelper.createChildNodePropsAsync({
-                        pathMatcher: (identifier) => {
-                            if (identifier.id !== rowInstanceKey.id) {
-                                return false;
-                            }
-                            if (!HierarchyNodeIdentifier_js_1.HierarchyNodeIdentifier.isInstanceNodeIdentifier(identifier)) {
-                                return false;
-                            }
-                            if (identifier.imodelKey && identifier.imodelKey !== this._imodelAccess.imodelKey) {
-                                return false;
-                            }
-                            if (identifier.className === rowInstanceKey.className) {
-                                return true;
-                            }
-                            return Promise.all([
-                                this._imodelAccess.classDerivesFrom(identifier.className, rowInstanceKey.className),
-                                this._imodelAccess.classDerivesFrom(rowInstanceKey.className, identifier.className),
-                            ]).then(([isDerivedFrom, isDerivedTo]) => isDerivedFrom || isDerivedTo);
-                        },
-                    });
-                })()
-                : undefined;
-            if (nodeExtraProps?.autoExpand) {
-                parsedNode.autoExpand = true;
-            }
-            if (nodeExtraProps?.filtering) {
-                parsedNode.filtering = nodeExtraProps.filtering;
-            }
-            return parsedNode;
-        };
-    }
-    async defineHierarchyLevel(props) {
-        const sourceDefinitions = await this._source.defineHierarchyLevel(props);
-        const filteringHelper = (0, HierarchyFiltering_js_1.createHierarchyFilteringHelper)(this._nodeIdentifierPaths, props.parentNode);
-        const childNodeFilteringIdentifiers = filteringHelper.getChildNodeFilteringIdentifiers();
-        if (!childNodeFilteringIdentifiers) {
-            return sourceDefinitions;
-        }
-        const [genericNodeDefinitions, instanceNodeDefinitions] = (0, Partition_js_1.partition)(sourceDefinitions, IModelHierarchyDefinition_js_1.HierarchyNodesDefinition.isGenericNode);
-        return (0, rxjs_1.firstValueFrom)((0, rxjs_1.merge)(genericNodeDefinitions.pipe((0, rxjs_1.map)((definition) => {
-            if (filteringHelper.hasFilterTargetAncestor ||
-                childNodeFilteringIdentifiers.some((identifier) => HierarchyNodeIdentifier_js_1.HierarchyNodeIdentifier.isGenericNodeIdentifier(identifier) &&
-                    (!identifier.source || identifier.source === this._imodelAccess.imodelKey) &&
-                    identifier.id === definition.node.key)) {
-                return {
-                    ...definition,
-                    node: {
-                        ...definition.node,
-                        ...filteringHelper.createChildNodeProps({ pathMatcher: ({ id }) => id === definition.node.key }),
-                    },
-                };
-            }
-            return undefined;
-        }), (0, rxjs_1.filter)((def) => !!def)), instanceNodeDefinitions.pipe((0, rxjs_1.mergeMap)((definition) => {
-            if (filteringHelper.hasFilterTargetAncestor) {
-                // if we have a filter target ancestor, we don't need to filter the definitions - we use all of them
-                return (0, rxjs_1.of)(applyECInstanceIdsSelector(definition));
-            }
-            return (0, rxjs_1.defer)(async () => {
-                const imodelAccess = this._imodelAccess;
-                const matches = new Map();
-                async function getEntries(x) {
-                    let entries = matches.get(x.id);
-                    if (!entries) {
-                        entries = [];
-                        matches.set(x.id, entries);
-                    }
-                    // make sure that we don't have path identifiers that only differ by class name, where
-                    // class names are in the same class hierarchy, e.g.:
-                    // [{ className: "bis.Element", id: "0x1" }, { className: "bis.Subject", id: "0x1" }]
-                    // are actually the same instance, so we only need to keep one of them, or otherwise the query will
-                    // duplicate it
-                    for (const entry of entries) {
-                        if (entry.className === x.className ||
-                            (await imodelAccess.classDerivesFrom(entry.className, x.className)) ||
-                            (await imodelAccess.classDerivesFrom(x.className, entry.className))) {
-                            return undefined;
-                        }
-                    }
-                    return entries;
-                }
-                for (const id of childNodeFilteringIdentifiers) {
-                    // take only identifiers that match the definition by type, source and class
-                    if (!HierarchyNodeIdentifier_js_1.HierarchyNodeIdentifier.isInstanceNodeIdentifier(id)) {
-                        continue;
-                    }
-                    if (id.imodelKey && id.imodelKey !== imodelAccess.imodelKey) {
-                        continue;
-                    }
-                    if (id.className !== definition.fullClassName &&
-                        !(await Promise.all([
-                            imodelAccess.classDerivesFrom(id.className, definition.fullClassName),
-                            imodelAccess.classDerivesFrom(definition.fullClassName, id.className),
-                        ]).then(([isDerivedFrom, isDerivedTo]) => isDerivedFrom || isDerivedTo))) {
-                        continue;
-                    }
-                    const entriesTargetForPathIdentifier = await getEntries(id);
-                    if (entriesTargetForPathIdentifier) {
-                        entriesTargetForPathIdentifier.push(id);
-                    }
-                }
-                return Array.from(matches.values()).flat();
-            }).pipe(
-            // only take definitions that have matching path identifiers
-            (0, rxjs_1.filter)((pathIdentifiers) => pathIdentifiers.length > 0), 
-            // for each definition that we're going to use, apply query-level filter
-            (0, rxjs_1.map)((pathIdentifiers) => applyECInstanceIdsFilter(definition, pathIdentifiers)));
-        }))).pipe((0, rxjs_1.toArray)()));
-    }
-}
-exports.FilteringHierarchyDefinition = FilteringHierarchyDefinition;
-/** @internal */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-exports.ECSQL_COLUMN_NAME_FilterECInstanceId = "FilterECInstanceId";
-/** @internal */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-exports.ECSQL_COLUMN_NAME_FilterClassName = "FilterClassName";
-function getClassECInstanceIds(filteredInstanceKeys) {
-    const classNameECInstanceIds = new Map();
-    for (const key of filteredInstanceKeys) {
-        const entry = classNameECInstanceIds.get(key.className);
-        if (entry === undefined) {
-            classNameECInstanceIds.set(key.className, [key.id]);
-            continue;
-        }
-        entry.push(key.id);
-    }
-    return classNameECInstanceIds;
-}
-/** @internal */
-function applyECInstanceIdsFilter(def, filteredInstanceKeys) {
-    const instanceIdsByClass = getClassECInstanceIds(filteredInstanceKeys);
-    return {
-        ...def,
-        query: {
-            ...def.query,
-            ctes: [
-                ...(def.query.ctes ?? []),
-                `FilteringInfo(ECInstanceId, FilterClassName) AS (
-          ${Array.from(instanceIdsByClass)
-                    .map(([className, ecInstanceIds]) => `
-                SELECT ECInstanceId, '${className}' AS FilterClassName
-                FROM ${className}
-                WHERE ECInstanceId IN (${ecInstanceIds.join(", ")})
-              `)
-                    .join(" UNION ALL ")}
-        )`,
-            ],
-            ecsql: `
-        SELECT
-          [q].*,
-          IdToHex([f].[ECInstanceId]) AS [${exports.ECSQL_COLUMN_NAME_FilterECInstanceId}],
-          [f].[FilterClassName] AS [${exports.ECSQL_COLUMN_NAME_FilterClassName}]
-        FROM (
-          ${def.query.ecsql}
-        ) [q]
-        JOIN FilteringInfo [f] ON [f].[ECInstanceId] = [q].[ECInstanceId]
-      `,
-        },
-    };
-}
-/** @internal */
-function applyECInstanceIdsSelector(def) {
-    return {
-        ...def,
-        query: {
-            ...def.query,
-            ecsql: `
-        SELECT
-          [q].*,
-          IdToHex([q].[ECInstanceId]) AS [${exports.ECSQL_COLUMN_NAME_FilterECInstanceId}],
-          [q].[${NodeSelectQueryFactory_js_1.NodeSelectClauseColumnNames.FullClassName}] AS [${exports.ECSQL_COLUMN_NAME_FilterClassName}]
-        FROM (${def.query.ecsql}) [q]
-      `,
-        },
-    };
-}
-//# sourceMappingURL=FilteringHierarchyDefinition.js.map

package/lib/cjs/hierarchies/imodel/FilteringHierarchyDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FilteringHierarchyDefinition.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/FilteringHierarchyDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAsRhG,4DAgCC;AAGD,gEAcC;AArUD,+BAAwF;AAGxF,oEAAkG;AAClG,8EAAwE;AAExE,qEAA+D;AAC/D,iFAWwC;AACxC,qEAA+H;AAC/H,2EAA0E;AAC1E,6DAA0D;AAS1D,gBAAgB;AAChB,MAAa,4BAA4B;IAC/B,aAAa,CAAoD;IACjE,OAAO,CAAsB;IAC7B,oBAAoB,CAA2B;IAC/C,YAAY,CAAa;IAEjC,YAAmB,KAAwC;QACzD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,uCAAkB,CAAC;IACxF,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;YACpB,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACnG,IAAI,aAAa,EAAE,gBAAgB,EAAE,eAAe,IAAI,aAAa,CAAC,SAAS,EAAE,cAAc,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,uBAAuB,EAAE,CAAC;gBACpJ,yHAAyH;gBACzH,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC;IAEO,wBAAwB,CAAC,IAAoC;QACnE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,sBAAsB;YACtB,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YAED,IAAI,KAAK,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;gBACnC,MAAM,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC,mBAAmB,EAAE,UAAU,CAAC;gBAExE,gGAAgG;gBAChG,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;oBAC7B,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,2EAA2E;gBAC3E,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;oBACxC,SAAS;gBACX,CAAC;gBAED,uDAAuD;gBACvD,0HAA0H;gBAC1H,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBACzC,MAAM,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC;gBAChD,IAAI,SAAS,GAAG,iBAAiB,EAAE,CAAC;oBAClC,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,+BAA+B,EAAE,CAAC;gBACrD,oBAAoB;gBACpB,SAAS;YACX,CAAC;YAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,+BAA+B,EAAE,CAAC;gBACnE,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;oBAC/C,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,eAAe;QACxB,OAAO,KAAK,EAAE,IAA4B,EAAE,EAAE;YAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACrG,sHAAsH;YACtH,IAAI,+CAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvF,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,KAAK,EAAE,GAAkC,EAAE,UAA0C,EAAwC,EAAE;YACpI,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YAChD,MAAM,eAAe,GAAG,IAAA,sDAA8B,EAAC,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;YAC9F,MAAM,cAAc,GAClB,GAAG,CAAC,4CAAoC,CAAC,IAAI,GAAG,CAAC,yCAAiC,CAAC;gBACjF,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;oBAChB,MAAM,cAAc,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,yCAAiC,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,4CAAoC,CAAC,EAAE,CAAC;oBAC5H,OAAO,eAAe,CAAC,yBAAyB,CAAC;wBAC/C,WAAW,EAAE,CAAC,UAAU,EAA8B,EAAE;4BACtD,IAAI,UAAU,CAAC,EAAE,KAAK,cAAc,CAAC,EAAE,EAAE,CAAC;gCACxC,OAAO,KAAK,CAAC;4BACf,CAAC;4BACD,IAAI,CAAC,oDAAuB,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;gCAClE,OAAO,KAAK,CAAC;4BACf,CAAC;4BACD,IAAI,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;gCAClF,OAAO,KAAK,CAAC;4BACf,CAAC;4BACD,IAAI,UAAU,CAAC,SAAS,KAAK,cAAc,CAAC,SAAS,EAAE,CAAC;gCACtD,OAAO,IAAI,CAAC;4BACd,CAAC;4BACD,OAAO,OAAO,CAAC,GAAG,CAAC;gCACjB,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAAS,EAAE,cAAc,CAAC,SAAS,CAAC;gCACnF,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC;6BACpF,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,aAAa,IAAI,WAAW,CAAC,CAAC;wBAC1E,CAAC;qBACF,CAAC,CAAC;gBACL,CAAC,CAAC,EAAE;gBACN,CAAC,CAAC,SAAS,CAAC;YAChB,IAAI,cAAc,EAAE,UAAU,EAAE,CAAC;gBAC/B,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;YAC/B,CAAC;YACD,IAAI,cAAc,EAAE,SAAS,EAAE,CAAC;gBAC9B,UAAU,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;YAClD,CAAC;YAED,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,KAAgC;QAChE,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAEzE,MAAM,eAAe,GAAG,IAAA,sDAA8B,EAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACpG,MAAM,6BAA6B,GAAG,eAAe,CAAC,gCAAgC,EAAE,CAAC;QACzF,IAAI,CAAC,6BAA6B,EAAE,CAAC;YACnC,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,MAAM,CAAC,sBAAsB,EAAE,uBAAuB,CAAC,GAAG,IAAA,wBAAS,EAAC,iBAAiB,EAAE,uDAAwB,CAAC,aAAa,CAAC,CAAC;QAC/H,OAAO,IAAA,qBAAc,EACnB,IAAA,YAAK,EACH,sBAAsB,CAAC,IAAI,CACzB,IAAA,UAAG,EAAC,CAAC,UAAU,EAAE,EAAE;YACjB,IACE,eAAe,CAAC,uBAAuB;gBACvC,6BAA6B,CAAC,IAAI,CAChC,CAAC,UAAU,EAAE,EAAE,CACb,oDAAuB,CAAC,uBAAuB,CAAC,UAAU,CAAC;oBAC3D,CAAC,CAAC,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;oBAC1E,UAAU,CAAC,EAAE,KAAK,UAAU,CAAC,IAAI,CAAC,GAAG,CACxC,EACD,CAAC;gBACD,OAAO;oBACL,GAAG,UAAU;oBACb,IAAI,EAAE;wBACJ,GAAG,UAAU,CAAC,IAAI;wBAClB,GAAG,eAAe,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;qBACjG;iBACF,CAAC;YACJ,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,EACF,IAAA,aAAM,EAAC,CAAC,GAAG,EAAyC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAC9D,EAED,uBAAuB,CAAC,IAAI,CAC1B,IAAA,eAAQ,EAAC,CAAC,UAAU,EAAE,EAAE;YACtB,IAAI,eAAe,CAAC,uBAAuB,EAAE,CAAC;gBAC5C,oGAAoG;gBACpG,OAAO,IAAA,SAAE,EAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,IAAA,YAAK,EAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC;gBACxC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAmC,CAAC;gBAC3D,KAAK,UAAU,UAAU,CAAC,CAAoB;oBAC5C,IAAI,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAChC,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,EAAE,CAAC;wBACb,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;oBAC7B,CAAC;oBACD,sFAAsF;oBACtF,qDAAqD;oBACrD,qFAAqF;oBACrF,mGAAmG;oBACnG,eAAe;oBACf,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;wBAC5B,IACE,KAAK,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;4BAC/B,CAAC,MAAM,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;4BACnE,CAAC,MAAM,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,EACnE,CAAC;4BACD,OAAO,SAAS,CAAC;wBACnB,CAAC;oBACH,CAAC;oBACD,OAAO,OAAO,CAAC;gBACjB,CAAC;gBACD,KAAK,MAAM,EAAE,IAAI,6BAA6B,EAAE,CAAC;oBAC/C,4EAA4E;oBAC5E,IAAI,CAAC,oDAAuB,CAAC,wBAAwB,CAAC,EAAE,CAAC,EAAE,CAAC;wBAC1D,SAAS;oBACX,CAAC;oBACD,IAAI,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;wBAC5D,SAAS;oBACX,CAAC;oBACD,IACE,EAAE,CAAC,SAAS,KAAK,UAAU,CAAC,aAAa;wBACzC,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;4BAClB,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,aAAa,CAAC;4BACrE,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,SAAS,CAAC;yBACtE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,aAAa,IAAI,WAAW,CAAC,CAAC,EACxE,CAAC;wBACD,SAAS;oBACX,CAAC;oBACD,MAAM,8BAA8B,GAAG,MAAM,UAAU,CAAC,EAAE,CAAC,CAAC;oBAC5D,IAAI,8BAA8B,EAAE,CAAC;wBACnC,8BAA8B,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;gBACD,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC7C,CAAC,CAAC,CAAC,IAAI;YACL,4DAA4D;YAC5D,IAAA,aAAM,EAAC,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;YAEvD,wEAAwE;YACxE,IAAA,UAAG,EAAC,CAAC,eAAe,EAAE,EAAE,CAAC,wBAAwB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,CAChF,CAAC;QACJ,CAAC,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAA,cAAO,GAAE,CAAC,CAClB,CAAC;IACJ,CAAC;CACF;AA7ND,oEA6NC;AAED,gBAAgB;AAChB,gEAAgE;AACnD,QAAA,oCAAoC,GAAG,oBAAoB,CAAC;AAEzE,gBAAgB;AAChB,gEAAgE;AACnD,QAAA,iCAAiC,GAAG,iBAAiB,CAAC;AAEnE,SAAS,qBAAqB,CAAC,oBAAmC;IAChE,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC/D,KAAK,MAAM,GAAG,IAAI,oBAAoB,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;YACpD,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED,gBAAgB;AAChB,SAAgB,wBAAwB,CAAC,GAAiC,EAAE,oBAAmC;IAC7G,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IACvE,OAAO;QACL,GAAG,GAAG;QACN,KAAK,EAAE;YACL,GAAG,GAAG,CAAC,KAAK;YACZ,IAAI,EAAE;gBACJ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzB;YACI,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC;qBAC7B,GAAG,CACF,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC;wCACN,SAAS;uBAC1B,SAAS;yCACS,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;eAClD,CACF;qBACA,IAAI,CAAC,aAAa,CAAC;UACtB;aACH;YACD,KAAK,EAAE;;;4CAG+B,4CAAoC;sCAC1C,yCAAiC;;YAE3D,GAAG,CAAC,KAAK,CAAC,KAAK;;;OAGpB;SACF;KACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,SAAgB,0BAA0B,CAAC,GAAiC;IAC1E,OAAO;QACL,GAAG,GAAG;QACN,KAAK,EAAE;YACL,GAAG,GAAG,CAAC,KAAK;YACZ,KAAK,EAAE;;;4CAG+B,4CAAoC;iBAC/D,uDAA2B,CAAC,aAAa,SAAS,yCAAiC;gBACpF,GAAG,CAAC,KAAK,CAAC,KAAK;OACxB;SACF;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 { defer, filter, firstValueFrom, map, merge, mergeMap, of, toArray } from \"rxjs\";\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { ECClassHierarchyInspector, InstanceKey } from \"@itwin/presentation-shared\";\nimport { createHierarchyFilteringHelper, HierarchyFilteringPath } from \"../HierarchyFiltering.js\";\nimport { HierarchyNodeIdentifier } from \"../HierarchyNodeIdentifier.js\";\nimport { IModelInstanceKey } from \"../HierarchyNodeKey.js\";\nimport { partition } from \"../internal/operators/Partition.js\";\nimport {\n  DefineHierarchyLevelProps,\n  GenericHierarchyNodeDefinition,\n  HierarchyDefinition,\n  HierarchyDefinitionParentNode,\n  HierarchyLevelDefinition,\n  HierarchyNodesDefinition,\n  InstanceNodesQueryDefinition,\n  NodeParser,\n  NodePostProcessor,\n  NodePreProcessor,\n} from \"./IModelHierarchyDefinition.js\";\nimport { ProcessedGroupingHierarchyNode, ProcessedHierarchyNode, SourceInstanceHierarchyNode } from \"./IModelHierarchyNode.js\";\nimport { NodeSelectClauseColumnNames } from \"./NodeSelectQueryFactory.js\";\nimport { defaultNodesParser } from \"./TreeNodesReader.js\";\n\ninterface FilteringHierarchyDefinitionProps {\n  imodelAccess: ECClassHierarchyInspector & { imodelKey: string };\n  source: HierarchyDefinition;\n  nodeIdentifierPaths: HierarchyFilteringPath[];\n  nodesParser?: NodeParser;\n}\n\n/** @internal */\nexport class FilteringHierarchyDefinition implements HierarchyDefinition {\n  private _imodelAccess: ECClassHierarchyInspector & { imodelKey: string };\n  private _source: HierarchyDefinition;\n  private _nodeIdentifierPaths: HierarchyFilteringPath[];\n  private _nodesParser: NodeParser;\n\n  public constructor(props: FilteringHierarchyDefinitionProps) {\n    this._imodelAccess = props.imodelAccess;\n    this._source = props.source;\n    this._nodeIdentifierPaths = props.nodeIdentifierPaths;\n    this._nodesParser = props.nodesParser ?? this._source.parseNode ?? defaultNodesParser;\n  }\n\n  public get preProcessNode(): NodePreProcessor {\n    return async (node) => {\n      const processedNode = this._source.preProcessNode ? await this._source.preProcessNode(node) : node;\n      if (processedNode?.processingParams?.hideInHierarchy && processedNode.filtering?.isFilterTarget && !processedNode.filtering.hasFilterTargetAncestor) {\n        // we want to hide target nodes if they have `hideInHierarchy` param, but only if they're not under another filter target\n        return undefined;\n      }\n      return processedNode;\n    };\n  }\n\n  private shouldExpandGroupingNode(node: ProcessedGroupingHierarchyNode) {\n    for (const child of node.children) {\n      /* c8 ignore next 3 */\n      if (!child.filtering) {\n        continue;\n      }\n\n      if (child.filtering.isFilterTarget) {\n        const childAutoExpand = child.filtering.filterTargetOptions?.autoExpand;\n\n        // If child is a filter target and is has no `autoExpand` flag, then it's always to be expanded.\n        if (childAutoExpand === true) {\n          return true;\n        }\n\n        // If it's not an object and not `true`, then it's falsy - continue looking\n        if (typeof childAutoExpand !== \"object\") {\n          continue;\n        }\n\n        // If grouping node's child has `autoExpandUntil` flag,\n        // auto-expand the grouping node only if it's depth is lower than that of the grouping node in associated with the target.\n        const nodeDepth = node.parentKeys.length;\n        const filterTargetDepth = childAutoExpand.depth;\n        if (nodeDepth < filterTargetDepth) {\n          return true;\n        }\n      }\n\n      if (!child.filtering.filteredChildrenIdentifierPaths) {\n        /* c8 ignore next */\n        continue;\n      }\n\n      for (const path of child.filtering.filteredChildrenIdentifierPaths) {\n        if (\"path\" in path && path.options?.autoExpand) {\n          return true;\n        }\n      }\n    }\n    return false;\n  }\n\n  public get postProcessNode(): NodePostProcessor {\n    return async (node: ProcessedHierarchyNode) => {\n      const processedNode = this._source.postProcessNode ? await this._source.postProcessNode(node) : node;\n      // instance nodes get the auto-expand flag in `parseNode`, but grouping ones need to be handled during post-processing\n      if (ProcessedHierarchyNode.isGroupingNode(node) && this.shouldExpandGroupingNode(node)) {\n        Object.assign(processedNode, { autoExpand: true });\n      }\n      return processedNode;\n    };\n  }\n\n  public get parseNode(): NodeParser {\n    return async (row: { [columnName: string]: any }, parentNode?: HierarchyDefinitionParentNode): Promise<SourceInstanceHierarchyNode> => {\n      const parsedNode = await this._nodesParser(row);\n      const filteringHelper = createHierarchyFilteringHelper(this._nodeIdentifierPaths, parentNode);\n      const nodeExtraProps =\n        row[ECSQL_COLUMN_NAME_FilterECInstanceId] && row[ECSQL_COLUMN_NAME_FilterClassName]\n          ? await (async () => {\n              const rowInstanceKey = { className: row[ECSQL_COLUMN_NAME_FilterClassName], id: row[ECSQL_COLUMN_NAME_FilterECInstanceId] };\n              return filteringHelper.createChildNodePropsAsync({\n                pathMatcher: (identifier): boolean | Promise<boolean> => {\n                  if (identifier.id !== rowInstanceKey.id) {\n                    return false;\n                  }\n                  if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(identifier)) {\n                    return false;\n                  }\n                  if (identifier.imodelKey && identifier.imodelKey !== this._imodelAccess.imodelKey) {\n                    return false;\n                  }\n                  if (identifier.className === rowInstanceKey.className) {\n                    return true;\n                  }\n                  return Promise.all([\n                    this._imodelAccess.classDerivesFrom(identifier.className, rowInstanceKey.className),\n                    this._imodelAccess.classDerivesFrom(rowInstanceKey.className, identifier.className),\n                  ]).then(([isDerivedFrom, isDerivedTo]) => isDerivedFrom || isDerivedTo);\n                },\n              });\n            })()\n          : undefined;\n      if (nodeExtraProps?.autoExpand) {\n        parsedNode.autoExpand = true;\n      }\n      if (nodeExtraProps?.filtering) {\n        parsedNode.filtering = nodeExtraProps.filtering;\n      }\n\n      return parsedNode;\n    };\n  }\n\n  public async defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition> {\n    const sourceDefinitions = await this._source.defineHierarchyLevel(props);\n\n    const filteringHelper = createHierarchyFilteringHelper(this._nodeIdentifierPaths, props.parentNode);\n    const childNodeFilteringIdentifiers = filteringHelper.getChildNodeFilteringIdentifiers();\n    if (!childNodeFilteringIdentifiers) {\n      return sourceDefinitions;\n    }\n\n    const [genericNodeDefinitions, instanceNodeDefinitions] = partition(sourceDefinitions, HierarchyNodesDefinition.isGenericNode);\n    return firstValueFrom(\n      merge(\n        genericNodeDefinitions.pipe(\n          map((definition) => {\n            if (\n              filteringHelper.hasFilterTargetAncestor ||\n              childNodeFilteringIdentifiers.some(\n                (identifier) =>\n                  HierarchyNodeIdentifier.isGenericNodeIdentifier(identifier) &&\n                  (!identifier.source || identifier.source === this._imodelAccess.imodelKey) &&\n                  identifier.id === definition.node.key,\n              )\n            ) {\n              return {\n                ...definition,\n                node: {\n                  ...definition.node,\n                  ...filteringHelper.createChildNodeProps({ pathMatcher: ({ id }) => id === definition.node.key }),\n                },\n              };\n            }\n            return undefined;\n          }),\n          filter((def): def is GenericHierarchyNodeDefinition => !!def),\n        ),\n\n        instanceNodeDefinitions.pipe(\n          mergeMap((definition) => {\n            if (filteringHelper.hasFilterTargetAncestor) {\n              // if we have a filter target ancestor, we don't need to filter the definitions - we use all of them\n              return of(applyECInstanceIdsSelector(definition));\n            }\n            return defer(async () => {\n              const imodelAccess = this._imodelAccess;\n              const matches = new Map<Id64String, IModelInstanceKey[]>();\n              async function getEntries(x: IModelInstanceKey) {\n                let entries = matches.get(x.id);\n                if (!entries) {\n                  entries = [];\n                  matches.set(x.id, entries);\n                }\n                // make sure that we don't have path identifiers that only differ by class name, where\n                // class names are in the same class hierarchy, e.g.:\n                // [{ className: \"bis.Element\", id: \"0x1\" }, { className: \"bis.Subject\", id: \"0x1\" }]\n                // are actually the same instance, so we only need to keep one of them, or otherwise the query will\n                // duplicate it\n                for (const entry of entries) {\n                  if (\n                    entry.className === x.className ||\n                    (await imodelAccess.classDerivesFrom(entry.className, x.className)) ||\n                    (await imodelAccess.classDerivesFrom(x.className, entry.className))\n                  ) {\n                    return undefined;\n                  }\n                }\n                return entries;\n              }\n              for (const id of childNodeFilteringIdentifiers) {\n                // take only identifiers that match the definition by type, source and class\n                if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(id)) {\n                  continue;\n                }\n                if (id.imodelKey && id.imodelKey !== imodelAccess.imodelKey) {\n                  continue;\n                }\n                if (\n                  id.className !== definition.fullClassName &&\n                  !(await Promise.all([\n                    imodelAccess.classDerivesFrom(id.className, definition.fullClassName),\n                    imodelAccess.classDerivesFrom(definition.fullClassName, id.className),\n                  ]).then(([isDerivedFrom, isDerivedTo]) => isDerivedFrom || isDerivedTo))\n                ) {\n                  continue;\n                }\n                const entriesTargetForPathIdentifier = await getEntries(id);\n                if (entriesTargetForPathIdentifier) {\n                  entriesTargetForPathIdentifier.push(id);\n                }\n              }\n              return Array.from(matches.values()).flat();\n            }).pipe(\n              // only take definitions that have matching path identifiers\n              filter((pathIdentifiers) => pathIdentifiers.length > 0),\n\n              // for each definition that we're going to use, apply query-level filter\n              map((pathIdentifiers) => applyECInstanceIdsFilter(definition, pathIdentifiers)),\n            );\n          }),\n        ),\n      ).pipe(toArray()),\n    );\n  }\n}\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ECSQL_COLUMN_NAME_FilterECInstanceId = \"FilterECInstanceId\";\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ECSQL_COLUMN_NAME_FilterClassName = \"FilterClassName\";\n\nfunction getClassECInstanceIds(filteredInstanceKeys: InstanceKey[]) {\n  const classNameECInstanceIds = new Map<string, Id64String[]>();\n  for (const key of filteredInstanceKeys) {\n    const entry = classNameECInstanceIds.get(key.className);\n    if (entry === undefined) {\n      classNameECInstanceIds.set(key.className, [key.id]);\n      continue;\n    }\n    entry.push(key.id);\n  }\n  return classNameECInstanceIds;\n}\n\n/** @internal */\nexport function applyECInstanceIdsFilter(def: InstanceNodesQueryDefinition, filteredInstanceKeys: InstanceKey[]): InstanceNodesQueryDefinition {\n  const instanceIdsByClass = getClassECInstanceIds(filteredInstanceKeys);\n  return {\n    ...def,\n    query: {\n      ...def.query,\n      ctes: [\n        ...(def.query.ctes ?? []),\n        `FilteringInfo(ECInstanceId, FilterClassName) AS (\n          ${Array.from(instanceIdsByClass)\n            .map(\n              ([className, ecInstanceIds]) => `\n                SELECT ECInstanceId, '${className}' AS FilterClassName\n                FROM ${className}\n                WHERE ECInstanceId IN (${ecInstanceIds.join(\", \")})\n              `,\n            )\n            .join(\" UNION ALL \")}\n        )`,\n      ],\n      ecsql: `\n        SELECT\n          [q].*,\n          IdToHex([f].[ECInstanceId]) AS [${ECSQL_COLUMN_NAME_FilterECInstanceId}],\n          [f].[FilterClassName] AS [${ECSQL_COLUMN_NAME_FilterClassName}]\n        FROM (\n          ${def.query.ecsql}\n        ) [q]\n        JOIN FilteringInfo [f] ON [f].[ECInstanceId] = [q].[ECInstanceId]\n      `,\n    },\n  };\n}\n\n/** @internal */\nexport function applyECInstanceIdsSelector(def: InstanceNodesQueryDefinition): InstanceNodesQueryDefinition {\n  return {\n    ...def,\n    query: {\n      ...def.query,\n      ecsql: `\n        SELECT\n          [q].*,\n          IdToHex([q].[ECInstanceId]) AS [${ECSQL_COLUMN_NAME_FilterECInstanceId}],\n          [q].[${NodeSelectClauseColumnNames.FullClassName}] AS [${ECSQL_COLUMN_NAME_FilterClassName}]\n        FROM (${def.query.ecsql}) [q]\n      `,\n    },\n  };\n}\n"]}

package/lib/esm/hierarchies/HierarchyFiltering.d.ts

@@ -1,110 +0,0 @@
-import { HierarchyNode, NonGroupingHierarchyNode } from "./HierarchyNode.js";
-import { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from "./HierarchyNodeIdentifier.js";
-import { GenericNodeKey, GroupingNodeKey, InstancesNodeKey } from "./HierarchyNodeKey.js";
-/** @public */
-export interface FilterTargetGroupingNodeInfo {
-    /** Key of the grouping node. */
-    key: GroupingNodeKey;
-    /**
-     * Depth of the grouping node in the hierarchy.
-     * Generally, it can be retrieved from `parentKeys.length`.
-     */
-    depth: number;
-}
-/** @public */
-export interface HierarchyFilteringPathOptions {
-    /**
-     * This option specifies the way `autoExpand` flag should be assigned to nodes in the filtered hierarchy.
-     * - If it's `false` or `undefined`, nodes have no 'autoExpand' flag.
-     * - If it's `true`, then all nodes up to the filter target will have `autoExpand` flag.
-     * - If it's an instance of `FilterTargetGroupingNodeInfo`, then all nodes up to the grouping node that matches this property,
-     * will have `autoExpand` flag.
-     */
-    autoExpand?: boolean | FilterTargetGroupingNodeInfo;
-}
-/**
- * A path of hierarchy node identifiers for filtering the hierarchy with additional options.
- * @public
- */
-export type HierarchyFilteringPath = HierarchyNodeIdentifiersPath | {
-    path: HierarchyNodeIdentifiersPath;
-    options?: HierarchyFilteringPathOptions;
-};
-/** @public */
-export declare namespace HierarchyFilteringPath {
-    /**
-     * Normalizes the hierarchy filtering path to the object form.
-     * @public
-     */
-    function normalize(source: HierarchyFilteringPath): Exclude<HierarchyFilteringPath, HierarchyNodeIdentifiersPath>;
-    /**
-     * Merges two given `HierarchyFilteringPathOptions` objects.
-     * - if both inputs are `undefined`, `undefined` is returned,
-     * - else if one of the inputs is `undefined`, the other one is returned.
-     * - else, merge each option individually.
-     *
-     * For the `autoExpand` attribute, the merge chooses to auto-expand as deep as the deepest input:
-     * - if any one of the inputs is `true`, return `true`,
-     * - else if both inputs are objects, return the one with the greater `depth` attribute.
-     * - else if one input is an object, return it.
-     * - else, return `false` or `undefined`.
-     *
-     * @public
-     */
-    function mergeOptions(lhs: HierarchyFilteringPathOptions | undefined, rhs: HierarchyFilteringPathOptions | undefined): HierarchyFilteringPathOptions | undefined;
-}
-/**
- * An utility that extracts filtering properties from given root level filtering props or
- * the parent node. Returns `undefined` if filtering props are not present.
- * @public
- * @deprecated in 1.3. Use `createHierarchyFilteringHelper` instead.
- */
-export declare function extractFilteringProps(rootLevelFilteringProps: HierarchyFilteringPath[], parentNode: Pick<NonGroupingHierarchyNode, "filtering"> | undefined): {
-    filteredNodePaths: HierarchyFilteringPath[];
-    hasFilterTargetAncestor: boolean;
-} | undefined;
-/**
- * Creates a set of utilities for making it easier to filter the given hierarchy
- * level.
- *
- * @public
- */
-export declare function createHierarchyFilteringHelper(rootLevelFilteringProps: HierarchyFilteringPath[] | undefined, parentNode: Pick<NonGroupingHierarchyNode, "filtering"> | undefined): {
-    /**
-     * Returns a flag indicating if the hierarchy level is filtered.
-     */
-    hasFilter: boolean;
-    /**
-     * Returns a flag indicating whether this hierarchy level has an ancestor node
-     * that is a filter target. That generally means that this and all downstream hierarchy
-     * levels should be displayed without filter being applied to them, even if filter paths
-     * say otherwise.
-     */
-    hasFilterTargetAncestor: boolean;
-    /**
-     * Returns a list of hierarchy node identifiers that apply specifically for this
-     * hierarchy level. Returns `undefined` if filtering is not applied to this level.
-     */
-    getChildNodeFilteringIdentifiers: () => HierarchyNodeIdentifier[] | undefined;
-    /**
-     * When a hierarchy node is created for a filtered hierarchy level, it needs some attributes (e.g. `filtering`
-     * and `autoExpand`) to be set based on the filter paths and filtering options. This function calculates
-     * these props for a child node based on its key or path matcher.
-     *
-     * When using `pathMatcher` prop, callers have more flexibility to decide whether the given `HierarchyNodeIdentifier` applies
-     * to their node. For example, only some parts of the identifier can be checked for improved performance. Otherwise, the
-     * `nodeKey` prop can be used to check the whole identifier.
-     */
-    createChildNodeProps: (props: {
-        nodeKey: InstancesNodeKey | GenericNodeKey;
-    } | {
-        pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean;
-    }) => Pick<HierarchyNode, "filtering" | "autoExpand"> | undefined;
-    /**
-     * Similar to `createChildNodeProps`, but takes an async `pathMatcher` prop.
-     */
-    createChildNodePropsAsync: (props: {
-        pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;
-    }) => Promise<Pick<HierarchyNode, "filtering" | "autoExpand"> | undefined>;
-};
-//# sourceMappingURL=HierarchyFiltering.d.ts.map

package/lib/esm/hierarchies/HierarchyFiltering.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyFiltering.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyFiltering.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAE,cAAc,EAAE,eAAe,EAAoB,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE5G,cAAc;AACd,MAAM,WAAW,4BAA4B;IAC3C,gCAAgC;IAChC,GAAG,EAAE,eAAe,CAAC;IAErB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,cAAc;AACd,MAAM,WAAW,6BAA6B;IAC5C;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,4BAA4B,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,4BAA4B,GAAG;IAAE,IAAI,EAAE,4BAA4B,CAAC;IAAC,OAAO,CAAC,EAAE,6BAA6B,CAAA;CAAE,CAAC;AACpJ,cAAc;AAEd,yBAAiB,sBAAsB,CAAC;IACtC;;;OAGG;IACH,SAAgB,SAAS,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,EAAE,4BAA4B,CAAC,CAKvH;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,YAAY,CAC1B,GAAG,EAAE,6BAA6B,GAAG,SAAS,EAC9C,GAAG,EAAE,6BAA6B,GAAG,SAAS,GAC7C,6BAA6B,GAAG,SAAS,CAmB3C;CACF;AAED;;;;;GAKG;AAEH,wBAAgB,qBAAqB,CACnC,uBAAuB,EAAE,sBAAsB,EAAE,EACjD,UAAU,EAAE,IAAI,CAAC,wBAAwB,EAAE,WAAW,CAAC,GAAG,SAAS,GAEjE;IACE,iBAAiB,EAAE,sBAAsB,EAAE,CAAC;IAC5C,uBAAuB,EAAE,OAAO,CAAC;CAClC,GACD,SAAS,CAEZ;AAuBD;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC5C,uBAAuB,EAAE,sBAAsB,EAAE,GAAG,SAAS,EAC7D,UAAU,EAAE,IAAI,CAAC,wBAAwB,EAAE,WAAW,CAAC,GAAG,SAAS;IAKjE;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;OAGG;;IAWH;;;;;;;;OAQG;kCAGG;QACE,OAAO,EAAE,gBAAgB,GAAG,cAAc,CAAC;KAC5C,GACD;QACE,WAAW,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,OAAO,CAAC;KAC/D,KACJ,IAAI,CAAC,aAAa,EAAE,WAAW,GAAG,YAAY,CAAC,GAAG,SAAS;IAoB9D;;OAEG;uCACsC;QACvC,WAAW,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KAClF,KAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,GAAG,YAAY,CAAC,GAAG,SAAS,CAAC;EA2B3E"}

package/lib/esm/hierarchies/HierarchyFiltering.js

@@ -1,205 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
-import { HierarchyNodeIdentifier } from "./HierarchyNodeIdentifier.js";
-import { HierarchyNodeKey } from "./HierarchyNodeKey.js";
-/** @public */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export var HierarchyFilteringPath;
-(function (HierarchyFilteringPath) {
-    /**
-     * Normalizes the hierarchy filtering path to the object form.
-     * @public
-     */
-    function normalize(source) {
-        if (Array.isArray(source)) {
-            return { path: source };
-        }
-        return source;
-    }
-    HierarchyFilteringPath.normalize = normalize;
-    /**
-     * Merges two given `HierarchyFilteringPathOptions` objects.
-     * - if both inputs are `undefined`, `undefined` is returned,
-     * - else if one of the inputs is `undefined`, the other one is returned.
-     * - else, merge each option individually.
-     *
-     * For the `autoExpand` attribute, the merge chooses to auto-expand as deep as the deepest input:
-     * - if any one of the inputs is `true`, return `true`,
-     * - else if both inputs are objects, return the one with the greater `depth` attribute.
-     * - else if one input is an object, return it.
-     * - else, return `false` or `undefined`.
-     *
-     * @public
-     */
-    function mergeOptions(lhs, rhs) {
-        if (!lhs || !rhs) {
-            return lhs ?? rhs;
-        }
-        return {
-            autoExpand: (() => {
-                if (rhs.autoExpand === true || lhs.autoExpand === true) {
-                    return true;
-                }
-                if (typeof lhs.autoExpand === "object") {
-                    if (typeof rhs.autoExpand === "object" && rhs.autoExpand.depth > lhs.autoExpand.depth) {
-                        return rhs.autoExpand;
-                    }
-                    return lhs.autoExpand;
-                }
-                return rhs.autoExpand;
-            })(),
-        };
-    }
-    HierarchyFilteringPath.mergeOptions = mergeOptions;
-})(HierarchyFilteringPath || (HierarchyFilteringPath = {}));
-/**
- * An utility that extracts filtering properties from given root level filtering props or
- * the parent node. Returns `undefined` if filtering props are not present.
- * @public
- * @deprecated in 1.3. Use `createHierarchyFilteringHelper` instead.
- */
-/* c8 ignore start */
-export function extractFilteringProps(rootLevelFilteringProps, parentNode) {
-    return extractFilteringPropsInternal(rootLevelFilteringProps, parentNode);
-}
-/* c8 ignore end */
-function extractFilteringPropsInternal(rootLevelFilteringProps, parentNode) {
-    if (!parentNode) {
-        return rootLevelFilteringProps ? { filteredNodePaths: rootLevelFilteringProps, hasFilterTargetAncestor: false } : undefined;
-    }
-    return parentNode.filtering?.filteredChildrenIdentifierPaths
-        ? {
-            filteredNodePaths: parentNode.filtering.filteredChildrenIdentifierPaths,
-            hasFilterTargetAncestor: !!parentNode.filtering.hasFilterTargetAncestor || !!parentNode.filtering.isFilterTarget,
-        }
-        : undefined;
-}
-/**
- * Creates a set of utilities for making it easier to filter the given hierarchy
- * level.
- *
- * @public
- */
-export function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNode) {
-    const filteringProps = extractFilteringPropsInternal(rootLevelFilteringProps, parentNode);
-    const hasFilter = !!filteringProps;
-    return {
-        /**
-         * Returns a flag indicating if the hierarchy level is filtered.
-         */
-        hasFilter,
-        /**
-         * Returns a flag indicating whether this hierarchy level has an ancestor node
-         * that is a filter target. That generally means that this and all downstream hierarchy
-         * levels should be displayed without filter being applied to them, even if filter paths
-         * say otherwise.
-         */
-        hasFilterTargetAncestor: filteringProps?.hasFilterTargetAncestor ?? false,
-        /**
-         * Returns a list of hierarchy node identifiers that apply specifically for this
-         * hierarchy level. Returns `undefined` if filtering is not applied to this level.
-         */
-        getChildNodeFilteringIdentifiers: () => {
-            if (!hasFilter) {
-                return undefined;
-            }
-            return filteringProps.filteredNodePaths
-                .map(HierarchyFilteringPath.normalize)
-                .filter(({ path }) => path.length > 0)
-                .map(({ path }) => path[0]);
-        },
-        /**
-         * When a hierarchy node is created for a filtered hierarchy level, it needs some attributes (e.g. `filtering`
-         * and `autoExpand`) to be set based on the filter paths and filtering options. This function calculates
-         * these props for a child node based on its key or path matcher.
-         *
-         * When using `pathMatcher` prop, callers have more flexibility to decide whether the given `HierarchyNodeIdentifier` applies
-         * to their node. For example, only some parts of the identifier can be checked for improved performance. Otherwise, the
-         * `nodeKey` prop can be used to check the whole identifier.
-         */
-        createChildNodeProps: (props) => {
-            if (!hasFilter) {
-                return undefined;
-            }
-            const reducer = new MatchingFilteringPathsReducer(filteringProps?.hasFilterTargetAncestor);
-            filteringProps.filteredNodePaths.forEach((filteredPath) => {
-                const normalizedPath = HierarchyFilteringPath.normalize(filteredPath);
-                if ("nodeKey" in props &&
-                    ((HierarchyNodeKey.isGeneric(props.nodeKey) && HierarchyNodeIdentifier.equal(normalizedPath.path[0], props.nodeKey)) ||
-                        (HierarchyNodeKey.isInstances(props.nodeKey) && props.nodeKey.instanceKeys.some((ik) => HierarchyNodeIdentifier.equal(normalizedPath.path[0], ik))))) {
-                    reducer.accept(normalizedPath);
-                }
-                else if ("pathMatcher" in props && props.pathMatcher(normalizedPath.path[0])) {
-                    reducer.accept(normalizedPath);
-                }
-            });
-            return reducer.getNodeProps();
-        },
-        /**
-         * Similar to `createChildNodeProps`, but takes an async `pathMatcher` prop.
-         */
-        createChildNodePropsAsync: async (props) => {
-            if (!hasFilter) {
-                return undefined;
-            }
-            const reducer = new MatchingFilteringPathsReducer(filteringProps?.hasFilterTargetAncestor);
-            for (const filteredChildrenNodeIdentifierPath of filteringProps.filteredNodePaths) {
-                const normalizedPath = HierarchyFilteringPath.normalize(filteredChildrenNodeIdentifierPath);
-                /* c8 ignore next 3 */
-                if (normalizedPath.path.length === 0) {
-                    continue;
-                }
-                const matchesPossiblyPromise = props.pathMatcher(normalizedPath.path[0]);
-                if (matchesPossiblyPromise instanceof Promise) {
-                    if (!(await matchesPossiblyPromise)) {
-                        continue;
-                    }
-                }
-                if (!matchesPossiblyPromise) {
-                    continue;
-                }
-                reducer.accept(normalizedPath);
-            }
-            return reducer.getNodeProps();
-        },
-    };
-}
-class MatchingFilteringPathsReducer {
-    _hasFilterTargetAncestor;
-    _filteredChildrenIdentifierPaths = new Array();
-    _isFilterTarget = false;
-    _filterTargetOptions = undefined;
-    _needsAutoExpand = false;
-    constructor(_hasFilterTargetAncestor) {
-        this._hasFilterTargetAncestor = _hasFilterTargetAncestor;
-    }
-    accept({ path, options }) {
-        if (path.length === 1) {
-            this._isFilterTarget = true;
-            this._filterTargetOptions = HierarchyFilteringPath.mergeOptions(this._filterTargetOptions, options);
-        }
-        else if (path.length > 1) {
-            this._filteredChildrenIdentifierPaths.push({ path: path.slice(1), options });
-            if (options?.autoExpand) {
-                this._needsAutoExpand = true;
-            }
-        }
-    }
-    getNodeProps() {
-        return {
-            ...(this._hasFilterTargetAncestor || this._isFilterTarget || this._filteredChildrenIdentifierPaths.length > 0
-                ? {
-                    filtering: {
-                        ...(this._hasFilterTargetAncestor ? { hasFilterTargetAncestor: true } : undefined),
-                        ...(this._isFilterTarget ? { isFilterTarget: true, filterTargetOptions: this._filterTargetOptions } : undefined),
-                        ...(this._filteredChildrenIdentifierPaths.length > 0 ? { filteredChildrenIdentifierPaths: this._filteredChildrenIdentifierPaths } : undefined),
-                    },
-                }
-                : undefined),
-            ...(this._needsAutoExpand ? { autoExpand: true } : undefined),
-        };
-    }
-}
-//# sourceMappingURL=HierarchyFiltering.js.map