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

package/lib/cjs/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/cjs/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/cjs/hierarchies/HierarchyFiltering.js

@@ -1,210 +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.HierarchyFilteringPath = void 0;
-exports.extractFilteringProps = extractFilteringProps;
-exports.createHierarchyFilteringHelper = createHierarchyFilteringHelper;
-const HierarchyNodeIdentifier_js_1 = require("./HierarchyNodeIdentifier.js");
-const HierarchyNodeKey_js_1 = require("./HierarchyNodeKey.js");
-/** @public */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-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 || (exports.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 */
-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
- */
-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_js_1.HierarchyNodeKey.isGeneric(props.nodeKey) && HierarchyNodeIdentifier_js_1.HierarchyNodeIdentifier.equal(normalizedPath.path[0], props.nodeKey)) ||
-                        (HierarchyNodeKey_js_1.HierarchyNodeKey.isInstances(props.nodeKey) && props.nodeKey.instanceKeys.some((ik) => HierarchyNodeIdentifier_js_1.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

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

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyFiltering.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyFiltering.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA+FhG,sDAUC;AA6BD,wEAuGC;AA1OD,6EAAqG;AACrG,+DAA4G;AA+B5G,cAAc;AACd,2DAA2D;AAC3D,IAAiB,sBAAsB,CAiDtC;AAjDD,WAAiB,sBAAsB;IACrC;;;OAGG;IACH,SAAgB,SAAS,CAAC,MAA8B;QACtD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC1B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IALe,gCAAS,YAKxB,CAAA;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,YAAY,CAC1B,GAA8C,EAC9C,GAA8C;QAE9C,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,GAAG,IAAI,GAAG,CAAC;QACpB,CAAC;QAED,OAAO;YACL,UAAU,EAAE,CAAC,GAAgD,EAAE;gBAC7D,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;oBACvD,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;oBACvC,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;wBACtF,OAAO,GAAG,CAAC,UAAU,CAAC;oBACxB,CAAC;oBACD,OAAO,GAAG,CAAC,UAAU,CAAC;gBACxB,CAAC;gBACD,OAAO,GAAG,CAAC,UAAU,CAAC;YACxB,CAAC,CAAC,EAAE;SACL,CAAC;IACJ,CAAC;IAtBe,mCAAY,eAsB3B,CAAA;AACH,CAAC,EAjDgB,sBAAsB,sCAAtB,sBAAsB,QAiDtC;AAED;;;;;GAKG;AACH,qBAAqB;AACrB,SAAgB,qBAAqB,CACnC,uBAAiD,EACjD,UAAmE;IAOnE,OAAO,6BAA6B,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;AAC5E,CAAC;AACD,mBAAmB;AAEnB,SAAS,6BAA6B,CACpC,uBAA6D,EAC7D,UAAmE;IAOnE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,uBAAuB,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9H,CAAC;IACD,OAAO,UAAU,CAAC,SAAS,EAAE,+BAA+B;QAC1D,CAAC,CAAC;YACE,iBAAiB,EAAE,UAAU,CAAC,SAAS,CAAC,+BAA+B;YACvE,uBAAuB,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,uBAAuB,IAAI,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc;SACjH;QACH,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,8BAA8B,CAC5C,uBAA6D,EAC7D,UAAmE;IAEnE,MAAM,cAAc,GAAG,6BAA6B,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;IAC1F,MAAM,SAAS,GAAG,CAAC,CAAC,cAAc,CAAC;IACnC,OAAO;QACL;;WAEG;QACH,SAAS;QAET;;;;;WAKG;QACH,uBAAuB,EAAE,cAAc,EAAE,uBAAuB,IAAI,KAAK;QAEzE;;;WAGG;QACH,gCAAgC,EAAE,GAAG,EAAE;YACrC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,cAAc,CAAC,iBAAiB;iBACpC,GAAG,CAAC,sBAAsB,CAAC,SAAS,CAAC;iBACrC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;iBACrC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QAED;;;;;;;;WAQG;QACH,oBAAoB,EAAE,CACpB,KAMK,EACwD,EAAE;YAC/D,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,6BAA6B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;YAC3F,cAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;gBACxD,MAAM,cAAc,GAAG,sBAAsB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBACtE,IACE,SAAS,IAAI,KAAK;oBAClB,CAAC,CAAC,sCAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,oDAAuB,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;wBAClH,CAAC,sCAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,oDAAuB,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EACtJ,CAAC;oBACD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBACjC,CAAC;qBAAM,IAAI,aAAa,IAAI,KAAK,IAAI,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC/E,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;QAChC,CAAC;QAED;;WAEG;QACH,yBAAyB,EAAE,KAAK,EAAE,KAEjC,EAAwE,EAAE;YACzE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,6BAA6B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;YAC3F,KAAK,MAAM,kCAAkC,IAAI,cAAc,CAAC,iBAAiB,EAAE,CAAC;gBAClF,MAAM,cAAc,GAAG,sBAAsB,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;gBAC5F,sBAAsB;gBACtB,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACrC,SAAS;gBACX,CAAC;gBAED,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzE,IAAI,sBAAsB,YAAY,OAAO,EAAE,CAAC;oBAC9C,IAAI,CAAC,CAAC,MAAM,sBAAsB,CAAC,EAAE,CAAC;wBACpC,SAAS;oBACX,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBAC5B,SAAS;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YACjC,CAAC;YACD,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;QAChC,CAAC;KACF,CAAC;AACJ,CAAC;AAGD,MAAM,6BAA6B;IAMN;IALnB,gCAAgC,GAAG,IAAI,KAAK,EAA2B,CAAC;IACxE,eAAe,GAAG,KAAK,CAAC;IACxB,oBAAoB,GAAG,SAAsD,CAAC;IAC9E,gBAAgB,GAAG,KAAK,CAAC;IAEjC,YAA2B,wBAAiC;QAAjC,6BAAwB,GAAxB,wBAAwB,CAAS;IAAG,CAAC;IAEzD,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAA2B;QACtD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;YAC5B,IAAI,CAAC,oBAAoB,GAAG,sBAAsB,CAAC,YAAY,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACtG,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAC7E,IAAI,OAAO,EAAE,UAAU,EAAE,CAAC;gBACxB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IACM,YAAY;QACjB,OAAO;YACL,GAAG,CAAC,IAAI,CAAC,wBAAwB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,gCAAgC,CAAC,MAAM,GAAG,CAAC;gBAC3G,CAAC,CAAC;oBACE,SAAS,EAAE;wBACT,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;wBAClF,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;wBAChH,GAAG,CAAC,IAAI,CAAC,gCAAgC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,+BAA+B,EAAE,IAAI,CAAC,gCAAgC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;qBAC/I;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC9D,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { HierarchyNode, NonGroupingHierarchyNode } from \"./HierarchyNode.js\";\nimport { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from \"./HierarchyNodeIdentifier.js\";\nimport { GenericNodeKey, GroupingNodeKey, HierarchyNodeKey, InstancesNodeKey } from \"./HierarchyNodeKey.js\";\n\n/** @public */\nexport interface FilterTargetGroupingNodeInfo {\n  /** Key of the grouping node. */\n  key: GroupingNodeKey;\n\n  /**\n   * Depth of the grouping node in the hierarchy.\n   * Generally, it can be retrieved from `parentKeys.length`.\n   */\n  depth: number;\n}\n\n/** @public */\nexport interface HierarchyFilteringPathOptions {\n  /**\n   * This option specifies the way `autoExpand` flag should be assigned to nodes in the filtered hierarchy.\n   * - If it's `false` or `undefined`, nodes have no 'autoExpand' flag.\n   * - If it's `true`, then all nodes up to the filter target will have `autoExpand` flag.\n   * - If it's an instance of `FilterTargetGroupingNodeInfo`, then all nodes up to the grouping node that matches this property,\n   * will have `autoExpand` flag.\n   */\n  autoExpand?: boolean | FilterTargetGroupingNodeInfo;\n}\n\n/**\n * A path of hierarchy node identifiers for filtering the hierarchy with additional options.\n * @public\n */\nexport type HierarchyFilteringPath = HierarchyNodeIdentifiersPath | { path: HierarchyNodeIdentifiersPath; options?: HierarchyFilteringPathOptions };\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyFilteringPath {\n  /**\n   * Normalizes the hierarchy filtering path to the object form.\n   * @public\n   */\n  export function normalize(source: HierarchyFilteringPath): Exclude<HierarchyFilteringPath, HierarchyNodeIdentifiersPath> {\n    if (Array.isArray(source)) {\n      return { path: source };\n    }\n    return source;\n  }\n\n  /**\n   * Merges two given `HierarchyFilteringPathOptions` objects.\n   * - if both inputs are `undefined`, `undefined` is returned,\n   * - else if one of the inputs is `undefined`, the other one is returned.\n   * - else, merge each option individually.\n   *\n   * For the `autoExpand` attribute, the merge chooses to auto-expand as deep as the deepest input:\n   * - if any one of the inputs is `true`, return `true`,\n   * - else if both inputs are objects, return the one with the greater `depth` attribute.\n   * - else if one input is an object, return it.\n   * - else, return `false` or `undefined`.\n   *\n   * @public\n   */\n  export function mergeOptions(\n    lhs: HierarchyFilteringPathOptions | undefined,\n    rhs: HierarchyFilteringPathOptions | undefined,\n  ): HierarchyFilteringPathOptions | undefined {\n    if (!lhs || !rhs) {\n      return lhs ?? rhs;\n    }\n\n    return {\n      autoExpand: ((): HierarchyFilteringPathOptions[\"autoExpand\"] => {\n        if (rhs.autoExpand === true || lhs.autoExpand === true) {\n          return true;\n        }\n        if (typeof lhs.autoExpand === \"object\") {\n          if (typeof rhs.autoExpand === \"object\" && rhs.autoExpand.depth > lhs.autoExpand.depth) {\n            return rhs.autoExpand;\n          }\n          return lhs.autoExpand;\n        }\n        return rhs.autoExpand;\n      })(),\n    };\n  }\n}\n\n/**\n * An utility that extracts filtering properties from given root level filtering props or\n * the parent node. Returns `undefined` if filtering props are not present.\n * @public\n * @deprecated in 1.3. Use `createHierarchyFilteringHelper` instead.\n */\n/* c8 ignore start */\nexport function extractFilteringProps(\n  rootLevelFilteringProps: HierarchyFilteringPath[],\n  parentNode: Pick<NonGroupingHierarchyNode, \"filtering\"> | undefined,\n):\n  | {\n      filteredNodePaths: HierarchyFilteringPath[];\n      hasFilterTargetAncestor: boolean;\n    }\n  | undefined {\n  return extractFilteringPropsInternal(rootLevelFilteringProps, parentNode);\n}\n/* c8 ignore end */\n\nfunction extractFilteringPropsInternal(\n  rootLevelFilteringProps: HierarchyFilteringPath[] | undefined,\n  parentNode: Pick<NonGroupingHierarchyNode, \"filtering\"> | undefined,\n):\n  | {\n      filteredNodePaths: HierarchyFilteringPath[];\n      hasFilterTargetAncestor: boolean;\n    }\n  | undefined {\n  if (!parentNode) {\n    return rootLevelFilteringProps ? { filteredNodePaths: rootLevelFilteringProps, hasFilterTargetAncestor: false } : undefined;\n  }\n  return parentNode.filtering?.filteredChildrenIdentifierPaths\n    ? {\n        filteredNodePaths: parentNode.filtering.filteredChildrenIdentifierPaths,\n        hasFilterTargetAncestor: !!parentNode.filtering.hasFilterTargetAncestor || !!parentNode.filtering.isFilterTarget,\n      }\n    : undefined;\n}\n\n/**\n * Creates a set of utilities for making it easier to filter the given hierarchy\n * level.\n *\n * @public\n */\nexport function createHierarchyFilteringHelper(\n  rootLevelFilteringProps: HierarchyFilteringPath[] | undefined,\n  parentNode: Pick<NonGroupingHierarchyNode, \"filtering\"> | undefined,\n) {\n  const filteringProps = extractFilteringPropsInternal(rootLevelFilteringProps, parentNode);\n  const hasFilter = !!filteringProps;\n  return {\n    /**\n     * Returns a flag indicating if the hierarchy level is filtered.\n     */\n    hasFilter,\n\n    /**\n     * Returns a flag indicating whether this hierarchy level has an ancestor node\n     * that is a filter target. That generally means that this and all downstream hierarchy\n     * levels should be displayed without filter being applied to them, even if filter paths\n     * say otherwise.\n     */\n    hasFilterTargetAncestor: filteringProps?.hasFilterTargetAncestor ?? false,\n\n    /**\n     * Returns a list of hierarchy node identifiers that apply specifically for this\n     * hierarchy level. Returns `undefined` if filtering is not applied to this level.\n     */\n    getChildNodeFilteringIdentifiers: () => {\n      if (!hasFilter) {\n        return undefined;\n      }\n      return filteringProps.filteredNodePaths\n        .map(HierarchyFilteringPath.normalize)\n        .filter(({ path }) => path.length > 0)\n        .map(({ path }) => path[0]);\n    },\n\n    /**\n     * When a hierarchy node is created for a filtered hierarchy level, it needs some attributes (e.g. `filtering`\n     * and `autoExpand`) to be set based on the filter paths and filtering options. This function calculates\n     * these props for a child node based on its key or path matcher.\n     *\n     * When using `pathMatcher` prop, callers have more flexibility to decide whether the given `HierarchyNodeIdentifier` applies\n     * to their node. For example, only some parts of the identifier can be checked for improved performance. Otherwise, the\n     * `nodeKey` prop can be used to check the whole identifier.\n     */\n    createChildNodeProps: (\n      props:\n        | {\n            nodeKey: InstancesNodeKey | GenericNodeKey;\n          }\n        | {\n            pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean;\n          },\n    ): Pick<HierarchyNode, \"filtering\" | \"autoExpand\"> | undefined => {\n      if (!hasFilter) {\n        return undefined;\n      }\n      const reducer = new MatchingFilteringPathsReducer(filteringProps?.hasFilterTargetAncestor);\n      filteringProps.filteredNodePaths.forEach((filteredPath) => {\n        const normalizedPath = HierarchyFilteringPath.normalize(filteredPath);\n        if (\n          \"nodeKey\" in props &&\n          ((HierarchyNodeKey.isGeneric(props.nodeKey) && HierarchyNodeIdentifier.equal(normalizedPath.path[0], props.nodeKey)) ||\n            (HierarchyNodeKey.isInstances(props.nodeKey) && props.nodeKey.instanceKeys.some((ik) => HierarchyNodeIdentifier.equal(normalizedPath.path[0], ik))))\n        ) {\n          reducer.accept(normalizedPath);\n        } else if (\"pathMatcher\" in props && props.pathMatcher(normalizedPath.path[0])) {\n          reducer.accept(normalizedPath);\n        }\n      });\n      return reducer.getNodeProps();\n    },\n\n    /**\n     * Similar to `createChildNodeProps`, but takes an async `pathMatcher` prop.\n     */\n    createChildNodePropsAsync: async (props: {\n      pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n    }): Promise<Pick<HierarchyNode, \"filtering\" | \"autoExpand\"> | undefined> => {\n      if (!hasFilter) {\n        return undefined;\n      }\n      const reducer = new MatchingFilteringPathsReducer(filteringProps?.hasFilterTargetAncestor);\n      for (const filteredChildrenNodeIdentifierPath of filteringProps.filteredNodePaths) {\n        const normalizedPath = HierarchyFilteringPath.normalize(filteredChildrenNodeIdentifierPath);\n        /* c8 ignore next 3 */\n        if (normalizedPath.path.length === 0) {\n          continue;\n        }\n\n        const matchesPossiblyPromise = props.pathMatcher(normalizedPath.path[0]);\n        if (matchesPossiblyPromise instanceof Promise) {\n          if (!(await matchesPossiblyPromise)) {\n            continue;\n          }\n        }\n        if (!matchesPossiblyPromise) {\n          continue;\n        }\n\n        reducer.accept(normalizedPath);\n      }\n      return reducer.getNodeProps();\n    },\n  };\n}\n\ntype NormalizedFilteringPath = ReturnType<(typeof HierarchyFilteringPath)[\"normalize\"]>;\nclass MatchingFilteringPathsReducer {\n  private _filteredChildrenIdentifierPaths = new Array<NormalizedFilteringPath>();\n  private _isFilterTarget = false;\n  private _filterTargetOptions = undefined as HierarchyFilteringPathOptions | undefined;\n  private _needsAutoExpand = false;\n\n  public constructor(private _hasFilterTargetAncestor: boolean) {}\n\n  public accept({ path, options }: NormalizedFilteringPath) {\n    if (path.length === 1) {\n      this._isFilterTarget = true;\n      this._filterTargetOptions = HierarchyFilteringPath.mergeOptions(this._filterTargetOptions, options);\n    } else if (path.length > 1) {\n      this._filteredChildrenIdentifierPaths.push({ path: path.slice(1), options });\n      if (options?.autoExpand) {\n        this._needsAutoExpand = true;\n      }\n    }\n  }\n  public getNodeProps(): Pick<HierarchyNode, \"filtering\" | \"autoExpand\"> {\n    return {\n      ...(this._hasFilterTargetAncestor || this._isFilterTarget || this._filteredChildrenIdentifierPaths.length > 0\n        ? {\n            filtering: {\n              ...(this._hasFilterTargetAncestor ? { hasFilterTargetAncestor: true } : undefined),\n              ...(this._isFilterTarget ? { isFilterTarget: true, filterTargetOptions: this._filterTargetOptions } : undefined),\n              ...(this._filteredChildrenIdentifierPaths.length > 0 ? { filteredChildrenIdentifierPaths: this._filteredChildrenIdentifierPaths } : undefined),\n            },\n          }\n        : undefined),\n      ...(this._needsAutoExpand ? { autoExpand: true } : undefined),\n    };\n  }\n}\n"]}

