@itwin/presentation-common 3.5.0-dev.8 → 3.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (474) hide show
  1. package/CHANGELOG.md +71 -1
  2. package/lib/cjs/assets/locales/en/BisCore.json +18 -18
  3. package/lib/cjs/assets/locales/en/ECPresentation.json +9 -9
  4. package/lib/cjs/assets/locales/en/RulesEngine.json +5 -5
  5. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  6. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  7. package/lib/cjs/presentation-common/AsyncTasks.js.map +1 -1
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  9. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  10. package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -1
  11. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  12. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  13. package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
  14. package/lib/cjs/presentation-common/EC.d.ts +315 -315
  15. package/lib/cjs/presentation-common/EC.js +270 -270
  16. package/lib/cjs/presentation-common/EC.js.map +1 -1
  17. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  18. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  19. package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
  20. package/lib/cjs/presentation-common/Error.d.ts +45 -45
  21. package/lib/cjs/presentation-common/Error.js +62 -62
  22. package/lib/cjs/presentation-common/Error.js.map +1 -1
  23. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +60 -0
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -0
  25. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +10 -0
  26. package/lib/cjs/presentation-common/InstanceFilterDefinition.js.map +1 -0
  27. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  28. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  29. package/lib/cjs/presentation-common/KeySet.js +423 -418
  30. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  31. package/lib/cjs/presentation-common/LabelDefinition.d.ts +79 -79
  32. package/lib/cjs/presentation-common/LabelDefinition.js +76 -76
  33. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  34. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  35. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  36. package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
  37. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +37 -37
  38. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  39. package/lib/cjs/presentation-common/PresentationIpcInterface.js.map +1 -1
  40. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +242 -242
  41. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  42. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  43. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +181 -181
  44. package/lib/cjs/presentation-common/PresentationRpcInterface.js +102 -102
  45. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  46. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  47. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  48. package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
  49. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  50. package/lib/cjs/presentation-common/RpcRequestsHandler.js +155 -155
  51. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  52. package/lib/cjs/presentation-common/RulesetVariables.d.ts +166 -166
  53. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  54. package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
  55. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  56. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  57. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  58. package/lib/cjs/presentation-common/Update.d.ts +194 -194
  59. package/lib/cjs/presentation-common/Update.js +196 -196
  60. package/lib/cjs/presentation-common/Update.js.map +1 -1
  61. package/lib/cjs/presentation-common/Utils.d.ts +62 -64
  62. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  63. package/lib/cjs/presentation-common/Utils.js +43 -45
  64. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  65. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  66. package/lib/cjs/presentation-common/content/Category.js +49 -49
  67. package/lib/cjs/presentation-common/content/Category.js.map +1 -1
  68. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  69. package/lib/cjs/presentation-common/content/Content.js +56 -56
  70. package/lib/cjs/presentation-common/content/Content.js.map +1 -1
  71. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +101 -101
  72. package/lib/cjs/presentation-common/content/ContentTraverser.js +420 -420
  73. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  74. package/lib/cjs/presentation-common/content/Descriptor.d.ts +275 -240
  75. package/lib/cjs/presentation-common/content/Descriptor.d.ts.map +1 -1
  76. package/lib/cjs/presentation-common/content/Descriptor.js +195 -189
  77. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  78. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  79. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  80. package/lib/cjs/presentation-common/content/DisplayTypes.js.map +1 -1
  81. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  82. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  83. package/lib/cjs/presentation-common/content/Editor.js.map +1 -1
  84. package/lib/cjs/presentation-common/content/Fields.d.ts +282 -282
  85. package/lib/cjs/presentation-common/content/Fields.js +394 -394
  86. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  87. package/lib/cjs/presentation-common/content/Item.d.ts +87 -87
  88. package/lib/cjs/presentation-common/content/Item.js +86 -86
  89. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  90. package/lib/cjs/presentation-common/content/Property.d.ts +51 -51
  91. package/lib/cjs/presentation-common/content/Property.js +36 -36
  92. package/lib/cjs/presentation-common/content/Property.js.map +1 -1
  93. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  94. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  95. package/lib/cjs/presentation-common/content/Renderer.js.map +1 -1
  96. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  97. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  98. package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
  99. package/lib/cjs/presentation-common/content/Value.d.ts +157 -157
  100. package/lib/cjs/presentation-common/content/Value.js +217 -217
  101. package/lib/cjs/presentation-common/content/Value.js.map +1 -1
  102. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +185 -185
  103. package/lib/cjs/presentation-common/hierarchy/Key.js +112 -112
  104. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  105. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +141 -141
  106. package/lib/cjs/presentation-common/hierarchy/Node.js +97 -97
  107. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  108. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  109. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +98 -98
  110. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  111. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  112. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  113. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  114. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  115. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  116. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  117. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  118. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  119. package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
  120. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  121. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  122. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  123. package/lib/cjs/presentation-common/rules/Rule.d.ts +74 -74
  124. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  125. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  126. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +66 -66
  127. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  128. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  129. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  130. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  131. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  132. package/lib/cjs/presentation-common/rules/Variables.d.ts +55 -55
  133. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  134. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  135. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  136. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  137. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  138. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  139. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  140. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  141. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  142. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  143. package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
  144. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  145. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  146. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  147. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  148. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  149. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  150. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  151. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  152. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  153. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  154. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  155. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  156. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  157. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  158. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  159. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  160. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  161. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  162. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  163. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  164. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  165. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  166. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  167. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  168. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  169. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  170. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  171. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  172. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  173. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  174. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  175. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  176. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  177. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  178. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  179. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  180. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  181. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  182. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  183. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  184. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  185. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  186. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  187. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  188. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  189. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  190. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  191. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  192. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  193. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  194. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  195. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  196. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  197. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  198. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  199. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  200. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  201. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  202. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  203. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  204. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  205. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +22 -22
  206. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  207. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  208. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  209. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  210. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  211. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  212. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  213. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  214. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  215. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  216. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  217. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  218. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  219. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  220. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  221. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  222. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  223. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  224. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  225. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  226. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  227. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  228. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  229. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  230. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  231. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +25 -25
  232. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  233. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  234. package/lib/cjs/presentation-common.d.ts +111 -110
  235. package/lib/cjs/presentation-common.d.ts.map +1 -1
  236. package/lib/cjs/presentation-common.js +127 -126
  237. package/lib/cjs/presentation-common.js.map +1 -1
  238. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  239. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  240. package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
  241. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  242. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  243. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
  244. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  245. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  246. package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
  247. package/lib/esm/presentation-common/EC.d.ts +315 -315
  248. package/lib/esm/presentation-common/EC.js +267 -267
  249. package/lib/esm/presentation-common/EC.js.map +1 -1
  250. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  251. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  252. package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
  253. package/lib/esm/presentation-common/Error.d.ts +45 -45
  254. package/lib/esm/presentation-common/Error.js +58 -58
  255. package/lib/esm/presentation-common/Error.js.map +1 -1
  256. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +60 -0
  257. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -0
  258. package/lib/esm/presentation-common/InstanceFilterDefinition.js +9 -0
  259. package/lib/esm/presentation-common/InstanceFilterDefinition.js.map +1 -0
  260. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  261. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  262. package/lib/esm/presentation-common/KeySet.js +419 -414
  263. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  264. package/lib/esm/presentation-common/LabelDefinition.d.ts +79 -79
  265. package/lib/esm/presentation-common/LabelDefinition.js +73 -73
  266. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  267. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  268. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  269. package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
  270. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +37 -37
  271. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  272. package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
  273. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +242 -242
  274. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  275. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  276. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +181 -181
  277. package/lib/esm/presentation-common/PresentationRpcInterface.js +98 -98
  278. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  279. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  280. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  281. package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
  282. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  283. package/lib/esm/presentation-common/RpcRequestsHandler.js +151 -151
  284. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  285. package/lib/esm/presentation-common/RulesetVariables.d.ts +166 -166
  286. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  287. package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
  288. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  289. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  290. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  291. package/lib/esm/presentation-common/Update.d.ts +194 -194
  292. package/lib/esm/presentation-common/Update.js +193 -193
  293. package/lib/esm/presentation-common/Update.js.map +1 -1
  294. package/lib/esm/presentation-common/Utils.d.ts +62 -64
  295. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  296. package/lib/esm/presentation-common/Utils.js +39 -41
  297. package/lib/esm/presentation-common/Utils.js.map +1 -1
  298. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  299. package/lib/esm/presentation-common/content/Category.js +46 -46
  300. package/lib/esm/presentation-common/content/Category.js.map +1 -1
  301. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  302. package/lib/esm/presentation-common/content/Content.js +52 -52
  303. package/lib/esm/presentation-common/content/Content.js.map +1 -1
  304. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +101 -101
  305. package/lib/esm/presentation-common/content/ContentTraverser.js +411 -411
  306. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  307. package/lib/esm/presentation-common/content/Descriptor.d.ts +275 -240
  308. package/lib/esm/presentation-common/content/Descriptor.d.ts.map +1 -1
  309. package/lib/esm/presentation-common/content/Descriptor.js +191 -185
  310. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  311. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  312. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  313. package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
  314. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  315. package/lib/esm/presentation-common/content/Editor.js +8 -8
  316. package/lib/esm/presentation-common/content/Editor.js.map +1 -1
  317. package/lib/esm/presentation-common/content/Fields.d.ts +282 -282
  318. package/lib/esm/presentation-common/content/Fields.js +387 -387
  319. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  320. package/lib/esm/presentation-common/content/Item.d.ts +87 -87
  321. package/lib/esm/presentation-common/content/Item.js +82 -82
  322. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  323. package/lib/esm/presentation-common/content/Property.d.ts +51 -51
  324. package/lib/esm/presentation-common/content/Property.js +33 -33
  325. package/lib/esm/presentation-common/content/Property.js.map +1 -1
  326. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  327. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  328. package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
  329. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  330. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  331. package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
  332. package/lib/esm/presentation-common/content/Value.d.ts +157 -157
  333. package/lib/esm/presentation-common/content/Value.js +214 -214
  334. package/lib/esm/presentation-common/content/Value.js.map +1 -1
  335. package/lib/esm/presentation-common/hierarchy/Key.d.ts +185 -185
  336. package/lib/esm/presentation-common/hierarchy/Key.js +109 -109
  337. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  338. package/lib/esm/presentation-common/hierarchy/Node.d.ts +141 -141
  339. package/lib/esm/presentation-common/hierarchy/Node.js +94 -94
  340. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  341. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  342. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +95 -95
  343. package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  344. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  345. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  346. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  347. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  348. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  349. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  350. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  351. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  352. package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
  353. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  354. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  355. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  356. package/lib/esm/presentation-common/rules/Rule.d.ts +74 -74
  357. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  358. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  359. package/lib/esm/presentation-common/rules/Ruleset.d.ts +66 -66
  360. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  361. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  362. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  363. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  364. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  365. package/lib/esm/presentation-common/rules/Variables.d.ts +55 -55
  366. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  367. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  368. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  369. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  370. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  371. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  372. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  373. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  374. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  375. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  376. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  377. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  378. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  379. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  380. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  381. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  382. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  383. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  384. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  385. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  386. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  387. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  388. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  389. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  390. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  391. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  392. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  393. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  394. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  395. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  396. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  397. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  398. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  399. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  400. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  401. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  402. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  403. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  404. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  405. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  406. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  407. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  408. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  409. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  410. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  411. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  412. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  413. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  414. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  415. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  416. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  417. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  418. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  419. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  420. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  421. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  422. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  423. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  424. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  425. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  426. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  427. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  428. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  429. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  430. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  431. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  432. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  433. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  434. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  435. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  436. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  437. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  438. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +19 -19
  439. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  440. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  441. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  442. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  443. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  444. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  445. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  446. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  447. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  448. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  449. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  450. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  451. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  452. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  453. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  454. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  455. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  456. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  457. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  458. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  459. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  460. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  461. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  462. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  463. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  464. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +25 -25
  465. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  466. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  467. package/lib/esm/presentation-common.d.ts +111 -110
  468. package/lib/esm/presentation-common.d.ts.map +1 -1
  469. package/lib/esm/presentation-common.js +115 -114
  470. package/lib/esm/presentation-common.js.map +1 -1
  471. package/lib/public/locales/en/BisCore.json +18 -18
  472. package/lib/public/locales/en/ECPresentation.json +9 -9
  473. package/lib/public/locales/en/RulesEngine.json +5 -5
  474. package/package.json +9 -9
