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

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

@@ -1,7 +1,8 @@
 /** @packageDocumentation
  * @module Hierarchies
  */
-import { InstanceKey, InstanceKeyJSON } from "../EC";
+import { Id64String } from "@itwin/core-bentley";
+import { InstanceKey } from "../EC";
 /**
  * Standard node types
  * @public
@@ -19,29 +20,35 @@ export declare enum StandardNodeTypes {
 export declare type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;
 /** @public */
 export declare namespace NodeKey {
-    /** Serialize given [[NodeKey]] to JSON */
+    /**
+     * Serialize given [[NodeKey]] to JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
     function toJSON(key: NodeKey): NodeKeyJSON;
-    /** Deserialize node key from JSON */
+    /**
+     * 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]] */
+    /** Checks if the supplied key is an [[ECInstancesNodeKey]]. @deprecated in 3.x */
     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]] */
+    /** Checks if the supplied key is an [[ECClassGroupingNodeKey]]. @deprecated in 3.x */
     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]] */
+    /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]]. @deprecated in 3.x */
     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]] */
+    /** Checks if the supplied key is a [[LabelGroupingNodeKey]]. @deprecated in 3.x */
     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 */
+    /** Checks if the supplied key is a grouping node key. @deprecated in 3.x */
     function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;
     /**
      * Checks if two given node keys are equal, taking their versions into account.
@@ -73,15 +80,22 @@ export interface BaseNodeKey {
     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
@@ -95,10 +109,11 @@ export interface ECInstancesNodeKey extends BaseNodeKey {
 /**
  * Serialized [[ECInstancesNodeKey]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[ECInstancesNodeKey]].
  */
