@itwin/presentation-hierarchies 2.0.0-alpha.2 → 2.0.0-alpha.20

package/README.md

@@ -50,15 +50,15 @@ Below is a list of learning material related to building hierarchies:
 - General topics:
   - [Formatting](./learning/Formatting.md)
   - [Logging](./learning/Logging.md)
-  - [Hierarchy filtering](./learning/HierarchyFiltering.md)
-  - [Hierarchy level filtering](./learning/HierarchyFiltering.md)
+  - [Hierarchy search](./learning/HierarchySearch.md)
+  - [Hierarchy level filtering](./learning/HierarchyLevelFiltering.md)
   - [Merged hierarchies](./learning/MergedHierarchies.md)
   - [Custom hierarchy providers](./learning/CustomHierarchyProviders.md)
 - iModel-based hierarchies:
   - [Hierarchy provider](./learning/imodel/HierarchyProvider.md)
   - [Hierarchy definition](./learning/imodel/HierarchyDefinition.md)
   - [Hierarchy node labels](./learning/imodel/HierarchyNodeLabels.md)
-  - [Hierarchy filtering](./learning/imodel/HierarchyFiltering.md)
+  - [Hierarchy search](./learning/imodel/HierarchySearch.md)
   - [Hierarchy level filtering](./learning/imodel/HierarchyLevelFiltering.md)
   - [Grouping](./learning/imodel/Grouping.md)
   - [Localization](./learning/imodel/Localization.md)
@@ -75,47 +75,26 @@ Here's a simple example of how to create a hierarchy provider and build a hierar
 
 ```ts
 import { IModelConnection } from "@itwin/core-frontend";
-import { SchemaContext } from "@itwin/ecschema-metadata";
-import { ECSchemaRpcLocater } from "@itwin/ecschema-rpcinterface-common";
 import { createECSchemaProvider, createECSqlQueryExecutor, createIModelKey } from "@itwin/presentation-core-interop";
-import { createLimitingECSqlQueryExecutor } from "@itwin/presentation-hierarchies";
-import { createCachingECClassHierarchyInspector, Props } from "@itwin/presentation-shared";
+import { createLimitingECSqlQueryExecutor, HierarchyLevelDefinition } from "@itwin/presentation-hierarchies";
+import { Props } from "@itwin/presentation-shared";
 
 import {
   createIModelHierarchyProvider,
-  createNodesQueryClauseFactory,
   createPredicateBasedHierarchyDefinition,
   DefineInstanceNodeChildHierarchyLevelProps,
   HierarchyNode,
   HierarchyProvider,
 } from "@itwin/presentation-hierarchies";
-import { createBisInstanceLabelSelectClauseFactory, ECSqlBinding } from "@itwin/presentation-shared";
-
-// Not really part of the package, but we need SchemaContext to create a hierarchy provider. It's
-// recommended to cache the schema context and reuse it across different application's components to
-// avoid loading and storing same schemas multiple times.
-const imodelSchemaContextsCache = new Map<string, SchemaContext>();
-function getIModelSchemaContext(imodel: IModelConnection) {
-  const imodelKey = createIModelKey(imodel);
-  let context = imodelSchemaContextsCache.get(imodelKey);
-  if (!context) {
-    context = new SchemaContext();
-    context.addLocater(new ECSchemaRpcLocater(imodel.getRpcProps()));
-    imodelSchemaContextsCache.set(imodelKey, context);
-    imodel.onClose.addListener(() => imodelSchemaContextsCache.delete(imodelKey));
-  }
-  return context;
-}
+import { ECSqlBinding } from "@itwin/presentation-shared";
 
 function createIModelAccess(imodel: IModelConnection) {
-  const schemaProvider = createECSchemaProvider(getIModelSchemaContext(imodel));
+  const schemaProvider = createECSchemaProvider(imodel);
   return {
     // The key of the iModel we're accessing
     imodelKey: createIModelKey(imodel),
-    // Schema provider provides access to EC information (metadata)
+    // Schema provider provides access to EC information (metadata) and class hierarchy inspection
     ...schemaProvider,
-    // While caching for hierarchy inspector is not mandatory, it's recommended to use it to improve performance
-    ...createCachingECClassHierarchyInspector({ schemaProvider, cacheSize: 100 }),
     // The second argument is the maximum number of rows the executor will return - this allows us to
     // avoid creating hierarchy levels of insane size (expensive to us and useless to users)
     ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),
@@ -123,29 +102,21 @@ function createIModelAccess(imodel: IModelConnection) {
 }
 
 function createProvider(imodelAccess: Props<typeof createIModelHierarchyProvider>["imodelAccess"]): HierarchyProvider {
-  // Create a factory for building labels SELECT query clauses according to BIS conventions
-  const labelsQueryFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector: imodelAccess });
-
-  // Create a factory for building nodes SELECT query clauses in a format understood by the provider
-  const nodesQueryFactory = createNodesQueryClauseFactory({ imodelAccess, instanceLabelSelectClauseFactory: labelsQueryFactory });
-
-  // Then, define the hierarchy
+  // Define the hierarchy
   const hierarchyDefinition = createPredicateBasedHierarchyDefinition({
-    classHierarchyInspector: imodelAccess,
+    imodelAccess,
     hierarchy: {
       // For root nodes, select all BisCore.GeometricModel3d instances
-      rootNodes: async () => [
+      rootNodes: async ({ createSelectClause }) => [
         {
           fullClassName: "BisCore.GeometricModel3d",
           query: {
             ecsql: `
               SELECT