@@ -1,186 +1,186 @@
1
- /** @packageDocumentation
2
- * @module Hierarchies
3
- */
4
- import { InstanceKey, InstanceKeyJSON } from "../EC";
5
- /**
6
- * Standard node types
7
- * @public
8
- */
9
- export declare enum StandardNodeTypes {
10
- ECInstancesNode = "ECInstancesNode",
11
- ECClassGroupingNode = "ECClassGroupingNode",
12
- ECPropertyGroupingNode = "ECPropertyGroupingNode",
13
- DisplayLabelGroupingNode = "DisplayLabelGroupingNode"
14
- }
15
- /**
16
- * One of the node key types
17
- * @public
18
- */
19
- export declare type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;
20
- /** @public */
21
- export declare namespace NodeKey {
22
- /** Serialize given [[NodeKey]] to JSON */
23
- function toJSON(key: NodeKey): NodeKeyJSON;
24
- /** Deserialize node key from JSON */
25
- function fromJSON(json: NodeKeyJSON): NodeKey;
26
- /** Checks if the supplied key is an [[ECInstancesNodeKey]] */
27
- function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey;
28
- /** Checks if the supplied key is an [[ECInstancesNodeKey]] */
29
- function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;
30
- /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */
31
- function isClassGroupingNodeKey(key: NodeKey): key is ECClassGroupingNodeKey;
32
- /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */
33
- function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;
34
- /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */
35
- function isPropertyGroupingNodeKey(key: NodeKey): key is ECPropertyGroupingNodeKey;
36
- /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */
37
- function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;
38
- /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */
39
- function isLabelGroupingNodeKey(key: NodeKey): key is LabelGroupingNodeKey;
40
- /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */
41
- function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;
42
- /** Checks if the supplied key is a grouping node key */
43
- function isGroupingNodeKey(key: NodeKey): key is GroupingNodeKey;
44
- /** Checks if the supplied key is a grouping node key */
45
- function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;
46
- /**
47
- * Checks if two given node keys are equal, taking their versions into account.
48
- *
49
- * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array
50
- * which is the most accurate way of checking equality. However, when version are different,
51
- * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.
52
- * In that case equality is checked using other key attributes, depending on the type of the node (type,
53
- * label, grouping class, property name, etc.).
54
- */
55
- function equals(lhs: NodeKey, rhs: NodeKey): boolean;
56
- }
57
- /**
58
- * Node key path. Can be used to define path from one node to another.
59
- * @public
60
- */
61
- export declare type NodeKeyPath = NodeKey[];
62
- /**
63
- * Data structure that describes a basic node key
64
- * @public
65
- */
66
- export interface BaseNodeKey {
67
- /** Node type */
68
- type: string;
69
- /**
70
- * Version of the key. Different versions suggest that node keys were created by two different
71
- * versions of the library. In that case, keys representing the same node may be different.
72
- */
73
- version: number;
74
- /** Node hash path from root to the node whose key this is */
75
- pathFromRoot: string[];
76
- }
77
- /**
78
- * Serialized [[BaseNodeKey]] JSON representation.
79
- * @public
80
- */
81
- export interface BaseNodeKeyJSON {
82
- type: string;
83
- version?: number;
84
- pathFromRoot: string[];
85
- }
86
- /**
87
- * Data structure that describes a node ECInstance node key
88
- * @public
89
- */
90
- export interface ECInstancesNodeKey extends BaseNodeKey {
91
- type: StandardNodeTypes.ECInstancesNode;
92
- /** List of [[InstanceKey]] objects of ECInstances represented by the node */
93
- instanceKeys: InstanceKey[];
94
- }
95
- /**
96
- * Serialized [[ECInstancesNodeKey]] JSON representation.
97
- * @public
98
- */
99
- export interface ECInstancesNodeKeyJSON extends BaseNodeKeyJSON {
100
- type: StandardNodeTypes.ECInstancesNode;
101
- instanceKeys: InstanceKeyJSON[];
102
- }
103
- /**
104
- * Data structure that describes a grouping node key
105
- * @public
106
- */
107
- export interface GroupingNodeKey extends BaseNodeKey {
108
- /**
109
- * Get the number of instances grouped by the node represented
110
- * by this key.
111
- *
112
- * **Note:** this property is just a helper and is not involved
113
- * in identifying a node.
114
- */
115
- groupedInstancesCount: number;
116
- }
117
- /**
118
- * Serialized [[GroupingNodeKey]] JSON representation.
119
- * @public
120
- */
121
- export interface GroupingNodeKeyJSON extends BaseNodeKeyJSON {
122
- groupedInstancesCount: number;
123
- }
124
- /**
125
- * Data structure that describes an ECClass grouping node key
126
- * @public
127
- */
128
- export interface ECClassGroupingNodeKey extends GroupingNodeKey {
129
- type: StandardNodeTypes.ECClassGroupingNode;
130
- /** Full name of the grouping ECClass */
131
- className: string;
132
- }
133
- /**
134
- * Serialized [[ECClassGroupingNodeKey]] JSON representation.
135
- * @public
136
- */
137
- export interface ECClassGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
138
- type: StandardNodeTypes.ECClassGroupingNode;
139
- className: string;
140
- }
141
- /**
142
- * Data structure that describes an ECProperty grouping node key
143
- * @public
144
- */
145
- export interface ECPropertyGroupingNodeKey extends GroupingNodeKey {
146
- type: StandardNodeTypes.ECPropertyGroupingNode;
147
- /** Full name of the grouping ECProperty class */
148
- className: string;
149
- /** Name of the ECProperty */
150
- propertyName: string;
151
- /** Raw grouping values */
152
- groupingValues: any[];
153
- }
154
- /**
155
- * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.
156
- * @public
157
- */
158
- export interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
159
- type: StandardNodeTypes.ECPropertyGroupingNode;
160
- className: string;
161
- propertyName: string;
162
- groupingValues: any[];
163
- }
164
- /**
165
- * Data structure that describes a display label grouping node key
166
- * @public
167
- */
168
- export interface LabelGroupingNodeKey extends GroupingNodeKey {
169
- type: StandardNodeTypes.DisplayLabelGroupingNode;
170
- /** Grouping display label */
171
- label: string;
172
- }
173
- /**
174
- * Serialized [[LabelGroupingNodeKey]] JSON representation.
175
- * @public
176
- */
177
- export interface LabelGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
178
- type: StandardNodeTypes.DisplayLabelGroupingNode;
179
- label: string;
180
- }
181
- /**
182
- * One of the serialized node key types
183
- * @public
184
- */
185
- export declare type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;
1
+ /** @packageDocumentation
2
+ * @module Hierarchies
3
+ */
4
+ import { InstanceKey, InstanceKeyJSON } from "../EC";
5
+ /**
6
+ * Standard node types
7
+ * @public
8
+ */
9
+ export declare enum StandardNodeTypes {
10
+ ECInstancesNode = "ECInstancesNode",
11
+ ECClassGroupingNode = "ECClassGroupingNode",
12
+ ECPropertyGroupingNode = "ECPropertyGroupingNode",
13
+ DisplayLabelGroupingNode = "DisplayLabelGroupingNode"
14
+ }
15
+ /**
16
+ * One of the node key types
17
+ * @public
18
+ */
19
+ export declare type NodeKey = BaseNodeKey | ECInstancesNodeKey | ECClassGroupingNodeKey | ECPropertyGroupingNodeKey | LabelGroupingNodeKey;
20
+ /** @public */
21
+ export declare namespace NodeKey {
22
+ /** Serialize given [[NodeKey]] to JSON */
23
+ function toJSON(key: NodeKey): NodeKeyJSON;
24
+ /** Deserialize node key from JSON */
25
+ function fromJSON(json: NodeKeyJSON): NodeKey;
26
+ /** Checks if the supplied key is an [[ECInstancesNodeKey]] */
27
+ function isInstancesNodeKey(key: NodeKey): key is ECInstancesNodeKey;
28
+ /** Checks if the supplied key is an [[ECInstancesNodeKey]] */
29
+ function isInstancesNodeKey(key: NodeKeyJSON): key is ECInstancesNodeKeyJSON;
30
+ /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */
31
+ function isClassGroupingNodeKey(key: NodeKey): key is ECClassGroupingNodeKey;
32
+ /** Checks if the supplied key is an [[ECClassGroupingNodeKey]] */
33
+ function isClassGroupingNodeKey(key: NodeKeyJSON): key is ECClassGroupingNodeKeyJSON;
34
+ /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */
35
+ function isPropertyGroupingNodeKey(key: NodeKey): key is ECPropertyGroupingNodeKey;
36
+ /** Checks if the supplied key is an [[ECPropertyGroupingNodeKey]] */
37
+ function isPropertyGroupingNodeKey(key: NodeKeyJSON): key is ECPropertyGroupingNodeKeyJSON;
38
+ /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */
39
+ function isLabelGroupingNodeKey(key: NodeKey): key is LabelGroupingNodeKey;
40
+ /** Checks if the supplied key is a [[LabelGroupingNodeKey]] */
41
+ function isLabelGroupingNodeKey(key: NodeKeyJSON): key is LabelGroupingNodeKeyJSON;
42
+ /** Checks if the supplied key is a grouping node key */
43
+ function isGroupingNodeKey(key: NodeKey): key is GroupingNodeKey;
44
+ /** Checks if the supplied key is a grouping node key */
45
+ function isGroupingNodeKey(key: NodeKeyJSON): key is GroupingNodeKeyJSON;
46
+ /**
47
+ * Checks if two given node keys are equal, taking their versions into account.
48
+ *
49
+ * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array
50
+ * which is the most accurate way of checking equality. However, when version are different,
51
+ * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.
52
+ * In that case equality is checked using other key attributes, depending on the type of the node (type,
53
+ * label, grouping class, property name, etc.).
54
+ */
55
+ function equals(lhs: NodeKey, rhs: NodeKey): boolean;
56
+ }
57
+ /**
58
+ * Node key path. Can be used to define path from one node to another.
59
+ * @public
60
+ */
61
+ export declare type NodeKeyPath = NodeKey[];
62
+ /**
63
+ * Data structure that describes a basic node key
64
+ * @public
65
+ */
66
+ export interface BaseNodeKey {
67
+ /** Node type */
68
+ type: string;
69
+ /**
70
+ * Version of the key. Different versions suggest that node keys were created by two different
71
+ * versions of the library. In that case, keys representing the same node may be different.
72
+ */
73
+ version: number;
74
+ /** Node hash path from root to the node whose key this is */
75
+ pathFromRoot: string[];
76
+ }
77
+ /**
78
+ * Serialized [[BaseNodeKey]] JSON representation.
79
+ * @public
80
+ */
81
+ export interface BaseNodeKeyJSON {
82
+ type: string;
83
+ version?: number;
84
+ pathFromRoot: string[];
85
+ }
86
+ /**
87
+ * Data structure that describes a node ECInstance node key
88
+ * @public
89
+ */
90
+ export interface ECInstancesNodeKey extends BaseNodeKey {
91
+ type: StandardNodeTypes.ECInstancesNode;
92
+ /** List of [[InstanceKey]] objects of ECInstances represented by the node */
93
+ instanceKeys: InstanceKey[];
94
+ }
95
+ /**
96
+ * Serialized [[ECInstancesNodeKey]] JSON representation.
97
+ * @public
98
+ */
99
+ export interface ECInstancesNodeKeyJSON extends BaseNodeKeyJSON {
100
+ type: StandardNodeTypes.ECInstancesNode;
101
+ instanceKeys: InstanceKeyJSON[];
102
+ }
103
+ /**
104
+ * Data structure that describes a grouping node key
105
+ * @public
106
+ */
107
+ export interface GroupingNodeKey extends BaseNodeKey {
108
+ /**
109
+ * Get the number of instances grouped by the node represented
110
+ * by this key.
111
+ *
112
+ * **Note:** this property is just a helper and is not involved
113
+ * in identifying a node.
114
+ */
115
+ groupedInstancesCount: number;
116
+ }
117
+ /**
118
+ * Serialized [[GroupingNodeKey]] JSON representation.
119
+ * @public
120
+ */
121
+ export interface GroupingNodeKeyJSON extends BaseNodeKeyJSON {
122
+ groupedInstancesCount: number;
123
+ }
124
+ /**
125
+ * Data structure that describes an ECClass grouping node key
126
+ * @public
127
+ */
128
+ export interface ECClassGroupingNodeKey extends GroupingNodeKey {
129
+ type: StandardNodeTypes.ECClassGroupingNode;
130
+ /** Full name of the grouping ECClass */
131
+ className: string;
132
+ }
133
+ /**
134
+ * Serialized [[ECClassGroupingNodeKey]] JSON representation.
135
+ * @public
136
+ */
137
+ export interface ECClassGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
138
+ type: StandardNodeTypes.ECClassGroupingNode;
139
+ className: string;
140
+ }
141
+ /**
142
+ * Data structure that describes an ECProperty grouping node key
143
+ * @public
144
+ */
145
+ export interface ECPropertyGroupingNodeKey extends GroupingNodeKey {
146
+ type: StandardNodeTypes.ECPropertyGroupingNode;
147
+ /** Full name of the grouping ECProperty class */
148
+ className: string;
149
+ /** Name of the ECProperty */
150
+ propertyName: string;
151
+ /** Raw grouping values */
152
+ groupingValues: any[];
153
+ }
154
+ /**
155
+ * Serialized [[ECPropertyGroupingNodeKey]] JSON representation.
156
+ * @public
157
+ */
158
+ export interface ECPropertyGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
159
+ type: StandardNodeTypes.ECPropertyGroupingNode;
160
+ className: string;
161
+ propertyName: string;
162
+ groupingValues: any[];
163
+ }
164
+ /**
165
+ * Data structure that describes a display label grouping node key
166
+ * @public
167
+ */
168
+ export interface LabelGroupingNodeKey extends GroupingNodeKey {
169
+ type: StandardNodeTypes.DisplayLabelGroupingNode;
170
+ /** Grouping display label */
171
+ label: string;
172
+ }
173
+ /**
174
+ * Serialized [[LabelGroupingNodeKey]] JSON representation.
175
+ * @public
176
+ */
177
+ export interface LabelGroupingNodeKeyJSON extends GroupingNodeKeyJSON {
178
+ type: StandardNodeTypes.DisplayLabelGroupingNode;
179
+ label: string;
180
+ }
181
+ /**
182
+ * One of the serialized node key types
183
+ * @public
184
+ */
185
+ export declare type NodeKeyJSON = BaseNodeKeyJSON | ECInstancesNodeKeyJSON | ECClassGroupingNodeKeyJSON | ECPropertyGroupingNodeKeyJSON | LabelGroupingNodeKeyJSON;
186
186
  //# sourceMappingURL=Key.d.ts.map
