@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

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 (366) hide show
  1. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  2. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  3. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  4. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  5. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  6. package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
  7. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  8. package/lib/cjs/presentation-common/EC.d.ts +350 -350
  9. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  10. package/lib/cjs/presentation-common/EC.js +290 -290
  11. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  12. package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
  13. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  14. package/lib/cjs/presentation-common/Error.d.ts +47 -47
  15. package/lib/cjs/presentation-common/Error.js +64 -64
  16. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  17. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  18. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  19. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  20. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  21. package/lib/cjs/presentation-common/KeySet.js +428 -428
  22. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -93
  23. package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
  24. package/lib/cjs/presentation-common/LabelDefinition.js +78 -78
  25. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  26. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  27. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  28. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  29. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -273
  30. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  31. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  32. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
  33. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  34. package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
  35. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  36. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +30 -30
  37. package/lib/cjs/presentation-common/PropertyFormatter.js +198 -198
  38. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  39. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  40. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  41. package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -166
  42. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  43. package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
  44. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  45. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  46. package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
  47. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  48. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  49. package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
  50. package/lib/cjs/presentation-common/Update.js +226 -226
  51. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  52. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  53. package/lib/cjs/presentation-common/Utils.js +43 -43
  54. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  55. package/lib/cjs/presentation-common/content/Category.js +48 -48
  56. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  57. package/lib/cjs/presentation-common/content/Content.js +56 -56
  58. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  59. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -437
  60. package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
  61. package/lib/cjs/presentation-common/content/Descriptor.js +191 -191
  62. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  63. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  64. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  65. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  66. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -298
  67. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  68. package/lib/cjs/presentation-common/content/Fields.js +393 -393
  69. package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
  70. package/lib/cjs/presentation-common/content/Item.js +84 -84
  71. package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
  72. package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
  73. package/lib/cjs/presentation-common/content/Property.js +40 -40
  74. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  75. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  76. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  77. package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
  78. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  79. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  80. package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
  81. package/lib/cjs/presentation-common/content/Value.js +273 -273
  82. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  83. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
  84. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  85. package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
  86. package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
  87. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
  88. package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
  89. package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
  90. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  91. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
  92. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  93. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  94. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  95. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  96. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  97. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  98. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  99. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  100. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  101. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  102. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  103. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  104. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  105. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  106. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  107. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  108. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  109. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  110. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  111. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  112. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  113. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  114. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  115. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  116. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  117. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  118. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  119. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  120. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  121. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  122. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  123. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  124. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  125. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  126. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  127. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  128. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  129. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  130. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  131. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  132. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  133. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  134. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  135. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  136. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  137. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  138. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  139. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  140. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  141. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  142. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  143. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  144. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  145. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  146. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  147. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  148. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  149. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  150. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  151. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  152. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  153. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  154. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  155. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  156. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  157. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  158. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  159. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  160. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  161. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  162. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  163. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  164. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  165. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  166. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  167. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  168. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  169. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  170. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  171. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  172. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  173. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  174. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  175. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  176. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  177. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  178. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  179. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  180. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  181. package/lib/cjs/presentation-common.d.ts +113 -113
  182. package/lib/cjs/presentation-common.js +133 -129
  183. package/lib/cjs/presentation-common.js.map +1 -1
  184. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  185. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  186. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  187. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  188. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  189. package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
  190. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  191. package/lib/esm/presentation-common/EC.d.ts +350 -350
  192. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  193. package/lib/esm/presentation-common/EC.js +287 -287
  194. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  195. package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
  196. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  197. package/lib/esm/presentation-common/Error.d.ts +47 -47
  198. package/lib/esm/presentation-common/Error.js +60 -60
  199. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  200. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  201. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  202. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  203. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  204. package/lib/esm/presentation-common/KeySet.js +424 -424
  205. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -93
  206. package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
  207. package/lib/esm/presentation-common/LabelDefinition.js +75 -75
  208. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  209. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  210. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  211. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  212. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -273
  213. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  214. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  215. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  216. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  217. package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
  218. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  219. package/lib/esm/presentation-common/PropertyFormatter.d.ts +30 -30
  220. package/lib/esm/presentation-common/PropertyFormatter.js +193 -193
  221. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  222. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  223. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  224. package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -162
  225. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  226. package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
  227. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  228. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  229. package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
  230. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  231. package/lib/esm/presentation-common/Update.d.ts +213 -213
  232. package/lib/esm/presentation-common/Update.d.ts.map +1 -1
  233. package/lib/esm/presentation-common/Update.js +223 -223
  234. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  235. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  236. package/lib/esm/presentation-common/Utils.js +39 -39
  237. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  238. package/lib/esm/presentation-common/content/Category.js +45 -45
  239. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  240. package/lib/esm/presentation-common/content/Content.js +52 -52
  241. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  242. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -427
  243. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  244. package/lib/esm/presentation-common/content/Descriptor.js +187 -187
  245. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  246. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  247. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  248. package/lib/esm/presentation-common/content/Editor.js +8 -8
  249. package/lib/esm/presentation-common/content/Fields.d.ts +298 -298
  250. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  251. package/lib/esm/presentation-common/content/Fields.js +386 -386
  252. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  253. package/lib/esm/presentation-common/content/Item.js +80 -80
  254. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  255. package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
  256. package/lib/esm/presentation-common/content/Property.js +37 -37
  257. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  258. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  259. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  260. package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
  261. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  262. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  263. package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
  264. package/lib/esm/presentation-common/content/Value.js +270 -270
  265. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  266. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  267. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  268. package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
  269. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  270. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  271. package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
  272. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  273. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  274. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  275. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  276. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  277. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  278. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  279. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  280. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  281. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  282. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  283. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  284. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  285. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  286. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  287. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  288. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  289. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  290. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  291. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  292. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  293. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  294. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  295. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  296. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  297. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  298. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  299. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  300. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  301. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  302. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  303. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  304. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  305. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  306. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  307. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  308. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  309. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  310. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  311. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  312. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  313. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  314. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  315. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  316. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  317. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  318. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  319. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  320. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  321. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  322. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  323. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  324. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  325. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  326. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  327. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  328. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  329. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  330. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  331. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  332. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  333. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  334. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  335. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  336. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  337. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  338. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  339. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  340. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  341. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  342. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  343. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  344. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  345. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  346. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  347. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  348. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  349. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  350. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  351. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  352. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  353. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  354. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  355. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  356. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  357. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  358. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  359. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  360. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  361. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  362. package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  363. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  364. package/lib/esm/presentation-common.d.ts +113 -113
  365. package/lib/esm/presentation-common.js +117 -117
  366. package/package.json +12 -12
