@itwin/presentation-hierarchies 1.6.1 → 1.7.1

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @itwin/presentation-hierarchies
 
+## 1.7.1
+
+### Patch Changes
+
+- [#1024](https://github.com/iTwin/presentation/pull/1024): Update `depthInPath` documentation. Clarified that it does not set auto-expand for node that is at `depthInPath` position.
+
+## 1.7.0
+
+### Minor Changes
+
+- 8f7d200926b93e862276e1f978f6c891691e0dae: Refactored specifying the depth / level to which filtering path should be auto-expanded.
+
+  - Deprecated `FilteringPathAutoExpandOption` and `FilterTargetGroupingNodeInfo`.
+  - Added `FilteringPathAutoExpandDepthInPath` and `FilteringPathAutoExpandDepthInHierarchy` which should be used instead.
+
+  Migration:
+
+  ```ts
+  const pathExpandedToInstanceInPath: HierarchyFilteringPath = {
+    path: [instanceKey1, instanceKey2, instanceKey3],
+    options: {
+      // deprecated:
+      autoExpand: { depth: 1 },
+      // do this instead:
+      autoExpand: { depthInPath: 1 },
+    },
+  };
+
+  const pathExpandedToGroupingNode: HierarchyFilteringPath = {
+    path: [instanceKey1, instanceKey2, instanceKey3],
+    options: {
+      // deprecated:
+      autoExpand: { depth: 1, key: groupingNodeKey },
+      // also deprecated:
+      autoExpand: { depth: 1, includeGroupingNodes: true },
+      // do this instead:
+      autoExpand: { depthInHierarchy: 1 },
+    },
+  };
+  ```
+
 ## 1.6.1
 
 ### Patch Changes

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

@@ -1,24 +1,32 @@
 import { HierarchyNode, NonGroupingHierarchyNode } from "./HierarchyNode.js";
 import { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from "./HierarchyNodeIdentifier.js";
 import { GenericNodeKey, GroupingNodeKey, InstancesNodeKey } from "./HierarchyNodeKey.js";
-/** @public */
+/**
+ * @public
+ * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInHierarchy` instead.
+ */
 export interface FilterTargetGroupingNodeInfo {
     /**
      * Key of the grouping node.
-     * @deprecated in 1.6. Use `FilteringPathAutoExpandOption` with `includeGroupingNodes` set to true instead.
+     * @deprecated in 1.6. Use `FilteringPathAutoExpandDepthInHierarchy` instead.
      */
     key: GroupingNodeKey;
     /**
      * Depth up to which nodes in the hierarchy should be expanded.
+     * @deprecated in 1.6. Use `FilteringPathAutoExpandDepthInHierarchy` instead.
      */
     depth: number;
 }
-/** @public */
+/**
+ * @public
+ * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInPath` or `FilteringPathAutoExpandDepthInHierarchy` instead.
+ */
 export interface FilteringPathAutoExpandOption {
     /**
      * Depth up to which nodes in the hierarchy should be expanded.
      *
      * If `includeGroupingNodes` is set to true, then depth should take into account the number of grouping nodes in hierarchy.
+     * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInPath` or `FilteringPathAutoExpandDepthInHierarchy` instead.
      */
     depth: number;
     /**
@@ -35,10 +43,47 @@ export interface FilteringPathAutoExpandOption {
      *       - Element1
      *       - Element2
      * Then you provide `autoExpand: { depth: 2, includeGroupingNodes: true }`
+     *
+     * To get the correct depth use `HierarchyNode.parentKeys.length`.
+     * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInHierarchy` instead.
      */
     includeGroupingNodes?: boolean;
 }
 /** @public */
+export interface FilteringPathAutoExpandDepthInPath {
+    /**
+     * Depth that tells which nodes in the filtering path should be expanded.
+     *
+     * Use when you want to expand up to specific instance node and don't care about grouping nodes.
+     *
+     * **NOTE**: All nodes that are up to `depthInPath` will be expanded. Node at the `depthInPath` position won't be expanded.
+     */
+    depthInPath: number;
+}
+/** @public */
+export interface FilteringPathAutoExpandDepthInHierarchy {
+    /**
+     * Depth that tells which nodes in the hierarchy should be expanded.
+     *
+     * This should take into account the number of grouping nodes in hierarchy.
+     *
+     * * **Use case example:**
+     *
+     * You want to `autoExpand` only `Node1` and `GroupingNode1` in the following hierarchy:
+     * - Node1
+     *   - GroupingNode1
+     *     - GroupingNode2
+     *       - Element1
+     *       - Element2
+     * Then you provide `autoExpand: { depthInHierarchy: 2 }`
+     *
+     * To get the correct depth use `HierarchyNode.parentKeys.length`.
+     *
+     * **NOTE**: All nodes that are up to and including `depthInHierarchy` will be expanded.
+     */
+    depthInHierarchy: number;
+}
+/** @public */
 export interface HierarchyFilteringPathOptions {
     /**
      * This option specifies the way `autoExpand` flag should be assigned to nodes in the filtered hierarchy.
@@ -47,8 +92,10 @@ export interface HierarchyFilteringPathOptions {
      * - If it's an instance of `FilterTargetGroupingNodeInfo`, then all nodes up to the grouping node that matches this property,
      * will have `autoExpand` flag.
      * - If it's an instance of `FilteringPathAutoExpandOption`, then all nodes up to and including `depth` will have `autoExpand` flag.
+     * - If it's an instance of `FilteringPathAutoExpandDepthInPath`, then all nodes up to `depthInPath` will have `autoExpand` flag.
+     * - If it's an instance of `FilteringPathAutoExpandDepthInHierarchy`, then all nodes up to and including `depthInHierarchy` will have `autoExpand` flag.
      */
-    autoExpand?: boolean | FilterTargetGroupingNodeInfo | FilteringPathAutoExpandOption;
+    autoExpand?: boolean | FilterTargetGroupingNodeInfo | FilteringPathAutoExpandOption | FilteringPathAutoExpandDepthInHierarchy | FilteringPathAutoExpandDepthInPath;
 }
 /**
  * A path of hierarchy node identifiers for filtering the hierarchy with additional options.
@@ -76,8 +123,8 @@ export declare namespace HierarchyFilteringPath {
      * - else if only one of the inputs is an object, return it,
      * - else if both inputs are falsy, return `false` or `undefined`,
      * - else:
-     *    - if only one of the inputs has `includeGroupingNodes` set to `true` or `key` defined, return the one that has only `depth` set,
-     *    - else return the one with greater `depth`.
+     *    - if only one of the inputs has `includeGroupingNodes` set to `true` or `key` defined or `depthInHierarchy` set, return the other one,
+     *    - else return the one with greater `depth`, `depthInPath` or `depthInHierarchy`.
      *
      * @public
      */
@@ -99,7 +146,7 @@ export declare function extractFilteringProps(rootLevelFilteringProps: Hierarchy
  *
  * @public
  */
-export declare function createHierarchyFilteringHelper(rootLevelFilteringProps: HierarchyFilteringPath[] | undefined, parentNode: Pick<NonGroupingHierarchyNode, "filtering"> | undefined): {
+export declare function createHierarchyFilteringHelper(rootLevelFilteringProps: HierarchyFilteringPath[] | undefined, parentNode: Pick<NonGroupingHierarchyNode, "filtering" | "parentKeys"> | undefined): {
     /**
      * Returns a flag indicating if the hierarchy level is filtered.
      */
@@ -129,19 +176,12 @@ export declare function createHierarchyFilteringHelper(rootLevelFilteringProps:
         nodeKey: InstancesNodeKey | GenericNodeKey;
     } | {
         pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean;
-    }) => NodeProps | undefined;
+    }) => Pick<HierarchyNode, "autoExpand" | "filtering"> | undefined;
     /**
      * Similar to `createChildNodeProps`, but takes an async `pathMatcher` prop.
      */
     createChildNodePropsAsync: (props: {
         pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;
-    }) => Promise<NodeProps | undefined> | NodeProps | undefined;
-};
-/** @public */
-export type NodeProps = Pick<HierarchyNode, "autoExpand" | "filtering"> & {
-    filtering?: {
-        autoExpandDepth?: number;
-        includeGroupingNodes?: boolean;
-    };
+    }) => Promise<Pick<HierarchyNode, "autoExpand" | "filtering"> | undefined> | Pick<HierarchyNode, "autoExpand" | "filtering"> | undefined;
 };
 //# sourceMappingURL=HierarchyFiltering.d.ts.map

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

