@itwin/presentation-hierarchies 2.0.0-alpha.6 → 2.0.0-alpha.8

package/lib/esm/hierarchies/{HierarchyFiltering.js → HierarchySearch.js}

@@ -4,8 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 import { HierarchyNodeIdentifier } from "./HierarchyNodeIdentifier.js";
 import { HierarchyNodeKey } from "./HierarchyNodeKey.js";
-var HierarchyFilteringPathOptions;
-(function (HierarchyFilteringPathOptions) {
+var HierarchySearchPathOptions;
+(function (HierarchySearchPathOptions) {
     function mergeRevealOptions(lhs, rhs) {
         if (rhs === true || lhs === true) {
             return true;
@@ -28,18 +28,18 @@ var HierarchyFilteringPathOptions;
         }
         return lhsDepth > rhsDepth ? lhs : rhs;
     }
-    HierarchyFilteringPathOptions.mergeRevealOptions = mergeRevealOptions;
+    HierarchySearchPathOptions.mergeRevealOptions = mergeRevealOptions;
     function mergeAutoExpandOption(lhs, rhs) {
         return lhs || rhs ? true : undefined;
     }
-    HierarchyFilteringPathOptions.mergeAutoExpandOption = mergeAutoExpandOption;
-})(HierarchyFilteringPathOptions || (HierarchyFilteringPathOptions = {}));
+    HierarchySearchPathOptions.mergeAutoExpandOption = mergeAutoExpandOption;
+})(HierarchySearchPathOptions || (HierarchySearchPathOptions = {}));
 /** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
-export var HierarchyFilteringPath;
-(function (HierarchyFilteringPath) {
+export var HierarchySearchPath;
+(function (HierarchySearchPath) {
     /**
-     * Normalizes the hierarchy filtering path to the object form.
+     * Normalizes the hierarchy search path to the object form.
      * @public
      */
     function normalize(source) {
@@ -48,9 +48,9 @@ export var HierarchyFilteringPath;
         }
         return source;
     }
-    HierarchyFilteringPath.normalize = normalize;
+    HierarchySearchPath.normalize = normalize;
     /**
-     * Merges two given `HierarchyFilteringPathOptions` objects.
+     * Merges two given `HierarchySearchPathOptions` objects.
      *
      * For the `reveal` attribute, the merge chooses to `reveal` as deep as the deepest input:
      * - if any one of the inputs is `true`, return `true`,
@@ -63,8 +63,8 @@ export var HierarchyFilteringPath;
      * @public
      */
     function mergeOptions(lhs, rhs) {
-        const reveal = HierarchyFilteringPathOptions.mergeRevealOptions(lhs?.reveal, rhs?.reveal);
-        const autoExpand = HierarchyFilteringPathOptions.mergeAutoExpandOption(lhs?.autoExpand, rhs?.autoExpand);
+        const reveal = HierarchySearchPathOptions.mergeRevealOptions(lhs?.reveal, rhs?.reveal);
+        const autoExpand = HierarchySearchPathOptions.mergeAutoExpandOption(lhs?.autoExpand, rhs?.autoExpand);
         return reveal || autoExpand
             ? {
                 ...(reveal !== undefined ? { reveal } : undefined),
@@ -72,55 +72,40 @@ export var HierarchyFilteringPath;
             }
             : undefined;
     }
-    HierarchyFilteringPath.mergeOptions = mergeOptions;
-})(HierarchyFilteringPath || (HierarchyFilteringPath = {}));
-/**
- * An utility that extracts filtering properties from given root level filtering props or
- * the parent node. Returns `undefined` if filtering props are not present.
- * @public
- * @deprecated in 1.3. Use `createHierarchyFilteringHelper` instead.
- */
+    HierarchySearchPath.mergeOptions = mergeOptions;
+})(HierarchySearchPath || (HierarchySearchPath = {}));
+// TODO: remove c8 ignore start and add tests to cover the gaps
 /* c8 ignore start */
