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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. package/CHANGELOG.md +51 -1
  2. package/Ruleset.schema.json +11 -0
  3. package/lib/cjs/assets/locales/en/Presentation.json +15 -0
  4. package/lib/cjs/assets/locales/en-PSEUDO/Presentation.json +15 -0
  5. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  6. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  7. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  9. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  10. package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
  11. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  12. package/lib/cjs/presentation-common/EC.d.ts +347 -350
  13. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  14. package/lib/cjs/presentation-common/EC.js +290 -290
  15. package/lib/cjs/presentation-common/EC.js.map +1 -1
  16. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  17. package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
  18. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  19. package/lib/cjs/presentation-common/Error.d.ts +47 -45
  20. package/lib/cjs/presentation-common/Error.d.ts.map +1 -1
  21. package/lib/cjs/presentation-common/Error.js +64 -62
  22. package/lib/cjs/presentation-common/Error.js.map +1 -1
  23. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  25. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  26. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  27. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  28. package/lib/cjs/presentation-common/KeySet.js +428 -428
  29. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -87
  30. package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
  31. package/lib/cjs/presentation-common/LabelDefinition.js +78 -73
  32. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  33. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  34. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  35. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  36. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  37. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -261
  38. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  39. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  40. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  41. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
  42. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  43. package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
  44. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  45. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +31 -0
  46. package/lib/cjs/presentation-common/PropertyFormatter.d.ts.map +1 -0
  47. package/lib/cjs/presentation-common/PropertyFormatter.js +199 -0
  48. package/lib/cjs/presentation-common/PropertyFormatter.js.map +1 -0
  49. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  50. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  51. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -83
  52. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  53. package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -171
  54. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  55. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  56. package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
  57. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  58. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  59. package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
  60. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  61. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  62. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  63. package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
  64. package/lib/cjs/presentation-common/Update.js +226 -226
  65. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  66. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  67. package/lib/cjs/presentation-common/Utils.js +43 -43
  68. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  69. package/lib/cjs/presentation-common/content/Category.js +48 -48
  70. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  71. package/lib/cjs/presentation-common/content/Content.js +56 -56
  72. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  73. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -439
  74. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  75. package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
  76. package/lib/cjs/presentation-common/content/Descriptor.js +191 -193
  77. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  78. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  79. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  80. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  81. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  82. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -301
  83. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  84. package/lib/cjs/presentation-common/content/Fields.js +393 -397
  85. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  86. package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
  87. package/lib/cjs/presentation-common/content/Item.d.ts.map +1 -1
  88. package/lib/cjs/presentation-common/content/Item.js +84 -84
  89. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  90. package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
  91. package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
  92. package/lib/cjs/presentation-common/content/Property.js +40 -40
  93. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  94. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  95. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  96. package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
  97. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  98. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  99. package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
  100. package/lib/cjs/presentation-common/content/Value.js +273 -273
  101. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  102. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
  103. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  104. package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
  105. package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
  106. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  107. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
  108. package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
  109. package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
  110. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  111. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  112. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
  113. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  114. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  115. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  116. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  117. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  118. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  119. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  120. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  121. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  122. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  123. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  124. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  125. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  126. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  127. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  128. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  129. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  130. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  131. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  132. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  133. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  134. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  135. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  136. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  137. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  138. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  139. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  140. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  141. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  142. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  143. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  144. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  145. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  146. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  147. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  148. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  149. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  150. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  151. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  152. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  153. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  154. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  155. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  156. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  157. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  158. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  159. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  160. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  161. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  162. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  163. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  164. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  165. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  166. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  167. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  168. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  169. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  170. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  171. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  172. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  173. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  174. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  175. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  176. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  177. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  178. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  179. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  180. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  181. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  182. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  183. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  184. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  185. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  186. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  187. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  188. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  189. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  190. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  191. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  192. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  193. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  194. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  195. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  196. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  197. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  198. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  199. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  200. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  201. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  202. package/lib/cjs/presentation-common.d.ts +113 -112
  203. package/lib/cjs/presentation-common.d.ts.map +1 -1
  204. package/lib/cjs/presentation-common.js +133 -128
  205. package/lib/cjs/presentation-common.js.map +1 -1
  206. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  207. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  208. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  209. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  210. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  211. package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
  212. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  213. package/lib/esm/presentation-common/EC.d.ts +347 -350
  214. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  215. package/lib/esm/presentation-common/EC.js +287 -287
  216. package/lib/esm/presentation-common/EC.js.map +1 -1
  217. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  218. package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
  219. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  220. package/lib/esm/presentation-common/Error.d.ts +47 -45
  221. package/lib/esm/presentation-common/Error.d.ts.map +1 -1
  222. package/lib/esm/presentation-common/Error.js +60 -58
  223. package/lib/esm/presentation-common/Error.js.map +1 -1
  224. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  225. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  226. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  227. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  228. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  229. package/lib/esm/presentation-common/KeySet.js +424 -424
  230. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -87
  231. package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
  232. package/lib/esm/presentation-common/LabelDefinition.js +75 -70
  233. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  234. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  235. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  236. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  237. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  238. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -261
  239. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  240. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  241. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  242. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  243. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  244. package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
  245. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  246. package/lib/esm/presentation-common/PropertyFormatter.d.ts +31 -0
  247. package/lib/esm/presentation-common/PropertyFormatter.d.ts.map +1 -0
  248. package/lib/esm/presentation-common/PropertyFormatter.js +194 -0
  249. package/lib/esm/presentation-common/PropertyFormatter.js.map +1 -0
  250. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  251. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  252. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -83
  253. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  254. package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -167
  255. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  256. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  257. package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
  258. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  259. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  260. package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
  261. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  262. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  263. package/lib/esm/presentation-common/Update.d.ts +213 -213
  264. package/lib/esm/presentation-common/Update.d.ts.map +1 -1
  265. package/lib/esm/presentation-common/Update.js +223 -223
  266. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  267. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  268. package/lib/esm/presentation-common/Utils.js +39 -39
  269. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  270. package/lib/esm/presentation-common/content/Category.js +45 -45
  271. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  272. package/lib/esm/presentation-common/content/Content.js +52 -52
  273. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  274. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -429
  275. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  276. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  277. package/lib/esm/presentation-common/content/Descriptor.js +187 -189
  278. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  279. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  280. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  281. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  282. package/lib/esm/presentation-common/content/Editor.js +8 -8
  283. package/lib/esm/presentation-common/content/Fields.d.ts +298 -301
  284. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  285. package/lib/esm/presentation-common/content/Fields.js +386 -390
  286. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  287. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  288. package/lib/esm/presentation-common/content/Item.d.ts.map +1 -1
  289. package/lib/esm/presentation-common/content/Item.js +80 -80
  290. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  291. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  292. package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
  293. package/lib/esm/presentation-common/content/Property.js +37 -37
  294. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  295. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  296. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  297. package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
  298. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  299. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  300. package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
  301. package/lib/esm/presentation-common/content/Value.js +270 -270
  302. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  303. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  304. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  305. package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
  306. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  307. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  308. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  309. package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
  310. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  311. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  312. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  313. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  314. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  315. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  316. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  317. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  318. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  319. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  320. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  321. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  322. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  323. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  324. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  325. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  326. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  327. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  328. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  329. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  330. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  331. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  332. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  333. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  334. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  335. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  336. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  337. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  338. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  339. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  340. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  341. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  342. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  343. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  344. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  345. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  346. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  347. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  348. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  349. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  350. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  351. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  352. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  353. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  354. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  355. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  356. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  357. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  358. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  359. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  360. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  361. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  362. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  363. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  364. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  365. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  366. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  367. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  368. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  369. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  370. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  371. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  372. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  373. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  374. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  375. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  376. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  377. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  378. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  379. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  380. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  381. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  382. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  383. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  384. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  385. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  386. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  387. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  388. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  389. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  390. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  391. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  392. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  393. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  394. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  395. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  396. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  397. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  398. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  399. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  400. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  401. package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  402. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  403. package/lib/esm/presentation-common.d.ts +113 -112
  404. package/lib/esm/presentation-common.d.ts.map +1 -1
  405. package/lib/esm/presentation-common.js +117 -116
  406. package/lib/esm/presentation-common.js.map +1 -1
  407. package/lib/public/locales/en/Presentation.json +15 -0
  408. package/package.json +17 -15
  409. package/lib/cjs/assets/locales/en/BisCore.json +0 -18
  410. package/lib/cjs/assets/locales/en/ECPresentation.json +0 -9
  411. package/lib/cjs/assets/locales/en/RulesEngine.json +0 -6
  412. package/lib/cjs/assets/locales/en-PSEUDO/BisCore.json +0 -18
  413. package/lib/cjs/assets/locales/en-PSEUDO/ECPresentation.json +0 -9
  414. package/lib/cjs/assets/locales/en-PSEUDO/RulesEngine.json +0 -6
  415. package/lib/public/locales/en/BisCore.json +0 -18
  416. package/lib/public/locales/en/ECPresentation.json +0 -9
  417. package/lib/public/locales/en/RulesEngine.json +0 -6
