@itwin/presentation-hierarchies 2.0.0-alpha.11 → 2.0.0-alpha.13

package/lib/cjs/presentation-hierarchies.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.setLogger = exports.getLogger = exports.HierarchySearchPath = exports.createHierarchySearchHelper = exports.mergeProviders = exports.createHierarchyProvider = exports.HierarchyNodeKey = exports.HierarchyNodeIdentifier = exports.HierarchyNode = exports.RowsLimitExceededError = exports.ProcessedHierarchyNode = exports.createMergedIModelHierarchyProvider = exports.createIModelHierarchyProvider = exports.createNodesQueryClauseFactory = exports.NodeSelectClauseColumnNames = exports.createLimitingECSqlQueryExecutor = exports.createPredicateBasedHierarchyDefinition = exports.HierarchyNodesDefinition = exports.GenericInstanceFilter = void 0;
+exports.setLogger = exports.getLogger = exports.HierarchySearchTree = exports.HierarchySearchPath = exports.createHierarchySearchHelper = exports.mergeProviders = exports.createHierarchyProvider = exports.HierarchyNodeKey = exports.HierarchyNodeIdentifier = exports.HierarchyNode = exports.RowsLimitExceededError = exports.ProcessedHierarchyNode = exports.createMergedIModelHierarchyProvider = exports.createIModelHierarchyProvider = exports.createNodesQueryClauseFactory = exports.NodeSelectClauseColumnNames = exports.createLimitingECSqlQueryExecutor = exports.createPredicateBasedHierarchyDefinition = exports.HierarchyNodesDefinition = exports.GenericInstanceFilter = void 0;
 var core_common_1 = require("@itwin/core-common");
 Object.defineProperty(exports, "GenericInstanceFilter", { enumerable: true, get: function () { return core_common_1.GenericInstanceFilter; } });
 var IModelHierarchyDefinition_js_1 = require("./hierarchies/imodel/IModelHierarchyDefinition.js");
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "mergeProviders", { enumerable: true, get: functi
 var HierarchySearch_js_1 = require("./hierarchies/HierarchySearch.js");
 Object.defineProperty(exports, "createHierarchySearchHelper", { enumerable: true, get: function () { return HierarchySearch_js_1.createHierarchySearchHelper; } });
 Object.defineProperty(exports, "HierarchySearchPath", { enumerable: true, get: function () { return HierarchySearch_js_1.HierarchySearchPath; } });
+Object.defineProperty(exports, "HierarchySearchTree", { enumerable: true, get: function () { return HierarchySearch_js_1.HierarchySearchTree; } });
 var Logging_js_1 = require("./hierarchies/Logging.js");
 Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return Logging_js_1.getLogger; } });
 Object.defineProperty(exports, "setLogger", { enumerable: true, get: function () { return Logging_js_1.setLogger; } });

package/lib/cjs/presentation-hierarchies.js.map

@@ -1 +1 @@
-{"version":3,"file":"presentation-hierarchies.js","sourceRoot":"","sources":["../../src/presentation-hierarchies.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,kDAA2D;AAAlD,oHAAA,qBAAqB,OAAA;AAU9B,kGAA6F;AAApF,wIAAA,wBAAwB,OAAA;AAMjC,kHAAoH;AAA3G,+JAAA,uCAAuC,OAAA;AAEhD,oGAAsG;AAA7F,iJAAA,gCAAgC,OAAA;AAEzC,4FAA4H;AAAnH,wIAAA,2BAA2B,OAAA;AAAE,0IAAA,6BAA6B,OAAA;AACnE,8FAAqI;AAA5H,2IAAA,6BAA6B,OAAA;AAAE,iJAAA,mCAAmC,OAAA;AAE3E,sFAAqF;AAA5E,gIAAA,sBAAsB,OAAA;AAE/B,uEAA0E;AAAjE,4HAAA,sBAAsB,OAAA;AAE/B,mEAA+D;AAAtD,iHAAA,aAAa,OAAA;AAEtB,uFAAmF;AAA1E,qIAAA,uBAAuB,OAAA;AAchC,yEAAqE;AAA5D,uHAAA,gBAAgB,OAAA;AAEzB,2EAA6E;AAApE,+HAAA,uBAAuB,OAAA;AAChC,qEAAiE;AAAxD,mHAAA,cAAc,OAAA;AAEvB,uEAAoG;AAA3F,iIAAA,2BAA2B,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AACzD,uDAAgE;AAAvD,uGAAA,SAAS,OAAA;AAAE,uGAAA,SAAS,OAAA","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\nexport { GenericInstanceFilter } from \"@itwin/core-common\";\n\nexport type {\n  DefineHierarchyLevelProps,\n  HierarchyLevelDefinition,\n  HierarchyDefinition,\n  NodeParser,\n  NodePostProcessor,\n  NodePreProcessor,\n} from \"./hierarchies/imodel/IModelHierarchyDefinition.js\";\nexport { HierarchyNodesDefinition } from \"./hierarchies/imodel/IModelHierarchyDefinition.js\";\nexport type {\n  DefineGenericNodeChildHierarchyLevelProps,\n  DefineInstanceNodeChildHierarchyLevelProps,\n  DefineRootHierarchyLevelProps,\n} from \"./hierarchies/imodel/PredicateBasedHierarchyDefinition.js\";\nexport { createPredicateBasedHierarchyDefinition } from \"./hierarchies/imodel/PredicateBasedHierarchyDefinition.js\";\nexport type { LimitingECSqlQueryExecutor } from \"./hierarchies/imodel/LimitingECSqlQueryExecutor.js\";\nexport { createLimitingECSqlQueryExecutor } from \"./hierarchies/imodel/LimitingECSqlQueryExecutor.js\";\nexport type { NodesQueryClauseFactory } from \"./hierarchies/imodel/NodeSelectQueryFactory.js\";\nexport { NodeSelectClauseColumnNames, createNodesQueryClauseFactory } from \"./hierarchies/imodel/NodeSelectQueryFactory.js\";\nexport { createIModelHierarchyProvider, createMergedIModelHierarchyProvider } from \"./hierarchies/imodel/IModelHierarchyProvider.js\";\nexport type { SourceHierarchyNode } from \"./hierarchies/imodel/IModelHierarchyNode.js\";\nexport { ProcessedHierarchyNode } from \"./hierarchies/imodel/IModelHierarchyNode.js\";\n\nexport { RowsLimitExceededError } from \"./hierarchies/HierarchyErrors.js\";\nexport type { GroupingHierarchyNode, NonGroupingHierarchyNode } from \"./hierarchies/HierarchyNode.js\";\nexport { HierarchyNode } from \"./hierarchies/HierarchyNode.js\";\nexport type { HierarchyNodeIdentifiersPath } from \"./hierarchies/HierarchyNodeIdentifier.js\";\nexport { HierarchyNodeIdentifier } from \"./hierarchies/HierarchyNodeIdentifier.js\";\nexport type {\n  GenericNodeKey,\n  GroupingNodeKey,\n  IModelInstanceKey,\n  InstancesNodeKey,\n  ClassGroupingNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n  IModelHierarchyNodeKey,\n} from \"./hierarchies/HierarchyNodeKey.js\";\nexport { HierarchyNodeKey } from \"./hierarchies/HierarchyNodeKey.js\";\nexport type { GetHierarchyNodesProps, HierarchyProvider } from \"./hierarchies/HierarchyProvider.js\";\nexport { createHierarchyProvider } from \"./hierarchies/HierarchyProvider.js\";\nexport { mergeProviders } from \"./hierarchies/HierarchyMerge.js\";\nexport type { HierarchySearchPathOptions } from \"./hierarchies/HierarchySearch.js\";\nexport { createHierarchySearchHelper, HierarchySearchPath } from \"./hierarchies/HierarchySearch.js\";\nexport { getLogger, setLogger } from \"./hierarchies/Logging.js\";\n"]}
+{"version":3,"file":"presentation-hierarchies.js","sourceRoot":"","sources":["../../src/presentation-hierarchies.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,kDAA2D;AAAlD,oHAAA,qBAAqB,OAAA;AAU9B,kGAA6F;AAApF,wIAAA,wBAAwB,OAAA;AAMjC,kHAAoH;AAA3G,+JAAA,uCAAuC,OAAA;AAEhD,oGAAsG;AAA7F,iJAAA,gCAAgC,OAAA;AAEzC,4FAA4H;AAAnH,wIAAA,2BAA2B,OAAA;AAAE,0IAAA,6BAA6B,OAAA;AACnE,8FAAqI;AAA5H,2IAAA,6BAA6B,OAAA;AAAE,iJAAA,mCAAmC,OAAA;AAE3E,sFAAqF;AAA5E,gIAAA,sBAAsB,OAAA;AAE/B,uEAA0E;AAAjE,4HAAA,sBAAsB,OAAA;AAE/B,mEAA+D;AAAtD,iHAAA,aAAa,OAAA;AAEtB,uFAAmF;AAA1E,qIAAA,uBAAuB,OAAA;AAchC,yEAAqE;AAA5D,uHAAA,gBAAgB,OAAA;AAEzB,2EAA6E;AAApE,+HAAA,uBAAuB,OAAA;AAChC,qEAAiE;AAAxD,mHAAA,cAAc,OAAA;AAEvB,uEAAyH;AAAhH,iIAAA,2BAA2B,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AAC9E,uDAAgE;AAAvD,uGAAA,SAAS,OAAA;AAAE,uGAAA,SAAS,OAAA","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\nexport { GenericInstanceFilter } from \"@itwin/core-common\";\n\nexport type {\n  DefineHierarchyLevelProps,\n  HierarchyLevelDefinition,\n  HierarchyDefinition,\n  NodeParser,\n  NodePostProcessor,\n  NodePreProcessor,\n} from \"./hierarchies/imodel/IModelHierarchyDefinition.js\";\nexport { HierarchyNodesDefinition } from \"./hierarchies/imodel/IModelHierarchyDefinition.js\";\nexport type {\n  DefineGenericNodeChildHierarchyLevelProps,\n  DefineInstanceNodeChildHierarchyLevelProps,\n  DefineRootHierarchyLevelProps,\n} from \"./hierarchies/imodel/PredicateBasedHierarchyDefinition.js\";\nexport { createPredicateBasedHierarchyDefinition } from \"./hierarchies/imodel/PredicateBasedHierarchyDefinition.js\";\nexport type { LimitingECSqlQueryExecutor } from \"./hierarchies/imodel/LimitingECSqlQueryExecutor.js\";\nexport { createLimitingECSqlQueryExecutor } from \"./hierarchies/imodel/LimitingECSqlQueryExecutor.js\";\nexport type { NodesQueryClauseFactory } from \"./hierarchies/imodel/NodeSelectQueryFactory.js\";\nexport { NodeSelectClauseColumnNames, createNodesQueryClauseFactory } from \"./hierarchies/imodel/NodeSelectQueryFactory.js\";\nexport { createIModelHierarchyProvider, createMergedIModelHierarchyProvider } from \"./hierarchies/imodel/IModelHierarchyProvider.js\";\nexport type { SourceHierarchyNode } from \"./hierarchies/imodel/IModelHierarchyNode.js\";\nexport { ProcessedHierarchyNode } from \"./hierarchies/imodel/IModelHierarchyNode.js\";\n\nexport { RowsLimitExceededError } from \"./hierarchies/HierarchyErrors.js\";\nexport type { GroupingHierarchyNode, NonGroupingHierarchyNode } from \"./hierarchies/HierarchyNode.js\";\nexport { HierarchyNode } from \"./hierarchies/HierarchyNode.js\";\nexport type { HierarchyNodeIdentifiersPath } from \"./hierarchies/HierarchyNodeIdentifier.js\";\nexport { HierarchyNodeIdentifier } from \"./hierarchies/HierarchyNodeIdentifier.js\";\nexport type {\n  GenericNodeKey,\n  GroupingNodeKey,\n  IModelInstanceKey,\n  InstancesNodeKey,\n  ClassGroupingNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n  IModelHierarchyNodeKey,\n} from \"./hierarchies/HierarchyNodeKey.js\";\nexport { HierarchyNodeKey } from \"./hierarchies/HierarchyNodeKey.js\";\nexport type { GetHierarchyNodesProps, HierarchyProvider } from \"./hierarchies/HierarchyProvider.js\";\nexport { createHierarchyProvider } from \"./hierarchies/HierarchyProvider.js\";\nexport { mergeProviders } from \"./hierarchies/HierarchyMerge.js\";\nexport type { HierarchySearchPathOptions } from \"./hierarchies/HierarchySearch.js\";\nexport { createHierarchySearchHelper, HierarchySearchPath, HierarchySearchTree } from \"./hierarchies/HierarchySearch.js\";\nexport { getLogger, setLogger } from \"./hierarchies/Logging.js\";\n"]}

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