@@ -1,113 +1,113 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Hierarchies
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.NodeKey = exports.StandardNodeTypes = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const EC_1 = require("../EC");
13
- /**
14
- * Standard node types
15
- * @public
16
- */
17
- var StandardNodeTypes;
18
- (function (StandardNodeTypes) {
19
- StandardNodeTypes["ECInstancesNode"] = "ECInstancesNode";
20
- StandardNodeTypes["ECClassGroupingNode"] = "ECClassGroupingNode";
21
- StandardNodeTypes["ECPropertyGroupingNode"] = "ECPropertyGroupingNode";
22
- StandardNodeTypes["DisplayLabelGroupingNode"] = "DisplayLabelGroupingNode";
23
- })(StandardNodeTypes = exports.StandardNodeTypes || (exports.StandardNodeTypes = {}));
24
- /** @public */
25
- var NodeKey;
26
- (function (NodeKey) {
27
- /** Serialize given [[NodeKey]] to JSON */
28
- function toJSON(key) {
29
- if (isInstancesNodeKey(key))
30
- return { ...key, instanceKeys: key.instanceKeys.map(EC_1.InstanceKey.toJSON) };
31
- return { ...key };
32
- }
33
- NodeKey.toJSON = toJSON;
34
- /** Deserialize node key from JSON */
35
- function fromJSON(json) {
36
- if (isInstancesNodeKey(json))
37
- return { version: 1, ...json, instanceKeys: json.instanceKeys.map(EC_1.InstanceKey.fromJSON) };
38
- return { version: 1, ...json };
39
- }
40
- NodeKey.fromJSON = fromJSON;
41
- function isInstancesNodeKey(key) {
42
- return key.type === StandardNodeTypes.ECInstancesNode;
43
- }
44
- NodeKey.isInstancesNodeKey = isInstancesNodeKey;
45
- function isClassGroupingNodeKey(key) {
46
- return key.type === StandardNodeTypes.ECClassGroupingNode;
47
- }
48
- NodeKey.isClassGroupingNodeKey = isClassGroupingNodeKey;
49
- function isPropertyGroupingNodeKey(key) {
50
- return key.type === StandardNodeTypes.ECPropertyGroupingNode;
51
- }
52
- NodeKey.isPropertyGroupingNodeKey = isPropertyGroupingNodeKey;
53
- function isLabelGroupingNodeKey(key) {
54
- return key.type === StandardNodeTypes.DisplayLabelGroupingNode;
55
- }
56
- NodeKey.isLabelGroupingNodeKey = isLabelGroupingNodeKey;
57
- function isGroupingNodeKey(key) {
58
- return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key);
59
- }
60
- NodeKey.isGroupingNodeKey = isGroupingNodeKey;
61
- /**
62
- * Checks if two given node keys are equal, taking their versions into account.
63
- *
64
- * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array
65
- * which is the most accurate way of checking equality. However, when version are different,
66
- * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.
67
- * In that case equality is checked using other key attributes, depending on the type of the node (type,
68
- * label, grouping class, property name, etc.).
69
- */
70
- function equals(lhs, rhs) {
71
- // types must always be equal
72
- if (lhs.type !== rhs.type)
73
- return false;
74
- // `pathFromRoot` lengths must always be equal
75
- if (lhs.pathFromRoot.length !== rhs.pathFromRoot.length)
76
- return false;
77
- // when versions are equal, compare using contents of `pathFromRoot` array
78
- if (lhs.version === rhs.version) {
79
- for (let i = 0; i < lhs.pathFromRoot.length; ++i) {
80
- if (lhs.pathFromRoot[i] !== rhs.pathFromRoot[i])
81
- return false;
82
- }
83
- return true;
84
- }
85
- // when versions aren't equal, compare using other key information, because key hashes
86
- // of different key versions can't be compared
87
- if (isInstancesNodeKey(lhs)) {
88
- (0, core_bentley_1.assert)(isInstancesNodeKey(rhs));
89
- if (lhs.instanceKeys.length !== rhs.instanceKeys.length)
90
- return false;
91
- for (let i = 0; i < lhs.instanceKeys.length; ++i) {
92
- if (0 !== EC_1.InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]))
93
- return false;
94
- }
95
- return true;
96
- }
97
- if (isClassGroupingNodeKey(lhs)) {
98
- (0, core_bentley_1.assert)(isClassGroupingNodeKey(rhs));
99
- return lhs.className === rhs.className;
100
- }
101
- if (isPropertyGroupingNodeKey(lhs)) {
102
- (0, core_bentley_1.assert)(isPropertyGroupingNodeKey(rhs));
103
- return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;
104
- }
105
- if (isLabelGroupingNodeKey(lhs)) {
106
- (0, core_bentley_1.assert)(isLabelGroupingNodeKey(rhs));
107
- return lhs.label === rhs.label;
108
- }
109
- return true;
110
- }
111
- NodeKey.equals = equals;
112
- })(NodeKey = exports.NodeKey || (exports.NodeKey = {}));
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module Hierarchies
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.NodeKey = exports.StandardNodeTypes = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const EC_1 = require("../EC");
13
+ /**
14
+ * Standard node types
15
+ * @public
16
+ */
17
+ var StandardNodeTypes;
18
+ (function (StandardNodeTypes) {
19
+ StandardNodeTypes["ECInstancesNode"] = "ECInstancesNode";
20
+ StandardNodeTypes["ECClassGroupingNode"] = "ECClassGroupingNode";
21
+ StandardNodeTypes["ECPropertyGroupingNode"] = "ECPropertyGroupingNode";
22
+ StandardNodeTypes["DisplayLabelGroupingNode"] = "DisplayLabelGroupingNode";
23
+ })(StandardNodeTypes = exports.StandardNodeTypes || (exports.StandardNodeTypes = {}));
24
+ /** @public */
25
+ var NodeKey;
26
+ (function (NodeKey) {
27
+ /** Serialize given [[NodeKey]] to JSON */
28
+ function toJSON(key) {
29
+ if (isInstancesNodeKey(key))
30
+ return { ...key, instanceKeys: key.instanceKeys.map(EC_1.InstanceKey.toJSON) };
31
+ return { ...key };
32
+ }
33
+ NodeKey.toJSON = toJSON;
34
+ /** Deserialize node key from JSON */
35
+ function fromJSON(json) {
36
+ if (isInstancesNodeKey(json))
37
+ return { version: 1, ...json, instanceKeys: json.instanceKeys.map(EC_1.InstanceKey.fromJSON) };
38
+ return { version: 1, ...json };
39
+ }
40
+ NodeKey.fromJSON = fromJSON;
41
+ function isInstancesNodeKey(key) {
42
+ return key.type === StandardNodeTypes.ECInstancesNode;
43
+ }
44
+ NodeKey.isInstancesNodeKey = isInstancesNodeKey;
45
+ function isClassGroupingNodeKey(key) {
46
+ return key.type === StandardNodeTypes.ECClassGroupingNode;
47
+ }
48
+ NodeKey.isClassGroupingNodeKey = isClassGroupingNodeKey;
49
+ function isPropertyGroupingNodeKey(key) {
50
+ return key.type === StandardNodeTypes.ECPropertyGroupingNode;
51
+ }
52
+ NodeKey.isPropertyGroupingNodeKey = isPropertyGroupingNodeKey;
53
+ function isLabelGroupingNodeKey(key) {
54
+ return key.type === StandardNodeTypes.DisplayLabelGroupingNode;
55
+ }
56
+ NodeKey.isLabelGroupingNodeKey = isLabelGroupingNodeKey;
57
+ function isGroupingNodeKey(key) {
58
+ return isClassGroupingNodeKey(key) || isPropertyGroupingNodeKey(key) || isLabelGroupingNodeKey(key);
59
+ }
60
+ NodeKey.isGroupingNodeKey = isGroupingNodeKey;
61
+ /**
62
+ * Checks if two given node keys are equal, taking their versions into account.
63
+ *
64
+ * When comparing two keys of the same version, the algorithm uses [[NodeKey.pathFromRoot]] array
65
+ * which is the most accurate way of checking equality. However, when version are different,
66
+ * [[NodeKey.pathFromRoot]] array may contain different strings even though keys represent the same node.
67
+ * In that case equality is checked using other key attributes, depending on the type of the node (type,
68
+ * label, grouping class, property name, etc.).
69
+ */
70
+ function equals(lhs, rhs) {
71
+ // types must always be equal
72
+ if (lhs.type !== rhs.type)
73
+ return false;
74
+ // `pathFromRoot` lengths must always be equal
75
+ if (lhs.pathFromRoot.length !== rhs.pathFromRoot.length)
76
+ return false;
77
+ // when versions are equal, compare using contents of `pathFromRoot` array
78
+ if (lhs.version === rhs.version) {
79
+ for (let i = 0; i < lhs.pathFromRoot.length; ++i) {
80
+ if (lhs.pathFromRoot[i] !== rhs.pathFromRoot[i])
81
+ return false;
82
+ }
83
+ return true;
84
+ }
85
+ // when versions aren't equal, compare using other key information, because key hashes
86
+ // of different key versions can't be compared
87
+ if (isInstancesNodeKey(lhs)) {
88
+ (0, core_bentley_1.assert)(isInstancesNodeKey(rhs));
89
+ if (lhs.instanceKeys.length !== rhs.instanceKeys.length)
90
+ return false;
91
+ for (let i = 0; i < lhs.instanceKeys.length; ++i) {
92
+ if (0 !== EC_1.InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]))
93
+ return false;
94
+ }
95
+ return true;
96
+ }
97
+ if (isClassGroupingNodeKey(lhs)) {
98
+ (0, core_bentley_1.assert)(isClassGroupingNodeKey(rhs));
99
+ return lhs.className === rhs.className;
100
+ }
101
+ if (isPropertyGroupingNodeKey(lhs)) {
102
+ (0, core_bentley_1.assert)(isPropertyGroupingNodeKey(rhs));
103
+ return lhs.className === rhs.className && lhs.propertyName === rhs.propertyName;
104
+ }
105
+ if (isLabelGroupingNodeKey(lhs)) {
106
+ (0, core_bentley_1.assert)(isLabelGroupingNodeKey(rhs));
107
+ return lhs.label === rhs.label;
108
+ }
109
+ return true;
110
+ }
111
+ NodeKey.equals = equals;
112
+ })(NodeKey = exports.NodeKey || (exports.NodeKey = {}));
113
113
  //# sourceMappingURL=Key.js.map