@itwin/presentation-common 5.0.0-dev.10 → 5.0.0-dev.102

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;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAyD;AACzD,8BAAoC;AAEpC;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wDAAmC,CAAA;IACnC,gEAA2C,CAAA;IAC3C,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;AACvD,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B;AAOD,cAAc;AACd,2DAA2D;AAC3D,IAAiB,OAAO,CA0HvB;AA1HD,WAAiB,OAAO;IACtB;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,MAAM,CAAC,GAAY;QACjC,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IACpB,CAAC;IAFe,cAAM,SAErB,CAAA;IAED;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAAiB;QACxC,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;IACjC,CAAC;IAFe,gBAAQ,WAEvB,CAAA;IAMD,4DAA4D;IAC5D,SAAgB,kBAAkB,CAAC,GAA0B;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,eAAe,CAAC;IACxD,CAAC;IAFe,0BAAkB,qBAEjC,CAAA;IAMD,4DAA4D;IAC5D,SAAgB,sBAAsB,CAAC,GAA0B;QAC/D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,mBAAmB,CAAC;IAC5D,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAMD,4DAA4D;IAC5D,SAAgB,yBAAyB,CAAC,GAA0B;QAClE,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,sBAAsB,CAAC;IAC/D,CAAC;IAFe,iCAAyB,4BAExC,CAAA;IAMD,4DAA4D;IAC5D,SAAgB,sBAAsB,CAAC,GAA0B;QAC/D,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,wBAAwB,CAAC;IACjE,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAMD,4DAA4D;IAC5D,SAAgB,iBAAiB,CAAC,GAA0B;QAC1D,OAAO,sBAAsB,CAAC,GAAG,CAAC,IAAI,yBAAyB,CAAC,GAAG,CAAC,IAAI,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,uDAAuD;IAC9J,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,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,8CAA8C;QAC9C,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,0EAA0E;QAC1E,IAAI,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;YAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACjD,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;oBAChD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,sFAAsF;QACtF,8CAA8C;QAC9C,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAA,qBAAM,EAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YAChC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,gBAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxE,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC;QACzC,CAAC;QACD,IAAI,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,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;QAClF,CAAC;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAhDe,cAAM,SAgDrB,CAAA;AACH,CAAC,EA1HgB,OAAO,uBAAP,OAAO,QA0HvB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Hierarchies\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { InstanceKey } from \"../EC\";\r\n\r\n/**\r\n * Standard node types\r\n * @public\r\n */\r\nexport enum StandardNodeTypes {\r\n  ECInstancesNode = \"ECInstancesNode\",\r\n  ECClassGroupingNode = \"ECClassGroupingNode\",\r\n  ECPropertyGroupingNode = \"ECPropertyGroupingNode\",\r\n  DisplayLabelGroupingNode = \"DisplayLabelGroupingNode\",\r\n}\r\n\r\n/**\r\n * One of the node key types\r\n * @public\r\n */\r\nexport type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;\r\n/** @public */\r\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace NodeKey {\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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. Use an override for [[NodeKey]]. */\r\n  export function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\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. Use an override for [[NodeKey]]. */\r\n  export function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\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. Use an override for [[NodeKey]]. */\r\n  export function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\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. Use an override for [[NodeKey]]. */\r\n  export function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\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. Use an override for [[NodeKey]]. */\r\n  export function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  export function isGroupingNodeKey(key: NodeKey | NodeKeyJSON) {\r\n    return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key); // eslint-disable-line @typescript-eslint/no-deprecated\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\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\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      }\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      }\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      }\r\n      return true;\r\n    }\r\n    if (isClassGroupingNodeKey(lhs)) {\r\n      assert(isClassGroupingNodeKey(rhs));\r\n      return lhs.className === rhs.className;\r\n    }\r\n    if (isPropertyGroupingNodeKey(lhs)) {\r\n      assert(isPropertyGroupingNodeKey(rhs));\r\n      return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;\r\n    }\r\n    if (isLabelGroupingNodeKey(lhs)) {\r\n      assert(isLabelGroupingNodeKey(rhs));\r\n      return lhs.label === rhs.label;\r\n    }\r\n    return true;\r\n  }\r\n}\r\n\r\n/**\r\n * Node key path. Can be used to define path from one node to another.\r\n * @public\r\n */\r\nexport type NodeKeyPath = NodeKey[];\r\n\r\n/**\r\n * Data structure that describes a basic node key\r\n * @public\r\n */\r\nexport interface BaseNodeKey {\r\n  /** Node type */\r\n  type: string;\r\n\r\n  /**\r\n   * Version of the key. Different versions suggest that node keys were created by two different\r\n   * versions of the library. In that case, keys representing the same node may be different.\r\n   */\r\n  version: number;\r\n\r\n  /** Node hash path from root to the node whose key this is */\r\n  pathFromRoot: string[];\r\n\r\n  /** Query that returns all selected instance keys */\r\n  instanceKeysSelectQuery?: PresentationQuery;\r\n}\r\n/**\r\n * Serialized [[BaseNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[BaseNodeKey]].\r\n */\r\nexport interface BaseNodeKeyJSON {\r\n  type: string;\r\n  // TODO: make this required\r\n  version?: number;\r\n  pathFromRoot: string[];\r\n  instanceKeysSelectQuery?: PresentationQuery;\r\n}\r\n\r\n/**\r\n * Data structure that describes a node ECInstance node key\r\n * @public\r\n */\r\nexport interface ECInstancesNodeKey extends BaseNodeKey {\r\n  type: StandardNodeTypes.ECInstancesNode;\r\n  /** List of [[InstanceKey]] objects of ECInstances represented by the node */\r\n  instanceKeys: InstanceKey[];\r\n}\r\n/**\r\n * Serialized [[ECInstancesNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[ECInstancesNodeKey]].\r\n */\r\nexport interface ECInstancesNodeKeyJSON extends BaseNodeKey {\r\n  type: StandardNodeTypes.ECInstancesNode;\r\n  instanceKeys: InstanceKey[];\r\n}\r\n\r\n/**\r\n * Data structure that describes a grouping node key\r\n * @public\r\n */\r\nexport interface GroupingNodeKey extends BaseNodeKey {\r\n  /**\r\n   * Get the number of instances grouped by the node represented\r\n   * by this key.\r\n   *\r\n   * **Note:** this property is just a helper and is not involved\r\n   * in identifying a node.\r\n   */\r\n  groupedInstancesCount: number;\r\n}\r\n/**\r\n * Serialized [[GroupingNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[GroupingNodeKey]].\r\n */\r\nexport interface GroupingNodeKeyJSON extends BaseNodeKey {\r\n  groupedInstancesCount: number;\r\n}\r\n\r\n/**\r\n * Data structure that describes an ECClass grouping node key\r\n * @public\r\n */\r\nexport interface ECClassGroupingNodeKey extends GroupingNodeKey {\r\n  type: StandardNodeTypes.ECClassGroupingNode;\r\n  /** Full name of the grouping ECClass */\r\n  className: string;\r\n}\r\n/**\r\n * Serialized [[ECClassGroupingNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[ECClassGroupingNodeKey]].\r\n */\r\nexport interface ECClassGroupingNodeKeyJSON extends GroupingNodeKey {\r\n  type: StandardNodeTypes.ECClassGroupingNode;\r\n  className: string;\r\n}\r\n\r\n/**\r\n * Data structure that describes an ECProperty grouping node key\r\n * @public\r\n */\r\nexport interface ECPropertyGroupingNodeKey extends GroupingNodeKey {\r\n  type: StandardNodeTypes.ECPropertyGroupingNode;\r\n  /** Full name of the grouping ECProperty class */\r\n  className: string;\r\n  /** Name of the ECProperty */\r\n  propertyName: string;\r\n  /** Raw grouping values */\r\n  groupingValues: any[];\r\n}\r\n/**\r\n * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[ECPropertyGroupingNodeKey]].\r\n */\r\nexport interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKey {\r\n  type: StandardNodeTypes.ECPropertyGroupingNode;\r\n  className: string;\r\n  propertyName: string;\r\n  groupingValues: any[];\r\n}\r\n\r\n/**\r\n * Data structure that describes a display label grouping node key\r\n * @public\r\n */\r\nexport interface LabelGroupingNodeKey extends GroupingNodeKey {\r\n  type: StandardNodeTypes.DisplayLabelGroupingNode;\r\n  /** Grouping display label */\r\n  label: string;\r\n}\r\n/**\r\n * Serialized [[LabelGroupingNodeKey]] JSON representation.\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelGroupingNodeKey]].\r\n */\r\nexport interface LabelGroupingNodeKeyJSON extends GroupingNodeKey {\r\n  type: StandardNodeTypes.DisplayLabelGroupingNode;\r\n  label: string;\r\n}\r\n\r\n/**\r\n * One of the serialized node key types\r\n * @public\r\n * @deprecated in 3.x. Use [[NodeKey]].\r\n */\r\n// eslint-disable-next-line @typescript-eslint/no-deprecated\r\nexport type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;\r\n\r\n/**\r\n * Data structure that describes a presentation query\r\n * @public\r\n */\r\nexport interface PresentationQuery {\r\n  /** ECSQL query */\r\n  query: string;\r\n  /** The query bindings */\r\n  bindings?: PresentationQueryBinding[];\r\n}\r\n\r\n/**\r\n * Defines an [[Id64String]] value binding.\r\n * @public\r\n */\r\nexport interface IdBinding {\r\n  type: \"Id\";\r\n  value: Id64String;\r\n}\r\n\r\n/**\r\n * Defines an [[IdSet]] value binding for use with `InVirtualSet` ECSQL function.\r\n * @public\r\n */\r\nexport interface IdSetBinding {\r\n  type: \"IdSet\";\r\n  value: Id64String[];\r\n}\r\n\r\n/**\r\n * Defines an EC value binding.\r\n * @public\r\n */\r\nexport interface ECValueBinding {\r\n  type: \"ECValue\";\r\n  valueType: string;\r\n  valueTypeExtended?: string;\r\n  value: any;\r\n}\r\n\r\n/**\r\n * Defines a binding for a list of EC values for use with `InVirtualSet` ECSQL function.\r\n * @public\r\n */\r\nexport interface ECValueSetBinding {\r\n  type: \"ValueSet\";\r\n  valueType: string;\r\n  valueTypeExtended?: string;\r\n  value: any[];\r\n}\r\n\r\n/**\r\n * One of the [[PresentationQuery]] binding types.\r\n * @public\r\n */\r\nexport type PresentationQueryBinding = IdBinding | IdSetBinding | ECValueBinding | ECValueSetBinding;\r\n"]}
+{"version":3,"file":"Key.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Key.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAyD;AACzD,oCAAuC;AAEvC;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,wDAAmC,CAAA;IACnC,gEAA2C,CAAA;IAC3C,sEAAiD,CAAA;IACjD,0EAAqD,CAAA;AACvD,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B;AAOD,cAAc;AACd,2DAA2D;AAC3D,IAAiB,OAAO,CAoFvB;AApFD,WAAiB,OAAO;IACtB,8DAA8D;IAC9D,SAAgB,kBAAkB,CAAC,GAAY;QAC7C,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,eAAe,CAAC;IACxD,CAAC;IAFe,0BAAkB,qBAEjC,CAAA;IAED,kEAAkE;IAClE,SAAgB,sBAAsB,CAAC,GAAY;QACjD,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,mBAAmB,CAAC;IAC5D,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAED,qEAAqE;IACrE,SAAgB,yBAAyB,CAAC,GAAY;QACpD,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,sBAAsB,CAAC;IAC/D,CAAC;IAFe,iCAAyB,4BAExC,CAAA;IAED,+DAA+D;IAC/D,SAAgB,sBAAsB,CAAC,GAAY;QACjD,OAAO,GAAG,CAAC,IAAI,KAAK,iBAAiB,CAAC,wBAAwB,CAAC;IACjE,CAAC;IAFe,8BAAsB,yBAErC,CAAA;IAED,wDAAwD;IACxD,SAAgB,iBAAiB,CAAC,GAAY;QAC5C,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,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,8CAA8C;QAC9C,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,0EAA0E;QAC1E,IAAI,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;YAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACjD,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;oBAChD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,sFAAsF;QACtF,8CAA8C;QAC9C,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAA,qBAAM,EAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YAChC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,mBAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxE,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC;QACzC,CAAC;QACD,IAAI,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,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;QAClF,CAAC;QACD,IAAI,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,IAAA,qBAAM,EAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAhDe,cAAM,SAgDrB,CAAA;AACH,CAAC,EApFgB,OAAO,uBAAP,OAAO,QAoFvB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Hierarchies\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport { InstanceKey } from \"../EC.js\";\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\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace NodeKey {\r\n  /** Checks if the supplied key is an [[ECInstancesNodeKey]] */\r\n  export function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey {\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    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    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    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    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\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\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      }\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      }\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      }\r\n      return true;\r\n    }\r\n    if (isClassGroupingNodeKey(lhs)) {\r\n      assert(isClassGroupingNodeKey(rhs));\r\n      return lhs.className === rhs.className;\r\n    }\r\n    if (isPropertyGroupingNodeKey(lhs)) {\r\n      assert(isPropertyGroupingNodeKey(rhs));\r\n      return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;\r\n    }\r\n    if (isLabelGroupingNodeKey(lhs)) {\r\n      assert(isLabelGroupingNodeKey(rhs));\r\n      return lhs.label === rhs.label;\r\n    }\r\n    return true;\r\n  }\r\n}\r\n\r\n/**\r\n * Node key path. Can be used to define path from one node to another.\r\n * @public\r\n */\r\nexport type NodeKeyPath = NodeKey[];\r\n\r\n/**\r\n * Data structure that describes a basic node key\r\n * @public\r\n */\r\nexport interface BaseNodeKey {\r\n  /** Node type */\r\n  type: string;\r\n\r\n  /**\r\n   * Version of the key. Different versions suggest that node keys were created by two different\r\n   * versions of the library. In that case, keys representing the same node may be different.\r\n   */\r\n  version: number;\r\n\r\n  /** Node hash path from root to the node whose key this is */\r\n  pathFromRoot: string[];\r\n\r\n  /** Query that returns all selected instance keys */\r\n  instanceKeysSelectQuery?: PresentationQuery;\r\n}\r\n\r\n/**\r\n * Data structure that describes a node ECInstance node key\r\n * @public\r\n */\r\nexport interface ECInstancesNodeKey extends BaseNodeKey {\r\n  type: StandardNodeTypes.ECInstancesNode;\r\n  /** List of [[InstanceKey]] objects of ECInstances represented by the node */\r\n  instanceKeys: InstanceKey[];\r\n}\r\n\r\n/**\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/**\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/**\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/**\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/**\r\n * Data structure that describes a presentation query\r\n * @public\r\n */\r\nexport interface PresentationQuery {\r\n  /** ECSQL query */\r\n  query: string;\r\n  /** The query bindings */\r\n  bindings?: PresentationQueryBinding[];\r\n}\r\n\r\n/**\r\n * Defines an [[Id64String]] value binding.\r\n * @public\r\n */\r\nexport interface IdBinding {\r\n  type: \"Id\";\r\n  value: Id64String;\r\n}\r\n\r\n/**\r\n * Defines an [[IdSet]] value binding for use with `InVirtualSet` ECSQL function.\r\n * @public\r\n */\r\nexport interface IdSetBinding {\r\n  type: \"IdSet\";\r\n  value: Id64String[];\r\n}\r\n\r\n/**\r\n * Defines an EC value binding.\r\n * @public\r\n */\r\nexport interface ECValueBinding {\r\n  type: \"ECValue\";\r\n  valueType: string;\r\n  valueTypeExtended?: string;\r\n  value: any;\r\n}\r\n\r\n/**\r\n * Defines a binding for a list of EC values for use with `InVirtualSet` ECSQL function.\r\n * @public\r\n */\r\nexport interface ECValueSetBinding {\r\n  type: \"ValueSet\";\r\n  valueType: string;\r\n  valueTypeExtended?: string;\r\n  value: any[];\r\n}\r\n\r\n/**\r\n * One of the [[PresentationQuery]] binding types.\r\n * @public\r\n */\r\nexport type PresentationQueryBinding = IdBinding | IdSetBinding | ECValueBinding | ECValueSetBinding;\r\n"]}

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