@@ -1,22 +1,18 @@
 import { HierarchyNodeKey } from "./HierarchyNodeKey.js";
 import type { OmitOverUnion } from "@itwin/presentation-shared";
 import type { ClassGroupingNodeKey, GenericNodeKey, GroupingNodeKey, IModelHierarchyNodeKey, IModelInstanceKey, InstancesNodeKey, LabelGroupingNodeKey, PropertyGroupingNodeKey, PropertyOtherValuesGroupingNodeKey, PropertyValueGroupingNodeKey, PropertyValueRangeGroupingNodeKey } from "./HierarchyNodeKey.js";
-import type { HierarchySearchPath, HierarchySearchPathOptions } from "./HierarchySearch.js";
+import type { HierarchySearchTree } from "./HierarchySearch.js";
 /** @public */
-export type HierarchyNodeSearchProps = {
+export interface HierarchyNodeSearchProps {
     /** If set to true, then one of the ancestor nodes in the hierarchy is the search target. */
     hasSearchTargetAncestor?: boolean;
     /** Paths to node's children that are search targets. */
-    childrenTargetPaths?: HierarchySearchPath[];
-} & ({
+    childrenTargetPaths?: HierarchySearchTree[];
     /** Whether or not this node is a search target. */
-    isSearchTarget?: false;
-} | {
-    /** Whether or not this node is a search target. */
-    isSearchTarget: true;
-    /** Options that were used to search the node. */
-    searchTargetOptions?: HierarchySearchPathOptions;
-});
+    isSearchTarget?: boolean;
+    /** Options assigned to this node through search. */
+    options?: HierarchySearchTree["options"];
+}
 /**
  * A data structure that defines attributes that are common to all types of hierarchy nodes.
  * @public
@@ -136,6 +132,12 @@ export declare namespace HierarchyNode {
         key: PropertyGroupingNodeKey;
         supportsFiltering?: undefined;
     } & GroupingHierarchyNode;
+    /**
+     * Gets the grouping level of the given grouping node.
+     *
+     * May be useful when setting `groupingLevel` for `HierarchySearchTree.options.autoExpand` or `HierarchySearchPathOptions.reveal`.
+     */
+    function getGroupingNodeLevel(groupingNode: Pick<GroupingHierarchyNode, "key" | "parentKeys">): number;
 }
 /**
  * A type of `HierarchyNode` that doesn't know about its children and is an input when requesting

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNode.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EACV,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,iCAAiC,EAClC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAE5F,cAAc;AACd,MAAM,MAAM,wBAAwB,GAAG;IACrC,4FAA4F;IAC5F,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC7C,GAAG,CACA;IACE,mDAAmD;IACnD,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,GACD;IACE,mDAAmD;IACnD,cAAc,EAAE,IAAI,CAAC;IACrB,iDAAiD;IACjD,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;CAClD,CACJ,CAAC;AAEF;;;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;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,iEAAiE;IACjE,GAAG,EAAE,cAAc,GAAG,gBAAgB,CAAC;IACvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,uEAAuE;IACvE,MAAM,CAAC,EAAE,wBAAwB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,2EAA2E;IAC3E,GAAG,EAAE,eAAe,CAAC;IAErB;;;OAGG;IACH,mBAAmB,EAAE,iBAAiB,EAAE,CAAC;IAEzC,+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,cAAc;AAEd,yBAAiB,aAAa,CAAC;IAC7B,sDAAsD;IACtD,SAAgB,SAAS,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,wBAAwB,GAAG;QAAE,GAAG,EAAE,cAAc,CAAA;KAAE,CAElJ;IACD,8EAA8E;IAC9E,SAAgB,YAAY,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,sBAAsB,CAAA;KAAE,CAElI;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,wBAAwB,GAAG;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,CAE1J;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,qBAAqB,CAE1H;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,qBAAqB,CAEtG;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,qBAAqB,CAEtG;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,qBAAqB,CAEpH;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,qBAAqB,CAE9G;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,qBAAqB,CAEnH;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,qBAAqB,CAEzG;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,aAAa,IAAI,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC"}
+{"version":3,"file":"HierarchyNode.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EACV,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,iCAAiC,EAClC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,4FAA4F;IAC5F,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC5C,mDAAmD;IACnD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oDAAoD;IACpD,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;CAC1C;AAED;;;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;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,iEAAiE;IACjE,GAAG,EAAE,cAAc,GAAG,gBAAgB,CAAC;IACvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,uEAAuE;IACvE,MAAM,CAAC,EAAE,wBAAwB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,2EAA2E;IAC3E,GAAG,EAAE,eAAe,CAAC;IAErB;;;OAGG;IACH,mBAAmB,EAAE,iBAAiB,EAAE,CAAC;IAEzC,+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,cAAc;AAEd,yBAAiB,aAAa,CAAC;IAC7B,sDAAsD;IACtD,SAAgB,SAAS,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,wBAAwB,GAAG;QAAE,GAAG,EAAE,cAAc,CAAA;KAAE,CAElJ;IACD,8EAA8E;IAC9E,SAAgB,YAAY,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,sBAAsB,CAAA;KAAE,CAElI;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,wBAAwB,GAAG;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,CAE1J;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,qBAAqB,CAE1H;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,qBAAqB,CAEtG;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,qBAAqB,CAEtG;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,qBAAqB,CAEpH;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,qBAAqB,CAE9G;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,qBAAqB,CAEnH;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,qBAAqB,CAEzG;IAED;;;;OAIG;IACH,SAAgB,oBAAoB,CAAC,YAAY,EAAE,IAAI,CAAC,qBAAqB,EAAE,KAAK,GAAG,YAAY,CAAC,GAAG,MAAM,CAU5G;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,GAAG,aAAa,IAAI,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC"}

package/lib/esm/hierarchies/HierarchyNode.js

@@ -57,5 +57,23 @@ export var HierarchyNode;
         return HierarchyNodeKey.isPropertyGrouping(node.key);
     }
     HierarchyNode.isPropertyGroupingNode = isPropertyGroupingNode;
+    /**
+     * Gets the grouping level of the given grouping node.
+     *
+     * May be useful when setting `groupingLevel` for `HierarchySearchTree.options.autoExpand` or `HierarchySearchPathOptions.reveal`.
+     */
+    function getGroupingNodeLevel(groupingNode) {
+        let level = 1;
+        for (let i = groupingNode.parentKeys.length - 1; i >= 0; i--) {
+            if (HierarchyNodeKey.isGrouping(groupingNode.parentKeys[i])) {
+                level++;
+            }
+            else {
+                break;
+            }
+        }
+        return level;
+    }
+    HierarchyNode.getGroupingNodeLevel = getGroupingNodeLevel;
 })(HierarchyNode || (HierarchyNode = {}));
 //# sourceMappingURL=HierarchyNode.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNode.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AA8FzD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,aAAa,CAqD7B;AArDD,WAAiB,aAAa;IAC5B,sDAAsD;IACtD,SAAgB,SAAS,CAA0C,IAAW;QAC5E,OAAO,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,uBAAS,YAExB,CAAA;IACD,8EAA8E;IAC9E,SAAgB,YAAY,CAA0C,IAAW;QAC/E,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAFe,0BAAY,eAE3B,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAA0C,IAAW;QAClF,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAFe,6BAAe,kBAE9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAA0C,IAAW;QACjF,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAFe,4BAAc,iBAE7B,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,iCAAmB,sBAIlC,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,iCAAmB,sBAIlC,CAAA;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAC/C,IAAW;QAEX,OAAO,gBAAgB,CAAC,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAJe,+CAAiC,oCAIhD,CAAA;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CACzC,IAAW;QAEX,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAJe,yCAA2B,8BAI1C,CAAA;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAC9C,IAAW;QAEX,OAAO,gBAAgB,CAAC,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IAJe,8CAAgC,mCAI/C,CAAA;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CACpC,IAAW;QAEX,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAJe,oCAAsB,yBAIrC,CAAA;AACH,CAAC,EArDgB,aAAa,KAAb,aAAa,QAqD7B","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 { HierarchyNodeKey } from \"./HierarchyNodeKey.js\";\n\nimport type { OmitOverUnion } from \"@itwin/presentation-shared\";\nimport type {\n  ClassGroupingNodeKey,\n  GenericNodeKey,\n  GroupingNodeKey,\n  IModelHierarchyNodeKey,\n  IModelInstanceKey,\n  InstancesNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n} from \"./HierarchyNodeKey.js\";\nimport type { HierarchySearchPath, HierarchySearchPathOptions } from \"./HierarchySearch.js\";\n\n/** @public */\nexport type HierarchyNodeSearchProps = {\n  /** If set to true, then one of the ancestor nodes in the hierarchy is the search target. */\n  hasSearchTargetAncestor?: boolean;\n  /** Paths to node's children that are search targets. */\n  childrenTargetPaths?: HierarchySearchPath[];\n} & (\n  | {\n      /** Whether or not this node is a search target. */\n      isSearchTarget?: false;\n    }\n  | {\n      /** Whether or not this node is a search target. */\n      isSearchTarget: true;\n      /** Options that were used to search the node. */\n      searchTargetOptions?: HierarchySearchPathOptions;\n    }\n);\n\n/**\n * A data structure that defines attributes that are common to all types of hierarchy nodes.\n * @public\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}\n\n/**\n * A data structure that represents a single non-grouping hierarchy node.\n * @public\n */\nexport interface NonGroupingHierarchyNode extends BaseHierarchyNode {\n  /** An identifier to identify the node in its hierarchy level. */\n  key: GenericNodeKey | 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  /** Data that is assigned to the node if hierarchy search is enabled */\n  search?: HierarchyNodeSearchProps;\n}\n\n/**\n * A data structure that represents a grouping node that groups other nodes.\n * @public\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: IModelInstanceKey[];\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 * @public\n */\nexport type HierarchyNode = NonGroupingHierarchyNode | GroupingHierarchyNode;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNode {\n  /** Checks whether the given node is a generic node */\n  export function isGeneric<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & NonGroupingHierarchyNode & { key: GenericNodeKey } {\n    return HierarchyNodeKey.isGeneric(node.key);\n  }\n  /** Checks whether the given node is a standard (iModel content based) node */\n  export function isIModelNode<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & { key: IModelHierarchyNodeKey } {\n    return HierarchyNodeKey.isIModelNodeKey(node.key);\n  }\n  /** Checks whether the given node is an ECInstances-based node */\n  export function isInstancesNode<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & 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 }>(node: TNode): node is TNode & 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 } & 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 } & 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 } & 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 } & 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 } & 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 } & 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 * @public\n */\nexport type ParentHierarchyNode<TBase = HierarchyNode> = OmitOverUnion<TBase, \"children\">;\n"]}