@@ -1 +1 @@
-{"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;;;OAGG;IACH,GAAG,EAAE,eAAe,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,cAAc;AACd,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,cAAc;AACd,MAAM,WAAW,6BAA6B;IAC5C;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,4BAA4B,GAAG,6BAA6B,CAAC;CACrF;AA2BD;;;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;;;;;;;;;;;;;;;OAeG;IACH,SAAgB,YAAY,CAC1B,GAAG,EAAE,6BAA6B,GAAG,SAAS,EAC9C,GAAG,EAAE,6BAA6B,GAAG,SAAS,GAC7C,6BAA6B,GAAG,SAAS,CAQ3C;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,SAAS,GAAG,SAAS;IAoBxB;;OAEG;uCACgC;QACjC,WAAW,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KAClF,KAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,GAAG,SAAS;EAgC7D;AAED,cAAc;AACd,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,GAAG,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE;QAAE,eAAe,CAAC,EAAE,MAAM,CAAC;QAAC,oBAAoB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,CAAC"}
+{"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;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,GAAG,EAAE,eAAe,CAAC;IAErB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,cAAc;AACd,MAAM,WAAW,kCAAkC;IACjD;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,cAAc;AACd,MAAM,WAAW,uCAAuC;IACtD;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,cAAc;AACd,MAAM,WAAW,6BAA6B;IAC5C;;;;;;;;;OASG;IACH,UAAU,CAAC,EACP,OAAO,GAEP,4BAA4B,GAE5B,6BAA6B,GAC7B,uCAAuC,GACvC,kCAAkC,CAAC;CACxC;AAmCD;;;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;;;;;;;;;;;;;;;OAeG;IACH,SAAgB,YAAY,CAC1B,GAAG,EAAE,6BAA6B,GAAG,SAAS,EAC9C,GAAG,EAAE,6BAA6B,GAAG,SAAS,GAC7C,6BAA6B,GAAG,SAAS,CAQ3C;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,GAAG,YAAY,CAAC,GAAG,SAAS;IAKhF;;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,YAAY,GAAG,WAAW,CAAC,GAAG,SAAS;IAoB9D;;OAEG;uCACgC;QACjC,WAAW,EAAE,CAAC,UAAU,EAAE,uBAAuB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KAClF,KAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,GAAG,WAAW,CAAC,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,GAAG,WAAW,CAAC,GAAG,SAAS;EAgCzI"}

package/lib/cjs/hierarchies/HierarchyFiltering.js

@@ -18,16 +18,24 @@ var HierarchyFilteringPathOptions;
         if (!rhs || !lhs) {
             return !!rhs ? rhs : lhs;
         }
