@itwin/presentation-common 3.6.0-dev.36 → 3.6.0-dev.38

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