@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,63 +1,65 @@
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.PresentationError = exports.PresentationStatus = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- /**
13
- * Status codes used by Presentation APIs.
14
- * @public
15
- */
16
- var PresentationStatus;
17
- (function (PresentationStatus) {
18
- /** Success result. */
19
- PresentationStatus[PresentationStatus["Success"] = 0] = "Success";
20
- /** Request was cancelled. */
21
- PresentationStatus[PresentationStatus["Canceled"] = 1] = "Canceled";
22
- /** Error: Unknown */
23
- PresentationStatus[PresentationStatus["Error"] = 65536] = "Error";
24
- /** Error: Backend is not initialized. */
25
- PresentationStatus[PresentationStatus["NotInitialized"] = 65537] = "NotInitialized";
26
- /** Error: Argument is invalid. */
27
- PresentationStatus[PresentationStatus["InvalidArgument"] = 65539] = "InvalidArgument";
28
- /**
29
- * Timeout for the request was reached which prevented it from being fulfilled. Frontend may
30
- * repeat the request.
31
- */
32
- PresentationStatus[PresentationStatus["BackendTimeout"] = 65543] = "BackendTimeout";
33
- })(PresentationStatus = exports.PresentationStatus || (exports.PresentationStatus = {}));
34
- /**
35
- * An error type thrown by Presentation APIs.
36
- * @public
37
- */
38
- class PresentationError extends core_bentley_1.BentleyError {
39
- /**
40
- * Creates an instance of Error.
41
- * @param errorNumber Error code
42
- * @param message Optional brief description of the error. The `message` property combined with the `name`
43
- * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.
44
- * @param log Optional log function which logs the error.
45
- * @param getMetaData Optional function that returns meta-data related to an error.
46
- */
47
- constructor(errorNumber, message, getMetaData) {
48
- super(errorNumber, message, getMetaData);
49
- }
50
- /**
51
- * Returns the name of each error status. The name is used by the `Error.prototype.toString()`
52
- * method to create a string representation of the error.
53
- */
54
- // eslint-disable-next-line @typescript-eslint/naming-convention
55
- _initName() {
56
- let value = PresentationStatus[this.errorNumber];
57
- if (!value)
58
- value = `Unknown Error (${this.errorNumber})`;
59
- return value;
60
- }
61
- }
62
- exports.PresentationError = PresentationError;
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.PresentationError = exports.PresentationStatus = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ /**
13
+ * Status codes used by Presentation APIs.
14
+ * @public
15
+ */
16
+ var PresentationStatus;
17
+ (function (PresentationStatus) {
18
+ /** Success result. */
19
+ PresentationStatus[PresentationStatus["Success"] = 0] = "Success";
20
+ /** Request was cancelled. */
21
+ PresentationStatus[PresentationStatus["Canceled"] = 1] = "Canceled";
22
+ /** Error: Unknown */
23
+ PresentationStatus[PresentationStatus["Error"] = 65536] = "Error";
24
+ /** Error: Backend is not initialized. */
25
+ PresentationStatus[PresentationStatus["NotInitialized"] = 65537] = "NotInitialized";
26
+ /** Error: Result set is too large. */
27
+ PresentationStatus[PresentationStatus["ResultSetTooLarge"] = 65538] = "ResultSetTooLarge";
28
+ /** Error: Argument is invalid. */
29
+ PresentationStatus[PresentationStatus["InvalidArgument"] = 65539] = "InvalidArgument";
30
+ /**
31
+ * Timeout for the request was reached which prevented it from being fulfilled. Frontend may
32
+ * repeat the request.
33
+ */
34
+ PresentationStatus[PresentationStatus["BackendTimeout"] = 65543] = "BackendTimeout";
35
+ })(PresentationStatus = exports.PresentationStatus || (exports.PresentationStatus = {}));
36
+ /**
37
+ * An error type thrown by Presentation APIs.
38
+ * @public
39
+ */
40
+ class PresentationError extends core_bentley_1.BentleyError {
41
+ /**
42
+ * Creates an instance of Error.
43
+ * @param errorNumber Error code
44
+ * @param message Optional brief description of the error. The `message` property combined with the `name`
45
+ * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.
46
+ * @param log Optional log function which logs the error.
47
+ * @param getMetaData Optional function that returns meta-data related to an error.
48
+ */
49
+ constructor(errorNumber, message, getMetaData) {
50
+ super(errorNumber, message, getMetaData);
51
+ }
52
+ /**
53
+ * Returns the name of each error status. The name is used by the `Error.prototype.toString()`
54
+ * method to create a string representation of the error.
55
+ */
56
+ // eslint-disable-next-line @typescript-eslint/naming-convention
57
+ _initName() {
58
+ let value = PresentationStatus[this.errorNumber];
59
+ if (!value)
60
+ value = `Unknown Error (${this.errorNumber})`;
61
+ return value;
62
+ }
63
+ }
64
+ exports.PresentationError = PresentationError;
63
65
  //# sourceMappingURL=Error.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../src/presentation-common/Error.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwE;AAExE;;;GAGG;AACH,IAAY,kBAqBX;AArBD,WAAY,kBAAkB;IAC5B,sBAAsB;IACtB,iEAAW,CAAA;IAEX,6BAA6B;IAC7B,mEAAY,CAAA;IAEZ,qBAAqB;IACrB,iEAAe,CAAA;IAEf,yCAAyC;IACzC,mFAA0B,CAAA;IAE1B,kCAAkC;IAClC,qFAA2B,CAAA;IAE3B;;;OAGG;IACH,mFAA0B,CAAA;AAC5B,CAAC,EArBW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAqB7B;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,2BAAY;IAEjD;;;;;;;OAOG;IACH,YAAmB,WAA+B,EAAE,OAAgB,EAAE,WAAiC;QACrG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,gEAAgE;IAC7C,SAAS;QAC1B,IAAI,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK;YACR,KAAK,GAAG,kBAAkB,IAAI,CAAC,WAAW,GAAG,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzBD,8CAyBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { BentleyError, GetMetaDataFunction } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Status codes used by Presentation APIs.\r\n * @public\r\n */\r\nexport enum PresentationStatus {\r\n /** Success result. */\r\n Success = 0,\r\n\r\n /** Request was cancelled. */\r\n Canceled = 1,\r\n\r\n /** Error: Unknown */\r\n Error = 0x10000,\r\n\r\n /** Error: Backend is not initialized. */\r\n NotInitialized = Error + 1,\r\n\r\n /** Error: Argument is invalid. */\r\n InvalidArgument = Error + 3,\r\n\r\n /**\r\n * Timeout for the request was reached which prevented it from being fulfilled. Frontend may\r\n * repeat the request.\r\n */\r\n BackendTimeout = Error + 7,\r\n}\r\n\r\n/**\r\n * An error type thrown by Presentation APIs.\r\n * @public\r\n */\r\nexport class PresentationError extends BentleyError {\r\n\r\n /**\r\n * Creates an instance of Error.\r\n * @param errorNumber Error code\r\n * @param message Optional brief description of the error. The `message` property combined with the `name`\r\n * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.\r\n * @param log Optional log function which logs the error.\r\n * @param getMetaData Optional function that returns meta-data related to an error.\r\n */\r\n public constructor(errorNumber: PresentationStatus, message?: string, getMetaData?: GetMetaDataFunction) {\r\n super(errorNumber, message, getMetaData);\r\n }\r\n\r\n /**\r\n * Returns the name of each error status. The name is used by the `Error.prototype.toString()`\r\n * method to create a string representation of the error.\r\n */\r\n // eslint-disable-next-line @typescript-eslint/naming-convention\r\n protected override _initName(): string {\r\n let value = PresentationStatus[this.errorNumber];\r\n if (!value)\r\n value = `Unknown Error (${this.errorNumber})`;\r\n return value;\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"Error.js","sourceRoot":"","sources":["../../../src/presentation-common/Error.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwE;AAExE;;;GAGG;AACH,IAAY,kBAwBX;AAxBD,WAAY,kBAAkB;IAC5B,sBAAsB;IACtB,iEAAW,CAAA;IAEX,6BAA6B;IAC7B,mEAAY,CAAA;IAEZ,qBAAqB;IACrB,iEAAe,CAAA;IAEf,yCAAyC;IACzC,mFAA0B,CAAA;IAE1B,sCAAsC;IACtC,yFAA6B,CAAA;IAE7B,kCAAkC;IAClC,qFAA2B,CAAA;IAE3B;;;OAGG;IACH,mFAA0B,CAAA;AAC5B,CAAC,EAxBW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAwB7B;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,2BAAY;IAEjD;;;;;;;OAOG;IACH,YAAmB,WAA+B,EAAE,OAAgB,EAAE,WAAiC;QACrG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,gEAAgE;IAC7C,SAAS;QAC1B,IAAI,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK;YACR,KAAK,GAAG,kBAAkB,IAAI,CAAC,WAAW,GAAG,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzBD,8CAyBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { BentleyError, GetMetaDataFunction } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Status codes used by Presentation APIs.\r\n * @public\r\n */\r\nexport enum PresentationStatus {\r\n /** Success result. */\r\n Success = 0,\r\n\r\n /** Request was cancelled. */\r\n Canceled = 1,\r\n\r\n /** Error: Unknown */\r\n Error = 0x10000,\r\n\r\n /** Error: Backend is not initialized. */\r\n NotInitialized = Error + 1,\r\n\r\n /** Error: Result set is too large. */\r\n ResultSetTooLarge = Error + 2,\r\n\r\n /** Error: Argument is invalid. */\r\n InvalidArgument = Error + 3,\r\n\r\n /**\r\n * Timeout for the request was reached which prevented it from being fulfilled. Frontend may\r\n * repeat the request.\r\n */\r\n BackendTimeout = Error + 7,\r\n}\r\n\r\n/**\r\n * An error type thrown by Presentation APIs.\r\n * @public\r\n */\r\nexport class PresentationError extends BentleyError {\r\n\r\n /**\r\n * Creates an instance of Error.\r\n * @param errorNumber Error code\r\n * @param message Optional brief description of the error. The `message` property combined with the `name`\r\n * property is used by the `Error.prototype.toString()` method to create a string representation of the Error.\r\n * @param log Optional log function which logs the error.\r\n * @param getMetaData Optional function that returns meta-data related to an error.\r\n */\r\n public constructor(errorNumber: PresentationStatus, message?: string, getMetaData?: GetMetaDataFunction) {\r\n super(errorNumber, message, getMetaData);\r\n }\r\n\r\n /**\r\n * Returns the name of each error status. The name is used by the `Error.prototype.toString()`\r\n * method to create a string representation of the error.\r\n */\r\n // eslint-disable-next-line @typescript-eslint/naming-convention\r\n protected override _initName(): string {\r\n let value = PresentationStatus[this.errorNumber];\r\n if (!value)\r\n value = `Unknown Error (${this.errorNumber})`;\r\n return value;\r\n }\r\n}\r\n"]}
