@itwin/presentation-hierarchies 1.1.0 → 1.2.0

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

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

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

@@ -2,7 +2,7 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-/** @beta */
+/** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export var HierarchyNodesDefinition;
 (function (HierarchyNodesDefinition) {

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

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

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

@@ -1,9 +1,9 @@
 import { ConcatenatedValue, InstanceKey, OmitOverUnion, PrimitiveValue } from "@itwin/presentation-shared";
-import { GroupingHierarchyNode, NonGroupingHierarchyNode } from "../HierarchyNode";
-import { GenericNodeKey, InstancesNodeKey } from "../HierarchyNodeKey";
+import { GroupingHierarchyNode, NonGroupingHierarchyNode } from "../HierarchyNode.js";
+import { GenericNodeKey, InstancesNodeKey } from "../HierarchyNodeKey.js";
 /**
  * Base processing parameters that apply to every node.
- * @beta
+ * @public
  */
 interface HierarchyNodeProcessingParamsBase {
     /** Indicates if this node should be hidden if it has no child nodes. */
@@ -13,7 +13,7 @@ interface HierarchyNodeProcessingParamsBase {
 }
 /**
  * A data structure for defining nodes' grouping requirements.
- * @beta
+ * @public
  */
 interface HierarchyNodeGroupingParams {
     byLabel?: HierarchyNodeLabelGroupingParams;
@@ -23,7 +23,7 @@ interface HierarchyNodeGroupingParams {
 }
 /**
  * A data structure for defining params specifically used for label grouping.
- * @beta
+ * @public
  */
 interface HierarchyNodeLabelGroupingBaseParams {
     /** Label grouping option that determines whether to group nodes or to merge them. Defaults to "group".*/
@@ -33,26 +33,26 @@ interface HierarchyNodeLabelGroupingBaseParams {
 }
 /**
  * A data structure for defining label merging.
- * @beta
+ * @public
  */
 interface HierarchyNodeLabelGroupingMergeParams extends HierarchyNodeLabelGroupingBaseParams {
     action: "merge";
 }
 /**
  * A data structure for defining label grouping with additional parameters.
- * @beta
+ * @public
  */
 interface HierarchyNodeLabelGroupingGroupParams extends HierarchyNodeLabelGroupingBaseParams, HierarchyNodeGroupingParamsBase {
     action?: "group";
 }
 /**
  * A data structure for defining possible label grouping types.
- * @beta
+ * @public
  */
 export type HierarchyNodeLabelGroupingParams = boolean | HierarchyNodeLabelGroupingMergeParams | HierarchyNodeLabelGroupingGroupParams;
 /**
  * Grouping parameters that are shared across all types of groupings.
- * @beta
+ * @public
  */
 export interface HierarchyNodeGroupingParamsBase {
     /** Hiding option that determines whether to hide group nodes which have no siblings at the same hierarchy level. */
@@ -66,12 +66,12 @@ export interface HierarchyNodeGroupingParamsBase {
  * Defines possible values for `BaseGroupingParams.autoExpand` attribute:
  * - `single-child` - set the grouping node to auto-expand if it groups a single node.
  * - `always` - always set the grouping node to auto-expand.
- * @beta
+ * @public
  */
 export type HierarchyNodeAutoExpandProp = "single-child" | "always";
 /**
  * A data structure that represents base class grouping.
- * @beta
+ * @public
  */
 interface HierarchyNodeBaseClassGroupingParams extends HierarchyNodeGroupingParamsBase {
     /**
@@ -84,7 +84,7 @@ interface HierarchyNodeBaseClassGroupingParams extends HierarchyNodeGroupingPara
 }
 /**
  * A data structure that represents properties grouping.
- * @beta
+ * @public
  */
 export interface HierarchyNodePropertiesGroupingParams extends HierarchyNodeGroupingParamsBase {
     /**
@@ -133,7 +133,7 @@ export interface HierarchyNodePropertiesGroupingParams extends HierarchyNodeGrou
 }
 /**
  * A data structure that represents specific properties' grouping params.
- * @beta
+ * @public
  */
 export interface HierarchyNodePropertyGroup {
     /** A string indicating the name of the property to group by. */
@@ -145,7 +145,7 @@ export interface HierarchyNodePropertyGroup {
 }
 /**
  * A data structure that represents boundaries for a value.
- * @beta
+ * @public
  */
 export interface HierarchyNodePropertyValueRange {
     /** Defines the lower bound of the range. */
@@ -157,14 +157,14 @@ export interface HierarchyNodePropertyValueRange {
 }
 /**
  * Processing parameters that apply to instance nodes.
- * @beta
+ * @public
  */
 export interface InstanceHierarchyNodeProcessingParams extends HierarchyNodeProcessingParamsBase {
     grouping?: HierarchyNodeGroupingParams;
 }
 /**
  * A generic (not based on data in an iModel) node that has processing parameters.
- * @beta
+ * @public
  */
 export type ProcessedGenericHierarchyNode = Omit<NonGroupingHierarchyNode, "key" | "children"> & {
     key: GenericNodeKey;
@@ -173,7 +173,7 @@ export type ProcessedGenericHierarchyNode = Omit<NonGroupingHierarchyNode, "key"
 };
 /**
  * An instances' (based on data in an iModel) node that has processing parameters.
- * @beta
+ * @public
  */
 export type ProcessedInstanceHierarchyNode = Omit<NonGroupingHierarchyNode, "key" | "children"> & {
     key: InstancesNodeKey;
@@ -182,7 +182,7 @@ export type ProcessedInstanceHierarchyNode = Omit<NonGroupingHierarchyNode, "key
 };
 /**
  * A grouping node that groups either instance nodes or other grouping nodes.
- * @beta
+ * @public
  */
 export type ProcessedGroupingHierarchyNode = Omit<GroupingHierarchyNode, "children"> & {
     children: Array<ProcessedGroupingHierarchyNode | ProcessedInstanceHierarchyNode>;
@@ -194,10 +194,10 @@ export type ProcessedGroupingHierarchyNode = Omit<GroupingHierarchyNode, "childr
  * Type guards under `HierarchyNode` namespace can be used to differentiate between different sub-types of
  * `ProcessedHierarchyNode`.
  *
- * @beta
+ * @public
  */
 export type ProcessedHierarchyNode = ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode | ProcessedGroupingHierarchyNode;
-/** @beta */
+/** @public */
 export declare namespace ProcessedHierarchyNode {
     /** Checks whether the given node is a generic node */
     function isGeneric(node: ProcessedHierarchyNode): node is ProcessedGenericHierarchyNode;
@@ -209,21 +209,21 @@ export declare namespace ProcessedHierarchyNode {
 /**
  * A `ProcessedHierarchyNode` that has an unformatted label in a form of `ConcatenatedValue`. Generally this is
  * returned by hierarchy definitions as a generic node or when the node is just parsed from query results.
- * @beta
+ * @public
  */
 export type SourceHierarchyNode<TBase = SourceGenericHierarchyNode | SourceInstanceHierarchyNode> = OmitOverUnion<TBase, "label" | "parentKeys"> & {
     label: string | ConcatenatedValue;
 };
 /**
  * A kind of `ProcessedGenericHierarchyNode` that has unformatted label and doesn't know about its ancestors.
- * @beta
+ * @public
  */
 export type SourceGenericHierarchyNode = SourceHierarchyNode<Omit<ProcessedGenericHierarchyNode, "key"> & {
     key: string;
 }>;
 /**
  * A kind of `ProcessedInstanceHierarchyNode` that has unformatted label and doesn't know about its ancestors.
- * @beta
+ * @public
  */
 export type SourceInstanceHierarchyNode = SourceHierarchyNode<Omit<ProcessedInstanceHierarchyNode, "key"> & {
     key: Omit<InstancesNodeKey, "instanceKeys"> & {

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

@@ -1 +1 @@
-{"version":3,"file":"IModelHierarchyNode.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC3G,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACnF,OAAO,EAAE,cAAc,EAAoB,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEzF;;;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,GAAG,iBAAiB,CAAC;IACnD,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,6BAA6B,GAAG,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAC/F,GAAG,EAAE,cAAc,CAAC;IACpB,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,6BAA6B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC;AAErI,YAAY;AAEZ,yBAAiB,sBAAsB,CAAC;IACtC,sDAAsD;IACtD,SAAgB,SAAS,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI,IAAI,6BAA6B,CAE7F;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI,IAAI,8BAA8B,CAEpG;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI,IAAI,8BAA8B,CAEnG;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,0BAA0B,GAAG,2BAA2B,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAAC,GAAG;IACjJ,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,IAAI,CAAC,6BAA6B,EAAE,KAAK,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAE3H;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,CAC3D,IAAI,CAAC,8BAA8B,EAAE,KAAK,CAAC,GAAG;IAC5C,GAAG,EAAE,IAAI,CAAC,gBAAgB,EAAE,cAAc,CAAC,GAAG;QAAE,YAAY,EAAE,WAAW,EAAE,CAAA;KAAE,CAAC;CAC/E,CACF,CAAC"}
+{"version":3,"file":"IModelHierarchyNode.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC3G,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACtF,OAAO,EAAE,cAAc,EAAoB,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE5F;;;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,GAAG,iBAAiB,CAAC;IACnD,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,6BAA6B,GAAG,IAAI,CAAC,wBAAwB,EAAE,KAAK,GAAG,UAAU,CAAC,GAAG;IAC/F,GAAG,EAAE,cAAc,CAAC;IACpB,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,6BAA6B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC;AAErI,cAAc;AAEd,yBAAiB,sBAAsB,CAAC;IACtC,sDAAsD;IACtD,SAAgB,SAAS,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI,IAAI,6BAA6B,CAE7F;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI,IAAI,8BAA8B,CAEpG;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,IAAI,EAAE,sBAAsB,GAAG,IAAI,IAAI,8BAA8B,CAEnG;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,0BAA0B,GAAG,2BAA2B,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAAC,GAAG;IACjJ,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,IAAI,CAAC,6BAA6B,EAAE,KAAK,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAE3H;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,CAC3D,IAAI,CAAC,8BAA8B,EAAE,KAAK,CAAC,GAAG;IAC5C,GAAG,EAAE,IAAI,CAAC,gBAAgB,EAAE,cAAc,CAAC,GAAG;QAAE,YAAY,EAAE,WAAW,EAAE,CAAA;KAAE,CAAC;CAC/E,CACF,CAAC"}

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

@@ -2,8 +2,8 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { HierarchyNodeKey } from "../HierarchyNodeKey";
-/** @beta */
+import { HierarchyNodeKey } from "../HierarchyNodeKey.js";
+/** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export var ProcessedHierarchyNode;
 (function (ProcessedHierarchyNode) {

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

@@ -1 +1 @@
-{"version":3,"file":"IModelHierarchyNode.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyNode.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAIhG,OAAO,EAAkB,gBAAgB,EAAoB,MAAM,qBAAqB,CAAC;AAuNzF,YAAY;AACZ,2DAA2D;AAC3D,MAAM,KAAW,sBAAsB,CAatC;AAbD,WAAiB,sBAAsB;IACrC,sDAAsD;IACtD,SAAgB,SAAS,CAAC,IAA4B;QACpD,OAAO,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,gCAAS,YAExB,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,IAA4B;QAC1D,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAFe,sCAAe,kBAE9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,IAA4B;QACzD,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAFe,qCAAc,iBAE7B,CAAA;AACH,CAAC,EAbgB,sBAAsB,KAAtB,sBAAsB,QAatC","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 { GroupingHierarchyNode, NonGroupingHierarchyNode } from \"../HierarchyNode\";\nimport { GenericNodeKey, HierarchyNodeKey, InstancesNodeKey } from \"../HierarchyNodeKey\";\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 | ConcatenatedValue;\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 generic (not based on data in an iModel) node that has processing parameters.\n * @beta\n */\nexport type ProcessedGenericHierarchyNode = Omit<NonGroupingHierarchyNode, \"key\" | \"children\"> & {\n  key: GenericNodeKey;\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 = ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode | ProcessedGroupingHierarchyNode;\n\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace ProcessedHierarchyNode {\n  /** Checks whether the given node is a generic node */\n  export function isGeneric(node: ProcessedHierarchyNode): node is ProcessedGenericHierarchyNode {\n    return HierarchyNodeKey.isGeneric(node.key);\n  }\n  /** Checks whether the given node is an ECInstances-based node */\n  export function isInstancesNode(node: ProcessedHierarchyNode): node is ProcessedInstanceHierarchyNode {\n    return HierarchyNodeKey.isInstances(node.key);\n  }\n  /** Checks whether the given node is a grouping node */\n  export function isGroupingNode(node: ProcessedHierarchyNode): node is ProcessedGroupingHierarchyNode {\n    return HierarchyNodeKey.isGrouping(node.key);\n  }\n}\n\n/**\n * A `ProcessedHierarchyNode` that has an unformatted label in a form of `ConcatenatedValue`. Generally this is\n * returned by hierarchy definitions as a generic node or when the node is just parsed from query results.\n * @beta\n */\nexport type SourceHierarchyNode<TBase = SourceGenericHierarchyNode | SourceInstanceHierarchyNode> = OmitOverUnion<TBase, \"label\" | \"parentKeys\"> & {\n  label: string | ConcatenatedValue;\n};\n\n/**\n * A kind of `ProcessedGenericHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @beta\n */\nexport type SourceGenericHierarchyNode = SourceHierarchyNode<Omit<ProcessedGenericHierarchyNode, \"key\"> & { key: string }>;\n\n/**\n * A kind of `ProcessedInstanceHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @beta\n */\nexport type SourceInstanceHierarchyNode = SourceHierarchyNode<\n  Omit<ProcessedInstanceHierarchyNode, \"key\"> & {\n    key: Omit<InstancesNodeKey, \"instanceKeys\"> & { instanceKeys: InstanceKey[] };\n  }\n>;\n"]}
+{"version":3,"file":"IModelHierarchyNode.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyNode.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAIhG,OAAO,EAAkB,gBAAgB,EAAoB,MAAM,wBAAwB,CAAC;AAuN5F,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,sBAAsB,CAatC;AAbD,WAAiB,sBAAsB;IACrC,sDAAsD;IACtD,SAAgB,SAAS,CAAC,IAA4B;QACpD,OAAO,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,gCAAS,YAExB,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,IAA4B;QAC1D,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAFe,sCAAe,kBAE9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,IAA4B;QACzD,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAFe,qCAAc,iBAE7B,CAAA;AACH,CAAC,EAbgB,sBAAsB,KAAtB,sBAAsB,QAatC","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 { GroupingHierarchyNode, NonGroupingHierarchyNode } from \"../HierarchyNode.js\";\nimport { GenericNodeKey, HierarchyNodeKey, InstancesNodeKey } from \"../HierarchyNodeKey.js\";\n\n/**\n * Base processing parameters that apply to every node.\n * @public\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 * @public\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 * @public\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 * @public\n */\ninterface HierarchyNodeLabelGroupingMergeParams extends HierarchyNodeLabelGroupingBaseParams {\n  action: \"merge\";\n}\n\n/**\n * A data structure for defining label grouping with additional parameters.\n * @public\n */\ninterface HierarchyNodeLabelGroupingGroupParams extends HierarchyNodeLabelGroupingBaseParams, HierarchyNodeGroupingParamsBase {\n  action?: \"group\";\n}\n\n/**\n * A data structure for defining possible label grouping types.\n * @public\n */\nexport type HierarchyNodeLabelGroupingParams = boolean | HierarchyNodeLabelGroupingMergeParams | HierarchyNodeLabelGroupingGroupParams;\n\n/**\n * Grouping parameters that are shared across all types of groupings.\n * @public\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 * @public\n */\nexport type HierarchyNodeAutoExpandProp = \"single-child\" | \"always\";\n\n/**\n * A data structure that represents base class grouping.\n * @public\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 * @public\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 * @public\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 | ConcatenatedValue;\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 * @public\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 * @public\n */\nexport interface InstanceHierarchyNodeProcessingParams extends HierarchyNodeProcessingParamsBase {\n  grouping?: HierarchyNodeGroupingParams;\n}\n\n/**\n * A generic (not based on data in an iModel) node that has processing parameters.\n * @public\n */\nexport type ProcessedGenericHierarchyNode = Omit<NonGroupingHierarchyNode, \"key\" | \"children\"> & {\n  key: GenericNodeKey;\n  children?: boolean;\n  processingParams?: HierarchyNodeProcessingParamsBase;\n};\n\n/**\n * An instances' (based on data in an iModel) node that has processing parameters.\n * @public\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 * @public\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 * @public\n */\nexport type ProcessedHierarchyNode = ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode | ProcessedGroupingHierarchyNode;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace ProcessedHierarchyNode {\n  /** Checks whether the given node is a generic node */\n  export function isGeneric(node: ProcessedHierarchyNode): node is ProcessedGenericHierarchyNode {\n    return HierarchyNodeKey.isGeneric(node.key);\n  }\n  /** Checks whether the given node is an ECInstances-based node */\n  export function isInstancesNode(node: ProcessedHierarchyNode): node is ProcessedInstanceHierarchyNode {\n    return HierarchyNodeKey.isInstances(node.key);\n  }\n  /** Checks whether the given node is a grouping node */\n  export function isGroupingNode(node: ProcessedHierarchyNode): node is ProcessedGroupingHierarchyNode {\n    return HierarchyNodeKey.isGrouping(node.key);\n  }\n}\n\n/**\n * A `ProcessedHierarchyNode` that has an unformatted label in a form of `ConcatenatedValue`. Generally this is\n * returned by hierarchy definitions as a generic node or when the node is just parsed from query results.\n * @public\n */\nexport type SourceHierarchyNode<TBase = SourceGenericHierarchyNode | SourceInstanceHierarchyNode> = OmitOverUnion<TBase, \"label\" | \"parentKeys\"> & {\n  label: string | ConcatenatedValue;\n};\n\n/**\n * A kind of `ProcessedGenericHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @public\n */\nexport type SourceGenericHierarchyNode = SourceHierarchyNode<Omit<ProcessedGenericHierarchyNode, \"key\"> & { key: string }>;\n\n/**\n * A kind of `ProcessedInstanceHierarchyNode` that has unformatted label and doesn't know about its ancestors.\n * @public\n */\nexport type SourceInstanceHierarchyNode = SourceHierarchyNode<\n  Omit<ProcessedInstanceHierarchyNode, \"key\"> & {\n    key: Omit<InstancesNodeKey, \"instanceKeys\"> & { instanceKeys: InstanceKey[] };\n  }\n>;\n"]}

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

@@ -1,11 +1,11 @@
 import { ECClassHierarchyInspector, ECSchemaProvider, Event, IPrimitiveValueFormatter } from "@itwin/presentation-shared";
-import { HierarchyFilteringPath } from "../HierarchyFiltering";
-import { HierarchyProvider } from "../HierarchyProvider";
-import { HierarchyDefinition } from "./IModelHierarchyDefinition";
-import { LimitingECSqlQueryExecutor } from "./LimitingECSqlQueryExecutor";
+import { HierarchyFilteringPath } from "../HierarchyFiltering.js";
+import { HierarchyProvider } from "../HierarchyProvider.js";
+import { HierarchyDefinition } from "./IModelHierarchyDefinition.js";
+import { LimitingECSqlQueryExecutor } from "./LimitingECSqlQueryExecutor.js";
 /**
  * Defines the strings used by hierarchy provider.
- * @beta
+ * @public
  */
 interface IModelHierarchyProviderLocalizedStrings {
     /**
@@ -19,13 +19,13 @@ interface IModelHierarchyProviderLocalizedStrings {
      */
     other: string;
 }
-/** @beta */
+/** @public */
 type IModelAccess = ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector & {
     imodelKey: string;
 };
 /**
  * Props for `createIModelHierarchyProvider`.
- * @beta
+ * @public
  */
 interface IModelHierarchyProviderProps {
     /**
@@ -68,7 +68,7 @@ interface IModelHierarchyProviderProps {
  * Creates an instance of `HierarchyProvider` that creates a hierarchy based on given iModel and
  * a hierarchy definition, which defines each hierarchy level through ECSQL queries.
  *
- * @beta
+ * @public
  */
 export declare function createIModelHierarchyProvider(props: IModelHierarchyProviderProps): HierarchyProvider & {
     dispose: () => void;

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

@@ -1 +1 @@
-{"version":3,"file":"IModelHierarchyProvider.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyProvider.ts"],"names":[],"mappings":"AA2BA,OAAO,EAGL,yBAAyB,EACzB,gBAAgB,EAGhB,KAAK,EAGL,wBAAwB,EAEzB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,OAAO,EAA0B,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAiBjF,OAAO,EAA6B,mBAAmB,EAA4B,MAAM,6BAA6B,CAAC;AASvH,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAe1E;;;GAGG;AACH,UAAU,uCAAuC;IAC/C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,YAAY;AACZ,KAAK,YAAY,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtH;;;GAGG;AACH,UAAU,4BAA4B;IACpC;;;;;;OAMG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B,wFAAwF;IACxF,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC,qGAAqG;IACrG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAEpE;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,yCAAyC;IACzC,SAAS,CAAC,EAAE;QACV,2DAA2D;QAC3D,KAAK,EAAE,sBAAsB,EAAE,CAAC;KACjC,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,4BAA4B,GAAG,iBAAiB,GAAG;IAAE,OAAO,EAAE,MAAM,IAAI,CAAA;CAAE,CAE9H"}
+{"version":3,"file":"IModelHierarchyProvider.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyProvider.ts"],"names":[],"mappings":"AA2BA,OAAO,EAGL,yBAAyB,EACzB,gBAAgB,EAGhB,KAAK,EAGL,wBAAwB,EAEzB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,EAA0B,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAiBpF,OAAO,EAA6B,mBAAmB,EAA4B,MAAM,gCAAgC,CAAC;AAS1H,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAe7E;;;GAGG;AACH,UAAU,uCAAuC;IAC/C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,cAAc;AACd,KAAK,YAAY,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtH;;;GAGG;AACH,UAAU,4BAA4B;IACpC;;;;;;OAMG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B,wFAAwF;IACxF,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC,qGAAqG;IACrG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAEpE;;;;OAIG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,yCAAyC;IACzC,SAAS,CAAC,EAAE;QACV,2DAA2D;QAC3D,KAAK,EAAE,sBAAsB,EAAE,CAAC;KACjC,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,4BAA4B,GAAG,iBAAiB,GAAG;IAAE,OAAO,EAAE,MAAM,IAAI,CAAA;CAAE,CAE9H"}

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

@@ -5,26 +5,26 @@
 import { catchError, concat, defaultIfEmpty, defer, EMPTY, filter, finalize, from, map, merge, mergeAll, mergeMap, of, Subject, take, takeUntil, tap, } from "rxjs";
 import { assert, BeEvent, Guid, StopWatch } from "@itwin/core-bentley";
 import { createDefaultValueFormatter, formatConcatenatedValue, normalizeFullClassName, } from "@itwin/presentation-shared";
-import { RowsLimitExceededError } from "../HierarchyErrors";
-import { HierarchyNode } from "../HierarchyNode";
-import { HierarchyNodeKey } from "../HierarchyNodeKey";
-import { LOGGING_NAMESPACE as BASE_LOGGING_NAMESPACE, LOGGING_NAMESPACE_INTERNAL as BASE_LOGGING_NAMESPACE_INTERNAL, LOGGING_NAMESPACE_PERFORMANCE as BASE_LOGGING_NAMESPACE_PERFORMANCE, createNodeIdentifierForLogging, hasChildren, } from "../internal/Common";
-import { eachValueFrom } from "../internal/EachValueFrom";
-import { doLog, log } from "../internal/LoggingUtils";
-import { partition } from "../internal/operators/Partition";
-import { reduceToMergeMapList } from "../internal/operators/ReduceToMergeMap";
-import { shareReplayWithErrors } from "../internal/operators/ShareReplayWithErrors";
-import { sortNodesByLabelOperator } from "../internal/operators/Sorting";
-import { SubscriptionScheduler } from "../internal/SubscriptionScheduler";
-import { FilteringHierarchyDefinition } from "./FilteringHierarchyDefinition";
-import { HierarchyCache } from "./HierarchyCache";
-import { HierarchyNodesDefinition } from "./IModelHierarchyDefinition";
-import { NodeSelectClauseColumnNames } from "./NodeSelectQueryFactory";
-import { createDetermineChildrenOperator } from "./operators/DetermineChildren";
-import { createGroupingOperator } from "./operators/Grouping";
-import { createHideIfNoChildrenOperator } from "./operators/HideIfNoChildren";
-import { createHideNodesInHierarchyOperator } from "./operators/HideNodesInHierarchy";
-import { readNodes } from "./TreeNodesReader";
+import { RowsLimitExceededError } from "../HierarchyErrors.js";
+import { HierarchyNode } from "../HierarchyNode.js";
+import { HierarchyNodeKey } from "../HierarchyNodeKey.js";
+import { LOGGING_NAMESPACE as BASE_LOGGING_NAMESPACE, LOGGING_NAMESPACE_INTERNAL as BASE_LOGGING_NAMESPACE_INTERNAL, LOGGING_NAMESPACE_PERFORMANCE as BASE_LOGGING_NAMESPACE_PERFORMANCE, createNodeIdentifierForLogging, hasChildren, } from "../internal/Common.js";
+import { eachValueFrom } from "../internal/EachValueFrom.js";
+import { doLog, log } from "../internal/LoggingUtils.js";
+import { partition } from "../internal/operators/Partition.js";
+import { reduceToMergeMapList } from "../internal/operators/ReduceToMergeMap.js";
+import { shareReplayWithErrors } from "../internal/operators/ShareReplayWithErrors.js";
+import { sortNodesByLabelOperator } from "../internal/operators/Sorting.js";
+import { SubscriptionScheduler } from "../internal/SubscriptionScheduler.js";
+import { FilteringHierarchyDefinition } from "./FilteringHierarchyDefinition.js";
+import { HierarchyCache } from "./HierarchyCache.js";
+import { HierarchyNodesDefinition } from "./IModelHierarchyDefinition.js";
+import { NodeSelectClauseColumnNames } from "./NodeSelectQueryFactory.js";
+import { createDetermineChildrenOperator } from "./operators/DetermineChildren.js";
+import { createGroupingOperator } from "./operators/Grouping.js";
+import { createHideIfNoChildrenOperator } from "./operators/HideIfNoChildren.js";
+import { createHideNodesInHierarchyOperator } from "./operators/HideNodesInHierarchy.js";
+import { readNodes } from "./TreeNodesReader.js";
 const LOGGING_NAMESPACE = `${BASE_LOGGING_NAMESPACE}.IModelHierarchyProvider`;
 const LOGGING_NAMESPACE_INTERNAL = `${BASE_LOGGING_NAMESPACE_INTERNAL}.IModelHierarchyProvider`;
 const LOGGING_NAMESPACE_PERFORMANCE = `${BASE_LOGGING_NAMESPACE_PERFORMANCE}.IModelHierarchyProvider`;
@@ -34,7 +34,7 @@ const DEFAULT_QUERY_CACHE_SIZE = 1;
  * Creates an instance of `HierarchyProvider` that creates a hierarchy based on given iModel and
  * a hierarchy definition, which defines each hierarchy level through ECSQL queries.
  *
- * @beta
+ * @public
  */
 export function createIModelHierarchyProvider(props) {
     return new IModelHierarchyProviderImpl(props);
@@ -81,7 +81,7 @@ class IModelHierarchyProviderImpl {
     invalidateHierarchyCache(reason) {
         doLog({
             category: `${LOGGING_NAMESPACE}.Events`,
-            message: /* istanbul ignore next */ () => (reason ? `${reason}: clear hierarchy cache` : `Clear hierarchy cache`),
+            message: /* c8 ignore next */ () => (reason ? `${reason}: clear hierarchy cache` : `Clear hierarchy cache`),
         });
         this._nodesCache?.clear();
     }
@@ -115,7 +115,7 @@ class IModelHierarchyProviderImpl {
         const { requestContext, ...defineHierarchyLevelProps } = props;
         doLog({
             category: LOGGING_NAMESPACE_PERFORMANCE,
-            message: /* istanbul ignore next */ () => `[${requestContext.requestId}] Requesting hierarchy level definitions for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${requestContext.requestId}] Requesting hierarchy level definitions for ${createNodeIdentifierForLogging(props.parentNode)}`,
         });
         return from(defer(async () => {
             let parentNode = props.parentNode;
@@ -138,7 +138,7 @@ class IModelHierarchyProviderImpl {
             return this._activeHierarchyDefinition.defineHierarchyLevel({ ...defineHierarchyLevelProps, parentNode });
         })).pipe(mergeAll(), finalize(() => doLog({
             category: LOGGING_NAMESPACE_PERFORMANCE,
-            message: /* istanbul ignore next */ () => `[${requestContext.requestId}] Received all hierarchy level definitions for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${requestContext.requestId}] Received all hierarchy level definitions for ${createNodeIdentifierForLogging(props.parentNode)}`,
         })));
     }
     createSourceNodesObservable(props) {
@@ -160,7 +160,7 @@ class IModelHierarchyProviderImpl {
             }))));
         }), finalize(() => doLog({
             category: LOGGING_NAMESPACE_PERFORMANCE,
-            message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Read all child nodes ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Read all child nodes ${createNodeIdentifierForLogging(props.parentNode)}`,
         })), shareReplayWithErrors());
     }
     createPreProcessedNodesObservable(queryNodesObservable, props) {
@@ -178,13 +178,13 @@ class IModelHierarchyProviderImpl {
         // 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), finalize(() => doLog({
             category: LOGGING_NAMESPACE_PERFORMANCE,
-            message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Finished pre-processing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Finished pre-processing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
         })));
     }
     createProcessedNodesObservable(preprocessedNodesObservable, props) {
         return preprocessedNodesObservable.pipe(createGroupingOperator(this._imodelAccess, props.parentNode, this._valuesFormatter, this._localizedStrings, (gn) => this.onGroupingNodeCreated(gn, props)), finalize(() => doLog({
             category: LOGGING_NAMESPACE_PERFORMANCE,
-            message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Finished grouping child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Finished grouping child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
         })));
     }
     createFinalizedNodesObservable(processedNodesObservable, props) {
@@ -197,34 +197,33 @@ class IModelHierarchyProviderImpl {
             });
         }), takeUntil(this._dispose), finalize(() => doLog({
             category: LOGGING_NAMESPACE_PERFORMANCE,
-            message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Finished finalizing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Finished finalizing child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
         })));
     }
     createHasNodesObservable(preprocessedNodesObservable, possiblyKnownChildrenObservable, props) {
         const loggingCategory = `${LOGGING_NAMESPACE_INTERNAL}.HasNodes`;
         return concat((possiblyKnownChildrenObservable ?? EMPTY).pipe(filter((n) => hasChildren(n))), preprocessedNodesObservable).pipe(log({
             category: loggingCategory,
-            message: /* istanbul ignore next */ (n) => `[${props.requestContext.requestId}] Node before mapping to 'true': ${createNodeIdentifierForLogging(n)}`,
+            message: /* c8 ignore next */ (n) => `[${props.requestContext.requestId}] Node before mapping to 'true': ${createNodeIdentifierForLogging(n)}`,
         }), take(1), map(() => true), defaultIfEmpty(false), catchError((e) => {
             doLog({
                 category: loggingCategory,
-                message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Error while determining children: ${e.message}`,
+                message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Error while determining children: ${e.message}`,
             });
             if (e instanceof RowsLimitExceededError) {
                 return of(true);
             }
             throw e;
-        }), log({ category: loggingCategory, message: /* istanbul ignore next */ (r) => `[${props.requestContext.requestId}] Result: ${r}` }));
+        }), log({ category: loggingCategory, message: /* c8 ignore next */ (r) => `[${props.requestContext.requestId}] Result: ${r}` }));
     }
     getCachedObservableEntry(props) {
         const loggingCategory = `${LOGGING_NAMESPACE}.QueryResultsCache`;
         const { parentNode, ...restProps } = props;
         const cached = props.ignoreCache || !this._nodesCache ? undefined : this._nodesCache.get(props);
         if (cached) {
-            // istanbul ignore next
             doLog({
                 category: loggingCategory,
-                message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Found query nodes observable for ${createNodeIdentifierForLogging(parentNode)}`,
+                message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Found query nodes observable for ${createNodeIdentifierForLogging(parentNode)}`,
             });
             return cached;
         }
@@ -252,7 +251,7 @@ class IModelHierarchyProviderImpl {
         this._nodesCache?.set(nonGroupingNodeChildrenRequestProps, value);
         doLog({
             category: loggingCategory,
-            message: /* istanbul ignore next */ () => `[${props.requestContext.requestId}] Saved query nodes observable for ${createNodeIdentifierForLogging(parentNode)}`,
+            message: /* c8 ignore next */ () => `[${props.requestContext.requestId}] Saved query nodes observable for ${createNodeIdentifierForLogging(parentNode)}`,
         });
         return value;
     }
@@ -289,7 +288,7 @@ class IModelHierarchyProviderImpl {
         let nodesCount = 0;
         doLog({
             category: loggingCategory,
-            message: /* istanbul ignore next */ () => `[${requestContext.requestId}] Requesting child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${requestContext.requestId}] Requesting child nodes for ${createNodeIdentifierForLogging(props.parentNode)}`,
         });
         return eachValueFrom(this.getChildNodesObservables({ ...props, requestContext }).finalizedNodes.pipe(tap(() => ++nodesCount), catchError((e) => {
             error = e;
@@ -297,7 +296,8 @@ class IModelHierarchyProviderImpl {
         }), finalize(() => {
             doLog({
                 category: loggingCategory,
-                message: /* istanbul ignore next */ () => error
+                message: /* c8 ignore next */ () => 
+                /* c8 ignore next 3 */ error
                     ? `[${requestContext.requestId}] Error creating child nodes for ${createNodeIdentifierForLogging(props.parentNode)}: ${error instanceof Error ? error.message : error.toString()}`
                     : `[${requestContext.requestId}] Returned ${nodesCount} child nodes for ${createNodeIdentifierForLogging(props.parentNode)} in ${timer.currentSeconds.toFixed(2)} s.`,
             });
@@ -367,7 +367,7 @@ class IModelHierarchyProviderImpl {
         const timer = new StopWatch(undefined, true);
         doLog({
             category: loggingCategory,
-            message: /* istanbul ignore next */ () => `[${requestContext.requestId}] Requesting keys for ${createNodeIdentifierForLogging(props.parentNode)}`,
+            message: /* c8 ignore next */ () => `[${requestContext.requestId}] Requesting keys for ${createNodeIdentifierForLogging(props.parentNode)}`,
         });
         let error;
         let keysCount = 0;
@@ -377,7 +377,8 @@ class IModelHierarchyProviderImpl {
         }), finalize(() => {
             doLog({
                 category: loggingCategory,
-                message: /* istanbul ignore next */ () => error
+                message: /* c8 ignore next */ () => 
+                /* c8 ignore next 3 */ error
                     ? `[${requestContext.requestId}] Error creating node instance keys for ${createNodeIdentifierForLogging(props.parentNode)}: ${error instanceof Error ? error.message : error.toString()}`
                     : `[${requestContext.requestId}] Returned ${keysCount} instance keys for ${createNodeIdentifierForLogging(props.parentNode)} in ${timer.currentSeconds.toFixed(2)} s.`,
             });
@@ -417,7 +418,6 @@ function filterQueryByInstanceKeys(query, filteredInstanceKeys) {
         return query;
     }
     const MAX_ALLOWED_BINDINGS = 1000;
-    // istanbul ignore else
     if (filteredInstanceKeys.length < MAX_ALLOWED_BINDINGS) {
         return {
             ...query,
@@ -429,7 +429,7 @@ function filterQueryByInstanceKeys(query, filteredInstanceKeys) {
             bindings: [...(query.bindings ?? []), ...filteredInstanceKeys.map((k) => ({ type: "id", value: k.id }))],
         };
     }
-    // istanbul ignore next
+    /* c8 ignore start */
     return {
         ...query,
         ecsql: `
@@ -439,5 +439,6 @@ function filterQueryByInstanceKeys(query, filteredInstanceKeys) {
     `,
         bindings: [...(query.bindings ?? []), { type: "idset", value: filteredInstanceKeys.map((k) => k.id) }],
     };
+    /* c8 ignore end */
 }
 //# sourceMappingURL=IModelHierarchyProvider.js.map