@@ -1,8 +1,8 @@
 /** @packageDocumentation
  * @module Hierarchies
  */
-import { LabelDefinition, LabelDefinitionJSON } from "../LabelDefinition";
-import { NodeKey, NodeKeyJSON } from "./Key";
+import { LabelDefinition } from "../LabelDefinition.js";
+import { NodeKey } from "./Key.js";
 /**
  * Data structure that describes a tree node.
  * @public
@@ -16,24 +16,10 @@ export interface Node {
     description?: string;
     /**
      * Image ID
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. Will
+     * be removed with [[PropertyGroup.imageId]] and [[PropertyRangeGroupSpecification.imageId]].
      */
     imageId?: string;
-    /**
-     * Foreground color
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    foreColor?: string;
-    /**
-     * Background color
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    backColor?: string;
-    /**
-     * Font style
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    fontStyle?: string;
     /** Does this node have child nodes */
     hasChildren?: boolean;
     /** Is this node selectable */
@@ -42,21 +28,6 @@ export interface Node {
     isEditable?: boolean;
     /** Is this node expanded */
     isExpanded?: boolean;
-    /**
-     * Is checkbox visible for this node
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    isCheckboxVisible?: boolean;
-    /**
-     * Is this node's checkbox checked
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    isChecked?: boolean;
-    /**
-     * Is this node's checkbox enabled
-     * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    isCheckboxEnabled?: boolean;
     /**
      * Identifies whether the hierarchy level below this node supports filtering. If not, requesting either a hierarchy level descriptor or
      * a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.
@@ -67,87 +38,13 @@ export interface Node {
         [key: string]: any;
     };
 }
-/**
- * Serialized [[Node]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[Node]].
- */
-export interface NodeJSON {
-    key: NodeKeyJSON;
-    labelDefinition: LabelDefinitionJSON;
-    description?: string;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    imageId?: string;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    foreColor?: string;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    backColor?: string;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    fontStyle?: string;
-    hasChildren?: boolean;
-    isSelectionDisabled?: boolean;
-    isEditable?: boolean;
-    isExpanded?: boolean;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    isCheckboxVisible?: boolean;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    isChecked?: boolean;
-    /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
-    isCheckboxEnabled?: boolean;
-    supportsFiltering?: boolean;
-    extendedData?: {
-        [key: string]: any;
-    };
-}
 /**
  * Partial node definition.
  * @public
  */
 export type PartialNode = AllOrNone<Partial<Node>, "key" | "label">;
-/**
- * Serialized [[PartialNode]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[PartialNode]].
- */
-export type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, "key" | "labelDefinition">;
 type AllOrNone<T, P extends keyof T> = Omit<T, P> & ({
     [K in P]?: never;
 } | Required<Pick<T, P>>);
-/** @public */
-export declare namespace Node {
-    /**
-     * Serialize given [[Node]] to JSON
-     * @deprecated in 3.x. Use [[Node]].
-     */
-    function toJSON(node: Node): NodeJSON;
-    /** @internal */
-    function toPartialJSON(node: PartialNode): PartialNodeJSON;
-    /**
-     * Deserialize [[Node]] from JSON
-     * @deprecated in 3.x. Use [[Node]].
-     */
-    function fromJSON(json: NodeJSON | string): Node;
-    /** @internal */
-    function fromPartialJSON(json: PartialNodeJSON): PartialNode;
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[Node]] objects.
-     * @internal
-     */
-    function reviver(key: string, value: any): any;
-    /**
-     * Deserialize nodes list from JSON
-     * @param json JSON or JSON serialized to string to deserialize from
-     * @returns Deserialized nodes list
-     * @internal
-     */
-    function listFromJSON(json: NodeJSON[] | string): Node[];
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing [[Node]][] objects.
-     * @internal
-     */
-    function listReviver(key: string, value: any): any;
-}
 export {};
 //# sourceMappingURL=Node.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Node.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,6CAA6C;IAC7C,GAAG,EAAE,OAAO,CAAC;IACb,uCAAuC;IACvC,KAAK,EAAE,eAAe,CAAC;IACvB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8BAA8B;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,4CAA4C;IAC5C,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IAEvB,GAAG,EAAE,WAAW,CAAC;IAGjB,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gKAAgK;IAChK,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gKAAgK;IAChK,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gKAAgK;IAChK,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gKAAgK;IAChK,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,gKAAgK;IAChK,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gKAAgK;IAChK,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gKAAgK;IAChK,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,GAAG,iBAAiB,CAAC,CAAC;AAEtF,KAAK,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,CAWtD;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,CAM9D;IAED;;;;OAIG;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,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC;;;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;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,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,4CAA4C;IAC5C,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;AAEpE,KAAK,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"}

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