+{"version":3,"file":"HierarchyNode.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNode.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAuFzD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,aAAa,CAsE7B;AAtED,WAAiB,aAAa;IAC5B,sDAAsD;IACtD,SAAgB,SAAS,CAA0C,IAAW;QAC5E,OAAO,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,uBAAS,YAExB,CAAA;IACD,8EAA8E;IAC9E,SAAgB,YAAY,CAA0C,IAAW;QAC/E,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAFe,0BAAY,eAE3B,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAA0C,IAAW;QAClF,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAFe,6BAAe,kBAE9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAA0C,IAAW;QACjF,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAFe,4BAAc,iBAE7B,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,iCAAmB,sBAIlC,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,iCAAmB,sBAIlC,CAAA;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAC/C,IAAW;QAEX,OAAO,gBAAgB,CAAC,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAJe,+CAAiC,oCAIhD,CAAA;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CACzC,IAAW;QAEX,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAJe,yCAA2B,8BAI1C,CAAA;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAC9C,IAAW;QAEX,OAAO,gBAAgB,CAAC,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IAJe,8CAAgC,mCAI/C,CAAA;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CACpC,IAAW;QAEX,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAJe,oCAAsB,yBAIrC,CAAA;IAED;;;;OAIG;IACH,SAAgB,oBAAoB,CAAC,YAA+D;QAClG,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,IAAI,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,IAAI,gBAAgB,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5D,KAAK,EAAE,CAAC;YACV,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAVe,kCAAoB,uBAUnC,CAAA;AACH,CAAC,EAtEgB,aAAa,KAAb,aAAa,QAsE7B","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 { HierarchyNodeKey } from \"./HierarchyNodeKey.js\";\n\nimport type { OmitOverUnion } from \"@itwin/presentation-shared\";\nimport type {\n  ClassGroupingNodeKey,\n  GenericNodeKey,\n  GroupingNodeKey,\n  IModelHierarchyNodeKey,\n  IModelInstanceKey,\n  InstancesNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n} from \"./HierarchyNodeKey.js\";\nimport type { HierarchySearchTree } from \"./HierarchySearch.js\";\n\n/** @public */\nexport interface HierarchyNodeSearchProps {\n  /** If set to true, then one of the ancestor nodes in the hierarchy is the search target. */\n  hasSearchTargetAncestor?: boolean;\n  /** Paths to node's children that are search targets. */\n  childrenTargetPaths?: HierarchySearchTree[];\n  /** Whether or not this node is a search target. */\n  isSearchTarget?: boolean;\n  /** Options assigned to this node through search. */\n  options?: HierarchySearchTree[\"options\"];\n}\n\n/**\n * A data structure that defines attributes that are common to all types of hierarchy nodes.\n * @public\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}\n\n/**\n * A data structure that represents a single non-grouping hierarchy node.\n * @public\n */\nexport interface NonGroupingHierarchyNode extends BaseHierarchyNode {\n  /** An identifier to identify the node in its hierarchy level. */\n  key: GenericNodeKey | 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  /** Data that is assigned to the node if hierarchy search is enabled */\n  search?: HierarchyNodeSearchProps;\n}\n\n/**\n * A data structure that represents a grouping node that groups other nodes.\n * @public\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: IModelInstanceKey[];\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 * @public\n */\nexport type HierarchyNode = NonGroupingHierarchyNode | GroupingHierarchyNode;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNode {\n  /** Checks whether the given node is a generic node */\n  export function isGeneric<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & NonGroupingHierarchyNode & { key: GenericNodeKey } {\n    return HierarchyNodeKey.isGeneric(node.key);\n  }\n  /** Checks whether the given node is a standard (iModel content based) node */\n  export function isIModelNode<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & { key: IModelHierarchyNodeKey } {\n    return HierarchyNodeKey.isIModelNodeKey(node.key);\n  }\n  /** Checks whether the given node is an ECInstances-based node */\n  export function isInstancesNode<TNode extends { key: HierarchyNodeKey }>(node: TNode): node is TNode & 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 }>(node: TNode): node is TNode & 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 } & 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 } & 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 } & 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 } & 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 } & 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 } & GroupingHierarchyNode {\n    return HierarchyNodeKey.isPropertyGrouping(node.key);\n  }\n\n  /**\n   * Gets the grouping level of the given grouping node.\n   *\n   * May be useful when setting `groupingLevel` for `HierarchySearchTree.options.autoExpand` or `HierarchySearchPathOptions.reveal`.\n   */\n  export function getGroupingNodeLevel(groupingNode: Pick<GroupingHierarchyNode, \"key\" | \"parentKeys\">): number {\n    let level = 1;\n    for (let i = groupingNode.parentKeys.length - 1; i >= 0; i--) {\n      if (HierarchyNodeKey.isGrouping(groupingNode.parentKeys[i])) {\n        level++;\n      } else {\n        break;\n      }\n    }\n    return level;\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 * @public\n */\nexport type ParentHierarchyNode<TBase = HierarchyNode> = OmitOverUnion<TBase, \"children\">;\n"]}

package/lib/esm/hierarchies/HierarchyNodeIdentifier.d.ts

@@ -18,6 +18,8 @@ export declare namespace HierarchyNodeIdentifier {
     function isGenericNodeIdentifier(id: HierarchyNodeIdentifier): id is GenericNodeKey;
     /** Checks two identifiers for equality */
     function equal(lhs: HierarchyNodeIdentifier, rhs: HierarchyNodeIdentifier): boolean;
+    /** Compares two identifiers */
+    function compare(lhs: HierarchyNodeIdentifier, rhs: HierarchyNodeIdentifier): number;
 }
 /**
  * A path of hierarchy node identifiers, typically used to describe a path from root down

package/lib/esm/hierarchies/HierarchyNodeIdentifier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNodeIdentifier.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeIdentifier.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/E;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GAAG,cAAc,CAAC;AAEzE,cAAc;AAEd,yBAAiB,uBAAuB,CAAC;IACvC,yEAAyE;IACzE,SAAgB,wBAAwB,CAAC,EAAE,EAAE,uBAAuB,GAAG,EAAE,IAAI,iBAAiB,CAE7F;IAED,uEAAuE;IACvE,SAAgB,uBAAuB,CAAC,EAAE,EAAE,uBAAuB,GAAG,EAAE,IAAI,cAAc,CAEzF;IAED,0CAA0C;IAC1C,SAAgB,KAAK,CAAC,GAAG,EAAE,uBAAuB,EAAE,GAAG,EAAE,uBAAuB,WAQ/E;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG,uBAAuB,EAAE,CAAC"}
+{"version":3,"file":"HierarchyNodeIdentifier.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeIdentifier.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/E;;;;;;;;;GASG;AACH,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GAAG,cAAc,CAAC;AAEzE,cAAc;AAEd,yBAAiB,uBAAuB,CAAC;IACvC,yEAAyE;IACzE,SAAgB,wBAAwB,CAAC,EAAE,EAAE,uBAAuB,GAAG,EAAE,IAAI,iBAAiB,CAE7F;IAED,uEAAuE;IACvE,SAAgB,uBAAuB,CAAC,EAAE,EAAE,uBAAuB,GAAG,EAAE,IAAI,cAAc,CAEzF;IAED,0CAA0C;IAC1C,SAAgB,KAAK,CAAC,GAAG,EAAE,uBAAuB,EAAE,GAAG,EAAE,uBAAuB,WAE/E;IAED,+BAA+B;IAC/B,SAAgB,OAAO,CAAC,GAAG,EAAE,uBAAuB,EAAE,GAAG,EAAE,uBAAuB,GAAG,MAAM,CAmB1F;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG,uBAAuB,EAAE,CAAC"}

package/lib/esm/hierarchies/HierarchyNodeIdentifier.js

@@ -2,6 +2,7 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
+import { compareStrings, compareStringsOrUndefined } from "@itwin/core-bentley";
 import { InstanceKey } from "@itwin/presentation-shared";
 /** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
@@ -19,14 +20,30 @@ export var HierarchyNodeIdentifier;
     HierarchyNodeIdentifier.isGenericNodeIdentifier = isGenericNodeIdentifier;
     /** Checks two identifiers for equality */
     function equal(lhs, rhs) {
-        if (isInstanceNodeIdentifier(lhs) && isInstanceNodeIdentifier(rhs)) {
-            return InstanceKey.equals(lhs, rhs) && lhs.imodelKey === rhs.imodelKey;
+        return compare(lhs, rhs) === 0;
+    }
+    HierarchyNodeIdentifier.equal = equal;
+    /** Compares two identifiers */
+    function compare(lhs, rhs) {
+        if (HierarchyNodeIdentifier.isGenericNodeIdentifier(lhs)) {
+            if (HierarchyNodeIdentifier.isGenericNodeIdentifier(rhs)) {
+                const sourceCompareResult = compareStringsOrUndefined(lhs.source, rhs.source);
+                if (sourceCompareResult !== 0) {
+                    return sourceCompareResult;
+                }
+                return compareStrings(lhs.id, rhs.id);
+            }
+            return -1;
         }
-        if (isGenericNodeIdentifier(lhs) && isGenericNodeIdentifier(rhs)) {
-            return lhs.source === rhs.source && lhs.id === rhs.id;
+        if (HierarchyNodeIdentifier.isInstanceNodeIdentifier(rhs)) {
+            const imodelKeyCompareResult = compareStringsOrUndefined(lhs.imodelKey, rhs.imodelKey);
+            if (imodelKeyCompareResult !== 0) {
+                return imodelKeyCompareResult;
+            }
+            return InstanceKey.compare(lhs, rhs);
         }
-        return false;
+        return 1;
     }
-    HierarchyNodeIdentifier.equal = equal;
+    HierarchyNodeIdentifier.compare = compare;
 })(HierarchyNodeIdentifier || (HierarchyNodeIdentifier = {}));
 //# sourceMappingURL=HierarchyNodeIdentifier.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNodeIdentifier.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeIdentifier.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAgBzD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,uBAAuB,CAqBvC;AArBD,WAAiB,uBAAuB;IACtC,yEAAyE;IACzE,SAAgB,wBAAwB,CAAC,EAA2B;QAClE,OAAO,WAAW,IAAI,EAAE,CAAC;IAC3B,CAAC;IAFe,gDAAwB,2BAEvC,CAAA;IAED,uEAAuE;IACvE,SAAgB,uBAAuB,CAAC,EAA2B;QACjE,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAFe,+CAAuB,0BAEtC,CAAA;IAED,0CAA0C;IAC1C,SAAgB,KAAK,CAAC,GAA4B,EAAE,GAA4B;QAC9E,IAAI,wBAAwB,CAAC,GAAG,CAAC,IAAI,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC;YACnE,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC;QACzE,CAAC;QACD,IAAI,uBAAuB,CAAC,GAAG,CAAC,IAAI,uBAAuB,CAAC,GAAG,CAAC,EAAE,CAAC;YACjE,OAAO,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC;QACxD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IARe,6BAAK,QAQpB,CAAA;AACH,CAAC,EArBgB,uBAAuB,KAAvB,uBAAuB,QAqBvC","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 { InstanceKey } from \"@itwin/presentation-shared\";\n\nimport type { GenericNodeKey, IModelInstanceKey } from \"./HierarchyNodeKey.js\";\n\n/**\n * An identifier that can be used to identify either an ECInstance or a generic node.\n *\n * This is different from `HierarchyNodeKey` - the key can represent more types of nodes and,\n * in case of `InstancesNodeKey`, contains information about all instances the node represents.\n * `HierarchyNodeIdentifier`, on the other hand, is used for matching a node, so it only needs\n * to contain information about a single instance.\n *\n * @public\n */\nexport type HierarchyNodeIdentifier = IModelInstanceKey | GenericNodeKey;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodeIdentifier {\n  /** Checks whether the given identifier is an instance node identifier */\n  export function isInstanceNodeIdentifier(id: HierarchyNodeIdentifier): id is IModelInstanceKey {\n    return \"className\" in id;\n  }\n\n  /** Checks whether the given identifier is a generic node identifier */\n  export function isGenericNodeIdentifier(id: HierarchyNodeIdentifier): id is GenericNodeKey {\n    return !isInstanceNodeIdentifier(id);\n  }\n\n  /** Checks two identifiers for equality */\n  export function equal(lhs: HierarchyNodeIdentifier, rhs: HierarchyNodeIdentifier) {\n    if (isInstanceNodeIdentifier(lhs) && isInstanceNodeIdentifier(rhs)) {\n      return InstanceKey.equals(lhs, rhs) && lhs.imodelKey === rhs.imodelKey;\n    }\n    if (isGenericNodeIdentifier(lhs) && isGenericNodeIdentifier(rhs)) {\n      return lhs.source === rhs.source && lhs.id === rhs.id;\n    }\n    return false;\n  }\n}\n\n/**\n * A path of hierarchy node identifiers, typically used to describe a path from root down\n * to specific node deep in the hierarchy.\n *\n * @public\n */\nexport type HierarchyNodeIdentifiersPath = HierarchyNodeIdentifier[];\n"]}