-        if (!("key" in lhs) && !lhs.includeGroupingNodes) {
-            if (!("key" in rhs) && !rhs.includeGroupingNodes) {
-                return lhs.depth > rhs.depth ? lhs : rhs;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const lhsDepth = "depth" in lhs ? lhs.depth : "depthInPath" in lhs ? lhs.depthInPath : lhs.depthInHierarchy;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const rhsDepth = "depth" in rhs ? rhs.depth : "depthInPath" in rhs ? rhs.depthInPath : rhs.depthInHierarchy;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const isLhsDepthBasedOnPath = "depthInPath" in lhs ? true : !("key" in lhs) && !("depthInHierarchy" in lhs) && !lhs.includeGroupingNodes;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const isRhsDepthBasedOnPath = "depthInPath" in rhs ? true : !("key" in rhs) && !("depthInHierarchy" in rhs) && !rhs.includeGroupingNodes;
+        if (isLhsDepthBasedOnPath) {
+            if (isRhsDepthBasedOnPath) {
+                return lhsDepth > rhsDepth ? lhs : rhs;
             }
             return lhs;
         }
-        if (!("key" in rhs) && !rhs.includeGroupingNodes) {
+        if (isRhsDepthBasedOnPath) {
             return rhs;
         }
-        return lhs.depth > rhs.depth ? lhs : rhs;
+        return lhsDepth > rhsDepth ? lhs : rhs;
     }
     HierarchyFilteringPathOptions.mergeAutoExpandOptions = mergeAutoExpandOptions;
 })(HierarchyFilteringPathOptions || (HierarchyFilteringPathOptions = {}));
@@ -57,8 +65,8 @@ var HierarchyFilteringPath;
      * - else if only one of the inputs is an object, return it,
      * - else if both inputs are falsy, return `false` or `undefined`,
      * - else:
-     *    - if only one of the inputs has `includeGroupingNodes` set to `true` or `key` defined, return the one that has only `depth` set,
-     *    - else return the one with greater `depth`.
+     *    - if only one of the inputs has `includeGroupingNodes` set to `true` or `key` defined or `depthInHierarchy` set, return the other one,
+     *    - else return the one with greater `depth`, `depthInPath` or `depthInHierarchy`.
      *
      * @public
      */
@@ -153,7 +161,7 @@ function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNode) {
                     reducer.accept(normalizedPath);
                 }
             });