-                ${await nodesQueryFactory.createSelectClause({
+                ${await createSelectClause({
                   ecClassId: { selector: "this.ECClassId" },
                   ecInstanceId: { selector: "this.ECInstanceId" },
-                  nodeLabel: {
-                    selector: await labelsQueryFactory.createSelectClause({ classAlias: "this", className: "BisCore.GeometricModel3d" }),
-                  },
+                  nodeLabel: { of: { classAlias: "this", className: "BisCore.GeometricModel3d" } },
                 })}
               FROM BisCore.GeometricModel3d this
             `,
@@ -156,21 +127,20 @@ function createProvider(imodelAccess: Props<typeof createIModelHierarchyProvider
         {
           // For BisCore.Model parent nodes, select all BisCore.Element instances contained in corresponding model
           parentInstancesNodePredicate: "BisCore.Model",
-          definitions: async ({ parentNodeInstanceIds }: DefineInstanceNodeChildHierarchyLevelProps) => [
+          definitions: async ({
+            parentNodeInstanceIds,
+            createSelectClause,
+          }: DefineInstanceNodeChildHierarchyLevelProps): Promise<HierarchyLevelDefinition> => [
             {
               fullClassName: "BisCore.Element",
               query: {
                 ecsql: `
                   SELECT
-                    ${await nodesQueryFactory.createSelectClause({
+                    ${await createSelectClause({
                       ecClassId: { selector: "this.ECClassId" },
                       ecInstanceId: { selector: "this.ECInstanceId" },
-                      nodeLabel: {
-                        selector: await labelsQueryFactory.createSelectClause({ classAlias: "this", className: "BisCore.Element" }),
-                      },
-                      grouping: {
-                        byClass: true,
-                      },
+                      nodeLabel: { of: { classAlias: "this", className: "BisCore.Element" } },
+                      grouping: { byClass: true },
                     })}
                   FROM BisCore.Element this
                   WHERE this.Model.Id IN (${parentNodeInstanceIds.map(() => "?").join(",")})

package/lib/hierarchies/HierarchyErrors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyErrors.d.ts","sourceRoot":"","sources":["../../src/hierarchies/HierarchyErrors.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,KAAK;aACZ,KAAK,EAAE,MAAM;IAAhD,YAAmC,KAAK,EAAE,MAAM,EAE/C;CACF"}

package/lib/hierarchies/HierarchyErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyErrors.js","sourceRoot":"","sources":["../../src/hierarchies/HierarchyErrors.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IACZ,KAAK;IAAxC,YAAmC,KAAa;QAC9C,KAAK,CAAC,uBAAuB,KAAK,WAAW,CAAC,CAAC;qBADd,KAAK;IAExC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Error that is thrown when rows amount exceed hierarchy level limit.\n * @public\n */\nexport class RowsLimitExceededError extends Error {\n  public constructor(public readonly limit: number) {\n    super(`Query rows limit of ${limit} exceeded`);\n  }\n}\n"]}

package/lib/hierarchies/HierarchyMerge.d.ts

@@ -0,0 +1,19 @@
+import "./internal/DisposePolyfill.js";
+import type { HierarchyProvider } from "./HierarchyProvider.js";
+/**
+ * Props for `mergeProviders` function.
+ * @public
+ */
+interface MergeHierarchyProvidersProps {
+    /** List of providers to merge. */
+    providers: HierarchyProvider[];
+}
+/**
+ * Creates a single, merged, hierarchy provider from multiple given providers.
+ * @public
+ */
+export declare function mergeProviders({ providers, }: MergeHierarchyProvidersProps): HierarchyProvider & {
+    [Symbol.dispose]: () => void;
+};
+export {};
+//# sourceMappingURL=HierarchyMerge.d.ts.map

package/lib/hierarchies/HierarchyMerge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyMerge.d.ts","sourceRoot":"","sources":["../../src/hierarchies/HierarchyMerge.ts"],"names":[],"mappings":"AAKA,OAAO,+BAA+B,CAAC;AASvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;;GAGG;AACH,UAAU,4BAA4B;IACpC,kCAAkC;IAClC,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,EAC7B,SAAS,GACV,EAAE,4BAA4B,GAAG,iBAAiB,GAAG;IAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,CAyCrF"}

package/lib/{esm/hierarchies/HierarchyProvider.js → hierarchies/HierarchyMerge.js}

@@ -5,17 +5,17 @@
 import "./internal/DisposePolyfill.js";
 import { filter, first, from, map, mergeMap, of } from "rxjs";
 import { BeEvent } from "@itwin/core-bentley";
+import { eachValueFrom } from "@itwin/presentation-shared";
 import { safeDispose } from "./internal/Common.js";
-import { eachValueFrom } from "./internal/EachValueFrom.js";
 import { sortNodesByLabelOperator } from "./internal/operators/Sorting.js";
 /**
  * Creates a single, merged, hierarchy provider from multiple given providers.
  * @public
  */
-export function mergeProviders({ providers }) {
+export function mergeProviders({ providers, }) {
     const hierarchyChanged = new BeEvent();
     providers.forEach((p) => {
-        p.hierarchyChanged.addListener(() => hierarchyChanged.raiseEvent());
+        p.hierarchyChanged.addListener((args) => hierarchyChanged.raiseEvent(args));
     });
     const dispose = () => {
         hierarchyChanged.clear();
@@ -33,9 +33,8 @@ export function mergeProviders({ providers }) {
         }))), sortNodesByLabelOperator)),
         getNodeInstanceKeys: (props) => eachValueFrom(from(providers).pipe(mergeMap((p) => p.getNodeInstanceKeys(props)))),
         setFormatter: (formatter) => providers.forEach((p) => p.setFormatter(formatter)),
-        setHierarchyFilter: (props) => providers.forEach((p) => p.setHierarchyFilter(props)),
+        setHierarchySearch: (props) => providers.forEach((p) => p.setHierarchySearch(props)),
         [Symbol.dispose]: dispose,
-        dispose,
     };
 }
-//# sourceMappingURL=HierarchyProvider.js.map
+//# sourceMappingURL=HierarchyMerge.js.map

package/lib/hierarchies/HierarchyMerge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyMerge.js","sourceRoot":"","sources":["../../src/hierarchies/HierarchyMerge.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,+BAA+B,CAAC;AAEvC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAc3E;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,EAC7B,SAAS,GACoB;IAC7B,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAAoE,CAAC;IACzG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACtB,CAAC,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzB,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC;IAEF,OAAO;QACL,gBAAgB;QAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,aAAa,CACX,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAClB,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CACjC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC;YACD,+FAA+F;YAC/F,6EAA6E;YAC7E,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CACzB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,EAC7B,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,EACjD,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EACf,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,EACvB,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC,CAC3D,CAAC;QACJ,CAAC,CAAC,CACH,CACF,EACD,wBAAwB,CACzB,CACF;QACH,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClH,YAAY,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAChF,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpF,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO;KAC1B,CAAC;AACJ,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 \"./internal/DisposePolyfill.js\";\n\nimport { filter, first, from, map, mergeMap, of } from \"rxjs\";\nimport { BeEvent } from \"@itwin/core-bentley\";\nimport { eachValueFrom } from \"@itwin/presentation-shared\";\nimport { safeDispose } from \"./internal/Common.js\";\nimport { sortNodesByLabelOperator } from \"./internal/operators/Sorting.js\";\n\nimport type { EventArgs } from \"@itwin/presentation-shared\";\nimport type { HierarchyProvider } from \"./HierarchyProvider.js\";\n\n/**\n * Props for `mergeProviders` function.\n * @public\n */\ninterface MergeHierarchyProvidersProps {\n  /** List of providers to merge. */\n  providers: HierarchyProvider[];\n}\n\n/**\n * Creates a single, merged, hierarchy provider from multiple given providers.\n * @public\n */\nexport function mergeProviders({\n  providers,\n}: MergeHierarchyProvidersProps): HierarchyProvider & { [Symbol.dispose]: () => void } {\n  const hierarchyChanged = new BeEvent<(args: EventArgs<HierarchyProvider[\"hierarchyChanged\"]>) => void>();\n  providers.forEach((p) => {\n    p.hierarchyChanged.addListener((args) => hierarchyChanged.raiseEvent(args));\n  });\n  const dispose = () => {\n    hierarchyChanged.clear();\n    providers.forEach((p) => safeDispose(p));\n  };\n\n  return {\n    hierarchyChanged,\n    getNodes: (props) =>\n      eachValueFrom(\n        from(providers).pipe(\n          mergeMap((provider) =>\n            from(provider.getNodes(props)).pipe(\n              mergeMap((node) => {\n                if (node.children) {\n                  return of(node);\n                }\n                // each provider only considers its own data when determining node's children - in case it says\n                // the node has no children, we have to check against the other providers too\n                return from(providers).pipe(\n                  filter((p) => p !== provider),\n                  mergeMap((p) => p.getNodes({ parentNode: node })),\n                  map(() => true),\n                  first(undefined, false),\n                  map((hasChildren) => ({ ...node, children: hasChildren })),\n                );\n              }),\n            ),\n          ),\n          sortNodesByLabelOperator,\n        ),\n      ),\n    getNodeInstanceKeys: (props) => eachValueFrom(from(providers).pipe(mergeMap((p) => p.getNodeInstanceKeys(props)))),\n    setFormatter: (formatter) => providers.forEach((p) => p.setFormatter(formatter)),\n    setHierarchySearch: (props) => providers.forEach((p) => p.setHierarchySearch(props)),\n    [Symbol.dispose]: dispose,\n  };\n}\n"]}

