@itwin/presentation-common 3.4.4 → 3.4.6

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 (458) hide show
  1. package/CHANGELOG.md +11 -1
  2. package/lib/cjs/assets/locales/en/BisCore.json +18 -18
  3. package/lib/cjs/assets/locales/en/ECPresentation.json +9 -9
  4. package/lib/cjs/assets/locales/en/RulesEngine.json +5 -5
  5. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  6. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  7. package/lib/cjs/presentation-common/AsyncTasks.js.map +1 -1
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  9. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  10. package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -1
  11. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  12. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  13. package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
  14. package/lib/cjs/presentation-common/EC.d.ts +315 -315
  15. package/lib/cjs/presentation-common/EC.js +270 -270
  16. package/lib/cjs/presentation-common/EC.js.map +1 -1
  17. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  18. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  19. package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
  20. package/lib/cjs/presentation-common/Error.d.ts +45 -45
  21. package/lib/cjs/presentation-common/Error.js +62 -62
  22. package/lib/cjs/presentation-common/Error.js.map +1 -1
  23. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  24. package/lib/cjs/presentation-common/KeySet.js +418 -418
  25. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  26. package/lib/cjs/presentation-common/LabelDefinition.d.ts +79 -79
  27. package/lib/cjs/presentation-common/LabelDefinition.js +76 -76
  28. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  29. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  30. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  31. package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
  32. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +37 -37
  33. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  34. package/lib/cjs/presentation-common/PresentationIpcInterface.js.map +1 -1
  35. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +242 -242
  36. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  37. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  38. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +181 -181
  39. package/lib/cjs/presentation-common/PresentationRpcInterface.js +102 -102
  40. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  41. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  42. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  43. package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
  44. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  45. package/lib/cjs/presentation-common/RpcRequestsHandler.js +155 -155
  46. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  47. package/lib/cjs/presentation-common/RulesetVariables.d.ts +166 -166
  48. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  49. package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
  50. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  51. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  52. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  53. package/lib/cjs/presentation-common/Update.d.ts +194 -194
  54. package/lib/cjs/presentation-common/Update.js +196 -196
  55. package/lib/cjs/presentation-common/Update.js.map +1 -1
  56. package/lib/cjs/presentation-common/Utils.d.ts +64 -64
  57. package/lib/cjs/presentation-common/Utils.js +45 -45
  58. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  59. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  60. package/lib/cjs/presentation-common/content/Category.js +49 -49
  61. package/lib/cjs/presentation-common/content/Category.js.map +1 -1
  62. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  63. package/lib/cjs/presentation-common/content/Content.js +56 -56
  64. package/lib/cjs/presentation-common/content/Content.js.map +1 -1
  65. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +101 -101
  66. package/lib/cjs/presentation-common/content/ContentTraverser.js +420 -420
  67. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  68. package/lib/cjs/presentation-common/content/Descriptor.d.ts +240 -240
  69. package/lib/cjs/presentation-common/content/Descriptor.js +189 -189
  70. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  71. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  72. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  73. package/lib/cjs/presentation-common/content/DisplayTypes.js.map +1 -1
  74. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  75. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  76. package/lib/cjs/presentation-common/content/Editor.js.map +1 -1
  77. package/lib/cjs/presentation-common/content/Fields.d.ts +282 -282
  78. package/lib/cjs/presentation-common/content/Fields.js +394 -394
  79. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  80. package/lib/cjs/presentation-common/content/Item.d.ts +87 -87
  81. package/lib/cjs/presentation-common/content/Item.js +86 -86
  82. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  83. package/lib/cjs/presentation-common/content/Property.d.ts +51 -51
  84. package/lib/cjs/presentation-common/content/Property.js +36 -36
  85. package/lib/cjs/presentation-common/content/Property.js.map +1 -1
  86. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  87. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  88. package/lib/cjs/presentation-common/content/Renderer.js.map +1 -1
  89. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  90. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  91. package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
  92. package/lib/cjs/presentation-common/content/Value.d.ts +157 -157
  93. package/lib/cjs/presentation-common/content/Value.js +217 -217
  94. package/lib/cjs/presentation-common/content/Value.js.map +1 -1
  95. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +185 -185
  96. package/lib/cjs/presentation-common/hierarchy/Key.js +112 -112
  97. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  98. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +141 -141
  99. package/lib/cjs/presentation-common/hierarchy/Node.js +97 -97
  100. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  101. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  102. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +98 -98
  103. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  104. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  105. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  106. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  107. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  108. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  109. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  110. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  111. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  112. package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
  113. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  114. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  115. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  116. package/lib/cjs/presentation-common/rules/Rule.d.ts +74 -74
  117. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  118. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  119. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +66 -66
  120. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  121. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  122. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  123. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  124. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  125. package/lib/cjs/presentation-common/rules/Variables.d.ts +55 -55
  126. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  127. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  128. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  129. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  130. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  131. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  132. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  133. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  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/ContentRule.js.map +1 -1
  137. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  138. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  139. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  140. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  141. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  142. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  143. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  144. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  145. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  146. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  147. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  148. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  149. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  150. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  151. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  152. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  153. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  154. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  155. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  156. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  157. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  158. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  159. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  160. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  161. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  162. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  163. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  164. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  165. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  166. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  167. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  168. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  169. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  170. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  171. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  172. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  173. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  174. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  175. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  176. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  177. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  178. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  179. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  180. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  181. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  182. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  183. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  184. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  185. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  186. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  187. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  188. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  189. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  190. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  191. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  192. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  193. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  194. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  195. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  196. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  197. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  198. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +22 -22
  199. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  200. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  201. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  202. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  203. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  204. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  205. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  206. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  207. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  208. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  209. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  210. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  211. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  212. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  213. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  214. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  215. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  216. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  217. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  218. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  219. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  220. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  221. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  222. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  223. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  224. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +25 -25
  225. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  226. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  227. package/lib/cjs/presentation-common.d.ts +110 -110
  228. package/lib/cjs/presentation-common.js +126 -126
  229. package/lib/cjs/presentation-common.js.map +1 -1
  230. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  231. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  232. package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
  233. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  234. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  235. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
  236. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  237. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  238. package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
  239. package/lib/esm/presentation-common/EC.d.ts +315 -315
  240. package/lib/esm/presentation-common/EC.js +267 -267
  241. package/lib/esm/presentation-common/EC.js.map +1 -1
  242. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  243. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  244. package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
  245. package/lib/esm/presentation-common/Error.d.ts +45 -45
  246. package/lib/esm/presentation-common/Error.js +58 -58
  247. package/lib/esm/presentation-common/Error.js.map +1 -1
  248. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  249. package/lib/esm/presentation-common/KeySet.js +414 -414
  250. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  251. package/lib/esm/presentation-common/LabelDefinition.d.ts +79 -79
  252. package/lib/esm/presentation-common/LabelDefinition.js +73 -73
  253. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  254. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  255. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  256. package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
  257. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +37 -37
  258. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  259. package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
  260. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +242 -242
  261. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  262. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  263. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +181 -181
  264. package/lib/esm/presentation-common/PresentationRpcInterface.js +98 -98
  265. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  266. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  267. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  268. package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
  269. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  270. package/lib/esm/presentation-common/RpcRequestsHandler.js +151 -151
  271. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  272. package/lib/esm/presentation-common/RulesetVariables.d.ts +166 -166
  273. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  274. package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
  275. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  276. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  277. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  278. package/lib/esm/presentation-common/Update.d.ts +194 -194
  279. package/lib/esm/presentation-common/Update.js +193 -193
  280. package/lib/esm/presentation-common/Update.js.map +1 -1
  281. package/lib/esm/presentation-common/Utils.d.ts +64 -64
  282. package/lib/esm/presentation-common/Utils.js +41 -41
  283. package/lib/esm/presentation-common/Utils.js.map +1 -1
  284. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  285. package/lib/esm/presentation-common/content/Category.js +46 -46
  286. package/lib/esm/presentation-common/content/Category.js.map +1 -1
  287. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  288. package/lib/esm/presentation-common/content/Content.js +52 -52
  289. package/lib/esm/presentation-common/content/Content.js.map +1 -1
  290. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +101 -101
  291. package/lib/esm/presentation-common/content/ContentTraverser.js +411 -411
  292. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  293. package/lib/esm/presentation-common/content/Descriptor.d.ts +240 -240
  294. package/lib/esm/presentation-common/content/Descriptor.js +185 -185
  295. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  296. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  297. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  298. package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
  299. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  300. package/lib/esm/presentation-common/content/Editor.js +8 -8
  301. package/lib/esm/presentation-common/content/Editor.js.map +1 -1
  302. package/lib/esm/presentation-common/content/Fields.d.ts +282 -282
  303. package/lib/esm/presentation-common/content/Fields.js +387 -387
  304. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  305. package/lib/esm/presentation-common/content/Item.d.ts +87 -87
  306. package/lib/esm/presentation-common/content/Item.js +82 -82
  307. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  308. package/lib/esm/presentation-common/content/Property.d.ts +51 -51
  309. package/lib/esm/presentation-common/content/Property.js +33 -33
  310. package/lib/esm/presentation-common/content/Property.js.map +1 -1
  311. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  312. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  313. package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
  314. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  315. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  316. package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
  317. package/lib/esm/presentation-common/content/Value.d.ts +157 -157
  318. package/lib/esm/presentation-common/content/Value.js +214 -214
  319. package/lib/esm/presentation-common/content/Value.js.map +1 -1
  320. package/lib/esm/presentation-common/hierarchy/Key.d.ts +185 -185
  321. package/lib/esm/presentation-common/hierarchy/Key.js +109 -109
  322. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  323. package/lib/esm/presentation-common/hierarchy/Node.d.ts +141 -141
  324. package/lib/esm/presentation-common/hierarchy/Node.js +94 -94
  325. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  326. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  327. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +95 -95
  328. package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  329. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  330. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  331. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  332. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  333. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  334. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  335. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  336. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  337. package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
  338. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  339. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  340. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  341. package/lib/esm/presentation-common/rules/Rule.d.ts +74 -74
  342. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  343. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  344. package/lib/esm/presentation-common/rules/Ruleset.d.ts +66 -66
  345. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  346. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  347. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  348. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  349. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  350. package/lib/esm/presentation-common/rules/Variables.d.ts +55 -55
  351. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  352. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  353. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  354. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  355. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  356. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  357. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  358. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  359. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  360. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  361. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  362. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  363. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  364. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  365. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  366. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  367. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  368. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  369. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  370. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  371. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  372. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  373. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  374. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  375. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  376. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  377. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  378. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  379. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  380. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  381. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  382. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  383. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  384. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  385. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  386. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  387. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  388. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  389. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  390. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  391. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  392. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  393. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  394. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  395. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  396. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  397. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  398. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  399. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  400. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  401. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  402. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  403. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  404. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  405. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  406. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  407. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  408. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  409. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  410. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  411. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  412. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  413. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  414. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  415. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  416. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  417. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  418. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  419. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  420. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  421. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  422. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  423. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +19 -19
  424. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  425. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  426. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  427. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  428. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  429. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  430. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  431. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  432. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  433. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  434. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  435. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  436. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  437. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  438. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  439. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  440. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  441. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  442. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  443. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  444. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  445. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  446. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  447. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  448. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  449. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +25 -25
  450. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  451. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  452. package/lib/esm/presentation-common.d.ts +110 -110
  453. package/lib/esm/presentation-common.js +114 -114
  454. package/lib/esm/presentation-common.js.map +1 -1
  455. package/lib/public/locales/en/BisCore.json +18 -18
  456. package/lib/public/locales/en/ECPresentation.json +9 -9
  457. package/lib/public/locales/en/RulesEngine.json +5 -5
  458. package/package.json +9 -9
