@itwin/presentation-common 4.0.0-dev.7 → 4.0.0-dev.70

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 (416) hide show
  1. package/CHANGELOG.md +20 -2
  2. package/lib/cjs/assets/locales/en/Presentation.json +15 -0
  3. package/lib/cjs/assets/locales/en-PSEUDO/Presentation.json +15 -0
  4. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  5. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  6. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  7. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  8. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  9. package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
  10. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  11. package/lib/cjs/presentation-common/EC.d.ts +347 -350
  12. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  13. package/lib/cjs/presentation-common/EC.js +290 -290
  14. package/lib/cjs/presentation-common/EC.js.map +1 -1
  15. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  16. package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
  17. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  18. package/lib/cjs/presentation-common/Error.d.ts +47 -45
  19. package/lib/cjs/presentation-common/Error.d.ts.map +1 -1
  20. package/lib/cjs/presentation-common/Error.js +64 -62
  21. package/lib/cjs/presentation-common/Error.js.map +1 -1
  22. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  23. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  25. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  26. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  27. package/lib/cjs/presentation-common/KeySet.js +428 -428
  28. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -87
  29. package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
  30. package/lib/cjs/presentation-common/LabelDefinition.js +78 -73
  31. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  32. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  33. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  34. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  35. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  36. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -261
  37. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  38. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  39. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  40. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
  41. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  42. package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
  43. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  44. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +31 -0
  45. package/lib/cjs/presentation-common/PropertyFormatter.d.ts.map +1 -0
  46. package/lib/cjs/presentation-common/PropertyFormatter.js +199 -0
  47. package/lib/cjs/presentation-common/PropertyFormatter.js.map +1 -0
  48. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  49. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  50. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -83
  51. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  52. package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -171
  53. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  54. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  55. package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
  56. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  57. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  58. package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
  59. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  60. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  61. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  62. package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
  63. package/lib/cjs/presentation-common/Update.js +226 -226
  64. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  65. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  66. package/lib/cjs/presentation-common/Utils.js +43 -43
  67. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  68. package/lib/cjs/presentation-common/content/Category.js +48 -48
  69. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  70. package/lib/cjs/presentation-common/content/Content.js +56 -56
  71. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  72. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -439
  73. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  74. package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
  75. package/lib/cjs/presentation-common/content/Descriptor.js +191 -193
  76. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  77. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  78. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  79. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  80. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  81. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -301
  82. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  83. package/lib/cjs/presentation-common/content/Fields.js +393 -397
  84. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  85. package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
  86. package/lib/cjs/presentation-common/content/Item.d.ts.map +1 -1
  87. package/lib/cjs/presentation-common/content/Item.js +84 -84
  88. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  89. package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
  90. package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
  91. package/lib/cjs/presentation-common/content/Property.js +40 -40
  92. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  93. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  94. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  95. package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
  96. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  97. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  98. package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
  99. package/lib/cjs/presentation-common/content/Value.js +273 -273
  100. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  101. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
  102. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  103. package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
  104. package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
  105. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  106. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
  107. package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
  108. package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
  109. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  110. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  111. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
  112. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  113. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  114. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  115. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  116. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  117. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  118. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  119. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  120. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  121. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  122. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  123. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  124. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  125. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  126. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  127. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  128. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  129. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  130. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  131. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  132. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  133. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  134. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  135. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  136. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  137. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  138. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  139. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  140. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  141. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  142. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  143. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  144. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  145. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  146. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  147. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  148. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  149. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  150. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  151. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  152. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  153. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  154. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  155. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  156. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  157. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  158. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  159. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  160. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  161. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  162. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  163. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  164. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  165. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  166. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  167. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  168. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  169. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  170. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  171. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  172. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  173. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  174. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  175. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  176. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  177. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  178. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  179. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  180. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  181. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  182. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  183. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  184. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  185. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  186. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  187. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  188. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  189. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  190. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  191. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  192. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  193. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  194. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  195. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  196. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  197. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  198. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  199. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  200. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  201. package/lib/cjs/presentation-common.d.ts +113 -112
  202. package/lib/cjs/presentation-common.d.ts.map +1 -1
  203. package/lib/cjs/presentation-common.js +133 -128
  204. package/lib/cjs/presentation-common.js.map +1 -1
  205. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  206. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  207. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  208. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  209. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  210. package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
  211. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  212. package/lib/esm/presentation-common/EC.d.ts +347 -350
  213. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  214. package/lib/esm/presentation-common/EC.js +287 -287
  215. package/lib/esm/presentation-common/EC.js.map +1 -1
  216. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  217. package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
  218. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  219. package/lib/esm/presentation-common/Error.d.ts +47 -45
  220. package/lib/esm/presentation-common/Error.d.ts.map +1 -1
  221. package/lib/esm/presentation-common/Error.js +60 -58
  222. package/lib/esm/presentation-common/Error.js.map +1 -1
  223. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  224. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  225. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  226. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  227. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  228. package/lib/esm/presentation-common/KeySet.js +424 -424
  229. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -87
  230. package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
  231. package/lib/esm/presentation-common/LabelDefinition.js +75 -70
  232. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  233. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  234. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  235. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  236. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  237. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -261
  238. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  239. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  240. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  241. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  242. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  243. package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
  244. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  245. package/lib/esm/presentation-common/PropertyFormatter.d.ts +31 -0
  246. package/lib/esm/presentation-common/PropertyFormatter.d.ts.map +1 -0
  247. package/lib/esm/presentation-common/PropertyFormatter.js +194 -0
  248. package/lib/esm/presentation-common/PropertyFormatter.js.map +1 -0
  249. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  250. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  251. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -83
  252. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  253. package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -167
  254. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  255. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  256. package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
  257. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  258. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  259. package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
  260. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  261. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  262. package/lib/esm/presentation-common/Update.d.ts +213 -213
  263. package/lib/esm/presentation-common/Update.d.ts.map +1 -1
  264. package/lib/esm/presentation-common/Update.js +223 -223
  265. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  266. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  267. package/lib/esm/presentation-common/Utils.js +39 -39
  268. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  269. package/lib/esm/presentation-common/content/Category.js +45 -45
  270. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  271. package/lib/esm/presentation-common/content/Content.js +52 -52
  272. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  273. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -429
  274. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  275. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  276. package/lib/esm/presentation-common/content/Descriptor.js +187 -189
  277. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  278. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  279. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  280. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  281. package/lib/esm/presentation-common/content/Editor.js +8 -8
  282. package/lib/esm/presentation-common/content/Fields.d.ts +298 -301
  283. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  284. package/lib/esm/presentation-common/content/Fields.js +386 -390
  285. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  286. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  287. package/lib/esm/presentation-common/content/Item.d.ts.map +1 -1
  288. package/lib/esm/presentation-common/content/Item.js +80 -80
  289. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  290. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  291. package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
  292. package/lib/esm/presentation-common/content/Property.js +37 -37
  293. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  294. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  295. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  296. package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
  297. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  298. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  299. package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
  300. package/lib/esm/presentation-common/content/Value.js +270 -270
  301. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  302. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  303. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  304. package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
  305. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  306. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  307. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  308. package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
  309. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  310. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  311. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  312. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  313. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  314. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  315. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  316. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  317. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  318. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  319. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  320. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  321. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  322. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  323. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  324. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  325. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  326. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  327. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  328. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  329. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  330. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  331. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  332. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  333. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  334. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  335. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  336. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  337. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  338. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  339. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  340. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  341. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  342. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  343. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  344. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  345. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  346. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  347. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  348. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  349. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  350. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  351. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  352. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  353. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  354. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  355. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  356. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  357. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  358. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  359. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  360. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  361. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  362. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  363. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  364. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  365. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  366. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  367. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  368. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  369. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  370. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  371. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  372. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  373. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  374. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  375. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  376. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  377. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  378. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  379. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  380. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  381. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  382. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  383. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  384. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  385. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  386. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  387. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  388. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  389. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  390. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  391. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  392. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  393. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  394. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  395. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  396. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  397. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  398. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  399. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  400. package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  401. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  402. package/lib/esm/presentation-common.d.ts +113 -112
  403. package/lib/esm/presentation-common.d.ts.map +1 -1
  404. package/lib/esm/presentation-common.js +117 -116
  405. package/lib/esm/presentation-common.js.map +1 -1
  406. package/lib/public/locales/en/Presentation.json +15 -0
  407. package/package.json +15 -13
  408. package/lib/cjs/assets/locales/en/BisCore.json +0 -18
  409. package/lib/cjs/assets/locales/en/ECPresentation.json +0 -9
  410. package/lib/cjs/assets/locales/en/RulesEngine.json +0 -6
  411. package/lib/cjs/assets/locales/en-PSEUDO/BisCore.json +0 -18
  412. package/lib/cjs/assets/locales/en-PSEUDO/ECPresentation.json +0 -9
  413. package/lib/cjs/assets/locales/en-PSEUDO/RulesEngine.json +0 -6
  414. package/lib/public/locales/en/BisCore.json +0 -18
  415. package/lib/public/locales/en/ECPresentation.json +0 -9
  416. package/lib/public/locales/en/RulesEngine.json +0 -6