@@ -1,94 +1,94 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- import { StrippedRelationshipPath } from "./EC";
5
- /**
6
- * Definition of an instance filter that can be used to filter content or hierarchy levels.
7
- *
8
- * Example:
9
- *
10
- * ```json
11
- * {
12
- * selectClassName: "MySchema:MyClass",
13
- * expression: "this.MyProperty = 1 AND other.OtherProperty = 2",
14
- * relatedInstances: [{
15
- * pathFromSelectToPropertyClass: [{
16
- * sourceClassName: "MySchema:MyClass",
17
- * relationshipName: "MySchema:RelationshipFromMyToOtherClass",
18
- * isForwardRelationship: true,
19
- * targetClassName: "MySchema:OtherClass",
20
- * }],
21
- * alias: "other",
22
- * }],
23
- * }
24
- * ```
25
- *
26
- * @beta
27
- */
28
- export interface InstanceFilterDefinition {
29
- /**
30
- * Select class filter used to select only instances of specific class.
31
- * The [[relatedInstances]] attribute, when used, should specify paths from this class.
32
- * Also, the [[expression]] attribute's `this` symbol points to instances of this class.
33
- *
34
- * The format is full class name: `SchemaName:ClassName`.
35
- */
36
- selectClassName: string;
37
- /**
38
- * Specifies relationship paths pointing to related instances used in the [[expression]] attribute.
39
- *
40
- * Sometimes there's a need to filter on a related instance property. In that case, the relationship
41
- * needs to be named by specifying the path and alias for the target (or the relationship). Then, the
42
- * related instance's symbol context can be accessed through the root symbol named as specified in the
43
- * [[alias]] (or [[relationshipAlias]]) attribute.
44
- */
45
- relatedInstances?: InstanceFilterRelatedInstanceDefinition[];
46
- /**
47
- * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.
48
- */
49
- expression: string;
50
- }
51
- /**
52
- * Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].
53
- * @beta
54
- */
55
- export declare type InstanceFilterRelatedInstanceDefinition = InstanceFilterRelatedInstancePath & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);
56
- /**
57
- * Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].
58
- * @beta
59
- */
60
- export interface InstanceFilterRelatedInstancePath {
61
- /**
62
- * A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)
63
- * to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].
64
- */
65
- pathFromSelectToPropertyClass: StrippedRelationshipPath;
66
- /**
67
- * An optional flag indicating that the target instance must exist. Setting this allows to filter out all
68
- * select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.
69
- */
70
- isRequired?: boolean;
71
- }
72
- /**
73
- * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.
74
- * @beta
75
- */
76
- export interface InstanceFilterRelatedInstanceTargetAlias {
77
- /**
78
- * An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to
79
- * access related instance symbols context in the [[InstanceFilterDefinition.expression]].
80
- */
81
- alias: string;
82
- }
83
- /**
84
- * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.
85
- * @beta
86
- */
87
- export interface InstanceFilterRelatedInstanceRelationshipAlias {
88
- /**
89
- * An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be
90
- * used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].
91
- */
92
- relationshipAlias: string;
93
- }
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ import { StrippedRelationshipPath } from "./EC";
5
+ /**
6
+ * Definition of an instance filter that can be used to filter content or hierarchy levels.
7
+ *
8
+ * Example:
9
+ *
10
+ * ```json
11
+ * {
12
+ * selectClassName: "MySchema:MyClass",
13
+ * expression: "this.MyProperty = 1 AND other.OtherProperty = 2",
14
+ * relatedInstances: [{
15
+ * pathFromSelectToPropertyClass: [{
16
+ * sourceClassName: "MySchema:MyClass",
17
+ * relationshipName: "MySchema:RelationshipFromMyToOtherClass",
18
+ * isForwardRelationship: true,
19
+ * targetClassName: "MySchema:OtherClass",
20
+ * }],
21
+ * alias: "other",
22
+ * }],
23
+ * }
24
+ * ```
25
+ *
26
+ * @beta
27
+ */
28
+ export interface InstanceFilterDefinition {
29
+ /**
30
+ * Select class filter used to select only instances of specific class.
31
+ * The [[relatedInstances]] attribute, when used, should specify paths from this class.
32
+ * Also, the [[expression]] attribute's `this` symbol points to instances of this class.
33
+ *
34
+ * The format is full class name: `SchemaName:ClassName`.
35
+ */
36
+ selectClassName: string;
37
+ /**
38
+ * Specifies relationship paths pointing to related instances used in the [[expression]] attribute.
39
+ *
40
+ * Sometimes there's a need to filter on a related instance property. In that case, the relationship
41
+ * needs to be named by specifying the path and alias for the target (or the relationship). Then, the
42
+ * related instance's symbol context can be accessed through the root symbol named as specified in the
43
+ * [[alias]] (or [[relationshipAlias]]) attribute.
44
+ */
45
+ relatedInstances?: InstanceFilterRelatedInstanceDefinition[];
46
+ /**
47
+ * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering the select instances.
48
+ */
49
+ expression: string;
50
+ }
51
+ /**
52
+ * Related instance definition for accessing properties of a related instance in [[InstanceFilterDefinition.expression]].
53
+ * @beta
54
+ */
55
+ export type InstanceFilterRelatedInstanceDefinition = InstanceFilterRelatedInstancePath & (InstanceFilterRelatedInstanceTargetAlias | InstanceFilterRelatedInstanceRelationshipAlias);
56
+ /**
57
+ * Partial definition of common attributes for [[InstanceFilterRelatedInstanceDefinition]].
58
+ * @beta
59
+ */
60
+ export interface InstanceFilterRelatedInstancePath {
61
+ /**
62
+ * A relationship path from select class (either specified through [[InstanceFilterDefinition.selectClassName]] or taken from context)
63
+ * to the target related instance containing the properties used in [[InstanceFilterDefinition.expression]].
64
+ */
65
+ pathFromSelectToPropertyClass: StrippedRelationshipPath;
66
+ /**
67
+ * An optional flag indicating that the target instance must exist. Setting this allows to filter out all
68
+ * select instances that don't have a related instance by following the [[pathFromSelectToPropertyClass]] path.
69
+ */
70
+ isRequired?: boolean;
71
+ }
72
+ /**
73
+ * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the target class.
74
+ * @beta
75
+ */
76
+ export interface InstanceFilterRelatedInstanceTargetAlias {
77
+ /**
78
+ * An alias for the target class in the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be used to
79
+ * access related instance symbols context in the [[InstanceFilterDefinition.expression]].
80
+ */
81
+ alias: string;
82
+ }
83
+ /**
84
+ * Partial definition of [[InstanceFilterRelatedInstanceDefinition]] for the case when referencing the relationship class.
85
+ * @beta
86
+ */
87
+ export interface InstanceFilterRelatedInstanceRelationshipAlias {
88
+ /**
89
+ * An alias for the relationship in the last step of the [[InstanceFilterRelatedInstancePath.pathFromSelectToPropertyClass]] path. This alias can be
90
+ * used to access the relationship instance symbols context in the [[InstanceFilterDefinition.expression]].
91
+ */
92
+ relationshipAlias: string;
93
+ }
94
94
  //# sourceMappingURL=InstanceFilterDefinition.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"InstanceFilterDefinition.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/InstanceFilterDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,MAAM,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,uCAAuC,GACjD,iCAAiC,GAC/B,CAAC,wCAAwC,GAAG,8CAA8C,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,6BAA6B,EAAE,wBAAwB,CAAC;IACxD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,8CAA8C;IAC7D;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}
1
+ {"version":3,"file":"InstanceFilterDefinition.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/InstanceFilterDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,MAAM,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GACjD,iCAAiC,GAC/B,CAAC,wCAAwC,GAAG,8CAA8C,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,6BAA6B,EAAE,wBAAwB,CAAC;IACxD;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,8CAA8C;IAC7D;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}
@@ -1,10 +1,10 @@
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 });
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
10
  //# sourceMappingURL=InstanceFilterDefinition.js.map