@itwin/presentation-common 4.0.0-dev.24 → 4.0.0-dev.28

package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts

@@ -1,38 +1,38 @@
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { Node, NodeJSON } from "./Node";
-/**
- * Defines a hierarchy level that consists of an array of nodes and possibly other information.
- * @beta
- */
-export interface HierarchyLevel {
-    /** A list of nodes in a hierarchy level. */
-    nodes: Node[];
-    /**
-     * Identifies whether the hierarchy level supports filtering. If not, requesting either a hierarchy level descriptor or
-     * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.
-     */
-    supportsFiltering?: boolean;
-}
-/**
- * JSON representation of [[HierarchyLevel]].
- * @beta
- * @deprecated in 3.x. Use [[HierarchyLevel]]
- */
-export interface HierarchyLevelJSON {
-    nodes: NodeJSON[];
-    supportsFiltering?: boolean;
-}
-/**
- * Contains helper functions for working with objects of [[HierarchyLevel]] type.
- * @beta
- */
-export declare namespace HierarchyLevel {
-    /**
-     * Deserialize [[HierarchyLevel]] from JSON
-     * @deprecated in 3.x. Use [[HierarchyLevel]].
-     */
-    function fromJSON(json: HierarchyLevelJSON): HierarchyLevel;
-}
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { Node, NodeJSON } from "./Node";
+/**
+ * Defines a hierarchy level that consists of an array of nodes and possibly other information.
+ * @beta
+ */
+export interface HierarchyLevel {
+    /** A list of nodes in a hierarchy level. */
+    nodes: Node[];
+    /**
+     * Identifies whether the hierarchy level supports filtering. If not, requesting either a hierarchy level descriptor or
+     * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.
+     */
+    supportsFiltering?: boolean;
+}
+/**
+ * JSON representation of [[HierarchyLevel]].
+ * @beta
+ * @deprecated in 3.x. Use [[HierarchyLevel]]
+ */
+export interface HierarchyLevelJSON {
+    nodes: NodeJSON[];
+    supportsFiltering?: boolean;
+}
+/**
+ * Contains helper functions for working with objects of [[HierarchyLevel]] type.
+ * @beta
+ */
+export declare namespace HierarchyLevel {
+    /**
+     * Deserialize [[HierarchyLevel]] from JSON
+     * @deprecated in 3.x. Use [[HierarchyLevel]].
+     */
+    function fromJSON(json: HierarchyLevelJSON): HierarchyLevel;
+}
 //# sourceMappingURL=HierarchyLevel.d.ts.map

package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js