package/CHANGELOG.md CHANGED
@@ -1,6 +1,24 @@
1
1
  # Change Log - @itwin/presentation-common
2
2
 
3
- This log was last generated on Thu, 26 Jan 2023 22:53:28 GMT and should not be manually modified.
3
+ This log was last generated on Wed, 08 Feb 2023 14:58:40 GMT and should not be manually modified.
4
+
5
+ ## 3.6.0
6
+ Wed, 08 Feb 2023 14:58:40 GMT
7
+
8
+ ### Updates
9
+
10
+ - API promotions
11
+ - Deprecate a number of `{api_name}JSON` interfaces in favor of sibling `{api_name}` interface
12
+ - Take `InstanceFilterDefinition` instead of pure string ECExpression for hierarchy level filter
13
+ - Allow specifying enum values in presentation rules as strings
14
+ - Add APIs to get hierarchy level descriptor
15
+ - Introduce unfilterable nodes and hierarchy levels
16
+ - React to RPC deprecations.
17
+
18
+ ## 3.5.6
19
+ Fri, 24 Feb 2023 16:02:47 GMT
20
+
21
+ _Version update only_
4
22
 
5
23
  ## 3.5.5
6
24
  Thu, 26 Jan 2023 22:53:28 GMT
@@ -226,7 +244,7 @@ Mon, 24 Jan 2022 14:00:52 GMT
226
244
  - Optimize `KeySetJSON` size by compressing instance IDs.
