@itwin/presentation-common 4.0.0-dev.6 → 4.0.0-dev.61

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 +12 -10
  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
@@ -1,45 +1,45 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- import { Field } from "./content/Fields";
5
- import { Item } from "./content/Item";
6
- import { InstanceKey } from "./EC";
7
- import { Ruleset } from "./rules/Ruleset";
8
- /**
9
- * A factory class that can be used to create presentation rulesets targeted towards
10
- * specific use cases.
11
- *
12
- * @public
13
- */
14
- export declare class RulesetsFactory {
15
- private createSimilarInstancesRulesetInfo;
16
- /**
17
- * Create a ruleset with content rules for getting instances are of the
18
- * same ECClass and have the same property value as the provided `record`.
19
- * @param field A field identifying which property of the record we should use
20
- * @param record A record whose similar instances should be found
21
- * @param computeDisplayValue Optional callback function to calculate display value that's
22
- * used in ruleset's description. If not provided, display value from record is used instead.
23
- */
24
- createSimilarInstancesRuleset(field: Field, record: Item, computeDisplayValue?: ComputeDisplayValueCallback): Promise<{
25
- ruleset: Ruleset;
26
- description: string;
27
- }>;
28
- }
29
- /**
30
- * Definition of a function for calculating a display value.
31
- * @public
32
- */
33
- export declare type ComputeDisplayValueCallback = (type: string, value: PrimitivePropertyValue, displayValue: string) => Promise<string>;
34
- /**
35
- * Value of a primitive property.
36
- * @public
37
- */
38
- export declare type PrimitivePropertyValue = string | number | boolean | Point | InstanceKey | undefined;
39
- declare type Point = {
40
- x: number;
41
- y: number;
42
- z?: number;
43
- };
44
- export {};
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ import { Field } from "./content/Fields";
5
+ import { Item } from "./content/Item";
6
+ import { InstanceKey } from "./EC";
7
+ import { Ruleset } from "./rules/Ruleset";
8
+ /**
9
+ * A factory class that can be used to create presentation rulesets targeted towards
10
+ * specific use cases.
11
+ *
12
+ * @public
13
+ */
14
+ export declare class RulesetsFactory {
15
+ private createSimilarInstancesRulesetInfo;
16
+ /**
17
+ * Create a ruleset with content rules for getting instances are of the
18
+ * same ECClass and have the same property value as the provided `record`.
19
+ * @param field A field identifying which property of the record we should use
20
+ * @param record A record whose similar instances should be found
21
+ * @param computeDisplayValue Optional callback function to calculate display value that's
22
+ * used in ruleset's description. If not provided, display value from record is used instead.
23
+ */
24
+ createSimilarInstancesRuleset(field: Field, record: Item, computeDisplayValue?: ComputeDisplayValueCallback): Promise<{
25
+ ruleset: Ruleset;
26
+ description: string;
27
+ }>;
28
+ }
29
+ /**
30
+ * Definition of a function for calculating a display value.
31
+ * @public
32
+ */
33
+ export type ComputeDisplayValueCallback = (type: string, value: PrimitivePropertyValue, displayValue: string) => Promise<string>;
34
+ /**
35
+ * Value of a primitive property.
36
+ * @public
37
+ */
38
+ export type PrimitivePropertyValue = string | number | boolean | Point | InstanceKey | undefined;
39
+ type Point = {
40
+ x: number;
41
+ y: number;
42
+ z?: number;
43
+ };
44
+ export {};
45
45
  //# sourceMappingURL=RulesetsFactory.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"RulesetsFactory.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/RulesetsFactory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAmB,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAGtC,OAAO,EAAa,WAAW,EAAoB,MAAM,MAAM,CAAC;AAMhE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,iCAAiC;IAgCzC;;;;;;;OAOG;IACU,6BAA6B,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAK9K;AAED;;;GAGG;AACH,oBAAY,2BAA2B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAOjI;;;GAGG;AACH,oBAAY,sBAAsB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,WAAW,GAAG,SAAS,CAAC;AAGjG,aAAK,KAAK,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"RulesetsFactory.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/RulesetsFactory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAmB,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAGtC,OAAO,EAAa,WAAW,EAAoB,MAAM,MAAM,CAAC;AAMhE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,iCAAiC;IAgCzC;;;;;;;OAOG;IACU,6BAA6B,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAK9K;AAED;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAOjI;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,WAAW,GAAG,SAAS,CAAC;AAGjG,KAAK,KAAK,GAAG;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC"}