@@ -1,156 +1,156 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module RPC
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.RpcRequestsHandler = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const core_common_1 = require("@itwin/core-common");
13
- const CommonLoggerCategory_1 = require("./CommonLoggerCategory");
14
- const Error_1 = require("./Error");
15
- const PresentationRpcInterface_1 = require("./PresentationRpcInterface");
16
- /**
17
- * RPC requests handler that wraps [[PresentationRpcInterface]] and
18
- * adds handling for cases when backend needs to be synced with client
19
- * state.
20
- *
21
- * @internal
22
- */
23
- class RpcRequestsHandler {
24
- constructor(props) {
25
- this.maxRequestRepeatCount = 5;
26
- this.clientId = (props && props.clientId) ? props.clientId : core_bentley_1.Guid.createValue();
27
- }
28
- dispose() {
29
- }
30
- // eslint-disable-next-line @typescript-eslint/naming-convention
31
- get rpcClient() { return core_common_1.RpcManager.getClientForInterface(PresentationRpcInterface_1.PresentationRpcInterface); }
32
- async requestRepeatedly(func, diagnosticsHandler, repeatCount = 1) {
33
- let diagnostics;
34
- let error;
35
- let shouldRepeat = false;
36
- try {
37
- const response = await func();
38
- diagnostics = response.diagnostics;
39
- if (response.statusCode === Error_1.PresentationStatus.Success)
40
- return response.result;
41
- if (response.statusCode === Error_1.PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)
42
- shouldRepeat = true;
43
- else
44
- error = new Error_1.PresentationError(response.statusCode, response.errorMessage);
45
- }
46
- catch (e) {
47
- error = e;
48
- if (repeatCount < this.maxRequestRepeatCount)
49
- shouldRepeat = true;
50
- }
51
- finally {
52
- diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
53
- }
54
- if (shouldRepeat) {
55
- ++repeatCount;
56
- return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);
57
- }
58
- throw error;
59
- }
60
- /**
61
- * Send the request to backend.
62
- *
63
- * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,
64
- * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error
65
- * response from the backend, throw the last encountered error.
66
- *
67
- * @internal
68
- */
69
- async request(func, options, ...additionalOptions) {
70
- const { imodel, diagnostics, ...optionsNoIModel } = options;
71
- const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics !== null && diagnostics !== void 0 ? diagnostics : {};
72
- if (isOptionsWithRuleset(optionsNoIModel))
73
- optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
74
- const rpcOptions = {
75
- ...optionsNoIModel,
76
- clientId: this.clientId,
77
- };
78
- if (diagnostics)
79
- rpcOptions.diagnostics = diagnosticsOptions;
80
- const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
81
- return this.requestRepeatedly(doRequest, diagnosticsHandler);
82
- }
83
- async getNodesCount(options) {
84
- return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
85
- }
86
- async getPagedNodes(options) {
87
- return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
88
- }
89
- async getNodePaths(options) {
90
- return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
91
- }
92
- async getFilteredNodePaths(options) {
93
- return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
94
- }
95
- async getContentSources(options) {
96
- return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
97
- }
98
- async getContentDescriptor(options) {
99
- return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
100
- }
101
- async getContentSetSize(options) {
102
- return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
103
- }
104
- async getPagedContent(options) {
105
- return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
106
- }
107
- async getPagedContentSet(options) {
108
- return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
109
- }
110
- async getPagedDistinctValues(options) {
111
- return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
112
- }
113
- async getElementProperties(options) {
114
- return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
115
- }
116
- async getContentInstanceKeys(options) {
117
- return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
118
- }
119
- async getDisplayLabelDefinition(options) {
120
- return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
121
- }
122
- async getPagedDisplayLabelDefinitions(options) {
123
- return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
124
- }
125
- async getSelectionScopes(options) {
126
- return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
127
- }
128
- async computeSelection(options) {
129
- return this.request(this.rpcClient.computeSelection.bind(this.rpcClient), options);
130
- }
131
- }
132
- exports.RpcRequestsHandler = RpcRequestsHandler;
133
- function isOptionsWithRuleset(options) {
134
- return (typeof options.rulesetOrId === "object");
135
- }
136
- const RULESET_SUPPORTED_PROPERTIES_OBJ = {
137
- id: true,
138
- rules: true,
139
- version: true,
140
- requiredSchemas: true,
141
- supplementationInfo: true,
142
- vars: true,
143
- };
144
- function cleanupRuleset(ruleset) {
145
- const cleanedUpRuleset = { ...ruleset };
146
- for (const propertyKey of Object.keys(cleanedUpRuleset)) {
147
- if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
148
- if (propertyKey === "$schema")
149
- delete cleanedUpRuleset[propertyKey];
150
- else
151
- core_bentley_1.Logger.logWarning(CommonLoggerCategory_1.PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
152
- }
153
- }
154
- return cleanedUpRuleset;
155
- }
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module RPC
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.RpcRequestsHandler = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_common_1 = require("@itwin/core-common");
13
+ const CommonLoggerCategory_1 = require("./CommonLoggerCategory");
14
+ const Error_1 = require("./Error");
15
+ const PresentationRpcInterface_1 = require("./PresentationRpcInterface");
16
+ /**
17
+ * RPC requests handler that wraps [[PresentationRpcInterface]] and
18
+ * adds handling for cases when backend needs to be synced with client
19
+ * state.
20
+ *
21
+ * @internal
22
+ */
23
+ class RpcRequestsHandler {
24
+ constructor(props) {
25
+ this.maxRequestRepeatCount = 5;
26
+ this.clientId = (props && props.clientId) ? props.clientId : core_bentley_1.Guid.createValue();
27
+ }
28
+ dispose() {
29
+ }
30
+ // eslint-disable-next-line @typescript-eslint/naming-convention
31
+ get rpcClient() { return core_common_1.RpcManager.getClientForInterface(PresentationRpcInterface_1.PresentationRpcInterface); }
32
+ async requestRepeatedly(func, diagnosticsHandler, repeatCount = 1) {
33
+ let diagnostics;
34
+ let error;
35
+ let shouldRepeat = false;
36
+ try {
37
+ const response = await func();
38
+ diagnostics = response.diagnostics;
39
+ if (response.statusCode === Error_1.PresentationStatus.Success)
40
+ return response.result;
41
+ if (response.statusCode === Error_1.PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)
42
+ shouldRepeat = true;
43
+ else
44
+ error = new Error_1.PresentationError(response.statusCode, response.errorMessage);
45
+ }
46
+ catch (e) {
47
+ error = e;
48
+ if (repeatCount < this.maxRequestRepeatCount)
49
+ shouldRepeat = true;
50
+ }
51
+ finally {
52
+ diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
53
+ }
54
+ if (shouldRepeat) {
55
+ ++repeatCount;
56
+ return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);
57
+ }
58
+ throw error;
59
+ }
60
+ /**
61
+ * Send the request to backend.
62
+ *
63
+ * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,
64
+ * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error
65
+ * response from the backend, throw the last encountered error.
66
+ *
67
+ * @internal
68
+ */
69
+ async request(func, options, ...additionalOptions) {
70
+ const { imodel, diagnostics, ...optionsNoIModel } = options;
71
+ const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics !== null && diagnostics !== void 0 ? diagnostics : {};
72
+ if (isOptionsWithRuleset(optionsNoIModel))
73
+ optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
74
+ const rpcOptions = {
75
+ ...optionsNoIModel,
76
+ clientId: this.clientId,
77
+ };
78
+ if (diagnostics)
79
+ rpcOptions.diagnostics = diagnosticsOptions;
80
+ const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
81
+ return this.requestRepeatedly(doRequest, diagnosticsHandler);
82
+ }
83
+ async getNodesCount(options) {
84
+ return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
85
+ }
86
+ async getPagedNodes(options) {
87
+ return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
88
+ }
89
+ async getNodePaths(options) {
90
+ return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
91
+ }
92
+ async getFilteredNodePaths(options) {
93
+ return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
94
+ }
95
+ async getContentSources(options) {
96
+ return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
97
+ }
98
+ async getContentDescriptor(options) {
99
+ return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
100
+ }
101
+ async getContentSetSize(options) {
102
+ return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
103
+ }
104
+ async getPagedContent(options) {
105
+ return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
106
+ }
107
+ async getPagedContentSet(options) {
108
+ return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
109
+ }
110
+ async getPagedDistinctValues(options) {
111
+ return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
112
+ }
113
+ async getElementProperties(options) {
114
+ return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
115
+ }
116
+ async getContentInstanceKeys(options) {
117
+ return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
118
+ }
119
+ async getDisplayLabelDefinition(options) {
120
+ return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
121
+ }
122
+ async getPagedDisplayLabelDefinitions(options) {
123
+ return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
124
+ }
125
+ async getSelectionScopes(options) {
126
+ return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
127
+ }
128
+ async computeSelection(options) {
129
+ return this.request(this.rpcClient.computeSelection.bind(this.rpcClient), options);
130
+ }
131
+ }
132
+ exports.RpcRequestsHandler = RpcRequestsHandler;
133
+ function isOptionsWithRuleset(options) {
134
+ return (typeof options.rulesetOrId === "object");
135
+ }
136
+ const RULESET_SUPPORTED_PROPERTIES_OBJ = {
137
+ id: true,
138
+ rules: true,
139
+ version: true,
140
+ requiredSchemas: true,
141
+ supplementationInfo: true,
142
+ vars: true,
143
+ };
144
+ function cleanupRuleset(ruleset) {
145
+ const cleanedUpRuleset = { ...ruleset };
146
+ for (const propertyKey of Object.keys(cleanedUpRuleset)) {
147
+ if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
148
+ if (propertyKey === "$schema")
149
+ delete cleanedUpRuleset[propertyKey];
150
+ else
151
+ core_bentley_1.Logger.logWarning(CommonLoggerCategory_1.PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
152
+ }
153
+ }
154
+ return cleanedUpRuleset;
155
+ }
156
156
  //# sourceMappingURL=RpcRequestsHandler.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgE;AAChE,oDAAgE;AAChE,iEAA0E;AAO1E,mCAAgE;AAYhE,yEAEoC;AAoBpC;;;;;;GAMG;AACH,MAAa,kBAAkB;IAM7B,YAAmB,KAA+B;QALlC,0BAAqB,GAAW,CAAC,CAAC;QAMhD,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,mBAAI,CAAC,WAAW,EAAE,CAAC;IAClF,CAAC;IAEM,OAAO;IACd,CAAC;IAED,gEAAgE;IAChE,IAAY,SAAS,KAA+B,OAAO,wBAAU,CAAC,qBAAqB,CAAC,mDAAwB,CAAC,CAAC,CAAC,CAAC;IAEhH,KAAK,CAAC,iBAAiB,CAAU,IAA4C,EAAE,kBAA6C,EAAE,cAAsB,CAAC;QAC3J,IAAI,WAA0C,CAAC;QAC/C,IAAI,KAA0B,CAAC;QAC/B,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;YAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YAEnC,IAAI,QAAQ,CAAC,UAAU,KAAK,0BAAkB,CAAC,OAAO;gBACpD,OAAO,QAAQ,CAAC,MAAO,CAAC;YAE1B,IAAI,QAAQ,CAAC,UAAU,KAAK,0BAAkB,CAAC,cAAc,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBACvG,YAAY,GAAG,IAAI,CAAC;;gBAEpB,KAAK,GAAG,IAAI,yBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SAE7E;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,GAAG,CAAC,CAAC;YACV,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBAC1C,YAAY,GAAG,IAAI,CAAC;SAEvB;gBAAS;YACR,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;SACtE;QAED,IAAI,YAAY,EAAE;YAChB,EAAE,WAAW,CAAC;YACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,EAAE,WAAW,CAAC,CAAC;SACtE;QAED,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO,CAClB,IAAoI,EACpI,OAAiB,EACjB,GAAG,iBAAyB;QAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,CAAC;QACjF,IAAI,oBAAoB,CAAC,eAAe,CAAC;YACvC,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW;YACb,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAC9C,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA+G;QACxI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,OAAsH;QAC/I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,OAAuH;QAC/I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAA8G;QAC9I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAAsH;QACtJ,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiI;QAC9J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,OAAwI;QACnK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IACM,KAAK,CAAC,kBAAkB,CAAC,OAAwI;QACtK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwI;QAC1K,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAA2F;QAC3H,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwH;QAC1J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,OAAiG;QACtI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,+BAA+B,CAAC,OAAkG;QAC7I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AApJD,gDAoJC;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,CAAC,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;AAC5F,CAAC;AAMD,MAAM,gCAAgC,GAAkC;IACtE,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB;IACtC,MAAM,gBAAgB,GAAY,EAAE,GAAG,OAAO,EAAE,CAAC;IAEjD,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;QACvD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACjE,IAAI,WAAW,KAAK,SAAS;gBAC3B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;;gBAE9C,qBAAM,CAAC,UAAU,CAAC,uDAAgC,CAAC,OAAO,EAAE,qDAAqD,WAAW,2DAA2D,CAAC,CAAC;SAC5L;KACF;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module RPC\n */\n\nimport { Guid, IDisposable, Logger } from \"@itwin/core-bentley\";\nimport { IModelRpcProps, RpcManager } from \"@itwin/core-common\";\nimport { PresentationCommonLoggerCategory } from \"./CommonLoggerCategory\";\nimport { DescriptorJSON, DescriptorOverrides } from \"./content/Descriptor\";\nimport { ItemJSON } from \"./content/Item\";\nimport { DisplayValueGroupJSON } from \"./content/Value\";\nimport { ClientDiagnostics, ClientDiagnosticsAttribute, ClientDiagnosticsHandler } from \"./Diagnostics\";\nimport { InstanceKeyJSON } from \"./EC\";\nimport { ElementProperties } from \"./ElementProperties\";\nimport { PresentationError, PresentationStatus } from \"./Error\";\nimport { NodeKeyJSON } from \"./hierarchy/Key\";\nimport { NodeJSON } from \"./hierarchy/Node\";\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\nimport { KeySetJSON } from \"./KeySet\";\nimport { LabelDefinitionJSON } from \"./LabelDefinition\";\nimport {\n ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\n ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\n FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyRequestOptions, Paged, RequestOptions,\n RequestOptionsWithRuleset, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\n} from \"./PresentationManagerOptions\";\nimport {\n ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse,\n} from \"./PresentationRpcInterface\";\nimport { Ruleset } from \"./rules/Ruleset\";\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\nimport { SelectionScope } from \"./selection/SelectionScope\";\nimport { PagedResponse } from \"./Utils\";\n\n/**\n * Configuration parameters for [[RpcRequestsHandler]].\n *\n * @internal\n */\nexport interface RpcRequestsHandlerProps {\n /**\n * Optional ID used to identify client that requests data. If not specified,\n * the handler creates a unique GUID as a client id.\n * @internal\n */\n clientId?: string;\n}\n\n/**\n * RPC requests handler that wraps [[PresentationRpcInterface]] and\n * adds handling for cases when backend needs to be synced with client\n * state.\n *\n * @internal\n */\nexport class RpcRequestsHandler implements IDisposable {\n public readonly maxRequestRepeatCount: number = 5;\n\n /** ID that identifies this handler as a client */\n public readonly clientId: string;\n\n public constructor(props?: RpcRequestsHandlerProps) {\n this.clientId = (props && props.clientId) ? props.clientId : Guid.createValue();\n }\n\n public dispose() {\n }\n\n // eslint-disable-next-line @typescript-eslint/naming-convention\n private get rpcClient(): PresentationRpcInterface { return RpcManager.getClientForInterface(PresentationRpcInterface); }\n\n private async requestRepeatedly<TResult>(func: () => PresentationRpcResponse<TResult>, diagnosticsHandler?: ClientDiagnosticsHandler, repeatCount: number = 1): Promise<TResult> {\n let diagnostics: ClientDiagnostics | undefined;\n let error: unknown | undefined;\n let shouldRepeat = false;\n try {\n const response = await func();\n diagnostics = response.diagnostics;\n\n if (response.statusCode === PresentationStatus.Success)\n return response.result!;\n\n if (response.statusCode === PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)\n shouldRepeat = true;\n else\n error = new PresentationError(response.statusCode, response.errorMessage);\n\n } catch (e) {\n error = e;\n if (repeatCount < this.maxRequestRepeatCount)\n shouldRepeat = true;\n\n } finally {\n diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);\n }\n\n if (shouldRepeat) {\n ++repeatCount;\n return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);\n }\n\n throw error;\n }\n\n /**\n * Send the request to backend.\n *\n * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,\n * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error\n * response from the backend, throw the last encountered error.\n *\n * @internal\n */\n public async request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(\n func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>,\n options: TOptions,\n ...additionalOptions: TArg[]\n ): Promise<TResult> {\n const { imodel, diagnostics, ...optionsNoIModel } = options;\n const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};\n if (isOptionsWithRuleset(optionsNoIModel))\n optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);\n const rpcOptions: PresentationRpcRequestOptions<TOptions> = {\n ...optionsNoIModel,\n clientId: this.clientId,\n };\n if (diagnostics)\n rpcOptions.diagnostics = diagnosticsOptions;\n const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);\n return this.requestRepeatedly(doRequest, diagnosticsHandler);\n }\n\n public async getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKeyJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\n return this.request<number, typeof options>(\n this.rpcClient.getNodesCount.bind(this.rpcClient), options);\n }\n public async getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKeyJSON, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>> {\n return this.request<PagedResponse<NodeJSON>, typeof options>(\n this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\n }\n\n public async getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\n return this.request<NodePathElementJSON[], typeof options>(\n this.rpcClient.getNodePaths.bind(this.rpcClient), options);\n }\n public async getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\n return this.request<NodePathElementJSON[], typeof options>(\n this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\n }\n\n public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\n return this.request<ContentSourcesRpcResult, typeof options>(\n this.rpcClient.getContentSources.bind(this.rpcClient), options);\n }\n public async getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\n return this.request<DescriptorJSON | undefined, typeof options>(\n this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\n }\n public async getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\n return this.request<number, typeof options>(\n this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\n }\n public async getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\n return this.request<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\n this.rpcClient.getPagedContent.bind(this.rpcClient), options);\n }\n public async getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\n return this.request<PagedResponse<ItemJSON>, typeof options>(\n this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\n }\n\n public async getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>> {\n return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(\n this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\n }\n\n public async getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined> {\n return this.request<ElementProperties | undefined, typeof options>(\n this.rpcClient.getElementProperties.bind(this.rpcClient), options);\n }\n\n public async getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{ total: number, items: KeySetJSON }> {\n return this.request<{ total: number, items: KeySetJSON }, typeof options>(\n this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\n }\n\n public async getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKeyJSON> & ClientDiagnosticsAttribute): Promise<LabelDefinitionJSON> {\n return this.request<LabelDefinitionJSON, typeof options>(\n this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\n }\n public async getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKeyJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinitionJSON>> {\n return this.request<PagedResponse<LabelDefinitionJSON>, typeof options>(\n this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\n }\n\n public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\n return this.request<SelectionScope[], typeof options>(\n this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);\n }\n public async computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON> {\n return this.request<KeySetJSON, typeof options>(\n this.rpcClient.computeSelection.bind(this.rpcClient), options);\n }\n}\n\nfunction isOptionsWithRuleset(options: Object): options is { rulesetOrId: Ruleset } {\n return (typeof (options as RequestOptionsWithRuleset<any, any>).rulesetOrId === \"object\");\n}\n\ntype RulesetWithRequiredProperties = {\n [key in keyof Ruleset]-?: true;\n};\n\nconst RULESET_SUPPORTED_PROPERTIES_OBJ: RulesetWithRequiredProperties = {\n id: true,\n rules: true,\n version: true,\n requiredSchemas: true,\n supplementationInfo: true,\n vars: true,\n};\n\nfunction cleanupRuleset(ruleset: Ruleset): Ruleset {\n const cleanedUpRuleset: Ruleset = { ...ruleset };\n\n for (const propertyKey of Object.keys(cleanedUpRuleset)) {\n if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {\n if (propertyKey === \"$schema\")\n delete (cleanedUpRuleset as any)[propertyKey];\n else\n Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);\n }\n }\n\n return cleanedUpRuleset;\n}\n"]}