227
245
  - Remove `PresentationRpcInterface.loadHierarchy`.
228
246
  - The `condition` attribute should be defined on both `ChildNodeRule` and `RootNodeRule`.
229
- - Added `ignoreCategories` parameter in `createFieldHierarchies` function for adding all of the nested properties to parent field's child fields without considering categories.
247
+ - Added `ignoreCategories` parameter in `createFieldHierarchies` function for adding all of the nested properties to parent field's child fields without considering categories.
230
248
  - Removed `PresentationUnitSystem` in favor of `UnitSystemKey` from `@itwin/core-quantity`.
231
249
  - remove ClientRequestContext.current
232
250
 
@@ -0,0 +1,15 @@
1
+ {
2
+ "label": {
3
+ "notSpecified": "Not specified",
4
+ "other": "Other",
5
+ "varies": "Varies",
6
+ "multipleInstances": "Multiple items"
7
+ },
8
+ "field": {
9
+ "label": "Label"
10
+ },
11
+ "selectedItems": {
12
+ "categoryLabel": "Selected Item(s)",
13
+ "categoryDescription": "Contains properties of selected item(s)"
14
+ }
15
+ }
@@ -0,0 +1,15 @@
1
+ {
2
+ "label": {
3
+ "notSpecified": "Ñót spêçìfíêd",
4
+ "other": "Òthér",
5
+ "varies": "Vàríês",
6
+ "multipleInstances": "Mµltíplê ïtèms"
7
+ },
8
+ "field": {
9
+ "label": "£ábêl"
10
+ },
11
+ "selectedItems": {
12
+ "categoryLabel": "$élêçtèd Ítêm(s)",
13
+ "categoryDescription": "Çóñtãìñs pròpërtìés öf sëlèçtêd ïtèm(s)"
14
+ }
15
+ }
@@ -1,23 +1,23 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- import { IDisposable } from "@itwin/core-bentley";
5
- /**
6
- * A helper to track ongoing async tasks. Usage:
7
- * ```
8
- * await using(tracker.trackAsyncTask(), async (_r) => {
9
- * await doSomethingAsync();
10
- * });
11
- * ```
12
- *
13
- * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
14
- * async tasks to complete.
15
- *
16
- * @internal
17
- */
18
- export declare class AsyncTasksTracker {
19
- private _asyncsInProgress;
20
- get pendingAsyncs(): Set<string>;
21
- trackAsyncTask(): IDisposable;
22
- }
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ import { IDisposable } from "@itwin/core-bentley";
5
+ /**
6
+ * A helper to track ongoing async tasks. Usage:
7
+ * ```
8
+ * await using(tracker.trackAsyncTask(), async (_r) => {
9
+ * await doSomethingAsync();
10
+ * });
11
+ * ```
12
+ *
13
+ * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
14
+ * async tasks to complete.
15
+ *
16
+ * @internal
17
+ */
18
+ export declare class AsyncTasksTracker {
19
+ private _asyncsInProgress;
20
+ get pendingAsyncs(): Set<string>;
21
+ trackAsyncTask(): IDisposable;
22
+ }
23
23
  //# sourceMappingURL=AsyncTasks.d.ts.map