-export interface ECInstancesNodeKeyJSON extends BaseNodeKeyJSON {
+export interface ECInstancesNodeKeyJSON extends BaseNodeKey {
     type: StandardNodeTypes.ECInstancesNode;
-    instanceKeys: InstanceKeyJSON[];
+    instanceKeys: InstanceKey[];
 }
 /**
  * Data structure that describes a grouping node key
@@ -117,8 +132,9 @@ export interface GroupingNodeKey extends BaseNodeKey {
 /**
  * Serialized [[GroupingNodeKey]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[GroupingNodeKey]].
  */
-export interface GroupingNodeKeyJSON extends BaseNodeKeyJSON {
+export interface GroupingNodeKeyJSON extends BaseNodeKey {
     groupedInstancesCount: number;
 }
 /**
@@ -133,8 +149,9 @@ export interface ECClassGroupingNodeKey extends GroupingNodeKey {
 /**
  * Serialized [[ECClassGroupingNodeKey]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[ECClassGroupingNodeKey]].
  */
-export interface ECClassGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
+export interface ECClassGroupingNodeKeyJSON extends GroupingNodeKey {
     type: StandardNodeTypes.ECClassGroupingNode;
     className: string;
 }
@@ -154,8 +171,9 @@ export interface ECPropertyGroupingNodeKey extends GroupingNodeKey {
 /**
  * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[ECPropertyGroupingNodeKey]].
  */
-export interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
+export interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKey {
     type: StandardNodeTypes.ECPropertyGroupingNode;
     className: string;
     propertyName: string;
@@ -173,14 +191,57 @@ export interface LabelGroupingNodeKey extends GroupingNodeKey {
 /**
  * Serialized [[LabelGroupingNodeKey]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[LabelGroupingNodeKey]].
  */
-export interface LabelGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
+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

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

@@ -1 +1 @@
-{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Key.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAErD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;IAC3C,sBAAsB,2BAA2B;IACjD,wBAAwB,6BAA6B;CACtD;AAED;;;GAGG;AACH,oBAAY,OAAO,GAAG,WAAW,GAAG,kBAAkB,GAAG,sBAAsB,GAAG,yBAAyB,GAAG,oBAAoB,CAAC;AACnI,cAAc;AACd,yBAAiB,OAAO,CAAC;IACvB,0CAA0C;IAC1C,SAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,WAAW,CAIhD;IAED,qCAAqC;IACrC,SAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAInD;IAED,8DAA8D;IAC9D,SAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,kBAAkB,CAAC;IAC5E,8DAA8D;IAC9D,SAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,sBAAsB,CAAC;IAKpF,kEAAkE;IAClE,SAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAAC;IACpF,kEAAkE;IAClE,SAAgB,sBAAsB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,0BAA0B,CAAC;IAK5F,qEAAqE;IACrE,SAAgB,yBAAyB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,yBAAyB,CAAC;IAC1F,qEAAqE;IACrE,SAAgB,yBAAyB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,6BAA6B,CAAC;IAKlG,+DAA+D;IAC/D,SAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAAC;IAClF,+DAA+D;IAC/D,SAAgB,sBAAsB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,wBAAwB,CAAC;IAK1F,wDAAwD;IACxD,SAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,eAAe,CAAC;IACxE,wDAAwD;IACxD,SAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,mBAAmB,CAAC;IAKhF;;;;;;;;OAQG;IACH,SAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CA2C1D;CACF;AAED;;;GAGG;AACH,oBAAY,WAAW,GAAG,OAAO,EAAE,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AACD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,IAAI,EAAE,iBAAiB,CAAC,eAAe,CAAC;IACxC,6EAA6E;IAC7E,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AACD;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,IAAI,EAAE,iBAAiB,CAAC,eAAe,CAAC;IACxC,YAAY,EAAE,eAAe,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD;;;;;;OAMG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AACD;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC;IAC5C,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;CACnB;AACD;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACrE,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE,IAAI,EAAE,iBAAiB,CAAC,sBAAsB,CAAC;IAC/C,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,cAAc,EAAE,GAAG,EAAE,CAAC;CACvB;AACD;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE,IAAI,EAAE,iBAAiB,CAAC,sBAAsB,CAAC;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,GAAG,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,iBAAiB,CAAC,wBAAwB,CAAC;IACjD,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf;AACD;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,IAAI,EAAE,iBAAiB,CAAC,wBAAwB,CAAC;IACjD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,oBAAY,WAAW,GAAG,eAAe,GAAG,sBAAsB,GAAG,0BAA0B,GAAG,6BAA6B,GAAG,wBAAwB,CAAC"}
+{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Key.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAEpC;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;IAC3C,sBAAsB,2BAA2B;IACjD,wBAAwB,6BAA6B;CACtD;AAED;;;GAGG;AACH,oBAAY,OAAO,GAAG,WAAW,GAAG,kBAAkB,GAAG,sBAAsB,GAAG,yBAAyB,GAAG,oBAAoB,CAAC;AACnI,cAAc;AACd,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IAEH,SAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,WAAW,CAEhD;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAEnD;IAED,8DAA8D;IAC9D,SAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,kBAAkB,CAAC;IAC5E,kFAAkF;IAElF,SAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,sBAAsB,CAAC;IAMpF,kEAAkE;IAClE,SAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAAC;IACpF,sFAAsF;IAEtF,SAAgB,sBAAsB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,0BAA0B,CAAC;IAM5F,qEAAqE;IACrE,SAAgB,yBAAyB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,yBAAyB,CAAC;IAC1F,yFAAyF;IAEzF,SAAgB,yBAAyB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,6BAA6B,CAAC;IAMlG,+DAA+D;IAC/D,SAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAAC;IAClF,mFAAmF;IAEnF,SAAgB,sBAAsB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,wBAAwB,CAAC;IAM1F,wDAAwD;IACxD,SAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,eAAe,CAAC;IACxE,4EAA4E;IAE5E,SAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,mBAAmB,CAAC;IAMhF;;;;;;;;OAQG;IACH,SAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CA2C1D;CACF;AAED;;;GAGG;AACH,oBAAY,WAAW,GAAG,OAAO,EAAE,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;CAC7C;AACD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,aAAa;IACb,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,IAAI,EAAE,iBAAiB,CAAC,eAAe,CAAC;IACxC,6EAA6E;IAC7E,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AACD;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,IAAI,EAAE,iBAAiB,CAAC,eAAe,CAAC;IACxC,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD;;;;;;OAMG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AACD;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC;IAC5C,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;CACnB;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA2B,SAAQ,eAAe;IACjE,IAAI,EAAE,iBAAiB,CAAC,mBAAmB,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAChE,IAAI,EAAE,iBAAiB,CAAC,sBAAsB,CAAC;IAC/C,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,0BAA0B;IAC1B,cAAc,EAAE,GAAG,EAAE,CAAC;CACvB;AACD;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,eAAe;IACpE,IAAI,EAAE,iBAAiB,CAAC,sBAAsB,CAAC;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,GAAG,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,iBAAiB,CAAC,wBAAwB,CAAC;IACjD,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf;AACD;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D,IAAI,EAAE,iBAAiB,CAAC,wBAAwB,CAAC;IACjD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AAEH,oBAAY,WAAW,GAAG,eAAe,GAAG,sBAAsB,GAAG,0BAA0B,GAAG,6BAA6B,GAAG,wBAAwB,CAAC;AAE3J;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,QAAQ,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACvC;AAED,aAAa;AACb,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,IAAI,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;CAC/C;AAED,aAAa;AACb,MAAM,WAAW,SAAU,SAAQ,4BAA4B;IAC7D,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,aAAa;AACb,MAAM,WAAW,YAAa,SAAQ,4BAA4B;IAChE,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED,aAAa;AACb,MAAM,WAAW,cAAe,SAAQ,4BAA4B;IAClE,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,GAAG,CAAC;CACZ;AAED,aAAa;AACb,MAAM,WAAW,iBAAkB,SAAQ,4BAA4B;IACrE,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,GAAG,EAAE,CAAC;CACd;AAED;;;GAGG;AACH,oBAAY,wBAAwB,GAAG,SAAS,GAAG,YAAY,GAAG,cAAc,GAAG,iBAAiB,CAAC"}

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

@@ -21,36 +21,45 @@ export var StandardNodeTypes;
 /** @public */
 export var NodeKey;
 (function (NodeKey) {
-    /** Serialize given [[NodeKey]] to JSON */
+    /**
+     * Serialize given [[NodeKey]] to JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function toJSON(key) {
-        if (isInstancesNodeKey(key))
-            return { ...key, instanceKeys: key.instanceKeys.map(InstanceKey.toJSON) };
         return { ...key };
     }
     NodeKey.toJSON = toJSON;
-    /** Deserialize node key from JSON */
+    /**
+     * Deserialize node key from JSON
+     * @deprecated in 3.x. Use [[NodeKey]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function fromJSON(json) {
-        if (isInstancesNodeKey(json))
-            return { version: 1, ...json, instanceKeys: json.instanceKeys.map(InstanceKey.fromJSON) };
         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);
     }

package/lib/esm/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,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAmB,MAAM,OAAO,CAAC;AAErD;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wDAAmC,CAAA;IACnC,gEAA2C,CAAA;IAC3C,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;AACvD,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAOD,cAAc;AACd,MAAM,KAAW,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,WAAW,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,WAAW,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,MAAM,CAAC,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,WAAW,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,MAAM,CAAC,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,MAAM,CAAC,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,MAAM,CAAC,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,KAAP,OAAO,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,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAEpC;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wDAAmC,CAAA;IACnC,gEAA2C,CAAA;IAC3C,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;AACvD,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAOD,cAAc;AACd,MAAM,KAAW,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,MAAM,CAAC,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,WAAW,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,MAAM,CAAC,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,MAAM,CAAC,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,MAAM,CAAC,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,KAAP,OAAO,QA0HvB","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, Id64String } from \"@itwin/core-bentley\";\r\nimport { InstanceKey } 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  /**\r\n   * Serialize given [[NodeKey]] to JSON\r\n   * @deprecated in 3.x. Use [[NodeKey]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(key: NodeKey): NodeKeyJSON {\r\n    return { ...key };\r\n  }\r\n\r\n  /**\r\n   * Deserialize node key from JSON\r\n   * @deprecated in 3.x. Use [[NodeKey]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: NodeKeyJSON): NodeKey {\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]]. @deprecated in 3.x */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;\r\n  // eslint-disable-next-line deprecation/deprecation\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]]. @deprecated in 3.x */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;\r\n  // eslint-disable-next-line deprecation/deprecation\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]]. @deprecated in 3.x */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;\r\n  // eslint-disable-next-line deprecation/deprecation\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]]. @deprecated in 3.x */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;\r\n  // eslint-disable-next-line deprecation/deprecation\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. @deprecated in 3.x */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;\r\n  // eslint-disable-next-line deprecation/deprecation\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  /** Query that returns all selected instance keys\r\n   * @alpha\r\n   */\r\n  instanceKeysSelectQuery?: PresentationQuery;\r\n}\r\n/**\r\n * Serialized [[BaseNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[BaseNodeKey]].\r\n */\r\nexport interface BaseNodeKeyJSON {\r\n  type: string;\r\n  // TODO: make this required\r\n  version?: number;\r\n  pathFromRoot: string[];\r\n  /** @alpha */\r\n  instanceKeysSelectQuery?: PresentationQuery;\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 * @deprecated in 3.x. Use [[ECInstancesNodeKey]].\r\n */\r\nexport interface ECInstancesNodeKeyJSON extends BaseNodeKey {\r\n  type: StandardNodeTypes.ECInstancesNode;\r\n  instanceKeys: InstanceKey[];\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 * @deprecated in 3.x. Use [[GroupingNodeKey]].\r\n */\r\nexport interface GroupingNodeKeyJSON extends BaseNodeKey {\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 * @deprecated in 3.x. Use [[ECClassGroupingNodeKey]].\r\n */\r\nexport interface ECClassGroupingNodeKeyJSON extends GroupingNodeKey {\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 * @deprecated in 3.x. Use [[ECPropertyGroupingNodeKey]].\r\n */\r\nexport interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKey {\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 * @deprecated in 3.x. Use [[LabelGroupingNodeKey]].\r\n */\r\nexport interface LabelGroupingNodeKeyJSON extends GroupingNodeKey {\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 * @deprecated in 3.x. Use [[NodeKey]].\r\n */\r\n// eslint-disable-next-line deprecation/deprecation\r\nexport type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;\r\n\r\n/**\r\n * Data structure that describes a presentation query\r\n * @alpha\r\n */\r\nexport interface PresentationQuery {\r\n  /** ECSQL query */\r\n  query: string;\r\n  /** The query bindings */\r\n  bindings?: PresentationQueryBinding[];\r\n}\r\n\r\n/** @alpha */\r\nexport interface BasePresentationQueryBinding {\r\n  type: \"Id\" | \"IdSet\" | \"ECValue\" | \"ValueSet\";\r\n}\r\n\r\n/** @alpha */\r\nexport interface IdBinding extends BasePresentationQueryBinding {\r\n  type: \"Id\";\r\n  value: Id64String;\r\n}\r\n\r\n/** @alpha */\r\nexport interface IdSetBinding extends BasePresentationQueryBinding {\r\n  type: \"IdSet\";\r\n  value: Id64String[];\r\n}\r\n\r\n/** @alpha */\r\nexport interface ECValueBinding extends BasePresentationQueryBinding {\r\n  type: \"ECValue\";\r\n  valueType: string;\r\n  value: any;\r\n}\r\n\r\n/** @alpha */\r\nexport interface ECValueSetBinding extends BasePresentationQueryBinding {\r\n  type: \"ValueSet\";\r\n  valueType: string;\r\n  value: any[];\r\n}\r\n\r\n/**\r\n * One of the presentation query binding types\r\n * @alpha\r\n */\r\nexport type PresentationQueryBinding = IdBinding | IdSetBinding | ECValueBinding | ECValueSetBinding;\r\n"]}

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

@@ -16,22 +16,22 @@ export interface Node {
     description?: string;
     /**
      * Image ID
-     * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @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 Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @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 Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @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 Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @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 */
@@ -44,19 +44,25 @@ export interface Node {
     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.
+     * @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 Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @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 Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @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;
@@ -65,29 +71,32 @@ export interface Node {
 /**
  * Serialized [[Node]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[Node]].
  */
 export interface NodeJSON {
     key: NodeKeyJSON;
     labelDefinition: LabelDefinitionJSON;
     description?: string;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     imageId?: string;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     foreColor?: string;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     backColor?: string;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     fontStyle?: string;
     hasChildren?: boolean;
     isSelectionDisabled?: boolean;
     isEditable?: boolean;
     isExpanded?: boolean;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     isCheckboxVisible?: boolean;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     isChecked?: boolean;
-    /** @deprecated */
+    /** @deprecated in 3.x. */
     isCheckboxEnabled?: boolean;
+    /** @beta */
+    supportsFiltering?: boolean;
     extendedData?: {
         [key: string]: any;
     };
@@ -100,6 +109,7 @@ 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> & ({
@@ -107,18 +117,23 @@ declare type AllOrNone<T, P extends keyof T> = Omit<T, P> & ({
 } | Required<Pick<T, P>>);
 /** @public */
 export declare namespace Node {
-    /** Serialize given [[Node]] to JSON */
+    /**
+     * 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 */
+    /**
+     * 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;
@@ -126,14 +141,12 @@ export declare namespace Node {
      * 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;

package/lib/esm/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"}

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

@@ -5,47 +5,55 @@
 /** @packageDocumentation
  * @module Hierarchies
  */
-import { LabelDefinition } from "../LabelDefinition";
 import { NodeKey } from "./Key";
 /** @public */
 export var Node;
 (function (Node) {
-    /** Serialize given [[Node]] to JSON */
+    /**
+     * Serialize given [[Node]] to JSON
+     * @deprecated in 3.x. Use [[Node]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function toJSON(node) {
-        const { key, label, ...baseNode } = node;
+        const { label, ...baseNode } = node;
         return {
             ...baseNode,
-            key: NodeKey.toJSON(key),
-            labelDefinition: LabelDefinition.toJSON(label),
+            labelDefinition: label,
         };
     }
     Node.toJSON = toJSON;
     /** @internal */
+    // eslint-disable-next-line deprecation/deprecation
     function toPartialJSON(node) {
         if (node.key === undefined) {
             return node;
         }
-        const { key, label, ...baseNode } = node;
+        const { label, ...baseNode } = node;
         return {
             ...baseNode,
-            key: NodeKey.toJSON(key),
-            labelDefinition: LabelDefinition.toJSON(label),
+            labelDefinition: label,
         };
     }
     Node.toPartialJSON = toPartialJSON;
-    /** Deserialize [[Node]] from JSON */
+    /**
+     * Deserialize [[Node]] from JSON
+     * @deprecated in 3.x. Use [[Node]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function fromJSON(json) {
         if (typeof json === "string")
             return JSON.parse(json, reviver);
         const { labelDefinition, ...baseJson } = json;
         return {
             ...baseJson,
+            // eslint-disable-next-line deprecation/deprecation
             key: NodeKey.fromJSON(json.key),
-            label: LabelDefinition.fromJSON(labelDefinition),
+            label: labelDefinition,
         };
     }
     Node.fromJSON = fromJSON;
     /** @internal */
+    // eslint-disable-next-line deprecation/deprecation
     function fromPartialJSON(json) {
         if (json.key === undefined) {
             return json;
@@ -53,18 +61,19 @@ export var Node;
         const { key, labelDefinition, ...baseJson } = json;
         return {
             ...baseJson,
+            // eslint-disable-next-line deprecation/deprecation
             key: NodeKey.fromJSON(key),
-            label: LabelDefinition.fromJSON(labelDefinition),
+            label: labelDefinition,
         };
     }
     Node.fromPartialJSON = fromPartialJSON;
     /**
      * Reviver function that can be used as a second argument for
      * `JSON.parse` method when parsing [[Node]] objects.
-     *
      * @internal
      */
     function reviver(key, value) {
+        // eslint-disable-next-line deprecation/deprecation
         return key === "" ? fromJSON(value) : value;
     }
     Node.reviver = reviver;
@@ -72,19 +81,19 @@ export var Node;
      * Deserialize nodes list from JSON
      * @param json JSON or JSON serialized to string to deserialize from
      * @returns Deserialized nodes list
-     *
      * @internal
      */
+    // eslint-disable-next-line deprecation/deprecation
     function listFromJSON(json) {
         if (typeof json === "string")
             return JSON.parse(json, listReviver);
+        // eslint-disable-next-line deprecation/deprecation
         return json.map((m) => fromJSON(m));
     }
     Node.listFromJSON = listFromJSON;
     /**
      * Reviver function that can be used as a second argument for
      * `JSON.parse` method when parsing [[Node]][] objects.
-     *
      * @internal
      */
     function listReviver(key, value) {