@@ -1,41 +1,41 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- import { NodeKey } from "./hierarchy/Key";
5
- import { RulesetVariableJSON } from "./RulesetVariables";
6
- /** @internal */
7
- export declare const PRESENTATION_IPC_CHANNEL_NAME = "presentation-ipc-interface";
8
- /** @internal */
9
- export interface CommonIpcParams {
10
- clientId: string;
11
- }
12
- /** @internal */
13
- export interface SetRulesetVariableParams<TVariable> extends CommonIpcParams {
14
- rulesetId: string;
15
- variable: TVariable;
16
- }
17
- /** @internal */
18
- export interface UnsetRulesetVariableParams extends CommonIpcParams {
19
- rulesetId: string;
20
- variableId: string;
21
- }
22
- /** @internal */
23
- export interface UpdateHierarchyStateParams<TNodeKey> extends CommonIpcParams {
24
- rulesetId: string;
25
- imodelKey: string;
26
- stateChanges: Array<{
27
- nodeKey: TNodeKey | undefined;
28
- isExpanded?: boolean;
29
- instanceFilters?: string[];
30
- }>;
31
- }
32
- /** @internal */
33
- export interface PresentationIpcInterface {
34
- /** Sets ruleset variable value. */
35
- setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;
36
- /** Unsets ruleset variable value. */
37
- unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;
38
- /** Updates hierarchy state saved on the backend. Hierarchy state is used when performing updates after iModel data changes */
39
- updateHierarchyState(params: UpdateHierarchyStateParams<NodeKey>): Promise<void>;
40
- }
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ import { NodeKey } from "./hierarchy/Key";
5
+ import { RulesetVariableJSON } from "./RulesetVariables";
6
+ /** @internal */
7
+ export declare const PRESENTATION_IPC_CHANNEL_NAME = "presentation-ipc-interface";
8
+ /** @internal */
9
+ export interface CommonIpcParams {
10
+ clientId: string;
11
+ }
12
+ /** @internal */
13
+ export interface SetRulesetVariableParams<TVariable> extends CommonIpcParams {
14
+ rulesetId: string;
15
+ variable: TVariable;
16
+ }
17
+ /** @internal */
18
+ export interface UnsetRulesetVariableParams extends CommonIpcParams {
19
+ rulesetId: string;
20
+ variableId: string;
21
+ }
22
+ /** @internal */
23
+ export interface UpdateHierarchyStateParams<TNodeKey> extends CommonIpcParams {
24
+ rulesetId: string;
25
+ imodelKey: string;
26
+ stateChanges: Array<{
27
+ nodeKey: TNodeKey | undefined;
28
+ isExpanded?: boolean;
29
+ instanceFilters?: string[];
30
+ }>;
31
+ }
32
+ /** @internal */
33
+ export interface PresentationIpcInterface {
34
+ /** Sets ruleset variable value. */
35
+ setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;
36
+ /** Unsets ruleset variable value. */
37
+ unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;
38
+ /** Updates hierarchy state saved on the backend. Hierarchy state is used when performing updates after iModel data changes */
39
+ updateHierarchyState(params: UpdateHierarchyStateParams<NodeKey>): Promise<void>;
40
+ }
41
41
  //# sourceMappingURL=PresentationIpcInterface.d.ts.map
