@itwin/presentation-hierarchies 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @itwin/presentation-hierarchies
 
+## 0.4.0
+
+### Minor Changes
+
+- [#676](https://github.com/iTwin/presentation/pull/676): `createHierarchyProvider`: Added ability to specify whether hierarchy should be expanded to filtering path target, when specifying the `filtering.paths` prop.
+
+  With this change, hierarchy is no longer expanded to filter targets by default. To achieve the same behavior, paths with `autoExpand` option should be provided:
+
+  _Before:_
+
+  ```tsx
+  const hierarchyProvider = createHierarchyProvider({
+    imodelAccess,
+    hierarchyDefinition: createHierarchyDefinition(imodelAccess),
+    filtering: { paths: filterPaths },
+  });
+  ```
+
+  _Now:_
+
+  ```tsx
+  const hierarchyProvider = createHierarchyProvider({
+    imodelAccess,
+    hierarchyDefinition: createHierarchyDefinition(imodelAccess),
+    filtering: { paths: filterPaths.map((path) => ({ path, options: { autoExpand: true } })) },
+  });
+  ```
+
+- [#672](https://github.com/iTwin/presentation/pull/672): Fix `autoExpand` prop of grouping specification for `NodesQueryClauseFactory.createSelectClause` being wrongly defined as `string`. Define it as a string union of `"always" | "single-child"`.
+
+### Patch Changes
+
+- [#675](https://github.com/iTwin/presentation/pull/675): Fix nodes being erroneously set as filter targets when they had filter target siblings.
+- [#672](https://github.com/iTwin/presentation/pull/672): Fix grouped nodes not being returned for "Not specified" property grouping node when grouping by value ranges.
+- [#672](https://github.com/iTwin/presentation/pull/672): Fix hierarchy provider not returning all nodes in situations when internal cache is full and a prior request of grouped children was made.
+- Updated dependencies:
+  - @itwin/presentation-shared@0.4.0
+
 ## 0.3.0
 
 ### Minor Changes

package/README.md

@@ -96,9 +96,9 @@ function createProvider(imodel: IModelConnection): HierarchyProvider {
   const schemaProvider = createECSchemaProvider(getIModelSchemaContext(imodel));
   const imodelAccess = {
     ...schemaProvider,
-    // while caching for hierarchy inspector is not mandatory, it's recommended to use it to improve performance
+    // While caching for hierarchy inspector is not mandatory, it's recommended to use it to improve performance
     ...createCachingECClassHierarchyInspector({ schemaProvider, cacheSize: 100 }),
-    // the second argument is the maximum number of rows the executor will return - this allows us to
+    // The second argument is the maximum number of rows the executor will return - this allows us to
     // avoid creating hierarchy levels of insane size (expensive to us and useless to users)
     ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),
   };
@@ -112,7 +112,7 @@ function createProvider(imodel: IModelConnection): HierarchyProvider {
   const hierarchyDefinition = createClassBasedHierarchyDefinition({
     classHierarchyInspector: imodelAccess,
     hierarchy: {
-      // for root nodes, select all BisCore.GeometricModel3d instances
+      // For root nodes, select all BisCore.GeometricModel3d instances
       rootNodes: async () => [
         {
           fullClassName: "BisCore.GeometricModel3d",
@@ -133,7 +133,7 @@ function createProvider(imodel: IModelConnection): HierarchyProvider {
       ],
       childNodes: [
         {
-          // for BisCore.Model parent nodes, select all BisCore.Element instances contained in corresponding model
+          // For BisCore.Model parent nodes, select all BisCore.Element instances contained in corresponding model
           parentNodeClassName: "BisCore.Model",
           definitions: async ({ parentNodeInstanceIds }: DefineInstanceNodeChildHierarchyLevelProps) => [
             {

package/lib/cjs/hierarchies/HierarchyDefinition.js

@@ -4,7 +4,8 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createClassBasedHierarchyDefinition = exports.HierarchyNodesDefinition = void 0;
+exports.HierarchyNodesDefinition = void 0;
+exports.createClassBasedHierarchyDefinition = createClassBasedHierarchyDefinition;
 const HierarchyNode_1 = require("./HierarchyNode");
 const rxjs_1 = require("rxjs");
 /** @beta */
@@ -30,7 +31,6 @@ var HierarchyNodesDefinition;
 function createClassBasedHierarchyDefinition(props) {
     return new ClassBasedHierarchyDefinition(props);
 }
-exports.createClassBasedHierarchyDefinition = createClassBasedHierarchyDefinition;
 class ClassBasedHierarchyDefinition {
     _props;
     constructor(_props) {

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyDefinition.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAKhG,mDAQyB;AAEzB,+BAA4F;AAkC5F,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,wBAAwB,CAOxC;AAPD,WAAiB,wBAAwB;IACvC,SAAgB,YAAY,CAAC,GAA6B;QACxD,OAAO,CAAC,CAAE,GAAqC,CAAC,IAAI,CAAC;IACvD,CAAC;IAFe,qCAAY,eAE3B,CAAA;IACD,SAAgB,oBAAoB,CAAC,GAA6B;QAChE,OAAO,CAAC,CAAE,GAAoC,CAAC,KAAK,CAAC;IACvD,CAAC;IAFe,6CAAoB,uBAEnC,CAAA;AACH,CAAC,EAPgB,wBAAwB,wCAAxB,wBAAwB,QAOxC;AA8ND;;;;;;GAMG;AACH,SAAgB,mCAAmC,CAAC,KAAyC;IAC3F,OAAO,IAAI,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAFD,kFAEC;AAED,MAAM,6BAA6B;IACN;IAA3B,YAA2B,MAA0C;QAA1C,WAAM,GAAN,MAAM,CAAoC;IAAG,CAAC;IAEzE;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAAgC;QAChE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,6BAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU;iBAC1C,MAAM,CAAC,yCAAyC,CAAC;iBACjD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,mBAAmB,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/D,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxG,CAAC;QAED,uBAAuB;QACvB,IAAI,6BAAa,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAChF,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,4CAA4C,CAAC,CAAC;YACtH,OAAO,CACL,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,GAAG,kBAAkB,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAC3F,+BAA+B,CAAC,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,uBAAuB,EAAE;gBAC5F,GAAG,KAAK;gBACR,mBAAmB;gBACnB,qBAAqB;gBACrB,UAAU;aACX,CAAC,CACH,CACF,CACF,CAAC,IAAI,EAAE,CAAC;QACX,CAAC;QAED,uBAAuB;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED,KAAK,UAAU,+BAA+B,CAC5C,cAAyC,EACzC,IAAkD,EAClD,YAAwD;IAExD,MAAM,GAAG,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,CAAC,IAAI,CACzB,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC1B,IAAI,MAAM,cAAc,CAAC,gBAAgB,CAAC,YAAY,CAAC,mBAAmB,EAAE,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACrG,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,EACF,IAAA,aAAM,EAAC,CAAC,CAAC,EAAqC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EACrD,IAAA,cAAO,GAAE,EACT,IAAA,gBAAS,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EACvE,IAAA,aAAM,EAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,IAAI,GAAG,KAAK,CAAC,CAAC,EACxD,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,EACtD,IAAA,eAAQ,GAAE,CACX,CAAC;IACF,OAAO,IAAA,qBAAc,EAAC,GAAG,CAAC,IAAI,CAAC,IAAA,cAAO,GAAE,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,uBAAuB,CAAC,YAA2B;IAC1D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC3D,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC3B,IAAI,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,EAAE,CAAC;YACjB,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IACH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,SAAS,yCAAyC,CAAC,GAAuC;IACxF,OAAO,CAAC,CAAE,GAA+C,CAAC,mBAAmB,CAAC;AAChF,CAAC;AAED,SAAS,4CAA4C,CAAC,GAAuC;IAC3F,OAAO,CAAC,CAAE,GAAkD,CAAC,mBAAmB,CAAC;AACnF,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 { Id64String } from \"@itwin/core-bentley\";\nimport { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { ECClassHierarchyInspector, ECSqlQueryDef, InstanceKey } from \"@itwin/presentation-shared\";\nimport {\n  HierarchyNode,\n  NonGroupingHierarchyNode,\n  ParsedCustomHierarchyNode,\n  ParsedInstanceHierarchyNode,\n  ProcessedCustomHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n} from \"./HierarchyNode\";\nimport { InstancesNodeKey } from \"./HierarchyNodeKey\";\nimport { concatMap, filter, firstValueFrom, from, mergeAll, mergeMap, toArray } from \"rxjs\";\n\n/**\n * A nodes definition that returns a single custom defined node.\n * @beta\n */\nexport interface CustomHierarchyNodeDefinition {\n  /** The node to be created in the hierarchy level */\n  node: ParsedCustomHierarchyNode;\n}\n\n/**\n * A nodes definition that returns an ECSQL query for selecting nodes from an iModel.\n * @beta\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 * @beta\n */\nexport type HierarchyNodesDefinition = CustomHierarchyNodeDefinition | InstanceNodesQueryDefinition;\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodesDefinition {\n  export function isCustomNode(def: HierarchyNodesDefinition): def is CustomHierarchyNodeDefinition {\n    return !!(def as CustomHierarchyNodeDefinition).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 * @beta\n */\nexport type HierarchyLevelDefinition = HierarchyNodesDefinition[];\n\n/**\n * A type for a function that parses a `ParsedInstanceHierarchyNode` from provided ECSQL `row` object.\n * @beta\n */\nexport type NodeParser = (row: { [columnName: string]: any }) => ParsedInstanceHierarchyNode;\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 * @beta\n */\nexport type NodePreProcessor = <TNode extends ProcessedCustomHierarchyNode | 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 * @beta\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 custom node (key is of `string` type).\n * @beta\n */\ntype HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, \"children\">;\n\n/**\n * Props for `HierarchyDefinition.defineHierarchyLevel`.\n * @beta\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 * @beta\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\n/**\n * Props for defining child hierarchy level for specific parent instance node.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineInstanceNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\"> & {\n  /** The parent instance node. */\n  parentNode: Omit<HierarchyDefinitionParentNode, \"key\"> & { key: InstancesNodeKey };\n\n  /**\n   * Full name of the parent instance node class.\n   *\n   * The `parentNode.key` also contains information about the instances the parent node is based on. However,\n   * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance\n   * keys are grouped by class and a hierarchy level definition is requested for each combination of class and\n   * instance IDs (with the same `parentNode`).\n   */\n  parentNodeClassName: string;\n\n  /**\n   * ECInstanceIds of the parent instance node.\n   *\n   * The `parentNode.key` also contains information about the instances the parent node is based on. However,\n   * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance\n   * keys are grouped by class and a hierarchy level definition is requested for each combination of class and\n   * instance IDs (with the same `parentNode`).\n   */\n  parentNodeInstanceIds: Id64String[];\n};\n\n/**\n * A definition of a hierarchy level that should be used for specific class of parent instance nodes.\n * @beta\n */\ninterface InstancesNodeChildHierarchyLevelDefinition {\n  /**\n   * Full name of the parent instance node's class to match against when checking if this hierarchy\n   * level should be used for specific parent instance node.\n   *\n   * The check is polymorphic, so `BisCore.Element` class would match `BisCore.GeometricElement`, `BisCore.Category` and\n   * all other element classes.\n   */\n  parentNodeClassName: string;\n\n  /**\n   * Called to create a hierarchy level definition when the class check passes (see `parentNodeClassName`).\n   */\n  definitions: (requestProps: DefineInstanceNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n\n  /**\n   * If set to true, and node matches at least one of the previous definitions, this definition will not be applied.\n   *\n   * For example:\n   * ```ts\n   * {\n   *   parentNodeClassName: \"BisCore.GeometricElement3d\",\n   *   definitions: () => ...,\n   * },\n   * // This will apply to all elements, that are not BisCore.GeometricElement3d\n   * {\n   *   parentNodeClassName: \"BisCore.Element\",\n   *   onlyIfNotHandled: true,\n   *   definitions: () => ...,\n   * }\n   * ```\n   */\n  onlyIfNotHandled?: boolean;\n}\n\n/**\n * Props for defining child hierarchy level for specific parent custom node.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineCustomNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\"> & {\n  /** The parent custom node. */\n  parentNode: Omit<HierarchyDefinitionParentNode, \"key\"> & { key: string };\n};\n\n/**\n * A definition of a hierarchy level for that should be used for specific custom parent nodes.\n * @beta\n */\ninterface CustomNodeChildHierarchyLevelDefinition {\n  /**\n   * `HierarchyNode.key` of the custom node that this child hierarchy level definition should be used for.\n   */\n  customParentNodeKey: string;\n\n  /**\n   * Called to create a hierarchy level definition when the node key check passes (see `customParentNodeKey`).\n   */\n  definitions: (requestProps: DefineCustomNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n}\n\n/**\n * A hierarchy level definition associated with either parent instance node's class or custom\n * node's key.\n * @beta\n */\ntype ClassBasedHierarchyLevelDefinition = InstancesNodeChildHierarchyLevelDefinition | CustomNodeChildHierarchyLevelDefinition;\n\n/**\n * Props for defining root hierarchy level.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineRootHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\">;\n\n/**\n * Props for `createClassBasedHierarchyDefinition`.\n * @beta\n */\ninterface ClassBasedHierarchyDefinitionProps {\n  /** Access to ECClass hierarchy in the iModel */\n  classHierarchyInspector: ECClassHierarchyInspector;\n\n  /** Hierarchy level definitions based on parent instance node's class or custom node's key. */\n  hierarchy: {\n    /** Called to create the root hierarchy level definition. */\n    rootNodes: (props: DefineRootHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n\n    /**\n     * Called to get child hierarchy level definitions based on parent instance node's class\n     * or custom node's key.\n     */\n    childNodes: ClassBasedHierarchyLevelDefinition[];\n  };\n}\n\n/**\n * Creates an instance of `HierarchyDefinition` that uses a somewhat declarative approach to define the\n * hierarchy - each hierarchy level is assigned either an instance node's class or custom node's\n * key and they're used to assign hierarchy level definitions based on parent node.\n *\n * @beta\n */\nexport function createClassBasedHierarchyDefinition(props: ClassBasedHierarchyDefinitionProps): HierarchyDefinition {\n  return new ClassBasedHierarchyDefinition(props);\n}\n\nclass ClassBasedHierarchyDefinition implements HierarchyDefinition {\n  public constructor(private _props: ClassBasedHierarchyDefinitionProps) {}\n\n  /**\n   * Create hierarchy level definitions for specific hierarchy level.\n   * @param parentNode Parent node to create children definitions for.\n   */\n  public async defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition> {\n    const { parentNode } = props;\n    if (!parentNode) {\n      return this._props.hierarchy.rootNodes(props);\n    }\n\n    if (HierarchyNode.isCustom(parentNode)) {\n      const defs = this._props.hierarchy.childNodes\n        .filter(isCustomNodeChildHierarchyLevelDefinition)\n        .filter((def) => def.customParentNodeKey === parentNode.key);\n      return (await Promise.all(defs.map(async (def) => def.definitions({ ...props, parentNode })))).flat();\n    }\n\n    // istanbul ignore else\n    if (HierarchyNode.isInstancesNode(parentNode)) {\n      const instanceIdsByClass = groupInstanceIdsByClass(parentNode.key.instanceKeys);\n      const instancesParentNodeDefs = this._props.hierarchy.childNodes.filter(isInstancesNodeChildHierarchyLevelDefinition);\n      return (\n        await Promise.all(\n          [...instanceIdsByClass.entries()].map(async ([parentNodeClassName, parentNodeInstanceIds]) =>\n            createHierarchyLevelDefinitions(this._props.classHierarchyInspector, instancesParentNodeDefs, {\n              ...props,\n              parentNodeClassName,\n              parentNodeInstanceIds,\n              parentNode,\n            }),\n          ),\n        )\n      ).flat();\n    }\n\n    // istanbul ignore next\n    return [];\n  }\n}\n\nasync function createHierarchyLevelDefinitions(\n  classHierarchy: ECClassHierarchyInspector,\n  defs: InstancesNodeChildHierarchyLevelDefinition[],\n  requestProps: DefineInstanceNodeChildHierarchyLevelProps,\n) {\n  const obs = from(defs).pipe(\n    mergeMap(async (def, idx) => {\n      if (await classHierarchy.classDerivesFrom(requestProps.parentNodeClassName, def.parentNodeClassName)) {\n        return { def, idx };\n      }\n      return undefined;\n    }),\n    filter((x): x is Exclude<typeof x, undefined> => !!x),\n    toArray(),\n    concatMap((x) => x.sort((a, b) => a.idx - b.idx).map(({ def }) => def)),\n    filter((def, idx) => !def.onlyIfNotHandled || idx === 0),\n    mergeMap(async (def) => def.definitions(requestProps)),\n    mergeAll(),\n  );\n  return firstValueFrom(obs.pipe(toArray()));\n}\n\nfunction groupInstanceIdsByClass(instanceKeys: InstanceKey[]) {\n  const instanceIdsByClass = new Map<string, Id64String[]>();\n  instanceKeys.forEach((key) => {\n    let instanceIds = instanceIdsByClass.get(key.className);\n    if (!instanceIds) {\n      instanceIds = [];\n      instanceIdsByClass.set(key.className, instanceIds);\n    }\n    instanceIds.push(key.id);\n  });\n  return instanceIdsByClass;\n}\n\nfunction isCustomNodeChildHierarchyLevelDefinition(def: ClassBasedHierarchyLevelDefinition): def is CustomNodeChildHierarchyLevelDefinition {\n  return !!(def as CustomNodeChildHierarchyLevelDefinition).customParentNodeKey;\n}\n\nfunction isInstancesNodeChildHierarchyLevelDefinition(def: ClassBasedHierarchyLevelDefinition): def is InstancesNodeChildHierarchyLevelDefinition {\n  return !!(def as InstancesNodeChildHierarchyLevelDefinition).parentNodeClassName;\n}\n"]}
+{"version":3,"file":"HierarchyDefinition.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA+RhG,kFAEC;AA5RD,mDAQyB;AAEzB,+BAA4F;AAkC5F,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,wBAAwB,CAOxC;AAPD,WAAiB,wBAAwB;IACvC,SAAgB,YAAY,CAAC,GAA6B;QACxD,OAAO,CAAC,CAAE,GAAqC,CAAC,IAAI,CAAC;IACvD,CAAC;IAFe,qCAAY,eAE3B,CAAA;IACD,SAAgB,oBAAoB,CAAC,GAA6B;QAChE,OAAO,CAAC,CAAE,GAAoC,CAAC,KAAK,CAAC;IACvD,CAAC;IAFe,6CAAoB,uBAEnC,CAAA;AACH,CAAC,EAPgB,wBAAwB,wCAAxB,wBAAwB,QAOxC;AA8ND;;;;;;GAMG;AACH,SAAgB,mCAAmC,CAAC,KAAyC;IAC3F,OAAO,IAAI,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,6BAA6B;IACN;IAA3B,YAA2B,MAA0C;QAA1C,WAAM,GAAN,MAAM,CAAoC;IAAG,CAAC;IAEzE;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAAgC;QAChE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,6BAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU;iBAC1C,MAAM,CAAC,yCAAyC,CAAC;iBACjD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,mBAAmB,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/D,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxG,CAAC;QAED,uBAAuB;QACvB,IAAI,6BAAa,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAChF,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,4CAA4C,CAAC,CAAC;YACtH,OAAO,CACL,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,GAAG,kBAAkB,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAC3F,+BAA+B,CAAC,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,uBAAuB,EAAE;gBAC5F,GAAG,KAAK;gBACR,mBAAmB;gBACnB,qBAAqB;gBACrB,UAAU;aACX,CAAC,CACH,CACF,CACF,CAAC,IAAI,EAAE,CAAC;QACX,CAAC;QAED,uBAAuB;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED,KAAK,UAAU,+BAA+B,CAC5C,cAAyC,EACzC,IAAkD,EAClD,YAAwD;IAExD,MAAM,GAAG,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,CAAC,IAAI,CACzB,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC1B,IAAI,MAAM,cAAc,CAAC,gBAAgB,CAAC,YAAY,CAAC,mBAAmB,EAAE,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACrG,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,EACF,IAAA,aAAM,EAAC,CAAC,CAAC,EAAqC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EACrD,IAAA,cAAO,GAAE,EACT,IAAA,gBAAS,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EACvE,IAAA,aAAM,EAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,IAAI,GAAG,KAAK,CAAC,CAAC,EACxD,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,EACtD,IAAA,eAAQ,GAAE,CACX,CAAC;IACF,OAAO,IAAA,qBAAc,EAAC,GAAG,CAAC,IAAI,CAAC,IAAA,cAAO,GAAE,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,uBAAuB,CAAC,YAA2B;IAC1D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC3D,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC3B,IAAI,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,EAAE,CAAC;YACjB,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IACH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,SAAS,yCAAyC,CAAC,GAAuC;IACxF,OAAO,CAAC,CAAE,GAA+C,CAAC,mBAAmB,CAAC;AAChF,CAAC;AAED,SAAS,4CAA4C,CAAC,GAAuC;IAC3F,OAAO,CAAC,CAAE,GAAkD,CAAC,mBAAmB,CAAC;AACnF,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 { Id64String } from \"@itwin/core-bentley\";\nimport { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { ECClassHierarchyInspector, ECSqlQueryDef, InstanceKey } from \"@itwin/presentation-shared\";\nimport {\n  HierarchyNode,\n  NonGroupingHierarchyNode,\n  ParsedCustomHierarchyNode,\n  ParsedInstanceHierarchyNode,\n  ProcessedCustomHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n} from \"./HierarchyNode\";\nimport { InstancesNodeKey } from \"./HierarchyNodeKey\";\nimport { concatMap, filter, firstValueFrom, from, mergeAll, mergeMap, toArray } from \"rxjs\";\n\n/**\n * A nodes definition that returns a single custom defined node.\n * @beta\n */\nexport interface CustomHierarchyNodeDefinition {\n  /** The node to be created in the hierarchy level */\n  node: ParsedCustomHierarchyNode;\n}\n\n/**\n * A nodes definition that returns an ECSQL query for selecting nodes from an iModel.\n * @beta\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 * @beta\n */\nexport type HierarchyNodesDefinition = CustomHierarchyNodeDefinition | InstanceNodesQueryDefinition;\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodesDefinition {\n  export function isCustomNode(def: HierarchyNodesDefinition): def is CustomHierarchyNodeDefinition {\n    return !!(def as CustomHierarchyNodeDefinition).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 * @beta\n */\nexport type HierarchyLevelDefinition = HierarchyNodesDefinition[];\n\n/**\n * A type for a function that parses a `ParsedInstanceHierarchyNode` from provided ECSQL `row` object.\n * @beta\n */\nexport type NodeParser = (row: { [columnName: string]: any }) => ParsedInstanceHierarchyNode;\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 * @beta\n */\nexport type NodePreProcessor = <TNode extends ProcessedCustomHierarchyNode | 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 * @beta\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 custom node (key is of `string` type).\n * @beta\n */\ntype HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, \"children\">;\n\n/**\n * Props for `HierarchyDefinition.defineHierarchyLevel`.\n * @beta\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 * @beta\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\n/**\n * Props for defining child hierarchy level for specific parent instance node.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineInstanceNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\"> & {\n  /** The parent instance node. */\n  parentNode: Omit<HierarchyDefinitionParentNode, \"key\"> & { key: InstancesNodeKey };\n\n  /**\n   * Full name of the parent instance node class.\n   *\n   * The `parentNode.key` also contains information about the instances the parent node is based on. However,\n   * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance\n   * keys are grouped by class and a hierarchy level definition is requested for each combination of class and\n   * instance IDs (with the same `parentNode`).\n   */\n  parentNodeClassName: string;\n\n  /**\n   * ECInstanceIds of the parent instance node.\n   *\n   * The `parentNode.key` also contains information about the instances the parent node is based on. However,\n   * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance\n   * keys are grouped by class and a hierarchy level definition is requested for each combination of class and\n   * instance IDs (with the same `parentNode`).\n   */\n  parentNodeInstanceIds: Id64String[];\n};\n\n/**\n * A definition of a hierarchy level that should be used for specific class of parent instance nodes.\n * @beta\n */\ninterface InstancesNodeChildHierarchyLevelDefinition {\n  /**\n   * Full name of the parent instance node's class to match against when checking if this hierarchy\n   * level should be used for specific parent instance node.\n   *\n   * The check is polymorphic, so `BisCore.Element` class would match `BisCore.GeometricElement`, `BisCore.Category` and\n   * all other element classes.\n   */\n  parentNodeClassName: string;\n\n  /**\n   * Called to create a hierarchy level definition when the class check passes (see `parentNodeClassName`).\n   */\n  definitions: (requestProps: DefineInstanceNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n\n  /**\n   * If set to true, and node matches at least one of the previous definitions, this definition will not be applied.\n   *\n   * For example:\n   * ```ts\n   * {\n   *   parentNodeClassName: \"BisCore.GeometricElement3d\",\n   *   definitions: () => ...,\n   * },\n   * // This will apply to all elements, that are not BisCore.GeometricElement3d\n   * {\n   *   parentNodeClassName: \"BisCore.Element\",\n   *   onlyIfNotHandled: true,\n   *   definitions: () => ...,\n   * }\n   * ```\n   */\n  onlyIfNotHandled?: boolean;\n}\n\n/**\n * Props for defining child hierarchy level for specific parent custom node.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineCustomNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\"> & {\n  /** The parent custom node. */\n  parentNode: Omit<HierarchyDefinitionParentNode, \"key\"> & { key: string };\n};\n\n/**\n * A definition of a hierarchy level for that should be used for specific custom parent nodes.\n * @beta\n */\ninterface CustomNodeChildHierarchyLevelDefinition {\n  /**\n   * `HierarchyNode.key` of the custom node that this child hierarchy level definition should be used for.\n   */\n  customParentNodeKey: string;\n\n  /**\n   * Called to create a hierarchy level definition when the node key check passes (see `customParentNodeKey`).\n   */\n  definitions: (requestProps: DefineCustomNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n}\n\n/**\n * A hierarchy level definition associated with either parent instance node's class or custom\n * node's key.\n * @beta\n */\ntype ClassBasedHierarchyLevelDefinition = InstancesNodeChildHierarchyLevelDefinition | CustomNodeChildHierarchyLevelDefinition;\n\n/**\n * Props for defining root hierarchy level.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineRootHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\">;\n\n/**\n * Props for `createClassBasedHierarchyDefinition`.\n * @beta\n */\ninterface ClassBasedHierarchyDefinitionProps {\n  /** Access to ECClass hierarchy in the iModel */\n  classHierarchyInspector: ECClassHierarchyInspector;\n\n  /** Hierarchy level definitions based on parent instance node's class or custom node's key. */\n  hierarchy: {\n    /** Called to create the root hierarchy level definition. */\n    rootNodes: (props: DefineRootHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n\n    /**\n     * Called to get child hierarchy level definitions based on parent instance node's class\n     * or custom node's key.\n     */\n    childNodes: ClassBasedHierarchyLevelDefinition[];\n  };\n}\n\n/**\n * Creates an instance of `HierarchyDefinition` that uses a somewhat declarative approach to define the\n * hierarchy - each hierarchy level is assigned either an instance node's class or custom node's\n * key and they're used to assign hierarchy level definitions based on parent node.\n *\n * @beta\n */\nexport function createClassBasedHierarchyDefinition(props: ClassBasedHierarchyDefinitionProps): HierarchyDefinition {\n  return new ClassBasedHierarchyDefinition(props);\n}\n\nclass ClassBasedHierarchyDefinition implements HierarchyDefinition {\n  public constructor(private _props: ClassBasedHierarchyDefinitionProps) {}\n\n  /**\n   * Create hierarchy level definitions for specific hierarchy level.\n   * @param parentNode Parent node to create children definitions for.\n   */\n  public async defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition> {\n    const { parentNode } = props;\n    if (!parentNode) {\n      return this._props.hierarchy.rootNodes(props);\n    }\n\n    if (HierarchyNode.isCustom(parentNode)) {\n      const defs = this._props.hierarchy.childNodes\n        .filter(isCustomNodeChildHierarchyLevelDefinition)\n        .filter((def) => def.customParentNodeKey === parentNode.key);\n      return (await Promise.all(defs.map(async (def) => def.definitions({ ...props, parentNode })))).flat();\n    }\n\n    // istanbul ignore else\n    if (HierarchyNode.isInstancesNode(parentNode)) {\n      const instanceIdsByClass = groupInstanceIdsByClass(parentNode.key.instanceKeys);\n      const instancesParentNodeDefs = this._props.hierarchy.childNodes.filter(isInstancesNodeChildHierarchyLevelDefinition);\n      return (\n        await Promise.all(\n          [...instanceIdsByClass.entries()].map(async ([parentNodeClassName, parentNodeInstanceIds]) =>\n            createHierarchyLevelDefinitions(this._props.classHierarchyInspector, instancesParentNodeDefs, {\n              ...props,\n              parentNodeClassName,\n              parentNodeInstanceIds,\n              parentNode,\n            }),\n          ),\n        )\n      ).flat();\n    }\n\n    // istanbul ignore next\n    return [];\n  }\n}\n\nasync function createHierarchyLevelDefinitions(\n  classHierarchy: ECClassHierarchyInspector,\n  defs: InstancesNodeChildHierarchyLevelDefinition[],\n  requestProps: DefineInstanceNodeChildHierarchyLevelProps,\n) {\n  const obs = from(defs).pipe(\n    mergeMap(async (def, idx) => {\n      if (await classHierarchy.classDerivesFrom(requestProps.parentNodeClassName, def.parentNodeClassName)) {\n        return { def, idx };\n      }\n      return undefined;\n    }),\n    filter((x): x is Exclude<typeof x, undefined> => !!x),\n    toArray(),\n    concatMap((x) => x.sort((a, b) => a.idx - b.idx).map(({ def }) => def)),\n    filter((def, idx) => !def.onlyIfNotHandled || idx === 0),\n    mergeMap(async (def) => def.definitions(requestProps)),\n    mergeAll(),\n  );\n  return firstValueFrom(obs.pipe(toArray()));\n}\n\nfunction groupInstanceIdsByClass(instanceKeys: InstanceKey[]) {\n  const instanceIdsByClass = new Map<string, Id64String[]>();\n  instanceKeys.forEach((key) => {\n    let instanceIds = instanceIdsByClass.get(key.className);\n    if (!instanceIds) {\n      instanceIds = [];\n      instanceIdsByClass.set(key.className, instanceIds);\n    }\n    instanceIds.push(key.id);\n  });\n  return instanceIdsByClass;\n}\n\nfunction isCustomNodeChildHierarchyLevelDefinition(def: ClassBasedHierarchyLevelDefinition): def is CustomNodeChildHierarchyLevelDefinition {\n  return !!(def as CustomNodeChildHierarchyLevelDefinition).customParentNodeKey;\n}\n\nfunction isInstancesNodeChildHierarchyLevelDefinition(def: ClassBasedHierarchyLevelDefinition): def is InstancesNodeChildHierarchyLevelDefinition {\n  return !!(def as InstancesNodeChildHierarchyLevelDefinition).parentNodeClassName;\n}\n"]}

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

@@ -1,8 +1,8 @@
 import { ConcatenatedValue, InstanceKey, OmitOverUnion, PrimitiveValue } from "@itwin/presentation-shared";
-import { HierarchyNodeIdentifiersPath } from "./HierarchyNodeIdentifier";
 import { ClassGroupingNodeKey, GroupingNodeKey, HierarchyNodeKey, InstancesNodeKey, LabelGroupingNodeKey, PropertyGroupingNodeKey, PropertyOtherValuesGroupingNodeKey, PropertyValueGroupingNodeKey, PropertyValueRangeGroupingNodeKey, StandardHierarchyNodeKey } from "./HierarchyNodeKey";
+import { HierarchyFilteringPath } from "./HierarchyProvider";
 /**
- * A data structure that represents a single non-grouping hierarchy node.
+ * A data structure that defines attributes that are common to all types of hierarchy nodes.
  * @beta
  */
 interface BaseHierarchyNode {
@@ -22,7 +22,7 @@ interface BaseHierarchyNode {
     filtering?: {
         isFilterTarget?: boolean;
         hasFilterTargetAncestor?: boolean;
-        filteredChildrenIdentifierPaths?: HierarchyNodeIdentifiersPath[];
+        filteredChildrenIdentifierPaths?: HierarchyFilteringPath[];
     };
 }
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNode.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC3G,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,iCAAiC,EACjC,wBAAwB,EACzB,MAAM,oBAAoB,CAAC;AAE5B;;;GAGG;AACH,UAAU,iBAAiB;IACzB,0FAA0F;IAC1F,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,QAAQ,EAAE,OAAO,CAAC;IAClB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACtC,oEAAoE;IACpE,SAAS,CAAC,EAAE;QACV,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,+BAA+B,CAAC,EAAE,4BAA4B,EAAE,CAAC;KAClE,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,iEAAiE;IACjE,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,2EAA2E;IAC3E,GAAG,EAAE,eAAe,CAAC;IAErB;;;OAGG;IACH,mBAAmB,EAAE,WAAW,EAAE,CAAC;IAEnC,+HAA+H;IAC/H,mBAAmB,CAAC,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;CACrE;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,wBAAwB,GAAG,qBAAqB,CAAC;AAE7E,YAAY;AAEZ,yBAAiB,aAAa,CAAC;IAC7B,qDAAqD;IACrD,SAAgB,QAAQ,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAC9D,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAAG,4BAA4B,GAAG,wBAAwB,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAEpI;IACD,8EAA8E;IAC9E,SAAgB,UAAU,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,wBAAwB,CAAA;KAAE,CAElI;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACrE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,wBAAwB,CAAC,GAAG;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,CAEhJ;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACpE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,qBAAqB,CAAC,CAEjH;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACzE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACjH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACzE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACjH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACvF,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,kCAAkC,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAC/H,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACjF,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,4BAA4B,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACzH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACtF,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,iCAAiC,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAC9H,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAC5E,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,uBAAuB,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACpH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,aAAa,IAAI,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAE1F;;;GAGG;AACH,UAAU,iCAAiC;IACzC,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,uGAAuG;IACvG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,UAAU,2BAA2B;IACnC,OAAO,CAAC,EAAE,gCAAgC,CAAC;IAC3C,OAAO,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IACpD,aAAa,CAAC,EAAE,oCAAoC,CAAC;IACrD,YAAY,CAAC,EAAE,qCAAqC,CAAC;CACtD;AAED;;;GAGG;AACH,UAAU,oCAAoC;IAC5C,yGAAyG;IACzG,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC3B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,UAAU,qCAAsC,SAAQ,oCAAoC;IAC1F,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,UAAU,qCAAsC,SAAQ,oCAAoC,EAAE,+BAA+B;IAC3H,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,OAAO,GAAG,qCAAqC,GAAG,qCAAqC,CAAC;AAEvI;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oHAAoH;IACpH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0GAA0G;IAC1G,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,6FAA6F;IAC7F,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG,QAAQ,CAAC;AAEpE;;;GAGG;AACH,UAAU,oCAAqC,SAAQ,+BAA+B;IACpF;;;;;OAKG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAsC,SAAQ,+BAA+B;IAC5F;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,EAAE,0BAA0B,EAAE,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,gEAAgE;IAChE,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,8FAA8F;IAC9F,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,sGAAsG;IACtG,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAsC,SAAQ,iCAAiC;IAC9F,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAC9F,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,iCAAiC,CAAC;CACtD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAChG,GAAG,EAAE,gBAAgB,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,qCAAqC,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG;IACrF,QAAQ,EAAE,KAAK,CAAC,8BAA8B,GAAG,8BAA8B,CAAC,CAAC;CAClF,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,4BAA4B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC;AAEpI;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,yBAAyB,GAAG,2BAA2B,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAAC,GAAG;IAChJ,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,CAAC,8BAA8B,CAAC,CAAC"}
+{"version":3,"file":"HierarchyNode.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC3G,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,iCAAiC,EACjC,wBAAwB,EACzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,UAAU,iBAAiB;IACzB,0FAA0F;IAC1F,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,QAAQ,EAAE,OAAO,CAAC;IAClB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACtC,oEAAoE;IACpE,SAAS,CAAC,EAAE;QACV,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,+BAA+B,CAAC,EAAE,sBAAsB,EAAE,CAAC;KAC5D,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,iEAAiE;IACjE,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,2EAA2E;IAC3E,GAAG,EAAE,eAAe,CAAC;IAErB;;;OAGG;IACH,mBAAmB,EAAE,WAAW,EAAE,CAAC;IAEnC,+HAA+H;IAC/H,mBAAmB,CAAC,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;CACrE;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,wBAAwB,GAAG,qBAAqB,CAAC;AAE7E,YAAY;AAEZ,yBAAiB,aAAa,CAAC;IAC7B,qDAAqD;IACrD,SAAgB,QAAQ,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAC9D,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAAG,4BAA4B,GAAG,wBAAwB,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAEpI;IACD,8EAA8E;IAC9E,SAAgB,UAAU,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,wBAAwB,CAAA;KAAE,CAElI;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACrE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,wBAAwB,CAAC,GAAG;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,CAEhJ;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACpE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAAG,8BAA8B,GAAG,qBAAqB,CAAC,CAEjH;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACzE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACjH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACzE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACjH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACvF,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,kCAAkC,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAC/H,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACjF,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,4BAA4B,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACzH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACtF,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,iCAAiC,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GAC9H,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAC5E,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,uBAAuB,CAAC;QAAC,iBAAiB,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,CAAC,KAAK,SAAS,sBAAsB,GACpH,8BAA8B,GAC9B,qBAAqB,CAAC,CAE3B;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,aAAa,IAAI,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAE1F;;;GAGG;AACH,UAAU,iCAAiC;IACzC,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,uGAAuG;IACvG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,UAAU,2BAA2B;IACnC,OAAO,CAAC,EAAE,gCAAgC,CAAC;IAC3C,OAAO,CAAC,EAAE,OAAO,GAAG,+BAA+B,CAAC;IACpD,aAAa,CAAC,EAAE,oCAAoC,CAAC;IACrD,YAAY,CAAC,EAAE,qCAAqC,CAAC;CACtD;AAED;;;GAGG;AACH,UAAU,oCAAoC;IAC5C,yGAAyG;IACzG,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC3B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,UAAU,qCAAsC,SAAQ,oCAAoC;IAC1F,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,UAAU,qCAAsC,SAAQ,oCAAoC,EAAE,+BAA+B;IAC3H,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,OAAO,GAAG,qCAAqC,GAAG,qCAAqC,CAAC;AAEvI;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oHAAoH;IACpH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0GAA0G;IAC1G,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,6FAA6F;IAC7F,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG,QAAQ,CAAC;AAEpE;;;GAGG;AACH,UAAU,oCAAqC,SAAQ,+BAA+B;IACpF;;;;;OAKG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAsC,SAAQ,+BAA+B;IAC5F;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,EAAE,0BAA0B,EAAE,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,gEAAgE;IAChE,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,8FAA8F;IAC9F,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,sGAAsG;IACtG,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAsC,SAAQ,iCAAiC;IAC9F,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAC9F,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,iCAAiC,CAAC;CACtD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAChG,GAAG,EAAE,gBAAgB,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,qCAAqC,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG;IACrF,QAAQ,EAAE,KAAK,CAAC,8BAA8B,GAAG,8BAA8B,CAAC,CAAC;CAClF,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,GAAG,4BAA4B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC;AAEpI;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,yBAAyB,GAAG,2BAA2B,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAAC,GAAG;IAChJ,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,CAAC,8BAA8B,CAAC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNode.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAIhG,yDAW4B;AA+D5B,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,aAAa,CAuE7B;AAvED,WAAiB,aAAa;IAC5B,qDAAqD;IACrD,SAAgB,QAAQ,CACtB,IAAW;QAEX,OAAO,mCAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAJe,sBAAQ,WAIvB,CAAA;IACD,8EAA8E;IAC9E,SAAgB,UAAU,CAA0C,IAAW;QAC7E,OAAO,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAFe,wBAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAC7B,IAAW;QAEX,OAAO,mCAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAJe,6BAAe,kBAI9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAC5B,IAAW;QAEX,OAAO,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAJe,4BAAc,iBAI7B,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAIX,OAAO,mCAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IANe,iCAAmB,sBAMlC,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAIX,OAAO,mCAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IANe,iCAAmB,sBAMlC,CAAA;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAC/C,IAAW;QAIX,OAAO,mCAAgB,CAAC,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IANe,+CAAiC,oCAMhD,CAAA;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CACzC,IAAW;QAIX,OAAO,mCAAgB,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IANe,yCAA2B,8BAM1C,CAAA;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAC9C,IAAW;QAIX,OAAO,mCAAgB,CAAC,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IANe,8CAAgC,mCAM/C,CAAA;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CACpC,IAAW;QAIX,OAAO,mCAAgB,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IANe,oCAAsB,yBAMrC,CAAA;AACH,CAAC,EAvEgB,aAAa,6BAAb,aAAa,QAuE7B","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 { ConcatenatedValue, InstanceKey, OmitOverUnion, PrimitiveValue } from \"@itwin/presentation-shared\";\nimport { HierarchyNodeIdentifiersPath } from \"./HierarchyNodeIdentifier\";\nimport {\n  ClassGroupingNodeKey,\n  GroupingNodeKey,\n  HierarchyNodeKey,\n  InstancesNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n  StandardHierarchyNodeKey,\n} from \"./HierarchyNodeKey\";\n\n/**\n * A data structure that represents a single non-grouping hierarchy node.\n * @beta\n */\ninterface BaseHierarchyNode {\n  /** Identifiers of all node ancestors. Can be used to identify a node in the hierarchy. */\n  parentKeys: HierarchyNodeKey[];\n  /** Node's display label. */\n  label: string;\n  /** A flag indicating whether the node has children or not. */\n  children: boolean;\n  /** A flag indicating whether this node should be auto-expanded in the UI. */\n  autoExpand?: boolean;\n  /** Additional data that may be assigned to this node. */\n  extendedData?: { [key: string]: any };\n  /** Data that may be assigned to the node if filtering is enabled */\n  filtering?: {\n    isFilterTarget?: boolean;\n    hasFilterTargetAncestor?: boolean;\n    filteredChildrenIdentifierPaths?: HierarchyNodeIdentifiersPath[];\n  };\n}\n\n/**\n * A data structure that represents a single non-grouping hierarchy node.\n * @beta\n */\nexport interface NonGroupingHierarchyNode extends BaseHierarchyNode {\n  /** An identifier to identify the node in its hierarchy level. */\n  key: string | InstancesNodeKey;\n  /**\n   * Identifies whether the hierarchy level below this node supports filtering. If not, supplying an instance\n   * filter when requesting child hierarchy level will have no effect.\n   */\n  supportsFiltering?: boolean;\n}\n\n/**\n * A data structure that represents a grouping node that groups other nodes.\n * @beta\n */\nexport interface GroupingHierarchyNode extends BaseHierarchyNode {\n  /** An identifier to identify this grouping node in its hierarchy level. */\n  key: GroupingNodeKey;\n\n  /**\n   * Keys of all instances grouped by this node, including deeply nested under\n   * other grouping nodes.\n   */\n  groupedInstanceKeys: InstanceKey[];\n\n  /** The closest ancestor node that is not a grouping node. May be `undefined` if the grouping node grouped root level nodes. */\n  nonGroupingAncestor?: ParentHierarchyNode<NonGroupingHierarchyNode>;\n}\n\n/**\n * A data structure that represents a single hierarchy node.\n * @beta\n */\nexport type HierarchyNode = NonGroupingHierarchyNode | GroupingHierarchyNode;\n\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNode {\n  /** Checks whether the given node is a custom node */\n  export function isCustom<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & (TNode extends ProcessedHierarchyNode ? ProcessedCustomHierarchyNode : NonGroupingHierarchyNode) & { key: string } {\n    return HierarchyNodeKey.isCustom(node.key);\n  }\n  /** Checks whether the given node is a standard (iModel content based) node */\n  export function isStandard<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & { key: StandardHierarchyNodeKey } {\n    return HierarchyNodeKey.isStandard(node.key);\n  }\n  /** Checks whether the given node is an ECInstances-based node */\n  export function isInstancesNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & (TNode extends ProcessedHierarchyNode ? ProcessedInstanceHierarchyNode : NonGroupingHierarchyNode) & { key: InstancesNodeKey } {\n    return HierarchyNodeKey.isInstances(node.key);\n  }\n  /** Checks whether the given node is a grouping node */\n  export function isGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & (TNode extends ProcessedHierarchyNode ? ProcessedGroupingHierarchyNode : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isGrouping(node.key);\n  }\n  /** Checks whether the given node is a class grouping node */\n  export function isClassGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: ClassGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isClassGrouping(node.key);\n  }\n  /** Checks whether the given node is a label grouping node */\n  export function isLabelGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: LabelGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isLabelGrouping(node.key);\n  }\n  /** Checks whether the given node is property grouping node for other values  */\n  export function isPropertyOtherValuesGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyOtherValuesGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyOtherValuesGrouping(node.key);\n  }\n  /** Checks whether the given node is a property value grouping node */\n  export function isPropertyValueGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyValueGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyValueGrouping(node.key);\n  }\n  /** Checks whether the given node is a property value range grouping node */\n  export function isPropertyValueRangeGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyValueRangeGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyValueRangeGrouping(node.key);\n  }\n  /** Checks whether the given node is a property grouping node */\n  export function isPropertyGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyGrouping(node.key);\n  }\n}\n\n/**\n * A type of `HierarchyNode` that doesn't know about its children and is an input when requesting\n * them using `HierarchyProvider.getNodes`.\n * @beta\n */\nexport type ParentHierarchyNode<TBase = HierarchyNode> = OmitOverUnion<TBase, \"children\">;\n\n/**\n * Base processing parameters that apply to every node.\n * @beta\n */\ninterface HierarchyNodeProcessingParamsBase {\n  /** Indicates if this node should be hidden if it has no child nodes. */\n  hideIfNoChildren?: boolean;\n  /** Indicates that this node should always be hidden and its children should be loaded in its place. */\n  hideInHierarchy?: boolean;\n}\n\n/**\n * A data structure for defining nodes' grouping requirements.\n * @beta\n */\ninterface HierarchyNodeGroupingParams {\n  byLabel?: HierarchyNodeLabelGroupingParams;\n  byClass?: boolean | HierarchyNodeGroupingParamsBase;\n  byBaseClasses?: HierarchyNodeBaseClassGroupingParams;\n  byProperties?: HierarchyNodePropertiesGroupingParams;\n}\n\n/**\n * A data structure for defining params specifically used for label grouping.\n * @beta\n */\ninterface HierarchyNodeLabelGroupingBaseParams {\n  /** Label grouping option that determines whether to group nodes or to merge them. Defaults to \"group\".*/\n  action?: \"group\" | \"merge\";\n  /** Value that needs to match in order for nodes to be grouped or merged.*/\n  groupId?: string;\n}\n\n/**\n * A data structure for defining label merging.\n * @beta\n */\ninterface HierarchyNodeLabelGroupingMergeParams extends HierarchyNodeLabelGroupingBaseParams {\n  action: \"merge\";\n}\n\n/**\n * A data structure for defining label grouping with additional parameters.\n * @beta\n */\ninterface HierarchyNodeLabelGroupingGroupParams extends HierarchyNodeLabelGroupingBaseParams, HierarchyNodeGroupingParamsBase {\n  action?: \"group\";\n}\n\n/**\n * A data structure for defining possible label grouping types.\n * @beta\n */\nexport type HierarchyNodeLabelGroupingParams = boolean | HierarchyNodeLabelGroupingMergeParams | HierarchyNodeLabelGroupingGroupParams;\n\n/**\n * Grouping parameters that are shared across all types of groupings.\n * @beta\n */\nexport interface HierarchyNodeGroupingParamsBase {\n  /** Hiding option that determines whether to hide group nodes which have no siblings at the same hierarchy level. */\n  hideIfNoSiblings?: boolean;\n  /** Hiding option that determines whether to hide group nodes which have only one node as its children. */\n  hideIfOneGroupedNode?: boolean;\n  /** Option which auto expands grouping nodes' children when it has single child or always. */\n  autoExpand?: HierarchyNodeAutoExpandProp;\n}\n\n/**\n * Defines possible values for `BaseGroupingParams.autoExpand` attribute:\n * - `single-child` - set the grouping node to auto-expand if it groups a single node.\n * - `always` - always set the grouping node to auto-expand.\n * @beta\n */\nexport type HierarchyNodeAutoExpandProp = \"single-child\" | \"always\";\n\n/**\n * A data structure that represents base class grouping.\n * @beta\n */\ninterface HierarchyNodeBaseClassGroupingParams extends HierarchyNodeGroupingParamsBase {\n  /**\n   * Full names of classes, which should be used to group the node. Only has effect if the node\n   * represents an instance of that class.\n   *\n   * Full class name format: `SchemaName.ClassName`.\n   */\n  fullClassNames: string[];\n}\n\n/**\n * A data structure that represents properties grouping.\n * @beta\n */\nexport interface HierarchyNodePropertiesGroupingParams extends HierarchyNodeGroupingParamsBase {\n  /**\n   * Full name of a class whose properties are used to group the node. Only has effect if the node\n   * represents an instance of that class.\n   *\n   * Full class name format: `SchemaName.ClassName`.\n   */\n  propertiesClassName: string;\n  /**\n   * Property grouping option that determines whether to group nodes whose grouping value is not set or is set to an empty string.\n   *\n   * Label of the created grouping node will be `Not Specified`.\n   */\n  createGroupForUnspecifiedValues?: boolean;\n  /**\n   * Property grouping option that determines whether to group nodes whose grouping value doesn't fit within any of the provided\n   * ranges, or is not a numeric value.\n   *\n   * Label of the created grouping node will be `Other`.\n   */\n  createGroupForOutOfRangeValues?: boolean;\n  /**\n   * Properties of the specified class, by which the nodes should be grouped. Each provided group definition results in a\n   * grouping hierarchy level.\n   *\n   * Example usage:\n   * ```ts\n   * propertyGroups: [\n   *   {\n   *     propertyName: \"type\",\n   *     propertyValue: \"Wall\"\n   *   },\n   *   {\n   *     propertyName: \"length\",\n   *     propertyValue: 15,\n   *     ranges: [\n   *       { fromValue: 1, toValue: 10, rangeLabel: \"Small\" },\n   *       { fromValue: 11, toValue: 20, rangeLabel: \"Medium\" }\n   *     ]\n   *   },\n   * ]\n   * ```\n   */\n  propertyGroups: HierarchyNodePropertyGroup[];\n}\n\n/**\n * A data structure that represents specific properties' grouping params.\n * @beta\n */\nexport interface HierarchyNodePropertyGroup {\n  /** A string indicating the name of the property to group by. */\n  propertyName: string;\n  /**  Value of the property, which will be used to group the node. */\n  propertyValue?: PrimitiveValue;\n  /** Ranges are used to group nodes by numeric properties which are within specified bounds. */\n  ranges?: HierarchyNodePropertyValueRange[];\n}\n\n/**\n * A data structure that represents boundaries for a value.\n * @beta\n */\nexport interface HierarchyNodePropertyValueRange {\n  /** Defines the lower bound of the range. */\n  fromValue: number;\n  /** Defines the upper bound of the range. */\n  toValue: number;\n  /** Defines the range label. Will be used as `PropertyValueRangeGroupingNode` node's display label. */\n  rangeLabel?: string;\n}\n\n/**\n * Processing parameters that apply to instance nodes.\n * @beta\n */\nexport interface InstanceHierarchyNodeProcessingParams extends HierarchyNodeProcessingParamsBase {\n  grouping?: HierarchyNodeGroupingParams;\n}\n\n/**\n * A custom (not based on data in an iModel) node that has processing parameters.\n * @beta\n */\nexport type ProcessedCustomHierarchyNode = Omit<NonGroupingHierarchyNode, \"key\" | \"children\"> & {\n  key: string;\n  children?: boolean;\n  processingParams?: HierarchyNodeProcessingParamsBase;\n};\n\n/**\n * An instances' (based on data in an iModel) node that has processing parameters.\n * @beta\n */\nexport type ProcessedInstanceHierarchyNode = Omit<NonGroupingHierarchyNode, \"key\" | \"children\"> & {\n  key: InstancesNodeKey;\n  children?: boolean;\n  processingParams?: InstanceHierarchyNodeProcessingParams;\n};\n\n/**\n * A grouping node that groups either instance nodes or other grouping nodes.\n * @beta\n */\nexport type ProcessedGroupingHierarchyNode = Omit<GroupingHierarchyNode, \"children\"> & {\n  children: Array<ProcessedGroupingHierarchyNode | ProcessedInstanceHierarchyNode>;\n};\n\n/**\n * A `HierarchyNode` that may have processing parameters defining whether it should be hidden under some conditions,\n * how it should be grouped, sorted, etc.\n *\n * Type guards under `HierarchyNode` namespace can be used to differentiate between different sub-types of\n * `ProcessedHierarchyNode`.\n *\n * @beta\n */\nexport type ProcessedHierarchyNode = ProcessedCustomHierarchyNode | ProcessedInstanceHierarchyNode | ProcessedGroupingHierarchyNode;\n\n/**\n * A `ProcessedHierarchyNode` that has an unformatted label in a form of `ConcatenatedValue`. Generally this is\n * returned when the node is just parsed from query results.\n * @beta\n */\nexport type ParsedHierarchyNode<TBase = ParsedCustomHierarchyNode | ParsedInstanceHierarchyNode> = OmitOverUnion<TBase, \"label\" | \"parentKeys\"> & {\n  label: string | ConcatenatedValue;\n};\n\n/**\n * A kind of `ProcessedCustomHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @beta\n */\nexport type ParsedCustomHierarchyNode = ParsedHierarchyNode<ProcessedCustomHierarchyNode>;\n\n/**\n * A kind of `ProcessedInstanceHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @beta\n */\nexport type ParsedInstanceHierarchyNode = ParsedHierarchyNode<ProcessedInstanceHierarchyNode>;\n"]}
+{"version":3,"file":"HierarchyNode.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAGhG,yDAW4B;AAgE5B,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,aAAa,CAuE7B;AAvED,WAAiB,aAAa;IAC5B,qDAAqD;IACrD,SAAgB,QAAQ,CACtB,IAAW;QAEX,OAAO,mCAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAJe,sBAAQ,WAIvB,CAAA;IACD,8EAA8E;IAC9E,SAAgB,UAAU,CAA0C,IAAW;QAC7E,OAAO,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAFe,wBAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAC7B,IAAW;QAEX,OAAO,mCAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAJe,6BAAe,kBAI9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAC5B,IAAW;QAEX,OAAO,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAJe,4BAAc,iBAI7B,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAIX,OAAO,mCAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IANe,iCAAmB,sBAMlC,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAIX,OAAO,mCAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IANe,iCAAmB,sBAMlC,CAAA;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAC/C,IAAW;QAIX,OAAO,mCAAgB,CAAC,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IANe,+CAAiC,oCAMhD,CAAA;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CACzC,IAAW;QAIX,OAAO,mCAAgB,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IANe,yCAA2B,8BAM1C,CAAA;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAC9C,IAAW;QAIX,OAAO,mCAAgB,CAAC,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IANe,8CAAgC,mCAM/C,CAAA;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CACpC,IAAW;QAIX,OAAO,mCAAgB,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IANe,oCAAsB,yBAMrC,CAAA;AACH,CAAC,EAvEgB,aAAa,6BAAb,aAAa,QAuE7B","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 { ConcatenatedValue, InstanceKey, OmitOverUnion, PrimitiveValue } from \"@itwin/presentation-shared\";\nimport {\n  ClassGroupingNodeKey,\n  GroupingNodeKey,\n  HierarchyNodeKey,\n  InstancesNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n  StandardHierarchyNodeKey,\n} from \"./HierarchyNodeKey\";\nimport { HierarchyFilteringPath } from \"./HierarchyProvider\";\n\n/**\n * A data structure that defines attributes that are common to all types of hierarchy nodes.\n * @beta\n */\ninterface BaseHierarchyNode {\n  /** Identifiers of all node ancestors. Can be used to identify a node in the hierarchy. */\n  parentKeys: HierarchyNodeKey[];\n  /** Node's display label. */\n  label: string;\n  /** A flag indicating whether the node has children or not. */\n  children: boolean;\n  /** A flag indicating whether this node should be auto-expanded in the UI. */\n  autoExpand?: boolean;\n  /** Additional data that may be assigned to this node. */\n  extendedData?: { [key: string]: any };\n  /** Data that may be assigned to the node if filtering is enabled */\n  filtering?: {\n    isFilterTarget?: boolean;\n    hasFilterTargetAncestor?: boolean;\n    filteredChildrenIdentifierPaths?: HierarchyFilteringPath[];\n  };\n}\n\n/**\n * A data structure that represents a single non-grouping hierarchy node.\n * @beta\n */\nexport interface NonGroupingHierarchyNode extends BaseHierarchyNode {\n  /** An identifier to identify the node in its hierarchy level. */\n  key: string | InstancesNodeKey;\n  /**\n   * Identifies whether the hierarchy level below this node supports filtering. If not, supplying an instance\n   * filter when requesting child hierarchy level will have no effect.\n   */\n  supportsFiltering?: boolean;\n}\n\n/**\n * A data structure that represents a grouping node that groups other nodes.\n * @beta\n */\nexport interface GroupingHierarchyNode extends BaseHierarchyNode {\n  /** An identifier to identify this grouping node in its hierarchy level. */\n  key: GroupingNodeKey;\n\n  /**\n   * Keys of all instances grouped by this node, including deeply nested under\n   * other grouping nodes.\n   */\n  groupedInstanceKeys: InstanceKey[];\n\n  /** The closest ancestor node that is not a grouping node. May be `undefined` if the grouping node grouped root level nodes. */\n  nonGroupingAncestor?: ParentHierarchyNode<NonGroupingHierarchyNode>;\n}\n\n/**\n * A data structure that represents a single hierarchy node.\n * @beta\n */\nexport type HierarchyNode = NonGroupingHierarchyNode | GroupingHierarchyNode;\n\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNode {\n  /** Checks whether the given node is a custom node */\n  export function isCustom<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & (TNode extends ProcessedHierarchyNode ? ProcessedCustomHierarchyNode : NonGroupingHierarchyNode) & { key: string } {\n    return HierarchyNodeKey.isCustom(node.key);\n  }\n  /** Checks whether the given node is a standard (iModel content based) node */\n  export function isStandard<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & { key: StandardHierarchyNodeKey } {\n    return HierarchyNodeKey.isStandard(node.key);\n  }\n  /** Checks whether the given node is an ECInstances-based node */\n  export function isInstancesNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & (TNode extends ProcessedHierarchyNode ? ProcessedInstanceHierarchyNode : NonGroupingHierarchyNode) & { key: InstancesNodeKey } {\n    return HierarchyNodeKey.isInstances(node.key);\n  }\n  /** Checks whether the given node is a grouping node */\n  export function isGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & (TNode extends ProcessedHierarchyNode ? ProcessedGroupingHierarchyNode : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isGrouping(node.key);\n  }\n  /** Checks whether the given node is a class grouping node */\n  export function isClassGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: ClassGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isClassGrouping(node.key);\n  }\n  /** Checks whether the given node is a label grouping node */\n  export function isLabelGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: LabelGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isLabelGrouping(node.key);\n  }\n  /** Checks whether the given node is property grouping node for other values  */\n  export function isPropertyOtherValuesGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyOtherValuesGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyOtherValuesGrouping(node.key);\n  }\n  /** Checks whether the given node is a property value grouping node */\n  export function isPropertyValueGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyValueGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyValueGrouping(node.key);\n  }\n  /** Checks whether the given node is a property value range grouping node */\n  export function isPropertyValueRangeGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyValueRangeGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyValueRangeGrouping(node.key);\n  }\n  /** Checks whether the given node is a property grouping node */\n  export function isPropertyGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyGroupingNodeKey; supportsFiltering?: undefined } & (TNode extends ProcessedHierarchyNode\n      ? ProcessedGroupingHierarchyNode\n      : GroupingHierarchyNode) {\n    return HierarchyNodeKey.isPropertyGrouping(node.key);\n  }\n}\n\n/**\n * A type of `HierarchyNode` that doesn't know about its children and is an input when requesting\n * them using `HierarchyProvider.getNodes`.\n * @beta\n */\nexport type ParentHierarchyNode<TBase = HierarchyNode> = OmitOverUnion<TBase, \"children\">;\n\n/**\n * Base processing parameters that apply to every node.\n * @beta\n */\ninterface HierarchyNodeProcessingParamsBase {\n  /** Indicates if this node should be hidden if it has no child nodes. */\n  hideIfNoChildren?: boolean;\n  /** Indicates that this node should always be hidden and its children should be loaded in its place. */\n  hideInHierarchy?: boolean;\n}\n\n/**\n * A data structure for defining nodes' grouping requirements.\n * @beta\n */\ninterface HierarchyNodeGroupingParams {\n  byLabel?: HierarchyNodeLabelGroupingParams;\n  byClass?: boolean | HierarchyNodeGroupingParamsBase;\n  byBaseClasses?: HierarchyNodeBaseClassGroupingParams;\n  byProperties?: HierarchyNodePropertiesGroupingParams;\n}\n\n/**\n * A data structure for defining params specifically used for label grouping.\n * @beta\n */\ninterface HierarchyNodeLabelGroupingBaseParams {\n  /** Label grouping option that determines whether to group nodes or to merge them. Defaults to \"group\".*/\n  action?: \"group\" | \"merge\";\n  /** Value that needs to match in order for nodes to be grouped or merged.*/\n  groupId?: string;\n}\n\n/**\n * A data structure for defining label merging.\n * @beta\n */\ninterface HierarchyNodeLabelGroupingMergeParams extends HierarchyNodeLabelGroupingBaseParams {\n  action: \"merge\";\n}\n\n/**\n * A data structure for defining label grouping with additional parameters.\n * @beta\n */\ninterface HierarchyNodeLabelGroupingGroupParams extends HierarchyNodeLabelGroupingBaseParams, HierarchyNodeGroupingParamsBase {\n  action?: \"group\";\n}\n\n/**\n * A data structure for defining possible label grouping types.\n * @beta\n */\nexport type HierarchyNodeLabelGroupingParams = boolean | HierarchyNodeLabelGroupingMergeParams | HierarchyNodeLabelGroupingGroupParams;\n\n/**\n * Grouping parameters that are shared across all types of groupings.\n * @beta\n */\nexport interface HierarchyNodeGroupingParamsBase {\n  /** Hiding option that determines whether to hide group nodes which have no siblings at the same hierarchy level. */\n  hideIfNoSiblings?: boolean;\n  /** Hiding option that determines whether to hide group nodes which have only one node as its children. */\n  hideIfOneGroupedNode?: boolean;\n  /** Option which auto expands grouping nodes' children when it has single child or always. */\n  autoExpand?: HierarchyNodeAutoExpandProp;\n}\n\n/**\n * Defines possible values for `BaseGroupingParams.autoExpand` attribute:\n * - `single-child` - set the grouping node to auto-expand if it groups a single node.\n * - `always` - always set the grouping node to auto-expand.\n * @beta\n */\nexport type HierarchyNodeAutoExpandProp = \"single-child\" | \"always\";\n\n/**\n * A data structure that represents base class grouping.\n * @beta\n */\ninterface HierarchyNodeBaseClassGroupingParams extends HierarchyNodeGroupingParamsBase {\n  /**\n   * Full names of classes, which should be used to group the node. Only has effect if the node\n   * represents an instance of that class.\n   *\n   * Full class name format: `SchemaName.ClassName`.\n   */\n  fullClassNames: string[];\n}\n\n/**\n * A data structure that represents properties grouping.\n * @beta\n */\nexport interface HierarchyNodePropertiesGroupingParams extends HierarchyNodeGroupingParamsBase {\n  /**\n   * Full name of a class whose properties are used to group the node. Only has effect if the node\n   * represents an instance of that class.\n   *\n   * Full class name format: `SchemaName.ClassName`.\n   */\n  propertiesClassName: string;\n  /**\n   * Property grouping option that determines whether to group nodes whose grouping value is not set or is set to an empty string.\n   *\n   * Label of the created grouping node will be `Not Specified`.\n   */\n  createGroupForUnspecifiedValues?: boolean;\n  /**\n   * Property grouping option that determines whether to group nodes whose grouping value doesn't fit within any of the provided\n   * ranges, or is not a numeric value.\n   *\n   * Label of the created grouping node will be `Other`.\n   */\n  createGroupForOutOfRangeValues?: boolean;\n  /**\n   * Properties of the specified class, by which the nodes should be grouped. Each provided group definition results in a\n   * grouping hierarchy level.\n   *\n   * Example usage:\n   * ```ts\n   * propertyGroups: [\n   *   {\n   *     propertyName: \"type\",\n   *     propertyValue: \"Wall\"\n   *   },\n   *   {\n   *     propertyName: \"length\",\n   *     propertyValue: 15,\n   *     ranges: [\n   *       { fromValue: 1, toValue: 10, rangeLabel: \"Small\" },\n   *       { fromValue: 11, toValue: 20, rangeLabel: \"Medium\" }\n   *     ]\n   *   },\n   * ]\n   * ```\n   */\n  propertyGroups: HierarchyNodePropertyGroup[];\n}\n\n/**\n * A data structure that represents specific properties' grouping params.\n * @beta\n */\nexport interface HierarchyNodePropertyGroup {\n  /** A string indicating the name of the property to group by. */\n  propertyName: string;\n  /**  Value of the property, which will be used to group the node. */\n  propertyValue?: PrimitiveValue;\n  /** Ranges are used to group nodes by numeric properties which are within specified bounds. */\n  ranges?: HierarchyNodePropertyValueRange[];\n}\n\n/**\n * A data structure that represents boundaries for a value.\n * @beta\n */\nexport interface HierarchyNodePropertyValueRange {\n  /** Defines the lower bound of the range. */\n  fromValue: number;\n  /** Defines the upper bound of the range. */\n  toValue: number;\n  /** Defines the range label. Will be used as `PropertyValueRangeGroupingNode` node's display label. */\n  rangeLabel?: string;\n}\n\n/**\n * Processing parameters that apply to instance nodes.\n * @beta\n */\nexport interface InstanceHierarchyNodeProcessingParams extends HierarchyNodeProcessingParamsBase {\n  grouping?: HierarchyNodeGroupingParams;\n}\n\n/**\n * A custom (not based on data in an iModel) node that has processing parameters.\n * @beta\n */\nexport type ProcessedCustomHierarchyNode = Omit<NonGroupingHierarchyNode, \"key\" | \"children\"> & {\n  key: string;\n  children?: boolean;\n  processingParams?: HierarchyNodeProcessingParamsBase;\n};\n\n/**\n * An instances' (based on data in an iModel) node that has processing parameters.\n * @beta\n */\nexport type ProcessedInstanceHierarchyNode = Omit<NonGroupingHierarchyNode, \"key\" | \"children\"> & {\n  key: InstancesNodeKey;\n  children?: boolean;\n  processingParams?: InstanceHierarchyNodeProcessingParams;\n};\n\n/**\n * A grouping node that groups either instance nodes or other grouping nodes.\n * @beta\n */\nexport type ProcessedGroupingHierarchyNode = Omit<GroupingHierarchyNode, \"children\"> & {\n  children: Array<ProcessedGroupingHierarchyNode | ProcessedInstanceHierarchyNode>;\n};\n\n/**\n * A `HierarchyNode` that may have processing parameters defining whether it should be hidden under some conditions,\n * how it should be grouped, sorted, etc.\n *\n * Type guards under `HierarchyNode` namespace can be used to differentiate between different sub-types of\n * `ProcessedHierarchyNode`.\n *\n * @beta\n */\nexport type ProcessedHierarchyNode = ProcessedCustomHierarchyNode | ProcessedInstanceHierarchyNode | ProcessedGroupingHierarchyNode;\n\n/**\n * A `ProcessedHierarchyNode` that has an unformatted label in a form of `ConcatenatedValue`. Generally this is\n * returned when the node is just parsed from query results.\n * @beta\n */\nexport type ParsedHierarchyNode<TBase = ParsedCustomHierarchyNode | ParsedInstanceHierarchyNode> = OmitOverUnion<TBase, \"label\" | \"parentKeys\"> & {\n  label: string | ConcatenatedValue;\n};\n\n/**\n * A kind of `ProcessedCustomHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @beta\n */\nexport type ParsedCustomHierarchyNode = ParsedHierarchyNode<ProcessedCustomHierarchyNode>;\n\n/**\n * A kind of `ProcessedInstanceHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @beta\n */\nexport type ParsedInstanceHierarchyNode = ParsedHierarchyNode<ProcessedInstanceHierarchyNode>;\n"]}

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

@@ -57,6 +57,16 @@ interface HierarchyProviderLocalizedStrings {
      */
     other: string;
 }
+/**
+ * A path of hierarchy node identifiers for filtering the hierarchy with additional options.
+ * @beta
+ */
+export type HierarchyFilteringPath = HierarchyNodeIdentifiersPath | {
+    path: HierarchyNodeIdentifiersPath;
+    options?: {
+        autoExpand?: boolean;
+    };
+};
 /**
  * Props for `createHierarchyProvider`.
  * @beta
@@ -92,7 +102,7 @@ interface HierarchyProviderProps {
     /** Props for filtering the hierarchy. */
     filtering?: {
         /** A list of node identifiers from root to target node. */
-        paths: HierarchyNodeIdentifiersPath[];
+        paths: HierarchyFilteringPath[];
     };
 }
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyProvider.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAGL,yBAAyB,EACzB,gBAAgB,EAIhB,WAAW,EACX,wBAAwB,EAEzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAA6B,mBAAmB,EAA4B,MAAM,uBAAuB,CAAC;AAEjH,OAAO,EACL,aAAa,EAEb,mBAAmB,EAMpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AAiBzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAQ1E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,2EAA2E;IAC3E,UAAU,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE5C,0FAA0F;IAC1F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAE/C,sEAAsE;IACtE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE9E,wDAAwD;IACxD,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAE5G,0GAA0G;IAC1G,uBAAuB,IAAI,IAAI,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,GAAG,IAAI,CAAC;CACrE;AAED;;;GAGG;AACH,UAAU,iCAAiC;IACzC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,UAAU,sBAAsB;IAC9B;;;;;;OAMG;IACH,YAAY,EAAE,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,CAAC;IAExF;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC,qGAAqG;IACrG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IAErC,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC;IAE9D,yCAAyC;IACzC,SAAS,CAAC,EAAE;QACV,2DAA2D;QAC3D,KAAK,EAAE,4BAA4B,EAAE,CAAC;KACvC,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,sBAAsB,GAAG,iBAAiB,CAExF"}
+{"version":3,"file":"HierarchyProvider.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAGL,yBAAyB,EACzB,gBAAgB,EAIhB,WAAW,EACX,wBAAwB,EAEzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAA6B,mBAAmB,EAA4B,MAAM,uBAAuB,CAAC;AAEjH,OAAO,EACL,aAAa,EAEb,mBAAmB,EAMpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AAuBzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAU1E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,2EAA2E;IAC3E,UAAU,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE5C,0FAA0F;IAC1F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAE/C,sEAAsE;IACtE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE9E,wDAAwD;IACxD,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAE5G,0GAA0G;IAC1G,uBAAuB,IAAI,IAAI,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,GAAG,IAAI,CAAC;CACrE;AAED;;;GAGG;AACH,UAAU,iCAAiC;IACzC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,4BAA4B,GAAG;IAAE,IAAI,EAAE,4BAA4B,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,CAAC;AAE/I;;;GAGG;AACH,UAAU,sBAAsB;IAC9B;;;;;;OAMG;IACH,YAAY,EAAE,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,CAAC;IAExF;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC,qGAAqG;IACrG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IAErC,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC;IAE9D,yCAAyC;IACzC,SAAS,CAAC,EAAE;QACV,2DAA2D;QAC3D,KAAK,EAAE,sBAAsB,EAAE,CAAC;KACjC,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,sBAAsB,GAAG,iBAAiB,CAExF"}

package/lib/cjs/hierarchies/HierarchyProvider.js

@@ -4,7 +4,7 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHierarchyProvider = void 0;
+exports.createHierarchyProvider = createHierarchyProvider;
 const rxjs_1 = require("rxjs");
 const core_bentley_1 = require("@itwin/core-bentley");
 const presentation_shared_1 = require("@itwin/presentation-shared");
@@ -27,8 +27,9 @@ const Sorting_1 = require("./internal/operators/Sorting");
 const SubscriptionScheduler_1 = require("./internal/SubscriptionScheduler");
 const TreeNodesReader_1 = require("./internal/TreeNodesReader");
 const NodeSelectQueryFactory_1 = require("./NodeSelectQueryFactory");
-const LOGGING_NAMESPACE = `${Common_1.LOGGING_NAMESPACE}.HierarchyProvider`;
-const PERF_LOGGING_NAMESPACE = `${LOGGING_NAMESPACE}.Performance`;
+const LOGGING_NAMESPACE = `${Common_1.LOGGING_NAMESPACE}.Provider`;
+const LOGGING_NAMESPACE_INTERNAL = `${Common_1.LOGGING_NAMESPACE_INTERNAL}.Provider`;
+const LOGGING_NAMESPACE_PERFORMANCE = `${Common_1.LOGGING_NAMESPACE_PERFORMANCE}.Provider`;
 const DEFAULT_QUERY_CONCURRENCY = 10;
 const DEFAULT_QUERY_CACHE_SIZE = 1;
 /**
@@ -40,7 +41,6 @@ const DEFAULT_QUERY_CACHE_SIZE = 1;
 function createHierarchyProvider(props) {
     return new HierarchyProviderImpl(props);
 }
-exports.createHierarchyProvider = createHierarchyProvider;
 class HierarchyProviderImpl {
     _imodelAccess;
     _valuesFormatter;
@@ -97,12 +97,12 @@ class HierarchyProviderImpl {
     }
     createParsedQueryNodesObservable(props) {
         (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
             message: /* istanbul ignore next */ () => `Requesting hierarchy level definitions for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         });
         // stream hierarchy level definitions
         const definitions = (0, rxjs_1.from)((0, rxjs_1.defer)(async () => this.hierarchyDefinition.defineHierarchyLevel(props))).pipe((0, rxjs_1.mergeAll)(), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
             message: /* istanbul ignore next */ () => `Received all hierarchy level definitions for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         })));
         // pipe definitions to nodes and put "share replay" on it
@@ -110,12 +110,9 @@ class HierarchyProviderImpl {
             if (HierarchyDefinition_1.HierarchyNodesDefinition.isCustomNode(def)) {
                 return (0, rxjs_1.of)(def.node);
             }
-            return this._queryScheduler.scheduleSubscription((0, rxjs_1.of)(def.query).pipe((0, rxjs_1.map)((query) => filterQueryByInstanceKeys(query, props.filteredInstanceKeys)), (0, LoggingUtils_1.log)({
-                category: `${LOGGING_NAMESPACE}.Queries`,
-                message: /* istanbul ignore next */ (query) => `Query direct nodes for parent ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}: ${(0, LoggingUtils_1.createQueryLogMessage)(query)}`,
-            }), (0, rxjs_1.mergeMap)((query) => (0, TreeNodesReader_1.readNodes)({ queryExecutor: this.queryExecutor, query, limit: props.hierarchyLevelSizeLimit, parser: this.hierarchyDefinition.parseNode }))));
+            return this._queryScheduler.scheduleSubscription((0, rxjs_1.of)(def.query).pipe((0, rxjs_1.map)((query) => filterQueryByInstanceKeys(query, props.filteredInstanceKeys)), (0, rxjs_1.mergeMap)((query) => (0, TreeNodesReader_1.readNodes)({ queryExecutor: this.queryExecutor, query, limit: props.hierarchyLevelSizeLimit, parser: this.hierarchyDefinition.parseNode }))));
         }), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
             message: /* istanbul ignore next */ () => `Read all child nodes ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         })), (0, ShareReplayWithErrors_1.shareReplayWithErrors)());
     }
@@ -129,7 +126,7 @@ class HierarchyProviderImpl {
         (0, rxjs_1.mergeMap)(async (node) => applyLabelsFormatting(node, this._imodelAccess, this._valuesFormatter)), 
         // we have `ProcessedHierarchyNode` from here
         preProcessNodes(this.hierarchyDefinition), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
             message: /* istanbul ignore next */ () => `Finished initializing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(parentNode)}`,
         })), (0, ShareReplayWithErrors_1.shareReplayWithErrors)());
     }
@@ -137,14 +134,14 @@ class HierarchyProviderImpl {
         return this.createInitializedNodesObservable(queryNodesObservable, props.parentNode).pipe((0, HideIfNoChildren_1.createHideIfNoChildrenOperator)((n) => this.getChildNodesObservables({ parentNode: n }).hasNodes), (0, HideNodesInHierarchy_1.createHideNodesInHierarchyOperator)(
         // note: for child nodes created because of hidden parent, we want to use parent's request props (instance filter, limit)
         (n) => this.getChildNodesObservables({ ...props, parentNode: n }).processedNodes, false), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
             message: /* istanbul ignore next */ () => `Finished pre-processing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         })));
     }
     createProcessedNodesObservable(preprocessedNodesObservable, props) {
         return preprocessedNodesObservable.pipe((0, Grouping_1.createGroupingOperator)(this._imodelAccess, props.parentNode, this._valuesFormatter, this._localizedStrings, (gn) => this.onGroupingNodeCreated(gn, props)), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
-            message: /* istanbul ignore next */ () => `Finished processing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
+            message: /* istanbul ignore next */ () => `Finished grouping child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         })));
     }
     createFinalizedNodesObservable(processedNodesObservable, props) {
@@ -156,12 +153,12 @@ class HierarchyProviderImpl {
                 children: (0, Common_1.hasChildren)(n),
             });
         }), (0, rxjs_1.finalize)(() => (0, LoggingUtils_1.doLog)({
-            category: PERF_LOGGING_NAMESPACE,
+            category: LOGGING_NAMESPACE_PERFORMANCE,
             message: /* istanbul ignore next */ () => `Finished finalizing child nodes for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         })));
     }
     createHasNodesObservable(preprocessedNodesObservable, possiblyKnownChildrenObservable) {
-        const loggingCategory = `${LOGGING_NAMESPACE}.HasNodes`;
+        const loggingCategory = `${LOGGING_NAMESPACE_INTERNAL}.HasNodes`;
         return (0, rxjs_1.concat)((possiblyKnownChildrenObservable ?? rxjs_1.EMPTY).pipe((0, rxjs_1.filter)((n) => (0, Common_1.hasChildren)(n))), preprocessedNodesObservable).pipe((0, LoggingUtils_1.log)({ category: loggingCategory, message: /* istanbul ignore next */ (n) => `Node before mapping to 'true': ${(0, Common_1.createNodeIdentifierForLogging)(n)}` }), (0, rxjs_1.take)(1), (0, rxjs_1.map)(() => true), (0, rxjs_1.defaultIfEmpty)(false), (0, rxjs_1.catchError)((e) => {
             (0, LoggingUtils_1.doLog)({ category: loggingCategory, message: /* istanbul ignore next */ () => `Error while determining children: ${e.message}` });
             if (e instanceof HierarchyErrors_1.RowsLimitExceededError) {
@@ -171,7 +168,7 @@ class HierarchyProviderImpl {
         }), (0, LoggingUtils_1.log)({ category: loggingCategory, message: /* istanbul ignore next */ (r) => `Result: ${r}` }));
     }
     getCachedObservableEntry(props) {
-        const loggingCategory = `${LOGGING_NAMESPACE}.GetCachedObservableEntry`;
+        const loggingCategory = `${LOGGING_NAMESPACE}.QueryResultsCache`;
         const { parentNode, ...restProps } = props;
         const cached = props.ignoreCache || !this._nodesCache ? undefined : this._nodesCache.get(props);
         if (cached) {
@@ -310,11 +307,24 @@ class HierarchyProviderImpl {
      */
     getNodeInstanceKeys(props) {
         const loggingCategory = `${LOGGING_NAMESPACE}.GetNodeInstanceKeys`;
+        const timer = new core_bentley_1.StopWatch(undefined, true);
         (0, LoggingUtils_1.doLog)({
             category: loggingCategory,
             message: /* istanbul ignore next */ () => `Requesting keys for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}`,
         });
-        return (0, EachValueFrom_1.eachValueFrom)(this.getNodeInstanceKeysObs(props));
+        let error;
+        let keysCount = 0;
+        return (0, EachValueFrom_1.eachValueFrom)(this.getNodeInstanceKeysObs(props).pipe((0, rxjs_1.tap)(() => ++keysCount), (0, rxjs_1.catchError)((e) => {
+            error = e;
+            throw e;
+        }), (0, rxjs_1.finalize)(() => {
+            (0, LoggingUtils_1.doLog)({
+                category: loggingCategory,
+                message: /* istanbul ignore next */ () => error
+                    ? `Error creating node instance keys for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)}: ${error instanceof Error ? error.message : error.toString()}`
+                    : `Returned ${keysCount} instance keys for ${(0, Common_1.createNodeIdentifierForLogging)(props.parentNode)} in ${timer.currentSeconds.toFixed(2)} s.`,
+            });
+        })));
     }
     /**
      * A function that should be called when the underlying data source, used by `HierarchyProviderProps.schemaProvider`,
@@ -323,6 +333,10 @@ class HierarchyProviderImpl {
      * Calling the function invalidates internal caches to make sure fresh data is retrieved on new requests.
      */
     notifyDataSourceChanged() {
+        (0, LoggingUtils_1.doLog)({
+            category: `${LOGGING_NAMESPACE}.Events`,
+            message: /* istanbul ignore next */ () => `Data source changed: clear query results cache`,
+        });
         this._nodesCache?.clear();
     }
 }