@@ -7,103 +7,4 @@
  * @module Hierarchies
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Node = void 0;
-const Key_1 = require("./Key");
-/** @public */
-var Node;
-(function (Node) {
-    /**
-     * Serialize given [[Node]] to JSON
-     * @deprecated in 3.x. Use [[Node]].
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function toJSON(node) {
-        const { label, ...baseNode } = node;
-        return {
-            ...baseNode,
-            labelDefinition: label,
-        };
-    }
-    Node.toJSON = toJSON;
-    /** @internal */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function toPartialJSON(node) {
-        if (node.key === undefined) {
-            return node;
-        }
-        const { label, ...baseNode } = node;
-        return {
-            ...baseNode,
-            labelDefinition: label,
-        };
-    }
-    Node.toPartialJSON = toPartialJSON;
-    /**
-     * Deserialize [[Node]] from JSON
-     * @deprecated in 3.x. Use [[Node]].
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function fromJSON(json) {
-        if (typeof json === "string") {
-            return JSON.parse(json, reviver);
-        }
-        const { labelDefinition, ...baseJson } = json;
-        return {
-            ...baseJson,
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            key: Key_1.NodeKey.fromJSON(json.key),
-            label: labelDefinition,
-        };
-    }
-    Node.fromJSON = fromJSON;
-    /** @internal */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function fromPartialJSON(json) {
-        if (json.key === undefined) {
-            return json;
-        }
-        const { key, labelDefinition, ...baseJson } = json;
-        return {
-            ...baseJson,
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            key: Key_1.NodeKey.fromJSON(key),
-            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 @typescript-eslint/no-deprecated
-        return key === "" ? fromJSON(value) : value;
-    }
-    Node.reviver = reviver;
-    /**
-     * 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 @typescript-eslint/no-deprecated
-    function listFromJSON(json) {
-        if (typeof json === "string") {
-            return JSON.parse(json, listReviver);
-        }
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-        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) {
-        return key === "" ? listFromJSON(value) : value;
-    }
-    Node.listReviver = listReviver;
-})(Node || (exports.Node = Node = {}));
 //# sourceMappingURL=Node.js.map

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;;;gGAGgG;AAChG;;GAEG;;;AAGH,+BAA6C;AAsH7C,cAAc;AACd,IAAiB,IAAI,CA+FpB;AA/FD,WAAiB,IAAI;IACnB;;;OAGG;IACH,4DAA4D;IAC5D,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,4DAA4D;IAC5D,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;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,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,4DAA4D;YAC5D,GAAG,EAAE,aAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAXe,aAAQ,WAWvB,CAAA;IAED,gBAAgB;IAChB,4DAA4D;IAC5D,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,4DAA4D;YAC5D,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,4DAA4D;QAC5D,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,4DAA4D;IAC5D,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,CAAC;QACD,4DAA4D;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IANe,iBAAY,eAM3B,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,EA/FgB,IAAI,oBAAJ,IAAI,QA+FpB","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   */\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 @typescript-eslint/no-deprecated\r\n  key: NodeKeyJSON;\r\n  // TODO: rename to `label`\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  labelDefinition: LabelDefinitionJSON;\r\n  description?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  imageId?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  foreColor?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  backColor?: string;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\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. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  isCheckboxVisible?: boolean;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  isChecked?: boolean;\r\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\r\n  isCheckboxEnabled?: boolean;\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\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\r\n  export function fromJSON(json: NodeJSON | string): Node {\r\n    if (typeof json === \"string\") {\r\n      return JSON.parse(json, reviver);\r\n    }\r\n    const { labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\r\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\r\n    if (typeof json === \"string\") {\r\n      return JSON.parse(json, listReviver);\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\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"]}
+{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 Hierarchies\r\n */\r\n\r\nimport { LabelDefinition } from \"../LabelDefinition.js\";\r\nimport { NodeKey } from \"./Key.js\";\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. Will\r\n   * be removed with [[PropertyGroup.imageId]] and [[PropertyRangeGroupSpecification.imageId]].\r\n   */\r\n  imageId?: 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   * 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   */\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 * Partial node definition.\r\n * @public\r\n */\r\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\r\n\r\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\r\n"]}

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

@@ -1,19 +1,7 @@
 /** @packageDocumentation
  * @module Hierarchies
  */
-import { Node, NodeJSON } from "./Node";
-/**
- * Serialized [[NodePathElement]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[NodePathElement]].
- */
-export interface NodePathElementJSON {
-    node: NodeJSON;
-    index: number;
-    isMarked?: boolean;
-    children: NodePathElementJSON[];
-    filteringData?: NodePathFilteringDataJSON;
-}
+import { Node } from "./Node.js";
 /**
  * Describes a single step in the nodes path.
  * @public
@@ -30,47 +18,6 @@ export interface NodePathElement {
     /** Additional filtering-related information */
     filteringData?: NodePathFilteringData;
 }
-/** @public */
-export declare namespace NodePathElement {
-    /**
-     * Serialize given [[NodePathElement]] to JSON
-     * @deprecated in 3.x. Use [[NodePathElement]].
-     */
-    function toJSON(npe: NodePathElement): NodePathElementJSON;
-    /**
-     * 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;
-    /**
-     * 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;
-}
-/**
- * Serialized [[NodePathFilteringData]] JSON representation.
- * @public
- * @deprecated in 3.x. Use [[NodePathFilteringData]].
- */
-export interface NodePathFilteringDataJSON {
-    occurances: number;
-    childrenOccurances: number;
-}
 /**
  * Data related to node hierarchy filtering
  * @public
@@ -81,17 +28,4 @@ export interface NodePathFilteringData {
     /** Number of filter matches in the current element's children (recursively) */
     childMatchesCount: number;
 }
-/** @public */
-export declare namespace NodePathFilteringData {
-    /**
-     * Serialize given [[NodePathFilteringData]] to JSON
-     * @deprecated in 3.x. Use [[NodePathFilteringData]].
-     */
-    function toJSON(npfd: NodePathFilteringData): NodePathFilteringDataJSON;
-    /**
-     * 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;;;;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,CAiBhE;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,GAAG,eAAe,CAkB5E;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,CAMpF;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"}
+{"version":3,"file":"NodePathElement.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/NodePathElement.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC;;;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;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,+EAA+E;IAC/E,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}

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

@@ -7,121 +7,4 @@
  * @module Hierarchies
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodePathFilteringData = exports.NodePathElement = void 0;
-const Node_1 = require("./Node");
-/** @public */
-var NodePathElement;
-(function (NodePathElement) {
-    /**
-     * Serialize given [[NodePathElement]] to JSON
-     * @deprecated in 3.x. Use [[NodePathElement]].
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function toJSON(npe) {
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-        const result = {
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            node: Node_1.Node.toJSON(npe.node),
-            index: npe.index,
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            children: npe.children.map(NodePathElement.toJSON),
-        };
-        if (undefined !== npe.isMarked) {
-            result.isMarked = npe.isMarked;
-        }
-        if (undefined !== npe.filteringData) {
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            result.filteringData = NodePathFilteringData.toJSON(npe.filteringData);
-        }
-        return result;
-    }
-    NodePathElement.toJSON = toJSON;
-    /**
-     * Deserialize [[NodePathElement]] from JSON
-     * @deprecated in 3.x. Use [[NodePathElement]].
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function fromJSON(json) {
-        if (typeof json === "string") {
-            return JSON.parse(json, reviver);
-        }
-        const result = {
-            index: json.index,
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            node: Node_1.Node.fromJSON(json.node),
-            children: listFromJSON(json.children),
-        };
-        if (undefined !== json.isMarked) {
-            result.isMarked = json.isMarked;
-        }
-        if (undefined !== json.filteringData) {
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            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 @typescript-eslint/no-deprecated
-        return key === "" ? fromJSON(value) : value;
-    }
-    NodePathElement.reviver = reviver;
-    /**
-     * 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 @typescript-eslint/no-deprecated
-    function listFromJSON(json) {
-        if (typeof json === "string") {
-            return JSON.parse(json, listReviver);
-        }
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-        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) {
-        return key === "" ? listFromJSON(value) : value;
-    }
-    NodePathElement.listReviver = listReviver;
-})(NodePathElement || (exports.NodePathElement = NodePathElement = {}));
-/** @public */
-var NodePathFilteringData;
-(function (NodePathFilteringData) {
-    /**
-     * Serialize given [[NodePathFilteringData]] to JSON
-     * @deprecated in 3.x. Use [[NodePathFilteringData]].
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function toJSON(npfd) {
-        return {
-            occurances: npfd.matchesCount,
-            childrenOccurances: npfd.childMatchesCount,
-        };
-    }
-    NodePathFilteringData.toJSON = toJSON;
-    /**
-     * Deserialize [[NodePathFilteringData]] from JSON
-     * @deprecated in 3.x. Use [[NodePathFilteringData]].
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    function fromJSON(json) {
-        return {
-            matchesCount: json.occurances,
-            childMatchesCount: json.childrenOccurances,
-        };
-    }
-    NodePathFilteringData.fromJSON = fromJSON;
-})(NodePathFilteringData || (exports.NodePathFilteringData = NodePathFilteringData = {}));
 //# sourceMappingURL=NodePathElement.js.map

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;;;gGAGgG;AAChG;;GAEG;;;AAEH,iCAAwC;AAmCxC,cAAc;AACd,IAAiB,eAAe,CAmF/B;AAnFD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,MAAM,CAAC,GAAoB;QACzC,4DAA4D;QAC5D,MAAM,MAAM,GAAwB;YAClC,4DAA4D;YAC5D,IAAI,EAAE,WAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YAC3B,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,4DAA4D;YAC5D,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC;SACnD,CAAC;QACF,IAAI,SAAS,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QACjC,CAAC;QACD,IAAI,SAAS,KAAK,GAAG,CAAC,aAAa,EAAE,CAAC;YACpC,4DAA4D;YAC5D,MAAM,CAAC,aAAa,GAAG,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAjBe,sBAAM,SAiBrB,CAAA;IAED;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAAkC;QACzD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;QACD,MAAM,MAAM,GAAoB;YAC9B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,4DAA4D;YAC5D,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,EAAE,CAAC;YAChC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAClC,CAAC;QACD,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,4DAA4D;YAC5D,MAAM,CAAC,aAAa,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAlBe,wBAAQ,WAkBvB,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,4DAA4D;QAC5D,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,4DAA4D;IAC5D,SAAgB,YAAY,CAAC,IAAoC;QAC/D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,CAAC;QACD,4DAA4D;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IANe,4BAAY,eAM3B,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,EAnFgB,eAAe,+BAAf,eAAe,QAmF/B;AAuBD,cAAc;AACd,IAAiB,qBAAqB,CAwBrC;AAxBD,WAAiB,qBAAqB;IACpC;;;OAGG;IACH,4DAA4D;IAC5D,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,4DAA4D;IAC5D,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,qCAArB,qBAAqB,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 @typescript-eslint/no-deprecated\r\n  node: NodeJSON;\r\n  index: number;\r\n  isMarked?: boolean;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  children: NodePathElementJSON[];\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\r\n  export function toJSON(npe: NodePathElement): NodePathElementJSON {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const result: NodePathElementJSON = {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      node: Node.toJSON(npe.node),\r\n      index: npe.index,\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      children: npe.children.map(NodePathElement.toJSON),\r\n    };\r\n    if (undefined !== npe.isMarked) {\r\n      result.isMarked = npe.isMarked;\r\n    }\r\n    if (undefined !== npe.filteringData) {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\r\n  export function fromJSON(json: NodePathElementJSON | string): NodePathElement {\r\n    if (typeof json === \"string\") {\r\n      return JSON.parse(json, reviver);\r\n    }\r\n    const result: NodePathElement = {\r\n      index: json.index,\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\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    }\r\n    if (undefined !== json.filteringData) {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\r\n  export function listFromJSON(json: NodePathElementJSON[] | string): NodePathElement[] {\r\n    if (typeof json === \"string\") {\r\n      return JSON.parse(json, listReviver);\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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 @typescript-eslint/no-deprecated\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;;;gGAGgG;AAChG;;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 Hierarchies\r\n */\r\n\r\nimport { Node } from \"./Node.js\";\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/**\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"]}

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

@@ -2,8 +2,8 @@
  * @module PresentationRules
  */
 import { Id64String } from "@itwin/core-bentley";
-import { SingleSchemaClassSpecification } from "./ClassSpecifications";
-import { RelationshipPathSpecification } from "./RelationshipPathSpecification";
+import { SingleSchemaClassSpecification } from "./ClassSpecifications.js";
+import { RelationshipPathSpecification } from "./RelationshipPathSpecification.js";
 /**
  * Defines base attributes for [[RelatedInstanceByPathSpecification]] and [[RelatedInstanceByTargetInstancesSpecification]].
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"RelatedInstanceSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAmC,SAAQ,gCAAgC;IAC1F;;;OAGG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,6CAA8C,SAAQ,gCAAgC;IACrG;;OAEG;IACH,eAAe,EAAE;QACf,kDAAkD;QAClD,KAAK,EAAE,8BAA8B,CAAC;QACtC,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;KAC3B,CAAC;CACH;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GAAG,kCAAkC,GAAG,6CAA6C,CAAC"}
+{"version":3,"file":"RelatedInstanceSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAmC,SAAQ,gCAAgC;IAC1F;;;OAGG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,6CAA8C,SAAQ,gCAAgC;IACrG;;OAEG;IACH,eAAe,EAAE;QACf,kDAAkD;QAClD,KAAK,EAAE,8BAA8B,CAAC;QACtC,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;KAC3B,CAAC;CACH;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,4BAA4B,GAAG,kCAAkC,GAAG,6CAA6C,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 { Id64String } from \"@itwin/core-bentley\";\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * Defines base attributes for [[RelatedInstanceByPathSpecification]] and [[RelatedInstanceByTargetInstancesSpecification]].\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecificationBase {\r\n  /**\r\n   * Specifies an an alias that given to the related instance. The alias can be used to reference the\r\n   * instance in instance filter and customization rules.\r\n   *\r\n   * @pattern ^\\w[\\w\\d]*$\r\n   */\r\n  alias: string;\r\n\r\n  /**\r\n   * Specifies whether to omit the primary instance from the result if the other end of [[relationshipPath]]\r\n   * does not yield any related instances.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n\r\n/**\r\n * A type of [[RelatedInstanceSpecification]] that joins related instances by a relationship path.\r\n * @public\r\n */\r\nexport interface RelatedInstanceByPathSpecification extends RelatedInstanceSpecificationBase {\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md)\r\n   * that forms a path from the primary instance to the related instances.\r\n   */\r\n  relationshipPath: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * A type of [[RelatedInstanceSpecification]] that joins related instances by target class and instance IDs.\r\n * @public\r\n */\r\nexport interface RelatedInstanceByTargetInstancesSpecification extends RelatedInstanceSpecificationBase {\r\n  /**\r\n   * Specifies target class and a list of target ECInstance IDs.\r\n   */\r\n  targetInstances: {\r\n    /** Specification for the target class to join. */\r\n    class: SingleSchemaClassSpecification;\r\n    /** Ids of the target instances to join. */\r\n    instanceIds: Id64String[];\r\n  };\r\n}\r\n\r\n/**\r\n * Related instance specification is used in [content]($docs/presentation/content/ContentRule.md#attribute-specifications)\r\n * and [hierarchy]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications) specifications to \"join\" the\r\n * primary instance with its related instance and allow using the related instance for filtering, customization and grouping.\r\n *\r\n * @see [Related instance specification reference documentation page]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport type RelatedInstanceSpecification = RelatedInstanceByPathSpecification | RelatedInstanceByTargetInstancesSpecification;\r\n"]}
+{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 { Id64String } from \"@itwin/core-bentley\";\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications.js\";\r\nimport { RelationshipPathSpecification } from \"./RelationshipPathSpecification.js\";\r\n\r\n/**\r\n * Defines base attributes for [[RelatedInstanceByPathSpecification]] and [[RelatedInstanceByTargetInstancesSpecification]].\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecificationBase {\r\n  /**\r\n   * Specifies an an alias that given to the related instance. The alias can be used to reference the\r\n   * instance in instance filter and customization rules.\r\n   *\r\n   * @pattern ^\\w[\\w\\d]*$\r\n   */\r\n  alias: string;\r\n\r\n  /**\r\n   * Specifies whether to omit the primary instance from the result if the other end of [[relationshipPath]]\r\n   * does not yield any related instances.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n\r\n/**\r\n * A type of [[RelatedInstanceSpecification]] that joins related instances by a relationship path.\r\n * @public\r\n */\r\nexport interface RelatedInstanceByPathSpecification extends RelatedInstanceSpecificationBase {\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md)\r\n   * that forms a path from the primary instance to the related instances.\r\n   */\r\n  relationshipPath: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * A type of [[RelatedInstanceSpecification]] that joins related instances by target class and instance IDs.\r\n * @public\r\n */\r\nexport interface RelatedInstanceByTargetInstancesSpecification extends RelatedInstanceSpecificationBase {\r\n  /**\r\n   * Specifies target class and a list of target ECInstance IDs.\r\n   */\r\n  targetInstances: {\r\n    /** Specification for the target class to join. */\r\n    class: SingleSchemaClassSpecification;\r\n    /** Ids of the target instances to join. */\r\n    instanceIds: Id64String[];\r\n  };\r\n}\r\n\r\n/**\r\n * Related instance specification is used in [content]($docs/presentation/content/ContentRule.md#attribute-specifications)\r\n * and [hierarchy]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications) specifications to \"join\" the\r\n * primary instance with its related instance and allow using the related instance for filtering, customization and grouping.\r\n *\r\n * @see [Related instance specification reference documentation page]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport type RelatedInstanceSpecification = RelatedInstanceByPathSpecification | RelatedInstanceByTargetInstancesSpecification;\r\n"]}