-export function extractFilteringProps(rootLevelFilteringProps, parentNode) {
-    const filteringProps = extractFilteringPropsInternal(rootLevelFilteringProps, parentNode);
-    return filteringProps?.filteredNodePaths !== undefined
-        ? {
-            filteredNodePaths: filteringProps.filteredNodePaths,
-            hasFilterTargetAncestor: filteringProps.hasFilterTargetAncestor,
-        }
-        : undefined;
-}
-/* c8 ignore end */
-function extractFilteringPropsInternal(rootLevelFilteringProps, parentNode) {
+function extractSearchPropsInternal(rootLevelSearchProps, parentNode) {
     if (!parentNode) {
-        return rootLevelFilteringProps ? { filteredNodePaths: rootLevelFilteringProps, hasFilterTargetAncestor: false } : undefined;
+        return rootLevelSearchProps ? { childrenTargetPaths: rootLevelSearchProps, hasSearchTargetAncestor: false } : undefined;
     }
-    const filteringProps = {
-        ...(parentNode.filtering?.filteredChildrenIdentifierPaths ? { filteredNodePaths: parentNode.filtering.filteredChildrenIdentifierPaths } : undefined),
-        hasFilterTargetAncestor: !!parentNode.filtering?.hasFilterTargetAncestor || !!parentNode.filtering?.isFilterTarget,
+    const searchProps = {
+        ...(parentNode.search?.childrenTargetPaths ? { childrenTargetPaths: parentNode.search.childrenTargetPaths } : undefined),
+        hasSearchTargetAncestor: !!parentNode.search?.hasSearchTargetAncestor || !!parentNode.search?.isSearchTarget,
     };
-    return filteringProps.filteredNodePaths || filteringProps.hasFilterTargetAncestor ? filteringProps : undefined;
+    return searchProps.childrenTargetPaths || searchProps.hasSearchTargetAncestor ? searchProps : undefined;
 }
 /**
- * Creates a set of utilities for making it easier to filter the given hierarchy
+ * Creates a set of utilities for making it easier to search the given hierarchy
  * level.
  *
  * @public
  */
-export function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNode) {
-    const filteringProps = extractFilteringPropsInternal(rootLevelFilteringProps, parentNode);
-    const hasFilter = !!filteringProps;
-    function saveFilteringPropsFromPathsIntoReducer(extractionProps) {
+export function createHierarchySearchHelper(rootLevelSearchProps, parentNode) {
+    const searchProps = extractSearchPropsInternal(rootLevelSearchProps, parentNode);
+    const hasSearch = !!searchProps;
+    function saveSearchPropsFromPathsIntoReducer(extractionProps) {
         // Passes down matching normalized paths to the reducer.
-        // It uses `nodeKey`, `pathMatcher` or `asyncPathMatcher` to check if `HierarchyNodeIdentifier` at the first position in filtering path matches the node
+        // It uses `nodeKey`, `pathMatcher` or `asyncPathMatcher` to check if `HierarchyNodeIdentifier` at the first position in search path matches the node
         // and if it does, the path is passed down to the reducer.
         // This function returns a promise only if asyncPathMatcher returns a promise.
-        if (!filteringProps?.filteredNodePaths) {
+        if (!searchProps?.childrenTargetPaths) {
             return;
         }
         const matchedPathPromises = new Array();
-        for (const filteredChildrenNodeIdentifierPath of filteringProps.filteredNodePaths) {
-            const normalizedPath = HierarchyFilteringPath.normalize(filteredChildrenNodeIdentifierPath);
+        for (const childrenTargetPaths of searchProps.childrenTargetPaths) {
+            const normalizedPath = HierarchySearchPath.normalize(childrenTargetPaths);
             /* c8 ignore next 3 */
             if (normalizedPath.path.length === 0) {
                 continue;
@@ -148,47 +133,47 @@ export function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNo
         return Promise.all(matchedPathPromises).then((matchedPath) => matchedPath.forEach((normalizedPath) => normalizedPath && extractionProps.pathsReducer.accept(normalizedPath)));
     }
     function createChildNodeProps(props) {
-        if (!hasFilter) {
+        if (!hasSearch) {
             return undefined;
         }
-        const reducer = new MatchingFilteringPathsReducer(filteringProps.hasFilterTargetAncestor);
+        const reducer = new MatchingSearchPathsReducer(searchProps.hasSearchTargetAncestor);
         if ("asyncPathMatcher" in props) {
-            const extractResult = saveFilteringPropsFromPathsIntoReducer({ pathsReducer: reducer, asyncPathMatcher: props.asyncPathMatcher });
+            const extractResult = saveSearchPropsFromPathsIntoReducer({ pathsReducer: reducer, asyncPathMatcher: props.asyncPathMatcher });
             if (extractResult instanceof Promise) {
                 return extractResult.then(() => reducer.getNodeProps(props.parentKeys));
             }
         }
         else {
-            saveFilteringPropsFromPathsIntoReducer({ ...props, pathsReducer: reducer });
+            saveSearchPropsFromPathsIntoReducer({ ...props, pathsReducer: reducer });
         }
         return reducer.getNodeProps(props.parentKeys);
     }
     return {
         /** Returns a flag indicating if the hierarchy level is filtered. */
-        hasFilter,
+        hasSearch,
         /**
          * 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
+         * that is a search target. That generally means that this and all downstream hierarchy
+         * levels should be displayed without search being applied to them, even if search paths
          * say otherwise.
          */
-        hasFilterTargetAncestor: filteringProps?.hasFilterTargetAncestor ?? false,
+        hasSearchTargetAncestor: searchProps?.hasSearchTargetAncestor ?? 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.
+         * hierarchy level. Returns `undefined` if search is not applied to this level.
          */
-        getChildNodeFilteringIdentifiers: () => {
-            if (!filteringProps?.filteredNodePaths) {
+        getChildNodeSearchIdentifiers: () => {
+            if (!searchProps?.childrenTargetPaths) {
                 return undefined;
             }
-            return filteringProps.filteredNodePaths
-                .map(HierarchyFilteringPath.normalize)
+            return searchProps.childrenTargetPaths
+                .map(HierarchySearchPath.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
+         * When a hierarchy node is created for a filtered hierarchy level, it needs some attributes (e.g. `search`
+         * and `autoExpand`) to be set based on the search paths and search options. This function calculates
          * these props for a child node based on its key or path matcher.
          *
          * When using `pathMatcher` or `asyncPathMatcher` prop, callers have more flexibility to decide whether the given `HierarchyNodeIdentifier` applies
@@ -196,7 +181,7 @@ export function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNo
          * `nodeKey` prop can be used to check the whole identifier.
          *
          * There are multiple overloads of `createChildNodeProps`: depending on props type it returns different values:
-         * - `parentKeys` is defined and `pathMatcher` or `nodeKey` is provided - returns undefined **or** `filtering` and `autoExpand` prop from `HierarchyNode`;
+         * - `parentKeys` is defined and `pathMatcher` or `nodeKey` is provided - returns undefined **or** `search` and `autoExpand` prop from `HierarchyNode`;
          * - `parentKeys` is undefined - does not return `HierarchyNode.autoExpand` option;
          * - props have `asyncPathMatcher` - returns either Promise or the regular return value based on whether or not `asyncPathMatcher` returns a promise.
          */
@@ -204,42 +189,42 @@ export function createHierarchyFilteringHelper(rootLevelFilteringProps, parentNo
     };
 }
 /**
- * Extracts information from filtering paths and later returns `filtering` and `autoExpand` values from `HierarchyNode`.
+ * Extracts information from search paths and later returns `search` and `autoExpand` values from `HierarchyNode`.
  *
  * Saved values can be applied to a single `HierarchyNode` - this means that a new reducer should be created every time these props are requested for a `HierarchyNode`.
  *
  * Extracts information using `accept` function:
- * - Determines if node is filter target, and if it is saves the options as `filterTargetOptions`
- * - Saves `HierarchyFilteringPathOptions` and `filteredChildrenIdentifierPaths`
+ * - Determines if node is search target, and if it is saves the options as `searchTargetOptions`
+ * - Saves `HierarchySearchPathOptions` and `childrenTargetPaths`
  */
-class MatchingFilteringPathsReducer {
-    _hasFilterTargetAncestor;
-    _filteredChildrenIdentifierPaths = new Array();
-    _isFilterTarget = false;
-    _filterTargetOptions = undefined;
+class MatchingSearchPathsReducer {
+    _hasSearchTargetAncestor;
+    _childrenTargetPaths = new Array();
+    _isSearchTarget = false;
+    _searchTargetOptions = undefined;
     _revealOption = false;
-    constructor(_hasFilterTargetAncestor) {
-        this._hasFilterTargetAncestor = _hasFilterTargetAncestor;
+    constructor(_hasSearchTargetAncestor) {
+        this._hasSearchTargetAncestor = _hasSearchTargetAncestor;
     }
     accept(normalizedPath) {
         const { path, options } = normalizedPath;
         if (path.length === 1) {
-            this._isFilterTarget = true;
-            this._filterTargetOptions = HierarchyFilteringPath.mergeOptions(this._filterTargetOptions, options);
+            this._isSearchTarget = true;
+            this._searchTargetOptions = HierarchySearchPath.mergeOptions(this._searchTargetOptions, options);
         }
         else if (path.length > 1) {
-            this._filteredChildrenIdentifierPaths.push({ path: path.slice(1), options });
-            this._revealOption = HierarchyFilteringPathOptions.mergeRevealOptions(options?.reveal, this._revealOption);
+            this._childrenTargetPaths.push({ path: path.slice(1), options });
+            this._revealOption = HierarchySearchPathOptions.mergeRevealOptions(options?.reveal, this._revealOption);
         }
     }
     getNodeProps(parentKeys) {
         return {
-            ...(this._hasFilterTargetAncestor || this._isFilterTarget || this._filteredChildrenIdentifierPaths.length > 0
+            ...(this._hasSearchTargetAncestor || this._isSearchTarget || this._childrenTargetPaths.length > 0
                 ? {
-                    filtering: {
-                        ...(this._hasFilterTargetAncestor ? { hasFilterTargetAncestor: true } : undefined),
-                        ...(this._isFilterTarget ? { isFilterTarget: true, filterTargetOptions: this._filterTargetOptions } : undefined),
-                        ...(this._filteredChildrenIdentifierPaths.length > 0 ? { filteredChildrenIdentifierPaths: this._filteredChildrenIdentifierPaths } : undefined),
+                    search: {
+                        ...(this._hasSearchTargetAncestor ? { hasSearchTargetAncestor: true } : undefined),
+                        ...(this._isSearchTarget ? { isSearchTarget: true, searchTargetOptions: this._searchTargetOptions } : undefined),
+                        ...(this._childrenTargetPaths.length > 0 ? { childrenTargetPaths: this._childrenTargetPaths } : undefined),
                     },
                 }
                 : undefined),
@@ -249,7 +234,7 @@ class MatchingFilteringPathsReducer {
                     nodePositionInHierarchy: parentKeys.length,
                     nodePositionInPath: parentKeys.filter((key) => !HierarchyNodeKey.isGrouping(key)).length,
                 }) ||
-                    !!this._filterTargetOptions?.autoExpand)
+                    !!this._searchTargetOptions?.autoExpand)
                 ? { autoExpand: true }
                 : undefined),
         };
@@ -268,4 +253,4 @@ export function shouldAutoExpandBasedOnReveal({ reveal, nodePositionInPath, node
     }
     return nodePositionInPath < reveal.depthInPath;
 }
-//# sourceMappingURL=HierarchyFiltering.js.map
+//# sourceMappingURL=HierarchySearch.js.map

package/lib/esm/hierarchies/HierarchySearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchySearch.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchySearch.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAGhG,OAAO,EAAE,uBAAuB,EAAgC,MAAM,8BAA8B,CAAC;AACrG,OAAO,EAAkB,gBAAgB,EAAoB,MAAM,uBAAuB,CAAC;AAsE3F,IAAU,0BAA0B,CAmCnC;AAnCD,WAAU,0BAA0B;IAClC,SAAgB,kBAAkB,CAChC,GAAyC,EACzC,GAAyC;QAEzC,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,MAAM,QAAQ,GAAG,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAC/E,MAAM,QAAQ,GAAG,aAAa,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAC/E,MAAM,qBAAqB,GAAG,aAAa,IAAI,GAAG,CAAC;QACnD,MAAM,qBAAqB,GAAG,aAAa,IAAI,GAAG,CAAC;QAEnD,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;IA1Be,6CAAkB,qBA0BjC,CAAA;IAED,SAAgB,qBAAqB,CACnC,GAA6C,EAC7C,GAA6C;QAE7C,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACvC,CAAC;IALe,gDAAqB,wBAKpC,CAAA;AACH,CAAC,EAnCS,0BAA0B,KAA1B,0BAA0B,QAmCnC;AAOD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,mBAAmB,CAsCnC;AAtCD,WAAiB,mBAAmB;IAClC;;;OAGG;IACH,SAAgB,SAAS,CAAC,MAA2B;QACnD,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,6BAAS,YAKxB,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,YAAY,CAC1B,GAA2C,EAC3C,GAA2C;QAE3C,MAAM,MAAM,GAAG,0BAA0B,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACvF,MAAM,UAAU,GAAG,0BAA0B,CAAC,qBAAqB,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QACtG,OAAO,MAAM,IAAI,UAAU;YACzB,CAAC,CAAC;gBACE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;gBAClD,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;aAC3D;YACH,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAZe,gCAAY,eAY3B,CAAA;AACH,CAAC,EAtCgB,mBAAmB,KAAnB,mBAAmB,QAsCnC;AAED,+DAA+D;AAC/D,qBAAqB;AAErB,SAAS,0BAA0B,CACjC,oBAAuD,EACvD,UAAgE;IAOhE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,oBAAoB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1H,CAAC;IACD,MAAM,WAAW,GAGb;QACF,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,UAAU,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACxH,uBAAuB,EAAE,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,uBAAuB,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,cAAc;KAC7G,CAAC;IACF,OAAO,WAAW,CAAC,mBAAmB,IAAI,WAAW,CAAC,uBAAuB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1G,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,oBAAuD,EACvD,UAAgE;IAEhE,MAAM,WAAW,GAAG,0BAA0B,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;IACjF,MAAM,SAAS,GAAG,CAAC,CAAC,WAAW,CAAC;IAgBhC,SAAS,mCAAmC,CAC1C,eAQC;QAED,wDAAwD;QACxD,qJAAqJ;QACrJ,0DAA0D;QAC1D,8EAA8E;QAC9E,IAAI,CAAC,WAAW,EAAE,mBAAmB,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QACD,MAAM,mBAAmB,GAAG,IAAI,KAAK,EAA6C,CAAC;QACnF,KAAK,MAAM,mBAAmB,IAAI,WAAW,CAAC,mBAAmB,EAAE,CAAC;YAClE,MAAM,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YAC1E,sBAAsB;YACtB,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,SAAS;YACX,CAAC;YACD,IAAI,SAAS,IAAI,eAAe,EAAE,CAAC;gBACjC,IACE,CAAC,gBAAgB,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,uBAAuB,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;oBACvI,CAAC,gBAAgB,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC;wBACpD,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAC/G,CAAC;oBACD,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;gBACtD,CAAC;gBACD,SAAS;YACX,CAAC;YAED,MAAM,sBAAsB,GAC1B,aAAa,IAAI,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACpJ,IAAI,sBAAsB,YAAY,OAAO,EAAE,CAAC;gBAC9C,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;gBAC3G,SAAS;YACX,CAAC;YACD,IAAI,sBAAsB,EAAE,CAAC;gBAC3B,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO;QACT,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAC3D,WAAW,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,IAAI,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAC/G,CAAC;IACJ,CAAC;IA0BD,SAAS,oBAAoB,CAC3B,KAUC;QAMD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,0BAA0B,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;QACpF,IAAI,kBAAkB,IAAI,KAAK,EAAE,CAAC;YAChC,MAAM,aAAa,GAAG,mCAAmC,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAC/H,IAAI,aAAa,YAAY,OAAO,EAAE,CAAC;gBACrC,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;aAAM,CAAC;YACN,mCAAmC,CAAC,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;IACD,OAAO;QACL,oEAAoE;QACpE,SAAS;QACT;;;;;WAKG;QACH,uBAAuB,EAAE,WAAW,EAAE,uBAAuB,IAAI,KAAK;QACtE;;;WAGG;QACH,6BAA6B,EAAE,GAAG,EAAE;YAClC,IAAI,CAAC,WAAW,EAAE,mBAAmB,EAAE,CAAC;gBACtC,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,WAAW,CAAC,mBAAmB;iBACnC,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC;iBAClC,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;QACD;;;;;;;;;;;;;WAaG;QACH,oBAAoB;KACrB,CAAC;AACJ,CAAC;AAID;;;;;;;;GAQG;AACH,MAAM,0BAA0B;IAMH;IALnB,oBAAoB,GAAG,IAAI,KAAK,EAAwB,CAAC;IACzD,eAAe,GAAG,KAAK,CAAC;IACxB,oBAAoB,GAA2C,SAAS,CAAC;IACzE,aAAa,GAAyC,KAAK,CAAC;IAEpE,YAA2B,wBAAiC;QAAjC,6BAAwB,GAAxB,wBAAwB,CAAS;IAAG,CAAC;IAEzD,MAAM,CAAC,cAAoC;QAChD,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,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACnG,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YACjE,IAAI,CAAC,aAAa,GAAG,0BAA0B,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1G,CAAC;IACH,CAAC;IAEM,YAAY,CACjB,UAAc;QAEd,OAAO;YACL,GAAG,CAAC,IAAI,CAAC,wBAAwB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC;gBAC/F,CAAC,CAAC;oBACE,MAAM,EAAE;wBACN,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,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;qBAC3G;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,UAAU;gBACd,CAAC,6BAA6B,CAAC;oBAC7B,MAAM,EAAE,IAAI,CAAC,aAAa;oBAC1B,uBAAuB,EAAE,UAAU,CAAC,MAAM;oBAC1C,kBAAkB,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;iBACzF,CAAC;oBACA,CAAC,CAAC,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC;gBACxC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE;gBACtB,CAAC,CAAC,SAAS,CAAC;SACf,CAAC;IACJ,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,UAAU,6BAA6B,CAAC,EAC5C,MAAM,EACN,kBAAkB,EAClB,uBAAuB,GAKxB;IACC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,kBAAkB,IAAI,MAAM,EAAE,CAAC;QACjC,OAAO,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC;IAC3D,CAAC;IACD,OAAO,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC;AACjD,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { NonGroupingHierarchyNode } from \"./HierarchyNode.js\";\nimport { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from \"./HierarchyNodeIdentifier.js\";\nimport { GenericNodeKey, HierarchyNodeKey, InstancesNodeKey } from \"./HierarchyNodeKey.js\";\n\n/** @public */\nexport interface SearchPathRevealDepthInPath {\n  /**\n   * Index of the node in search path should be revealed in hierarchy by auto-expanding its ancestors.\n   *\n   * Use when you want to expand up to specific instance node and don't care about grouping nodes.\n   *\n   * **Use case example:**\n   *\n   * All nodes up to `Element1` should be expanded in the following hierarchy:\n   * - Node1\n   *   - GroupingNode1\n   *     - GroupingNode2\n   *       - Element1\n   *       - Element2\n   *\n   * Provide `{ path: [Node1, Element1], reveal: { depthInPath: 1 } }`\n   *\n   * **NOTE**: All nodes that are up to `depthInPath` will be expanded **except** search targets.\n   */\n  depthInPath: number;\n}\n\n/** @public */\nexport interface SearchPathRevealDepthInHierarchy {\n  /**\n   * Considering the list of nodes from root to the target node, this is an index in that list, identifying the node that should be revealed in hierarchy by auto-expanding its ancestors.\n   *\n   * This should take into account the number of grouping nodes in hierarchy.\n   *\n   * **Use case example:**\n   *\n   * Only `Node1` and `GroupingNode1` should have `autoExpand` flag in the following hierarchy:\n   * - Node1\n   *   - GroupingNode1\n   *     - GroupingNode2\n   *       - Element1\n   *       - Element2\n   *\n   * Provide `{ path: [Node1, Element1], reveal: { depthInHierarchy: 2 } }`\n   *\n   * To get the correct depth use `HierarchyNode.parentKeys.length`.\n   *\n   * **NOTE**: All nodes that are up to `depthInHierarchy` will be expanded **except** search targets.\n   */\n  depthInHierarchy: number;\n}\n\n/** @public */\nexport interface HierarchySearchPathOptions {\n  /**\n   * This option specifies the way `autoExpand` flag should be assigned to nodes in the searched hierarchy.\n   * - If it's `false` or `undefined`, nodes have no 'autoExpand' flag.\n   * - If it's `true`, then all nodes up to the search target will have `autoExpand` flag.\n   * - If it's an instance of `SearchPathRevealDepthInPath`, then all nodes up to `depthInPath` will have `autoExpand` flag.\n   * - If it's an instance of `SearchPathRevealDepthInHierarchy`, then all nodes up to `depthInHierarchy` will have `autoExpand` flag.\n   */\n  reveal?: boolean | SearchPathRevealDepthInHierarchy | SearchPathRevealDepthInPath;\n  /**\n   * This option specifies whether or not search target should be expanded.\n   * - If it's `false` or `undefined`, search target won't have 'autoExpand' flag.\n   * - If it's `true`, search target will have `autoExpand` flag.\n   *\n   * **NOTE**: this attribute does not set `autoExpand` flag on nodes up to the search target. For that use `reveal`.\n   */\n  autoExpand?: boolean;\n}\n\nnamespace HierarchySearchPathOptions {\n  export function mergeRevealOptions(\n    lhs: HierarchySearchPathOptions[\"reveal\"],\n    rhs: HierarchySearchPathOptions[\"reveal\"],\n  ): HierarchySearchPathOptions[\"reveal\"] {\n    if (rhs === true || lhs === true) {\n      return true;\n    }\n    if (!rhs || !lhs) {\n      return !!rhs ? rhs : lhs;\n    }\n\n    const lhsDepth = \"depthInPath\" in lhs ? lhs.depthInPath : lhs.depthInHierarchy;\n    const rhsDepth = \"depthInPath\" in rhs ? rhs.depthInPath : rhs.depthInHierarchy;\n    const isLhsDepthBasedOnPath = \"depthInPath\" in lhs;\n    const isRhsDepthBasedOnPath = \"depthInPath\" in rhs;\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  export function mergeAutoExpandOption(\n    lhs: HierarchySearchPathOptions[\"autoExpand\"],\n    rhs: HierarchySearchPathOptions[\"autoExpand\"],\n  ): HierarchySearchPathOptions[\"autoExpand\"] {\n    return lhs || rhs ? true : undefined;\n  }\n}\n\n/**\n * A path of hierarchy node identifiers for search the hierarchy with additional options.\n * @public\n */\nexport type HierarchySearchPath = HierarchyNodeIdentifiersPath | { path: HierarchyNodeIdentifiersPath; options?: HierarchySearchPathOptions };\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchySearchPath {\n  /**\n   * Normalizes the hierarchy search path to the object form.\n   * @public\n   */\n  export function normalize(source: HierarchySearchPath): Exclude<HierarchySearchPath, HierarchyNodeIdentifiersPath> {\n    if (Array.isArray(source)) {\n      return { path: source };\n    }\n    return source;\n  }\n\n  /**\n   * Merges two given `HierarchySearchPathOptions` objects.\n   *\n   * For the `reveal` attribute, the merge chooses to `reveal` 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 `depthInHierarchy` set, return the other one,\n   *    - else return the one with greater `depthInPath` or `depthInHierarchy`.\n   *\n   * @public\n   */\n  export function mergeOptions(\n    lhs: HierarchySearchPathOptions | undefined,\n    rhs: HierarchySearchPathOptions | undefined,\n  ): HierarchySearchPathOptions | undefined {\n    const reveal = HierarchySearchPathOptions.mergeRevealOptions(lhs?.reveal, rhs?.reveal);\n    const autoExpand = HierarchySearchPathOptions.mergeAutoExpandOption(lhs?.autoExpand, rhs?.autoExpand);\n    return reveal || autoExpand\n      ? {\n          ...(reveal !== undefined ? { reveal } : undefined),\n          ...(autoExpand !== undefined ? { autoExpand } : undefined),\n        }\n      : undefined;\n  }\n}\n\n// TODO: remove c8 ignore start and add tests to cover the gaps\n/* c8 ignore start */\n\nfunction extractSearchPropsInternal(\n  rootLevelSearchProps: HierarchySearchPath[] | undefined,\n  parentNode: Pick<NonGroupingHierarchyNode, \"search\"> | undefined,\n):\n  | {\n      childrenTargetPaths?: HierarchySearchPath[];\n      hasSearchTargetAncestor: boolean;\n    }\n  | undefined {\n  if (!parentNode) {\n    return rootLevelSearchProps ? { childrenTargetPaths: rootLevelSearchProps, hasSearchTargetAncestor: false } : undefined;\n  }\n  const searchProps: {\n    childrenTargetPaths?: HierarchySearchPath[];\n    hasSearchTargetAncestor: boolean;\n  } = {\n    ...(parentNode.search?.childrenTargetPaths ? { childrenTargetPaths: parentNode.search.childrenTargetPaths } : undefined),\n    hasSearchTargetAncestor: !!parentNode.search?.hasSearchTargetAncestor || !!parentNode.search?.isSearchTarget,\n  };\n  return searchProps.childrenTargetPaths || searchProps.hasSearchTargetAncestor ? searchProps : undefined;\n}\n\n/**\n * Creates a set of utilities for making it easier to search the given hierarchy\n * level.\n *\n * @public\n */\nexport function createHierarchySearchHelper(\n  rootLevelSearchProps: HierarchySearchPath[] | undefined,\n  parentNode: Pick<NonGroupingHierarchyNode, \"search\"> | undefined,\n) {\n  const searchProps = extractSearchPropsInternal(rootLevelSearchProps, parentNode);\n  const hasSearch = !!searchProps;\n\n  function saveSearchPropsFromPathsIntoReducer(\n    extractionProps: {\n      pathsReducer: MatchingSearchPathsReducer;\n    } & (\n      | {\n          nodeKey: InstancesNodeKey | GenericNodeKey;\n        }\n      | { pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean }\n    ),\n  ): void;\n  function saveSearchPropsFromPathsIntoReducer(extractionProps: {\n    pathsReducer: MatchingSearchPathsReducer;\n    asyncPathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n  }): void | Promise<void>;\n  function saveSearchPropsFromPathsIntoReducer(\n    extractionProps: {\n      pathsReducer: MatchingSearchPathsReducer;\n    } & (\n      | {\n          nodeKey: InstancesNodeKey | GenericNodeKey;\n        }\n      | { pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean }\n      | { asyncPathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean> }\n    ),\n  ): void | Promise<void> {\n    // Passes down matching normalized paths to the reducer.\n    // It uses `nodeKey`, `pathMatcher` or `asyncPathMatcher` to check if `HierarchyNodeIdentifier` at the first position in search path matches the node\n    // and if it does, the path is passed down to the reducer.\n    // This function returns a promise only if asyncPathMatcher returns a promise.\n    if (!searchProps?.childrenTargetPaths) {\n      return;\n    }\n    const matchedPathPromises = new Array<Promise<NormalizedSearchPath | undefined>>();\n    for (const childrenTargetPaths of searchProps.childrenTargetPaths) {\n      const normalizedPath = HierarchySearchPath.normalize(childrenTargetPaths);\n      /* c8 ignore next 3 */\n      if (normalizedPath.path.length === 0) {\n        continue;\n      }\n      if (\"nodeKey\" in extractionProps) {\n        if (\n          (HierarchyNodeKey.isGeneric(extractionProps.nodeKey) && HierarchyNodeIdentifier.equal(normalizedPath.path[0], extractionProps.nodeKey)) ||\n          (HierarchyNodeKey.isInstances(extractionProps.nodeKey) &&\n            extractionProps.nodeKey.instanceKeys.some((ik) => HierarchyNodeIdentifier.equal(normalizedPath.path[0], ik)))\n        ) {\n          extractionProps.pathsReducer.accept(normalizedPath);\n        }\n        continue;\n      }\n\n      const matchesPossiblyPromise =\n        \"pathMatcher\" in extractionProps ? extractionProps.pathMatcher(normalizedPath.path[0]) : extractionProps.asyncPathMatcher(normalizedPath.path[0]);\n      if (matchesPossiblyPromise instanceof Promise) {\n        matchedPathPromises.push(matchesPossiblyPromise.then((matches) => (matches ? normalizedPath : undefined)));\n        continue;\n      }\n      if (matchesPossiblyPromise) {\n        extractionProps.pathsReducer.accept(normalizedPath);\n      }\n    }\n    if (matchedPathPromises.length === 0) {\n      return;\n    }\n    return Promise.all(matchedPathPromises).then((matchedPath) =>\n      matchedPath.forEach((normalizedPath) => normalizedPath && extractionProps.pathsReducer.accept(normalizedPath)),\n    );\n  }\n\n  function createChildNodeProps(props: {\n    parentKeys?: undefined;\n    nodeKey: InstancesNodeKey | GenericNodeKey;\n  }): Pick<NonGroupingHierarchyNode, \"search\"> | undefined;\n  function createChildNodeProps(props: {\n    parentKeys?: undefined;\n    pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean;\n  }): Pick<NonGroupingHierarchyNode, \"search\"> | undefined;\n  function createChildNodeProps(props: {\n    parentKeys?: undefined;\n    asyncPathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n  }): Promise<Pick<NonGroupingHierarchyNode, \"search\"> | undefined> | Pick<NonGroupingHierarchyNode, \"search\"> | undefined;\n  function createChildNodeProps(props: {\n    parentKeys: HierarchyNodeKey[];\n    nodeKey: InstancesNodeKey | GenericNodeKey;\n  }): Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\"> | undefined;\n  function createChildNodeProps(props: {\n    parentKeys: HierarchyNodeKey[];\n    pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean;\n  }): Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\"> | undefined;\n  function createChildNodeProps(props: {\n    parentKeys: HierarchyNodeKey[];\n    asyncPathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n  }): Promise<Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\"> | undefined> | Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\"> | undefined;\n  function createChildNodeProps(\n    props: { parentKeys?: HierarchyNodeKey[] } & (\n      | {\n          asyncPathMatcher: (identifier: HierarchyNodeIdentifier) => boolean | Promise<boolean>;\n        }\n      | {\n          pathMatcher: (identifier: HierarchyNodeIdentifier) => boolean;\n        }\n      | {\n          nodeKey: InstancesNodeKey | GenericNodeKey;\n        }\n    ),\n  ):\n    | Promise<Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\"> | Pick<NonGroupingHierarchyNode, \"search\"> | undefined>\n    | Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\">\n    | Pick<NonGroupingHierarchyNode, \"search\">\n    | undefined {\n    if (!hasSearch) {\n      return undefined;\n    }\n    const reducer = new MatchingSearchPathsReducer(searchProps.hasSearchTargetAncestor);\n    if (\"asyncPathMatcher\" in props) {\n      const extractResult = saveSearchPropsFromPathsIntoReducer({ pathsReducer: reducer, asyncPathMatcher: props.asyncPathMatcher });\n      if (extractResult instanceof Promise) {\n        return extractResult.then(() => reducer.getNodeProps(props.parentKeys));\n      }\n    } else {\n      saveSearchPropsFromPathsIntoReducer({ ...props, pathsReducer: reducer });\n    }\n    return reducer.getNodeProps(props.parentKeys);\n  }\n  return {\n    /** Returns a flag indicating if the hierarchy level is filtered. */\n    hasSearch,\n    /**\n     * Returns a flag indicating whether this hierarchy level has an ancestor node\n     * that is a search target. That generally means that this and all downstream hierarchy\n     * levels should be displayed without search being applied to them, even if search paths\n     * say otherwise.\n     */\n    hasSearchTargetAncestor: searchProps?.hasSearchTargetAncestor ?? false,\n    /**\n     * Returns a list of hierarchy node identifiers that apply specifically for this\n     * hierarchy level. Returns `undefined` if search is not applied to this level.\n     */\n    getChildNodeSearchIdentifiers: () => {\n      if (!searchProps?.childrenTargetPaths) {\n        return undefined;\n      }\n      return searchProps.childrenTargetPaths\n        .map(HierarchySearchPath.normalize)\n        .filter(({ path }) => path.length > 0)\n        .map(({ path }) => path[0]);\n    },\n    /**\n     * When a hierarchy node is created for a filtered hierarchy level, it needs some attributes (e.g. `search`\n     * and `autoExpand`) to be set based on the search paths and search options. This function calculates\n     * these props for a child node based on its key or path matcher.\n     *\n     * When using `pathMatcher` or `asyncPathMatcher` 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     * There are multiple overloads of `createChildNodeProps`: depending on props type it returns different values:\n     * - `parentKeys` is defined and `pathMatcher` or `nodeKey` is provided - returns undefined **or** `search` and `autoExpand` prop from `HierarchyNode`;\n     * - `parentKeys` is undefined - does not return `HierarchyNode.autoExpand` option;\n     * - props have `asyncPathMatcher` - returns either Promise or the regular return value based on whether or not `asyncPathMatcher` returns a promise.\n     */\n    createChildNodeProps,\n  };\n}\n\ntype NormalizedSearchPath = ReturnType<(typeof HierarchySearchPath)[\"normalize\"]>;\n\n/**\n * Extracts information from search paths and later returns `search` and `autoExpand` values from `HierarchyNode`.\n *\n * Saved values can be applied to a single `HierarchyNode` - this means that a new reducer should be created every time these props are requested for a `HierarchyNode`.\n *\n * Extracts information using `accept` function:\n * - Determines if node is search target, and if it is saves the options as `searchTargetOptions`\n * - Saves `HierarchySearchPathOptions` and `childrenTargetPaths`\n */\nclass MatchingSearchPathsReducer {\n  private _childrenTargetPaths = new Array<NormalizedSearchPath>();\n  private _isSearchTarget = false;\n  private _searchTargetOptions: HierarchySearchPathOptions | undefined = undefined;\n  private _revealOption: HierarchySearchPathOptions[\"reveal\"] = false;\n\n  public constructor(private _hasSearchTargetAncestor: boolean) {}\n\n  public accept(normalizedPath: NormalizedSearchPath): void {\n    const { path, options } = normalizedPath;\n    if (path.length === 1) {\n      this._isSearchTarget = true;\n      this._searchTargetOptions = HierarchySearchPath.mergeOptions(this._searchTargetOptions, options);\n    } else if (path.length > 1) {\n      this._childrenTargetPaths.push({ path: path.slice(1), options });\n      this._revealOption = HierarchySearchPathOptions.mergeRevealOptions(options?.reveal, this._revealOption);\n    }\n  }\n\n  public getNodeProps<T extends HierarchyNodeKey[] | undefined = undefined>(\n    parentKeys?: T,\n  ): T extends undefined ? Pick<NonGroupingHierarchyNode, \"search\"> : Pick<NonGroupingHierarchyNode, \"search\" | \"autoExpand\"> {\n    return {\n      ...(this._hasSearchTargetAncestor || this._isSearchTarget || this._childrenTargetPaths.length > 0\n        ? {\n            search: {\n              ...(this._hasSearchTargetAncestor ? { hasSearchTargetAncestor: true } : undefined),\n              ...(this._isSearchTarget ? { isSearchTarget: true, searchTargetOptions: this._searchTargetOptions } : undefined),\n              ...(this._childrenTargetPaths.length > 0 ? { childrenTargetPaths: this._childrenTargetPaths } : undefined),\n            },\n          }\n        : undefined),\n      ...(parentKeys &&\n      (shouldAutoExpandBasedOnReveal({\n        reveal: this._revealOption,\n        nodePositionInHierarchy: parentKeys.length,\n        nodePositionInPath: parentKeys.filter((key) => !HierarchyNodeKey.isGrouping(key)).length,\n      }) ||\n        !!this._searchTargetOptions?.autoExpand)\n        ? { autoExpand: true }\n        : undefined),\n    };\n  }\n}\n\n/** @internal */\nexport function shouldAutoExpandBasedOnReveal({\n  reveal,\n  nodePositionInPath,\n  nodePositionInHierarchy,\n}: {\n  reveal: HierarchySearchPathOptions[\"reveal\"];\n  nodePositionInPath: number;\n  nodePositionInHierarchy: number;\n}): boolean {\n  if (!reveal) {\n    return false;\n  }\n  if (reveal === true) {\n    return true;\n  }\n  if (\"depthInHierarchy\" in reveal) {\n    return nodePositionInHierarchy < reveal.depthInHierarchy;\n  }\n  return nodePositionInPath < reveal.depthInPath;\n}\n"]}

package/lib/esm/hierarchies/imodel/HierarchyCache.js

@@ -14,11 +14,11 @@ export class HierarchyCache {
     }
     createCacheKeys(props) {
         function createVariationKey() {
-            const { instanceFilter, hierarchyLevelSizeLimit, filteredInstanceKeys } = props;
-            if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined && filteredInstanceKeys === undefined) {
+            const { instanceFilter, hierarchyLevelSizeLimit, targetInstanceKeys } = props;
+            if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined && targetInstanceKeys === undefined) {
                 return undefined;
             }
-            return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit, filteredInstanceKeys });
+            return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit, targetInstanceKeys });
         }
         if (!props.parentNode) {
             return { primaryKey: [], variationKey: createVariationKey() };

package/lib/esm/hierarchies/imodel/HierarchyCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"HierarchyCache.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/HierarchyCache.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAY,aAAa,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAe1D,gBAAgB;AAChB,MAAM,OAAO,cAAc;IACjB,IAAI,CAA4D;IAChE,MAAM,CAAiC;IAE/C,YAAmB,KAAqC;QACtD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAA6C,KAAK,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAClH,CAAC;IAEO,eAAe,CACrB,KAGC;QAED,SAAS,kBAAkB;YACzB,MAAM,EAAE,cAAc,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;YAChF,IAAI,cAAc,KAAK,SAAS,IAAI,uBAAuB,KAAK,SAAS,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBAChH,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAAE,CAAC;QAChE,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC;QAE/C,OAAO;YACL,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YACjD,YAAY,EAAE,kBAAkB,EAAE;SACnC,CAAC;IACJ,CAAC;IAEO,iBAAiB,CAAC,UAA8B,EAAE,YAAqB;QAC7E,MAAM,WAAW,GAAG,CAAC,MAAe,EAAE,EAAE;YACtC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,CAAC,KAAK,IAAI,MAAM,EAAE,CAAC;gBACrB,KAAK,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC,EAAE,CAAC;gBACzF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO;gBACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC;gBAC3D,GAAG,EAAE,CAAC,KAAQ,EAAE,EAAE;oBAChB,WAAW,CAAC,IAAI,CAAE,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;gBACzD,CAAC;aACF,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;YACtC,GAAG,EAAE,CAAC,KAAQ,EAAE,EAAE;gBAChB,WAAW,CAAC,IAAI,CAAE,CAAC,OAAO,GAAG,KAAK,CAAC;YACrC,CAAC;SACF,CAAC;IACJ,CAAC;IAEM,GAAG,CAAC,YAAoC,EAAE,KAAQ;QACvD,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAEM,GAAG,CAAC,YAAoC;QAC7C,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAAG,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;CACF;AAED,SAAS,wBAAwB,CAAC,GAAuB,EAAE,GAAuB;IAChF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IACjC,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACpC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { LRUCache, LRUDictionary, LRUMap } from \"@itwin/core-bentley\";\nimport { InstanceKey } from \"@itwin/presentation-shared\";\nimport { HierarchyNodeKey } from \"../HierarchyNodeKey.js\";\nimport { GetHierarchyNodesProps } from \"../HierarchyProvider.js\";\n\ninterface HierarchyCacheEntry<T> {\n  /** Stores observables for the default case - no instance filter or custom limit for the hierarchy level. */\n  primary: T | undefined;\n  /** Stores a limited number of variations with custom instance filter and/or custom limit for the hierarchy level. */\n  variations: LRUCache<string, T>;\n}\n\ninterface ChildNodeObservablesCacheProps {\n  size: number;\n  variationsCount?: number;\n}\n\n/** @internal */\nexport class HierarchyCache<T> {\n  private _map: LRUDictionary<HierarchyNodeKey[], HierarchyCacheEntry<T>>;\n  private _props: ChildNodeObservablesCacheProps;\n\n  public constructor(props: ChildNodeObservablesCacheProps) {\n    this._props = props;\n    this._map = new LRUDictionary<HierarchyNodeKey[], HierarchyCacheEntry<T>>(props.size, compareHierarchyNodeKeys);\n  }\n\n  private createCacheKeys(\n    props: Omit<GetHierarchyNodesProps, \"parentNode\"> & {\n      parentNode: { key: HierarchyNodeKey; parentKeys: HierarchyNodeKey[] } | undefined;\n      filteredInstanceKeys?: InstanceKey[];\n    },\n  ) {\n    function createVariationKey() {\n      const { instanceFilter, hierarchyLevelSizeLimit, filteredInstanceKeys } = props;\n      if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined && filteredInstanceKeys === undefined) {\n        return undefined;\n      }\n      return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit, filteredInstanceKeys });\n    }\n\n    if (!props.parentNode) {\n      return { primaryKey: [], variationKey: createVariationKey() };\n    }\n\n    const parentKeys = props.parentNode.parentKeys;\n\n    return {\n      primaryKey: [...parentKeys, props.parentNode.key],\n      variationKey: createVariationKey(),\n    };\n  }\n\n  private getCacheAccessors(primaryKey: HierarchyNodeKey[], variationKey?: string) {\n    const getMapEntry = (create: boolean) => {\n      let entry = this._map.get(primaryKey);\n      if (!entry && create) {\n        entry = { primary: undefined, variations: new LRUMap(this._props.variationsCount ?? 1) };\n        this._map.set(primaryKey, entry);\n      }\n      return entry;\n    };\n    if (variationKey) {\n      return {\n        get: () => getMapEntry(false)?.variations.get(variationKey),\n        set: (value: T) => {\n          getMapEntry(true)!.variations.set(variationKey, value);\n        },\n      };\n    }\n    return {\n      get: () => getMapEntry(false)?.primary,\n      set: (value: T) => {\n        getMapEntry(true)!.primary = value;\n      },\n    };\n  }\n\n  public set(requestProps: GetHierarchyNodesProps, value: T) {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    this.getCacheAccessors(primaryKey, variationKey).set(value);\n  }\n\n  public get(requestProps: GetHierarchyNodesProps): T | undefined {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    return this.getCacheAccessors(primaryKey, variationKey).get();\n  }\n\n  public clear() {\n    this._map.clear();\n  }\n}\n\nfunction compareHierarchyNodeKeys(lhs: HierarchyNodeKey[], rhs: HierarchyNodeKey[]) {\n  if (lhs.length !== rhs.length) {\n    return lhs.length - rhs.length;\n  }\n  for (let i = 0; i < lhs.length; ++i) {\n    const keysCompareResult = HierarchyNodeKey.compare(lhs[i], rhs[i]);\n    if (keysCompareResult !== 0) {\n      return keysCompareResult;\n    }\n  }\n  return 0;\n}\n"]}
+{"version":3,"file":"HierarchyCache.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/HierarchyCache.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAY,aAAa,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAe1D,gBAAgB;AAChB,MAAM,OAAO,cAAc;IACjB,IAAI,CAA4D;IAChE,MAAM,CAAiC;IAE/C,YAAmB,KAAqC;QACtD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAA6C,KAAK,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAClH,CAAC;IAEO,eAAe,CACrB,KAGC;QAED,SAAS,kBAAkB;YACzB,MAAM,EAAE,cAAc,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAC;YAC9E,IAAI,cAAc,KAAK,SAAS,IAAI,uBAAuB,KAAK,SAAS,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBAC9G,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,CAAC,CAAC;QACzF,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAAE,CAAC;QAChE,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC;QAE/C,OAAO;YACL,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YACjD,YAAY,EAAE,kBAAkB,EAAE;SACnC,CAAC;IACJ,CAAC;IAEO,iBAAiB,CAAC,UAA8B,EAAE,YAAqB;QAC7E,MAAM,WAAW,GAAG,CAAC,MAAe,EAAE,EAAE;YACtC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,CAAC,KAAK,IAAI,MAAM,EAAE,CAAC;gBACrB,KAAK,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC,EAAE,CAAC;gBACzF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO;gBACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC;gBAC3D,GAAG,EAAE,CAAC,KAAQ,EAAE,EAAE;oBAChB,WAAW,CAAC,IAAI,CAAE,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;gBACzD,CAAC;aACF,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;YACtC,GAAG,EAAE,CAAC,KAAQ,EAAE,EAAE;gBAChB,WAAW,CAAC,IAAI,CAAE,CAAC,OAAO,GAAG,KAAK,CAAC;YACrC,CAAC;SACF,CAAC;IACJ,CAAC;IAEM,GAAG,CAAC,YAAoC,EAAE,KAAQ;QACvD,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAEM,GAAG,CAAC,YAAoC;QAC7C,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAAG,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;CACF;AAED,SAAS,wBAAwB,CAAC,GAAuB,EAAE,GAAuB;IAChF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IACjC,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACpC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { LRUCache, LRUDictionary, LRUMap } from \"@itwin/core-bentley\";\nimport { InstanceKey } from \"@itwin/presentation-shared\";\nimport { HierarchyNodeKey } from \"../HierarchyNodeKey.js\";\nimport { GetHierarchyNodesProps } from \"../HierarchyProvider.js\";\n\ninterface HierarchyCacheEntry<T> {\n  /** Stores observables for the default case - no instance filter or custom limit for the hierarchy level. */\n  primary: T | undefined;\n  /** Stores a limited number of variations with custom instance filter and/or custom limit for the hierarchy level. */\n  variations: LRUCache<string, T>;\n}\n\ninterface ChildNodeObservablesCacheProps {\n  size: number;\n  variationsCount?: number;\n}\n\n/** @internal */\nexport class HierarchyCache<T> {\n  private _map: LRUDictionary<HierarchyNodeKey[], HierarchyCacheEntry<T>>;\n  private _props: ChildNodeObservablesCacheProps;\n\n  public constructor(props: ChildNodeObservablesCacheProps) {\n    this._props = props;\n    this._map = new LRUDictionary<HierarchyNodeKey[], HierarchyCacheEntry<T>>(props.size, compareHierarchyNodeKeys);\n  }\n\n  private createCacheKeys(\n    props: Omit<GetHierarchyNodesProps, \"parentNode\"> & {\n      parentNode: { key: HierarchyNodeKey; parentKeys: HierarchyNodeKey[] } | undefined;\n      targetInstanceKeys?: InstanceKey[];\n    },\n  ) {\n    function createVariationKey() {\n      const { instanceFilter, hierarchyLevelSizeLimit, targetInstanceKeys } = props;\n      if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined && targetInstanceKeys === undefined) {\n        return undefined;\n      }\n      return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit, targetInstanceKeys });\n    }\n\n    if (!props.parentNode) {\n      return { primaryKey: [], variationKey: createVariationKey() };\n    }\n\n    const parentKeys = props.parentNode.parentKeys;\n\n    return {\n      primaryKey: [...parentKeys, props.parentNode.key],\n      variationKey: createVariationKey(),\n    };\n  }\n\n  private getCacheAccessors(primaryKey: HierarchyNodeKey[], variationKey?: string) {\n    const getMapEntry = (create: boolean) => {\n      let entry = this._map.get(primaryKey);\n      if (!entry && create) {\n        entry = { primary: undefined, variations: new LRUMap(this._props.variationsCount ?? 1) };\n        this._map.set(primaryKey, entry);\n      }\n      return entry;\n    };\n    if (variationKey) {\n      return {\n        get: () => getMapEntry(false)?.variations.get(variationKey),\n        set: (value: T) => {\n          getMapEntry(true)!.variations.set(variationKey, value);\n        },\n      };\n    }\n    return {\n      get: () => getMapEntry(false)?.primary,\n      set: (value: T) => {\n        getMapEntry(true)!.primary = value;\n      },\n    };\n  }\n\n  public set(requestProps: GetHierarchyNodesProps, value: T) {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    this.getCacheAccessors(primaryKey, variationKey).set(value);\n  }\n\n  public get(requestProps: GetHierarchyNodesProps): T | undefined {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    return this.getCacheAccessors(primaryKey, variationKey).get();\n  }\n\n  public clear() {\n    this._map.clear();\n  }\n}\n\nfunction compareHierarchyNodeKeys(lhs: HierarchyNodeKey[], rhs: HierarchyNodeKey[]) {\n  if (lhs.length !== rhs.length) {\n    return lhs.length - rhs.length;\n  }\n  for (let i = 0; i < lhs.length; ++i) {\n    const keysCompareResult = HierarchyNodeKey.compare(lhs[i], rhs[i]);\n    if (keysCompareResult !== 0) {\n      return keysCompareResult;\n    }\n  }\n  return 0;\n}\n"]}

package/lib/esm/hierarchies/imodel/IModelHierarchyDefinition.d.ts

@@ -46,9 +46,16 @@ export type HierarchyLevelDefinition = HierarchyNodesDefinition[];
  * A type for a function that parses a `SourceInstanceHierarchyNode` from provided ECSQL `row` object.
  * @public
  */
-export type NodeParser = (row: {
-    [columnName: string]: any;
-}, parentNode?: HierarchyDefinitionParentNode) => SourceInstanceHierarchyNode | Promise<SourceInstanceHierarchyNode>;
+export type NodeParser = (props: {
+    /** The ECSQL row object to parse. Keys & value types depend on the executed query. */
+    row: {
+        [columnName: string]: any;
+    };
+    /** The parent node whose child node is being parsed. */
+    parentNode?: HierarchyDefinitionParentNode;
+    /** The key of iModel which is used to run the query. */
+    imodelKey: string;
+}) => SourceInstanceHierarchyNode | Promise<SourceInstanceHierarchyNode>;
 /**
  * A type for a function that pre-processes given node. Unless the function decides not to make any modifications,
  * it should return a new - modified - node, rather than modifying the given one. Returning `undefined` omits the node
@@ -77,6 +84,8 @@ export type HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, "chil
  * @public
  */
 export interface DefineHierarchyLevelProps {
+    /** The key of iModel for which the hierarchy definition is being requested for. */
+    imodelKey: string;
     /** Parent node to get children for. Pass `undefined` to get root nodes. */
     parentNode: HierarchyDefinitionParentNode | undefined;
     /** Optional hierarchy level filter. */

package/lib/esm/hierarchies/imodel/IModelHierarchyDefinition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IModelHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EACL,6BAA6B,EAC7B,sBAAsB,EACtB,8BAA8B,EAC9B,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oDAAoD;IACpD,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,8BAA8B,GAAG,4BAA4B,CAAC;AACrG,cAAc;AAEd,yBAAiB,wBAAwB,CAAC;IACxC,SAAgB,aAAa,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,8BAA8B,CAElG;IACD,SAAgB,oBAAoB,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,4BAA4B,CAEvG;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,EAAE,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CACvB,GAAG,EAAE;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,EAClC,UAAU,CAAC,EAAE,6BAA6B,KACvC,2BAA2B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,SAAS,6BAA6B,GAAG,8BAA8B,EAAE,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;AAEzJ;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAElG;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,2EAA2E;IAC3E,UAAU,EAAE,6BAA6B,GAAG,SAAS,CAAC;IAEtD,uCAAuC;IACvC,cAAc,CAAC,EAAE,qBAAqB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IAEvB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAElC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAEpC,+EAA+E;IAC/E,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAC3F"}
+{"version":3,"file":"IModelHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EACL,6BAA6B,EAC7B,sBAAsB,EACtB,8BAA8B,EAC9B,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oDAAoD;IACpD,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,8BAA8B,GAAG,4BAA4B,CAAC;AACrG,cAAc;AAEd,yBAAiB,wBAAwB,CAAC;IACxC,SAAgB,aAAa,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,8BAA8B,CAElG;IACD,SAAgB,oBAAoB,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,4BAA4B,CAEvG;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,EAAE,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE;IAC/B,sFAAsF;IACtF,GAAG,EAAE;QAAE,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEnC,wDAAwD;IACxD,UAAU,CAAC,EAAE,6BAA6B,CAAC;IAE3C,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;CACnB,KAAK,2BAA2B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,SAAS,6BAA6B,GAAG,8BAA8B,EAAE,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;AAEzJ;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAElG;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,mFAAmF;IACnF,SAAS,EAAE,MAAM,CAAC;IAElB,2EAA2E;IAC3E,UAAU,EAAE,6BAA6B,GAAG,SAAS,CAAC;IAEtD,uCAAuC;IACvC,cAAc,CAAC,EAAE,qBAAqB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IAEvB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAElC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAEpC,+EAA+E;IAC/E,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAC3F"}

package/lib/esm/hierarchies/imodel/IModelHierarchyDefinition.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelHierarchyDefinition.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyDefinition.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AA6ChG,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,wBAAwB,CAOxC;AAPD,WAAiB,wBAAwB;IACvC,SAAgB,aAAa,CAAC,GAA6B;QACzD,OAAO,CAAC,CAAE,GAAsC,CAAC,IAAI,CAAC;IACxD,CAAC;IAFe,sCAAa,gBAE5B,CAAA;IACD,SAAgB,oBAAoB,CAAC,GAA6B;QAChE,OAAO,CAAC,CAAE,GAAoC,CAAC,KAAK,CAAC;IACvD,CAAC;IAFe,6CAAoB,uBAEnC,CAAA;AACH,CAAC,EAPgB,wBAAwB,KAAxB,wBAAwB,QAOxC","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 { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { ECSqlQueryDef } from \"@itwin/presentation-shared\";\nimport { NonGroupingHierarchyNode } from \"../HierarchyNode.js\";\nimport {\n  ProcessedGenericHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n  SourceGenericHierarchyNode,\n  SourceInstanceHierarchyNode,\n} from \"./IModelHierarchyNode.js\";\n\n/**\n * A nodes definition that returns a single generic node.\n * @public\n */\nexport interface GenericHierarchyNodeDefinition {\n  /** The node to be created in the hierarchy level */\n  node: SourceGenericHierarchyNode;\n}\n\n/**\n * A nodes definition that returns an ECSQL query for selecting nodes from an iModel.\n * @public\n */\nexport interface InstanceNodesQueryDefinition {\n  /**\n   * Full name of the class whose instances are going to be returned. It's okay if the attribute\n   * points to a base class of multiple different classes of instances returned by the query, however\n   * the more specific this class is, the more efficient hierarchy building process is.\n   */\n  fullClassName: string;\n  /**\n   * An ECSQL query that selects nodes from an iModel. `SELECT` clause of the query is expected\n   * to be built using `NodeSelectQueryFactory.createSelectClause`.\n   */\n  query: ECSqlQueryDef;\n}\n\n/**\n * A definition of nodes included in a hierarchy level.\n * @public\n */\nexport type HierarchyNodesDefinition = GenericHierarchyNodeDefinition | InstanceNodesQueryDefinition;\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodesDefinition {\n  export function isGenericNode(def: HierarchyNodesDefinition): def is GenericHierarchyNodeDefinition {\n    return !!(def as GenericHierarchyNodeDefinition).node;\n  }\n  export function isInstanceNodesQuery(def: HierarchyNodesDefinition): def is InstanceNodesQueryDefinition {\n    return !!(def as InstanceNodesQueryDefinition).query;\n  }\n}\n\n/**\n * A definition of a hierarchy level, which may consist of multiple node definitions.\n * @public\n */\nexport type HierarchyLevelDefinition = HierarchyNodesDefinition[];\n\n/**\n * A type for a function that parses a `SourceInstanceHierarchyNode` from provided ECSQL `row` object.\n * @public\n */\nexport type NodeParser = (\n  row: { [columnName: string]: any },\n  parentNode?: HierarchyDefinitionParentNode,\n) => SourceInstanceHierarchyNode | Promise<SourceInstanceHierarchyNode>;\n\n/**\n * A type for a function that pre-processes given node. Unless the function decides not to make any modifications,\n * it should return a new - modified - node, rather than modifying the given one. Returning `undefined` omits the node\n * from the hierarchy.\n *\n * @public\n */\nexport type NodePreProcessor = <TNode extends ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode>(node: TNode) => Promise<TNode | undefined>;\n\n/**\n * A type for a function that post-processes given node. Unless the function decides not to make any modifications,\n * it should return a new - modified - node, rather than modifying the given one.\n *\n * @public\n */\nexport type NodePostProcessor = (node: ProcessedHierarchyNode) => Promise<ProcessedHierarchyNode>;\n\n/**\n * A type of node that can be passed to `HierarchyDefinition.defineHierarchyLevel`. This basically means\n * a `HierarchyNode` that:\n * - knows nothing about its children,\n * - is either an instances node (key is of `InstancesNodeKey` type) or a generic node (key is of `GenericNodeKey` type).\n * @public\n */\nexport type HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, \"children\">;\n\n/**\n * Props for `HierarchyDefinition.defineHierarchyLevel`.\n * @public\n */\nexport interface DefineHierarchyLevelProps {\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: HierarchyDefinitionParentNode | undefined;\n\n  /** Optional hierarchy level filter. */\n  instanceFilter?: GenericInstanceFilter;\n}\n\n/**\n * An interface for a factory that knows how define a hierarchy based on a given parent node.\n * @public\n */\nexport interface HierarchyDefinition {\n  /**\n   * An optional function for parsing ECInstance node from ECSQL row.\n   *\n   * Should be used in situations when the `HierarchyDefinition` implementation\n   * introduces additional ECSQL columns into the select clause and wants to assign additional\n   * data to the nodes it produces.\n   *\n   * Defaults to a function that parses all `HierarchyNode` attributes from a query, whose SELECT\n   * clause is created using `NodeSelectQueryFactory.createSelectClause`.\n   */\n  parseNode?: NodeParser;\n\n  /**\n   * An optional function for pre-processing nodes.\n   *\n   * Pre-processing happens immediately after the nodes are loaded based on `HierarchyLevelDefinition`\n   * returned by this `HierarchyDefinition` and before their processing (hiding, grouping, sorting, etc.) starts.\n   * The step allows assigning nodes additional data or excluding them from the hierarchy based on some attributes.\n   */\n  preProcessNode?: NodePreProcessor;\n\n  /**\n   * An optional function for post-processing nodes.\n   *\n   * Post-processing happens after the loaded nodes go through all the merging, hiding and grouping\n   * steps, but before sorting them. This step allows `HierarchyDefinition` implementations to assign additional data\n   * to nodes after they're processed. This is especially true for grouping nodes as they're only created during\n   * processing.\n   */\n  postProcessNode?: NodePostProcessor;\n\n  /** A function to create a hierarchy level definition for given parent node. */\n  defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition>;\n}\n"]}
+{"version":3,"file":"IModelHierarchyDefinition.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyDefinition.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AA6ChG,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,wBAAwB,CAOxC;AAPD,WAAiB,wBAAwB;IACvC,SAAgB,aAAa,CAAC,GAA6B;QACzD,OAAO,CAAC,CAAE,GAAsC,CAAC,IAAI,CAAC;IACxD,CAAC;IAFe,sCAAa,gBAE5B,CAAA;IACD,SAAgB,oBAAoB,CAAC,GAA6B;QAChE,OAAO,CAAC,CAAE,GAAoC,CAAC,KAAK,CAAC;IACvD,CAAC;IAFe,6CAAoB,uBAEnC,CAAA;AACH,CAAC,EAPgB,wBAAwB,KAAxB,wBAAwB,QAOxC","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 { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { ECSqlQueryDef } from \"@itwin/presentation-shared\";\nimport { NonGroupingHierarchyNode } from \"../HierarchyNode.js\";\nimport {\n  ProcessedGenericHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n  SourceGenericHierarchyNode,\n  SourceInstanceHierarchyNode,\n} from \"./IModelHierarchyNode.js\";\n\n/**\n * A nodes definition that returns a single generic node.\n * @public\n */\nexport interface GenericHierarchyNodeDefinition {\n  /** The node to be created in the hierarchy level */\n  node: SourceGenericHierarchyNode;\n}\n\n/**\n * A nodes definition that returns an ECSQL query for selecting nodes from an iModel.\n * @public\n */\nexport interface InstanceNodesQueryDefinition {\n  /**\n   * Full name of the class whose instances are going to be returned. It's okay if the attribute\n   * points to a base class of multiple different classes of instances returned by the query, however\n   * the more specific this class is, the more efficient hierarchy building process is.\n   */\n  fullClassName: string;\n  /**\n   * An ECSQL query that selects nodes from an iModel. `SELECT` clause of the query is expected\n   * to be built using `NodeSelectQueryFactory.createSelectClause`.\n   */\n  query: ECSqlQueryDef;\n}\n\n/**\n * A definition of nodes included in a hierarchy level.\n * @public\n */\nexport type HierarchyNodesDefinition = GenericHierarchyNodeDefinition | InstanceNodesQueryDefinition;\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodesDefinition {\n  export function isGenericNode(def: HierarchyNodesDefinition): def is GenericHierarchyNodeDefinition {\n    return !!(def as GenericHierarchyNodeDefinition).node;\n  }\n  export function isInstanceNodesQuery(def: HierarchyNodesDefinition): def is InstanceNodesQueryDefinition {\n    return !!(def as InstanceNodesQueryDefinition).query;\n  }\n}\n\n/**\n * A definition of a hierarchy level, which may consist of multiple node definitions.\n * @public\n */\nexport type HierarchyLevelDefinition = HierarchyNodesDefinition[];\n\n/**\n * A type for a function that parses a `SourceInstanceHierarchyNode` from provided ECSQL `row` object.\n * @public\n */\nexport type NodeParser = (props: {\n  /** The ECSQL row object to parse. Keys & value types depend on the executed query. */\n  row: { [columnName: string]: any };\n\n  /** The parent node whose child node is being parsed. */\n  parentNode?: HierarchyDefinitionParentNode;\n\n  /** The key of iModel which is used to run the query. */\n  imodelKey: string;\n}) => SourceInstanceHierarchyNode | Promise<SourceInstanceHierarchyNode>;\n\n/**\n * A type for a function that pre-processes given node. Unless the function decides not to make any modifications,\n * it should return a new - modified - node, rather than modifying the given one. Returning `undefined` omits the node\n * from the hierarchy.\n *\n * @public\n */\nexport type NodePreProcessor = <TNode extends ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode>(node: TNode) => Promise<TNode | undefined>;\n\n/**\n * A type for a function that post-processes given node. Unless the function decides not to make any modifications,\n * it should return a new - modified - node, rather than modifying the given one.\n *\n * @public\n */\nexport type NodePostProcessor = (node: ProcessedHierarchyNode) => Promise<ProcessedHierarchyNode>;\n\n/**\n * A type of node that can be passed to `HierarchyDefinition.defineHierarchyLevel`. This basically means\n * a `HierarchyNode` that:\n * - knows nothing about its children,\n * - is either an instances node (key is of `InstancesNodeKey` type) or a generic node (key is of `GenericNodeKey` type).\n * @public\n */\nexport type HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, \"children\">;\n\n/**\n * Props for `HierarchyDefinition.defineHierarchyLevel`.\n * @public\n */\nexport interface DefineHierarchyLevelProps {\n  /** The key of iModel for which the hierarchy definition is being requested for. */\n  imodelKey: string;\n\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: HierarchyDefinitionParentNode | undefined;\n\n  /** Optional hierarchy level filter. */\n  instanceFilter?: GenericInstanceFilter;\n}\n\n/**\n * An interface for a factory that knows how define a hierarchy based on a given parent node.\n * @public\n */\nexport interface HierarchyDefinition {\n  /**\n   * An optional function for parsing ECInstance node from ECSQL row.\n   *\n   * Should be used in situations when the `HierarchyDefinition` implementation\n   * introduces additional ECSQL columns into the select clause and wants to assign additional\n   * data to the nodes it produces.\n   *\n   * Defaults to a function that parses all `HierarchyNode` attributes from a query, whose SELECT\n   * clause is created using `NodeSelectQueryFactory.createSelectClause`.\n   */\n  parseNode?: NodeParser;\n\n  /**\n   * An optional function for pre-processing nodes.\n   *\n   * Pre-processing happens immediately after the nodes are loaded based on `HierarchyLevelDefinition`\n   * returned by this `HierarchyDefinition` and before their processing (hiding, grouping, sorting, etc.) starts.\n   * The step allows assigning nodes additional data or excluding them from the hierarchy based on some attributes.\n   */\n  preProcessNode?: NodePreProcessor;\n\n  /**\n   * An optional function for post-processing nodes.\n   *\n   * Post-processing happens after the loaded nodes go through all the merging, hiding and grouping\n   * steps, but before sorting them. This step allows `HierarchyDefinition` implementations to assign additional data\n   * to nodes after they're processed. This is especially true for grouping nodes as they're only created during\n   * processing.\n   */\n  postProcessNode?: NodePostProcessor;\n\n  /** A function to create a hierarchy level definition for given parent node. */\n  defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition>;\n}\n"]}

package/lib/esm/hierarchies/imodel/IModelHierarchyProvider.d.ts

@@ -1,7 +1,7 @@
 import "../internal/DisposePolyfill.js";
 import { ECClassHierarchyInspector, ECSchemaProvider, Event, IPrimitiveValueFormatter } from "@itwin/presentation-shared";
-import { HierarchyFilteringPath } from "../HierarchyFiltering.js";
 import { HierarchyProvider } from "../HierarchyProvider.js";
+import { HierarchySearchPath } from "../HierarchySearch.js";
 import { HierarchyDefinition } from "./IModelHierarchyDefinition.js";
 import { LimitingECSqlQueryExecutor } from "./LimitingECSqlQueryExecutor.js";
 /**
@@ -62,10 +62,10 @@ interface IModelHierarchyProviderProps {
      * by calling `setFormatter` on the provider instance.
      */
     formatter?: IPrimitiveValueFormatter;
-    /** Props for filtering the hierarchy. */
-    filtering?: {
+    /** Props for search the hierarchy. */
+    search?: {
         /** A list of node identifiers from root to target node. */
-        paths: HierarchyFilteringPath[];
+        paths: HierarchySearchPath[];
     };
 }
 /**

package/lib/esm/hierarchies/imodel/IModelHierarchyProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IModelHierarchyProvider.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyProvider.ts"],"names":[],"mappings":"AAKA,OAAO,gCAAgC,CAAC;AA4BxC,OAAO,EAGL,yBAAyB,EACzB,gBAAgB,EAGhB,KAAK,EAIL,wBAAwB,EAEzB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,EAA0B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAkBpF,OAAO,EAGL,mBAAmB,EAGpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAe7E;;;GAGG;AACH,UAAU,uCAAuC;IAC/C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,cAAc;AACd,KAAK,YAAY,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtH;;;GAGG;AACH,UAAU,4BAA4B;IACpC;;;;;;OAMG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC,qGAAqG;IACrG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAEpE;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IAErC,yCAAyC;IACzC,SAAS,CAAC,EAAE;QACV,2DAA2D;QAC3D,KAAK,EAAE,sBAAsB,EAAE,CAAC;KACjC,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,4BAA4B,GAAG,iBAAiB,GAAG,UAAU,CAGjH;AAED;;;GAGG;AACH,UAAU,kCAAmC,SAAQ,IAAI,CAAC,4BAA4B,EAAE,cAAc,GAAG,eAAe,CAAC;IACvH;;;;;OAKG;IACH,OAAO,EAAE,KAAK,CAAC;QACb;;;;;;WAMG;QACH,YAAY,EAAE,YAAY,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;KACnC,CAAC,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CAAC,KAAK,EAAE,kCAAkC,GAAG,iBAAiB,GAAG,UAAU,CAE7H"}
+{"version":3,"file":"IModelHierarchyProvider.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyProvider.ts"],"names":[],"mappings":"AAKA,OAAO,gCAAgC,CAAC;AA4BxC,OAAO,EAGL,yBAAyB,EACzB,gBAAgB,EAGhB,KAAK,EAIL,wBAAwB,EAEzB,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EAA0B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAiB5D,OAAO,EAGL,mBAAmB,EAGpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAgB7E;;;GAGG;AACH,UAAU,uCAAuC;IAC/C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,cAAc;AACd,KAAK,YAAY,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtH;;;GAGG;AACH,UAAU,4BAA4B;IACpC;;;;;;OAMG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC,qGAAqG;IACrG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAEpE;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IAErC,sCAAsC;IACtC,MAAM,CAAC,EAAE;QACP,2DAA2D;QAC3D,KAAK,EAAE,mBAAmB,EAAE,CAAC;KAC9B,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,4BAA4B,GAAG,iBAAiB,GAAG,UAAU,CAGjH;AAED;;;GAGG;AACH,UAAU,kCAAmC,SAAQ,IAAI,CAAC,4BAA4B,EAAE,cAAc,GAAG,eAAe,CAAC;IACvH;;;;;OAKG;IACH,OAAO,EAAE,KAAK,CAAC;QACb;;;;;;WAMG;QACH,YAAY,EAAE,YAAY,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;KACnC,CAAC,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CAAC,KAAK,EAAE,kCAAkC,GAAG,iBAAiB,GAAG,UAAU,CAE7H"}