@itwin/presentation-common 4.0.0-dev.8 → 4.0.0-dev.80

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 (417) hide show
  1. package/CHANGELOG.md +51 -1
  2. package/Ruleset.schema.json +11 -0
  3. package/lib/cjs/assets/locales/en/Presentation.json +15 -0
  4. package/lib/cjs/assets/locales/en-PSEUDO/Presentation.json +15 -0
  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/CommonLoggerCategory.d.ts +12 -12
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  9. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  10. package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
  11. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  12. package/lib/cjs/presentation-common/EC.d.ts +347 -350
  13. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  14. package/lib/cjs/presentation-common/EC.js +290 -290
  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.d.ts.map +1 -1
  18. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  19. package/lib/cjs/presentation-common/Error.d.ts +47 -45
  20. package/lib/cjs/presentation-common/Error.d.ts.map +1 -1
  21. package/lib/cjs/presentation-common/Error.js +64 -62
  22. package/lib/cjs/presentation-common/Error.js.map +1 -1
  23. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  25. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  26. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  27. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  28. package/lib/cjs/presentation-common/KeySet.js +428 -428
  29. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -87
  30. package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
  31. package/lib/cjs/presentation-common/LabelDefinition.js +78 -73
  32. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  33. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  34. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  35. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  36. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  37. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -261
  38. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  39. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  40. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  41. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
  42. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  43. package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
  44. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  45. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +31 -0
  46. package/lib/cjs/presentation-common/PropertyFormatter.d.ts.map +1 -0
  47. package/lib/cjs/presentation-common/PropertyFormatter.js +199 -0
  48. package/lib/cjs/presentation-common/PropertyFormatter.js.map +1 -0
  49. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  50. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  51. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -83
  52. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  53. package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -171
  54. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  55. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  56. package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
  57. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  58. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  59. package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
  60. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  61. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  62. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  63. package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
  64. package/lib/cjs/presentation-common/Update.js +226 -226
  65. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  66. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  67. package/lib/cjs/presentation-common/Utils.js +43 -43
  68. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  69. package/lib/cjs/presentation-common/content/Category.js +48 -48
  70. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  71. package/lib/cjs/presentation-common/content/Content.js +56 -56
  72. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  73. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -439
  74. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  75. package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
  76. package/lib/cjs/presentation-common/content/Descriptor.js +191 -193
  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/Editor.d.ts +15 -15
  81. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  82. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -301
  83. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  84. package/lib/cjs/presentation-common/content/Fields.js +393 -397
  85. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  86. package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
  87. package/lib/cjs/presentation-common/content/Item.d.ts.map +1 -1
  88. package/lib/cjs/presentation-common/content/Item.js +84 -84
  89. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  90. package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
  91. package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
  92. package/lib/cjs/presentation-common/content/Property.js +40 -40
  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/TypeDescription.d.ts +72 -72
  96. package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
  97. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  98. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  99. package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
  100. package/lib/cjs/presentation-common/content/Value.js +273 -273
  101. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  102. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
  103. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  104. package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
  105. package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
  106. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  107. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
  108. package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
  109. package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
  110. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  111. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  112. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
  113. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  114. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  115. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  116. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  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/RelationshipPathSpecification.d.ts +56 -56
  120. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  121. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  122. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  123. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  124. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  125. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  126. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  127. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  128. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  129. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  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/ContentRelatedInstancesSpecification.d.ts +25 -25
  133. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  134. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  135. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  136. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  137. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  138. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  139. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  140. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  141. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  142. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  143. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  144. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  145. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  146. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  147. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  148. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  149. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  150. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  151. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  152. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  153. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  154. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  155. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  156. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  157. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  158. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  159. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  160. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  161. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  162. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  163. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  164. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  165. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  166. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  167. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  168. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  169. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  170. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  171. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  172. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  173. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  174. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  175. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  176. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  177. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  178. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  179. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  180. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  181. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  182. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  183. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  184. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  185. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  186. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  187. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  188. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  189. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  190. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  191. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  192. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  193. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  194. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  195. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  196. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  197. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  198. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  199. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  200. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  201. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  202. package/lib/cjs/presentation-common.d.ts +113 -112
  203. package/lib/cjs/presentation-common.d.ts.map +1 -1
  204. package/lib/cjs/presentation-common.js +133 -128
  205. package/lib/cjs/presentation-common.js.map +1 -1
  206. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  207. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  208. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  209. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  210. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  211. package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
  212. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  213. package/lib/esm/presentation-common/EC.d.ts +347 -350
  214. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  215. package/lib/esm/presentation-common/EC.js +287 -287
  216. package/lib/esm/presentation-common/EC.js.map +1 -1
  217. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  218. package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
  219. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  220. package/lib/esm/presentation-common/Error.d.ts +47 -45
  221. package/lib/esm/presentation-common/Error.d.ts.map +1 -1
  222. package/lib/esm/presentation-common/Error.js +60 -58
  223. package/lib/esm/presentation-common/Error.js.map +1 -1
  224. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  225. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  226. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  227. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  228. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  229. package/lib/esm/presentation-common/KeySet.js +424 -424
  230. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -87
  231. package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
  232. package/lib/esm/presentation-common/LabelDefinition.js +75 -70
  233. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  234. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  235. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  236. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  237. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  238. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -261
  239. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  240. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  241. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  242. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  243. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  244. package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
  245. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  246. package/lib/esm/presentation-common/PropertyFormatter.d.ts +31 -0
  247. package/lib/esm/presentation-common/PropertyFormatter.d.ts.map +1 -0
  248. package/lib/esm/presentation-common/PropertyFormatter.js +194 -0
  249. package/lib/esm/presentation-common/PropertyFormatter.js.map +1 -0
  250. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  251. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  252. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -83
  253. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  254. package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -167
  255. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  256. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  257. package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
  258. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  259. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  260. package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
  261. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  262. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  263. package/lib/esm/presentation-common/Update.d.ts +213 -213
  264. package/lib/esm/presentation-common/Update.d.ts.map +1 -1
  265. package/lib/esm/presentation-common/Update.js +223 -223
  266. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  267. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  268. package/lib/esm/presentation-common/Utils.js +39 -39
  269. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  270. package/lib/esm/presentation-common/content/Category.js +45 -45
  271. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  272. package/lib/esm/presentation-common/content/Content.js +52 -52
  273. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  274. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -429
  275. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  276. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  277. package/lib/esm/presentation-common/content/Descriptor.js +187 -189
  278. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  279. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  280. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  281. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  282. package/lib/esm/presentation-common/content/Editor.js +8 -8
  283. package/lib/esm/presentation-common/content/Fields.d.ts +298 -301
  284. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  285. package/lib/esm/presentation-common/content/Fields.js +386 -390
  286. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  287. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  288. package/lib/esm/presentation-common/content/Item.d.ts.map +1 -1
  289. package/lib/esm/presentation-common/content/Item.js +80 -80
  290. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  291. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  292. package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
  293. package/lib/esm/presentation-common/content/Property.js +37 -37
  294. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  295. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  296. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  297. package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
  298. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  299. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  300. package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
  301. package/lib/esm/presentation-common/content/Value.js +270 -270
  302. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  303. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  304. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  305. package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
  306. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  307. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  308. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  309. package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
  310. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  311. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  312. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  313. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  314. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  315. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  316. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  317. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  318. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  319. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  320. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  321. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  322. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  323. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  324. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  325. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  326. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  327. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  328. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  329. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  330. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  331. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  332. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  333. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  334. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  335. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  336. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  337. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  338. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  339. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  340. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  341. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  342. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  343. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  344. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  345. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  346. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  347. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  348. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  349. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  350. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  351. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  352. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  353. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  354. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  355. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  356. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  357. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  358. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  359. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  360. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  361. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  362. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  363. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  364. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  365. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  366. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  367. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  368. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  369. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  370. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  371. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  372. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  373. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  374. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  375. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  376. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  377. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  378. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  379. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  380. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  381. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  382. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  383. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  384. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  385. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  386. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  387. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  388. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  389. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  390. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  391. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  392. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  393. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  394. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  395. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  396. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  397. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  398. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  399. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  400. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  401. package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  402. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  403. package/lib/esm/presentation-common.d.ts +113 -112
  404. package/lib/esm/presentation-common.d.ts.map +1 -1
  405. package/lib/esm/presentation-common.js +117 -116
  406. package/lib/esm/presentation-common.js.map +1 -1
  407. package/lib/public/locales/en/Presentation.json +15 -0
  408. package/package.json +17 -15
  409. package/lib/cjs/assets/locales/en/BisCore.json +0 -18
  410. package/lib/cjs/assets/locales/en/ECPresentation.json +0 -9
  411. package/lib/cjs/assets/locales/en/RulesEngine.json +0 -6
  412. package/lib/cjs/assets/locales/en-PSEUDO/BisCore.json +0 -18
  413. package/lib/cjs/assets/locales/en-PSEUDO/ECPresentation.json +0 -9
  414. package/lib/cjs/assets/locales/en-PSEUDO/RulesEngine.json +0 -6
  415. package/lib/public/locales/en/BisCore.json +0 -18
  416. package/lib/public/locales/en/ECPresentation.json +0 -9
  417. package/lib/public/locales/en/RulesEngine.json +0 -6