package/lib/cjs/hierarchies/imodel/FilteringHierarchyDefinition.d.ts

@@ -1,34 +0,0 @@
-import { ECClassHierarchyInspector, InstanceKey } from "@itwin/presentation-shared";
-import { HierarchyFilteringPath } from "../HierarchyFiltering.js";
-import { DefineHierarchyLevelProps, HierarchyDefinition, HierarchyLevelDefinition, InstanceNodesQueryDefinition, NodeParser, NodePostProcessor, NodePreProcessor } from "./IModelHierarchyDefinition.js";
-interface FilteringHierarchyDefinitionProps {
-    imodelAccess: ECClassHierarchyInspector & {
-        imodelKey: string;
-    };
-    source: HierarchyDefinition;
-    nodeIdentifierPaths: HierarchyFilteringPath[];
-    nodesParser?: NodeParser;
-}
-/** @internal */
-export declare class FilteringHierarchyDefinition implements HierarchyDefinition {
-    private _imodelAccess;
-    private _source;
-    private _nodeIdentifierPaths;
-    private _nodesParser;
-    constructor(props: FilteringHierarchyDefinitionProps);
-    get preProcessNode(): NodePreProcessor;
-    private shouldExpandGroupingNode;
-    get postProcessNode(): NodePostProcessor;
-    get parseNode(): NodeParser;
-    defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition>;
-}
-/** @internal */
-export declare const ECSQL_COLUMN_NAME_FilterECInstanceId = "FilterECInstanceId";
-/** @internal */
-export declare const ECSQL_COLUMN_NAME_FilterClassName = "FilterClassName";
-/** @internal */
-export declare function applyECInstanceIdsFilter(def: InstanceNodesQueryDefinition, filteredInstanceKeys: InstanceKey[]): InstanceNodesQueryDefinition;
-/** @internal */
-export declare function applyECInstanceIdsSelector(def: InstanceNodesQueryDefinition): InstanceNodesQueryDefinition;
-export {};
-//# sourceMappingURL=FilteringHierarchyDefinition.d.ts.map