+{"version":3,"file":"HierarchyNodeIdentifier.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeIdentifier.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAgBzD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,uBAAuB,CAqCvC;AArCD,WAAiB,uBAAuB;IACtC,yEAAyE;IACzE,SAAgB,wBAAwB,CAAC,EAA2B;QAClE,OAAO,WAAW,IAAI,EAAE,CAAC;IAC3B,CAAC;IAFe,gDAAwB,2BAEvC,CAAA;IAED,uEAAuE;IACvE,SAAgB,uBAAuB,CAAC,EAA2B;QACjE,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAFe,+CAAuB,0BAEtC,CAAA;IAED,0CAA0C;IAC1C,SAAgB,KAAK,CAAC,GAA4B,EAAE,GAA4B;QAC9E,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAFe,6BAAK,QAEpB,CAAA;IAED,+BAA+B;IAC/B,SAAgB,OAAO,CAAC,GAA4B,EAAE,GAA4B;QAChF,IAAI,uBAAuB,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,CAAC;YACzD,IAAI,uBAAuB,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzD,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC9E,IAAI,mBAAmB,KAAK,CAAC,EAAE,CAAC;oBAC9B,OAAO,mBAAmB,CAAC;gBAC7B,CAAC;gBACD,OAAO,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;YACxC,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,uBAAuB,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1D,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;YACvF,IAAI,sBAAsB,KAAK,CAAC,EAAE,CAAC;gBACjC,OAAO,sBAAsB,CAAC;YAChC,CAAC;YACD,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAnBe,+BAAO,UAmBtB,CAAA;AACH,CAAC,EArCgB,uBAAuB,KAAvB,uBAAuB,QAqCvC","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 { compareStrings, compareStringsOrUndefined } from \"@itwin/core-bentley\";\nimport { InstanceKey } from \"@itwin/presentation-shared\";\n\nimport type { GenericNodeKey, IModelInstanceKey } from \"./HierarchyNodeKey.js\";\n\n/**\n * An identifier that can be used to identify either an ECInstance or a generic node.\n *\n * This is different from `HierarchyNodeKey` - the key can represent more types of nodes and,\n * in case of `InstancesNodeKey`, contains information about all instances the node represents.\n * `HierarchyNodeIdentifier`, on the other hand, is used for matching a node, so it only needs\n * to contain information about a single instance.\n *\n * @public\n */\nexport type HierarchyNodeIdentifier = IModelInstanceKey | GenericNodeKey;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodeIdentifier {\n  /** Checks whether the given identifier is an instance node identifier */\n  export function isInstanceNodeIdentifier(id: HierarchyNodeIdentifier): id is IModelInstanceKey {\n    return \"className\" in id;\n  }\n\n  /** Checks whether the given identifier is a generic node identifier */\n  export function isGenericNodeIdentifier(id: HierarchyNodeIdentifier): id is GenericNodeKey {\n    return !isInstanceNodeIdentifier(id);\n  }\n\n  /** Checks two identifiers for equality */\n  export function equal(lhs: HierarchyNodeIdentifier, rhs: HierarchyNodeIdentifier) {\n    return compare(lhs, rhs) === 0;\n  }\n\n  /** Compares two identifiers */\n  export function compare(lhs: HierarchyNodeIdentifier, rhs: HierarchyNodeIdentifier): number {\n    if (HierarchyNodeIdentifier.isGenericNodeIdentifier(lhs)) {\n      if (HierarchyNodeIdentifier.isGenericNodeIdentifier(rhs)) {\n        const sourceCompareResult = compareStringsOrUndefined(lhs.source, rhs.source);\n        if (sourceCompareResult !== 0) {\n          return sourceCompareResult;\n        }\n        return compareStrings(lhs.id, rhs.id);\n      }\n      return -1;\n    }\n    if (HierarchyNodeIdentifier.isInstanceNodeIdentifier(rhs)) {\n      const imodelKeyCompareResult = compareStringsOrUndefined(lhs.imodelKey, rhs.imodelKey);\n      if (imodelKeyCompareResult !== 0) {\n        return imodelKeyCompareResult;\n      }\n      return InstanceKey.compare(lhs, rhs);\n    }\n    return 1;\n  }\n}\n\n/**\n * A path of hierarchy node identifiers, typically used to describe a path from root down\n * to specific node deep in the hierarchy.\n *\n * @public\n */\nexport type HierarchyNodeIdentifiersPath = HierarchyNodeIdentifier[];\n"]}

package/lib/esm/hierarchies/HierarchyNodeKey.d.ts

@@ -1,4 +1,5 @@
 import { InstanceKey } from "@itwin/presentation-shared";
+import type { EC } from "@itwin/presentation-shared";
 /**
  * An instance key that may be associated with specific iModel.
  * @public
@@ -45,7 +46,7 @@ export interface ClassGroupingNodeKey {
     /** Type of the node */
     type: "class-grouping";
     /** Full name of the ECClass that this grouping node is grouping by. */
-    className: string;
+    className: EC.FullClassName;
 }
 /**
  * A key for a label-grouping node.
@@ -72,7 +73,7 @@ export interface PropertyOtherValuesGroupingNodeKey {
     type: "property-grouping:other";
     /** Identifiers of properties whose values are grouped under this node. */
     properties: Array<{
-        className: string;
+        className: EC.FullClassName;
         propertyName: string;
     }>;
 }
@@ -86,7 +87,7 @@ export interface PropertyValueGroupingNodeKey {
     /** Name of the property that is used for grouping nodes. */
     propertyName: string;
     /** Full name of the ECClass containing the property. */
-    propertyClassName: string;
+    propertyClassName: EC.FullClassName;
     /** Formatted property value that this node is grouping by. */
     formattedPropertyValue: string;
 }