@@ -1,425 +1,425 @@
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 Core
7
- */
8
- import { CompressedId64Set, Guid, Id64 } from "@itwin/core-bentley";
9
- import { PresentationError, PresentationStatus } from "./Error";
10
- import { NodeKey } from "./hierarchy/Key";
11
- /** @public */
12
- export var Key;
13
- (function (Key) {
14
- /** Check if the supplied key is a `NodeKey` */
15
- function isNodeKey(key) {
16
- return !!key.type;
17
- }
18
- Key.isNodeKey = isNodeKey;
19
- /** Check if the supplied key is an `InstanceKey` */
20
- function isInstanceKey(key) {
21
- return !!key.className && !!key.id;
22
- }
23
- Key.isInstanceKey = isInstanceKey;
24
- /** Check if the supplied key is an `EntityProps` */
25
- function isEntityProps(key) {
26
- return !!key.classFullName && !!key.id;
27
- }
28
- Key.isEntityProps = isEntityProps;
29
- })(Key || (Key = {}));
30
- /**
31
- * A class that holds multiple [[Key]] objects. It's basically
32
- * used as a container that holds multiple keys of different types.
33
- *
34
- * @public
35
- */
36
- export class KeySet {
37
- /**
38
- * Creates an instance of KeySet.
39
- * @param source Optional source to initialize from.
40
- */
41
- constructor(source) {
42
- this._instanceKeys = new Map();
43
- this._lowerCaseMap = new Map();
44
- this._nodeKeys = new Set();
45
- this.recalculateGuid();
46
- if (source)
47
- this.add(source);
48
- }
49
- recalculateGuid() {
50
- // empty keyset should have empty guid, otherwise use a random guid value
51
- this._guid = this.isEmpty ? Guid.empty : Guid.createValue();
52
- }
53
- /**
54
- * Get a GUID that identifies changes in this keyset. The value
55
- * does not uniquely identify contents of the keyset, but it can be
56
- * used to check whether keyset has changed.
57
- */
58
- get guid() { return this._guid; }
59
- /**
60
- * Get a map of instance keys stored in this KeySet
61
- *
62
- * **Warning**: getting instance keys might be expensive for
63
- * large KeySets.
64
- */
65
- get instanceKeys() {
66
- const map = new Map();
67
- for (const entry of this._instanceKeys)
68
- map.set(this._lowerCaseMap.get(entry["0"]), new Set([...entry["1"]].map((key) => Id64.fromJSON(key))));
69
- return map;
70
- }
71
- /**
72
- * Get instance keys count
73
- */
74
- get instanceKeysCount() {
75
- let count = 0;
76
- this._instanceKeys.forEach((set) => count += set.size);
77
- return count;
78
- }
79
- /**
80
- * Get a set of node keys stored in this KeySet
81
- *
82
- * **Warning**: getting node keys might be expensive for
83
- * large KeySets.
84
- */
85
- get nodeKeys() {
86
- const set = new Set();
87
- for (const serialized of this._nodeKeys) {
88
- // eslint-disable-next-line deprecation/deprecation
89
- const key = NodeKey.fromJSON(JSON.parse(serialized));
90
- set.add(key);
91
- }
92
- return set;
93
- }
94
- /**
95
- * Get node keys count
96
- */
97
- get nodeKeysCount() {
98
- return this._nodeKeys.size;
99
- }
100
- isKeySet(set) {
101
- return !!set._nodeKeys && !!set._instanceKeys;
102
- }
103
- isKeysArray(keys) {
104
- return Array.isArray(keys);
105
- }
106
- /**
107
- * Clear this KeySet.
108
- * @returns itself
109
- */
110
- clear() {
111
- if (this.isEmpty)
112
- return this;
113
- this._instanceKeys = new Map();
114
- this._lowerCaseMap = new Map();
115
- this._nodeKeys = new Set();
116
- this.recalculateGuid();
117
- return this;
118
- }
119
- addKeySet(keyset, pred) {
120
- for (const key of keyset._nodeKeys) {
121
- // eslint-disable-next-line deprecation/deprecation
122
- if (!pred || pred(NodeKey.fromJSON(JSON.parse(key))))
123
- this._nodeKeys.add(key);
124
- }
125
- for (const entry of keyset._instanceKeys) {
126
- let set = this._instanceKeys.get(entry["0"]);
127
- const className = keyset._lowerCaseMap.get(entry["0"]);
128
- if (!set) {
129
- set = new Set();
130
- this._instanceKeys.set(entry["0"], set);
131
- this._lowerCaseMap.set(entry["0"], className);
132
- }
133
- entry["1"].forEach((id) => {
134
- if (!pred || pred({ className, id }))
135
- set.add(id);
136
- });
137
- }
138
- }
139
- addKeySetJSON(keyset) {
140
- for (const key of keyset.nodeKeys)
141
- this._nodeKeys.add(JSON.stringify(key));
142
- for (const entry of keyset.instanceKeys) {
143
- const lcClassName = entry["0"].toLowerCase();
144
- const idsJson = entry["1"];
145
- const ids = typeof idsJson === "string"
146
- ? idsJson === Id64.invalid
147
- ? new Set([Id64.invalid])
148
- : CompressedId64Set.decompressSet(idsJson)
149
- : new Set(idsJson);
150
- this._instanceKeys.set(lcClassName, ids);
151
- this._lowerCaseMap.set(lcClassName, entry["0"]);
152
- }
153
- }
154
- /**
155
- * Add a key or keys to this KeySet.
156
- * @param value A key or keys to add.
157
- * @param pred An optional predicate function that indicates whether a key should be added
158
- * @returns itself
159
- */
160
- add(value, pred) {
161
- if (!value)
162
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
163
- const sizeBefore = this.size;
164
- if (this.isKeySet(value)) {
165
- this.addKeySet(value, pred);
166
- }
167
- else if (this.isKeysArray(value)) {
168
- value.forEach((key) => this.add(key, pred));
169
- }
170
- else if (!pred || pred(value)) {
171
- if (Key.isEntityProps(value)) {
172
- this.add({ className: value.classFullName, id: Id64.fromJSON(value.id) });
173
- }
174
- else if (Key.isInstanceKey(value)) {
175
- const lcClassName = value.className.toLowerCase();
176
- if (!this._instanceKeys.has(lcClassName)) {
177
- this._instanceKeys.set(lcClassName, new Set());
178
- this._lowerCaseMap.set(lcClassName, value.className);
179
- }
180
- this._lowerCaseMap.set(lcClassName, value.className);
181
- this._instanceKeys.get(lcClassName).add(value.id);
182
- }
183
- else if (Key.isNodeKey(value)) {
184
- this._nodeKeys.add(JSON.stringify(value));
185
- }
186
- else {
187
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
188
- }
189
- }
190
- if (this.size !== sizeBefore)
191
- this.recalculateGuid();
192
- return this;
193
- }
194
- deleteKeySet(keyset) {
195
- for (const key of keyset._nodeKeys)
196
- this._nodeKeys.delete(key);
197
- for (const entry of keyset._instanceKeys) {
198
- const set = this._instanceKeys.get(entry["0"].toLowerCase());
199
- if (set) {
200
- entry["1"].forEach((key) => {
201
- set.delete(key);
202
- });
203
- }
204
- }
205
- }
206
- /**
207
- * Deletes a key or keys from this KeySet.
208
- * @param value A key or keys to delete.
209
- * @returns itself
210
- */
211
- delete(value) {
212
- if (!value)
213
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
214
- const sizeBefore = this.size;
215
- if (this.isKeySet(value)) {
216
- this.deleteKeySet(value);
217
- }
218
- else if (this.isKeysArray(value)) {
219
- for (const key of value)
220
- this.delete(key);
221
- }
222
- else if (Key.isEntityProps(value)) {
223
- this.delete({ className: value.classFullName, id: value.id });
224
- }
225
- else if (Key.isInstanceKey(value)) {
226
- const set = this._instanceKeys.get(value.className.toLowerCase());
227
- if (set)
228
- set.delete(value.id);
229
- }
230
- else if (Key.isNodeKey(value)) {
231
- this._nodeKeys.delete(JSON.stringify(value));
232
- }
233
- else {
234
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
235
- }
236
- if (this.size !== sizeBefore)
237
- this.recalculateGuid();
238
- return this;
239
- }
240
- /**
241
- * Check if this KeySet contains the specified key.
242
- * @param value The key to check.
243
- */
244
- has(value) {
245
- if (!value)
246
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
247
- if (Key.isEntityProps(value))
248
- return this.has({ className: value.classFullName, id: value.id });
249
- if (Key.isInstanceKey(value)) {
250
- const set = this._instanceKeys.get(value.className.toLowerCase());
251
- return !!(set && set.has(value.id));
252
- }
253
- if (Key.isNodeKey(value))
254
- return this._nodeKeys.has(JSON.stringify(value));
255
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
256
- }
257
- hasKeySet(readonlyKeys, checkType) {
258
- // note: cast-away read-onlyness to access private members...
259
- const keys = readonlyKeys;
260
- if (checkType === "all") {
261
- if (this._nodeKeys.size < keys._nodeKeys.size || this._instanceKeys.size < keys._instanceKeys.size)
262
- return false;
263
- if ([...keys._nodeKeys].some((key) => !this._nodeKeys.has(key)))
264
- return false;
265
- for (const otherEntry of keys._instanceKeys) {
266
- const thisEntryKeys = this._instanceKeys.get(otherEntry["0"].toLowerCase());
267
- if (!thisEntryKeys || thisEntryKeys.size < otherEntry["1"].size)
268
- return false;
269
- if ([...otherEntry["1"]].some((key) => !thisEntryKeys.has(key)))
270
- return false;
271
- }
272
- return true;
273
- }
274
- // "any" check type
275
- if ([...keys._nodeKeys].some((key) => this._nodeKeys.has(key)))
276
- return true;
277
- for (const otherEntry of keys._instanceKeys) {
278
- const thisEntryKeys = this._instanceKeys.get(otherEntry["0"].toLowerCase());
279
- if (thisEntryKeys && [...otherEntry["1"]].some((key) => thisEntryKeys.has(key)))
280
- return true;
281
- }
282
- return false;
283
- }
284
- hasKeysArray(keys, checkType) {
285
- if (checkType === "all") {
286
- if (this.size < keys.length)
287
- return false;
288
- for (const key of keys) {
289
- if (!this.has(key))
290
- return false;
291
- }
292
- return true;
293
- }
294
- // "any" check type
295
- for (const key of keys) {
296
- if (this.has(key))
297
- return true;
298
- }
299
- return false;
300
- }
301
- /**
302
- * Check if this KeySet contains all the specified keys.
303
- * @param keys The keys to check.
304
- */
305
- hasAll(keys) {
306
- if (!keys)
307
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${keys}`);
308
- if (this.isKeySet(keys))
309
- return this.hasKeySet(keys, "all");
310
- if (this.isKeysArray(keys))
311
- return this.hasKeysArray(keys, "all");
312
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: keys = ${keys}`);
313
- }
314
- /**
315
- * Check if this KeySet contains any of the specified keys.
316
- * @param keys The keys to check.
317
- */
318
- hasAny(keys) {
319
- if (!keys)
320
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${keys}`);
321
- if (this.isKeySet(keys))
322
- return this.hasKeySet(keys, "any");
323
- if (this.isKeysArray(keys))
324
- return this.hasKeysArray(keys, "any");
325
- throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: keys = ${keys}`);
326
- }
327
- /**
328
- * Get the number of keys stored in this KeySet.
329
- */
330
- get size() {
331
- const nodeKeysCount = this._nodeKeys.size;
332
- let instanceIdsCount = 0;
333
- for (const set of this._instanceKeys.values())
334
- instanceIdsCount += set.size;
335
- return nodeKeysCount + instanceIdsCount;
336
- }
337
- /**
338
- * Is this KeySet currently empty.
339
- */
340
- get isEmpty() {
341
- return 0 === this.size;
342
- }
343
- /** Iterate over all keys in this keyset. */
344
- some(callback) {
345
- for (const entry of this._instanceKeys) {
346
- const className = this._lowerCaseMap.get(entry["0"].toLowerCase());
347
- if (some(entry[1], (id) => callback({ className, id })))
348
- return true;
349
- }
350
- // eslint-disable-next-line deprecation/deprecation
351
- return some(this._nodeKeys, (serializedKey) => callback(NodeKey.fromJSON(JSON.parse(serializedKey))));
352
- }
353
- /** Iterate over all keys in this keyset. */
354
- forEach(callback) {
355
- let index = 0;
356
- this._instanceKeys.forEach((ids, className) => {
357
- const recentClassName = this._lowerCaseMap.get(className.toLowerCase());
358
- ids.forEach((id) => callback({ className: recentClassName, id }, index++));
359
- });
360
- this._nodeKeys.forEach((serializedKey) => {
361
- // eslint-disable-next-line deprecation/deprecation
362
- callback(NodeKey.fromJSON(JSON.parse(serializedKey)), index++);
363
- });
364
- }
365
- /** Iterate over all keys in this keyset in batches */
366
- forEachBatch(batchSize, callback) {
367
- const size = this.size;
368
- const count = Math.ceil(size / batchSize);
369
- if (1 === count) {
370
- callback(this, 0);
371
- return;
372
- }
373
- let batch = new KeySet();
374
- let batchIndex = 0;
375
- let currBatchSize = 0;
376
- this.forEach((key, index) => {
377
- batch.add(key);
378
- ++currBatchSize;
379
- if (currBatchSize === batchSize || index === (size - 1)) {
380
- callback(batch, batchIndex++);
381
- batch = new KeySet();
382
- currBatchSize = 0;
383
- }
384
- });
385
- }
386
- /**
387
- * Serializes this KeySet to JSON
388
- * @public
389
- */
390
- toJSON() {
391
- const instanceKeys = [];
392
- for (const entry of this._instanceKeys.entries()) {
393
- if (entry["1"].size > 0) {
394
- const className = this._lowerCaseMap.get(entry["0"].toLowerCase());
395
- const compressedIds = CompressedId64Set.sortAndCompress(entry["1"]);
396
- instanceKeys.push([className, compressedIds.length > 0 ? compressedIds : Id64.invalid]);
397
- }
398
- }
399
- // eslint-disable-next-line deprecation/deprecation
400
- const nodeKeys = [];
401
- for (const serializedKey of this._nodeKeys.values())
402
- nodeKeys.push(JSON.parse(serializedKey));
403
- return {
404
- instanceKeys,
405
- nodeKeys,
406
- };
407
- }
408
- /**
409
- * Creates a KeySet from JSON
410
- * @public
411
- */
412
- static fromJSON(json) {
413
- const keyset = new KeySet();
414
- keyset.addKeySetJSON(json);
415
- return keyset;
416
- }
417
- }
418
- const some = (set, cb) => {
419
- for (const item of set) {
420
- if (cb(item))
421
- return true;
422
- }
423
- return false;
424
- };
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 Core
7
+ */
8
+ import { CompressedId64Set, Guid, Id64 } from "@itwin/core-bentley";
9
+ import { PresentationError, PresentationStatus } from "./Error";
10
+ import { NodeKey } from "./hierarchy/Key";
11
+ /** @public */
12
+ export var Key;
13
+ (function (Key) {
14
+ /** Check if the supplied key is a `NodeKey` */
15
+ function isNodeKey(key) {
16
+ return !!key.type;
17
+ }
18
+ Key.isNodeKey = isNodeKey;
19
+ /** Check if the supplied key is an `InstanceKey` */
20
+ function isInstanceKey(key) {
21
+ return !!key.className && !!key.id;
22
+ }
23
+ Key.isInstanceKey = isInstanceKey;
24
+ /** Check if the supplied key is an `EntityProps` */
25
+ function isEntityProps(key) {
26
+ return !!key.classFullName && !!key.id;
27
+ }
28
+ Key.isEntityProps = isEntityProps;
29
+ })(Key || (Key = {}));
30
+ /**
31
+ * A class that holds multiple [[Key]] objects. It's basically
32
+ * used as a container that holds multiple keys of different types.
33
+ *
34
+ * @public
35
+ */
36
+ export class KeySet {
37
+ /**
38
+ * Creates an instance of KeySet.
39
+ * @param source Optional source to initialize from.
40
+ */
41
+ constructor(source) {
42
+ this._instanceKeys = new Map();
43
+ this._lowerCaseMap = new Map();
44
+ this._nodeKeys = new Set();
45
+ this.recalculateGuid();
46
+ if (source)
47
+ this.add(source);
48
+ }
49
+ recalculateGuid() {
50
+ // empty keyset should have empty guid, otherwise use a random guid value
51
+ this._guid = this.isEmpty ? Guid.empty : Guid.createValue();
52
+ }
53
+ /**
54
+ * Get a GUID that identifies changes in this keyset. The value
55
+ * does not uniquely identify contents of the keyset, but it can be
56
+ * used to check whether keyset has changed.
57
+ */
58
+ get guid() { return this._guid; }
59
+ /**
60
+ * Get a map of instance keys stored in this KeySet
61
+ *
62
+ * **Warning**: getting instance keys might be expensive for
63
+ * large KeySets.
64
+ */
65
+ get instanceKeys() {
66
+ const map = new Map();
67
+ for (const entry of this._instanceKeys)
68
+ map.set(this._lowerCaseMap.get(entry["0"]), new Set([...entry["1"]].map((key) => Id64.fromJSON(key))));
69
+ return map;
70
+ }
71
+ /**
72
+ * Get instance keys count
73
+ */
74
+ get instanceKeysCount() {
75
+ let count = 0;
76
+ this._instanceKeys.forEach((set) => count += set.size);
77
+ return count;
78
+ }
79
+ /**
80
+ * Get a set of node keys stored in this KeySet
81
+ *
82
+ * **Warning**: getting node keys might be expensive for
83
+ * large KeySets.
84
+ */
85
+ get nodeKeys() {
86
+ const set = new Set();
87
+ for (const serialized of this._nodeKeys) {
88
+ // eslint-disable-next-line deprecation/deprecation
89
+ const key = NodeKey.fromJSON(JSON.parse(serialized));
90
+ set.add(key);
91
+ }
92
+ return set;
93
+ }
94
+ /**
95
+ * Get node keys count
96
+ */
97
+ get nodeKeysCount() {
98
+ return this._nodeKeys.size;
99
+ }
100
+ isKeySet(set) {
101
+ return !!set._nodeKeys && !!set._instanceKeys;
102
+ }
103
+ isKeysArray(keys) {
104
+ return Array.isArray(keys);
105
+ }
106
+ /**
107
+ * Clear this KeySet.
108
+ * @returns itself
109
+ */
110
+ clear() {
111
+ if (this.isEmpty)
112
+ return this;
113
+ this._instanceKeys = new Map();
114
+ this._lowerCaseMap = new Map();
115
+ this._nodeKeys = new Set();
116
+ this.recalculateGuid();
117
+ return this;
118
+ }
119
+ addKeySet(keyset, pred) {
120
+ for (const key of keyset._nodeKeys) {
121
+ // eslint-disable-next-line deprecation/deprecation
122
+ if (!pred || pred(NodeKey.fromJSON(JSON.parse(key))))
123
+ this._nodeKeys.add(key);
124
+ }
125
+ for (const entry of keyset._instanceKeys) {
126
+ let set = this._instanceKeys.get(entry["0"]);
127
+ const className = keyset._lowerCaseMap.get(entry["0"]);
128
+ if (!set) {
129
+ set = new Set();
130
+ this._instanceKeys.set(entry["0"], set);
131
+ this._lowerCaseMap.set(entry["0"], className);
132
+ }
133
+ entry["1"].forEach((id) => {
134
+ if (!pred || pred({ className, id }))
135
+ set.add(id);
136
+ });
137
+ }
138
+ }
139
+ addKeySetJSON(keyset) {
140
+ for (const key of keyset.nodeKeys)
141
+ this._nodeKeys.add(JSON.stringify(key));
142
+ for (const entry of keyset.instanceKeys) {
143
+ const lcClassName = entry["0"].toLowerCase();
144
+ const idsJson = entry["1"];
145
+ const ids = typeof idsJson === "string"
146
+ ? idsJson === Id64.invalid
147
+ ? new Set([Id64.invalid])
148
+ : CompressedId64Set.decompressSet(idsJson)
149
+ : new Set(idsJson);
150
+ this._instanceKeys.set(lcClassName, ids);
151
+ this._lowerCaseMap.set(lcClassName, entry["0"]);
152
+ }
153
+ }
154
+ /**
155
+ * Add a key or keys to this KeySet.
156
+ * @param value A key or keys to add.
157
+ * @param pred An optional predicate function that indicates whether a key should be added
158
+ * @returns itself
159
+ */
160
+ add(value, pred) {
161
+ if (!value)
162
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
163
+ const sizeBefore = this.size;
164
+ if (this.isKeySet(value)) {
165
+ this.addKeySet(value, pred);
166
+ }
167
+ else if (this.isKeysArray(value)) {
168
+ value.forEach((key) => this.add(key, pred));
169
+ }
170
+ else if (!pred || pred(value)) {
171
+ if (Key.isEntityProps(value)) {
172
+ this.add({ className: value.classFullName, id: Id64.fromJSON(value.id) });
173
+ }
174
+ else if (Key.isInstanceKey(value)) {
175
+ const lcClassName = value.className.toLowerCase();
176
+ if (!this._instanceKeys.has(lcClassName)) {
177
+ this._instanceKeys.set(lcClassName, new Set());
178
+ this._lowerCaseMap.set(lcClassName, value.className);
179
+ }
180
+ this._lowerCaseMap.set(lcClassName, value.className);
181
+ this._instanceKeys.get(lcClassName).add(value.id);
182
+ }
183
+ else if (Key.isNodeKey(value)) {
184
+ this._nodeKeys.add(JSON.stringify(value));
185
+ }
186
+ else {
187
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
188
+ }
189
+ }
190
+ if (this.size !== sizeBefore)
191
+ this.recalculateGuid();
192
+ return this;
193
+ }
194
+ deleteKeySet(keyset) {
195
+ for (const key of keyset._nodeKeys)
196
+ this._nodeKeys.delete(key);
197
+ for (const entry of keyset._instanceKeys) {
198
+ const set = this._instanceKeys.get(entry["0"].toLowerCase());
199
+ if (set) {
200
+ entry["1"].forEach((key) => {
201
+ set.delete(key);
202
+ });
203
+ }
204
+ }
205
+ }
206
+ /**
207
+ * Deletes a key or keys from this KeySet.
208
+ * @param value A key or keys to delete.
209
+ * @returns itself
210
+ */
211
+ delete(value) {
212
+ if (!value)
213
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
214
+ const sizeBefore = this.size;
215
+ if (this.isKeySet(value)) {
216
+ this.deleteKeySet(value);
217
+ }
218
+ else if (this.isKeysArray(value)) {
219
+ for (const key of value)
220
+ this.delete(key);
221
+ }
222
+ else if (Key.isEntityProps(value)) {
223
+ this.delete({ className: value.classFullName, id: value.id });
224
+ }
225
+ else if (Key.isInstanceKey(value)) {
226
+ const set = this._instanceKeys.get(value.className.toLowerCase());
227
+ if (set)
228
+ set.delete(value.id);
229
+ }
230
+ else if (Key.isNodeKey(value)) {
231
+ this._nodeKeys.delete(JSON.stringify(value));
232
+ }
233
+ else {
234
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
235
+ }
236
+ if (this.size !== sizeBefore)
237
+ this.recalculateGuid();
238
+ return this;
239
+ }
240
+ /**
241
+ * Check if this KeySet contains the specified key.
242
+ * @param value The key to check.
243
+ */
244
+ has(value) {
245
+ if (!value)
246
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
247
+ if (Key.isEntityProps(value))
248
+ return this.has({ className: value.classFullName, id: value.id });
249
+ if (Key.isInstanceKey(value)) {
250
+ const set = this._instanceKeys.get(value.className.toLowerCase());
251
+ return !!(set && set.has(value.id));
252
+ }
253
+ if (Key.isNodeKey(value))
254
+ return this._nodeKeys.has(JSON.stringify(value));
255
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${value}`);
256
+ }
257
+ hasKeySet(readonlyKeys, checkType) {
258
+ // note: cast-away read-onlyness to access private members...
259
+ const keys = readonlyKeys;
260
+ if (checkType === "all") {
261
+ if (this._nodeKeys.size < keys._nodeKeys.size || this._instanceKeys.size < keys._instanceKeys.size)
262
+ return false;
263
+ if ([...keys._nodeKeys].some((key) => !this._nodeKeys.has(key)))
264
+ return false;
265
+ for (const otherEntry of keys._instanceKeys) {
266
+ const thisEntryKeys = this._instanceKeys.get(otherEntry["0"].toLowerCase());
267
+ if (!thisEntryKeys || thisEntryKeys.size < otherEntry["1"].size)
268
+ return false;
269
+ if ([...otherEntry["1"]].some((key) => !thisEntryKeys.has(key)))
270
+ return false;
271
+ }
272
+ return true;
273
+ }
274
+ // "any" check type
275
+ if ([...keys._nodeKeys].some((key) => this._nodeKeys.has(key)))
276
+ return true;
277
+ for (const otherEntry of keys._instanceKeys) {
278
+ const thisEntryKeys = this._instanceKeys.get(otherEntry["0"].toLowerCase());
279
+ if (thisEntryKeys && [...otherEntry["1"]].some((key) => thisEntryKeys.has(key)))
280
+ return true;
281
+ }
282
+ return false;
283
+ }
284
+ hasKeysArray(keys, checkType) {
285
+ if (checkType === "all") {
286
+ if (this.size < keys.length)
287
+ return false;
288
+ for (const key of keys) {
289
+ if (!this.has(key))
290
+ return false;
291
+ }
292
+ return true;
293
+ }
294
+ // "any" check type
295
+ for (const key of keys) {
296
+ if (this.has(key))
297
+ return true;
298
+ }
299
+ return false;
300
+ }
301
+ /**
302
+ * Check if this KeySet contains all the specified keys.
303
+ * @param keys The keys to check.
304
+ */
305
+ hasAll(keys) {
306
+ if (!keys)
307
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${keys}`);
308
+ if (this.isKeySet(keys))
309
+ return this.hasKeySet(keys, "all");
310
+ if (this.isKeysArray(keys))
311
+ return this.hasKeysArray(keys, "all");
312
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: keys = ${keys}`);
313
+ }
314
+ /**
315
+ * Check if this KeySet contains any of the specified keys.
316
+ * @param keys The keys to check.
317
+ */
318
+ hasAny(keys) {
319
+ if (!keys)
320
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: value = ${keys}`);
321
+ if (this.isKeySet(keys))
322
+ return this.hasKeySet(keys, "any");
323
+ if (this.isKeysArray(keys))
324
+ return this.hasKeysArray(keys, "any");
325
+ throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid argument: keys = ${keys}`);
326
+ }
327
+ /**
328
+ * Get the number of keys stored in this KeySet.
329
+ */
330
+ get size() {
331
+ const nodeKeysCount = this._nodeKeys.size;
332
+ let instanceIdsCount = 0;
333
+ for (const set of this._instanceKeys.values())
334
+ instanceIdsCount += set.size;
335
+ return nodeKeysCount + instanceIdsCount;
336
+ }
337
+ /**
338
+ * Is this KeySet currently empty.
339
+ */
340
+ get isEmpty() {
341
+ return 0 === this.size;
342
+ }
343
+ /** Iterate over all keys in this keyset. */
344
+ some(callback) {
345
+ for (const entry of this._instanceKeys) {
346
+ const className = this._lowerCaseMap.get(entry["0"].toLowerCase());
347
+ if (some(entry[1], (id) => callback({ className, id })))
348
+ return true;
349
+ }
350
+ // eslint-disable-next-line deprecation/deprecation
351
+ return some(this._nodeKeys, (serializedKey) => callback(NodeKey.fromJSON(JSON.parse(serializedKey))));
352
+ }
353
+ /** Iterate over all keys in this keyset. */
354
+ forEach(callback) {
355
+ let index = 0;
356
+ this._instanceKeys.forEach((ids, className) => {
357
+ const recentClassName = this._lowerCaseMap.get(className.toLowerCase());
358
+ ids.forEach((id) => callback({ className: recentClassName, id }, index++));
359
+ });
360
+ this._nodeKeys.forEach((serializedKey) => {
361
+ // eslint-disable-next-line deprecation/deprecation
362
+ callback(NodeKey.fromJSON(JSON.parse(serializedKey)), index++);
363
+ });
364
+ }
365
+ /** Iterate over all keys in this keyset in batches */
366
+ forEachBatch(batchSize, callback) {
367
+ const size = this.size;
368
+ const count = Math.ceil(size / batchSize);
369
+ if (1 === count) {
370
+ callback(this, 0);
371
+ return;
372
+ }
373
+ let batch = new KeySet();
374
+ let batchIndex = 0;
375
+ let currBatchSize = 0;
376
+ this.forEach((key, index) => {
377
+ batch.add(key);
378
+ ++currBatchSize;
379
+ if (currBatchSize === batchSize || index === (size - 1)) {
380
+ callback(batch, batchIndex++);
381
+ batch = new KeySet();
382
+ currBatchSize = 0;
383
+ }
384
+ });
385
+ }
386
+ /**
387
+ * Serializes this KeySet to JSON
388
+ * @public
389
+ */
390
+ toJSON() {
391
+ const instanceKeys = [];
392
+ for (const entry of this._instanceKeys.entries()) {
393
+ if (entry["1"].size > 0) {
394
+ const className = this._lowerCaseMap.get(entry["0"].toLowerCase());
395
+ const compressedIds = CompressedId64Set.sortAndCompress(entry["1"]);
396
+ instanceKeys.push([className, compressedIds.length > 0 ? compressedIds : Id64.invalid]);
397
+ }
398
+ }
399
+ // eslint-disable-next-line deprecation/deprecation
400
+ const nodeKeys = [];
401
+ for (const serializedKey of this._nodeKeys.values())
402
+ nodeKeys.push(JSON.parse(serializedKey));
403
+ return {
404
+ instanceKeys,
405
+ nodeKeys,
406
+ };
407
+ }
408
+ /**
409
+ * Creates a KeySet from JSON
410
+ * @public
411
+ */
412
+ static fromJSON(json) {
413
+ const keyset = new KeySet();
414
+ keyset.addKeySetJSON(json);
415
+ return keyset;
416
+ }
417
+ }
418
+ const some = (set, cb) => {
419
+ for (const item of set) {
420
+ if (cb(item))
421
+ return true;
422
+ }
423
+ return false;
424
+ };
425
425
  //# sourceMappingURL=KeySet.js.map