@@ -1,83 +1,83 @@
1
- /** @packageDocumentation
2
- * @module RPC
3
- */
4
- import { IModelRpcProps } from "@itwin/core-common";
5
- import { DescriptorJSON, DescriptorOverrides } from "./content/Descriptor";
6
- import { ItemJSON } from "./content/Item";
7
- import { DisplayValueGroupJSON } from "./content/Value";
8
- import { ClientDiagnosticsAttribute } from "./Diagnostics";
9
- import { InstanceKey } from "./EC";
10
- import { ElementProperties } from "./ElementProperties";
11
- import { NodeKey } from "./hierarchy/Key";
12
- import { NodeJSON } from "./hierarchy/Node";
13
- import { NodePathElementJSON } from "./hierarchy/NodePathElement";
14
- import { KeySetJSON } from "./KeySet";
15
- import { LabelDefinition } from "./LabelDefinition";
16
- import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, RequestOptions, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
17
- import { ContentSourcesRpcResult, PresentationRpcRequestOptions, PresentationRpcResponse } from "./PresentationRpcInterface";
18
- import { RulesetVariableJSON } from "./RulesetVariables";
19
- import { SelectionScope } from "./selection/SelectionScope";
20
- import { PagedResponse } from "./Utils";
21
- /**
22
- * Configuration parameters for [[RpcRequestsHandler]].
23
- *
24
- * @internal
25
- */
26
- export interface RpcRequestsHandlerProps {
27
- /**
28
- * Optional ID used to identify client that requests data. If not specified,
29
- * the handler creates a unique GUID as a client id.
30
- * @internal
31
- */
32
- clientId?: string;
33
- /** @internal */
34
- timeout?: number;
35
- }
36
- /**
37
- * RPC requests handler that wraps [[PresentationRpcInterface]] and
38
- * adds handling for cases when backend needs to be synced with client
39
- * state.
40
- *
41
- * @internal
42
- */
43
- export declare class RpcRequestsHandler {
44
- /** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */
45
- readonly timeout: number;
46
- /** ID that identifies this handler as a client */
47
- readonly clientId: string;
48
- constructor(props?: RpcRequestsHandlerProps);
49
- private get rpcClient();
50
- private requestWithTimeout;
51
- /**
52
- * Send the request to backend.
53
- *
54
- * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
55
- * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
56
- * is thrown with the details from the response.
57
- */
58
- request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>, options: TOptions, ...additionalOptions: TArg[]): Promise<TResult>;
59
- getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
60
- getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>>;
61
- getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
62
- getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
63
- getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
64
- getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult>;
65
- getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
66
- getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
67
- getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<{
68
- descriptor: DescriptorJSON;
69
- contentSet: PagedResponse<ItemJSON>;
70
- } | undefined>;
71
- getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<PagedResponse<ItemJSON>>;
72
- getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>>;
73
- getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
74
- getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{
75
- total: number;
76
- items: KeySetJSON;
77
- }>;
78
- getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
79
- getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>>;
80
- getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]>;
81
- computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON>;
82
- }
1
+ /** @packageDocumentation
2
+ * @module RPC
3
+ */
4
+ import { IModelRpcProps } from "@itwin/core-common";
5
+ import { DescriptorJSON, DescriptorOverrides } from "./content/Descriptor";
6
+ import { ItemJSON } from "./content/Item";
7
+ import { DisplayValueGroupJSON } from "./content/Value";
8
+ import { ClientDiagnosticsAttribute } from "./Diagnostics";
9
+ import { InstanceKey } from "./EC";
10
+ import { ElementProperties } from "./ElementProperties";
11
+ import { NodeKey } from "./hierarchy/Key";
12
+ import { NodeJSON } from "./hierarchy/Node";
13
+ import { NodePathElementJSON } from "./hierarchy/NodePathElement";
14
+ import { KeySetJSON } from "./KeySet";
15
+ import { LabelDefinition } from "./LabelDefinition";
16
+ import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, RequestOptions, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
17
+ import { ContentSourcesRpcResult, PresentationRpcRequestOptions, PresentationRpcResponse } from "./PresentationRpcInterface";
18
+ import { RulesetVariableJSON } from "./RulesetVariables";
19
+ import { SelectionScope } from "./selection/SelectionScope";
20
+ import { PagedResponse } from "./Utils";
21
+ /**
22
+ * Configuration parameters for [[RpcRequestsHandler]].
23
+ *
24
+ * @internal
25
+ */
26
+ export interface RpcRequestsHandlerProps {
27
+ /**
28
+ * Optional ID used to identify client that requests data. If not specified,
29
+ * the handler creates a unique GUID as a client id.
30
+ * @internal
31
+ */
32
+ clientId?: string;
33
+ /** @internal */
34
+ timeout?: number;
35
+ }
36
+ /**
37
+ * RPC requests handler that wraps [[PresentationRpcInterface]] and
38
+ * adds handling for cases when backend needs to be synced with client
39
+ * state.
40
+ *
41
+ * @internal
42
+ */
43
+ export declare class RpcRequestsHandler {
44
+ /** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */
45
+ readonly timeout: number;
46
+ /** ID that identifies this handler as a client */
47
+ readonly clientId: string;
48
+ constructor(props?: RpcRequestsHandlerProps);
49
+ private get rpcClient();
50
+ private requestWithTimeout;
51
+ /**
52
+ * Send the request to backend.
53
+ *
54
+ * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
55
+ * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
56
+ * is thrown with the details from the response.
57
+ */
58
+ request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>, options: TOptions, ...additionalOptions: TArg[]): Promise<TResult>;
59
+ getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
60
+ getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>>;
61
+ getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
62
+ getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
63
+ getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
64
+ getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult>;
65
+ getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
66
+ getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
67
+ getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<{
68
+ descriptor: DescriptorJSON;
69
+ contentSet: PagedResponse<ItemJSON>;
70
+ } | undefined>;
71
+ getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<PagedResponse<ItemJSON>>;
72
+ getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>>;
73
+ getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
74
+ getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{
75
+ total: number;
76
+ items: KeySetJSON;
77
+ }>;
78
+ getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
79
+ getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>>;
80
+ getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]>;
81
+ computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON>;
82
+ }
83
83
  //# sourceMappingURL=RpcRequestsHandler.d.ts.map