@@ -1,39 +1,39 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Core
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.AsyncTasksTracker = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- /**
13
- * A helper to track ongoing async tasks. Usage:
14
- * ```
15
- * await using(tracker.trackAsyncTask(), async (_r) => {
16
- * await doSomethingAsync();
17
- * });
18
- * ```
19
- *
20
- * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
21
- * async tasks to complete.
22
- *
23
- * @internal
24
- */
25
- class AsyncTasksTracker {
26
- constructor() {
27
- this._asyncsInProgress = new Set();
28
- }
29
- get pendingAsyncs() { return this._asyncsInProgress; }
30
- trackAsyncTask() {
31
- const id = core_bentley_1.Guid.createValue();
32
- this._asyncsInProgress.add(id);
33
- return {
34
- dispose: () => this._asyncsInProgress.delete(id),
35
- };
36
- }
37
- }
38
- exports.AsyncTasksTracker = AsyncTasksTracker;
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module Core
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.AsyncTasksTracker = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ /**
13
+ * A helper to track ongoing async tasks. Usage:
14
+ * ```
15
+ * await using(tracker.trackAsyncTask(), async (_r) => {
16
+ * await doSomethingAsync();
17
+ * });
18
+ * ```
19
+ *
20
+ * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
21
+ * async tasks to complete.
22
+ *
23
+ * @internal
24
+ */
25
+ class AsyncTasksTracker {
26
+ constructor() {
27
+ this._asyncsInProgress = new Set();
28
+ }
29
+ get pendingAsyncs() { return this._asyncsInProgress; }
30
+ trackAsyncTask() {
31
+ const id = core_bentley_1.Guid.createValue();
32
+ this._asyncsInProgress.add(id);
33
+ return {
34
+ dispose: () => this._asyncsInProgress.delete(id),
35
+ };
36
+ }
37
+ }
38
+ exports.AsyncTasksTracker = AsyncTasksTracker;
39
39
  //# sourceMappingURL=AsyncTasks.js.map
@@ -1,13 +1,13 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- /**
5
- * Logger categories used by this package
6
- * @note All logger categories in this package start with the `presentation-common` prefix.
7
- * @see [Logger]($bentley)
8
- * @public
9
- */
10
- export declare enum PresentationCommonLoggerCategory {
11
- Package = "presentation-common"
12
- }
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ /**
5
+ * Logger categories used by this package
6
+ * @note All logger categories in this package start with the `presentation-common` prefix.
7
+ * @see [Logger]($bentley)
8
+ * @public
9
+ */
10
+ export declare enum PresentationCommonLoggerCategory {
11
+ Package = "presentation-common"
12
+ }
13
13
  //# sourceMappingURL=CommonLoggerCategory.d.ts.map