@@ -1,10 +1,10 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Core
7
- */
8
- /** @internal */
9
- export const PRESENTATION_IPC_CHANNEL_NAME = "presentation-ipc-interface";
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Core
7
+ */
8
+ /** @internal */
9
+ export const PRESENTATION_IPC_CHANNEL_NAME = "presentation-ipc-interface";
10
10
  //# sourceMappingURL=PresentationIpcInterface.js.map
@@ -1,262 +1,274 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- import { BeEvent, Id64String } from "@itwin/core-bentley";
5
- import { UnitSystemKey } from "@itwin/core-quantity";
6
- import { SelectionInfo } from "./content/Descriptor";
7
- import { FieldDescriptor } from "./content/Fields";
8
- import { InstanceKey } from "./EC";
9
- import { InstanceFilterDefinition } from "./InstanceFilterDefinition";
10
- import { Ruleset } from "./rules/Ruleset";
11
- import { RulesetVariable } from "./RulesetVariables";
12
- import { SelectionScopeProps } from "./selection/SelectionScope";
13
- /**
14
- * A generic request options type used for both hierarchy and content requests.
15
- * @public
16
- */
17
- export interface RequestOptions<TIModel> {
18
- /** iModel to request data from */
19
- imodel: TIModel;
20
- /** Optional locale to use when formatting / localizing data */
21
- locale?: string;
22
- /**
23
- * Unit system to use when formatting property values with units. Default presentation
24
- * unit is used if unit system is not specified.
25
- */
26
- unitSystem?: UnitSystemKey;
27
- /**
28
- * Expected form of response. This property is set automatically on newer frontends.
29
- * `unparsed-json` — deliver response from native addon without parsing it.
30
- * @internal
31
- */
32
- transport?: "unparsed-json";
33
- }
34
- /**
35
- * Options for requests that require presentation ruleset. Not
36
- * meant to be used directly, see one of the subclasses.
37
- *
38
- * @public
39
- */
40
- export interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {
41
- /** Ruleset or id of the ruleset to use when requesting data */
42
- rulesetOrId: Ruleset | string;
43
- /** Ruleset variables to use when requesting data */
44
- rulesetVariables?: TRulesetVariable[];
45
- }
46
- /**
47
- * Request type for hierarchy requests.
48
- * @public
49
- */
50
- export interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
51
- /** Key of the parent node to get children for */
52
- parentKey?: TNodeKey;
53
- /**
54
- * An instance filter that should be applied for this hierarchy level.
55
- *
56
- * **Note:** May only be used on hierarchy levels that support filtering - check [[NavNode.supportsFiltering]] before
57
- * requesting filtered children.
58
- *
59
- * @beta
60
- */
61
- instanceFilter?: InstanceFilterDefinition;
62
- }
63
- /**
64
- * Params for hierarchy level descriptor requests.
65
- * @beta
66
- */
67
- export interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
68
- /** Key of the parent node to get hierarchy level descriptor for. */
69
- parentKey?: TNodeKey;
70
- }
71
- /**
72
- * Request type of filtering hierarchies by given ECInstance paths.
73
- * @public
74
- */
75
- export interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
76
- /** A list of paths from root ECInstance to target ECInstance. */
77
- instancePaths: InstanceKey[][];
78
- /**
79
- * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The
80
- * path is marked using `NodePathElement.isMarked` flag in the result.
81
- */
82
- markedIndex?: number;
83
- }
84
- /**
85
- * Request type of filtering hierarchies by given text.
86
- * @public
87
- */
88
- export interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
89
- /** Text to filter the hierarchy by. */
90
- filterText: string;
91
- }
92
- /**
93
- * Request type for content sources requests.
94
- * @public
95
- */
96
- export interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {
97
- /** Full names of classes to get content sources for. Format for a full class name: `SchemaName:ClassName`. */
98
- classes: string[];
99
- }
100
- /**
101
- * Request type for content descriptor requests.
102
- * @public
103
- */
104
- export interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
105
- /**
106
- * Content display type.
107
- * @see [[DefaultContentDisplayTypes]]
108
- */
109
- displayType: string;
110
- /** Input keys for getting the content */
111
- keys: TKeySet;
112
- /** Information about the selection event that was the cause of this content request */
113
- selection?: SelectionInfo;
114
- }
115
- /**
116
- * Request type for content requests.
117
- * @public
118
- */
119
- export interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
120
- /** Content descriptor for customizing the returned content */
121
- descriptor: TDescriptor;
122
- /** Input keys for getting the content */
123
- keys: TKeySet;
124
- }
125
- /**
126
- * Request type for distinct values' requests.
127
- * @public
128
- */
129
- export interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
130
- /** Content descriptor for customizing the returned content */
131
- descriptor: TDescriptor;
132
- /** Input keys for getting the content */
133
- keys: TKeySet;
134
- /** Descriptor for a field distinct values are requested for */
135
- fieldDescriptor: FieldDescriptor;
136
- }
137
- /**
138
- * Request type for element properties requests
139
- * @public
140
- */
141
- export declare type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;
142
- /**
143
- * Request type for single element properties requests.
144
- * @public
145
- */
146
- export interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
147
- /** ID of the element to get properties for. */
148
- elementId: Id64String;
149
- }
150
- /**
151
- * Request type for multiple elements properties requests.
152
- * @public
153
- */
154
- export interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
155
- /**
156
- * Classes of the elements to get properties for. If [[elementClasses]] is `undefined`, all classes
157
- * are used. Classes should be specified in one of these formats: "<schema name or alias>.<class_name>" or
158
- * "<schema name or alias>:<class_name>".
159
- */
160
- elementClasses?: string[];
161
- }
162
- /**
163
- * Request type for content instance keys' requests.
164
- * @public
165
- */
166
- export interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
167
- /**
168
- * Content display type.
169
- * @see [[DefaultContentDisplayTypes]]
170
- */
171
- displayType?: string;
172
- /** Input keys for getting the content. */
173
- keys: TKeySet;
174
- }
175
- /**
176
- * Request type for label requests
177
- * @public
178
- */
179
- export interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
180
- /** Key of ECInstance to get label for */
181
- key: TInstanceKey;
182
- }
183
- /**
184
- * Request type for labels requests
185
- * @public
186
- */
187
- export interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
188
- /** Keys of ECInstances to get labels for */
189
- keys: TInstanceKey[];
190
- }
191
- /**
192
- * Request options used for selection scope related requests
193
- * @public
194
- */
195
- export interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> {
196
- }
197
- /**
198
- * Request options used for calculating selection based on given instance keys and selection scope.
199
- * @public
200
- */
201
- export interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {
202
- elementIds: Id64String[];
203
- scope: SelectionScopeProps;
204
- }
205
- /** @internal */
206
- export declare function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel>;
207
- /**
208
- * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.
209
- * @public
210
- */
211
- export interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
212
- prev: {
213
- rulesetOrId?: Ruleset | string;
214
- rulesetVariables?: TRulesetVariable[];
215
- };
216
- expandedNodeKeys?: TNodeKey[];
217
- continuationToken?: {
218
- prevHierarchyNode: string;
219
- currHierarchyNode: string;
220
- };
221
- resultSetSize?: number;
222
- }
223
- /**
224
- * Paging options
225
- * @public
226
- */
227
- export interface PageOptions {
228
- /** Inclusive start 0-based index of the page */
229
- start?: number;
230
- /** Maximum size of the page */
231
- size?: number;
232
- }
233
- /**
234
- * A wrapper type that injects [[PageOptions]] into supplied type
235
- * @public
236
- */
237
- export declare type Paged<TOptions extends {}> = TOptions & {
238
- /** Optional paging parameters */
239
- paging?: PageOptions;
240
- };
241
- /**
242
- * A wrapper type that injects priority into supplied type.
243
- * @public
244
- */
245
- export declare type Prioritized<TOptions extends {}> = TOptions & {
246
- /** Optional priority */
247
- priority?: number;
248
- };
249
- /**
250
- * Checks if supplied request options are for single or multiple element properties.
251
- * @internal
252
- */
253
- export declare function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel>;
254
- /**
255
- * A wrapper type that injects cancelEvent into supplied type.
256
- * @public
257
- */
258
- export declare type WithCancelEvent<TOptions extends {}> = TOptions & {
259
- /** Event which is triggered when the request is canceled */
260
- cancelEvent?: BeEvent<() => void>;
261
- };
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ import { BeEvent, Id64String } from "@itwin/core-bentley";
5
+ import { UnitSystemKey } from "@itwin/core-quantity";
6
+ import { SelectionInfo } from "./content/Descriptor";
7
+ import { FieldDescriptor } from "./content/Fields";
8
+ import { InstanceKey } from "./EC";
9
+ import { InstanceFilterDefinition } from "./InstanceFilterDefinition";
10
+ import { Ruleset } from "./rules/Ruleset";
11
+ import { RulesetVariable } from "./RulesetVariables";
12
+ import { SelectionScopeProps } from "./selection/SelectionScope";
13
+ /**
14
+ * A generic request options type used for both hierarchy and content requests.
15
+ * @public
16
+ */
17
+ export interface RequestOptions<TIModel> {
18
+ /** iModel to request data from */
19
+ imodel: TIModel;
20
+ /** Optional locale to use when formatting / localizing data */
21
+ locale?: string;
22
+ /**
23
+ * Unit system to use when formatting property values with units. Default presentation
24
+ * unit is used if unit system is not specified.
25
+ */
26
+ unitSystem?: UnitSystemKey;
27
+ /**
28
+ * Expected form of response. This property is set automatically on newer frontends.
29
+ * `unparsed-json` — deliver response from native addon without parsing it.
30
+ * @internal
31
+ */
32
+ transport?: "unparsed-json";
33
+ }
34
+ /**
35
+ * Options for requests that require presentation ruleset. Not
36
+ * meant to be used directly, see one of the subclasses.
37
+ *
38
+ * @public
39
+ */
40
+ export interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {
41
+ /** Ruleset or id of the ruleset to use when requesting data */
42
+ rulesetOrId: Ruleset | string;
43
+ /** Ruleset variables to use when requesting data */
44
+ rulesetVariables?: TRulesetVariable[];
45
+ }
46
+ /**
47
+ * Request type for hierarchy requests.
48
+ * @public
49
+ */
50
+ export interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
51
+ /** Key of the parent node to get children for */
52
+ parentKey?: TNodeKey;
53
+ /**
54
+ * An instance filter that should be applied for this hierarchy level.
55
+ *
56
+ * **Note:** May only be used on hierarchy levels that support filtering - check [[NavNode.supportsFiltering]] before
57
+ * requesting filtered children.
58
+ *
59
+ * @beta
60
+ */
61
+ instanceFilter?: InstanceFilterDefinition;
62
+ /**
63
+ * A limit to how many instances at most should be loaded for a hierarchy level. If the limit is exceeded,
64
+ * the request fails with [[PresentationError]] having [[PresentationStatus.ResultSetTooLarge]] error number.
65
+ *
66
+ * Specifying the limit is useful when creating unlimited size result sets is not meaningful - this allows the library
67
+ * to return early as soon as the limit is reached, instead of creating a very large result that's possibly too large to
68
+ * be useful to be displayed to end users.
69
+ *
70
+ * @see [Hierarchies' filtering and limiting]($docs/presentation/hierarchies/FilteringLimiting.md)
71
+ * @beta
72
+ */
73
+ sizeLimit?: number;
74
+ }
75
+ /**
76
+ * Params for hierarchy level descriptor requests.
77
+ * @beta
78
+ */
79
+ export interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
80
+ /** Key of the parent node to get hierarchy level descriptor for. */
81
+ parentKey?: TNodeKey;
82
+ }
83
+ /**
84
+ * Request type of filtering hierarchies by given ECInstance paths.
85
+ * @public
86
+ */
87
+ export interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
88
+ /** A list of paths from root ECInstance to target ECInstance. */
89
+ instancePaths: InstanceKey[][];
90
+ /**
91
+ * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The
92
+ * path is marked using `NodePathElement.isMarked` flag in the result.
93
+ */
94
+ markedIndex?: number;
95
+ }
96
+ /**
97
+ * Request type of filtering hierarchies by given text.
98
+ * @public
99
+ */
100
+ export interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
101
+ /** Text to filter the hierarchy by. */
102
+ filterText: string;
103
+ }
104
+ /**
105
+ * Request type for content sources requests.
106
+ * @public
107
+ */
108
+ export interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {
109
+ /** Full names of classes to get content sources for. Format for a full class name: `SchemaName:ClassName`. */
110
+ classes: string[];
111
+ }
112
+ /**
113
+ * Request type for content descriptor requests.
114
+ * @public
115
+ */
116
+ export interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
117
+ /**
118
+ * Content display type.
119
+ * @see [[DefaultContentDisplayTypes]]
120
+ */
121
+ displayType: string;
122
+ /** Input keys for getting the content */
123
+ keys: TKeySet;
124
+ /** Information about the selection event that was the cause of this content request */
125
+ selection?: SelectionInfo;
126
+ }
127
+ /**
128
+ * Request type for content requests.
129
+ * @public
130
+ */
131
+ export interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
132
+ /** Content descriptor for customizing the returned content */
133
+ descriptor: TDescriptor;
134
+ /** Input keys for getting the content */
135
+ keys: TKeySet;
136
+ }
137
+ /**
138
+ * Request type for distinct values' requests.
139
+ * @public
140
+ */
141
+ export interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
142
+ /** Content descriptor for customizing the returned content */
143
+ descriptor: TDescriptor;
144
+ /** Input keys for getting the content */
145
+ keys: TKeySet;
146
+ /** Descriptor for a field distinct values are requested for */
147
+ fieldDescriptor: FieldDescriptor;
148
+ }
149
+ /**
150
+ * Request type for element properties requests
151
+ * @public
152
+ */
153
+ export type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;
154
+ /**
155
+ * Request type for single element properties requests.
156
+ * @public
157
+ */
158
+ export interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
159
+ /** ID of the element to get properties for. */
160
+ elementId: Id64String;
161
+ }
162
+ /**
163
+ * Request type for multiple elements properties requests.
164
+ * @public
165
+ */
166
+ export interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
167
+ /**
168
+ * Classes of the elements to get properties for. If [[elementClasses]] is `undefined`, all classes
169
+ * are used. Classes should be specified in one of these formats: "<schema name or alias>.<class_name>" or
170
+ * "<schema name or alias>:<class_name>".
171
+ */
172
+ elementClasses?: string[];
173
+ }
174
+ /**
175
+ * Request type for content instance keys' requests.
176
+ * @public
177
+ */
178
+ export interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
179
+ /**
180
+ * Content display type.
181
+ * @see [[DefaultContentDisplayTypes]]
182
+ */
183
+ displayType?: string;
184
+ /** Input keys for getting the content. */
185
+ keys: TKeySet;
186
+ }
187
+ /**
188
+ * Request type for label requests
189
+ * @public
190
+ */
191
+ export interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
192
+ /** Key of ECInstance to get label for */
193
+ key: TInstanceKey;
194
+ }
195
+ /**
196
+ * Request type for labels requests
197
+ * @public
198
+ */
199
+ export interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
200
+ /** Keys of ECInstances to get labels for */
201
+ keys: TInstanceKey[];
202
+ }
203
+ /**
204
+ * Request options used for selection scope related requests
205
+ * @public
206
+ */
207
+ export interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> {
208
+ }
209
+ /**
210
+ * Request options used for calculating selection based on given instance keys and selection scope.
211
+ * @public
212
+ */
213
+ export interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {
214
+ elementIds: Id64String[];
215
+ scope: SelectionScopeProps;
216
+ }
217
+ /** @internal */
218
+ export declare function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel>;
219
+ /**
220
+ * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.
221
+ * @public
222
+ */
223
+ export interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
224
+ prev: {
225
+ rulesetOrId?: Ruleset | string;
226
+ rulesetVariables?: TRulesetVariable[];
227
+ };
228
+ expandedNodeKeys?: TNodeKey[];
229
+ continuationToken?: {
230
+ prevHierarchyNode: string;
231
+ currHierarchyNode: string;
232
+ };
233
+ resultSetSize?: number;
234
+ }
235
+ /**
236
+ * Paging options
237
+ * @public
238
+ */
239
+ export interface PageOptions {
240
+ /** Inclusive start 0-based index of the page */
241
+ start?: number;
242
+ /** Maximum size of the page */
243
+ size?: number;
244
+ }
245
+ /**
246
+ * A wrapper type that injects [[PageOptions]] into supplied type
247
+ * @public
248
+ */
249
+ export type Paged<TOptions extends {}> = TOptions & {
250
+ /** Optional paging parameters */
251
+ paging?: PageOptions;
252
+ };
253
+ /**
254
+ * A wrapper type that injects priority into supplied type.
255
+ * @public
256
+ */
257
+ export type Prioritized<TOptions extends {}> = TOptions & {
258
+ /** Optional priority */
259
+ priority?: number;
260
+ };
261
+ /**
262
+ * Checks if supplied request options are for single or multiple element properties.
263
+ * @internal
264
+ */
265
+ export declare function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel>;
266
+ /**
267
+ * A wrapper type that injects cancelEvent into supplied type.
268
+ * @public
269
+ */
270
+ export type WithCancelEvent<TOptions extends {}> = TOptions & {
271
+ /** Event which is triggered when the request is canceled */
272
+ cancelEvent?: BeEvent<() => void>;
273
+ };
262
274
  //# sourceMappingURL=PresentationManagerOptions.d.ts.map