@itwin/presentation-common 3.6.0-dev.8 → 3.6.0

package/lib/cjs/presentation-common/hierarchy/Key.js

@@ -1,113 +1,122 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeKey = exports.StandardNodeTypes = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const EC_1 = require("../EC");
-/**
- * Standard node types
- * @public
- */
-var StandardNodeTypes;
-(function (StandardNodeTypes) {
-    StandardNodeTypes["ECInstancesNode"] = "ECInstancesNode";
-    StandardNodeTypes["ECClassGroupingNode"] = "ECClassGroupingNode";
-    StandardNodeTypes["ECPropertyGroupingNode"] = "ECPropertyGroupingNode";
-    StandardNodeTypes["DisplayLabelGroupingNode"] = "DisplayLabelGroupingNode";
-})(StandardNodeTypes = exports.StandardNodeTypes || (exports.StandardNodeTypes = {}));
-/** @public */
-var NodeKey;
-(function (NodeKey) {
-    /** Serialize given [[NodeKey]] to JSON */
-    function toJSON(key) {
-        if (isInstancesNodeKey(key))
-            return { ...key, instanceKeys: key.instanceKeys.map(EC_1.InstanceKey.toJSON) };
-        return { ...key };
-    }
-    NodeKey.toJSON = toJSON;
-    /** Deserialize node key from JSON */
-    function fromJSON(json) {
-        if (isInstancesNodeKey(json))
-            return { version: 1, ...json, instanceKeys: json.instanceKeys.map(EC_1.InstanceKey.fromJSON) };
-        return { version: 1, ...json };
-    }
-    NodeKey.fromJSON = fromJSON;
-    function isInstancesNodeKey(key) {
-        return key.type === StandardNodeTypes.ECInstancesNode;
-    }
-    NodeKey.isInstancesNodeKey = isInstancesNodeKey;
-    function isClassGroupingNodeKey(key) {
-        return key.type === StandardNodeTypes.ECClassGroupingNode;
-    }
-    NodeKey.isClassGroupingNodeKey = isClassGroupingNodeKey;
-    function isPropertyGroupingNodeKey(key) {
-        return key.type === StandardNodeTypes.ECPropertyGroupingNode;
-    }
-    NodeKey.isPropertyGroupingNodeKey = isPropertyGroupingNodeKey;
-    function isLabelGroupingNodeKey(key) {
-        return key.type === StandardNodeTypes.DisplayLabelGroupingNode;
-    }
-    NodeKey.isLabelGroupingNodeKey = isLabelGroupingNodeKey;
-    function isGroupingNodeKey(key) {
-        return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key);
-    }
-    NodeKey.isGroupingNodeKey = isGroupingNodeKey;
-    /**
-     * 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, rhs) {
-        // types must always be equal
-        if (lhs.type !== rhs.type)
-            return false;
-        // `pathFromRoot` lengths must always be equal
-        if (lhs.pathFromRoot.length !== rhs.pathFromRoot.length)
-            return false;
-        // when versions are equal, compare using contents of `pathFromRoot` array
-        if (lhs.version === rhs.version) {
-            for (let i = 0; i < lhs.pathFromRoot.length; ++i) {
-                if (lhs.pathFromRoot[i] !== rhs.pathFromRoot[i])
-                    return false;
-            }
-            return true;
-        }
-        // when versions aren't equal, compare using other key information, because key hashes
-        // of different key versions can't be compared
-        if (isInstancesNodeKey(lhs)) {
-            (0, core_bentley_1.assert)(isInstancesNodeKey(rhs));
-            if (lhs.instanceKeys.length !== rhs.instanceKeys.length)
-                return false;
-            for (let i = 0; i < lhs.instanceKeys.length; ++i) {
-                if (0 !== EC_1.InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]))
-                    return false;
-            }
-            return true;
-        }
-        if (isClassGroupingNodeKey(lhs)) {
-            (0, core_bentley_1.assert)(isClassGroupingNodeKey(rhs));
-            return lhs.className === rhs.className;
-        }
-        if (isPropertyGroupingNodeKey(lhs)) {
-            (0, core_bentley_1.assert)(isPropertyGroupingNodeKey(rhs));
-            return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;
-        }
-        if (isLabelGroupingNodeKey(lhs)) {
-            (0, core_bentley_1.assert)(isLabelGroupingNodeKey(rhs));
-            return lhs.label === rhs.label;
-        }
-        return true;
-    }
-    NodeKey.equals = equals;
-})(NodeKey = exports.NodeKey || (exports.NodeKey = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeKey = exports.StandardNodeTypes = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const EC_1 = require("../EC");
+/**
+ * Standard node types
+ * @public
+ */
+var StandardNodeTypes;
+(function (StandardNodeTypes) {
+    StandardNodeTypes["ECInstancesNode"] = "ECInstancesNode";
+    StandardNodeTypes["ECClassGroupingNode"] = "ECClassGroupingNode";
+    StandardNodeTypes["ECPropertyGroupingNode"] = "ECPropertyGroupingNode";
+    StandardNodeTypes["DisplayLabelGroupingNode"] = "DisplayLabelGroupingNode";
+})(StandardNodeTypes = exports.StandardNodeTypes || (exports.StandardNodeTypes = {}));
+/** @public */
+var NodeKey;
+(function (NodeKey) {
+    /**
+     * Serialize given [[NodeKey]] to JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(key) {
+        return { ...key };
+    }
+    NodeKey.toJSON = toJSON;
+    /**
+     * Deserialize node key from JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        return { version: 1, ...json };
+    }
+    NodeKey.fromJSON = fromJSON;
+    // eslint-disable-next-line deprecation/deprecation
+    function isInstancesNodeKey(key) {
+        return key.type === StandardNodeTypes.ECInstancesNode;
+    }
+    NodeKey.isInstancesNodeKey = isInstancesNodeKey;
+    // eslint-disable-next-line deprecation/deprecation
+    function isClassGroupingNodeKey(key) {
+        return key.type === StandardNodeTypes.ECClassGroupingNode;
+    }
+    NodeKey.isClassGroupingNodeKey = isClassGroupingNodeKey;
+    // eslint-disable-next-line deprecation/deprecation
+    function isPropertyGroupingNodeKey(key) {
+        return key.type === StandardNodeTypes.ECPropertyGroupingNode;
+    }
+    NodeKey.isPropertyGroupingNodeKey = isPropertyGroupingNodeKey;
+    // eslint-disable-next-line deprecation/deprecation
+    function isLabelGroupingNodeKey(key) {
+        return key.type === StandardNodeTypes.DisplayLabelGroupingNode;
+    }
+    NodeKey.isLabelGroupingNodeKey = isLabelGroupingNodeKey;
+    // eslint-disable-next-line deprecation/deprecation
+    function isGroupingNodeKey(key) {
+        return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key);
+    }
+    NodeKey.isGroupingNodeKey = isGroupingNodeKey;
+    /**
+     * 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, rhs) {
+        // types must always be equal
+        if (lhs.type !== rhs.type)
+            return false;
+        // `pathFromRoot` lengths must always be equal
+        if (lhs.pathFromRoot.length !== rhs.pathFromRoot.length)
+            return false;
+        // when versions are equal, compare using contents of `pathFromRoot` array
+        if (lhs.version === rhs.version) {
+            for (let i = 0; i < lhs.pathFromRoot.length; ++i) {
+                if (lhs.pathFromRoot[i] !== rhs.pathFromRoot[i])
+                    return false;
+            }
+            return true;
+        }
+        // when versions aren't equal, compare using other key information, because key hashes
+        // of different key versions can't be compared
+        if (isInstancesNodeKey(lhs)) {
+            (0, core_bentley_1.assert)(isInstancesNodeKey(rhs));
+            if (lhs.instanceKeys.length !== rhs.instanceKeys.length)
+                return false;
+            for (let i = 0; i < lhs.instanceKeys.length; ++i) {
+                if (0 !== EC_1.InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]))
+                    return false;
+            }
+            return true;
+        }
+        if (isClassGroupingNodeKey(lhs)) {
+            (0, core_bentley_1.assert)(isClassGroupingNodeKey(rhs));
+            return lhs.className === rhs.className;
+        }
+        if (isPropertyGroupingNodeKey(lhs)) {
+            (0, core_bentley_1.assert)(isPropertyGroupingNodeKey(rhs));
+            return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;
+        }
+        if (isLabelGroupingNodeKey(lhs)) {
+            (0, core_bentley_1.assert)(isLabelGroupingNodeKey(rhs));
+            return lhs.label === rhs.label;
+        }
+        return true;
+    }
+    NodeKey.equals = equals;
+})(NodeKey = exports.NodeKey || (exports.NodeKey = {}));
 //# sourceMappingURL=Key.js.map

package/lib/cjs/presentation-common/hierarchy/Key.js.map

@@ -1 +1 @@
-{"version":3,"file":"Key.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Key.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,8BAAqD;AAErD;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wDAAmC,CAAA;IACnC,gEAA2C,CAAA;IAC3C,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;AACvD,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAOD,cAAc;AACd,IAAiB,OAAO,CA4GvB;AA5GD,WAAiB,OAAO;IACtB,0CAA0C;IAC1C,SAAgB,MAAM,CAAC,GAAY;QACjC,IAAI,kBAAkB,CAAC,GAAG,CAAC;YACzB,OAAO,EAAE,GAAG,GAAG,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,gBAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5E,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IACpB,CAAC;IAJe,cAAM,SAIrB,CAAA;IAED,qCAAqC;IACrC,SAAgB,QAAQ,CAAC,IAAiB;QACxC,IAAI,kBAAkB,CAAC,IAAI,CAAC;YAC1B,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,gBAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5F,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;IACjC,CAAC;IAJe,gBAAQ,WAIvB,CAAA;IAMD,SAAgB,kBAAkB,CAAC,GAA0B;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,eAAe,CAAC;IACxD,CAAC;IAFe,0BAAkB,qBAEjC,CAAA;IAMD,SAAgB,sBAAsB,CAAC,GAA0B;QAC/D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,mBAAmB,CAAC;IAC5D,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAMD,SAAgB,yBAAyB,CAAC,GAA0B;QAClE,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,sBAAsB,CAAC;IAC/D,CAAC;IAFe,iCAAyB,4BAExC,CAAA;IAMD,SAAgB,sBAAsB,CAAC,GAA0B;QAC/D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,wBAAwB,CAAC;IACjE,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAMD,SAAgB,iBAAiB,CAAC,GAA0B;QAC1D,OAAO,sBAAsB,CAAC,GAAG,CAAC,IAAI,yBAAyB,CAAC,GAAG,CAAC,IAAI,sBAAsB,CAAC,GAAG,CAAC,CAAC;IACtG,CAAC;IAFe,yBAAiB,oBAEhC,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,MAAM,CAAC,GAAY,EAAE,GAAY;QAC/C,6BAA6B;QAC7B,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI;YACvB,OAAO,KAAK,CAAC;QAEf,8CAA8C;QAC9C,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM;YACrD,OAAO,KAAK,CAAC;QAEf,0EAA0E;QAC1E,IAAI,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAChD,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;oBAC7C,OAAO,KAAK,CAAC;aAChB;YACD,OAAO,IAAI,CAAC;SACb;QAED,sFAAsF;QACtF,8CAA8C;QAC9C,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE;YAC3B,IAAA,qBAAM,EAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YAChC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM;gBACrD,OAAO,KAAK,CAAC;YACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAChD,IAAI,CAAC,KAAK,gBAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;oBACrE,OAAO,KAAK,CAAC;aAChB;YACD,OAAO,IAAI,CAAC;SACb;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC;SACxC;QACD,IAAI,yBAAyB,CAAC,GAAG,CAAC,EAAE;YAClC,IAAA,qBAAM,EAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC;YACvC,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,CAAC;SACjF;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IA3Ce,cAAM,SA2CrB,CAAA;AACH,CAAC,EA5GgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA4GvB","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 { assert } from \"@itwin/core-bentley\";\r\nimport { InstanceKey, InstanceKeyJSON } from \"../EC\";\r\n\r\n/**\r\n * Standard node types\r\n * @public\r\n */\r\nexport enum StandardNodeTypes {\r\n  ECInstancesNode = \"ECInstancesNode\",\r\n  ECClassGroupingNode = \"ECClassGroupingNode\",\r\n  ECPropertyGroupingNode = \"ECPropertyGroupingNode\",\r\n  DisplayLabelGroupingNode = \"DisplayLabelGroupingNode\",\r\n}\r\n\r\n/**\r\n * One of the node key types\r\n * @public\r\n */\r\nexport type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;\r\n/** @public */\r\nexport namespace NodeKey { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  /** Serialize given [[NodeKey]] to JSON */\r\n  export function toJSON(key: NodeKey): NodeKeyJSON {\r\n    if (isInstancesNodeKey(key))\r\n      return { ...key, instanceKeys: key.instanceKeys.map(InstanceKey.toJSON) };\r\n    return { ...key };\r\n  }\r\n\r\n  /** Deserialize node key from JSON */\r\n  export function fromJSON(json: NodeKeyJSON): NodeKey {\r\n    if (isInstancesNodeKey(json))\r\n      return { version: 1, ...json, instanceKeys: json.instanceKeys.map(InstanceKey.fromJSON) };\r\n    return { version: 1, ...json };\r\n  }\r\n\r\n  /** Checks if the supplied key is an [[ECInstancesNodeKey]] */\r\n  export function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey;\r\n  /** Checks if the supplied key is an [[ECInstancesNodeKey]] */\r\n  export function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;\r\n  export function isInstancesNodeKey(key: NodeKey | NodeKeyJSON) {\r\n    return key.type === StandardNodeTypes.ECInstancesNode;\r\n  }\r\n\r\n  /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */\r\n  export function isClassGroupingNodeKey(key: NodeKey): key is ECClassGroupingNodeKey;\r\n  /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */\r\n  export function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;\r\n  export function isClassGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\r\n    return key.type === StandardNodeTypes.ECClassGroupingNode;\r\n  }\r\n\r\n  /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */\r\n  export function isPropertyGroupingNodeKey(key: NodeKey): key is ECPropertyGroupingNodeKey;\r\n  /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */\r\n  export function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;\r\n  export function isPropertyGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\r\n    return key.type === StandardNodeTypes.ECPropertyGroupingNode;\r\n  }\r\n\r\n  /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */\r\n  export function isLabelGroupingNodeKey(key: NodeKey): key is LabelGroupingNodeKey;\r\n  /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */\r\n  export function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;\r\n  export function isLabelGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\r\n    return key.type === StandardNodeTypes.DisplayLabelGroupingNode;\r\n  }\r\n\r\n  /** Checks if the supplied key is a grouping node key */\r\n  export function isGroupingNodeKey(key: NodeKey): key is GroupingNodeKey;\r\n  /** Checks if the supplied key is a grouping node key */\r\n  export function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;\r\n  export function isGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\r\n    return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key);\r\n  }\r\n\r\n  /**\r\n   * Checks if two given node keys are equal, taking their versions into account.\r\n   *\r\n   * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array\r\n   * which is the most accurate way of checking equality. However, when version are different,\r\n   * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.\r\n   * In that case equality is checked using other key attributes, depending on the type of the node (type,\r\n   * label, grouping class, property name, etc.).\r\n   */\r\n  export function equals(lhs: NodeKey, rhs: NodeKey): boolean {\r\n    // types must always be equal\r\n    if (lhs.type !== rhs.type)\r\n      return false;\r\n\r\n    // `pathFromRoot` lengths must always be equal\r\n    if (lhs.pathFromRoot.length !== rhs.pathFromRoot.length)\r\n      return false;\r\n\r\n    // when versions are equal, compare using contents of `pathFromRoot` array\r\n    if (lhs.version === rhs.version) {\r\n      for (let i = 0; i < lhs.pathFromRoot.length; ++i) {\r\n        if (lhs.pathFromRoot[i] !== rhs.pathFromRoot[i])\r\n          return false;\r\n      }\r\n      return true;\r\n    }\r\n\r\n    // when versions aren't equal, compare using other key information, because key hashes\r\n    // of different key versions can't be compared\r\n    if (isInstancesNodeKey(lhs)) {\r\n      assert(isInstancesNodeKey(rhs));\r\n      if (lhs.instanceKeys.length !== rhs.instanceKeys.length)\r\n        return false;\r\n      for (let i = 0; i < lhs.instanceKeys.length; ++i) {\r\n        if (0 !== InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]))\r\n          return false;\r\n      }\r\n      return true;\r\n    }\r\n    if (isClassGroupingNodeKey(lhs)) {\r\n      assert(isClassGroupingNodeKey(rhs));\r\n      return lhs.className === rhs.className;\r\n    }\r\n    if (isPropertyGroupingNodeKey(lhs)) {\r\n      assert(isPropertyGroupingNodeKey(rhs));\r\n      return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;\r\n    }\r\n    if (isLabelGroupingNodeKey(lhs)) {\r\n      assert(isLabelGroupingNodeKey(rhs));\r\n      return lhs.label === rhs.label;\r\n    }\r\n    return true;\r\n  }\r\n}\r\n\r\n/**\r\n * Node key path. Can be used to define path from one node to another.\r\n * @public\r\n */\r\nexport type NodeKeyPath = NodeKey[];\r\n\r\n/**\r\n * Data structure that describes a basic node key\r\n * @public\r\n */\r\nexport interface BaseNodeKey {\r\n  /** Node type */\r\n  type: string;\r\n\r\n  /**\r\n   * Version of the key. Different versions suggest that node keys were created by two different\r\n   * versions of the library. In that case, keys representing the same node may be different.\r\n   */\r\n  version: number;\r\n\r\n  /** Node hash path from root to the node whose key this is */\r\n  pathFromRoot: string[];\r\n}\r\n/**\r\n * Serialized [[BaseNodeKey]] JSON representation.\r\n * @public\r\n */\r\nexport interface BaseNodeKeyJSON {\r\n  type: string;\r\n  version?: number;\r\n  pathFromRoot: string[];\r\n}\r\n\r\n/**\r\n * Data structure that describes a node ECInstance node key\r\n * @public\r\n */\r\nexport interface ECInstancesNodeKey extends BaseNodeKey {\r\n  type: StandardNodeTypes.ECInstancesNode;\r\n  /** List of [[InstanceKey]] objects of ECInstances represented by the node */\r\n  instanceKeys: InstanceKey[];\r\n}\r\n/**\r\n * Serialized [[ECInstancesNodeKey]] JSON representation.\r\n * @public\r\n */\r\nexport interface ECInstancesNodeKeyJSON extends BaseNodeKeyJSON {\r\n  type: StandardNodeTypes.ECInstancesNode;\r\n  instanceKeys: InstanceKeyJSON[];\r\n}\r\n\r\n/**\r\n * Data structure that describes a grouping node key\r\n * @public\r\n */\r\nexport interface GroupingNodeKey extends BaseNodeKey {\r\n  /**\r\n   * Get the number of instances grouped by the node represented\r\n   * by this key.\r\n   *\r\n   * **Note:** this property is just a helper and is not involved\r\n   * in identifying a node.\r\n   */\r\n  groupedInstancesCount: number;\r\n}\r\n/**\r\n * Serialized [[GroupingNodeKey]] JSON representation.\r\n * @public\r\n */\r\nexport interface GroupingNodeKeyJSON extends BaseNodeKeyJSON {\r\n  groupedInstancesCount: number;\r\n}\r\n\r\n/**\r\n * Data structure that describes an ECClass grouping node key\r\n * @public\r\n */\r\nexport interface ECClassGroupingNodeKey extends GroupingNodeKey {\r\n  type: StandardNodeTypes.ECClassGroupingNode;\r\n  /** Full name of the grouping ECClass */\r\n  className: string;\r\n}\r\n/**\r\n * Serialized [[ECClassGroupingNodeKey]] JSON representation.\r\n * @public\r\n */\r\nexport interface ECClassGroupingNodeKeyJSON extends GroupingNodeKeyJSON {\r\n  type: StandardNodeTypes.ECClassGroupingNode;\r\n  className: string;\r\n}\r\n\r\n/**\r\n * Data structure that describes an ECProperty grouping node key\r\n * @public\r\n */\r\nexport interface ECPropertyGroupingNodeKey extends GroupingNodeKey {\r\n  type: StandardNodeTypes.ECPropertyGroupingNode;\r\n  /** Full name of the grouping ECProperty class */\r\n  className: string;\r\n  /** Name of the ECProperty */\r\n  propertyName: string;\r\n  /** Raw grouping values */\r\n  groupingValues: any[];\r\n}\r\n/**\r\n * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.\r\n * @public\r\n */\r\nexport interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKeyJSON {\r\n  type: StandardNodeTypes.ECPropertyGroupingNode;\r\n  className: string;\r\n  propertyName: string;\r\n  groupingValues: any[];\r\n}\r\n\r\n/**\r\n * Data structure that describes a display label grouping node key\r\n * @public\r\n */\r\nexport interface LabelGroupingNodeKey extends GroupingNodeKey {\r\n  type: StandardNodeTypes.DisplayLabelGroupingNode;\r\n  /** Grouping display label */\r\n  label: string;\r\n}\r\n/**\r\n * Serialized [[LabelGroupingNodeKey]] JSON representation.\r\n * @public\r\n */\r\nexport interface LabelGroupingNodeKeyJSON extends GroupingNodeKeyJSON {\r\n  type: StandardNodeTypes.DisplayLabelGroupingNode;\r\n  label: string;\r\n}\r\n\r\n/**\r\n * One of the serialized node key types\r\n * @public\r\n */\r\nexport type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;\r\n"]}
+{"version":3,"file":"Key.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Key.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyD;AACzD,8BAAoC;AAEpC;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wDAAmC,CAAA;IACnC,gEAA2C,CAAA;IAC3C,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;AACvD,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAOD,cAAc;AACd,IAAiB,OAAO,CA0HvB;AA1HD,WAAiB,OAAO;IACtB;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAY;QACjC,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IACpB,CAAC;IAFe,cAAM,SAErB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAiB;QACxC,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;IACjC,CAAC;IAFe,gBAAQ,WAEvB,CAAA;IAOD,mDAAmD;IACnD,SAAgB,kBAAkB,CAAC,GAA0B;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,eAAe,CAAC;IACxD,CAAC;IAFe,0BAAkB,qBAEjC,CAAA;IAOD,mDAAmD;IACnD,SAAgB,sBAAsB,CAAC,GAA0B;QAC/D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,mBAAmB,CAAC;IAC5D,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAOD,mDAAmD;IACnD,SAAgB,yBAAyB,CAAC,GAA0B;QAClE,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,sBAAsB,CAAC;IAC/D,CAAC;IAFe,iCAAyB,4BAExC,CAAA;IAOD,mDAAmD;IACnD,SAAgB,sBAAsB,CAAC,GAA0B;QAC/D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,wBAAwB,CAAC;IACjE,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAOD,mDAAmD;IACnD,SAAgB,iBAAiB,CAAC,GAA0B;QAC1D,OAAO,sBAAsB,CAAC,GAAG,CAAC,IAAI,yBAAyB,CAAC,GAAG,CAAC,IAAI,sBAAsB,CAAC,GAAG,CAAC,CAAC;IACtG,CAAC;IAFe,yBAAiB,oBAEhC,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,MAAM,CAAC,GAAY,EAAE,GAAY;QAC/C,6BAA6B;QAC7B,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI;YACvB,OAAO,KAAK,CAAC;QAEf,8CAA8C;QAC9C,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM;YACrD,OAAO,KAAK,CAAC;QAEf,0EAA0E;QAC1E,IAAI,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAChD,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;oBAC7C,OAAO,KAAK,CAAC;aAChB;YACD,OAAO,IAAI,CAAC;SACb;QAED,sFAAsF;QACtF,8CAA8C;QAC9C,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE;YAC3B,IAAA,qBAAM,EAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YAChC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM;gBACrD,OAAO,KAAK,CAAC;YACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAChD,IAAI,CAAC,KAAK,gBAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;oBACrE,OAAO,KAAK,CAAC;aAChB;YACD,OAAO,IAAI,CAAC;SACb;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC;SACxC;QACD,IAAI,yBAAyB,CAAC,GAAG,CAAC,EAAE;YAClC,IAAA,qBAAM,EAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC;YACvC,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY,CAAC;SACjF;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;SAChC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IA3Ce,cAAM,SA2CrB,CAAA;AACH,CAAC,EA1HgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA0HvB","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 { assert, Id64String } from \"@itwin/core-bentley\";\nimport { InstanceKey } from \"../EC\";\n\n/**\n * Standard node types\n * @public\n */\nexport enum StandardNodeTypes {\n  ECInstancesNode = \"ECInstancesNode\",\n  ECClassGroupingNode = \"ECClassGroupingNode\",\n  ECPropertyGroupingNode = \"ECPropertyGroupingNode\",\n  DisplayLabelGroupingNode = \"DisplayLabelGroupingNode\",\n}\n\n/**\n * One of the node key types\n * @public\n */\nexport type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;\n/** @public */\nexport namespace NodeKey { // eslint-disable-line @typescript-eslint/no-redeclare\n  /**\n   * Serialize given [[NodeKey]] to JSON\n   * @deprecated in 3.x. Use [[NodeKey]].\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  export function toJSON(key: NodeKey): NodeKeyJSON {\n    return { ...key };\n  }\n\n  /**\n   * Deserialize node key from JSON\n   * @deprecated in 3.x. Use [[NodeKey]].\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  export function fromJSON(json: NodeKeyJSON): NodeKey {\n    return { version: 1, ...json };\n  }\n\n  /** Checks if the supplied key is an [[ECInstancesNodeKey]] */\n  export function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey;\n  /** Checks if the supplied key is an [[ECInstancesNodeKey]]. @deprecated in 3.x */\n  // eslint-disable-next-line deprecation/deprecation\n  export function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;\n  // eslint-disable-next-line deprecation/deprecation\n  export function isInstancesNodeKey(key: NodeKey | NodeKeyJSON) {\n    return key.type === StandardNodeTypes.ECInstancesNode;\n  }\n\n  /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */\n  export function isClassGroupingNodeKey(key: NodeKey): key is ECClassGroupingNodeKey;\n  /** Checks if the supplied key is an [[ECClassGroupingNodeKey]]. @deprecated in 3.x */\n  // eslint-disable-next-line deprecation/deprecation\n  export function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;\n  // eslint-disable-next-line deprecation/deprecation\n  export function isClassGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\n    return key.type === StandardNodeTypes.ECClassGroupingNode;\n  }\n\n  /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */\n  export function isPropertyGroupingNodeKey(key: NodeKey): key is ECPropertyGroupingNodeKey;\n  /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]]. @deprecated in 3.x */\n  // eslint-disable-next-line deprecation/deprecation\n  export function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;\n  // eslint-disable-next-line deprecation/deprecation\n  export function isPropertyGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\n    return key.type === StandardNodeTypes.ECPropertyGroupingNode;\n  }\n\n  /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */\n  export function isLabelGroupingNodeKey(key: NodeKey): key is LabelGroupingNodeKey;\n  /** Checks if the supplied key is a [[LabelGroupingNodeKey]]. @deprecated in 3.x */\n  // eslint-disable-next-line deprecation/deprecation\n  export function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;\n  // eslint-disable-next-line deprecation/deprecation\n  export function isLabelGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\n    return key.type === StandardNodeTypes.DisplayLabelGroupingNode;\n  }\n\n  /** Checks if the supplied key is a grouping node key */\n  export function isGroupingNodeKey(key: NodeKey): key is GroupingNodeKey;\n  /** Checks if the supplied key is a grouping node key. @deprecated in 3.x */\n  // eslint-disable-next-line deprecation/deprecation\n  export function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;\n  // eslint-disable-next-line deprecation/deprecation\n  export function isGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\n    return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key);\n  }\n\n  /**\n   * Checks if two given node keys are equal, taking their versions into account.\n   *\n   * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array\n   * which is the most accurate way of checking equality. However, when version are different,\n   * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.\n   * In that case equality is checked using other key attributes, depending on the type of the node (type,\n   * label, grouping class, property name, etc.).\n   */\n  export function equals(lhs: NodeKey, rhs: NodeKey): boolean {\n    // types must always be equal\n    if (lhs.type !== rhs.type)\n      return false;\n\n    // `pathFromRoot` lengths must always be equal\n    if (lhs.pathFromRoot.length !== rhs.pathFromRoot.length)\n      return false;\n\n    // when versions are equal, compare using contents of `pathFromRoot` array\n    if (lhs.version === rhs.version) {\n      for (let i = 0; i < lhs.pathFromRoot.length; ++i) {\n        if (lhs.pathFromRoot[i] !== rhs.pathFromRoot[i])\n          return false;\n      }\n      return true;\n    }\n\n    // when versions aren't equal, compare using other key information, because key hashes\n    // of different key versions can't be compared\n    if (isInstancesNodeKey(lhs)) {\n      assert(isInstancesNodeKey(rhs));\n      if (lhs.instanceKeys.length !== rhs.instanceKeys.length)\n        return false;\n      for (let i = 0; i < lhs.instanceKeys.length; ++i) {\n        if (0 !== InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]))\n          return false;\n      }\n      return true;\n    }\n    if (isClassGroupingNodeKey(lhs)) {\n      assert(isClassGroupingNodeKey(rhs));\n      return lhs.className === rhs.className;\n    }\n    if (isPropertyGroupingNodeKey(lhs)) {\n      assert(isPropertyGroupingNodeKey(rhs));\n      return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;\n    }\n    if (isLabelGroupingNodeKey(lhs)) {\n      assert(isLabelGroupingNodeKey(rhs));\n      return lhs.label === rhs.label;\n    }\n    return true;\n  }\n}\n\n/**\n * Node key path. Can be used to define path from one node to another.\n * @public\n */\nexport type NodeKeyPath = NodeKey[];\n\n/**\n * Data structure that describes a basic node key\n * @public\n */\nexport interface BaseNodeKey {\n  /** Node type */\n  type: string;\n\n  /**\n   * Version of the key. Different versions suggest that node keys were created by two different\n   * versions of the library. In that case, keys representing the same node may be different.\n   */\n  version: number;\n\n  /** Node hash path from root to the node whose key this is */\n  pathFromRoot: string[];\n\n  /** Query that returns all selected instance keys\n   * @alpha\n   */\n  instanceKeysSelectQuery?: PresentationQuery;\n}\n/**\n * Serialized [[BaseNodeKey]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[BaseNodeKey]].\n */\nexport interface BaseNodeKeyJSON {\n  type: string;\n  // TODO: make this required\n  version?: number;\n  pathFromRoot: string[];\n  /** @alpha */\n  instanceKeysSelectQuery?: PresentationQuery;\n}\n\n/**\n * Data structure that describes a node ECInstance node key\n * @public\n */\nexport interface ECInstancesNodeKey extends BaseNodeKey {\n  type: StandardNodeTypes.ECInstancesNode;\n  /** List of [[InstanceKey]] objects of ECInstances represented by the node */\n  instanceKeys: InstanceKey[];\n}\n/**\n * Serialized [[ECInstancesNodeKey]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[ECInstancesNodeKey]].\n */\nexport interface ECInstancesNodeKeyJSON extends BaseNodeKey {\n  type: StandardNodeTypes.ECInstancesNode;\n  instanceKeys: InstanceKey[];\n}\n\n/**\n * Data structure that describes a grouping node key\n * @public\n */\nexport interface GroupingNodeKey extends BaseNodeKey {\n  /**\n   * Get the number of instances grouped by the node represented\n   * by this key.\n   *\n   * **Note:** this property is just a helper and is not involved\n   * in identifying a node.\n   */\n  groupedInstancesCount: number;\n}\n/**\n * Serialized [[GroupingNodeKey]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[GroupingNodeKey]].\n */\nexport interface GroupingNodeKeyJSON extends BaseNodeKey {\n  groupedInstancesCount: number;\n}\n\n/**\n * Data structure that describes an ECClass grouping node key\n * @public\n */\nexport interface ECClassGroupingNodeKey extends GroupingNodeKey {\n  type: StandardNodeTypes.ECClassGroupingNode;\n  /** Full name of the grouping ECClass */\n  className: string;\n}\n/**\n * Serialized [[ECClassGroupingNodeKey]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[ECClassGroupingNodeKey]].\n */\nexport interface ECClassGroupingNodeKeyJSON extends GroupingNodeKey {\n  type: StandardNodeTypes.ECClassGroupingNode;\n  className: string;\n}\n\n/**\n * Data structure that describes an ECProperty grouping node key\n * @public\n */\nexport interface ECPropertyGroupingNodeKey extends GroupingNodeKey {\n  type: StandardNodeTypes.ECPropertyGroupingNode;\n  /** Full name of the grouping ECProperty class */\n  className: string;\n  /** Name of the ECProperty */\n  propertyName: string;\n  /** Raw grouping values */\n  groupingValues: any[];\n}\n/**\n * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[ECPropertyGroupingNodeKey]].\n */\nexport interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKey {\n  type: StandardNodeTypes.ECPropertyGroupingNode;\n  className: string;\n  propertyName: string;\n  groupingValues: any[];\n}\n\n/**\n * Data structure that describes a display label grouping node key\n * @public\n */\nexport interface LabelGroupingNodeKey extends GroupingNodeKey {\n  type: StandardNodeTypes.DisplayLabelGroupingNode;\n  /** Grouping display label */\n  label: string;\n}\n/**\n * Serialized [[LabelGroupingNodeKey]] JSON representation.\n * @public\n * @deprecated in 3.x. Use [[LabelGroupingNodeKey]].\n */\nexport interface LabelGroupingNodeKeyJSON extends GroupingNodeKey {\n  type: StandardNodeTypes.DisplayLabelGroupingNode;\n  label: string;\n}\n\n/**\n * One of the serialized node key types\n * @public\n * @deprecated in 3.x. Use [[NodeKey]].\n */\n// eslint-disable-next-line deprecation/deprecation\nexport type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;\n\n/**\n * Data structure that describes a presentation query\n * @alpha\n */\nexport interface PresentationQuery {\n  /** ECSQL query */\n  query: string;\n  /** The query bindings */\n  bindings?: PresentationQueryBinding[];\n}\n\n/** @alpha */\nexport interface BasePresentationQueryBinding {\n  type: \"Id\" | \"IdSet\" | \"ECValue\" | \"ValueSet\";\n}\n\n/** @alpha */\nexport interface IdBinding extends BasePresentationQueryBinding {\n  type: \"Id\";\n  value: Id64String;\n}\n\n/** @alpha */\nexport interface IdSetBinding extends BasePresentationQueryBinding {\n  type: \"IdSet\";\n  value: Id64String[];\n}\n\n/** @alpha */\nexport interface ECValueBinding extends BasePresentationQueryBinding {\n  type: \"ECValue\";\n  valueType: string;\n  value: any;\n}\n\n/** @alpha */\nexport interface ECValueSetBinding extends BasePresentationQueryBinding {\n  type: \"ValueSet\";\n  valueType: string;\n  value: any[];\n}\n\n/**\n * One of the presentation query binding types\n * @alpha\n */\nexport type PresentationQueryBinding = IdBinding | IdSetBinding | ECValueBinding | ECValueSetBinding;\n"]}

package/lib/cjs/presentation-common/hierarchy/Node.d.ts

@@ -1,142 +1,155 @@
-/** @packageDocumentation
- * @module Hierarchies
- */
-import { LabelDefinition, LabelDefinitionJSON } from "../LabelDefinition";
-import { NodeKey, NodeKeyJSON } from "./Key";
-/**
- * Data structure that describes a tree node.
- * @public
- */
-export interface Node {
-    /** A key that uniquely identifies a node. */
-    key: NodeKey;
-    /** Definition of node display label */
-    label: LabelDefinition;
-    /** Extensive description */
-    description?: string;
-    /**
-     * Image ID
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    imageId?: string;
-    /**
-     * Foreground color
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    foreColor?: string;
-    /**
-     * Background color
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    backColor?: string;
-    /**
-     * Font style
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    fontStyle?: string;
-    /** Does this node have child nodes */
-    hasChildren?: boolean;
-    /** Is this node selectable */
-    isSelectionDisabled?: boolean;
-    /** Is this node editable */
-    isEditable?: boolean;
-    /** Is this node expanded */
-    isExpanded?: boolean;
-    /**
-     * Is checkbox visible for this node
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    isCheckboxVisible?: boolean;
-    /**
-     * Is this node's checkbox checked
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    isChecked?: boolean;
-    /**
-     * Is this node's checkbox enabled
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    isCheckboxEnabled?: boolean;
-    /** Extended data injected into this node */
-    extendedData?: {
-        [key: string]: any;
-    };
-}
-/**
- * Serialized [[Node]] JSON representation.
- * @public
- */
-export interface NodeJSON {
-    key: NodeKeyJSON;
-    labelDefinition: LabelDefinitionJSON;
-    description?: string;
-    /** @deprecated */
-    imageId?: string;
-    /** @deprecated */
-    foreColor?: string;
-    /** @deprecated */
-    backColor?: string;
-    /** @deprecated */
-    fontStyle?: string;
-    hasChildren?: boolean;
-    isSelectionDisabled?: boolean;
-    isEditable?: boolean;
-    isExpanded?: boolean;
-    /** @deprecated */
-    isCheckboxVisible?: boolean;
-    /** @deprecated */
-    isChecked?: boolean;
-    /** @deprecated */
-    isCheckboxEnabled?: boolean;
-    extendedData?: {
-        [key: string]: any;
-    };
-}
-/**
- * Partial node definition.
- * @public
- */
-export declare type PartialNode = AllOrNone<Partial<Node>, "key" | "label">;
-/**
- * Serialized [[PartialNode]] JSON representation.
- * @public
- */
-export declare type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, "key" | "labelDefinition">;
-declare type AllOrNone<T, P extends keyof T> = Omit<T, P> & ({
-    [K in P]?: never;
-} | Required<Pick<T, P>>);
-/** @public */
-export declare namespace Node {
-    /** Serialize given [[Node]] to JSON */
-    function toJSON(node: Node): NodeJSON;
-    /** @internal */
-    function toPartialJSON(node: PartialNode): PartialNodeJSON;
-    /** Deserialize [[Node]] from JSON */
-    function fromJSON(json: NodeJSON | string): Node;
-    /** @internal */
-    function fromPartialJSON(json: PartialNodeJSON): PartialNode;
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[Node]] objects.
-     *
-     * @internal
-     */
-    function reviver(key: string, value: any): any;
-    /**
-     * Deserialize nodes list from JSON
-     * @param json JSON or JSON serialized to string to deserialize from
-     * @returns Deserialized nodes list
-     *
-     * @internal
-     */
-    function listFromJSON(json: NodeJSON[] | string): Node[];
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[Node]][] objects.
-     *
-     * @internal
-     */
-    function listReviver(key: string, value: any): any;
-}
-export {};
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+import { LabelDefinition, LabelDefinitionJSON } from "../LabelDefinition";
+import { NodeKey, NodeKeyJSON } from "./Key";
+/**
+ * Data structure that describes a tree node.
+ * @public
+ */
+export interface Node {
+    /** A key that uniquely identifies a node. */
+    key: NodeKey;
+    /** Definition of node display label */
+    label: LabelDefinition;
+    /** Extensive description */
+    description?: string;
+    /**
+     * Image ID
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    imageId?: string;
+    /**
+     * Foreground color
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    foreColor?: string;
+    /**
+     * Background color
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    backColor?: string;
+    /**
+     * Font style
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    fontStyle?: string;
+    /** Does this node have child nodes */
+    hasChildren?: boolean;
+    /** Is this node selectable */
+    isSelectionDisabled?: boolean;
+    /** Is this node editable */
+    isEditable?: boolean;
+    /** Is this node expanded */
+    isExpanded?: boolean;
+    /**
+     * Is checkbox visible for this node
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    isCheckboxVisible?: boolean;
+    /**
+     * Is this node's checkbox checked
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    isChecked?: boolean;
+    /**
+     * Is this node's checkbox enabled
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    isCheckboxEnabled?: boolean;
+    /**
+     * Identifies whether the hierarchy level below this node 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.
+     * @beta
+     */
+    supportsFiltering?: boolean;
+    /** Extended data injected into this node */
+    extendedData?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Serialized [[Node]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[Node]].
+ */
+export interface NodeJSON {
+    key: NodeKeyJSON;
+    labelDefinition: LabelDefinitionJSON;
+    description?: string;
+    /** @deprecated in 3.x. */
+    imageId?: string;
+    /** @deprecated in 3.x. */
+    foreColor?: string;
+    /** @deprecated in 3.x. */
+    backColor?: string;
+    /** @deprecated in 3.x. */
+    fontStyle?: string;
+    hasChildren?: boolean;
+    isSelectionDisabled?: boolean;
+    isEditable?: boolean;
+    isExpanded?: boolean;
+    /** @deprecated in 3.x. */
+    isCheckboxVisible?: boolean;
+    /** @deprecated in 3.x. */
+    isChecked?: boolean;
+    /** @deprecated in 3.x. */
+    isCheckboxEnabled?: boolean;
+    /** @beta */
+    supportsFiltering?: boolean;
+    extendedData?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Partial node definition.
+ * @public
+ */
+export declare type PartialNode = AllOrNone<Partial<Node>, "key" | "label">;
+/**
+ * Serialized [[PartialNode]] JSON representation.
+ * @public
+ * @deprecated in 3.x. Use [[PartialNode]].
+ */
+export declare type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, "key" | "labelDefinition">;
+declare type AllOrNone<T, P extends keyof T> = Omit<T, P> & ({
+    [K in P]?: never;
+} | Required<Pick<T, P>>);
+/** @public */
+export declare namespace Node {
+    /**
+     * Serialize given [[Node]] to JSON
+     * @deprecated in 3.x. Use [[Node]].
+     */
+    function toJSON(node: Node): NodeJSON;
+    /** @internal */
+    function toPartialJSON(node: PartialNode): PartialNodeJSON;
+    /**
+     * Deserialize [[Node]] from JSON
+     * @deprecated in 3.x. Use [[Node]].
+     */
+    function fromJSON(json: NodeJSON | string): Node;
+    /** @internal */
+    function fromPartialJSON(json: PartialNodeJSON): PartialNode;
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[Node]] objects.
+     * @internal
+     */
+    function reviver(key: string, value: any): any;
+    /**
+     * Deserialize nodes list from JSON
+     * @param json JSON or JSON serialized to string to deserialize from
+     * @returns Deserialized nodes list
+     * @internal
+     */
+    function listFromJSON(json: NodeJSON[] | string): Node[];
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[Node]][] objects.
+     * @internal
+     */
+    function listReviver(key: string, value: any): any;
+}
+export {};
 //# sourceMappingURL=Node.d.ts.map