@@ -1,21 +1,21 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Core
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.PresentationCommonLoggerCategory = void 0;
11
- /**
12
- * Logger categories used by this package
13
- * @note All logger categories in this package start with the `presentation-common` prefix.
14
- * @see [Logger]($bentley)
15
- * @public
16
- */
17
- var PresentationCommonLoggerCategory;
18
- (function (PresentationCommonLoggerCategory) {
19
- PresentationCommonLoggerCategory["Package"] = "presentation-common";
20
- })(PresentationCommonLoggerCategory = exports.PresentationCommonLoggerCategory || (exports.PresentationCommonLoggerCategory = {}));
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module Core
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.PresentationCommonLoggerCategory = void 0;
11
+ /**
12
+ * Logger categories used by this package
13
+ * @note All logger categories in this package start with the `presentation-common` prefix.
14
+ * @see [Logger]($bentley)
15
+ * @public
16
+ */
17
+ var PresentationCommonLoggerCategory;
18
+ (function (PresentationCommonLoggerCategory) {
19
+ PresentationCommonLoggerCategory["Package"] = "presentation-common";
20
+ })(PresentationCommonLoggerCategory = exports.PresentationCommonLoggerCategory || (exports.PresentationCommonLoggerCategory = {}));
21
21
  //# sourceMappingURL=CommonLoggerCategory.js.map