package/lib/{esm/hierarchies → hierarchies}/HierarchyNode.d.ts

@@ -1,30 +1,17 @@
-import { OmitOverUnion } from "@itwin/presentation-shared";
-import { HierarchyFilteringPath, HierarchyFilteringPathOptions } from "./HierarchyFiltering.js";
-import { ClassGroupingNodeKey, GenericNodeKey, GroupingNodeKey, HierarchyNodeKey, IModelHierarchyNodeKey, IModelInstanceKey, InstancesNodeKey, LabelGroupingNodeKey, PropertyGroupingNodeKey, PropertyOtherValuesGroupingNodeKey, PropertyValueGroupingNodeKey, PropertyValueRangeGroupingNodeKey } from "./HierarchyNodeKey.js";
+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 { HierarchySearchTree } from "./HierarchySearch.js";
 /** @public */
-export type HierarchyNodeFilteringProps = {
-    /** If set to true, then one of the ancestor nodes in the hierarchy is the filter target. */
-    hasFilterTargetAncestor?: boolean;
-    /** Paths to node's children that are filter targets. */
-    filteredChildrenIdentifierPaths?: HierarchyFilteringPath[];
-} & ({
-    /** Whether or not this node is a filter target. */
-    isFilterTarget?: false;
-} | {
-    /** Whether or not this node is a filter target. */
-    isFilterTarget: true;
-    /** Options that were used to filter the node. */
-    filterTargetOptions?: HierarchyFilteringPathOptions;
-});
-/** @public */
-export declare namespace HierarchyNodeFilteringProps {
-    /** @deprecated in 1.3. Use `createHierarchyFilteringHelper` and its `createChildNodeProps` function to create filtering props for nodes. */
-    function create(props: {
-        hasFilterTargetAncestor?: boolean;
-        filteredChildrenIdentifierPaths?: HierarchyFilteringPath[];
-        isFilterTarget?: boolean;
-        filterTargetOptions?: HierarchyFilteringPathOptions;
-    }): HierarchyNodeFilteringProps | undefined;
+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?: HierarchySearchTree[];
+    /** Whether or not this node is a search target. */
+    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.
@@ -43,8 +30,6 @@ interface BaseHierarchyNode {
     extendedData?: {
         [key: string]: any;
     };
-    /** Data that may be assigned to the node if filtering is enabled */
-    filtering?: HierarchyNodeFilteringProps;
 }
 /**
  * A data structure that represents a single non-grouping hierarchy node.
@@ -58,6 +43,8 @@ export interface NonGroupingHierarchyNode extends BaseHierarchyNode {
      * filter when requesting child hierarchy level will have no effect.
      */
     supportsFiltering?: boolean;
+    /** Data that is assigned to the node if hierarchy search is enabled */
+    search?: HierarchyNodeSearchProps;
 }
 /**
  * A data structure that represents a grouping node that groups other nodes.
@@ -145,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/hierarchies/HierarchyNode.d.ts.map

@@ -0,0 +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,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,EAC/D,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,wBAAwB,GAAG;QAAE,GAAG,EAAE,cAAc,CAAA;KAAE,CAEpE;IACD,8EAA8E;IAC9E,SAAgB,YAAY,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EAClE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG;QAAE,GAAG,EAAE,sBAAsB,CAAA;KAAE,CAEjD;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACrE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,wBAAwB,GAAG;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,CAEtE;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAAC,KAAK,SAAS;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,EACpE,IAAI,EAAE,KAAK,GACV,IAAI,IAAI,KAAK,GAAG,qBAAqB,CAEvC;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;QACjB,GAAG,EAAE,kCAAkC,CAAC;QACxC,iBAAiB,CAAC,EAAE,SAAS,CAAC;KAC/B,GAAG,qBAAqB,CAExB;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 → hierarchies}/HierarchyNode.js

@@ -2,27 +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 { HierarchyNodeKey, } from "./HierarchyNodeKey.js";
-/** @public */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export var HierarchyNodeFilteringProps;
-(function (HierarchyNodeFilteringProps) {
-    /** @deprecated in 1.3. Use `createHierarchyFilteringHelper` and its `createChildNodeProps` function to create filtering props for nodes. */
-    /* c8 ignore start */
-    function create(props) {
-        const { hasFilterTargetAncestor, filteredChildrenIdentifierPaths, isFilterTarget, filterTargetOptions } = props;
-        if (isFilterTarget || hasFilterTargetAncestor || filteredChildrenIdentifierPaths?.length) {
-            return {
-                ...(isFilterTarget ? { isFilterTarget, filterTargetOptions } : undefined),
-                ...(hasFilterTargetAncestor ? { hasFilterTargetAncestor } : undefined),
-                ...(!!filteredChildrenIdentifierPaths?.length ? { filteredChildrenIdentifierPaths } : undefined),
-            };
-        }
-        return undefined;
-    }
-    HierarchyNodeFilteringProps.create = create;
-    /* c8 ignore end */
-})(HierarchyNodeFilteringProps || (HierarchyNodeFilteringProps = {}));
+import { HierarchyNodeKey } from "./HierarchyNodeKey.js";
 /** @public */
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export var HierarchyNode;
@@ -77,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/hierarchies/HierarchyNode.js.map