package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Node.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,6CAA6C;IAC7C,GAAG,EAAE,OAAO,CAAC;IACb,uCAAuC;IACvC,KAAK,EAAE,eAAe,CAAC;IACvB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8BAA8B;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,4CAA4C;IAC5C,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,WAAW,CAAC;IACjB,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kBAAkB;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kBAAkB;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kBAAkB;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;AAEpE;;;GAGG;AACH,oBAAY,eAAe,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,iBAAiB,CAAC,CAAC;AAEtF,aAAK,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK;CAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAElG,cAAc;AACd,yBAAiB,IAAI,CAAC;IACpB,uCAAuC;IACvC,SAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,CAO3C;IAED,gBAAgB;IAChB,SAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,eAAe,CAWhE;IAED,qCAAqC;IACrC,SAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAStD;IAED,gBAAgB;IAChB,SAAgB,eAAe,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW,CAWlE;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAEpD;IAED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,IAAI,EAAE,CAI9D;IAED;;;;;OAKG;IACH,SAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAExD;CACF"}
+{"version":3,"file":"Node.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,6CAA6C;IAC7C,GAAG,EAAE,OAAO,CAAC;IACb,uCAAuC;IACvC,KAAK,EAAE,eAAe,CAAC;IACvB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8BAA8B;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,4CAA4C;IAC5C,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IAEvB,GAAG,EAAE,WAAW,CAAC;IAGjB,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,0BAA0B;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,0BAA0B;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY;IACZ,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,oBAAY,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;AAEpE;;;;GAIG;AAEH,oBAAY,eAAe,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,iBAAiB,CAAC,CAAC;AAEtF,aAAK,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK;CAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAElG,cAAc;AACd,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IAEH,SAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,CAM3C;IAED,gBAAgB;IAEhB,SAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,eAAe,CAUhE;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAUtD;IAED,gBAAgB;IAEhB,SAAgB,eAAe,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW,CAYlE;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAGpD;IAED;;;;;OAKG;IAEH,SAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,IAAI,EAAE,CAK9D;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAExD;CACF"}