@@ -1,126 +1,126 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- /**
5
- * Type of diagnostics logger severity.
6
- * @beta
7
- */
8
- export declare type DiagnosticsLoggerSeverity = "error" | "warning" | "info" | "debug" | "trace";
9
- /**
10
- * Returns lower severity of the given two. Examples:
11
- * ```
12
- * combineDiagnosticsSeverities("error", "error") === "error"
13
- * combineDiagnosticsSeverities("error", "debug") === "debug"
14
- * combineDiagnosticsSeverities("debug", "error") === "debug"
15
- * ```
16
- * @internal
17
- */
18
- export declare function combineDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): DiagnosticsLoggerSeverity | undefined;
19
- /**
20
- * Returns 0 if the given severities are equal after normalization, negative if `lhs` is lower, positive if higher. Examples:
21
- * ```
22
- * compareDiagnosticsSeverities("error", "error") === 0
23
- * compareDiagnosticsSeverities("error", false) === 0
24
- * compareDiagnosticsSeverities("error", undefined) === 0
25
- * compareDiagnosticsSeverities("debug", true) === 0
26
- * compareDiagnosticsSeverities("debug", "error") < 0
27
- * compareDiagnosticsSeverities("error", "debug") > 0
28
- * ```
29
- * @internal
30
- */
31
- export declare function compareDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): 0 | 1 | -1;
32
- /**
33
- * Data structure for diagnostics information.
34
- * @beta
35
- */
36
- export interface Diagnostics {
37
- logs?: DiagnosticsScopeLogs[];
38
- }
39
- /**
40
- * Data structure with client diagnostics information.
41
- * @beta
42
- */
43
- export interface ClientDiagnostics extends Diagnostics {
44
- backendVersion?: string;
45
- }
46
- /**
47
- * Data structure for diagnostics options.
48
- * @beta
49
- */
50
- export interface DiagnosticsOptions {
51
- /**
52
- * Flag specifying that performance should be measured, or
53
- * minimum duration in milliseconds for which performance metric should be included.
54
- */
55
- perf?: boolean | {
56
- minimumDuration: number;
57
- };
58
- /** Severity for developer log messages */
59
- dev?: boolean | DiagnosticsLoggerSeverity;
60
- /** Severity for presentation rules' editor log messages */
61
- editor?: boolean | DiagnosticsLoggerSeverity;
62
- }
63
- /**
64
- * A function that can be called after receiving diagnostics.
65
- * @beta
66
- */
67
- export declare type ClientDiagnosticsHandler = (logs: ClientDiagnostics) => void;
68
- /**
69
- * Data structure for client diagnostics options.
70
- * @beta
71
- */
72
- export interface ClientDiagnosticsOptions extends DiagnosticsOptions {
73
- backendVersion?: boolean;
74
- handler: ClientDiagnosticsHandler;
75
- }
76
- /**
77
- * Data structure which contains client diagnostics options.
78
- * @public
79
- */
80
- export interface ClientDiagnosticsAttribute {
81
- /**
82
- * Diagnostics options.
83
- * @beta
84
- */
85
- diagnostics?: ClientDiagnosticsOptions;
86
- }
87
- /**
88
- * Data structure for diagnostics log message information.
89
- * @beta
90
- */
91
- export interface DiagnosticsLogMessage {
92
- severity: {
93
- dev?: DiagnosticsLoggerSeverity;
94
- editor?: DiagnosticsLoggerSeverity;
95
- };
96
- category: string;
97
- message: string;
98
- timestamp: number;
99
- }
100
- /**
101
- * Data structure for diagnostics scope information.
102
- * @beta
103
- */
104
- export interface DiagnosticsScopeLogs {
105
- scope: string;
106
- scopeCreateTimestamp?: number;
107
- duration?: number;
108
- logs?: DiagnosticsLogEntry[];
109
- attributes?: {
110
- [attributeKey: string]: string | string[];
111
- };
112
- }
113
- /**
114
- * Data structure for diagnostics log entry.
115
- * @beta
116
- */
117
- export declare type DiagnosticsLogEntry = DiagnosticsLogMessage | DiagnosticsScopeLogs;
118
- /**
119
- * Functions related to diagnostics log entry.
120
- * @beta
121
- */
122
- export declare namespace DiagnosticsLogEntry {
123
- function isMessage(entry: DiagnosticsLogEntry): entry is DiagnosticsLogMessage;
124
- function isScope(entry: DiagnosticsLogEntry): entry is DiagnosticsScopeLogs;
125
- }
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ /**
5
+ * Type of diagnostics logger severity.
6
+ * @beta
7
+ */
8
+ export type DiagnosticsLoggerSeverity = "error" | "warning" | "info" | "debug" | "trace";
9
+ /**
10
+ * Returns lower severity of the given two. Examples:
11
+ * ```
12
+ * combineDiagnosticsSeverities("error", "error") === "error"
13
+ * combineDiagnosticsSeverities("error", "debug") === "debug"
14
+ * combineDiagnosticsSeverities("debug", "error") === "debug"
15
+ * ```
16
+ * @internal
17
+ */
18
+ export declare function combineDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): DiagnosticsLoggerSeverity | undefined;
19
+ /**
20
+ * Returns 0 if the given severities are equal after normalization, negative if `lhs` is lower, positive if higher. Examples:
21
+ * ```
22
+ * compareDiagnosticsSeverities("error", "error") === 0
23
+ * compareDiagnosticsSeverities("error", false) === 0
24
+ * compareDiagnosticsSeverities("error", undefined) === 0
25
+ * compareDiagnosticsSeverities("debug", true) === 0
26
+ * compareDiagnosticsSeverities("debug", "error") < 0
27
+ * compareDiagnosticsSeverities("error", "debug") > 0
28
+ * ```
29
+ * @internal
30
+ */
31
+ export declare function compareDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): 0 | 1 | -1;
32
+ /**
33
+ * Data structure for diagnostics information.
34
+ * @beta
35
+ */
36
+ export interface Diagnostics {
37
+ logs?: DiagnosticsScopeLogs[];
38
+ }
39
+ /**
40
+ * Data structure with client diagnostics information.
41
+ * @beta
42
+ */
43
+ export interface ClientDiagnostics extends Diagnostics {
44
+ backendVersion?: string;
45
+ }
46
+ /**
47
+ * Data structure for diagnostics options.
48
+ * @beta
49
+ */
50
+ export interface DiagnosticsOptions {
51
+ /**
52
+ * Flag specifying that performance should be measured, or
53
+ * minimum duration in milliseconds for which performance metric should be included.
54
+ */
55
+ perf?: boolean | {
56
+ minimumDuration: number;
57
+ };
58
+ /** Severity for developer log messages */
59
+ dev?: boolean | DiagnosticsLoggerSeverity;
60
+ /** Severity for presentation rules' editor log messages */
61
+ editor?: boolean | DiagnosticsLoggerSeverity;
62
+ }
63
+ /**
64
+ * A function that can be called after receiving diagnostics.
65
+ * @beta
66
+ */
67
+ export type ClientDiagnosticsHandler = (logs: ClientDiagnostics) => void;
68
+ /**
69
+ * Data structure for client diagnostics options.
70
+ * @beta
71
+ */
72
+ export interface ClientDiagnosticsOptions extends DiagnosticsOptions {
73
+ backendVersion?: boolean;
74
+ handler: ClientDiagnosticsHandler;
75
+ }
76
+ /**
77
+ * Data structure which contains client diagnostics options.
78
+ * @public
79
+ */
80
+ export interface ClientDiagnosticsAttribute {
81
+ /**
82
+ * Diagnostics options.
83
+ * @beta
84
+ */
85
+ diagnostics?: ClientDiagnosticsOptions;
86
+ }
87
+ /**
88
+ * Data structure for diagnostics log message information.
89
+ * @beta
90
+ */
91
+ export interface DiagnosticsLogMessage {
92
+ severity: {
93
+ dev?: DiagnosticsLoggerSeverity;
94
+ editor?: DiagnosticsLoggerSeverity;
95
+ };
96
+ category: string;
97
+ message: string;
98
+ timestamp: number;
99
+ }
100
+ /**
101
+ * Data structure for diagnostics scope information.
102
+ * @beta
103
+ */
104
+ export interface DiagnosticsScopeLogs {
105
+ scope: string;
106
+ scopeCreateTimestamp?: number;
107
+ duration?: number;
108
+ logs?: DiagnosticsLogEntry[];
109
+ attributes?: {
110
+ [attributeKey: string]: string | string[];
111
+ };
112
+ }
113
+ /**
114
+ * Data structure for diagnostics log entry.
115
+ * @beta
116
+ */
117
+ export type DiagnosticsLogEntry = DiagnosticsLogMessage | DiagnosticsScopeLogs;
118
+ /**
119
+ * Functions related to diagnostics log entry.
120
+ * @beta
121
+ */
122
+ export declare namespace DiagnosticsLogEntry {
123
+ function isMessage(entry: DiagnosticsLogEntry): entry is DiagnosticsLogMessage;
124
+ function isScope(entry: DiagnosticsLogEntry): entry is DiagnosticsScopeLogs;
125
+ }
126
126
  //# sourceMappingURL=Diagnostics.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Diagnostics.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/Diagnostics.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEzF;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,yCAStJ;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,cActJ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,0CAA0C;IAC1C,GAAG,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;IAC1C,2DAA2D;IAC3D,MAAM,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;CAC9C;AAED;;;GAGG;AACH,oBAAY,wBAAwB,GAAG,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,wBAAwB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE;QACR,GAAG,CAAC,EAAE,yBAAyB,CAAC;QAChC,MAAM,CAAC,EAAE,yBAAyB,CAAC;KACpC,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE;QAAE,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC;CAC5D;AAED;;;GAGG;AACH,oBAAY,mBAAmB,GAAG,qBAAqB,GAAG,oBAAoB,CAAC;AAE/E;;;GAGG;AACH,yBAAiB,mBAAmB,CAAC;IACnC,SAAgB,SAAS,CAAC,KAAK,EAAE,mBAAmB,GAAG,KAAK,IAAI,qBAAqB,CAEpF;IACD,SAAgB,OAAO,CAAC,KAAK,EAAE,mBAAmB,GAAG,KAAK,IAAI,oBAAoB,CAEjF;CACF"}
1
+ {"version":3,"file":"Diagnostics.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/Diagnostics.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEzF;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,yCAStJ;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,GAAG,yBAAyB,cActJ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,0CAA0C;IAC1C,GAAG,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;IAC1C,2DAA2D;IAC3D,MAAM,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,wBAAwB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE;QACR,GAAG,CAAC,EAAE,yBAAyB,CAAC;QAChC,MAAM,CAAC,EAAE,yBAAyB,CAAC;KACpC,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE;QAAE,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC;CAC5D;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,GAAG,oBAAoB,CAAC;AAE/E;;;GAGG;AACH,yBAAiB,mBAAmB,CAAC;IACnC,SAAgB,SAAS,CAAC,KAAK,EAAE,mBAAmB,GAAG,KAAK,IAAI,qBAAqB,CAEpF;IACD,SAAgB,OAAO,CAAC,KAAK,EAAE,mBAAmB,GAAG,KAAK,IAAI,oBAAoB,CAEjF;CACF"}