@@ -100,7 +101,7 @@ export interface PropertyValueRangeGroupingNodeKey {
     /** Name of the property that is used for grouping nodes. */
     propertyName: string;
     /** Full name of the ECClass containing the property. */
-    propertyClassName: string;
+    propertyClassName: EC.FullClassName;
     /** Defines the start of the values' range that this node is grouping by. */
     fromValue: number;
     /** Defines the end of the values' range that this node is grouping by. */

package/lib/esm/hierarchies/HierarchyNodeKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNodeKey.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeKey.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAA0B,MAAM,4BAA4B,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,IAAI,EAAE,SAAS,CAAC;IAEhB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,WAAW,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,iBAAiB,EAAE,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;IAEvB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;IAEvB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD,uBAAuB;IACvB,IAAI,EAAE,yBAAyB,CAAC;IAChC,0EAA0E;IAC1E,UAAU,EAAE,KAAK,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,uBAAuB;IACvB,IAAI,EAAE,yBAAyB,CAAC;IAEhC,4DAA4D;IAC5D,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,iBAAiB,EAAE,MAAM,CAAC;IAE1B,8DAA8D;IAC9D,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,uBAAuB;IACvB,IAAI,EAAE,yBAAyB,CAAC;IAEhC,4DAA4D;IAC5D,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,iBAAiB,EAAE,MAAM,CAAC;IAE1B,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAElB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,iCAAiC,GAAG,4BAA4B,GAAG,kCAAkC,CAAC;AAE5I;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,uBAAuB,CAAC;AAEpG;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,cAAc,CAAC;AAEvE,cAAc;AAEd,yBAAiB,gBAAgB,CAAC;IAChC,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,cAAc,CAEtE;IAED,yEAAyE;IACzE,SAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,sBAAsB,CAEpF;IAED,kEAAkE;IAClE,SAAgB,WAAW,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,gBAAgB,CAE1E;IAED,gEAAgE;IAChE,SAAgB,UAAU,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,eAAe,CAExE;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,oBAAoB,CAElF;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,oBAAoB,CAElF;IAED,mFAAmF;IACnF,SAAgB,6BAA6B,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,kCAAkC,CAE9G;IAED,kFAAkF;IAClF,SAAgB,4BAA4B,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,iCAAiC,CAE5G;IAED,6EAA6E;IAC7E,SAAgB,uBAAuB,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,4BAA4B,CAElG;IAED,wEAAwE;IACxE,SAAgB,kBAAkB,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,uBAAuB,CAExF;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,gBAAgB,GAAG,MAAM,CAiG5E;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAE5E;CACF"}
+{"version":3,"file":"HierarchyNodeKey.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeKey.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAA0B,MAAM,4BAA4B,CAAC;AAEjF,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,IAAI,EAAE,SAAS,CAAC;IAEhB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,WAAW,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,iBAAiB,EAAE,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;IAEvB,uEAAuE;IACvE,SAAS,EAAE,EAAE,CAAC,aAAa,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,uBAAuB;IACvB,IAAI,EAAE,gBAAgB,CAAC;IAEvB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD,uBAAuB;IACvB,IAAI,EAAE,yBAAyB,CAAC;IAChC,0EAA0E;IAC1E,UAAU,EAAE,KAAK,CAAC;QAChB,SAAS,EAAE,EAAE,CAAC,aAAa,CAAC;QAC5B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,uBAAuB;IACvB,IAAI,EAAE,yBAAyB,CAAC;IAEhC,4DAA4D;IAC5D,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,iBAAiB,EAAE,EAAE,CAAC,aAAa,CAAC;IAEpC,8DAA8D;IAC9D,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,uBAAuB;IACvB,IAAI,EAAE,yBAAyB,CAAC;IAEhC,4DAA4D;IAC5D,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,iBAAiB,EAAE,EAAE,CAAC,aAAa,CAAC;IAEpC,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAElB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,iCAAiC,GAAG,4BAA4B,GAAG,kCAAkC,CAAC;AAE5I;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,uBAAuB,CAAC;AAEpG;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,cAAc,CAAC;AAEvE,cAAc;AAEd,yBAAiB,gBAAgB,CAAC;IAChC,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,cAAc,CAEtE;IAED,yEAAyE;IACzE,SAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,sBAAsB,CAEpF;IAED,kEAAkE;IAClE,SAAgB,WAAW,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,gBAAgB,CAE1E;IAED,gEAAgE;IAChE,SAAgB,UAAU,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,eAAe,CAExE;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,oBAAoB,CAElF;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,oBAAoB,CAElF;IAED,mFAAmF;IACnF,SAAgB,6BAA6B,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,kCAAkC,CAE9G;IAED,kFAAkF;IAClF,SAAgB,4BAA4B,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,iCAAiC,CAE5G;IAED,6EAA6E;IAC7E,SAAgB,uBAAuB,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,4BAA4B,CAElG;IAED,wEAAwE;IACxE,SAAgB,kBAAkB,CAAC,GAAG,EAAE,gBAAgB,GAAG,GAAG,IAAI,uBAAuB,CAExF;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,gBAAgB,GAAG,MAAM,CAiG5E;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAE5E;CACF"}

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyNodeKey.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeKey.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AA0JjF,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,gBAAgB,CAgKhC;AAhKD,WAAiB,gBAAgB;IAC/B,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,GAAqB;QAC7C,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC;IAChC,CAAC;IAFe,0BAAS,YAExB,CAAA;IAED,yEAAyE;IACzE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,kEAAkE;IAClE,SAAgB,WAAW,CAAC,GAAqB;QAC/C,OAAO,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC;IAClC,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,gEAAgE;IAChE,SAAgB,UAAU,CAAC,GAAqB;QAC9C,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,2BAAU,aAEzB,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,mFAAmF;IACnF,SAAgB,6BAA6B,CAAC,GAAqB;QACjE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,8CAA6B,gCAE5C,CAAA;IAED,kFAAkF;IAClF,SAAgB,4BAA4B,CAAC,GAAqB;QAChE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED,6EAA6E;IAC7E,SAAgB,uBAAuB,CAAC,GAAqB;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED,wEAAwE;IACxE,SAAgB,kBAAkB,CAAC,GAAqB;QACtD,OAAO,6BAA6B,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,GAAG,CAAC,IAAI,uBAAuB,CAAC,GAAG,CAAC,CAAC;IACjH,CAAC;IAFe,mCAAkB,qBAEjC,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAqB,EAAE,GAAqB;QAClE,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;gBAC/B,MAAM,eAAe,GAAG,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,eAAe,CAAC;gBACzB,CAAC;gBACD,OAAO,yBAAyB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC;YACD,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;gBACjC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;oBACxD,OAAO,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBACjD,MAAM,wBAAwB,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/F,IAAI,wBAAwB,KAAK,CAAC,EAAE,CAAC;wBACnC,OAAO,wBAAwB,CAAC;oBAClC,CAAC;oBACD,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBACvH,IAAI,sBAAsB,KAAK,CAAC,EAAE,CAAC;wBACjC,OAAO,sBAAsB,CAAC;oBAChC,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,OAAO,cAAc,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,EAAE,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC9I,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,MAAM,kBAAkB,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBAChE,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;oBAC7B,OAAO,kBAAkB,CAAC;gBAC5B,CAAC;gBACD,OAAO,yBAAyB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC7D,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;oBACpD,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;gBACvD,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBAC/C,MAAM,kBAAkB,GAAG,cAAc,CACvC,sBAAsB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,EACvE,sBAAsB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,CACxE,CAAC;oBACF,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;wBAC7B,OAAO,kBAAkB,CAAC;oBAC5B,CAAC;oBACD,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC;oBACjJ,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;wBAC5B,OAAO,iBAAiB,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,cAAc,CACnD,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,EACjE,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,CAClE,CAAC;gBACF,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBAC7H,IAAI,yBAAyB,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,yBAAyB,CAAC;gBACnC,CAAC;gBACD,OAAO,cAAc,CAAC,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAChF,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,cAAc,CACnD,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,EACjE,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,CAClE,CAAC;gBACF,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBAC7H,IAAI,yBAAyB,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,yBAAyB,CAAC;gBACnC,CAAC;gBACD,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC;oBACpC,OAAO,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChD,CAAC;gBACD,OAAO,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IAjGe,wBAAO,UAiGtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAqB,EAAE,GAAqB;QACjE,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAFe,uBAAM,SAErB,CAAA;AACH,CAAC,EAhKgB,gBAAgB,KAAhB,gBAAgB,QAgKhC","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 { assert, compareStrings, compareStringsOrUndefined } from \"@itwin/core-bentley\";\nimport { InstanceKey, normalizeFullClassName } from \"@itwin/presentation-shared\";\n\n/**\n * An instance key that may be associated with specific iModel.\n * @public\n */\nexport interface IModelInstanceKey extends InstanceKey {\n  imodelKey?: string;\n}\n\n/**\n * A key for a generic node.\n * @public\n */\nexport interface GenericNodeKey {\n  /** Type of the node */\n  type: \"generic\";\n\n  /**\n   * Node key identifier, which uniquely identifies the node within the hierarchy level the node is used.\n   * The format of the identifier is not specified and is up to the data source.\n   */\n  id: string;\n\n  /**\n   * Optional data source identifier. Useful when a hierarchy is built using multiple hierarchy providers - in that\n   * case each provider can assign a unique source identifier to its nodes.\n   */\n  source?: string;\n}\n\n/**\n * A key for a node that represents one or more ECInstances.\n * @public\n */\nexport interface InstancesNodeKey {\n  /** Type of the node */\n  type: \"instances\";\n\n  /**\n   * Keys of ECInstances that are represented by the node. Generally, one node represents a single\n   * ECInstance, but in some cases (e.g. node merging) there could be more.\n   */\n  instanceKeys: IModelInstanceKey[];\n}\n\n/**\n * A key for a class-grouping node.\n * @public\n */\nexport interface ClassGroupingNodeKey {\n  /** Type of the node */\n  type: \"class-grouping\";\n\n  /** Full name of the ECClass that this grouping node is grouping by. */\n  className: string;\n}\n\n/**\n * A key for a label-grouping node.\n * @public\n */\nexport interface LabelGroupingNodeKey {\n  /** Type of the node */\n  type: \"label-grouping\";\n\n  /** Node label that this grouping node is grouping by. */\n  label: string;\n\n  /**\n   * Optional group identifier that is assigned to the node key when multiple nodes\n   * with the same label shouldn't be grouped together.\n   */\n  groupId?: string;\n}\n\n/**\n * A key property grouping node that groups nodes whose values don't fall into any other\n * property group in the hierarchy level.\n * @public\n */\nexport interface PropertyOtherValuesGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:other\";\n  /** Identifiers of properties whose values are grouped under this node. */\n  properties: Array<{\n    className: string;\n    propertyName: string;\n  }>;\n}\n\n/**\n * A key for a property grouping node that groups nodes by formatted property value.\n * @public\n */\nexport interface PropertyValueGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:value\";\n\n  /** Name of the property that is used for grouping nodes. */\n  propertyName: string;\n\n  /** Full name of the ECClass containing the property. */\n  propertyClassName: string;\n\n  /** Formatted property value that this node is grouping by. */\n  formattedPropertyValue: string;\n}\n\n/**\n * A key for a property grouping node that groups nodes by a range of property values.\n * @public\n */\nexport interface PropertyValueRangeGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:range\";\n\n  /** Name of the property that is used for grouping nodes. */\n  propertyName: string;\n\n  /** Full name of the ECClass containing the property. */\n  propertyClassName: string;\n\n  /** Defines the start of the values' range that this node is grouping by. */\n  fromValue: number;\n\n  /** Defines the end of the values' range that this node is grouping by. */\n  toValue: number;\n}\n\n/**\n * A key for a property grouping node.\n * @public\n */\nexport type PropertyGroupingNodeKey = PropertyValueRangeGroupingNodeKey | PropertyValueGroupingNodeKey | PropertyOtherValuesGroupingNodeKey;\n\n/**\n * A key for one of the instance grouping nodes.\n * @public\n */\nexport type GroupingNodeKey = ClassGroupingNodeKey | LabelGroupingNodeKey | PropertyGroupingNodeKey;\n\n/**\n * A key for either an instance node or one of the instance grouping nodes.\n * @public\n */\nexport type IModelHierarchyNodeKey = InstancesNodeKey | GroupingNodeKey;\n\n/**\n * A key that uniquely identifies a node in a hierarchy level.\n * @public\n */\nexport type HierarchyNodeKey = IModelHierarchyNodeKey | GenericNodeKey;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodeKey {\n  /** Checks whether the given node key is a generic node key. */\n  export function isGeneric(key: HierarchyNodeKey): key is GenericNodeKey {\n    return key.type === \"generic\";\n  }\n\n  /** Checks whether the given node key is a `StandardHierarchyNodeKey`. */\n  export function isIModelNodeKey(key: HierarchyNodeKey): key is IModelHierarchyNodeKey {\n    return !isGeneric(key);\n  }\n\n  /** Checks whether the given node key is an `InstancesNodeKey`. */\n  export function isInstances(key: HierarchyNodeKey): key is InstancesNodeKey {\n    return key.type === \"instances\";\n  }\n\n  /** Checks whether the given node key is a `GroupingNodeKey`. */\n  export function isGrouping(key: HierarchyNodeKey): key is GroupingNodeKey {\n    return !isGeneric(key) && !isInstances(key);\n  }\n\n  /** Checks whether the given node key is a `ClassGroupingNodeKey`. */\n  export function isClassGrouping(key: HierarchyNodeKey): key is ClassGroupingNodeKey {\n    return key.type === \"class-grouping\";\n  }\n\n  /** Checks whether the given node key is a `LabelGroupingNodeKey`. */\n  export function isLabelGrouping(key: HierarchyNodeKey): key is LabelGroupingNodeKey {\n    return key.type === \"label-grouping\";\n  }\n\n  /** Checks whether the given node key is a `PropertyOtherValuesGroupingNodeKey`. */\n  export function isPropertyOtherValuesGrouping(key: HierarchyNodeKey): key is PropertyOtherValuesGroupingNodeKey {\n    return key.type === \"property-grouping:other\";\n  }\n\n  /** Checks whether the given node key is a `PropertyValueRangeGroupingNodeKey`. */\n  export function isPropertyValueRangeGrouping(key: HierarchyNodeKey): key is PropertyValueRangeGroupingNodeKey {\n    return key.type === \"property-grouping:range\";\n  }\n\n  /** Checks whether the given node key is a `PropertyValueGroupingNodeKey`. */\n  export function isPropertyValueGrouping(key: HierarchyNodeKey): key is PropertyValueGroupingNodeKey {\n    return key.type === \"property-grouping:value\";\n  }\n\n  /** Checks whether the given node key is a `PropertyGroupingNodeKey`. */\n  export function isPropertyGrouping(key: HierarchyNodeKey): key is PropertyGroupingNodeKey {\n    return isPropertyOtherValuesGrouping(key) || isPropertyValueRangeGrouping(key) || isPropertyValueGrouping(key);\n  }\n\n  /**\n   * Compares two given keys. Returns:\n   * - `0` if they are equal,\n   * - `negative value` if lhs key is less than rhs key,\n   * - `positive value` if lhs key is more than rhs key.\n   */\n  export function compare(lhs: HierarchyNodeKey, rhs: HierarchyNodeKey): number {\n    const typeCompareResult = compareStrings(lhs.type, rhs.type);\n    if (typeCompareResult !== 0) {\n      return typeCompareResult;\n    }\n    switch (lhs.type) {\n      case \"generic\": {\n        assert(rhs.type === \"generic\");\n        const idCompareResult = compareStrings(lhs.id, rhs.id);\n        if (idCompareResult !== 0) {\n          return idCompareResult;\n        }\n        return compareStringsOrUndefined(lhs.source, rhs.source);\n      }\n      case \"instances\": {\n        assert(rhs.type === \"instances\");\n        if (lhs.instanceKeys.length !== rhs.instanceKeys.length) {\n          return lhs.instanceKeys.length > rhs.instanceKeys.length ? 1 : -1;\n        }\n        for (let i = 0; i < lhs.instanceKeys.length; ++i) {\n          const instanceKeyCompareResult = InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]);\n          if (instanceKeyCompareResult !== 0) {\n            return instanceKeyCompareResult;\n          }\n          const imodelKeyCompareResult = compareStringsOrUndefined(lhs.instanceKeys[i].imodelKey, rhs.instanceKeys[i].imodelKey);\n          if (imodelKeyCompareResult !== 0) {\n            return imodelKeyCompareResult;\n          }\n        }\n        return 0;\n      }\n      case \"class-grouping\": {\n        assert(rhs.type === \"class-grouping\");\n        return compareStrings(normalizeFullClassName(lhs.className).toLocaleLowerCase(), normalizeFullClassName(rhs.className).toLocaleLowerCase());\n      }\n      case \"label-grouping\": {\n        assert(rhs.type === \"label-grouping\");\n        const labelCompareResult = compareStrings(lhs.label, rhs.label);\n        if (labelCompareResult !== 0) {\n          return labelCompareResult;\n        }\n        return compareStringsOrUndefined(lhs.groupId, rhs.groupId);\n      }\n      case \"property-grouping:other\": {\n        assert(rhs.type === \"property-grouping:other\");\n        if (lhs.properties.length !== rhs.properties.length) {\n          return lhs.properties.length - rhs.properties.length;\n        }\n        for (let i = 0; i < lhs.properties.length; ++i) {\n          const classCompareResult = compareStrings(\n            normalizeFullClassName(lhs.properties[i].className).toLocaleLowerCase(),\n            normalizeFullClassName(rhs.properties[i].className).toLocaleLowerCase(),\n          );\n          if (classCompareResult !== 0) {\n            return classCompareResult;\n          }\n          const nameCompareResult = compareStrings(lhs.properties[i].propertyName.toLocaleLowerCase(), rhs.properties[i].propertyName.toLocaleLowerCase());\n          if (nameCompareResult !== 0) {\n            return nameCompareResult;\n          }\n        }\n        return 0;\n      }\n      case \"property-grouping:value\": {\n        assert(rhs.type === \"property-grouping:value\");\n        const propertyClassNameCompareResult = compareStrings(\n          normalizeFullClassName(lhs.propertyClassName).toLocaleLowerCase(),\n          normalizeFullClassName(rhs.propertyClassName).toLocaleLowerCase(),\n        );\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName.toLocaleLowerCase(), rhs.propertyName.toLocaleLowerCase());\n        if (propertyNameCompareResult !== 0) {\n          return propertyNameCompareResult;\n        }\n        return compareStrings(lhs.formattedPropertyValue, rhs.formattedPropertyValue);\n      }\n      case \"property-grouping:range\": {\n        assert(rhs.type === \"property-grouping:range\");\n        const propertyClassNameCompareResult = compareStrings(\n          normalizeFullClassName(lhs.propertyClassName).toLocaleLowerCase(),\n          normalizeFullClassName(rhs.propertyClassName).toLocaleLowerCase(),\n        );\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName.toLocaleLowerCase(), rhs.propertyName.toLocaleLowerCase());\n        if (propertyNameCompareResult !== 0) {\n          return propertyNameCompareResult;\n        }\n        if (lhs.fromValue !== rhs.fromValue) {\n          return lhs.fromValue > rhs.fromValue ? 1 : -1;\n        }\n        return lhs.toValue > rhs.toValue ? 1 : lhs.toValue < rhs.toValue ? -1 : 0;\n      }\n    }\n  }\n\n  /** Checks whether the two given keys are equal. */\n  export function equals(lhs: HierarchyNodeKey, rhs: HierarchyNodeKey): boolean {\n    return compare(lhs, rhs) === 0;\n  }\n}\n"]}
+{"version":3,"file":"HierarchyNodeKey.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeKey.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AA4JjF,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,gBAAgB,CAgKhC;AAhKD,WAAiB,gBAAgB;IAC/B,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,GAAqB;QAC7C,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC;IAChC,CAAC;IAFe,0BAAS,YAExB,CAAA;IAED,yEAAyE;IACzE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,kEAAkE;IAClE,SAAgB,WAAW,CAAC,GAAqB;QAC/C,OAAO,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC;IAClC,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,gEAAgE;IAChE,SAAgB,UAAU,CAAC,GAAqB;QAC9C,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,2BAAU,aAEzB,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,mFAAmF;IACnF,SAAgB,6BAA6B,CAAC,GAAqB;QACjE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,8CAA6B,gCAE5C,CAAA;IAED,kFAAkF;IAClF,SAAgB,4BAA4B,CAAC,GAAqB;QAChE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED,6EAA6E;IAC7E,SAAgB,uBAAuB,CAAC,GAAqB;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED,wEAAwE;IACxE,SAAgB,kBAAkB,CAAC,GAAqB;QACtD,OAAO,6BAA6B,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,GAAG,CAAC,IAAI,uBAAuB,CAAC,GAAG,CAAC,CAAC;IACjH,CAAC;IAFe,mCAAkB,qBAEjC,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAqB,EAAE,GAAqB;QAClE,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;gBAC/B,MAAM,eAAe,GAAG,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,eAAe,CAAC;gBACzB,CAAC;gBACD,OAAO,yBAAyB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC;YACD,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;gBACjC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;oBACxD,OAAO,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBACjD,MAAM,wBAAwB,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/F,IAAI,wBAAwB,KAAK,CAAC,EAAE,CAAC;wBACnC,OAAO,wBAAwB,CAAC;oBAClC,CAAC;oBACD,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBACvH,IAAI,sBAAsB,KAAK,CAAC,EAAE,CAAC;wBACjC,OAAO,sBAAsB,CAAC;oBAChC,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,OAAO,cAAc,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,EAAE,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAC9I,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,MAAM,kBAAkB,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBAChE,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;oBAC7B,OAAO,kBAAkB,CAAC;gBAC5B,CAAC;gBACD,OAAO,yBAAyB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC7D,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;oBACpD,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;gBACvD,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBAC/C,MAAM,kBAAkB,GAAG,cAAc,CACvC,sBAAsB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,EACvE,sBAAsB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,iBAAiB,EAAE,CACxE,CAAC;oBACF,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;wBAC7B,OAAO,kBAAkB,CAAC;oBAC5B,CAAC;oBACD,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC;oBACjJ,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;wBAC5B,OAAO,iBAAiB,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,cAAc,CACnD,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,EACjE,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,CAClE,CAAC;gBACF,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBAC7H,IAAI,yBAAyB,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,yBAAyB,CAAC;gBACnC,CAAC;gBACD,OAAO,cAAc,CAAC,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAChF,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,cAAc,CACnD,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,EACjE,sBAAsB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,iBAAiB,EAAE,CAClE,CAAC;gBACF,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBAC7H,IAAI,yBAAyB,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,yBAAyB,CAAC;gBACnC,CAAC;gBACD,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC;oBACpC,OAAO,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChD,CAAC;gBACD,OAAO,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IAjGe,wBAAO,UAiGtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAqB,EAAE,GAAqB;QACjE,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAFe,uBAAM,SAErB,CAAA;AACH,CAAC,EAhKgB,gBAAgB,KAAhB,gBAAgB,QAgKhC","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 { assert, compareStrings, compareStringsOrUndefined } from \"@itwin/core-bentley\";\nimport { InstanceKey, normalizeFullClassName } from \"@itwin/presentation-shared\";\n\nimport type { EC } from \"@itwin/presentation-shared\";\n\n/**\n * An instance key that may be associated with specific iModel.\n * @public\n */\nexport interface IModelInstanceKey extends InstanceKey {\n  imodelKey?: string;\n}\n\n/**\n * A key for a generic node.\n * @public\n */\nexport interface GenericNodeKey {\n  /** Type of the node */\n  type: \"generic\";\n\n  /**\n   * Node key identifier, which uniquely identifies the node within the hierarchy level the node is used.\n   * The format of the identifier is not specified and is up to the data source.\n   */\n  id: string;\n\n  /**\n   * Optional data source identifier. Useful when a hierarchy is built using multiple hierarchy providers - in that\n   * case each provider can assign a unique source identifier to its nodes.\n   */\n  source?: string;\n}\n\n/**\n * A key for a node that represents one or more ECInstances.\n * @public\n */\nexport interface InstancesNodeKey {\n  /** Type of the node */\n  type: \"instances\";\n\n  /**\n   * Keys of ECInstances that are represented by the node. Generally, one node represents a single\n   * ECInstance, but in some cases (e.g. node merging) there could be more.\n   */\n  instanceKeys: IModelInstanceKey[];\n}\n\n/**\n * A key for a class-grouping node.\n * @public\n */\nexport interface ClassGroupingNodeKey {\n  /** Type of the node */\n  type: \"class-grouping\";\n\n  /** Full name of the ECClass that this grouping node is grouping by. */\n  className: EC.FullClassName;\n}\n\n/**\n * A key for a label-grouping node.\n * @public\n */\nexport interface LabelGroupingNodeKey {\n  /** Type of the node */\n  type: \"label-grouping\";\n\n  /** Node label that this grouping node is grouping by. */\n  label: string;\n\n  /**\n   * Optional group identifier that is assigned to the node key when multiple nodes\n   * with the same label shouldn't be grouped together.\n   */\n  groupId?: string;\n}\n\n/**\n * A key property grouping node that groups nodes whose values don't fall into any other\n * property group in the hierarchy level.\n * @public\n */\nexport interface PropertyOtherValuesGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:other\";\n  /** Identifiers of properties whose values are grouped under this node. */\n  properties: Array<{\n    className: EC.FullClassName;\n    propertyName: string;\n  }>;\n}\n\n/**\n * A key for a property grouping node that groups nodes by formatted property value.\n * @public\n */\nexport interface PropertyValueGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:value\";\n\n  /** Name of the property that is used for grouping nodes. */\n  propertyName: string;\n\n  /** Full name of the ECClass containing the property. */\n  propertyClassName: EC.FullClassName;\n\n  /** Formatted property value that this node is grouping by. */\n  formattedPropertyValue: string;\n}\n\n/**\n * A key for a property grouping node that groups nodes by a range of property values.\n * @public\n */\nexport interface PropertyValueRangeGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:range\";\n\n  /** Name of the property that is used for grouping nodes. */\n  propertyName: string;\n\n  /** Full name of the ECClass containing the property. */\n  propertyClassName: EC.FullClassName;\n\n  /** Defines the start of the values' range that this node is grouping by. */\n  fromValue: number;\n\n  /** Defines the end of the values' range that this node is grouping by. */\n  toValue: number;\n}\n\n/**\n * A key for a property grouping node.\n * @public\n */\nexport type PropertyGroupingNodeKey = PropertyValueRangeGroupingNodeKey | PropertyValueGroupingNodeKey | PropertyOtherValuesGroupingNodeKey;\n\n/**\n * A key for one of the instance grouping nodes.\n * @public\n */\nexport type GroupingNodeKey = ClassGroupingNodeKey | LabelGroupingNodeKey | PropertyGroupingNodeKey;\n\n/**\n * A key for either an instance node or one of the instance grouping nodes.\n * @public\n */\nexport type IModelHierarchyNodeKey = InstancesNodeKey | GroupingNodeKey;\n\n/**\n * A key that uniquely identifies a node in a hierarchy level.\n * @public\n */\nexport type HierarchyNodeKey = IModelHierarchyNodeKey | GenericNodeKey;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodeKey {\n  /** Checks whether the given node key is a generic node key. */\n  export function isGeneric(key: HierarchyNodeKey): key is GenericNodeKey {\n    return key.type === \"generic\";\n  }\n\n  /** Checks whether the given node key is a `StandardHierarchyNodeKey`. */\n  export function isIModelNodeKey(key: HierarchyNodeKey): key is IModelHierarchyNodeKey {\n    return !isGeneric(key);\n  }\n\n  /** Checks whether the given node key is an `InstancesNodeKey`. */\n  export function isInstances(key: HierarchyNodeKey): key is InstancesNodeKey {\n    return key.type === \"instances\";\n  }\n\n  /** Checks whether the given node key is a `GroupingNodeKey`. */\n  export function isGrouping(key: HierarchyNodeKey): key is GroupingNodeKey {\n    return !isGeneric(key) && !isInstances(key);\n  }\n\n  /** Checks whether the given node key is a `ClassGroupingNodeKey`. */\n  export function isClassGrouping(key: HierarchyNodeKey): key is ClassGroupingNodeKey {\n    return key.type === \"class-grouping\";\n  }\n\n  /** Checks whether the given node key is a `LabelGroupingNodeKey`. */\n  export function isLabelGrouping(key: HierarchyNodeKey): key is LabelGroupingNodeKey {\n    return key.type === \"label-grouping\";\n  }\n\n  /** Checks whether the given node key is a `PropertyOtherValuesGroupingNodeKey`. */\n  export function isPropertyOtherValuesGrouping(key: HierarchyNodeKey): key is PropertyOtherValuesGroupingNodeKey {\n    return key.type === \"property-grouping:other\";\n  }\n\n  /** Checks whether the given node key is a `PropertyValueRangeGroupingNodeKey`. */\n  export function isPropertyValueRangeGrouping(key: HierarchyNodeKey): key is PropertyValueRangeGroupingNodeKey {\n    return key.type === \"property-grouping:range\";\n  }\n\n  /** Checks whether the given node key is a `PropertyValueGroupingNodeKey`. */\n  export function isPropertyValueGrouping(key: HierarchyNodeKey): key is PropertyValueGroupingNodeKey {\n    return key.type === \"property-grouping:value\";\n  }\n\n  /** Checks whether the given node key is a `PropertyGroupingNodeKey`. */\n  export function isPropertyGrouping(key: HierarchyNodeKey): key is PropertyGroupingNodeKey {\n    return isPropertyOtherValuesGrouping(key) || isPropertyValueRangeGrouping(key) || isPropertyValueGrouping(key);\n  }\n\n  /**\n   * Compares two given keys. Returns:\n   * - `0` if they are equal,\n   * - `negative value` if lhs key is less than rhs key,\n   * - `positive value` if lhs key is more than rhs key.\n   */\n  export function compare(lhs: HierarchyNodeKey, rhs: HierarchyNodeKey): number {\n    const typeCompareResult = compareStrings(lhs.type, rhs.type);\n    if (typeCompareResult !== 0) {\n      return typeCompareResult;\n    }\n    switch (lhs.type) {\n      case \"generic\": {\n        assert(rhs.type === \"generic\");\n        const idCompareResult = compareStrings(lhs.id, rhs.id);\n        if (idCompareResult !== 0) {\n          return idCompareResult;\n        }\n        return compareStringsOrUndefined(lhs.source, rhs.source);\n      }\n      case \"instances\": {\n        assert(rhs.type === \"instances\");\n        if (lhs.instanceKeys.length !== rhs.instanceKeys.length) {\n          return lhs.instanceKeys.length > rhs.instanceKeys.length ? 1 : -1;\n        }\n        for (let i = 0; i < lhs.instanceKeys.length; ++i) {\n          const instanceKeyCompareResult = InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]);\n          if (instanceKeyCompareResult !== 0) {\n            return instanceKeyCompareResult;\n          }\n          const imodelKeyCompareResult = compareStringsOrUndefined(lhs.instanceKeys[i].imodelKey, rhs.instanceKeys[i].imodelKey);\n          if (imodelKeyCompareResult !== 0) {\n            return imodelKeyCompareResult;\n          }\n        }\n        return 0;\n      }\n      case \"class-grouping\": {\n        assert(rhs.type === \"class-grouping\");\n        return compareStrings(normalizeFullClassName(lhs.className).toLocaleLowerCase(), normalizeFullClassName(rhs.className).toLocaleLowerCase());\n      }\n      case \"label-grouping\": {\n        assert(rhs.type === \"label-grouping\");\n        const labelCompareResult = compareStrings(lhs.label, rhs.label);\n        if (labelCompareResult !== 0) {\n          return labelCompareResult;\n        }\n        return compareStringsOrUndefined(lhs.groupId, rhs.groupId);\n      }\n      case \"property-grouping:other\": {\n        assert(rhs.type === \"property-grouping:other\");\n        if (lhs.properties.length !== rhs.properties.length) {\n          return lhs.properties.length - rhs.properties.length;\n        }\n        for (let i = 0; i < lhs.properties.length; ++i) {\n          const classCompareResult = compareStrings(\n            normalizeFullClassName(lhs.properties[i].className).toLocaleLowerCase(),\n            normalizeFullClassName(rhs.properties[i].className).toLocaleLowerCase(),\n          );\n          if (classCompareResult !== 0) {\n            return classCompareResult;\n          }\n          const nameCompareResult = compareStrings(lhs.properties[i].propertyName.toLocaleLowerCase(), rhs.properties[i].propertyName.toLocaleLowerCase());\n          if (nameCompareResult !== 0) {\n            return nameCompareResult;\n          }\n        }\n        return 0;\n      }\n      case \"property-grouping:value\": {\n        assert(rhs.type === \"property-grouping:value\");\n        const propertyClassNameCompareResult = compareStrings(\n          normalizeFullClassName(lhs.propertyClassName).toLocaleLowerCase(),\n          normalizeFullClassName(rhs.propertyClassName).toLocaleLowerCase(),\n        );\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName.toLocaleLowerCase(), rhs.propertyName.toLocaleLowerCase());\n        if (propertyNameCompareResult !== 0) {\n          return propertyNameCompareResult;\n        }\n        return compareStrings(lhs.formattedPropertyValue, rhs.formattedPropertyValue);\n      }\n      case \"property-grouping:range\": {\n        assert(rhs.type === \"property-grouping:range\");\n        const propertyClassNameCompareResult = compareStrings(\n          normalizeFullClassName(lhs.propertyClassName).toLocaleLowerCase(),\n          normalizeFullClassName(rhs.propertyClassName).toLocaleLowerCase(),\n        );\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName.toLocaleLowerCase(), rhs.propertyName.toLocaleLowerCase());\n        if (propertyNameCompareResult !== 0) {\n          return propertyNameCompareResult;\n        }\n        if (lhs.fromValue !== rhs.fromValue) {\n          return lhs.fromValue > rhs.fromValue ? 1 : -1;\n        }\n        return lhs.toValue > rhs.toValue ? 1 : lhs.toValue < rhs.toValue ? -1 : 0;\n      }\n    }\n  }\n\n  /** Checks whether the two given keys are equal. */\n  export function equals(lhs: HierarchyNodeKey, rhs: HierarchyNodeKey): boolean {\n    return compare(lhs, rhs) === 0;\n  }\n}\n"]}

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