-            return reducer.getNodeProps();
+            return reducer.getNodeProps(parentNode);
         },
         /**
          * Similar to `createChildNodeProps`, but takes an async `pathMatcher` prop.
@@ -181,11 +189,11 @@ function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNode) {
                 reducer.accept(normalizedPath);
             }
             if (matchedPathPromises.length === 0) {
-                return reducer.getNodeProps();
+                return reducer.getNodeProps(parentNode);
             }
             return Promise.all(matchedPathPromises)
                 .then((matchedPath) => matchedPath.forEach((normalizedPath) => normalizedPath && reducer.accept(normalizedPath)))
-                .then(() => reducer.getNodeProps());
+                .then(() => reducer.getNodeProps(parentNode));
         },
     };
 }
@@ -194,21 +202,46 @@ class MatchingFilteringPathsReducer {
     _filteredChildrenIdentifierPaths = new Array();
     _isFilterTarget = false;
     _filterTargetOptions = undefined;
-    _needsAutoExpand = false;
+    _autoExpandOption = false;
     constructor(_hasFilterTargetAncestor) {
         this._hasFilterTargetAncestor = _hasFilterTargetAncestor;
     }
-    accept({ path, options }) {
+    accept(normalizedPath) {
+        const { path, options } = normalizedPath;
         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 });
-            this._needsAutoExpand = HierarchyFilteringPathOptions.mergeAutoExpandOptions(options?.autoExpand, this._needsAutoExpand);
+            this._autoExpandOption = HierarchyFilteringPathOptions.mergeAutoExpandOptions(options?.autoExpand, this._autoExpandOption);
         }
     }
-    getNodeProps() {
+    getNeedsAutoExpand(parentNode) {
+        if (this._autoExpandOption === true) {
+            return true;
+        }
+        if (typeof this._autoExpandOption === "object") {
+            const parentLength = !parentNode
+                ? 0
+                : "key" in this._autoExpandOption ||
+                    "depthInHierarchy" in this._autoExpandOption ||
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
+                    ("includeGroupingNodes" in this._autoExpandOption && this._autoExpandOption.includeGroupingNodes)
+                    ? 1 + parentNode.parentKeys.length
+                    : 1 + parentNode.parentKeys.filter((key) => !HierarchyNodeKey_js_1.HierarchyNodeKey.isGrouping(key)).length;
+            const depth = "depthInHierarchy" in this._autoExpandOption
+                ? this._autoExpandOption.depthInHierarchy
+                : "depth" in this._autoExpandOption
+                    ? // eslint-disable-next-line @typescript-eslint/no-deprecated
+                        this._autoExpandOption.depth
+                    : // With `depthInPath` option we don't want to expand node that is at the `depthInPath` position
+                        this._autoExpandOption.depthInPath - 1;
+            return parentLength < depth;
+        }
+        return false;
+    }
+    getNodeProps(parentNode) {
         return {
             ...(this._hasFilterTargetAncestor || this._isFilterTarget || this._filteredChildrenIdentifierPaths.length > 0
                 ? {
@@ -216,16 +249,10 @@ class MatchingFilteringPathsReducer {
                         ...(this._hasFilterTargetAncestor ? { hasFilterTargetAncestor: true } : undefined),
                         ...(this._isFilterTarget ? { isFilterTarget: true, filterTargetOptions: this._filterTargetOptions } : undefined),
                         ...(this._filteredChildrenIdentifierPaths.length > 0 ? { filteredChildrenIdentifierPaths: this._filteredChildrenIdentifierPaths } : undefined),
-                        ...(this._needsAutoExpand && this._needsAutoExpand !== true
-                            ? {
-                                autoExpandDepth: this._needsAutoExpand.depth,
-                                includeGroupingNodes: "key" in this._needsAutoExpand || this._needsAutoExpand.includeGroupingNodes ? true : false,
-                            }
-                            : undefined),
                     },
                 }
                 : undefined),
-            ...(this._needsAutoExpand ? { autoExpand: !!this._needsAutoExpand } : undefined),
+            ...(this.getNeedsAutoExpand(parentNode) ? { autoExpand: true } : undefined),
         };
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyFiltering.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyFiltering.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA4IhG,sDAUC;AA6BD,wEA4GC;AA5RD,6EAAqG;AACrG,+DAA4G;AAuD5G,IAAU,6BAA6B,CAuBtC;AAvBD,WAAU,6BAA6B;IACrC,SAAgB,sBAAsB,CACpC,GAAgD,EAChD,GAAgD;QAEhD,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;YACjD,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACjD,OAAO,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;YAC3C,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;YACjD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IAC3C,CAAC;IArBe,oDAAsB,yBAqBrC,CAAA;AACH,CAAC,EAvBS,6BAA6B,KAA7B,6BAA6B,QAuBtC;AAOD,cAAc;AACd,2DAA2D;AAC3D,IAAiB,sBAAsB,CAwCtC;AAxCD,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;;;;;;;;;;;;;;;OAeG;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,6BAA6B,CAAC,sBAAsB,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;SACjG,CAAC;IACJ,CAAC;IAXe,mCAAY,eAW3B,CAAA;AACH,CAAC,EAxCgB,sBAAsB,sCAAtB,sBAAsB,QAwCtC;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,EACkB,EAAE;YACzB,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,CAAC,KAE3B,EAA0D,EAAE;YAC3D,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,6BAA6B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;YAC3F,MAAM,mBAAmB,GAAG,IAAI,KAAK,EAAgD,CAAC;YACtF,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,mBAAmB,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC3G,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBAC5B,SAAS;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;YAChC,CAAC;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;iBACpC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;iBAChH,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QACxC,CAAC;KACF,CAAC;AACJ,CAAC;AAOD,MAAM,6BAA6B;IAMN;IALnB,gCAAgC,GAAG,IAAI,KAAK,EAA2B,CAAC;IACxE,eAAe,GAAG,KAAK,CAAC;IACxB,oBAAoB,GAAG,SAAsD,CAAC;IAC9E,gBAAgB,GAAgD,KAAK,CAAC;IAE9E,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,CAAC,gBAAgB,GAAG,6BAA6B,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3H,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;wBAC9I,GAAG,CAAC,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB,KAAK,IAAI;4BACzD,CAAC,CAAC;gCACE,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK;gCAC5C,oBAAoB,EAAE,KAAK,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;6BAClH;4BACH,CAAC,CAAC,SAAS,CAAC;qBACf;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACjF,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  /**\n   * Key of the grouping node.\n   * @deprecated in 1.6. Use `FilteringPathAutoExpandOption` with `includeGroupingNodes` set to true instead.\n   */\n  key: GroupingNodeKey;\n\n  /**\n   * Depth up to which nodes in the hierarchy should be expanded.\n   */\n  depth: number;\n}\n\n/** @public */\nexport interface FilteringPathAutoExpandOption {\n  /**\n   * Depth up to which nodes in the hierarchy should be expanded.\n   *\n   * If `includeGroupingNodes` is set to true, then depth should take into account the number of grouping nodes in hierarchy.\n   */\n  depth: number;\n  /**\n   * Whether or not `depth` includes grouping nodes.\n   *\n   * Use when you want to autoExpand only some of the grouping nodes.\n   *\n   * **Use case example:**\n   *\n   * You want to `autoExpand` only `Node1` and `GroupingNode1` in the following hierarchy:\n   * - Node1\n   *   - GroupingNode1\n   *     - GroupingNode2\n   *       - Element1\n   *       - Element2\n   * Then you provide `autoExpand: { depth: 2, includeGroupingNodes: true }`\n   */\n  includeGroupingNodes?: boolean;\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   * - If it's an instance of `FilteringPathAutoExpandOption`, then all nodes up to and including `depth` will have `autoExpand` flag.\n   */\n  autoExpand?: boolean | FilterTargetGroupingNodeInfo | FilteringPathAutoExpandOption;\n}\n\nnamespace HierarchyFilteringPathOptions {\n  export function mergeAutoExpandOptions(\n    lhs: HierarchyFilteringPathOptions[\"autoExpand\"],\n    rhs: HierarchyFilteringPathOptions[\"autoExpand\"],\n  ): HierarchyFilteringPathOptions[\"autoExpand\"] {\n    if (rhs === true || lhs === true) {\n      return true;\n    }\n    if (!rhs || !lhs) {\n      return !!rhs ? rhs : lhs;\n    }\n\n    if (!(\"key\" in lhs) && !lhs.includeGroupingNodes) {\n      if (!(\"key\" in rhs) && !rhs.includeGroupingNodes) {\n        return lhs.depth > rhs.depth ? lhs : rhs;\n      }\n      return lhs;\n    }\n    if (!(\"key\" in rhs) && !rhs.includeGroupingNodes) {\n      return rhs;\n    }\n    return lhs.depth > rhs.depth ? lhs : rhs;\n  }\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 only one of the inputs is an object, return it,\n   * - else if both inputs are falsy, return `false` or `undefined`,\n   * - else:\n   *    - if only one of the inputs has `includeGroupingNodes` set to `true` or `key` defined, return the one that has only `depth` set,\n   *    - else return the one with greater `depth`.\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.mergeAutoExpandOptions(lhs.autoExpand, rhs.autoExpand),\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    ): NodeProps | 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: (props: {\n      pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n    }): Promise<NodeProps | undefined> | NodeProps | undefined => {\n      if (!hasFilter) {\n        return undefined;\n      }\n      const reducer = new MatchingFilteringPathsReducer(filteringProps?.hasFilterTargetAncestor);\n      const matchedPathPromises = new Array<Promise<NormalizedFilteringPath | undefined>>();\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          matchedPathPromises.push(matchesPossiblyPromise.then((matches) => (matches ? normalizedPath : undefined)));\n          continue;\n        }\n        if (!matchesPossiblyPromise) {\n          continue;\n        }\n\n        reducer.accept(normalizedPath);\n      }\n      if (matchedPathPromises.length === 0) {\n        return reducer.getNodeProps();\n      }\n      return Promise.all(matchedPathPromises)\n        .then((matchedPath) => matchedPath.forEach((normalizedPath) => normalizedPath && reducer.accept(normalizedPath)))\n        .then(() => reducer.getNodeProps());\n    },\n  };\n}\n\n/** @public */\nexport type NodeProps = Pick<HierarchyNode, \"autoExpand\" | \"filtering\"> & { filtering?: { autoExpandDepth?: number; includeGroupingNodes?: boolean } };\n\ntype NormalizedFilteringPath = ReturnType<(typeof HierarchyFilteringPath)[\"normalize\"]>;\n\nclass MatchingFilteringPathsReducer {\n  private _filteredChildrenIdentifierPaths = new Array<NormalizedFilteringPath>();\n  private _isFilterTarget = false;\n  private _filterTargetOptions = undefined as HierarchyFilteringPathOptions | undefined;\n  private _needsAutoExpand: HierarchyFilteringPathOptions[\"autoExpand\"] = 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      this._needsAutoExpand = HierarchyFilteringPathOptions.mergeAutoExpandOptions(options?.autoExpand, this._needsAutoExpand);\n    }\n  }\n  public getNodeProps(): NodeProps {\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              ...(this._needsAutoExpand && this._needsAutoExpand !== true\n                ? {\n                    autoExpandDepth: this._needsAutoExpand.depth,\n                    includeGroupingNodes: \"key\" in this._needsAutoExpand || this._needsAutoExpand.includeGroupingNodes ? true : false,\n                  }\n                : undefined),\n            },\n          }\n        : undefined),\n      ...(this._needsAutoExpand ? { autoExpand: !!this._needsAutoExpand } : undefined),\n    };\n  }\n}\n"]}
+{"version":3,"file":"HierarchyFiltering.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyFiltering.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA4MhG,sDAUC;AA6BD,wEA4GC;AA5VD,6EAAqG;AACrG,+DAA4G;AA+G5G,IAAU,6BAA6B,CA+BtC;AA/BD,WAAU,6BAA6B;IACrC,SAAgB,sBAAsB,CACpC,GAAgD,EAChD,GAAgD;QAEhD,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACjB,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3B,CAAC;QACD,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAC5G,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAC5G,4DAA4D;QAC5D,MAAM,qBAAqB,GAAG,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,kBAAkB,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC;QACzI,4DAA4D;QAC5D,MAAM,qBAAqB,GAAG,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,kBAAkB,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC;QAEzI,IAAI,qBAAqB,EAAE,CAAC;YAC1B,IAAI,qBAAqB,EAAE,CAAC;gBAC1B,OAAO,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;YACzC,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,qBAAqB,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC;QACb,CAAC;QACD,OAAO,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;IACzC,CAAC;IA7Be,oDAAsB,yBA6BrC,CAAA;AACH,CAAC,EA/BS,6BAA6B,KAA7B,6BAA6B,QA+BtC;AAOD,cAAc;AACd,2DAA2D;AAC3D,IAAiB,sBAAsB,CAwCtC;AAxCD,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;;;;;;;;;;;;;;;OAeG;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,6BAA6B,CAAC,sBAAsB,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;SACjG,CAAC;IACJ,CAAC;IAXe,mCAAY,eAW3B,CAAA;AACH,CAAC,EAxCgB,sBAAsB,sCAAtB,sBAAsB,QAwCtC;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,UAAkF;IAElF,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,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;QAED;;WAEG;QACH,yBAAyB,EAAE,CAAC,KAE3B,EAAsI,EAAE;YACvI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,6BAA6B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;YAC3F,MAAM,mBAAmB,GAAG,IAAI,KAAK,EAAgD,CAAC;YACtF,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,mBAAmB,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC3G,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBAC5B,SAAS;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAC1C,CAAC;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;iBACpC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;iBAChH,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC;QAClD,CAAC;KACF,CAAC;AACJ,CAAC;AAID,MAAM,6BAA6B;IAMN;IALnB,gCAAgC,GAAG,IAAI,KAAK,EAA2B,CAAC;IACxE,eAAe,GAAG,KAAK,CAAC;IACxB,oBAAoB,GAAG,SAAsD,CAAC;IAC9E,iBAAiB,GAAgD,KAAK,CAAC;IAE/E,YAA2B,wBAAiC;QAAjC,6BAAwB,GAAxB,wBAAwB,CAAS;IAAG,CAAC;IAEzD,MAAM,CAAC,cAAuC;QACnD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;QACzC,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,CAAC,iBAAiB,GAAG,6BAA6B,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,UAAoE;QAC7F,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YAC/C,MAAM,YAAY,GAAG,CAAC,UAAU;gBAC9B,CAAC,CAAC,CAAC;gBACH,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,iBAAiB;oBAC7B,kBAAkB,IAAI,IAAI,CAAC,iBAAiB;oBAC5C,4DAA4D;oBAC5D,CAAC,sBAAsB,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;oBACnG,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM;oBAClC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,sCAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;YAC1F,MAAM,KAAK,GACT,kBAAkB,IAAI,IAAI,CAAC,iBAAiB;gBAC1C,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB;gBACzC,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,iBAAiB;oBACjC,CAAC,CAAC,4DAA4D;wBAC5D,IAAI,CAAC,iBAAiB,CAAC,KAAK;oBAC9B,CAAC,CAAC,+FAA+F;wBAC/F,IAAI,CAAC,iBAAiB,CAAC,WAAW,GAAG,CAAC,CAAC;YAE/C,OAAO,YAAY,GAAG,KAAK,CAAC;QAC9B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,YAAY,CAAC,UAAoE;QACtF,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,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC5E,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/**\n * @public\n * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInHierarchy` instead.\n */\nexport interface FilterTargetGroupingNodeInfo {\n  /**\n   * Key of the grouping node.\n   * @deprecated in 1.6. Use `FilteringPathAutoExpandDepthInHierarchy` instead.\n   */\n  key: GroupingNodeKey;\n\n  /**\n   * Depth up to which nodes in the hierarchy should be expanded.\n   * @deprecated in 1.6. Use `FilteringPathAutoExpandDepthInHierarchy` instead.\n   */\n  depth: number;\n}\n\n/**\n * @public\n * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInPath` or `FilteringPathAutoExpandDepthInHierarchy` instead.\n */\nexport interface FilteringPathAutoExpandOption {\n  /**\n   * Depth up to which nodes in the hierarchy should be expanded.\n   *\n   * If `includeGroupingNodes` is set to true, then depth should take into account the number of grouping nodes in hierarchy.\n   * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInPath` or `FilteringPathAutoExpandDepthInHierarchy` instead.\n   */\n  depth: number;\n  /**\n   * Whether or not `depth` includes grouping nodes.\n   *\n   * Use when you want to autoExpand only some of the grouping nodes.\n   *\n   * **Use case example:**\n   *\n   * You want to `autoExpand` only `Node1` and `GroupingNode1` in the following hierarchy:\n   * - Node1\n   *   - GroupingNode1\n   *     - GroupingNode2\n   *       - Element1\n   *       - Element2\n   * Then you provide `autoExpand: { depth: 2, includeGroupingNodes: true }`\n   *\n   * To get the correct depth use `HierarchyNode.parentKeys.length`.\n   * @deprecated in 1.7. Use `FilteringPathAutoExpandDepthInHierarchy` instead.\n   */\n  includeGroupingNodes?: boolean;\n}\n\n/** @public */\nexport interface FilteringPathAutoExpandDepthInPath {\n  /**\n   * Depth that tells which nodes in the filtering path should be expanded.\n   *\n   * Use when you want to expand up to specific instance node and don't care about grouping nodes.\n   *\n   * **NOTE**: All nodes that are up to `depthInPath` will be expanded. Node at the `depthInPath` position won't be expanded.\n   */\n  depthInPath: number;\n}\n\n/** @public */\nexport interface FilteringPathAutoExpandDepthInHierarchy {\n  /**\n   * Depth that tells which nodes in the hierarchy should be expanded.\n   *\n   * This should take into account the number of grouping nodes in hierarchy.\n   *\n   * * **Use case example:**\n   *\n   * You want to `autoExpand` only `Node1` and `GroupingNode1` in the following hierarchy:\n   * - Node1\n   *   - GroupingNode1\n   *     - GroupingNode2\n   *       - Element1\n   *       - Element2\n   * Then you provide `autoExpand: { depthInHierarchy: 2 }`\n   *\n   * To get the correct depth use `HierarchyNode.parentKeys.length`.\n   *\n   * **NOTE**: All nodes that are up to and including `depthInHierarchy` will be expanded.\n   */\n  depthInHierarchy: 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   * - If it's an instance of `FilteringPathAutoExpandOption`, then all nodes up to and including `depth` will have `autoExpand` flag.\n   * - If it's an instance of `FilteringPathAutoExpandDepthInPath`, then all nodes up to `depthInPath` will have `autoExpand` flag.\n   * - If it's an instance of `FilteringPathAutoExpandDepthInHierarchy`, then all nodes up to and including `depthInHierarchy` will have `autoExpand` flag.\n   */\n  autoExpand?:\n    | boolean\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    | FilterTargetGroupingNodeInfo\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    | FilteringPathAutoExpandOption\n    | FilteringPathAutoExpandDepthInHierarchy\n    | FilteringPathAutoExpandDepthInPath;\n}\n\nnamespace HierarchyFilteringPathOptions {\n  export function mergeAutoExpandOptions(\n    lhs: HierarchyFilteringPathOptions[\"autoExpand\"],\n    rhs: HierarchyFilteringPathOptions[\"autoExpand\"],\n  ): HierarchyFilteringPathOptions[\"autoExpand\"] {\n    if (rhs === true || lhs === true) {\n      return true;\n    }\n    if (!rhs || !lhs) {\n      return !!rhs ? rhs : lhs;\n    }\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const lhsDepth = \"depth\" in lhs ? lhs.depth : \"depthInPath\" in lhs ? lhs.depthInPath : lhs.depthInHierarchy;\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const rhsDepth = \"depth\" in rhs ? rhs.depth : \"depthInPath\" in rhs ? rhs.depthInPath : rhs.depthInHierarchy;\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const isLhsDepthBasedOnPath = \"depthInPath\" in lhs ? true : !(\"key\" in lhs) && !(\"depthInHierarchy\" in lhs) && !lhs.includeGroupingNodes;\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const isRhsDepthBasedOnPath = \"depthInPath\" in rhs ? true : !(\"key\" in rhs) && !(\"depthInHierarchy\" in rhs) && !rhs.includeGroupingNodes;\n\n    if (isLhsDepthBasedOnPath) {\n      if (isRhsDepthBasedOnPath) {\n        return lhsDepth > rhsDepth ? lhs : rhs;\n      }\n      return lhs;\n    }\n    if (isRhsDepthBasedOnPath) {\n      return rhs;\n    }\n    return lhsDepth > rhsDepth ? lhs : rhs;\n  }\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 only one of the inputs is an object, return it,\n   * - else if both inputs are falsy, return `false` or `undefined`,\n   * - else:\n   *    - if only one of the inputs has `includeGroupingNodes` set to `true` or `key` defined or `depthInHierarchy` set, return the other one,\n   *    - else return the one with greater `depth`, `depthInPath` or `depthInHierarchy`.\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.mergeAutoExpandOptions(lhs.autoExpand, rhs.autoExpand),\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\" | \"parentKeys\"> | 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, \"autoExpand\" | \"filtering\"> | 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(parentNode);\n    },\n\n    /**\n     * Similar to `createChildNodeProps`, but takes an async `pathMatcher` prop.\n     */\n    createChildNodePropsAsync: (props: {\n      pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n    }): Promise<Pick<HierarchyNode, \"autoExpand\" | \"filtering\"> | undefined> | Pick<HierarchyNode, \"autoExpand\" | \"filtering\"> | undefined => {\n      if (!hasFilter) {\n        return undefined;\n      }\n      const reducer = new MatchingFilteringPathsReducer(filteringProps?.hasFilterTargetAncestor);\n      const matchedPathPromises = new Array<Promise<NormalizedFilteringPath | undefined>>();\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          matchedPathPromises.push(matchesPossiblyPromise.then((matches) => (matches ? normalizedPath : undefined)));\n          continue;\n        }\n        if (!matchesPossiblyPromise) {\n          continue;\n        }\n\n        reducer.accept(normalizedPath);\n      }\n      if (matchedPathPromises.length === 0) {\n        return reducer.getNodeProps(parentNode);\n      }\n      return Promise.all(matchedPathPromises)\n        .then((matchedPath) => matchedPath.forEach((normalizedPath) => normalizedPath && reducer.accept(normalizedPath)))\n        .then(() => reducer.getNodeProps(parentNode));\n    },\n  };\n}\n\ntype NormalizedFilteringPath = ReturnType<(typeof HierarchyFilteringPath)[\"normalize\"]>;\n\nclass MatchingFilteringPathsReducer {\n  private _filteredChildrenIdentifierPaths = new Array<NormalizedFilteringPath>();\n  private _isFilterTarget = false;\n  private _filterTargetOptions = undefined as HierarchyFilteringPathOptions | undefined;\n  private _autoExpandOption: HierarchyFilteringPathOptions[\"autoExpand\"] = false;\n\n  public constructor(private _hasFilterTargetAncestor: boolean) {}\n\n  public accept(normalizedPath: NormalizedFilteringPath): void {\n    const { path, options } = normalizedPath;\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      this._autoExpandOption = HierarchyFilteringPathOptions.mergeAutoExpandOptions(options?.autoExpand, this._autoExpandOption);\n    }\n  }\n\n  private getNeedsAutoExpand(parentNode: Pick<NonGroupingHierarchyNode, \"parentKeys\"> | undefined): boolean {\n    if (this._autoExpandOption === true) {\n      return true;\n    }\n    if (typeof this._autoExpandOption === \"object\") {\n      const parentLength = !parentNode\n        ? 0\n        : \"key\" in this._autoExpandOption ||\n            \"depthInHierarchy\" in this._autoExpandOption ||\n            // eslint-disable-next-line @typescript-eslint/no-deprecated\n            (\"includeGroupingNodes\" in this._autoExpandOption && this._autoExpandOption.includeGroupingNodes)\n          ? 1 + parentNode.parentKeys.length\n          : 1 + parentNode.parentKeys.filter((key) => !HierarchyNodeKey.isGrouping(key)).length;\n      const depth =\n        \"depthInHierarchy\" in this._autoExpandOption\n          ? this._autoExpandOption.depthInHierarchy\n          : \"depth\" in this._autoExpandOption\n            ? // eslint-disable-next-line @typescript-eslint/no-deprecated\n              this._autoExpandOption.depth\n            : // With `depthInPath` option we don't want to expand node that is at the `depthInPath` position\n              this._autoExpandOption.depthInPath - 1;\n\n      return parentLength < depth;\n    }\n    return false;\n  }\n\n  public getNodeProps(parentNode: Pick<NonGroupingHierarchyNode, \"parentKeys\"> | undefined): Pick<HierarchyNode, \"autoExpand\" | \"filtering\"> {\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.getNeedsAutoExpand(parentNode) ? { autoExpand: true } : undefined),\n    };\n  }\n}\n"]}

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