package/lib/cjs/hierarchies/imodel/FilteringHierarchyDefinition.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FilteringHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/FilteringHierarchyDefinition.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAAkC,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAIlG,OAAO,EACL,yBAAyB,EAEzB,mBAAmB,EAEnB,wBAAwB,EAExB,4BAA4B,EAC5B,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,gCAAgC,CAAC;AAKxC,UAAU,iCAAiC;IACzC,YAAY,EAAE,yBAAyB,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,MAAM,EAAE,mBAAmB,CAAC;IAC5B,mBAAmB,EAAE,sBAAsB,EAAE,CAAC;IAC9C,WAAW,CAAC,EAAE,UAAU,CAAC;CAC1B;AAED,gBAAgB;AAChB,qBAAa,4BAA6B,YAAW,mBAAmB;IACtE,OAAO,CAAC,aAAa,CAAoD;IACzE,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,oBAAoB,CAA2B;IACvD,OAAO,CAAC,YAAY,CAAa;gBAEd,KAAK,EAAE,iCAAiC;IAO3D,IAAW,cAAc,IAAI,gBAAgB,CAS5C;IAED,OAAO,CAAC,wBAAwB;IA2ChC,IAAW,eAAe,IAAI,iBAAiB,CAS9C;IAED,IAAW,SAAS,IAAI,UAAU,CAuCjC;IAEY,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAsGvG;AAED,gBAAgB;AAEhB,eAAO,MAAM,oCAAoC,uBAAuB,CAAC;AAEzE,gBAAgB;AAEhB,eAAO,MAAM,iCAAiC,oBAAoB,CAAC;AAenE,gBAAgB;AAChB,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,4BAA4B,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,4BAA4B,CAgC7I;AAED,gBAAgB;AAChB,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,4BAA4B,GAAG,4BAA4B,CAc1G"}