@@ -1,7 +1,7 @@
 import type { GenericInstanceFilter } from "@itwin/core-common";
 import type { Event, EventListener, InstanceKey, IPrimitiveValueFormatter, Props, RaisableEvent } from "@itwin/presentation-shared";
 import type { HierarchyNode, ParentHierarchyNode } from "./HierarchyNode.js";
-import type { HierarchySearchPath } from "./HierarchySearch.js";
+import type { HierarchySearchTree } from "./HierarchySearch.js";
 /**
  * Props for the `HierarchyProvider.getNodes` call.
  * @public
@@ -82,8 +82,8 @@ export interface HierarchyProvider {
      * @note Changing search is expected to trigger the `hierarchyChanged` event with `searchChange` arg.
      */
     setHierarchySearch(props: {
-        /** A list of node identifiers from root to target node. */
-        paths: HierarchySearchPath[];
+        /** A list of search trees that define paths from root to search target nodes. */
+        paths: HierarchySearchTree[];
     } | undefined): void;
 }
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyProvider.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,wBAAwB,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACpI,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE;;;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,wEAAwE;IACxE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,UAAU,yBAAyB;IACjC,sEAAsE;IACtE,eAAe,CAAC,EAAE;QAChB,YAAY,EAAE,wBAAwB,GAAG,SAAS,CAAC;KACpD,CAAC;IAEF,6EAA6E;IAC7E,YAAY,CAAC,EAAE;QACb,SAAS,EAAE,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC,CAAC;KAC3D,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,CAAC,CAAC;IAE5E;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE9E;;;;;;OAMG;IACH,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAE5G;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,GAAG,IAAI,CAAC;IAEpE;;;;;;;;;OASG;IACH,kBAAkB,CAChB,KAAK,EACD;QACE,2DAA2D;QAC3D,KAAK,EAAE,mBAAmB,EAAE,CAAC;KAC9B,GACD,SAAS,GACZ,IAAI,CAAC;CACT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,uBAAuB,CAAC,gBAAgB,SAAS,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,GAAG,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,EACzJ,cAAc,EAAE,CAAC,KAAK,EAAE;IAAE,gBAAgB,EAAE,aAAa,CAAC,aAAa,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAA;CAAE,KAAK,gBAAgB,GACrI,gBAAgB,GAAG,iBAAiB,CAStC"}
+{"version":3,"file":"HierarchyProvider.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,wBAAwB,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACpI,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE;;;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,wEAAwE;IACxE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,UAAU,yBAAyB;IACjC,sEAAsE;IACtE,eAAe,CAAC,EAAE;QAChB,YAAY,EAAE,wBAAwB,GAAG,SAAS,CAAC;KACpD,CAAC;IAEF,6EAA6E;IAC7E,YAAY,CAAC,EAAE;QACb,SAAS,EAAE,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC,CAAC;KAC3D,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,CAAC,CAAC;IAE5E;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE9E;;;;;;OAMG;IACH,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAE5G;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,GAAG,IAAI,CAAC;IAEpE;;;;;;;;;OASG;IACH,kBAAkB,CAChB,KAAK,EACD;QACE,iFAAiF;QACjF,KAAK,EAAE,mBAAmB,EAAE,CAAC;KAC9B,GACD,SAAS,GACZ,IAAI,CAAC;CACT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,uBAAuB,CAAC,gBAAgB,SAAS,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,GAAG,IAAI,CAAC,iBAAiB,EAAE,UAAU,CAAC,EACzJ,cAAc,EAAE,CAAC,KAAK,EAAE;IAAE,gBAAgB,EAAE,aAAa,CAAC,aAAa,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAA;CAAE,KAAK,gBAAgB,GACrI,gBAAgB,GAAG,iBAAiB,CAStC"}

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