@@ -0,0 +1 @@
+{"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,CAiF7B;AAjFD,WAAiB,aAAa;IAC5B,sDAAsD;IACtD,SAAgB,SAAS,CACvB,IAAW;QAEX,OAAO,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAJe,cAAA,SAAS,YAIxB,CAAA;IACD,8EAA8E;IAC9E,SAAgB,YAAY,CAC1B,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,cAAA,YAAY,eAI3B,CAAA;IACD,iEAAiE;IACjE,SAAgB,eAAe,CAC7B,IAAW;QAEX,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAJe,cAAA,eAAe,kBAI9B,CAAA;IACD,uDAAuD;IACvD,SAAgB,cAAc,CAC5B,IAAW;QAEX,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,CAAC;IAJe,cAAA,cAAc,iBAI7B,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,cAAA,mBAAmB,sBAIlC,CAAA;IACD,6DAA6D;IAC7D,SAAgB,mBAAmB,CACjC,IAAW;QAEX,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAJe,cAAA,mBAAmB,sBAIlC,CAAA;IACD,gFAAgF;IAChF,SAAgB,iCAAiC,CAC/C,IAAW;QAKX,OAAO,gBAAgB,CAAC,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAPe,cAAA,iCAAiC,oCAOhD,CAAA;IACD,sEAAsE;IACtE,SAAgB,2BAA2B,CACzC,IAAW;QAEX,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5D,CAAC;IAJe,cAAA,2BAA2B,8BAI1C,CAAA;IACD,4EAA4E;IAC5E,SAAgB,gCAAgC,CAC9C,IAAW;QAEX,OAAO,gBAAgB,CAAC,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjE,CAAC;IAJe,cAAA,gCAAgC,mCAI/C,CAAA;IACD,gEAAgE;IAChE,SAAgB,sBAAsB,CACpC,IAAW;QAEX,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAJe,cAAA,sBAAsB,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,cAAA,oBAAoB,uBAUnC,CAAA;AACH,CAAC,EAjFgB,aAAa,KAAb,aAAa,QAiF7B","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 }>(\n    node: TNode,\n  ): 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 }>(\n    node: TNode,\n  ): 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 }>(\n    node: TNode,\n  ): 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 }>(\n    node: TNode,\n  ): 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 & {\n    key: PropertyOtherValuesGroupingNodeKey;\n    supportsFiltering?: undefined;\n  } & GroupingHierarchyNode {\n    return HierarchyNodeKey.isPropertyOtherValuesGrouping(node.key);\n  }\n  /** Checks whether the given node is a property value grouping node */\n  export function isPropertyValueGroupingNode<TNode extends { key: HierarchyNodeKey }>(\n    node: TNode,\n  ): node is TNode & { key: PropertyValueGroupingNodeKey; supportsFiltering?: undefined } & 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/{cjs/hierarchies → hierarchies}/HierarchyNodeIdentifier.d.ts

@@ -1,4 +1,4 @@
-import { GenericNodeKey, IModelInstanceKey } from "./HierarchyNodeKey.js";
+import type { GenericNodeKey, IModelInstanceKey } from "./HierarchyNodeKey.js";
 /**
  * An identifier that can be used to identify either an ECInstance or a generic node.
  *
@@ -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/hierarchies/HierarchyNodeIdentifier.d.ts.map

@@ -0,0 +1 @@
+{"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 → 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/hierarchies/HierarchyNodeIdentifier.js.map

@@ -0,0 +1 @@
+{"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,wBAAA,wBAAwB,2BAEvC,CAAA;IAED,uEAAuE;IACvE,SAAgB,uBAAuB,CAAC,EAA2B;QACjE,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAFe,wBAAA,uBAAuB,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,wBAAA,KAAK,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,wBAAA,OAAO,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 → 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.FullClassNameDotNotation;
 }
 /**
  * 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.FullClassNameDotNotation;
         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.FullClassNameDotNotation;
     /** 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.FullClassNameDotNotation;
     /** 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/hierarchies/HierarchyNodeKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyNodeKey.d.ts","sourceRoot":"","sources":["../../src/hierarchies/HierarchyNodeKey.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,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,wBAAwB,CAAC;CACxC;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;QAAE,SAAS,EAAE,EAAE,CAAC,wBAAwB,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrF;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,wBAAwB,CAAC;IAE/C,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,wBAAwB,CAAC;IAE/C,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAElB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAC/B,iCAAiC,GACjC,4BAA4B,GAC5B,kCAAkC,CAAC;AAEvC;;;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,CA2F5E;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAE5E;CACF"}

package/lib/{esm/hierarchies → hierarchies}/HierarchyNodeKey.js

@@ -88,7 +88,7 @@ export var HierarchyNodeKey;
                     if (instanceKeyCompareResult !== 0) {
                         return instanceKeyCompareResult;
                     }
-                    const imodelKeyCompareResult = compareStringsOrUndefined(lhs.instanceKeys[0].imodelKey, rhs.instanceKeys[0].imodelKey);
+                    const imodelKeyCompareResult = compareStringsOrUndefined(lhs.instanceKeys[i].imodelKey, rhs.instanceKeys[i].imodelKey);
                     if (imodelKeyCompareResult !== 0) {
                         return imodelKeyCompareResult;
                     }

package/lib/hierarchies/HierarchyNodeKey.js.map

@@ -0,0 +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,MAAM,4BAA4B,CAAC;AA4JzD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,gBAAgB,CA0JhC;AA1JD,WAAiB,gBAAgB;IAC/B,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,GAAqB;QAC7C,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC;IAChC,CAAC;IAFe,iBAAA,SAAS,YAExB,CAAA;IAED,yEAAyE;IACzE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAFe,iBAAA,eAAe,kBAE9B,CAAA;IAED,kEAAkE;IAClE,SAAgB,WAAW,CAAC,GAAqB;QAC/C,OAAO,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC;IAClC,CAAC;IAFe,iBAAA,WAAW,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,iBAAA,UAAU,aAEzB,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,iBAAA,eAAe,kBAE9B,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,iBAAA,eAAe,kBAE9B,CAAA;IAED,mFAAmF;IACnF,SAAgB,6BAA6B,CAAC,GAAqB;QACjE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,iBAAA,6BAA6B,gCAE5C,CAAA;IAED,kFAAkF;IAClF,SAAgB,4BAA4B,CAAC,GAAqB;QAChE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,iBAAA,4BAA4B,+BAE3C,CAAA;IAED,6EAA6E;IAC7E,SAAgB,uBAAuB,CAAC,GAAqB;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,iBAAA,uBAAuB,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,iBAAA,kBAAkB,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,EAAE,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,EAAE,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,CACtD,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,EAC7B,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAC9B,CAAC;oBACF,IAAI,sBAAsB,KAAK,CAAC,EAAE,CAAC;wBACjC,OAAO,sBAAsB,CAAC;oBAChC,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,gBAAgB,EAAE,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,OAAO,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;YACtD,CAAC;YACD,KAAK,gBAAgB,EAAE,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,EAAE,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,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBACpG,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,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;oBACzG,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;wBAC5B,OAAO,iBAAiB,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,yBAAyB,EAAE,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,cAAc,CAAC,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBACpG,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;gBACrF,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,EAAE,CAAC;gBAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,cAAc,CAAC,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBACpG,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;gBACrF,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;IA3Fe,iBAAA,OAAO,UA2FtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAqB,EAAE,GAAqB;QACjE,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAFe,iBAAA,MAAM,SAErB,CAAA;AACH,CAAC,EA1JgB,gBAAgB,KAAhB,gBAAgB,QA0JhC","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 } 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.FullClassNameDotNotation;\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<{ className: EC.FullClassNameDotNotation; propertyName: string }>;\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.FullClassNameDotNotation;\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.FullClassNameDotNotation;\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 =\n  | PropertyValueRangeGroupingNodeKey\n  | PropertyValueGroupingNodeKey\n  | 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(\n            lhs.instanceKeys[i].imodelKey,\n            rhs.instanceKeys[i].imodelKey,\n          );\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(lhs.className, rhs.className);\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(lhs.properties[i].className, rhs.properties[i].className);\n          if (classCompareResult !== 0) {\n            return classCompareResult;\n          }\n          const nameCompareResult = compareStrings(lhs.properties[i].propertyName, rhs.properties[i].propertyName);\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(lhs.propertyClassName, rhs.propertyClassName);\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName, rhs.propertyName);\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(lhs.propertyClassName, rhs.propertyClassName);\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName, rhs.propertyName);\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"]}