@@ -19,7 +19,6 @@ export declare class FilteringHierarchyDefinition implements RxjsHierarchyDefini
     private _nodesParser;
     constructor(props: FilteringHierarchyDefinitionProps);
     get preProcessNode(): RxjsNodePreProcessor;
-    private shouldExpandGroupingNode;
     get postProcessNode(): RxjsNodePostProcessor;
     get parseNode(): RxjsNodeParser;
     defineHierarchyLevel(props: DefineHierarchyLevelProps): Observable<HierarchyLevelDefinition>;

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

@@ -1 +1 @@
-{"version":3,"file":"FilteringHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/FilteringHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuD,UAAU,EAAe,MAAM,MAAM,CAAC;AAEpG,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAAkC,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlG,OAAO,EACL,yBAAyB,EAEzB,wBAAwB,EAExB,4BAA4B,EAC7B,MAAM,wCAAwC,CAAC;AAKhD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9I,UAAU,iCAAiC;IACzC,YAAY,EAAE,yBAAyB,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,MAAM,EAAE,uBAAuB,CAAC;IAChC,mBAAmB,EAAE,sBAAsB,EAAE,CAAC;IAC9C,WAAW,CAAC,EAAE,cAAc,CAAC;CAC9B;AAED,gBAAgB;AAChB,qBAAa,4BAA6B,YAAW,uBAAuB;IAC1E,OAAO,CAAC,aAAa,CAAoD;IACzE,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,oBAAoB,CAA2B;IACvD,OAAO,CAAC,YAAY,CAAiB;gBAElB,KAAK,EAAE,iCAAiC;IAO3D,IAAW,cAAc,IAAI,oBAAoB,CAYhD;IAED,OAAO,CAAC,wBAAwB;IA8ChC,IAAW,eAAe,IAAI,qBAAqB,CAYlD;IAED,IAAW,SAAS,IAAI,cAAc,CAiDrC;IAEM,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAoGpG;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"}
+{"version":3,"file":"FilteringHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/FilteringHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuD,UAAU,EAAe,MAAM,MAAM,CAAC;AAEpG,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAAkC,sBAAsB,EAAiC,MAAM,0BAA0B,CAAC;AAGjI,OAAO,EACL,yBAAyB,EAEzB,wBAAwB,EAExB,4BAA4B,EAC7B,MAAM,wCAAwC,CAAC;AAKhD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9I,UAAU,iCAAiC;IACzC,YAAY,EAAE,yBAAyB,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,MAAM,EAAE,uBAAuB,CAAC;IAChC,mBAAmB,EAAE,sBAAsB,EAAE,CAAC;IAC9C,WAAW,CAAC,EAAE,cAAc,CAAC;CAC9B;AAED,gBAAgB;AAChB,qBAAa,4BAA6B,YAAW,uBAAuB;IAC1E,OAAO,CAAC,aAAa,CAAoD;IACzE,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,oBAAoB,CAA2B;IACvD,OAAO,CAAC,YAAY,CAAiB;gBAElB,KAAK,EAAE,iCAAiC;IAO3D,IAAW,cAAc,IAAI,oBAAoB,CAYhD;IAED,IAAW,eAAe,IAAI,qBAAqB,CAYlD;IAED,IAAW,SAAS,IAAI,cAAc,CA2CrC;IAEM,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAoGpG;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"}

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