@@ -1,29 +1,29 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { Node } from "./Node";
-/**
- * Contains helper functions for working with objects of [[HierarchyLevel]] type.
- * @beta
- */
-export var HierarchyLevel;
-(function (HierarchyLevel) {
-    /**
-     * Deserialize [[HierarchyLevel]] from JSON
-     * @deprecated in 3.x. Use [[HierarchyLevel]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        return {
-            ...json,
-            // eslint-disable-next-line deprecation/deprecation
-            nodes: json.nodes.map(Node.fromJSON),
-        };
-    }
-    HierarchyLevel.fromJSON = fromJSON;
-})(HierarchyLevel || (HierarchyLevel = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { Node } from "./Node";
+/**
+ * Contains helper functions for working with objects of [[HierarchyLevel]] type.
+ * @beta
+ */
+export var HierarchyLevel;
+(function (HierarchyLevel) {
+    /**
+     * Deserialize [[HierarchyLevel]] from JSON
+     * @deprecated in 3.x. Use [[HierarchyLevel]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        return {
+            ...json,
+            // eslint-disable-next-line deprecation/deprecation
+            nodes: json.nodes.map(Node.fromJSON),
+        };
+    }
+    HierarchyLevel.fromJSON = fromJSON;
+})(HierarchyLevel || (HierarchyLevel = {}));
 //# sourceMappingURL=HierarchyLevel.js.map

package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js.map

@@ -1 +1 @@
-{"version":3,"file":"HierarchyLevel.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/HierarchyLevel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAY,MAAM,QAAQ,CAAC;AA2BxC;;;GAGG;AACH,MAAM,KAAW,cAAc,CAa9B;AAbD,WAAiB,cAAc;IAC7B;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAwB;QAC/C,OAAO;YACL,GAAG,IAAI;YACP,mDAAmD;YACnD,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;SACrC,CAAC;IACJ,CAAC;IANe,uBAAQ,WAMvB,CAAA;AACH,CAAC,EAbgB,cAAc,KAAd,cAAc,QAa9B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Hierarchies\r\n */\r\n\r\nimport { Node, NodeJSON } from \"./Node\";\r\n\r\n/**\r\n * Defines a hierarchy level that consists of an array of nodes and possibly other information.\r\n * @beta\r\n */\r\nexport interface HierarchyLevel {\r\n  /** A list of nodes in a hierarchy level. */\r\n  nodes: Node[];\r\n  /**\r\n   * Identifies whether the hierarchy level supports filtering. If not, requesting either a hierarchy level descriptor or\r\n   * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.\r\n   */\r\n  supportsFiltering?: boolean;\r\n}\r\n\r\n/**\r\n * JSON representation of [[HierarchyLevel]].\r\n * @beta\r\n * @deprecated in 3.x. Use [[HierarchyLevel]]\r\n */\r\nexport interface HierarchyLevelJSON {\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  nodes: NodeJSON[];\r\n  supportsFiltering?: boolean;\r\n}\r\n\r\n/**\r\n * Contains helper functions for working with objects of [[HierarchyLevel]] type.\r\n * @beta\r\n */\r\nexport namespace HierarchyLevel {\r\n  /**\r\n   * Deserialize [[HierarchyLevel]] from JSON\r\n   * @deprecated in 3.x. Use [[HierarchyLevel]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: HierarchyLevelJSON): HierarchyLevel {\r\n    return {\r\n      ...json,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      nodes: json.nodes.map(Node.fromJSON),\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"HierarchyLevel.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/HierarchyLevel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAY,MAAM,QAAQ,CAAC;AA2BxC;;;GAGG;AACH,MAAM,KAAW,cAAc,CAa9B;AAbD,WAAiB,cAAc;IAC7B;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAwB;QAC/C,OAAO;YACL,GAAG,IAAI;YACP,mDAAmD;YACnD,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;SACrC,CAAC;IACJ,CAAC;IANe,uBAAQ,WAMvB,CAAA;AACH,CAAC,EAbgB,cAAc,KAAd,cAAc,QAa9B","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/** @packageDocumentation\n * @module Hierarchies\n */\n\nimport { Node, NodeJSON } from \"./Node\";\n\n/**\n * Defines a hierarchy level that consists of an array of nodes and possibly other information.\n * @beta\n */\nexport interface HierarchyLevel {\n  /** A list of nodes in a hierarchy level. */\n  nodes: Node[];\n  /**\n   * Identifies whether the hierarchy level supports filtering. If not, requesting either a hierarchy level descriptor or\n   * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.\n   */\n  supportsFiltering?: boolean;\n}\n\n/**\n * JSON representation of [[HierarchyLevel]].\n * @beta\n * @deprecated in 3.x. Use [[HierarchyLevel]]\n */\nexport interface HierarchyLevelJSON {\n  // eslint-disable-next-line deprecation/deprecation\n  nodes: NodeJSON[];\n  supportsFiltering?: boolean;\n}\n\n/**\n * Contains helper functions for working with objects of [[HierarchyLevel]] type.\n * @beta\n */\nexport namespace HierarchyLevel {\n  /**\n   * Deserialize [[HierarchyLevel]] from JSON\n   * @deprecated in 3.x. Use [[HierarchyLevel]].\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  export function fromJSON(json: HierarchyLevelJSON): HierarchyLevel {\n    return {\n      ...json,\n      // eslint-disable-next-line deprecation/deprecation\n      nodes: json.nodes.map(Node.fromJSON),\n    };\n  }\n}\n"]}

package/lib/esm/presentation-common/hierarchy/Key.d.ts

@@ -1,247 +1,247 @@
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { Id64String } from "@itwin/core-bentley";
-import { InstanceKey } from "../EC";
-/**
- * Standard node types
- * @public
- */
-export declare enum StandardNodeTypes {
-    ECInstancesNode = "ECInstancesNode",
-    ECClassGroupingNode = "ECClassGroupingNode",
-    ECPropertyGroupingNode = "ECPropertyGroupingNode",
-    DisplayLabelGroupingNode = "DisplayLabelGroupingNode"
-}
-/**
- * One of the node key types
- * @public
- */
-export declare type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;
-/** @public */
-export declare namespace NodeKey {
-    /**
-     * Serialize given [[NodeKey]] to JSON
-     * @deprecated in 3.x. Use [[NodeKey]].
-     */
-    function toJSON(key: NodeKey): NodeKeyJSON;
-    /**
-     * Deserialize node key from JSON
-     * @deprecated in 3.x. Use [[NodeKey]].
-     */
-    function fromJSON(json: NodeKeyJSON): NodeKey;
-    /** Checks if the supplied key is an [[ECInstancesNodeKey]] */
-    function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey;
-    /** Checks if the supplied key is an [[ECInstancesNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
-    function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;
-    /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */
-    function isClassGroupingNodeKey(key: NodeKey): key is ECClassGroupingNodeKey;
-    /** Checks if the supplied key is an [[ECClassGroupingNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
-    function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;
-    /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */
-    function isPropertyGroupingNodeKey(key: NodeKey): key is ECPropertyGroupingNodeKey;
-    /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
-    function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;
-    /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */
-    function isLabelGroupingNodeKey(key: NodeKey): key is LabelGroupingNodeKey;
-    /** Checks if the supplied key is a [[LabelGroupingNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
-    function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;
-    /** Checks if the supplied key is a grouping node key */
-    function isGroupingNodeKey(key: NodeKey): key is GroupingNodeKey;
-    /** Checks if the supplied key is a grouping node key. @deprecated in 3.x. Use an override for [[NodeKey]]. */
-    function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;
-    /**
-     * Checks if two given node keys are equal, taking their versions into account.
-     *
-     * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array
-     * which is the most accurate way of checking equality. However, when version are different,
-     * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.
-     * In that case equality is checked using other key attributes, depending on the type of the node (type,
-     * label, grouping class, property name, etc.).
-     */
-    function equals(lhs: NodeKey, rhs: NodeKey): boolean;
-}
-/**
- * Node key path. Can be used to define path from one node to another.
- * @public
- */
-export declare type NodeKeyPath = NodeKey[];
-/**
- * Data structure that describes a basic node key
- * @public
- */
-export interface BaseNodeKey {
-    /** Node type */
-    type: string;
-    /**
-     * Version of the key. Different versions suggest that node keys were created by two different
-     * versions of the library. In that case, keys representing the same node may be different.
-     */
-    version: number;
-    /** Node hash path from root to the node whose key this is */
-    pathFromRoot: string[];
-    /** Query that returns all selected instance keys
-     * @alpha
-     */
-    instanceKeysSelectQuery?: PresentationQuery;
-}
-/**
- * Serialized [[BaseNodeKey]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[BaseNodeKey]].
- */
-export interface BaseNodeKeyJSON {
-    type: string;
-    version?: number;
-    pathFromRoot: string[];
-    /** @alpha */
-    instanceKeysSelectQuery?: PresentationQuery;
-}
-/**
- * Data structure that describes a node ECInstance node key
- * @public
- */
-export interface ECInstancesNodeKey extends BaseNodeKey {
-    type: StandardNodeTypes.ECInstancesNode;
-    /** List of [[InstanceKey]] objects of ECInstances represented by the node */
-    instanceKeys: InstanceKey[];
-}
-/**
- * Serialized [[ECInstancesNodeKey]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[ECInstancesNodeKey]].
- */
-export interface ECInstancesNodeKeyJSON extends BaseNodeKey {
-    type: StandardNodeTypes.ECInstancesNode;
-    instanceKeys: InstanceKey[];
-}
-/**
- * Data structure that describes a grouping node key
- * @public
- */
-export interface GroupingNodeKey extends BaseNodeKey {
-    /**
-     * Get the number of instances grouped by the node represented
-     * by this key.
-     *
-     * **Note:** this property is just a helper and is not involved
-     * in identifying a node.
-     */
-    groupedInstancesCount: number;
-}
-/**
- * Serialized [[GroupingNodeKey]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[GroupingNodeKey]].
- */
-export interface GroupingNodeKeyJSON extends BaseNodeKey {
-    groupedInstancesCount: number;
-}
-/**
- * Data structure that describes an ECClass grouping node key
- * @public
- */
-export interface ECClassGroupingNodeKey extends GroupingNodeKey {
-    type: StandardNodeTypes.ECClassGroupingNode;
-    /** Full name of the grouping ECClass */
-    className: string;
-}
-/**
- * Serialized [[ECClassGroupingNodeKey]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[ECClassGroupingNodeKey]].
- */
-export interface ECClassGroupingNodeKeyJSON extends GroupingNodeKey {
-    type: StandardNodeTypes.ECClassGroupingNode;
-    className: string;
-}
-/**
- * Data structure that describes an ECProperty grouping node key
- * @public
- */
-export interface ECPropertyGroupingNodeKey extends GroupingNodeKey {
-    type: StandardNodeTypes.ECPropertyGroupingNode;
-    /** Full name of the grouping ECProperty class */
-    className: string;
-    /** Name of the ECProperty */
-    propertyName: string;
-    /** Raw grouping values */
-    groupingValues: any[];
-}
-/**
- * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[ECPropertyGroupingNodeKey]].
- */
-export interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKey {
-    type: StandardNodeTypes.ECPropertyGroupingNode;
-    className: string;
-    propertyName: string;
-    groupingValues: any[];
-}
-/**
- * Data structure that describes a display label grouping node key
- * @public
- */
-export interface LabelGroupingNodeKey extends GroupingNodeKey {
-    type: StandardNodeTypes.DisplayLabelGroupingNode;
-    /** Grouping display label */
-    label: string;
-}
-/**
- * Serialized [[LabelGroupingNodeKey]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[LabelGroupingNodeKey]].
- */
-export interface LabelGroupingNodeKeyJSON extends GroupingNodeKey {
-    type: StandardNodeTypes.DisplayLabelGroupingNode;
-    label: string;
-}
-/**
- * One of the serialized node key types
- * @public
- * @deprecated in 3.x. Use [[NodeKey]].
- */
-export declare type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;
-/**
- * Data structure that describes a presentation query
- * @alpha
- */
-export interface PresentationQuery {
-    /** ECSQL query */
-    query: string;
-    /** The query bindings */
-    bindings?: PresentationQueryBinding[];
-}
-/** @alpha */
-export interface BasePresentationQueryBinding {
-    type: "Id" | "IdSet" | "ECValue" | "ValueSet";
-}
-/** @alpha */
-export interface IdBinding extends BasePresentationQueryBinding {
-    type: "Id";
-    value: Id64String;
-}
-/** @alpha */
-export interface IdSetBinding extends BasePresentationQueryBinding {
-    type: "IdSet";
-    value: Id64String[];
-}
-/** @alpha */
-export interface ECValueBinding extends BasePresentationQueryBinding {
-    type: "ECValue";
-    valueType: string;
-    value: any;
-}
-/** @alpha */
-export interface ECValueSetBinding extends BasePresentationQueryBinding {
-    type: "ValueSet";
-    valueType: string;
-    value: any[];
-}
-/**
- * One of the presentation query binding types
- * @alpha
- */
-export declare type PresentationQueryBinding = IdBinding | IdSetBinding | ECValueBinding | ECValueSetBinding;
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { InstanceKey } from "../EC";
+/**
+ * Standard node types
+ * @public
+ */
+export declare enum StandardNodeTypes {
+    ECInstancesNode = "ECInstancesNode",
+    ECClassGroupingNode = "ECClassGroupingNode",
+    ECPropertyGroupingNode = "ECPropertyGroupingNode",
+    DisplayLabelGroupingNode = "DisplayLabelGroupingNode"
+}
+/**
+ * One of the node key types
+ * @public
+ */
+export declare type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;
+/** @public */
+export declare namespace NodeKey {
+    /**
+     * Serialize given [[NodeKey]] to JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
+    function toJSON(key: NodeKey): NodeKeyJSON;
+    /**
+     * Deserialize node key from JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
+    function fromJSON(json: NodeKeyJSON): NodeKey;
+    /** Checks if the supplied key is an [[ECInstancesNodeKey]] */
+    function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey;
+    /** Checks if the supplied key is an [[ECInstancesNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
+    function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;
+    /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */
+    function isClassGroupingNodeKey(key: NodeKey): key is ECClassGroupingNodeKey;
+    /** Checks if the supplied key is an [[ECClassGroupingNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
+    function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;
+    /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */
+    function isPropertyGroupingNodeKey(key: NodeKey): key is ECPropertyGroupingNodeKey;
+    /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
+    function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;
+    /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */
+    function isLabelGroupingNodeKey(key: NodeKey): key is LabelGroupingNodeKey;
+    /** Checks if the supplied key is a [[LabelGroupingNodeKey]]. @deprecated in 3.x. Use an override for [[NodeKey]]. */
+    function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;
+    /** Checks if the supplied key is a grouping node key */
+    function isGroupingNodeKey(key: NodeKey): key is GroupingNodeKey;
+    /** Checks if the supplied key is a grouping node key. @deprecated in 3.x. Use an override for [[NodeKey]]. */
+    function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;
+    /**
+     * Checks if two given node keys are equal, taking their versions into account.
+     *
+     * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array
+     * which is the most accurate way of checking equality. However, when version are different,
+     * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.
+     * In that case equality is checked using other key attributes, depending on the type of the node (type,
+     * label, grouping class, property name, etc.).
+     */
+    function equals(lhs: NodeKey, rhs: NodeKey): boolean;
+}
+/**
+ * Node key path. Can be used to define path from one node to another.
+ * @public
+ */
+export declare type NodeKeyPath = NodeKey[];
+/**
+ * Data structure that describes a basic node key
+ * @public
+ */
+export interface BaseNodeKey {
+    /** Node type */
+    type: string;
+    /**
+     * Version of the key. Different versions suggest that node keys were created by two different
+     * versions of the library. In that case, keys representing the same node may be different.
+     */
+    version: number;
+    /** Node hash path from root to the node whose key this is */
+    pathFromRoot: string[];
+    /** Query that returns all selected instance keys
+     * @alpha
+     */
+    instanceKeysSelectQuery?: PresentationQuery;
+}
+/**
+ * Serialized [[BaseNodeKey]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[BaseNodeKey]].
+ */
+export interface BaseNodeKeyJSON {
+    type: string;
+    version?: number;
+    pathFromRoot: string[];
+    /** @alpha */
+    instanceKeysSelectQuery?: PresentationQuery;
+}
+/**
+ * Data structure that describes a node ECInstance node key
+ * @public
+ */
+export interface ECInstancesNodeKey extends BaseNodeKey {
+    type: StandardNodeTypes.ECInstancesNode;
+    /** List of [[InstanceKey]] objects of ECInstances represented by the node */
+    instanceKeys: InstanceKey[];
+}
+/**
+ * Serialized [[ECInstancesNodeKey]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[ECInstancesNodeKey]].
+ */
+export interface ECInstancesNodeKeyJSON extends BaseNodeKey {
+    type: StandardNodeTypes.ECInstancesNode;
+    instanceKeys: InstanceKey[];
+}
+/**
+ * Data structure that describes a grouping node key
+ * @public
+ */
+export interface GroupingNodeKey extends BaseNodeKey {
+    /**
+     * Get the number of instances grouped by the node represented
+     * by this key.
+     *
+     * **Note:** this property is just a helper and is not involved
+     * in identifying a node.
+     */
+    groupedInstancesCount: number;
+}
+/**
+ * Serialized [[GroupingNodeKey]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[GroupingNodeKey]].
+ */
+export interface GroupingNodeKeyJSON extends BaseNodeKey {
+    groupedInstancesCount: number;
+}
+/**
+ * Data structure that describes an ECClass grouping node key
+ * @public
+ */
+export interface ECClassGroupingNodeKey extends GroupingNodeKey {
+    type: StandardNodeTypes.ECClassGroupingNode;
+    /** Full name of the grouping ECClass */
+    className: string;
+}
+/**
+ * Serialized [[ECClassGroupingNodeKey]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[ECClassGroupingNodeKey]].
+ */
+export interface ECClassGroupingNodeKeyJSON extends GroupingNodeKey {
+    type: StandardNodeTypes.ECClassGroupingNode;
+    className: string;
+}
+/**
+ * Data structure that describes an ECProperty grouping node key
+ * @public
+ */
+export interface ECPropertyGroupingNodeKey extends GroupingNodeKey {
+    type: StandardNodeTypes.ECPropertyGroupingNode;
+    /** Full name of the grouping ECProperty class */
+    className: string;
+    /** Name of the ECProperty */
+    propertyName: string;
+    /** Raw grouping values */
+    groupingValues: any[];
+}
+/**
+ * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[ECPropertyGroupingNodeKey]].
+ */
+export interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKey {
+    type: StandardNodeTypes.ECPropertyGroupingNode;
+    className: string;
+    propertyName: string;
+    groupingValues: any[];
+}
+/**
+ * Data structure that describes a display label grouping node key
+ * @public
+ */
+export interface LabelGroupingNodeKey extends GroupingNodeKey {
+    type: StandardNodeTypes.DisplayLabelGroupingNode;
+    /** Grouping display label */
+    label: string;
+}
+/**
+ * Serialized [[LabelGroupingNodeKey]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[LabelGroupingNodeKey]].
+ */
+export interface LabelGroupingNodeKeyJSON extends GroupingNodeKey {
+    type: StandardNodeTypes.DisplayLabelGroupingNode;
+    label: string;
+}
+/**
+ * One of the serialized node key types
+ * @public
+ * @deprecated in 3.x. Use [[NodeKey]].
+ */
+export declare type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;
+/**
+ * Data structure that describes a presentation query
+ * @alpha
+ */
+export interface PresentationQuery {
+    /** ECSQL query */
+    query: string;
+    /** The query bindings */
+    bindings?: PresentationQueryBinding[];
+}
+/** @alpha */
+export interface BasePresentationQueryBinding {
+    type: "Id" | "IdSet" | "ECValue" | "ValueSet";
+}
+/** @alpha */
+export interface IdBinding extends BasePresentationQueryBinding {
+    type: "Id";
+    value: Id64String;
+}
+/** @alpha */
+export interface IdSetBinding extends BasePresentationQueryBinding {
+    type: "IdSet";
+    value: Id64String[];
+}
+/** @alpha */
+export interface ECValueBinding extends BasePresentationQueryBinding {
+    type: "ECValue";
+    valueType: string;
+    value: any;
+}
+/** @alpha */
+export interface ECValueSetBinding extends BasePresentationQueryBinding {
+    type: "ValueSet";
+    valueType: string;
+    value: any[];
+}
+/**
+ * One of the presentation query binding types
+ * @alpha
+ */
+export declare type PresentationQueryBinding = IdBinding | IdSetBinding | ECValueBinding | ECValueSetBinding;
 //# sourceMappingURL=Key.d.ts.map