@@ -1,224 +1,224 @@
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.RulesetsFactory = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const TypeDescription_1 = require("./content/TypeDescription");
13
- const Value_1 = require("./content/Value");
14
- const EC_1 = require("./EC");
15
- const ContentSpecification_1 = require("./rules/content/ContentSpecification");
16
- const RelationshipDirection_1 = require("./rules/RelationshipDirection");
17
- const Rule_1 = require("./rules/Rule");
18
- /**
19
- * A factory class that can be used to create presentation rulesets targeted towards
20
- * specific use cases.
21
- *
22
- * @public
23
- */
24
- class RulesetsFactory {
25
- createSimilarInstancesRulesetInfo(field, record) {
26
- if (!field.isPropertiesField())
27
- throw new Error("Can only create 'similar instances' ruleset for properties-based records");
28
- if (field.type.valueFormat !== TypeDescription_1.PropertyValueFormat.Primitive)
29
- throw new Error("Can only create 'similar instances' ruleset for primitive properties");
30
- if (field.properties.length === 0)
31
- throw new Error("Invalid properties' field with no properties");
32
- if (record.isFieldMerged(field.name))
33
- throw new Error("Can't create 'similar instances' ruleset for merged values");
34
- if (!record.classInfo)
35
- throw new Error("Can't create 'similar instances' for records based on multiple different ECClass instances");
36
- const propertyName = getPropertyName(field);
37
- const propertyValue = getPropertyValue(record, field);
38
- const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);
39
- const relatedClass = relatedInstanceInfo === null || relatedInstanceInfo === void 0 ? void 0 : relatedInstanceInfo.class;
40
- const ruleset = {
41
- id: `SimilarInstances/${propertyName}/${core_bentley_1.Guid.createValue()}`,
42
- rules: [],
43
- };
44
- ruleset.rules.push({
45
- ruleType: Rule_1.RuleTypes.Content,
46
- specifications: [{
47
- specType: ContentSpecification_1.ContentSpecificationTypes.ContentInstancesOfSpecificClasses,
48
- classes: createMultiClassSpecification(record.classInfo),
49
- handleInstancesPolymorphically: true,
50
- relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],
51
- instanceFilter: createInstanceFilter(relatedInstanceInfo === null || relatedInstanceInfo === void 0 ? void 0 : relatedInstanceInfo.spec, field.type, propertyName, propertyValue.raw),
52
- }],
53
- });
54
- return { ruleset, relatedClass, propertyName, propertyValue };
55
- }
56
- /**
57
- * Create a ruleset with content rules for getting instances are of the
58
- * same ECClass and have the same property value as the provided `record`.
59
- * @param field A field identifying which property of the record we should use
60
- * @param record A record whose similar instances should be found
61
- * @param computeDisplayValue Optional callback function to calculate display value that's
62
- * used in ruleset's description. If not provided, display value from record is used instead.
63
- */
64
- async createSimilarInstancesRuleset(field, record, computeDisplayValue) {
65
- const info = this.createSimilarInstancesRulesetInfo(field, record);
66
- const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);
67
- return { ruleset: info.ruleset, description };
68
- }
69
- }
70
- exports.RulesetsFactory = RulesetsFactory;
71
- const toString = (displayValue) => {
72
- if (!displayValue)
73
- return "NULL";
74
- return displayValue.toString();
75
- };
76
- const createDescription = (record, relatedClass, field, value) => {
77
- const classInfo = relatedClass !== null && relatedClass !== void 0 ? relatedClass : record.classInfo;
78
- return `[${classInfo.label}].[${field.label}] = ${value}`;
79
- };
80
- const createDescriptionAsync = async (record, relatedClass, field, value, computeDisplayValue) => {
81
- const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);
82
- return createDescription(record, relatedClass, field, displayValue);
83
- };
84
- const getPropertyName = (field) => {
85
- let name = field.properties[0].property.name;
86
- if (field.type.typeName === "navigation")
87
- name += ".Id";
88
- return name;
89
- };
90
- const isPrimitivePropertyValue = (value) => {
91
- if (Value_1.Value.isPrimitive(value)) {
92
- return true;
93
- }
94
- if (Value_1.Value.isMap(value)) {
95
- if (typeof value.x === "number"
96
- && typeof value.y === "number"
97
- && (value.z === undefined || typeof value.z === "number")) {
98
- return true;
99
- }
100
- if (typeof value.className === "string" && typeof value.id === "string") {
101
- return true;
102
- }
103
- }
104
- return false;
105
- };
106
- const getPropertyValue = (record, field) => {
107
- const fieldNamesStack = [];
108
- let currField = field;
109
- while (currField) {
110
- fieldNamesStack.push(currField.name);
111
- currField = currField.parent;
112
- }
113
- let currFieldName = fieldNamesStack.pop();
114
- let displayValue = record.displayValues[currFieldName];
115
- let value = record.values[currFieldName];
116
- currFieldName = fieldNamesStack.pop();
117
- while (currFieldName) {
118
- if (!Value_1.Value.isNestedContent(value) || value.length === 0)
119
- throw new Error("Invalid record value");
120
- if (value.length > 1)
121
- throw new Error("Can't create 'similar instances' for records related through many part of *-to-many relationship");
122
- if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1)
123
- throw new Error("Can't create 'similar instances' ruleset for merged values");
124
- displayValue = value[0].displayValues[currFieldName];
125
- value = value[0].values[currFieldName];
126
- currFieldName = fieldNamesStack.pop();
127
- }
128
- if (!isPrimitivePropertyValue(value))
129
- throw new Error("Can only create 'similar instances' ruleset for primitive values");
130
- return { raw: value, display: toString(displayValue) };
131
- };
132
- const createInstanceFilter = (relatedInstanceSpec, propertyType, propertyName, propertyValue) => {
133
- const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : "this";
134
- return createComparison(propertyType, `${alias}.${propertyName}`, "=", propertyValue);
135
- };
136
- const createComparison = (type, name, operator, value) => {
137
- let compareValue = "";
138
- switch (typeof value) {
139
- case "undefined":
140
- compareValue = "NULL";
141
- break;
142
- case "string":
143
- compareValue = `"${value.replace(/"/g, `""`)}"`;
144
- break;
145
- case "boolean":
146
- compareValue = value ? "TRUE" : "FALSE";
147
- break;
148
- case "number":
149
- compareValue = value.toString();
150
- break;
151
- }
152
- if (type.typeName === "navigation" && typeof value === "object" && core_bentley_1.Id64.isId64(value.id))
153
- // note: this is temporary until we support hex ids in instance filters
154
- compareValue = hexToDec(value.id);
155
- if (type.typeName === "point2d" || type.typeName === "point3d") {
156
- if (typeof value !== "object")
157
- throw new Error("Expecting point values to be supplied as objects");
158
- const dimensionType = {
159
- valueFormat: TypeDescription_1.PropertyValueFormat.Primitive,
160
- typeName: "double",
161
- };
162
- const pointValue = value;
163
- let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;
164
- comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;
165
- if (type.typeName === "point3d" && pointValue.z !== undefined)
166
- comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;
167
- return comparison;
168
- }
169
- if (type.typeName === "double")
170
- return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;
171
- if (type.typeName === "dateTime")
172
- return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;
173
- return `${name} ${operator} ${compareValue}`;
174
- };
175
- const createMultiClassSpecification = (classInfo) => {
176
- const [schemaName, className] = classInfo.name.split(":");
177
- return { schemaName, classNames: [className] };
178
- };
179
- const createSingleClassSpecification = (classInfo) => {
180
- const [schemaName, className] = classInfo.name.split(":");
181
- return { schemaName, className };
182
- };
183
- const createRelatedInstanceSpec = (pathFromSelectToPropertyClass, index) => ({
184
- spec: {
185
- relationshipPath: pathFromSelectToPropertyClass.map((step) => ({
186
- relationship: createSingleClassSpecification(step.relationshipInfo),
187
- direction: step.isForwardRelationship ? RelationshipDirection_1.RelationshipDirection.Forward : RelationshipDirection_1.RelationshipDirection.Backward,
188
- targetClass: createSingleClassSpecification(step.targetClassInfo),
189
- })),
190
- isRequired: true,
191
- alias: `related_${index}`,
192
- },
193
- class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,
194
- });
195
- const createPathFromSelectToPropertyClass = (field) => {
196
- let currField = field;
197
- const pathFromPropertyToSelectClass = [];
198
- while (currField.parent) {
199
- pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);
200
- currField = currField.parent;
201
- }
202
- return EC_1.RelationshipPath.reverse(pathFromPropertyToSelectClass);
203
- };
204
- const createRelatedInstanceSpecInfo = (field) => {
205
- const path = createPathFromSelectToPropertyClass(field);
206
- return path.length ? createRelatedInstanceSpec(path, 0) : undefined;
207
- };
208
- const hexToDec = (id) => {
209
- const digits = [0];
210
- for (let i = 2; i < id.length; ++i) {
211
- let carry = parseInt(id.charAt(i), 16);
212
- for (let j = 0; j < digits.length; ++j) {
213
- digits[j] = digits[j] * 16 + carry;
214
- carry = digits[j] / 10 | 0;
215
- digits[j] %= 10;
216
- }
217
- while (carry > 0) {
218
- digits.push(carry % 10);
219
- carry = carry / 10 | 0;
220
- }
221
- }
222
- return digits.reverse().join("");
223
- };
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.RulesetsFactory = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const TypeDescription_1 = require("./content/TypeDescription");
13
+ const Value_1 = require("./content/Value");
14
+ const EC_1 = require("./EC");
15
+ const ContentSpecification_1 = require("./rules/content/ContentSpecification");
16
+ const RelationshipDirection_1 = require("./rules/RelationshipDirection");
17
+ const Rule_1 = require("./rules/Rule");
18
+ /**
19
+ * A factory class that can be used to create presentation rulesets targeted towards
20
+ * specific use cases.
21
+ *
22
+ * @public
23
+ */
24
+ class RulesetsFactory {
25
+ createSimilarInstancesRulesetInfo(field, record) {
26
+ if (!field.isPropertiesField())
27
+ throw new Error("Can only create 'similar instances' ruleset for properties-based records");
28
+ if (field.type.valueFormat !== TypeDescription_1.PropertyValueFormat.Primitive)
29
+ throw new Error("Can only create 'similar instances' ruleset for primitive properties");
30
+ if (field.properties.length === 0)
31
+ throw new Error("Invalid properties' field with no properties");
32
+ if (record.isFieldMerged(field.name))
33
+ throw new Error("Can't create 'similar instances' ruleset for merged values");
34
+ if (!record.classInfo)
35
+ throw new Error("Can't create 'similar instances' for records based on multiple different ECClass instances");
36
+ const propertyName = getPropertyName(field);
37
+ const propertyValue = getPropertyValue(record, field);
38
+ const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);
39
+ const relatedClass = relatedInstanceInfo?.class;
40
+ const ruleset = {
41
+ id: `SimilarInstances/${propertyName}/${core_bentley_1.Guid.createValue()}`,
42
+ rules: [],
43
+ };
44
+ ruleset.rules.push({
45
+ ruleType: Rule_1.RuleTypes.Content,
46
+ specifications: [{
47
+ specType: ContentSpecification_1.ContentSpecificationTypes.ContentInstancesOfSpecificClasses,
48
+ classes: createMultiClassSpecification(record.classInfo),
49
+ handleInstancesPolymorphically: true,
50
+ relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],
51
+ instanceFilter: createInstanceFilter(relatedInstanceInfo?.spec, field.type, propertyName, propertyValue.raw),
52
+ }],
53
+ });
54
+ return { ruleset, relatedClass, propertyName, propertyValue };
55
+ }
56
+ /**
57
+ * Create a ruleset with content rules for getting instances are of the
58
+ * same ECClass and have the same property value as the provided `record`.
59
+ * @param field A field identifying which property of the record we should use
60
+ * @param record A record whose similar instances should be found
61
+ * @param computeDisplayValue Optional callback function to calculate display value that's
62
+ * used in ruleset's description. If not provided, display value from record is used instead.
63
+ */
64
+ async createSimilarInstancesRuleset(field, record, computeDisplayValue) {
65
+ const info = this.createSimilarInstancesRulesetInfo(field, record);
66
+ const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);
67
+ return { ruleset: info.ruleset, description };
68
+ }
69
+ }
70
+ exports.RulesetsFactory = RulesetsFactory;
71
+ const toString = (displayValue) => {
72
+ if (!displayValue)
73
+ return "NULL";
74
+ return displayValue.toString();
75
+ };
76
+ const createDescription = (record, relatedClass, field, value) => {
77
+ const classInfo = relatedClass ?? record.classInfo;
78
+ return `[${classInfo.label}].[${field.label}] = ${value}`;
79
+ };
80
+ const createDescriptionAsync = async (record, relatedClass, field, value, computeDisplayValue) => {
81
+ const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);
82
+ return createDescription(record, relatedClass, field, displayValue);
83
+ };
84
+ const getPropertyName = (field) => {
85
+ let name = field.properties[0].property.name;
86
+ if (field.type.typeName === "navigation")
87
+ name += ".Id";
88
+ return name;
89
+ };
90
+ const isPrimitivePropertyValue = (value) => {
91
+ if (Value_1.Value.isPrimitive(value)) {
92
+ return true;
93
+ }
94
+ if (Value_1.Value.isMap(value)) {
95
+ if (typeof value.x === "number"
96
+ && typeof value.y === "number"
97
+ && (value.z === undefined || typeof value.z === "number")) {
98
+ return true;
99
+ }
100
+ if (typeof value.className === "string" && typeof value.id === "string") {
101
+ return true;
102
+ }
103
+ }
104
+ return false;
105
+ };
106
+ const getPropertyValue = (record, field) => {
107
+ const fieldNamesStack = [];
108
+ let currField = field;
109
+ while (currField) {
110
+ fieldNamesStack.push(currField.name);
111
+ currField = currField.parent;
112
+ }
113
+ let currFieldName = fieldNamesStack.pop();
114
+ let displayValue = record.displayValues[currFieldName];
115
+ let value = record.values[currFieldName];
116
+ currFieldName = fieldNamesStack.pop();
117
+ while (currFieldName) {
118
+ if (!Value_1.Value.isNestedContent(value) || value.length === 0)
119
+ throw new Error("Invalid record value");
120
+ if (value.length > 1)
121
+ throw new Error("Can't create 'similar instances' for records related through many part of *-to-many relationship");
122
+ if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1)
123
+ throw new Error("Can't create 'similar instances' ruleset for merged values");
124
+ displayValue = value[0].displayValues[currFieldName];
125
+ value = value[0].values[currFieldName];
126
+ currFieldName = fieldNamesStack.pop();
127
+ }
128
+ if (!isPrimitivePropertyValue(value))
129
+ throw new Error("Can only create 'similar instances' ruleset for primitive values");
130
+ return { raw: value, display: toString(displayValue) };
131
+ };
132
+ const createInstanceFilter = (relatedInstanceSpec, propertyType, propertyName, propertyValue) => {
133
+ const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : "this";
134
+ return createComparison(propertyType, `${alias}.${propertyName}`, "=", propertyValue);
135
+ };
136
+ const createComparison = (type, name, operator, value) => {
137
+ let compareValue = "";
138
+ switch (typeof value) {
139
+ case "undefined":
140
+ compareValue = "NULL";
141
+ break;
142
+ case "string":
143
+ compareValue = `"${value.replace(/"/g, `""`)}"`;
144
+ break;
145
+ case "boolean":
146
+ compareValue = value ? "TRUE" : "FALSE";
147
+ break;
148
+ case "number":
149
+ compareValue = value.toString();
150
+ break;
151
+ }
152
+ if (type.typeName === "navigation" && typeof value === "object" && core_bentley_1.Id64.isId64(value.id))
153
+ // note: this is temporary until we support hex ids in instance filters
154
+ compareValue = hexToDec(value.id);
155
+ if (type.typeName === "point2d" || type.typeName === "point3d") {
156
+ if (typeof value !== "object")
157
+ throw new Error("Expecting point values to be supplied as objects");
158
+ const dimensionType = {
159
+ valueFormat: TypeDescription_1.PropertyValueFormat.Primitive,
160
+ typeName: "double",
161
+ };
162
+ const pointValue = value;
163
+ let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;
164
+ comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;
165
+ if (type.typeName === "point3d" && pointValue.z !== undefined)
166
+ comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;
167
+ return comparison;
168
+ }
169
+ if (type.typeName === "double")
170
+ return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;
171
+ if (type.typeName === "dateTime")
172
+ return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;
173
+ return `${name} ${operator} ${compareValue}`;
174
+ };
175
+ const createMultiClassSpecification = (classInfo) => {
176
+ const [schemaName, className] = classInfo.name.split(":");
177
+ return { schemaName, classNames: [className] };
178
+ };
179
+ const createSingleClassSpecification = (classInfo) => {
180
+ const [schemaName, className] = classInfo.name.split(":");
181
+ return { schemaName, className };
182
+ };
183
+ const createRelatedInstanceSpec = (pathFromSelectToPropertyClass, index) => ({
184
+ spec: {
185
+ relationshipPath: pathFromSelectToPropertyClass.map((step) => ({
186
+ relationship: createSingleClassSpecification(step.relationshipInfo),
187
+ direction: step.isForwardRelationship ? RelationshipDirection_1.RelationshipDirection.Forward : RelationshipDirection_1.RelationshipDirection.Backward,
188
+ targetClass: createSingleClassSpecification(step.targetClassInfo),
189
+ })),
190
+ isRequired: true,
191
+ alias: `related_${index}`,
192
+ },
193
+ class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,
194
+ });
195
+ const createPathFromSelectToPropertyClass = (field) => {
196
+ let currField = field;
197
+ const pathFromPropertyToSelectClass = [];
198
+ while (currField.parent) {
199
+ pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);
200
+ currField = currField.parent;
201
+ }
202
+ return EC_1.RelationshipPath.reverse(pathFromPropertyToSelectClass);
203
+ };
204
+ const createRelatedInstanceSpecInfo = (field) => {
205
+ const path = createPathFromSelectToPropertyClass(field);
206
+ return path.length ? createRelatedInstanceSpec(path, 0) : undefined;
207
+ };
208
+ const hexToDec = (id) => {
209
+ const digits = [0];
210
+ for (let i = 2; i < id.length; ++i) {
211
+ let carry = parseInt(id.charAt(i), 16);
212
+ for (let j = 0; j < digits.length; ++j) {
213
+ digits[j] = digits[j] * 16 + carry;
214
+ carry = digits[j] / 10 | 0;
215
+ digits[j] %= 10;
216
+ }
217
+ while (carry > 0) {
218
+ digits.push(carry % 10);
219
+ carry = carry / 10 | 0;
220
+ }
221
+ }
222
+ return digits.reverse().join("");
223
+ };
224
224
  //# sourceMappingURL=RulesetsFactory.js.map