@itwin/presentation-common 3.6.0-dev.55 → 3.6.0-dev.59

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,sDAA6C;AAC7C,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":["/*---------------------------------------------------------------------------------------------\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 } 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/**\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}\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"]}

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

@@ -60,7 +60,7 @@ export interface Node {
     /**
      * 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.
-     * @alpha
+     * @beta
      */
     supportsFiltering?: boolean;
     /** Extended data injected into this node */
@@ -71,6 +71,7 @@ export interface Node {
 /**
  * Serialized [[Node]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[Node]].
  */
 export interface NodeJSON {
     key: NodeKeyJSON;
@@ -94,7 +95,7 @@ export interface NodeJSON {
     isChecked?: boolean;
     /** @deprecated in 3.x. */
     isCheckboxEnabled?: boolean;
-    /** @alpha */
+    /** @beta */
     supportsFiltering?: boolean;
     extendedData?: {
         [key: string]: any;
@@ -108,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> & ({
@@ -115,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;
@@ -134,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/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;;;;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;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,WAAW,CAAC;IACjB,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,aAAa;IACb,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/cjs/presentation-common/hierarchy/Node.js

@@ -8,47 +8,55 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Node = void 0;
-const LabelDefinition_1 = require("../LabelDefinition");
 const Key_1 = require("./Key");
 /** @public */
 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: Key_1.NodeKey.toJSON(key),
-            labelDefinition: LabelDefinition_1.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: Key_1.NodeKey.toJSON(key),
-            labelDefinition: LabelDefinition_1.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: Key_1.NodeKey.fromJSON(json.key),
-            label: LabelDefinition_1.LabelDefinition.fromJSON(labelDefinition),
+            label: labelDefinition,
         };
     }
     Node.fromJSON = fromJSON;
     /** @internal */
+    // eslint-disable-next-line deprecation/deprecation
     function fromPartialJSON(json) {
         if (json.key === undefined) {
             return json;
@@ -56,18 +64,19 @@ var Node;
         const { key, labelDefinition, ...baseJson } = json;
         return {
             ...baseJson,
+            // eslint-disable-next-line deprecation/deprecation
             key: Key_1.NodeKey.fromJSON(key),
-            label: LabelDefinition_1.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;
@@ -75,19 +84,19 @@ 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) {

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

@@ -1 +1 @@
-{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAA0E;AAC1E,+BAA6C;AAmH7C,cAAc;AACd,IAAiB,IAAI,CAmFpB;AAnFD,WAAiB,IAAI;IACnB,uCAAuC;IACvC,SAAgB,MAAM,CAAC,IAAU;QAC/B,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,aAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YACxB,eAAe,EAAE,iCAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAPe,WAAM,SAOrB,CAAA;IAED,gBAAgB;IAChB,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,aAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YACxB,eAAe,EAAE,iCAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAXe,kBAAa,gBAW5B,CAAA;IAED,qCAAqC;IACrC,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,aAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,iCAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SACjD,CAAC;IACJ,CAAC;IATe,aAAQ,WASvB,CAAA;IAED,gBAAgB;IAChB,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,aAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,iCAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SACjD,CAAC;IACJ,CAAC;IAXe,oBAAe,kBAW9B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAFe,YAAO,UAEtB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAJe,iBAAY,eAI3B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,gBAAW,cAE1B,CAAA;AACH,CAAC,EAnFgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAmFpB","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 { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\r\nimport { NodeKey, NodeKeyJSON } from \"./Key\";\r\n\r\n/**\r\n * Data structure that describes a tree node.\r\n * @public\r\n */\r\nexport interface Node {\r\n  /** A key that uniquely identifies a node. */\r\n  key: NodeKey;\r\n  /** Definition of node display label */\r\n  label: LabelDefinition;\r\n  /** Extensive description */\r\n  description?: string;\r\n  /**\r\n   * Image ID\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n  /**\r\n   * Foreground color\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  foreColor?: string;\r\n  /**\r\n   * Background color\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  backColor?: string;\r\n  /**\r\n   * Font style\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  fontStyle?: string;\r\n  /** Does this node have child nodes */\r\n  hasChildren?: boolean;\r\n  /** Is this node selectable */\r\n  isSelectionDisabled?: boolean;\r\n  /** Is this node editable */\r\n  isEditable?: boolean;\r\n  /** Is this node expanded */\r\n  isExpanded?: boolean;\r\n  /**\r\n   * Is checkbox visible for this node\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxVisible?: boolean;\r\n  /**\r\n   * Is this node's checkbox checked\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isChecked?: boolean;\r\n  /**\r\n   * Is this node's checkbox enabled\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxEnabled?: boolean;\r\n  /**\r\n   * Identifies whether the hierarchy level below this node supports filtering. If not, requesting either a hierarchy level descriptor or\r\n   * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.\r\n   * @alpha\r\n   */\r\n  supportsFiltering?: boolean;\r\n  /** Extended data injected into this node */\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Serialized [[Node]] JSON representation.\r\n * @public\r\n */\r\nexport interface NodeJSON {\r\n  key: NodeKeyJSON;\r\n  labelDefinition: LabelDefinitionJSON;\r\n  description?: string;\r\n  /** @deprecated in 3.x. */\r\n  imageId?: string;\r\n  /** @deprecated in 3.x. */\r\n  foreColor?: string;\r\n  /** @deprecated in 3.x. */\r\n  backColor?: string;\r\n  /** @deprecated in 3.x. */\r\n  fontStyle?: string;\r\n  hasChildren?: boolean;\r\n  isSelectionDisabled?: boolean;\r\n  isEditable?: boolean;\r\n  isExpanded?: boolean;\r\n  /** @deprecated in 3.x. */\r\n  isCheckboxVisible?: boolean;\r\n  /** @deprecated in 3.x. */\r\n  isChecked?: boolean;\r\n  /** @deprecated in 3.x. */\r\n  isCheckboxEnabled?: boolean;\r\n  /** @alpha */\r\n  supportsFiltering?: boolean;\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Partial node definition.\r\n * @public\r\n */\r\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\r\n\r\n/**\r\n * Serialized [[PartialNode]] JSON representation.\r\n * @public\r\n */\r\nexport type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, \"key\" | \"labelDefinition\">;\r\n\r\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\r\n\r\n/** @public */\r\nexport namespace Node {\r\n  /** Serialize given [[Node]] to JSON */\r\n  export function toJSON(node: Node): NodeJSON {\r\n    const { key, label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      key: NodeKey.toJSON(key),\r\n      labelDefinition: LabelDefinition.toJSON(label),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  export function toPartialJSON(node: PartialNode): PartialNodeJSON {\r\n    if (node.key === undefined) {\r\n      return node;\r\n    }\r\n\r\n    const { key, label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      key: NodeKey.toJSON(key),\r\n      labelDefinition: LabelDefinition.toJSON(label),\r\n    };\r\n  }\r\n\r\n  /** Deserialize [[Node]] from JSON */\r\n  export function fromJSON(json: NodeJSON | string): Node {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const { labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      key: NodeKey.fromJSON(json.key),\r\n      label: LabelDefinition.fromJSON(labelDefinition),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  export function fromPartialJSON(json: PartialNodeJSON): PartialNode {\r\n    if (json.key === undefined) {\r\n      return json;\r\n    }\r\n\r\n    const { key, labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      key: NodeKey.fromJSON(key),\r\n      label: LabelDefinition.fromJSON(labelDefinition),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[Node]] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize nodes list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized nodes list\r\n   *\r\n   * @internal\r\n   */\r\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    return json.map((m) => fromJSON(m));\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[Node]][] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,+BAA6C;AAyH7C,cAAc;AACd,IAAiB,IAAI,CA6FpB;AA7FD,WAAiB,IAAI;IACnB;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,IAAU;QAC/B,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;IANe,WAAM,SAMrB,CAAA;IAED,gBAAgB;IAChB,mDAAmD;IACnD,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;IAVe,kBAAa,gBAU5B,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,GAAG,EAAE,aAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAVe,aAAQ,WAUvB,CAAA;IAED,gBAAgB;IAChB,mDAAmD;IACnD,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,GAAG,EAAE,aAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAZe,oBAAe,kBAY9B,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,mDAAmD;QACnD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAHe,YAAO,UAGtB,CAAA;IAED;;;;;OAKG;IACH,mDAAmD;IACnD,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,mDAAmD;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IALe,iBAAY,eAK3B,CAAA;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,gBAAW,cAE1B,CAAA;AACH,CAAC,EA7FgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QA6FpB","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 { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\r\nimport { NodeKey, NodeKeyJSON } from \"./Key\";\r\n\r\n/**\r\n * Data structure that describes a tree node.\r\n * @public\r\n */\r\nexport interface Node {\r\n  /** A key that uniquely identifies a node. */\r\n  key: NodeKey;\r\n  /** Definition of node display label */\r\n  label: LabelDefinition;\r\n  /** Extensive description */\r\n  description?: string;\r\n  /**\r\n   * Image ID\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n  /**\r\n   * Foreground color\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  foreColor?: string;\r\n  /**\r\n   * Background color\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  backColor?: string;\r\n  /**\r\n   * Font style\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  fontStyle?: string;\r\n  /** Does this node have child nodes */\r\n  hasChildren?: boolean;\r\n  /** Is this node selectable */\r\n  isSelectionDisabled?: boolean;\r\n  /** Is this node editable */\r\n  isEditable?: boolean;\r\n  /** Is this node expanded */\r\n  isExpanded?: boolean;\r\n  /**\r\n   * Is checkbox visible for this node\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxVisible?: boolean;\r\n  /**\r\n   * Is this node's checkbox checked\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isChecked?: boolean;\r\n  /**\r\n   * Is this node's checkbox enabled\r\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxEnabled?: boolean;\r\n  /**\r\n   * Identifies whether the hierarchy level below this node supports filtering. If not, requesting either a hierarchy level descriptor or\r\n   * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.\r\n   * @beta\r\n   */\r\n  supportsFiltering?: boolean;\r\n  /** Extended data injected into this node */\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Serialized [[Node]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[Node]].\r\n */\r\nexport interface NodeJSON {\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  key: NodeKeyJSON;\r\n  // TODO: rename to `label`\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  labelDefinition: LabelDefinitionJSON;\r\n  description?: string;\r\n  /** @deprecated in 3.x. */\r\n  imageId?: string;\r\n  /** @deprecated in 3.x. */\r\n  foreColor?: string;\r\n  /** @deprecated in 3.x. */\r\n  backColor?: string;\r\n  /** @deprecated in 3.x. */\r\n  fontStyle?: string;\r\n  hasChildren?: boolean;\r\n  isSelectionDisabled?: boolean;\r\n  isEditable?: boolean;\r\n  isExpanded?: boolean;\r\n  /** @deprecated in 3.x. */\r\n  isCheckboxVisible?: boolean;\r\n  /** @deprecated in 3.x. */\r\n  isChecked?: boolean;\r\n  /** @deprecated in 3.x. */\r\n  isCheckboxEnabled?: boolean;\r\n  /** @beta */\r\n  supportsFiltering?: boolean;\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Partial node definition.\r\n * @public\r\n */\r\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\r\n\r\n/**\r\n * Serialized [[PartialNode]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[PartialNode]].\r\n */\r\n// eslint-disable-next-line deprecation/deprecation\r\nexport type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, \"key\" | \"labelDefinition\">;\r\n\r\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\r\n\r\n/** @public */\r\nexport namespace Node {\r\n  /**\r\n   * Serialize given [[Node]] to JSON\r\n   * @deprecated in 3.x. Use [[Node]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(node: Node): NodeJSON {\r\n    const { label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      labelDefinition: label,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toPartialJSON(node: PartialNode): PartialNodeJSON {\r\n    if (node.key === undefined) {\r\n      return node;\r\n    }\r\n\r\n    const { label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      labelDefinition: label,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[Node]] from JSON\r\n   * @deprecated in 3.x. Use [[Node]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: NodeJSON | string): Node {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const { labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      key: NodeKey.fromJSON(json.key),\r\n      label: labelDefinition,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromPartialJSON(json: PartialNodeJSON): PartialNode {\r\n    if (json.key === undefined) {\r\n      return json;\r\n    }\r\n\r\n    const { key, labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      key: NodeKey.fromJSON(key),\r\n      label: labelDefinition,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[Node]] objects.\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize nodes list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized nodes list\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return json.map((m) => fromJSON(m));\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[Node]][] objects.\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n"]}

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

@@ -5,6 +5,7 @@ import { Node, NodeJSON } from "./Node";
 /**
  * Serialized [[NodePathElement]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[NodePathElement]].
  */
 export interface NodePathElementJSON {
     node: NodeJSON;
@@ -31,14 +32,19 @@ export interface NodePathElement {
 }
 /** @public */
 export declare namespace NodePathElement {
-    /** Serialize given [[NodePathElement]] to JSON */
+    /**
+     * Serialize given [[NodePathElement]] to JSON
+     * @deprecated in 3.x. Use [[NodePathElement]].
+     */
     function toJSON(npe: NodePathElement): NodePathElementJSON;
-    /** Deserialize [[NodePathElement]] from JSON */
+    /**
+     * Deserialize [[NodePathElement]] from JSON
+     * @deprecated in 3.x. Use [[NodePathElement]].
+     */
     function fromJSON(json: NodePathElementJSON | string): NodePathElement;
     /**
      * Reviver function that can be used as a second argument for
      * `JSON.parse` method when parsing [[NodePathElement]] objects.
-     *
      * @internal
      */
     function reviver(key: string, value: any): any;
@@ -46,14 +52,12 @@ export declare namespace NodePathElement {
      * Deserialize [[NodePathElement]] list from JSON
      * @param json JSON or JSON serialized to string to deserialize from
      * @returns Deserialized [[NodePathElement]] list
-     *
      * @internal
      */
     function listFromJSON(json: NodePathElementJSON[] | string): NodePathElement[];
     /**
      * Reviver function that can be used as a second argument for
      * `JSON.parse` method when parsing [[NodePathElement]][] objects.
-     *
      * @internal
      */
     function listReviver(key: string, value: any): any;
@@ -61,6 +65,7 @@ export declare namespace NodePathElement {
 /**
  * Serialized [[NodePathFilteringData]] JSON representation.
  * @public
+ * @deprecated in 3.x. Use [[NodePathFilteringData]].
  */
 export interface NodePathFilteringDataJSON {
     occurances: number;
@@ -78,9 +83,15 @@ export interface NodePathFilteringData {
 }
 /** @public */
 export declare namespace NodePathFilteringData {
-    /** Serialize given [[NodePathFilteringData]] to JSON */
+    /**
+     * Serialize given [[NodePathFilteringData]] to JSON
+     * @deprecated in 3.x. Use [[NodePathFilteringData]].
+     */
     function toJSON(npfd: NodePathFilteringData): NodePathFilteringDataJSON;
-    /** Deserialize [[NodePathFilteringData]] from JSON */
+    /**
+     * Deserialize [[NodePathFilteringData]] from JSON
+     * @deprecated in 3.x. Use [[NodePathFilteringData]].
+     */
     function fromJSON(json: NodePathFilteringDataJSON): NodePathFilteringData;
 }
 //# sourceMappingURL=NodePathElement.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"NodePathElement.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/NodePathElement.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAChC,aAAa,CAAC,EAAE,yBAAyB,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0BAA0B;IAC1B,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,+CAA+C;IAC/C,aAAa,CAAC,EAAE,qBAAqB,CAAC;CACvC;AAED,cAAc;AACd,yBAAiB,eAAe,CAAC;IAC/B,kDAAkD;IAClD,SAAgB,MAAM,CAAC,GAAG,EAAE,eAAe,GAAG,mBAAmB,CAWhE;IAED,gDAAgD;IAChD,SAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,GAAG,eAAe,CAa5E;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAEpD;IAED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,GAAG,MAAM,GAAG,eAAe,EAAE,CAIpF;IAED;;;;;OAKG;IACH,SAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAExD;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,+EAA+E;IAC/E,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC,wDAAwD;IACxD,SAAgB,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,yBAAyB,CAK7E;IAED,sDAAsD;IACtD,SAAgB,QAAQ,CAAC,IAAI,EAAE,yBAAyB,GAAG,qBAAqB,CAK/E;CACF"}
+{"version":3,"file":"NodePathElement.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/NodePathElement.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAElC,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAEhC,aAAa,CAAC,EAAE,yBAAyB,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,IAAI,EAAE,IAAI,CAAC;IACX,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0BAA0B;IAC1B,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,+CAA+C;IAC/C,aAAa,CAAC,EAAE,qBAAqB,CAAC;CACvC;AAED,cAAc;AACd,yBAAiB,eAAe,CAAC;IAC/B;;;OAGG;IAEH,SAAgB,MAAM,CAAC,GAAG,EAAE,eAAe,GAAG,mBAAmB,CAgBhE;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,GAAG,eAAe,CAgB5E;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAGpD;IAED;;;;;OAKG;IAEH,SAAgB,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,GAAG,MAAM,GAAG,eAAe,EAAE,CAKpF;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG,CAExD;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,+EAA+E;IAC/E,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC;;;OAGG;IAEH,SAAgB,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,yBAAyB,CAK7E;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,yBAAyB,GAAG,qBAAqB,CAK/E;CACF"}

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

@@ -12,43 +12,59 @@ const Node_1 = require("./Node");
 /** @public */
 var NodePathElement;
 (function (NodePathElement) {
-    /** Serialize given [[NodePathElement]] to JSON */
+    /**
+     * Serialize given [[NodePathElement]] to JSON
+     * @deprecated in 3.x. Use [[NodePathElement]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function toJSON(npe) {
+        // eslint-disable-next-line deprecation/deprecation
         const result = {
+            // eslint-disable-next-line deprecation/deprecation
             node: Node_1.Node.toJSON(npe.node),
             index: npe.index,
+            // eslint-disable-next-line deprecation/deprecation
             children: npe.children.map(NodePathElement.toJSON),
         };
         if (undefined !== npe.isMarked)
             result.isMarked = npe.isMarked;
-        if (undefined !== npe.filteringData)
+        if (undefined !== npe.filteringData) {
+            // eslint-disable-next-line deprecation/deprecation
             result.filteringData = NodePathFilteringData.toJSON(npe.filteringData);
+        }
         return result;
     }
     NodePathElement.toJSON = toJSON;
-    /** Deserialize [[NodePathElement]] from JSON */
+    /**
+     * Deserialize [[NodePathElement]] from JSON
+     * @deprecated in 3.x. Use [[NodePathElement]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function fromJSON(json) {
         if (typeof json === "string")
             return JSON.parse(json, reviver);
         const result = {
             index: json.index,
+            // eslint-disable-next-line deprecation/deprecation
             node: Node_1.Node.fromJSON(json.node),
             children: listFromJSON(json.children),
         };
         if (undefined !== json.isMarked)
             result.isMarked = json.isMarked;
-        if (undefined !== json.filteringData)
+        if (undefined !== json.filteringData) {
+            // eslint-disable-next-line deprecation/deprecation
             result.filteringData = NodePathFilteringData.fromJSON(json.filteringData);
+        }
         return result;
     }
     NodePathElement.fromJSON = fromJSON;
     /**
      * Reviver function that can be used as a second argument for
      * `JSON.parse` method when parsing [[NodePathElement]] objects.
-     *
      * @internal
      */
     function reviver(key, value) {
+        // eslint-disable-next-line deprecation/deprecation
         return key === "" ? fromJSON(value) : value;
     }
     NodePathElement.reviver = reviver;
@@ -56,19 +72,19 @@ var NodePathElement;
      * Deserialize [[NodePathElement]] list from JSON
      * @param json JSON or JSON serialized to string to deserialize from
      * @returns Deserialized [[NodePathElement]] 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));
     }
     NodePathElement.listFromJSON = listFromJSON;
     /**
      * Reviver function that can be used as a second argument for
      * `JSON.parse` method when parsing [[NodePathElement]][] objects.
-     *
      * @internal
      */
     function listReviver(key, value) {
@@ -79,7 +95,11 @@ var NodePathElement;
 /** @public */
 var NodePathFilteringData;
 (function (NodePathFilteringData) {
-    /** Serialize given [[NodePathFilteringData]] to JSON */
+    /**
+     * Serialize given [[NodePathFilteringData]] to JSON
+     * @deprecated in 3.x. Use [[NodePathFilteringData]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function toJSON(npfd) {
         return {
             occurances: npfd.matchesCount,
@@ -87,7 +107,11 @@ var NodePathFilteringData;
         };
     }
     NodePathFilteringData.toJSON = toJSON;
-    /** Deserialize [[NodePathFilteringData]] from JSON */
+    /**
+     * Deserialize [[NodePathFilteringData]] from JSON
+     * @deprecated in 3.x. Use [[NodePathFilteringData]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
     function fromJSON(json) {
         return {
             matchesCount: json.occurances,

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

@@ -1 +1 @@
-{"version":3,"file":"NodePathElement.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/NodePathElement.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iCAAwC;AA+BxC,cAAc;AACd,IAAiB,eAAe,CA+D/B;AA/DD,WAAiB,eAAe;IAC9B,kDAAkD;IAClD,SAAgB,MAAM,CAAC,GAAoB;QACzC,MAAM,MAAM,GAAwB;YAClC,IAAI,EAAE,WAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC;SACnD,CAAC;QACF,IAAI,SAAS,KAAK,GAAG,CAAC,QAAQ;YAC5B,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACjC,IAAI,SAAS,KAAK,GAAG,CAAC,aAAa;YACjC,MAAM,CAAC,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACzE,OAAO,MAAM,CAAC;IAChB,CAAC;IAXe,sBAAM,SAWrB,CAAA;IAED,gDAAgD;IAChD,SAAgB,QAAQ,CAAC,IAAkC;QACzD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,MAAM,GAAoB;YAC9B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,WAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9B,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC;SACtC,CAAC;QACF,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAClC,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa;YAClC,MAAM,CAAC,aAAa,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,wBAAQ,WAavB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAFe,uBAAO,UAEtB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,IAAoC;QAC/D,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAJe,4BAAY,eAI3B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,2BAAW,cAE1B,CAAA;AACH,CAAC,EA/DgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA+D/B;AAsBD,cAAc;AACd,IAAiB,qBAAqB,CAgBrC;AAhBD,WAAiB,qBAAqB;IACpC,wDAAwD;IACxD,SAAgB,MAAM,CAAC,IAA2B;QAChD,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,YAAY;YAC7B,kBAAkB,EAAE,IAAI,CAAC,iBAAiB;SAC3C,CAAC;IACJ,CAAC;IALe,4BAAM,SAKrB,CAAA;IAED,sDAAsD;IACtD,SAAgB,QAAQ,CAAC,IAA+B;QACtD,OAAO;YACL,YAAY,EAAE,IAAI,CAAC,UAAU;YAC7B,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;SAC3C,CAAC;IACJ,CAAC;IALe,8BAAQ,WAKvB,CAAA;AACH,CAAC,EAhBgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAgBrC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Hierarchies\r\n */\r\n\r\nimport { Node, NodeJSON } from \"./Node\";\r\n\r\n/**\r\n * Serialized [[NodePathElement]] JSON representation.\r\n * @public\r\n */\r\nexport interface NodePathElementJSON {\r\n  node: NodeJSON;\r\n  index: number;\r\n  isMarked?: boolean;\r\n  children: NodePathElementJSON[];\r\n  filteringData?: NodePathFilteringDataJSON;\r\n}\r\n\r\n/**\r\n * Describes a single step in the nodes path.\r\n * @public\r\n */\r\nexport interface NodePathElement {\r\n  /** Node instance */\r\n  node: Node;\r\n  /** Node index  */\r\n  index: number;\r\n  /** Is this element part of the marked path */\r\n  isMarked?: boolean;\r\n  /** Child path elements */\r\n  children: NodePathElement[];\r\n  /** Additional filtering-related information */\r\n  filteringData?: NodePathFilteringData;\r\n}\r\n\r\n/** @public */\r\nexport namespace NodePathElement {\r\n  /** Serialize given [[NodePathElement]] to JSON */\r\n  export function toJSON(npe: NodePathElement): NodePathElementJSON {\r\n    const result: NodePathElementJSON = {\r\n      node: Node.toJSON(npe.node),\r\n      index: npe.index,\r\n      children: npe.children.map(NodePathElement.toJSON),\r\n    };\r\n    if (undefined !== npe.isMarked)\r\n      result.isMarked = npe.isMarked;\r\n    if (undefined !== npe.filteringData)\r\n      result.filteringData = NodePathFilteringData.toJSON(npe.filteringData);\r\n    return result;\r\n  }\r\n\r\n  /** Deserialize [[NodePathElement]] from JSON */\r\n  export function fromJSON(json: NodePathElementJSON | string): NodePathElement {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const result: NodePathElement = {\r\n      index: json.index,\r\n      node: Node.fromJSON(json.node),\r\n      children: listFromJSON(json.children),\r\n    };\r\n    if (undefined !== json.isMarked)\r\n      result.isMarked = json.isMarked;\r\n    if (undefined !== json.filteringData)\r\n      result.filteringData = NodePathFilteringData.fromJSON(json.filteringData);\r\n    return result;\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[NodePathElement]] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[NodePathElement]] list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized [[NodePathElement]] list\r\n   *\r\n   * @internal\r\n   */\r\n  export function listFromJSON(json: NodePathElementJSON[] | string): NodePathElement[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    return json.map((m) => fromJSON(m));\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[NodePathElement]][] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n\r\n/**\r\n * Serialized [[NodePathFilteringData]] JSON representation.\r\n * @public\r\n */\r\nexport interface NodePathFilteringDataJSON {\r\n  occurances: number;\r\n  childrenOccurances: number;\r\n}\r\n\r\n/**\r\n * Data related to node hierarchy filtering\r\n * @public\r\n */\r\nexport interface NodePathFilteringData {\r\n  /** Number of filter matches in the current element */\r\n  matchesCount: number;\r\n  /** Number of filter matches in the current element's children (recursively) */\r\n  childMatchesCount: number;\r\n}\r\n\r\n/** @public */\r\nexport namespace NodePathFilteringData {\r\n  /** Serialize given [[NodePathFilteringData]] to JSON */\r\n  export function toJSON(npfd: NodePathFilteringData): NodePathFilteringDataJSON {\r\n    return {\r\n      occurances: npfd.matchesCount,\r\n      childrenOccurances: npfd.childMatchesCount,\r\n    };\r\n  }\r\n\r\n  /** Deserialize [[NodePathFilteringData]] from JSON */\r\n  export function fromJSON(json: NodePathFilteringDataJSON): NodePathFilteringData {\r\n    return {\r\n      matchesCount: json.occurances,\r\n      childMatchesCount: json.childrenOccurances,\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NodePathElement.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/NodePathElement.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iCAAwC;AAmCxC,cAAc;AACd,IAAiB,eAAe,CA+E/B;AA/ED,WAAiB,eAAe;IAC9B;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAoB;QACzC,mDAAmD;QACnD,MAAM,MAAM,GAAwB;YAClC,mDAAmD;YACnD,IAAI,EAAE,WAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,mDAAmD;YACnD,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC;SACnD,CAAC;QACF,IAAI,SAAS,KAAK,GAAG,CAAC,QAAQ;YAC5B,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACjC,IAAI,SAAS,KAAK,GAAG,CAAC,aAAa,EAAE;YACnC,mDAAmD;YACnD,MAAM,CAAC,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;SACxE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAhBe,sBAAM,SAgBrB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAkC;QACzD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,MAAM,GAAoB;YAC9B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,mDAAmD;YACnD,IAAI,EAAE,WAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9B,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC;SACtC,CAAC;QACF,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAClC,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE;YACpC,mDAAmD;YACnD,MAAM,CAAC,aAAa,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC3E;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAhBe,wBAAQ,WAgBvB,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,mDAAmD;QACnD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAHe,uBAAO,UAGtB,CAAA;IAED;;;;;OAKG;IACH,mDAAmD;IACnD,SAAgB,YAAY,CAAC,IAAoC;QAC/D,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,mDAAmD;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IALe,4BAAY,eAK3B,CAAA;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,2BAAW,cAE1B,CAAA;AACH,CAAC,EA/EgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA+E/B;AAuBD,cAAc;AACd,IAAiB,qBAAqB,CAwBrC;AAxBD,WAAiB,qBAAqB;IACpC;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,IAA2B;QAChD,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,YAAY;YAC7B,kBAAkB,EAAE,IAAI,CAAC,iBAAiB;SAC3C,CAAC;IACJ,CAAC;IALe,4BAAM,SAKrB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAA+B;QACtD,OAAO;YACL,YAAY,EAAE,IAAI,CAAC,UAAU;YAC7B,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;SAC3C,CAAC;IACJ,CAAC;IALe,8BAAQ,WAKvB,CAAA;AACH,CAAC,EAxBgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAwBrC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Hierarchies\r\n */\r\n\r\nimport { Node, NodeJSON } from \"./Node\";\r\n\r\n/**\r\n * Serialized [[NodePathElement]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[NodePathElement]].\r\n */\r\nexport interface NodePathElementJSON {\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  node: NodeJSON;\r\n  index: number;\r\n  isMarked?: boolean;\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  children: NodePathElementJSON[];\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  filteringData?: NodePathFilteringDataJSON;\r\n}\r\n\r\n/**\r\n * Describes a single step in the nodes path.\r\n * @public\r\n */\r\nexport interface NodePathElement {\r\n  /** Node instance */\r\n  node: Node;\r\n  /** Node index  */\r\n  index: number;\r\n  /** Is this element part of the marked path */\r\n  isMarked?: boolean;\r\n  /** Child path elements */\r\n  children: NodePathElement[];\r\n  /** Additional filtering-related information */\r\n  filteringData?: NodePathFilteringData;\r\n}\r\n\r\n/** @public */\r\nexport namespace NodePathElement {\r\n  /**\r\n   * Serialize given [[NodePathElement]] to JSON\r\n   * @deprecated in 3.x. Use [[NodePathElement]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(npe: NodePathElement): NodePathElementJSON {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    const result: NodePathElementJSON = {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      node: Node.toJSON(npe.node),\r\n      index: npe.index,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      children: npe.children.map(NodePathElement.toJSON),\r\n    };\r\n    if (undefined !== npe.isMarked)\r\n      result.isMarked = npe.isMarked;\r\n    if (undefined !== npe.filteringData) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      result.filteringData = NodePathFilteringData.toJSON(npe.filteringData);\r\n    }\r\n    return result;\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[NodePathElement]] from JSON\r\n   * @deprecated in 3.x. Use [[NodePathElement]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: NodePathElementJSON | string): NodePathElement {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const result: NodePathElement = {\r\n      index: json.index,\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      node: Node.fromJSON(json.node),\r\n      children: listFromJSON(json.children),\r\n    };\r\n    if (undefined !== json.isMarked)\r\n      result.isMarked = json.isMarked;\r\n    if (undefined !== json.filteringData) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      result.filteringData = NodePathFilteringData.fromJSON(json.filteringData);\r\n    }\r\n    return result;\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[NodePathElement]] objects.\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[NodePathElement]] list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized [[NodePathElement]] list\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function listFromJSON(json: NodePathElementJSON[] | string): NodePathElement[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return json.map((m) => fromJSON(m));\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing [[NodePathElement]][] objects.\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n\r\n/**\r\n * Serialized [[NodePathFilteringData]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[NodePathFilteringData]].\r\n */\r\nexport interface NodePathFilteringDataJSON {\r\n  occurances: number;\r\n  childrenOccurances: number;\r\n}\r\n\r\n/**\r\n * Data related to node hierarchy filtering\r\n * @public\r\n */\r\nexport interface NodePathFilteringData {\r\n  /** Number of filter matches in the current element */\r\n  matchesCount: number;\r\n  /** Number of filter matches in the current element's children (recursively) */\r\n  childMatchesCount: number;\r\n}\r\n\r\n/** @public */\r\nexport namespace NodePathFilteringData {\r\n  /**\r\n   * Serialize given [[NodePathFilteringData]] to JSON\r\n   * @deprecated in 3.x. Use [[NodePathFilteringData]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(npfd: NodePathFilteringData): NodePathFilteringDataJSON {\r\n    return {\r\n      occurances: npfd.matchesCount,\r\n      childrenOccurances: npfd.childMatchesCount,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[NodePathFilteringData]] from JSON\r\n   * @deprecated in 3.x. Use [[NodePathFilteringData]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: NodePathFilteringDataJSON): NodePathFilteringData {\r\n    return {\r\n      matchesCount: json.occurances,\r\n      childMatchesCount: json.childrenOccurances,\r\n    };\r\n  }\r\n}\r\n"]}

package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts

@@ -12,8 +12,11 @@ import { RelationshipDirection } from "./RelationshipDirection";
 export interface RelationshipStepSpecification {
     /** This attribute specifies the ECRelationship that should be used to traverse to target class. */
     relationship: SingleSchemaClassSpecification;
-    /** This attribute specifies the direction in which the [[relationship]] should be followed. */
-    direction: RelationshipDirection.Forward | RelationshipDirection.Backward;
+    /**
+     * This attribute specifies the direction in which the [[relationship]] should be followed.
+     * @see RelationshipDirection
+     */
+    direction: `${RelationshipDirection}`;
     /**
      * This attribute may be used to specialize the target of the relationship.
      */

package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,mGAAmG;IACnG,YAAY,EAAE,8BAA8B,CAAC;IAE7C,+FAA+F;IAC/F,SAAS,EAAE,qBAAqB,CAAC,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAE1E;;OAEG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,WAAW,uCAAwC,SAAQ,6BAA6B;IAC5F;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;;;;;;GAOG;AACH,oBAAY,uCAAuC,GAAG,uCAAuC,GAAG,uCAAuC,EAAE,CAAC"}
+{"version":3,"file":"RelationshipPathSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,mGAAmG;IACnG,YAAY,EAAE,8BAA8B,CAAC;IAE7C;;;OAGG;IACH,SAAS,EAAE,GAAG,qBAAqB,EAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,WAAW,uCAAwC,SAAQ,6BAA6B;IAC5F;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;;;;;;GAOG;AACH,oBAAY,uCAAuC,GAAG,uCAAuC,GAAG,uCAAuC,EAAE,CAAC"}

package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single step in [[RelationshipPathSpecification]].\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** This attribute specifies the ECRelationship that should be used to traverse to target class. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** This attribute specifies the direction in which the [[relationship]] should be followed. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * This attribute may be used to specialize the target of the relationship.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single step in [[RepeatableRelationshipPathSpecification]].\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * When a number is specified, the relationship is traversed recursively the specified number of times.\r\n   *\r\n   * When it is set to a special value `\"*\"`, the same relationship is traversed recursively unbounded number\r\n   * of times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation\r\n   * rules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Relationship path specification is used to define a relationship path to an ECClass.\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * This specification declares a step in a relationship path between a source and target ECInstances. A step\r\n * can optionally be repeated a number of times to traverse the same relationship recursively. Multiple\r\n * specifications of this type can be chained together to express complex indirect relationships.\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}
+{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single step in [[RelationshipPathSpecification]].\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** This attribute specifies the ECRelationship that should be used to traverse to target class. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /**\r\n   * This attribute specifies the direction in which the [[relationship]] should be followed.\r\n   * @see RelationshipDirection\r\n   */\r\n  direction: `${RelationshipDirection}`;\r\n\r\n  /**\r\n   * This attribute may be used to specialize the target of the relationship.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single step in [[RepeatableRelationshipPathSpecification]].\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * When a number is specified, the relationship is traversed recursively the specified number of times.\r\n   *\r\n   * When it is set to a special value `\"*\"`, the same relationship is traversed recursively unbounded number\r\n   * of times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation\r\n   * rules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Relationship path specification is used to define a relationship path to an ECClass.\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * This specification declares a step in a relationship path between a source and target ECInstances. A step\r\n * can optionally be repeated a number of times to traverse the same relationship recursively. Multiple\r\n * specifications of this type can be chained together to express complex indirect relationships.\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}

package/lib/cjs/presentation-common/rules/Rule.d.ts

@@ -12,8 +12,11 @@ import { RequiredSchemaSpecification } from "./SchemasSpecification";
  * @public
  */
 export interface RuleBase {
-    /** Used for serializing to JSON. */
-    ruleType: RuleTypes;
+    /**
+     * Used for serializing to JSON.
+     * @see RuleTypes
+     */
+    ruleType: `${RuleTypes}`;
     /**
      * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are
      * equal, the rules are handled in the order they're defined.
@@ -28,7 +31,6 @@ export interface RuleBase {
     onlyIfNotHandled?: boolean;
     /**
      * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
-     * @beta
      */
     requiredSchemas?: RequiredSchemaSpecification[];
 }