@@ -1,163 +1,163 @@
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 RPC
7
- */
8
- import { BeDuration, BeTimePoint, Guid, Logger } from "@itwin/core-bentley";
9
- import { RpcManager } from "@itwin/core-common";
10
- import { PresentationCommonLoggerCategory } from "./CommonLoggerCategory";
11
- import { PresentationError, PresentationStatus } from "./Error";
12
- import { PresentationRpcInterface, } from "./PresentationRpcInterface";
13
- /**
14
- * Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing
15
- * a timeout error.
16
- */
17
- const DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes
18
- /**
19
- * RPC requests handler that wraps [[PresentationRpcInterface]] and
20
- * adds handling for cases when backend needs to be synced with client
21
- * state.
22
- *
23
- * @internal
24
- */
25
- export class RpcRequestsHandler {
26
- constructor(props) {
27
- this.clientId = props?.clientId ?? Guid.createValue();
28
- this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;
29
- }
30
- // eslint-disable-next-line @typescript-eslint/naming-convention
31
- get rpcClient() { return RpcManager.getClientForInterface(PresentationRpcInterface); }
32
- async requestWithTimeout(func, diagnosticsHandler) {
33
- const start = BeTimePoint.now();
34
- const timeout = BeDuration.fromMilliseconds(this.timeout);
35
- let diagnostics;
36
- while (start.plus(timeout).isInFuture) {
37
- try {
38
- const response = await func();
39
- diagnostics = response.diagnostics;
40
- switch (response.statusCode) {
41
- case PresentationStatus.Success: return response.result;
42
- case PresentationStatus.BackendTimeout: break;
43
- default: throw new PresentationError(response.statusCode, response.errorMessage);
44
- }
45
- }
46
- finally {
47
- diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
48
- }
49
- }
50
- throw new PresentationError(PresentationStatus.BackendTimeout);
51
- }
52
- /**
53
- * Send the request to backend.
54
- *
55
- * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
56
- * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
57
- * is thrown with the details from the response.
58
- */
59
- async request(func, options, ...additionalOptions) {
60
- const { imodel, diagnostics, ...optionsNoIModel } = options;
61
- const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};
62
- if (isOptionsWithRuleset(optionsNoIModel)) {
63
- optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
64
- }
65
- const rpcOptions = {
66
- ...optionsNoIModel,
67
- clientId: this.clientId,
68
- };
69
- if (diagnostics) {
70
- rpcOptions.diagnostics = diagnosticsOptions;
71
- }
72
- const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
73
- return this.requestWithTimeout(doRequest, diagnosticsHandler);
74
- }
75
- async getNodesCount(options) {
76
- return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
77
- }
78
- // eslint-disable-next-line deprecation/deprecation
79
- async getPagedNodes(options) {
80
- // eslint-disable-next-line deprecation/deprecation
81
- return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
82
- }
83
- async getNodesDescriptor(options) {
84
- const response = await this.request(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);
85
- if (typeof response === "string")
86
- return JSON.parse(response);
87
- return response;
88
- }
89
- // eslint-disable-next-line deprecation/deprecation
90
- async getNodePaths(options) {
91
- // eslint-disable-next-line deprecation/deprecation
92
- return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
93
- }
94
- // eslint-disable-next-line deprecation/deprecation
95
- async getFilteredNodePaths(options) {
96
- // eslint-disable-next-line deprecation/deprecation
97
- return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
98
- }
99
- async getContentSources(options) {
100
- return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
101
- }
102
- async getContentDescriptor(options) {
103
- return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
104
- }
105
- async getContentSetSize(options) {
106
- return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
107
- }
108
- async getPagedContent(options) {
109
- return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
110
- }
111
- async getPagedContentSet(options) {
112
- return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
113
- }
114
- // eslint-disable-next-line deprecation/deprecation
115
- async getPagedDistinctValues(options) {
116
- // eslint-disable-next-line deprecation/deprecation
117
- return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
118
- }
119
- async getElementProperties(options) {
120
- return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
121
- }
122
- async getContentInstanceKeys(options) {
123
- return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
124
- }
125
- async getDisplayLabelDefinition(options) {
126
- return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
127
- }
128
- async getPagedDisplayLabelDefinitions(options) {
129
- return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
130
- }
131
- async getSelectionScopes(options) {
132
- return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
133
- }
134
- async computeSelection(options) {
135
- return this.request(
136
- // eslint-disable-next-line deprecation/deprecation
137
- this.rpcClient.computeSelection.bind(this.rpcClient), options);
138
- }
139
- }
140
- function isOptionsWithRuleset(options) {
141
- return (typeof options.rulesetOrId === "object");
142
- }
143
- const RULESET_SUPPORTED_PROPERTIES_OBJ = {
144
- id: true,
145
- rules: true,
146
- version: true,
147
- requiredSchemas: true,
148
- supplementationInfo: true,
149
- vars: true,
150
- };
151
- function cleanupRuleset(ruleset) {
152
- const cleanedUpRuleset = { ...ruleset };
153
- for (const propertyKey of Object.keys(cleanedUpRuleset)) {
154
- if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
155
- if (propertyKey === "$schema")
156
- delete cleanedUpRuleset[propertyKey];
157
- else
158
- Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
159
- }
160
- }
161
- return cleanedUpRuleset;
162
- }
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 RPC
7
+ */
8
+ import { BeDuration, BeTimePoint, Guid, Logger } from "@itwin/core-bentley";
9
+ import { RpcManager } from "@itwin/core-common";
10
+ import { PresentationCommonLoggerCategory } from "./CommonLoggerCategory";
11
+ import { PresentationError, PresentationStatus } from "./Error";
12
+ import { PresentationRpcInterface, } from "./PresentationRpcInterface";
13
+ /**
14
+ * Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing
15
+ * a timeout error.
16
+ */
17
+ const DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes
18
+ /**
19
+ * RPC requests handler that wraps [[PresentationRpcInterface]] and
20
+ * adds handling for cases when backend needs to be synced with client
21
+ * state.
22
+ *
23
+ * @internal
24
+ */
25
+ export class RpcRequestsHandler {
26
+ constructor(props) {
27
+ this.clientId = props?.clientId ?? Guid.createValue();
28
+ this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;
29
+ }
30
+ // eslint-disable-next-line @typescript-eslint/naming-convention
31
+ get rpcClient() { return RpcManager.getClientForInterface(PresentationRpcInterface); }
32
+ async requestWithTimeout(func, diagnosticsHandler) {
33
+ const start = BeTimePoint.now();
34
+ const timeout = BeDuration.fromMilliseconds(this.timeout);
35
+ let diagnostics;
36
+ while (start.plus(timeout).isInFuture) {
37
+ try {
38
+ const response = await func();
39
+ diagnostics = response.diagnostics;
40
+ switch (response.statusCode) {
41
+ case PresentationStatus.Success: return response.result;
42
+ case PresentationStatus.BackendTimeout: break;
43
+ default: throw new PresentationError(response.statusCode, response.errorMessage);
44
+ }
45
+ }
46
+ finally {
47
+ diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
48
+ }
49
+ }
50
+ throw new PresentationError(PresentationStatus.BackendTimeout);
51
+ }
52
+ /**
53
+ * Send the request to backend.
54
+ *
55
+ * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
56
+ * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
57
+ * is thrown with the details from the response.
58
+ */
59
+ async request(func, options, ...additionalOptions) {
60
+ const { imodel, diagnostics, ...optionsNoIModel } = options;
61
+ const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};
62
+ if (isOptionsWithRuleset(optionsNoIModel)) {
63
+ optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
64
+ }
65
+ const rpcOptions = {
66
+ ...optionsNoIModel,
67
+ clientId: this.clientId,
68
+ };
69
+ if (diagnostics) {
70
+ rpcOptions.diagnostics = diagnosticsOptions;
71
+ }
72
+ const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
73
+ return this.requestWithTimeout(doRequest, diagnosticsHandler);
74
+ }
75
+ async getNodesCount(options) {
76
+ return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
77
+ }
78
+ // eslint-disable-next-line deprecation/deprecation
79
+ async getPagedNodes(options) {
80
+ // eslint-disable-next-line deprecation/deprecation
81
+ return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
82
+ }
83
+ async getNodesDescriptor(options) {
84
+ const response = await this.request(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);
85
+ if (typeof response === "string")
86
+ return JSON.parse(response);
87
+ return response;
88
+ }
89
+ // eslint-disable-next-line deprecation/deprecation
90
+ async getNodePaths(options) {
91
+ // eslint-disable-next-line deprecation/deprecation
92
+ return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
93
+ }
94
+ // eslint-disable-next-line deprecation/deprecation
95
+ async getFilteredNodePaths(options) {
96
+ // eslint-disable-next-line deprecation/deprecation
97
+ return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
98
+ }
99
+ async getContentSources(options) {
100
+ return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
101
+ }
102
+ async getContentDescriptor(options) {
103
+ return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
104
+ }
105
+ async getContentSetSize(options) {
106
+ return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
107
+ }
108
+ async getPagedContent(options) {
109
+ return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
110
+ }
111
+ async getPagedContentSet(options) {
112
+ return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
113
+ }
114
+ // eslint-disable-next-line deprecation/deprecation
115
+ async getPagedDistinctValues(options) {
116
+ // eslint-disable-next-line deprecation/deprecation
117
+ return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
118
+ }
119
+ async getElementProperties(options) {
120
+ return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
121
+ }
122
+ async getContentInstanceKeys(options) {
123
+ return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
124
+ }
125
+ async getDisplayLabelDefinition(options) {
126
+ return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
127
+ }
128
+ async getPagedDisplayLabelDefinitions(options) {
129
+ return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
130
+ }
131
+ async getSelectionScopes(options) {
132
+ return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
133
+ }
134
+ async computeSelection(options) {
135
+ return this.request(
136
+ // eslint-disable-next-line deprecation/deprecation
137
+ this.rpcClient.computeSelection.bind(this.rpcClient), options);
138
+ }
139
+ }
140
+ function isOptionsWithRuleset(options) {
141
+ return (typeof options.rulesetOrId === "object");
142
+ }
143
+ const RULESET_SUPPORTED_PROPERTIES_OBJ = {
144
+ id: true,
145
+ rules: true,
146
+ version: true,
147
+ requiredSchemas: true,
148
+ supplementationInfo: true,
149
+ vars: true,
150
+ };
151
+ function cleanupRuleset(ruleset) {
152
+ const cleanedUpRuleset = { ...ruleset };
153
+ for (const propertyKey of Object.keys(cleanedUpRuleset)) {
154
+ if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
155
+ if (propertyKey === "$schema")
156
+ delete cleanedUpRuleset[propertyKey];
157
+ else
158
+ Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
159
+ }
160
+ }
161
+ return cleanedUpRuleset;
162
+ }
163
163
  //# sourceMappingURL=RpcRequestsHandler.js.map