@@ -39,49 +39,11 @@ class FilteringHierarchyDefinition {
             }));
         };
     }
-    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 = "key" in childAutoExpand || childAutoExpand.includeGroupingNodes
-                    ? node.parentKeys.length
-                    : node.parentKeys.filter((key) => !HierarchyNodeKey_js_1.HierarchyNodeKey.isGrouping(key)).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 (node) => {
             return (this._source.postProcessNode ? this._source.postProcessNode(node) : (0, rxjs_1.of)(node)).pipe((0, rxjs_1.map)((processedNode) => {
                 // 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)) {
+                if (IModelHierarchyNode_js_1.ProcessedHierarchyNode.isGroupingNode(node) && shouldExpandGroupingNode(node)) {
                     Object.assign(processedNode, { autoExpand: true });
                 }
                 return processedNode;
@@ -118,13 +80,7 @@ class FilteringHierarchyDefinition {
                 });
                 return (nodeExtraPropsPossiblyPromise instanceof Promise ? (0, rxjs_1.from)(nodeExtraPropsPossiblyPromise) : (0, rxjs_1.of)(nodeExtraPropsPossiblyPromise)).pipe((0, rxjs_1.map)((nodeExtraProps) => {
                     if (nodeExtraProps?.autoExpand) {
-                        const parentLength = !parentNode
-                            ? 0
-                            : nodeExtraProps.filtering?.includeGroupingNodes
-                                ? 1 + parentNode.parentKeys.length
-                                : 1 + parentNode.parentKeys.filter((key) => !HierarchyNodeKey_js_1.HierarchyNodeKey.isGrouping(key)).length;
-                        parsedNode.autoExpand =
-                            nodeExtraProps.filtering?.autoExpandDepth !== undefined && parentLength >= nodeExtraProps.filtering.autoExpandDepth ? undefined : true;
+                        parsedNode.autoExpand = true;
                     }
                     if (nodeExtraProps?.filtering) {
                         parsedNode.filtering = nodeExtraProps.filtering;
@@ -280,4 +236,52 @@ function applyECInstanceIdsSelector(def) {
         },
     };
 }
+function shouldExpandGroupingNode(node) {
+    const numberOfNonGroupingParentNodes = node.parentKeys.filter((key) => !HierarchyNodeKey_js_1.HierarchyNodeKey.isGrouping(key)).length;
+    for (const child of node.children) {
+        /* c8 ignore next 3 */
+        if (!child.filtering) {
+            continue;
+        }
+        if (child.filtering.isFilterTarget &&
+            getAutoExpandAsTrueFalse(child.filtering.filterTargetOptions?.autoExpand, numberOfNonGroupingParentNodes, node.parentKeys.length)) {
+            return true;
+        }
+        if (!child.filtering.filteredChildrenIdentifierPaths) {
+            /* c8 ignore next */
+            continue;
+        }
+        for (const path of child.filtering.filteredChildrenIdentifierPaths) {
+            if ("path" in path && getAutoExpandAsTrueFalse(path.options?.autoExpand, numberOfNonGroupingParentNodes, node.parentKeys.length)) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function getAutoExpandAsTrueFalse(autoExpand, numberOfNonGroupingParentNodes, numberOfParentNodes) {
+    if (!autoExpand) {
+        return false;
+    }
+    if (autoExpand === true) {
+        return true;
+    }
+    // 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 = 
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    "key" in autoExpand || "depthInHierarchy" in autoExpand || (!("depthInPath" in autoExpand) && autoExpand.includeGroupingNodes)
+        ? numberOfParentNodes
+        : numberOfNonGroupingParentNodes;
+    const filterTargetDepth = "depth" in autoExpand
+        ? // eslint-disable-next-line @typescript-eslint/no-deprecated
+            autoExpand.depth
+        : "depthInPath" in autoExpand
+            ? autoExpand.depthInPath
+            : autoExpand.depthInHierarchy;
+    if (nodeDepth < filterTargetDepth) {
+        return true;
+    }
+    return false;
+}
 //# sourceMappingURL=FilteringHierarchyDefinition.js.map