@@ -1 +1 @@
-{"version":3,"file":"HierarchyProvider.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AA0G9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,UAAU,uBAAuB,CACrC,cAAsI;IAEtI,MAAM,gBAAgB,GAAqD,IAAI,OAAO,EAAE,CAAC;IACzF,MAAM,IAAI,GAAG,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QACzB,gBAAgB;QAChB,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAC,mBAAmB,KAAI,CAAC,EAAE,CAAC;QAC5I,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,YAAY,KAAI,CAAC,EAAE,CAAC;QACzG,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,kBAAkB,KAAI,CAAC,EAAE,CAAC;KAClI,CAAC,CAAC;AACL,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 { BeEvent } from \"@itwin/core-bentley\";\n\nimport type { GenericInstanceFilter } from \"@itwin/core-common\";\nimport type { Event, EventListener, InstanceKey, IPrimitiveValueFormatter, Props, RaisableEvent } from \"@itwin/presentation-shared\";\nimport type { HierarchyNode, ParentHierarchyNode } from \"./HierarchyNode.js\";\nimport type { HierarchySearchPath } from \"./HierarchySearch.js\";\n\n/**\n * Props for the `HierarchyProvider.getNodes` call.\n * @public\n */\nexport interface GetHierarchyNodesProps {\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: ParentHierarchyNode | undefined;\n\n  /** Optional hierarchy level filter. Has no effect if `parentNode` is a `GroupingNode`. */\n  instanceFilter?: GenericInstanceFilter;\n\n  /**\n   * Optional hierarchy level size limit override. This value is passed to `LimitingECSqlQueryExecutor` used\n   * by this provider to override query rows limit per hierarchy level. If not provided, defaults to whatever\n   * is used by the limiting query executor.\n   *\n   * Has no effect if `parentNode` is a `GroupingNode`.\n   */\n  hierarchyLevelSizeLimit?: number | \"unbounded\";\n\n  /** When set to `true` ignores the cache and fetches the nodes again. */\n  ignoreCache?: boolean;\n}\n\n/**\n * Event arguments for `HierarchyProvider.hierarchyChanged` event.\n * @public\n */\ninterface HierarchyChangedEventArgs {\n  /** Set when the hierarchy change was caused by a formatter change. */\n  formatterChange?: {\n    newFormatter: IPrimitiveValueFormatter | undefined;\n  };\n\n  /** Set when the hierarchy change was caused by a hierarchy search change. */\n  searchChange?: {\n    newSearch: Props<HierarchyProvider[\"setHierarchySearch\"]>;\n  };\n}\n\n/**\n * An interface for a hierarchy provider that knows how to create child nodes for a given parent node.\n * @public\n */\nexport interface HierarchyProvider {\n  /**\n   * An event that provider raises due to a hierarchy change that requires a reload.\n   *\n   * Consumers are expected to subscribe to this event and reload the hierarchy when it's raised.\n   * Implementations may provide additional details on what caused the change through the\n   * event arguments.\n   */\n  readonly hierarchyChanged: Event<(args: HierarchyChangedEventArgs) => void>;\n\n  /**\n   * Gets nodes for the specified parent node. This is **the method to implement**, otherwise\n   * the provider doesn't return any nodes.\n   */\n  getNodes(props: GetHierarchyNodesProps): AsyncIterableIterator<HierarchyNode>;\n\n  /**\n   * Gets instance keys for the specified parent node.\n   *\n   * The result of this method may be used to determine instances whose nodes would be displayed as children\n   * of the specified parent node. For such use cases calling this method should be more efficient compared\n   * to calling `getNodes`.\n   */\n  getNodeInstanceKeys(props: Omit<GetHierarchyNodesProps, \"ignoreCache\">): AsyncIterableIterator<InstanceKey>;\n\n  /**\n   * Overrides the property value formatter used by the hierarchy provider. Setting to `undefined`\n   * resets the formatter, but what that means depends on the provider implementation - it could just\n   * use unformatted values, or use some default formatter, e.g. the on created by `createDefaultValueFormatter`\n   * from `@itwin/presentation-shared` package.\n   *\n   * @note Changing formatter is expected to trigger the `hierarchyChanged` event with `formatterChange` arg.\n   */\n  setFormatter(formatter: IPrimitiveValueFormatter | undefined): void;\n\n  /**\n   * Sets the hierarchy search used by this hierarchy provider. Setting to `undefined`\n   * removes the search.\n   *\n   * @note There's a difference between `undefined` search and search with empty paths list. The\n   * former means no search is applied, while the latter means the search is applied and it filters-out\n   * all hierarchy.\n   *\n   * @note Changing search is expected to trigger the `hierarchyChanged` event with `searchChange` arg.\n   */\n  setHierarchySearch(\n    props:\n      | {\n          /** A list of node identifiers from root to target node. */\n          paths: HierarchySearchPath[];\n        }\n      | undefined,\n  ): void;\n}\n\n/**\n * An utility to create a `HierarchyProvider` from a partial implementation.\n *\n * Creating a `HierarchyProvider` directly requires implementing all its methods:\n * ```ts\n * {\n *   hierarchyChanged: new BeEvent(),\n *   async *getNodes({ parentNode }) {\n *     // yield nodes...\n *   },\n *   async *getNodeInstanceKeys() {},\n *   setFormatter() {},\n *   setHierarchySearch() {},\n * }\n * ```\n *\n * However, in many cases you may only need to implement the `getNodes` method and\n * can rely on default implementations for other methods.\n *\n * With this utility you can implement only part of it, e.g. just the `getNodes` method:\n * ```ts\n * // provide implementation as a javascript object\n * createHierarchyProvider(({ hierarchyChanged }) => ({\n *   async *getNodes({ parentNode }) {\n *     // yield nodes...\n *   },\n * }));\n *\n * // or, provide implementation as a class instance:\n * createHierarchyProvider(\n *   ({ hierarchyChanged }) =>\n *     new (class implements Pick<HierarchyProvider, \"getNodes\"> {\n *       public async *getNodes({ parentNode }): ReturnType<HierarchyProvider[\"getNodes\"]> {\n *         // yield nodes...\n *       }\n *     })(),\n * );\n * ```\n *\n * @public\n */\nexport function createHierarchyProvider<TPartialProvider extends Partial<Omit<HierarchyProvider, \"hierarchyChanged\">> & Pick<HierarchyProvider, \"getNodes\">>(\n  partialFactory: (props: { hierarchyChanged: RaisableEvent<EventListener<HierarchyProvider[\"hierarchyChanged\"]>> }) => TPartialProvider,\n): TPartialProvider & HierarchyProvider {\n  const hierarchyChanged: Props<typeof partialFactory>[\"hierarchyChanged\"] = new BeEvent();\n  const impl = partialFactory({ hierarchyChanged });\n  return Object.assign(impl, {\n    hierarchyChanged,\n    ...(impl.getNodeInstanceKeys ? { getNodeInstanceKeys: impl.getNodeInstanceKeys } : { /* c8 ignore next */ async *getNodeInstanceKeys() {} }),\n    ...(impl.setFormatter ? { setFormatter: impl.setFormatter } : { /* c8 ignore next */ setFormatter() {} }),\n    ...(impl.setHierarchySearch ? { setHierarchySearch: impl.setHierarchySearch } : { /* c8 ignore next */ setHierarchySearch() {} }),\n  });\n}\n"]}
+{"version":3,"file":"HierarchyProvider.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AA0G9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,UAAU,uBAAuB,CACrC,cAAsI;IAEtI,MAAM,gBAAgB,GAAqD,IAAI,OAAO,EAAE,CAAC;IACzF,MAAM,IAAI,GAAG,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QACzB,gBAAgB;QAChB,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAC,mBAAmB,KAAI,CAAC,EAAE,CAAC;QAC5I,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,YAAY,KAAI,CAAC,EAAE,CAAC;QACzG,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,kBAAkB,KAAI,CAAC,EAAE,CAAC;KAClI,CAAC,CAAC;AACL,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 { BeEvent } from \"@itwin/core-bentley\";\n\nimport type { GenericInstanceFilter } from \"@itwin/core-common\";\nimport type { Event, EventListener, InstanceKey, IPrimitiveValueFormatter, Props, RaisableEvent } from \"@itwin/presentation-shared\";\nimport type { HierarchyNode, ParentHierarchyNode } from \"./HierarchyNode.js\";\nimport type { HierarchySearchTree } from \"./HierarchySearch.js\";\n\n/**\n * Props for the `HierarchyProvider.getNodes` call.\n * @public\n */\nexport interface GetHierarchyNodesProps {\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: ParentHierarchyNode | undefined;\n\n  /** Optional hierarchy level filter. Has no effect if `parentNode` is a `GroupingNode`. */\n  instanceFilter?: GenericInstanceFilter;\n\n  /**\n   * Optional hierarchy level size limit override. This value is passed to `LimitingECSqlQueryExecutor` used\n   * by this provider to override query rows limit per hierarchy level. If not provided, defaults to whatever\n   * is used by the limiting query executor.\n   *\n   * Has no effect if `parentNode` is a `GroupingNode`.\n   */\n  hierarchyLevelSizeLimit?: number | \"unbounded\";\n\n  /** When set to `true` ignores the cache and fetches the nodes again. */\n  ignoreCache?: boolean;\n}\n\n/**\n * Event arguments for `HierarchyProvider.hierarchyChanged` event.\n * @public\n */\ninterface HierarchyChangedEventArgs {\n  /** Set when the hierarchy change was caused by a formatter change. */\n  formatterChange?: {\n    newFormatter: IPrimitiveValueFormatter | undefined;\n  };\n\n  /** Set when the hierarchy change was caused by a hierarchy search change. */\n  searchChange?: {\n    newSearch: Props<HierarchyProvider[\"setHierarchySearch\"]>;\n  };\n}\n\n/**\n * An interface for a hierarchy provider that knows how to create child nodes for a given parent node.\n * @public\n */\nexport interface HierarchyProvider {\n  /**\n   * An event that provider raises due to a hierarchy change that requires a reload.\n   *\n   * Consumers are expected to subscribe to this event and reload the hierarchy when it's raised.\n   * Implementations may provide additional details on what caused the change through the\n   * event arguments.\n   */\n  readonly hierarchyChanged: Event<(args: HierarchyChangedEventArgs) => void>;\n\n  /**\n   * Gets nodes for the specified parent node. This is **the method to implement**, otherwise\n   * the provider doesn't return any nodes.\n   */\n  getNodes(props: GetHierarchyNodesProps): AsyncIterableIterator<HierarchyNode>;\n\n  /**\n   * Gets instance keys for the specified parent node.\n   *\n   * The result of this method may be used to determine instances whose nodes would be displayed as children\n   * of the specified parent node. For such use cases calling this method should be more efficient compared\n   * to calling `getNodes`.\n   */\n  getNodeInstanceKeys(props: Omit<GetHierarchyNodesProps, \"ignoreCache\">): AsyncIterableIterator<InstanceKey>;\n\n  /**\n   * Overrides the property value formatter used by the hierarchy provider. Setting to `undefined`\n   * resets the formatter, but what that means depends on the provider implementation - it could just\n   * use unformatted values, or use some default formatter, e.g. the on created by `createDefaultValueFormatter`\n   * from `@itwin/presentation-shared` package.\n   *\n   * @note Changing formatter is expected to trigger the `hierarchyChanged` event with `formatterChange` arg.\n   */\n  setFormatter(formatter: IPrimitiveValueFormatter | undefined): void;\n\n  /**\n   * Sets the hierarchy search used by this hierarchy provider. Setting to `undefined`\n   * removes the search.\n   *\n   * @note There's a difference between `undefined` search and search with empty paths list. The\n   * former means no search is applied, while the latter means the search is applied and it filters-out\n   * all hierarchy.\n   *\n   * @note Changing search is expected to trigger the `hierarchyChanged` event with `searchChange` arg.\n   */\n  setHierarchySearch(\n    props:\n      | {\n          /** A list of search trees that define paths from root to search target nodes. */\n          paths: HierarchySearchTree[];\n        }\n      | undefined,\n  ): void;\n}\n\n/**\n * An utility to create a `HierarchyProvider` from a partial implementation.\n *\n * Creating a `HierarchyProvider` directly requires implementing all its methods:\n * ```ts\n * {\n *   hierarchyChanged: new BeEvent(),\n *   async *getNodes({ parentNode }) {\n *     // yield nodes...\n *   },\n *   async *getNodeInstanceKeys() {},\n *   setFormatter() {},\n *   setHierarchySearch() {},\n * }\n * ```\n *\n * However, in many cases you may only need to implement the `getNodes` method and\n * can rely on default implementations for other methods.\n *\n * With this utility you can implement only part of it, e.g. just the `getNodes` method:\n * ```ts\n * // provide implementation as a javascript object\n * createHierarchyProvider(({ hierarchyChanged }) => ({\n *   async *getNodes({ parentNode }) {\n *     // yield nodes...\n *   },\n * }));\n *\n * // or, provide implementation as a class instance:\n * createHierarchyProvider(\n *   ({ hierarchyChanged }) =>\n *     new (class implements Pick<HierarchyProvider, \"getNodes\"> {\n *       public async *getNodes({ parentNode }): ReturnType<HierarchyProvider[\"getNodes\"]> {\n *         // yield nodes...\n *       }\n *     })(),\n * );\n * ```\n *\n * @public\n */\nexport function createHierarchyProvider<TPartialProvider extends Partial<Omit<HierarchyProvider, \"hierarchyChanged\">> & Pick<HierarchyProvider, \"getNodes\">>(\n  partialFactory: (props: { hierarchyChanged: RaisableEvent<EventListener<HierarchyProvider[\"hierarchyChanged\"]>> }) => TPartialProvider,\n): TPartialProvider & HierarchyProvider {\n  const hierarchyChanged: Props<typeof partialFactory>[\"hierarchyChanged\"] = new BeEvent();\n  const impl = partialFactory({ hierarchyChanged });\n  return Object.assign(impl, {\n    hierarchyChanged,\n    ...(impl.getNodeInstanceKeys ? { getNodeInstanceKeys: impl.getNodeInstanceKeys } : { /* c8 ignore next */ async *getNodeInstanceKeys() {} }),\n    ...(impl.setFormatter ? { setFormatter: impl.setFormatter } : { /* c8 ignore next */ setFormatter() {} }),\n    ...(impl.setHierarchySearch ? { setHierarchySearch: impl.setHierarchySearch } : { /* c8 ignore next */ setHierarchySearch() {} }),\n  });\n}\n"]}