1
+ {"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgE;AAChE,oDAAgE;AAChE,iEAA0E;AAO1E,mCAAgE;AAYhE,yEAEoC;AAoBpC;;;;;;GAMG;AACH,MAAa,kBAAkB;IAM7B,YAAmB,KAA+B;QALlC,0BAAqB,GAAW,CAAC,CAAC;QAMhD,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,mBAAI,CAAC,WAAW,EAAE,CAAC;IAClF,CAAC;IAEM,OAAO;IACd,CAAC;IAED,gEAAgE;IAChE,IAAY,SAAS,KAA+B,OAAO,wBAAU,CAAC,qBAAqB,CAAC,mDAAwB,CAAC,CAAC,CAAC,CAAC;IAEhH,KAAK,CAAC,iBAAiB,CAAU,IAA4C,EAAE,kBAA6C,EAAE,cAAsB,CAAC;QAC3J,IAAI,WAA0C,CAAC;QAC/C,IAAI,KAA0B,CAAC;QAC/B,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;YAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YAEnC,IAAI,QAAQ,CAAC,UAAU,KAAK,0BAAkB,CAAC,OAAO;gBACpD,OAAO,QAAQ,CAAC,MAAO,CAAC;YAE1B,IAAI,QAAQ,CAAC,UAAU,KAAK,0BAAkB,CAAC,cAAc,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBACvG,YAAY,GAAG,IAAI,CAAC;;gBAEpB,KAAK,GAAG,IAAI,yBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SAE7E;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,GAAG,CAAC,CAAC;YACV,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBAC1C,YAAY,GAAG,IAAI,CAAC;SAEvB;gBAAS;YACR,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;SACtE;QAED,IAAI,YAAY,EAAE;YAChB,EAAE,WAAW,CAAC;YACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,EAAE,WAAW,CAAC,CAAC;SACtE;QAED,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO,CAClB,IAAoI,EACpI,OAAiB,EACjB,GAAG,iBAAyB;QAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,CAAC;QACjF,IAAI,oBAAoB,CAAC,eAAe,CAAC;YACvC,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW;YACb,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAC9C,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA+G;QACxI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,OAAsH;QAC/I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,OAAuH;QAC/I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAA8G;QAC9I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAAsH;QACtJ,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiI;QAC9J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,OAAwI;QACnK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IACM,KAAK,CAAC,kBAAkB,CAAC,OAAwI;QACtK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwI;QAC1K,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAA2F;QAC3H,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwH;QAC1J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,OAAiG;QACtI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,+BAA+B,CAAC,OAAkG;QAC7I,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AApJD,gDAoJC;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,CAAC,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;AAC5F,CAAC;AAMD,MAAM,gCAAgC,GAAkC;IACtE,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB;IACtC,MAAM,gBAAgB,GAAY,EAAE,GAAG,OAAO,EAAE,CAAC;IAEjD,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;QACvD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACjE,IAAI,WAAW,KAAK,SAAS;gBAC3B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;;gBAE9C,qBAAM,CAAC,UAAU,CAAC,uDAAgC,CAAC,OAAO,EAAE,qDAAqD,WAAW,2DAA2D,CAAC,CAAC;SAC5L;KACF;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RPC\r\n */\r\n\r\nimport { Guid, IDisposable, Logger } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps, RpcManager } from \"@itwin/core-common\";\r\nimport { PresentationCommonLoggerCategory } from \"./CommonLoggerCategory\";\r\nimport { DescriptorJSON, DescriptorOverrides } from \"./content/Descriptor\";\r\nimport { ItemJSON } from \"./content/Item\";\r\nimport { DisplayValueGroupJSON } from \"./content/Value\";\r\nimport { ClientDiagnostics, ClientDiagnosticsAttribute, ClientDiagnosticsHandler } from \"./Diagnostics\";\r\nimport { InstanceKeyJSON } from \"./EC\";\r\nimport { ElementProperties } from \"./ElementProperties\";\r\nimport { PresentationError, PresentationStatus } from \"./Error\";\r\nimport { NodeKeyJSON } from \"./hierarchy/Key\";\r\nimport { NodeJSON } from \"./hierarchy/Node\";\r\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\r\nimport { KeySetJSON } from \"./KeySet\";\r\nimport { LabelDefinitionJSON } from \"./LabelDefinition\";\r\nimport {\r\n ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\r\n ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\r\n FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyRequestOptions, Paged, RequestOptions,\r\n RequestOptionsWithRuleset, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport {\r\n ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse,\r\n} from \"./PresentationRpcInterface\";\r\nimport { Ruleset } from \"./rules/Ruleset\";\r\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\r\nimport { SelectionScope } from \"./selection/SelectionScope\";\r\nimport { PagedResponse } from \"./Utils\";\r\n\r\n/**\r\n * Configuration parameters for [[RpcRequestsHandler]].\r\n *\r\n * @internal\r\n */\r\nexport interface RpcRequestsHandlerProps {\r\n /**\r\n * Optional ID used to identify client that requests data. If not specified,\r\n * the handler creates a unique GUID as a client id.\r\n * @internal\r\n */\r\n clientId?: string;\r\n}\r\n\r\n/**\r\n * RPC requests handler that wraps [[PresentationRpcInterface]] and\r\n * adds handling for cases when backend needs to be synced with client\r\n * state.\r\n *\r\n * @internal\r\n */\r\nexport class RpcRequestsHandler implements IDisposable {\r\n public readonly maxRequestRepeatCount: number = 5;\r\n\r\n /** ID that identifies this handler as a client */\r\n public readonly clientId: string;\r\n\r\n public constructor(props?: RpcRequestsHandlerProps) {\r\n this.clientId = (props && props.clientId) ? props.clientId : Guid.createValue();\r\n }\r\n\r\n public dispose() {\r\n }\r\n\r\n // eslint-disable-next-line @typescript-eslint/naming-convention\r\n private get rpcClient(): PresentationRpcInterface { return RpcManager.getClientForInterface(PresentationRpcInterface); }\r\n\r\n private async requestRepeatedly<TResult>(func: () => PresentationRpcResponse<TResult>, diagnosticsHandler?: ClientDiagnosticsHandler, repeatCount: number = 1): Promise<TResult> {\r\n let diagnostics: ClientDiagnostics | undefined;\r\n let error: unknown | undefined;\r\n let shouldRepeat = false;\r\n try {\r\n const response = await func();\r\n diagnostics = response.diagnostics;\r\n\r\n if (response.statusCode === PresentationStatus.Success)\r\n return response.result!;\r\n\r\n if (response.statusCode === PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)\r\n shouldRepeat = true;\r\n else\r\n error = new PresentationError(response.statusCode, response.errorMessage);\r\n\r\n } catch (e) {\r\n error = e;\r\n if (repeatCount < this.maxRequestRepeatCount)\r\n shouldRepeat = true;\r\n\r\n } finally {\r\n diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);\r\n }\r\n\r\n if (shouldRepeat) {\r\n ++repeatCount;\r\n return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);\r\n }\r\n\r\n throw error;\r\n }\r\n\r\n /**\r\n * Send the request to backend.\r\n *\r\n * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,\r\n * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error\r\n * response from the backend, throw the last encountered error.\r\n *\r\n * @internal\r\n */\r\n public async request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(\r\n func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>,\r\n options: TOptions,\r\n ...additionalOptions: TArg[]\r\n ): Promise<TResult> {\r\n const { imodel, diagnostics, ...optionsNoIModel } = options;\r\n const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};\r\n if (isOptionsWithRuleset(optionsNoIModel))\r\n optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);\r\n const rpcOptions: PresentationRpcRequestOptions<TOptions> = {\r\n ...optionsNoIModel,\r\n clientId: this.clientId,\r\n };\r\n if (diagnostics)\r\n rpcOptions.diagnostics = diagnosticsOptions;\r\n const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);\r\n return this.requestRepeatedly(doRequest, diagnosticsHandler);\r\n }\r\n\r\n public async getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKeyJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\r\n return this.request<number, typeof options>(\r\n this.rpcClient.getNodesCount.bind(this.rpcClient), options);\r\n }\r\n public async getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKeyJSON, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>> {\r\n return this.request<PagedResponse<NodeJSON>, typeof options>(\r\n this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\r\n return this.request<NodePathElementJSON[], typeof options>(\r\n this.rpcClient.getNodePaths.bind(this.rpcClient), options);\r\n }\r\n public async getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\r\n return this.request<NodePathElementJSON[], typeof options>(\r\n this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\r\n return this.request<ContentSourcesRpcResult, typeof options>(\r\n this.rpcClient.getContentSources.bind(this.rpcClient), options);\r\n }\r\n public async getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\r\n return this.request<DescriptorJSON | undefined, typeof options>(\r\n this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\r\n }\r\n public async getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\r\n return this.request<number, typeof options>(\r\n this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\r\n }\r\n public async getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\r\n return this.request<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\r\n this.rpcClient.getPagedContent.bind(this.rpcClient), options);\r\n }\r\n public async getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\r\n return this.request<PagedResponse<ItemJSON>, typeof options>(\r\n this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>> {\r\n return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(\r\n this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined> {\r\n return this.request<ElementProperties | undefined, typeof options>(\r\n this.rpcClient.getElementProperties.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{ total: number, items: KeySetJSON }> {\r\n return this.request<{ total: number, items: KeySetJSON }, typeof options>(\r\n this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKeyJSON> & ClientDiagnosticsAttribute): Promise<LabelDefinitionJSON> {\r\n return this.request<LabelDefinitionJSON, typeof options>(\r\n this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\r\n }\r\n public async getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKeyJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinitionJSON>> {\r\n return this.request<PagedResponse<LabelDefinitionJSON>, typeof options>(\r\n this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\r\n }\r\n\r\n public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\r\n return this.request<SelectionScope[], typeof options>(\r\n this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);\r\n }\r\n public async computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON> {\r\n return this.request<KeySetJSON, typeof options>(\r\n this.rpcClient.computeSelection.bind(this.rpcClient), options);\r\n }\r\n}\r\n\r\nfunction isOptionsWithRuleset(options: Object): options is { rulesetOrId: Ruleset } {\r\n return (typeof (options as RequestOptionsWithRuleset<any, any>).rulesetOrId === \"object\");\r\n}\r\n\r\ntype RulesetWithRequiredProperties = {\r\n [key in keyof Ruleset]-?: true;\r\n};\r\n\r\nconst RULESET_SUPPORTED_PROPERTIES_OBJ: RulesetWithRequiredProperties = {\r\n id: true,\r\n rules: true,\r\n version: true,\r\n requiredSchemas: true,\r\n supplementationInfo: true,\r\n vars: true,\r\n};\r\n\r\nfunction cleanupRuleset(ruleset: Ruleset): Ruleset {\r\n const cleanedUpRuleset: Ruleset = { ...ruleset };\r\n\r\n for (const propertyKey of Object.keys(cleanedUpRuleset)) {\r\n if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {\r\n if (propertyKey === \"$schema\")\r\n delete (cleanedUpRuleset as any)[propertyKey];\r\n else\r\n Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);\r\n }\r\n }\r\n\r\n return cleanedUpRuleset;\r\n}\r\n"]}