@itwin/presentation-common 4.0.0-dev.28 → 4.0.0-dev.32

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 (477) hide show
  1. package/lib/cjs/assets/locales/en/BisCore.json +18 -18
  2. package/lib/cjs/assets/locales/en/ECPresentation.json +9 -9
  3. package/lib/cjs/assets/locales/en/RulesEngine.json +5 -5
  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/AsyncTasks.js.map +1 -1
  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/CommonLoggerCategory.js.map +1 -1
  10. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  11. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  12. package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
  13. package/lib/cjs/presentation-common/EC.d.ts +350 -350
  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.js +9 -9
  18. package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
  19. package/lib/cjs/presentation-common/Error.d.ts +45 -45
  20. package/lib/cjs/presentation-common/Error.js +62 -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.js +9 -9
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.js.map +1 -1
  25. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  26. package/lib/cjs/presentation-common/KeySet.js +428 -428
  27. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  28. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -93
  29. package/lib/cjs/presentation-common/LabelDefinition.js +78 -78
  30. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  31. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  32. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  33. package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
  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/PresentationIpcInterface.js.map +1 -1
  37. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +261 -261
  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.js +104 -104
  42. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  43. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +30 -25
  44. package/lib/cjs/presentation-common/PropertyFormatter.d.ts.map +1 -1
  45. package/lib/cjs/presentation-common/PropertyFormatter.js +198 -73
  46. package/lib/cjs/presentation-common/PropertyFormatter.js.map +1 -1
  47. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  48. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  49. package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
  50. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +83 -83
  51. package/lib/cjs/presentation-common/RpcRequestsHandler.js +171 -171
  52. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  53. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  54. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  55. package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
  56. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  57. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  58. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  59. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  60. package/lib/cjs/presentation-common/Update.js +226 -226
  61. package/lib/cjs/presentation-common/Update.js.map +1 -1
  62. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  63. package/lib/cjs/presentation-common/Utils.js +43 -43
  64. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  65. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  66. package/lib/cjs/presentation-common/content/Category.js +48 -48
  67. package/lib/cjs/presentation-common/content/Category.js.map +1 -1
  68. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  69. package/lib/cjs/presentation-common/content/Content.js +56 -56
  70. package/lib/cjs/presentation-common/content/Content.js.map +1 -1
  71. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  72. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -437
  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 -191
  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/DisplayTypes.js.map +1 -1
  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/Editor.js.map +1 -1
  83. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -298
  84. package/lib/cjs/presentation-common/content/Fields.js +393 -393
  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.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.js +40 -40
  91. package/lib/cjs/presentation-common/content/Property.js.map +1 -1
  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/Renderer.js.map +1 -1
  95. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  96. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  97. package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
  98. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  99. package/lib/cjs/presentation-common/content/Value.js +273 -273
  100. package/lib/cjs/presentation-common/content/Value.js.map +1 -1
  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/HierarchyLevel.js.map +1 -1
  104. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  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.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/hierarchy/NodePathElement.js.map +1 -1
  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/ClassSpecifications.js.map +1 -1
  116. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  117. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  118. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  119. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  120. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  121. package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
  122. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  123. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  124. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  125. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  126. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  127. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  128. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  129. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  130. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  131. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  132. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  133. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  134. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  135. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  136. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  137. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  138. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  139. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  140. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  141. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  142. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  143. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  144. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  145. package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
  146. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  147. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  148. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  149. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  150. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  151. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  152. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  153. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  154. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  155. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  156. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  157. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  158. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  159. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  160. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  161. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  162. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  163. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  164. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  165. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  166. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  167. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  168. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  169. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  170. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  171. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  172. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  173. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  174. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  175. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  176. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  177. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  178. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  179. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  180. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  181. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  182. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  183. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  184. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  185. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  186. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  187. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  188. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  189. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  190. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  191. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  192. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  193. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  194. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  195. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  196. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  197. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  198. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  199. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  200. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  201. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  202. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  203. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  204. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  205. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  206. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  207. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  208. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  209. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  210. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  211. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  212. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  213. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  214. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  215. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  216. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  217. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  218. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  219. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  220. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  221. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  222. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  223. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  224. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  225. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  226. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  227. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  228. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  229. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  230. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  231. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  232. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  233. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  234. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  235. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  236. package/lib/cjs/presentation-common.d.ts +113 -113
  237. package/lib/cjs/presentation-common.js +129 -129
  238. package/lib/cjs/presentation-common.js.map +1 -1
  239. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  240. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  241. package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
  242. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  243. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  244. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
  245. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  246. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  247. package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
  248. package/lib/esm/presentation-common/EC.d.ts +350 -350
  249. package/lib/esm/presentation-common/EC.js +287 -287
  250. package/lib/esm/presentation-common/EC.js.map +1 -1
  251. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  252. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  253. package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
  254. package/lib/esm/presentation-common/Error.d.ts +45 -45
  255. package/lib/esm/presentation-common/Error.js +58 -58
  256. package/lib/esm/presentation-common/Error.js.map +1 -1
  257. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  258. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  259. package/lib/esm/presentation-common/InstanceFilterDefinition.js.map +1 -1
  260. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  261. package/lib/esm/presentation-common/KeySet.js +424 -424
  262. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  263. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -93
  264. package/lib/esm/presentation-common/LabelDefinition.js +75 -75
  265. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  266. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  267. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  268. package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
  269. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  270. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  271. package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
  272. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +261 -261
  273. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  274. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  275. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  276. package/lib/esm/presentation-common/PresentationRpcInterface.js +100 -100
  277. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  278. package/lib/esm/presentation-common/PropertyFormatter.d.ts +30 -25
  279. package/lib/esm/presentation-common/PropertyFormatter.d.ts.map +1 -1
  280. package/lib/esm/presentation-common/PropertyFormatter.js +193 -68
  281. package/lib/esm/presentation-common/PropertyFormatter.js.map +1 -1
  282. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  283. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  284. package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
  285. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +83 -83
  286. package/lib/esm/presentation-common/RpcRequestsHandler.js +167 -167
  287. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  288. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  289. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  290. package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
  291. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  292. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  293. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  294. package/lib/esm/presentation-common/Update.d.ts +213 -213
  295. package/lib/esm/presentation-common/Update.js +223 -223
  296. package/lib/esm/presentation-common/Update.js.map +1 -1
  297. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  298. package/lib/esm/presentation-common/Utils.js +39 -39
  299. package/lib/esm/presentation-common/Utils.js.map +1 -1
  300. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  301. package/lib/esm/presentation-common/content/Category.js +45 -45
  302. package/lib/esm/presentation-common/content/Category.js.map +1 -1
  303. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  304. package/lib/esm/presentation-common/content/Content.js +52 -52
  305. package/lib/esm/presentation-common/content/Content.js.map +1 -1
  306. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  307. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -427
  308. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  309. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  310. package/lib/esm/presentation-common/content/Descriptor.js +187 -187
  311. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  312. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  313. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  314. package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
  315. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  316. package/lib/esm/presentation-common/content/Editor.js +8 -8
  317. package/lib/esm/presentation-common/content/Editor.js.map +1 -1
  318. package/lib/esm/presentation-common/content/Fields.d.ts +298 -298
  319. package/lib/esm/presentation-common/content/Fields.js +386 -386
  320. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  321. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  322. package/lib/esm/presentation-common/content/Item.js +80 -80
  323. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  324. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  325. package/lib/esm/presentation-common/content/Property.js +37 -37
  326. package/lib/esm/presentation-common/content/Property.js.map +1 -1
  327. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  328. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  329. package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
  330. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  331. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  332. package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
  333. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  334. package/lib/esm/presentation-common/content/Value.js +270 -270
  335. package/lib/esm/presentation-common/content/Value.js.map +1 -1
  336. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  337. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  338. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js.map +1 -1
  339. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  340. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  341. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  342. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  343. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  344. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  345. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  346. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  347. package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  348. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  349. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  350. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  351. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  352. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  353. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  354. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  355. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  356. package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
  357. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  358. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  359. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  360. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  361. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  362. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  363. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  364. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  365. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  366. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  367. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  368. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  369. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  370. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  371. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  372. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  373. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  374. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  375. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  376. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  377. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  378. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  379. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  380. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  381. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  382. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  383. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  384. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  385. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  386. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  387. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  388. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  389. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  390. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  391. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  392. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  393. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  394. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  395. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  396. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  397. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  398. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  399. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  400. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  401. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  402. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  403. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  404. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  405. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  406. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  407. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  408. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  409. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  410. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  411. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  412. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  413. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  414. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  415. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  416. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  417. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  418. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  419. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  420. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  421. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  422. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  423. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  424. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  425. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  426. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  427. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  428. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  429. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  430. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  431. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  432. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  433. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  434. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  435. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  436. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  437. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  438. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  439. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  440. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  441. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  442. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  443. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  444. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  445. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  446. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  447. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  448. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  449. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  450. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  451. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  452. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  453. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  454. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  455. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  456. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  457. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  458. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  459. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  460. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  461. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  462. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  463. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  464. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  465. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  466. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  467. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  468. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  469. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  470. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  471. package/lib/esm/presentation-common.d.ts +113 -113
  472. package/lib/esm/presentation-common.js +117 -117
  473. package/lib/esm/presentation-common.js.map +1 -1
  474. package/lib/public/locales/en/BisCore.json +18 -18
  475. package/lib/public/locales/en/ECPresentation.json +9 -9
  476. package/lib/public/locales/en/RulesEngine.json +5 -5
  477. package/package.json +11 -9
@@ -1,438 +1,438 @@
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 Content
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.parseCombinedFieldNames = exports.combineFieldNames = exports.FIELD_NAMES_SEPARATOR = exports.addFieldHierarchy = exports.createFieldHierarchies = exports.traverseContentItem = exports.traverseContent = exports.traverseFieldHierarchy = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const Content_1 = require("./Content");
13
- const Fields_1 = require("./Fields");
14
- const Item_1 = require("./Item");
15
- const TypeDescription_1 = require("./TypeDescription");
16
- const Value_1 = require("./Value");
17
- /**
18
- * An utility for traversing field hierarchy. Stops traversal as soon as `cb` returns `false`.
19
- * @public
20
- */
21
- function traverseFieldHierarchy(hierarchy, cb) {
22
- if (cb(hierarchy))
23
- hierarchy.childFields.forEach((childHierarchy) => traverseFieldHierarchy(childHierarchy, cb));
24
- }
25
- exports.traverseFieldHierarchy = traverseFieldHierarchy;
26
- /**
27
- * An utility to traverse content using provided visitor. Provides means to parse content into different formats,
28
- * for different components.
29
- * @public
30
- */
31
- function traverseContent(visitor, content) {
32
- if (!visitor.startContent({ descriptor: content.descriptor }))
33
- return;
34
- try {
35
- const fieldHierarchies = createFieldHierarchies(content.descriptor.fields);
36
- visitor.processFieldHierarchies({ hierarchies: fieldHierarchies });
37
- content.contentSet.forEach((item) => {
38
- traverseContentItemFields(visitor, fieldHierarchies, item);
39
- });
40
- }
41
- finally {
42
- visitor.finishContent();
43
- }
44
- }
45
- exports.traverseContent = traverseContent;
46
- /**
47
- * An utility for calling [[traverseContent]] when there's only one content item.
48
- * @public
49
- */
50
- function traverseContentItem(visitor, descriptor, item) {
51
- traverseContent(visitor, new Content_1.Content(descriptor, [item]));
52
- }
53
- exports.traverseContentItem = traverseContentItem;
54
- class VisitedCategories {
55
- constructor(_visitor, category) {
56
- this._visitor = _visitor;
57
- const stack = [];
58
- let curr = category;
59
- while (curr) {
60
- stack.push(curr);
61
- curr = curr.parent;
62
- }
63
- stack.reverse();
64
- this._didVisitAllHierarchy = true;
65
- this._visitedCategories = [];
66
- for (curr of stack) {
67
- if (this._visitor.startCategory({ category: curr })) {
68
- this._visitedCategories.push(curr);
69
- }
70
- else {
71
- this._didVisitAllHierarchy = false;
72
- break;
73
- }
74
- }
75
- }
76
- dispose() {
77
- while (this._visitedCategories.pop())
78
- this._visitor.finishCategory();
79
- }
80
- get shouldContinue() { return this._didVisitAllHierarchy; }
81
- }
82
- function traverseContentItemFields(visitor, fieldHierarchies, item) {
83
- if (!visitor.startItem({ item }))
84
- return;
85
- try {
86
- fieldHierarchies.forEach((fieldHierarchy) => {
87
- (0, core_bentley_1.using)(new VisitedCategories(visitor, fieldHierarchy.field.category), (res) => {
88
- if (res.shouldContinue)
89
- traverseContentItemField(visitor, fieldHierarchy, item);
90
- });
91
- });
92
- }
93
- finally {
94
- visitor.finishItem();
95
- }
96
- }
97
- function traverseContentItemField(visitor, fieldHierarchy, item) {
98
- if (!visitor.startField({ hierarchy: fieldHierarchy }))
99
- return;
100
- try {
101
- const rootToThisField = createFieldPath(fieldHierarchy.field);
102
- let parentFieldName;
103
- const pathUpToField = rootToThisField.slice(undefined, -1);
104
- for (let i = 0; i < pathUpToField.length; ++i) {
105
- const parentField = pathUpToField[i];
106
- const nextField = rootToThisField[i + 1];
107
- if (item.isFieldMerged(parentField.name)) {
108
- visitor.processMergedValue({ requestedField: fieldHierarchy.field, mergedField: parentField, parentFieldName });
109
- return;
110
- }
111
- const { emptyNestedItem, convertedItem } = convertNestedContentItemToStructArrayItem(item, parentField, nextField);
112
- if (emptyNestedItem)
113
- return;
114
- item = convertedItem;
115
- parentFieldName = combineFieldNames(parentField.name, parentFieldName);
116
- }
117
- if (item.isFieldMerged(fieldHierarchy.field.name)) {
118
- visitor.processMergedValue({ requestedField: fieldHierarchy.field, mergedField: fieldHierarchy.field, parentFieldName });
119
- return;
120
- }
121
- if (fieldHierarchy.field.isNestedContentField()) {
122
- fieldHierarchy = convertNestedContentFieldHierarchyToStructArrayHierarchy(fieldHierarchy, parentFieldName);
123
- const { emptyNestedItem, convertedItem } = convertNestedContentFieldHierarchyItemToStructArrayItem(item, fieldHierarchy);
124
- if (emptyNestedItem)
125
- return;
126
- item = convertedItem;
127
- }
128
- else if (pathUpToField.length > 0) {
129
- fieldHierarchy = {
130
- ...fieldHierarchy,
131
- field: Object.assign(fieldHierarchy.field.clone(), {
132
- type: {
133
- valueFormat: TypeDescription_1.PropertyValueFormat.Array,
134
- typeName: `${fieldHierarchy.field.type.typeName}[]`,
135
- memberType: fieldHierarchy.field.type,
136
- },
137
- }),
138
- };
139
- }
140
- traverseContentItemFieldValue(visitor, fieldHierarchy, item.mergedFieldNames, fieldHierarchy.field.type, parentFieldName, item.values[fieldHierarchy.field.name], item.displayValues[fieldHierarchy.field.name]);
141
- }
142
- finally {
143
- visitor.finishField();
144
- }
145
- }
146
- function traverseContentItemFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue) {
147
- if (rawValue !== undefined) {
148
- if (valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Array) {
149
- (0, core_bentley_1.assert)(Value_1.Value.isArray(rawValue));
150
- (0, core_bentley_1.assert)(Value_1.DisplayValue.isArray(displayValue));
151
- return traverseContentItemArrayFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue);
152
- }
153
- if (valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Struct) {
154
- (0, core_bentley_1.assert)(Value_1.Value.isMap(rawValue));
155
- (0, core_bentley_1.assert)(Value_1.DisplayValue.isMap(displayValue));
156
- return traverseContentItemStructFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue);
157
- }
158
- }
159
- traverseContentItemPrimitiveFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue);
160
- }
161
- function traverseContentItemArrayFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValues, displayValues) {
162
- (0, core_bentley_1.assert)(rawValues.length === displayValues.length);
163
- (0, core_bentley_1.assert)(valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Array);
164
- if (!visitor.startArray({ hierarchy: fieldHierarchy, valueType, parentFieldName, rawValues, displayValues }))
165
- return;
166
- try {
167
- const itemType = valueType.memberType;
168
- rawValues.forEach((_, i) => {
169
- traverseContentItemFieldValue(visitor, fieldHierarchy, mergedFieldNames, itemType, parentFieldName, rawValues[i], displayValues[i]);
170
- });
171
- }
172
- finally {
173
- visitor.finishArray();
174
- }
175
- }
176
- function traverseContentItemStructFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValues, displayValues) {
177
- (0, core_bentley_1.assert)(valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Struct);
178
- if (!visitor.startStruct({ hierarchy: fieldHierarchy, valueType, parentFieldName, rawValues, displayValues }))
179
- return;
180
- try {
181
- if (fieldHierarchy.field.isNestedContentField())
182
- parentFieldName = combineFieldNames(fieldHierarchy.field.name, parentFieldName);
183
- valueType.members.forEach((memberDescription) => {
184
- let memberField = fieldHierarchy.childFields.find((f) => f.field.name === memberDescription.name);
185
- if (!memberField) {
186
- // Not finding a member field means we're traversing an ECStruct. We still need to carry member information, so we
187
- // create a fake field to represent the member
188
- memberField = {
189
- field: new Fields_1.Field(fieldHierarchy.field.category, memberDescription.name, memberDescription.label, memberDescription.type, fieldHierarchy.field.isReadonly, 0),
190
- childFields: [],
191
- };
192
- }
193
- traverseContentItemFieldValue(visitor, memberField, mergedFieldNames, memberDescription.type, parentFieldName, rawValues[memberDescription.name], displayValues[memberDescription.name]);
194
- });
195
- }
196
- finally {
197
- visitor.finishStruct();
198
- }
199
- }
200
- function traverseContentItemPrimitiveFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue) {
201
- if (-1 !== mergedFieldNames.indexOf(fieldHierarchy.field.name)) {
202
- visitor.processMergedValue({ mergedField: fieldHierarchy.field, requestedField: fieldHierarchy.field, parentFieldName });
203
- return;
204
- }
205
- visitor.processPrimitiveValue({ field: fieldHierarchy.field, valueType, parentFieldName, rawValue, displayValue });
206
- }
207
- /**
208
- * Parses a list of [[Field]] objects into a list of [[FieldHierarchy]].
209
- *
210
- * @param ignoreCategories Enables adding all of the `nestedFields` to parent field's `childFields`
211
- * without considering categories.
212
- *
213
- * @public
214
- */
215
- function createFieldHierarchies(fields, ignoreCategories) {
216
- const hierarchies = new Array();
217
- const visitField = (category, field, parentField) => {
218
- let childFields = [];
219
- if (field.isNestedContentField()) {
220
- // visit all nested fields
221
- childFields = visitFields(field.nestedFields, field);
222
- if (0 === childFields.length)
223
- return undefined;
224
- }
225
- const fieldHierarchy = { field, childFields };
226
- if (category === parentField?.category || ignoreCategories && parentField) {
227
- // if categories of this field and its parent field match - return the field hierarchy without
228
- // including it as a top level field
229
- return fieldHierarchy;
230
- }
231
- addFieldHierarchy(hierarchies, fieldHierarchy);
232
- return undefined;
233
- };
234
- const visitFields = (visitedFields, parentField) => {
235
- const includedFields = [];
236
- visitedFields.forEach((field) => {
237
- const visitedField = visitField(field.category, field, parentField);
238
- if (visitedField)
239
- includedFields.push(visitedField);
240
- });
241
- return includedFields;
242
- };
243
- visitFields(fields, undefined);
244
- return hierarchies;
245
- }
246
- exports.createFieldHierarchies = createFieldHierarchies;
247
- function findRelatedFields(rootFields, hierarchy) {
248
- // build a list of parent fields in hierarchy
249
- const fields = [];
250
- let currField = hierarchy.field;
251
- while (currField) {
252
- fields.push(currField);
253
- currField = currField.parent;
254
- }
255
- for (let rootIndex = 0; rootIndex < rootFields.length; ++rootIndex) {
256
- const rootFieldHierarchy = rootFields[rootIndex];
257
- if (rootFieldHierarchy.field.category !== hierarchy.field.category) {
258
- // only interested in fields with the same category
259
- continue;
260
- }
261
- let first = true;
262
- currField = rootFieldHierarchy.field;
263
- while (currField) {
264
- const index = fields.findIndex((f) => f.name === currField.name);
265
- if (-1 !== index) {
266
- return {
267
- existing: {
268
- field: currField,
269
- hierarchy: first ? rootFieldHierarchy : undefined,
270
- index: rootIndex,
271
- },
272
- matchingField: fields[index],
273
- };
274
- }
275
- currField = currField.parent;
276
- first = false;
277
- }
278
- }
279
- return undefined;
280
- }
281
- function buildParentHierarchy(hierarchy, parentField) {
282
- // note: parentField is found by walking up the parentship relationship
283
- // from hierarchy.field, so we expect to always find it here
284
- while (hierarchy.field !== parentField) {
285
- const hierarchyParent = hierarchy.field.parent;
286
- (0, core_bentley_1.assert)(hierarchyParent !== undefined);
287
- hierarchy = { field: hierarchyParent, childFields: [hierarchy] };
288
- }
289
- return hierarchy;
290
- }
291
- function mergeHierarchies(lhs, rhs) {
292
- (0, core_bentley_1.assert)(lhs.field.name === rhs.field.name);
293
- const result = {
294
- field: lhs.field.clone(),
295
- childFields: [...lhs.childFields],
296
- };
297
- rhs.childFields.forEach((rhsChildHierarchy) => {
298
- const indexInResult = result.childFields.findIndex((resultHierarchy) => resultHierarchy.field.name === rhsChildHierarchy.field.name);
299
- if (indexInResult !== -1)
300
- result.childFields[indexInResult] = mergeHierarchies(result.childFields[indexInResult], rhsChildHierarchy);
301
- else
302
- result.childFields.push(rhsChildHierarchy);
303
- });
304
- return result;
305
- }
306
- /**
307
- * Adds a field hierarchy into root field hierarchies list. *
308
- * @public
309
- */
310
- function addFieldHierarchy(rootHierarchies, hierarchy) {
311
- const match = findRelatedFields(rootHierarchies, hierarchy);
312
- if (!match) {
313
- rootHierarchies.push(hierarchy);
314
- return;
315
- }
316
- const targetHierarchy = rootHierarchies[match.existing.index];
317
- const existingHierarchy = match.existing.hierarchy ?? buildParentHierarchy(targetHierarchy, match.existing.field);
318
- const insertHierarchy = buildParentHierarchy(hierarchy, match.matchingField);
319
- const mergedHierarchy = mergeHierarchies(existingHierarchy, insertHierarchy);
320
- mergedHierarchy.field.category = hierarchy.field.category;
321
- rootHierarchies[match.existing.index] = mergedHierarchy;
322
- }
323
- exports.addFieldHierarchy = addFieldHierarchy;
324
- function createFieldPath(field) {
325
- const path = [field];
326
- let currField = field;
327
- while (currField.parent) {
328
- currField = currField.parent;
329
- path.push(currField);
330
- }
331
- path.reverse();
332
- return path;
333
- }
334
- /** @internal */
335
- exports.FIELD_NAMES_SEPARATOR = "$";
336
- /**
337
- * Combines given field names in a way that allows them to be parsed back into a list of individual names using the [[parseCombinedFieldNames]] function.
338
- * @public
339
- */
340
- function combineFieldNames(fieldName, parentFieldName) {
341
- return parentFieldName ? `${parentFieldName}${exports.FIELD_NAMES_SEPARATOR}${fieldName}` : fieldName;
342
- }
343
- exports.combineFieldNames = combineFieldNames;
344
- /**
345
- * Parses given combined field names string, constructed using [[combineFieldNames]], into a list of individual field names.
346
- * @public
347
- */
348
- function parseCombinedFieldNames(combinedName) {
349
- return combinedName ? combinedName.split(exports.FIELD_NAMES_SEPARATOR) : [];
350
- }
351
- exports.parseCombinedFieldNames = parseCombinedFieldNames;
352
- function convertNestedContentItemToStructArrayItem(item, field, nextField) {
353
- const value = item.values[field.name] ?? [];
354
- (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(value));
355
- if (value.length === 0)
356
- return { emptyNestedItem: true, convertedItem: item };
357
- const nextFieldValues = { raw: [], display: [] };
358
- value.forEach((ncv) => {
359
- const nextRawValue = ncv.values[nextField.name];
360
- const nextDisplayValue = ncv.displayValues[nextField.name];
361
- if (nextField.isNestedContentField()) {
362
- if (nextRawValue) {
363
- (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(nextRawValue));
364
- nextFieldValues.raw.push(...nextRawValue);
365
- }
366
- }
367
- else {
368
- nextFieldValues.raw.push(nextRawValue);
369
- nextFieldValues.display.push(nextDisplayValue);
370
- }
371
- });
372
- const convertedItem = new Item_1.Item(item.primaryKeys, item.label, item.imageId, item.classInfo, { [nextField.name]: nextFieldValues.raw }, { [nextField.name]: nextFieldValues.display }, item.mergedFieldNames, item.extendedData); // eslint-disable-line deprecation/deprecation
373
- return { emptyNestedItem: false, convertedItem };
374
- }
375
- function convertNestedContentFieldHierarchyToStructArrayHierarchy(fieldHierarchy, parentFieldName) {
376
- const fieldName = fieldHierarchy.field.name;
377
- const convertedChildFieldHierarchies = fieldHierarchy.childFields.map((child) => {
378
- if (child.field.isNestedContentField())
379
- return convertNestedContentFieldHierarchyToStructArrayHierarchy(child, combineFieldNames(fieldName, parentFieldName));
380
- return child;
381
- });
382
- const convertedFieldHierarchy = {
383
- field: Object.assign(fieldHierarchy.field.clone(), {
384
- type: {
385
- valueFormat: TypeDescription_1.PropertyValueFormat.Array,
386
- typeName: `${fieldHierarchy.field.type.typeName}[]`,
387
- memberType: {
388
- valueFormat: TypeDescription_1.PropertyValueFormat.Struct,
389
- typeName: fieldHierarchy.field.type.typeName,
390
- members: convertedChildFieldHierarchies.map((member) => ({
391
- name: member.field.name,
392
- label: member.field.label,
393
- type: member.field.type,
394
- })),
395
- },
396
- },
397
- }),
398
- childFields: convertedChildFieldHierarchies,
399
- };
400
- return convertedFieldHierarchy;
401
- }
402
- function convertNestedContentValuesToStructArrayValuesRecursive(fieldHierarchy, ncvs) {
403
- const result = { raw: [], display: [], mergedFieldNames: [] };
404
- ncvs.forEach((ncv) => {
405
- const values = { ...ncv.values };
406
- const displayValues = { ...ncv.displayValues };
407
- const mergedFieldNames = [...ncv.mergedFieldNames];
408
- fieldHierarchy.childFields.forEach((childFieldHierarchy) => {
409
- const childFieldName = childFieldHierarchy.field.name;
410
- if (-1 !== ncv.mergedFieldNames.indexOf(childFieldName)) {
411
- return;
412
- }
413
- if (childFieldHierarchy.field.isNestedContentField()) {
414
- const value = values[childFieldName];
415
- (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(value));
416
- const convertedValues = convertNestedContentValuesToStructArrayValuesRecursive(childFieldHierarchy, value);
417
- values[childFieldName] = convertedValues.raw;
418
- displayValues[childFieldName] = convertedValues.display;
419
- mergedFieldNames.push(...convertedValues.mergedFieldNames);
420
- }
421
- });
422
- result.raw.push(values);
423
- result.display.push(displayValues);
424
- result.mergedFieldNames.push(...mergedFieldNames);
425
- });
426
- return result;
427
- }
428
- function convertNestedContentFieldHierarchyItemToStructArrayItem(item, fieldHierarchy) {
429
- const fieldName = fieldHierarchy.field.name;
430
- const rawValue = item.values[fieldName];
431
- (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(rawValue));
432
- if (rawValue.length === 0)
433
- return { emptyNestedItem: true, convertedItem: item };
434
- const converted = convertNestedContentValuesToStructArrayValuesRecursive(fieldHierarchy, rawValue);
435
- const convertedItem = new Item_1.Item(item.primaryKeys, item.label, item.imageId, item.classInfo, { [fieldName]: converted.raw }, { [fieldName]: converted.display }, converted.mergedFieldNames, item.extendedData); // eslint-disable-line deprecation/deprecation
436
- return { emptyNestedItem: false, convertedItem };
437
- }
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 Content
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.parseCombinedFieldNames = exports.combineFieldNames = exports.FIELD_NAMES_SEPARATOR = exports.addFieldHierarchy = exports.createFieldHierarchies = exports.traverseContentItem = exports.traverseContent = exports.traverseFieldHierarchy = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const Content_1 = require("./Content");
13
+ const Fields_1 = require("./Fields");
14
+ const Item_1 = require("./Item");
15
+ const TypeDescription_1 = require("./TypeDescription");
16
+ const Value_1 = require("./Value");
17
+ /**
18
+ * An utility for traversing field hierarchy. Stops traversal as soon as `cb` returns `false`.
19
+ * @public
20
+ */
21
+ function traverseFieldHierarchy(hierarchy, cb) {
22
+ if (cb(hierarchy))
23
+ hierarchy.childFields.forEach((childHierarchy) => traverseFieldHierarchy(childHierarchy, cb));
24
+ }
25
+ exports.traverseFieldHierarchy = traverseFieldHierarchy;
26
+ /**
27
+ * An utility to traverse content using provided visitor. Provides means to parse content into different formats,
28
+ * for different components.
29
+ * @public
30
+ */
31
+ function traverseContent(visitor, content) {
32
+ if (!visitor.startContent({ descriptor: content.descriptor }))
33
+ return;
34
+ try {
35
+ const fieldHierarchies = createFieldHierarchies(content.descriptor.fields);
36
+ visitor.processFieldHierarchies({ hierarchies: fieldHierarchies });
37
+ content.contentSet.forEach((item) => {
38
+ traverseContentItemFields(visitor, fieldHierarchies, item);
39
+ });
40
+ }
41
+ finally {
42
+ visitor.finishContent();
43
+ }
44
+ }
45
+ exports.traverseContent = traverseContent;
46
+ /**
47
+ * An utility for calling [[traverseContent]] when there's only one content item.
48
+ * @public
49
+ */
50
+ function traverseContentItem(visitor, descriptor, item) {
51
+ traverseContent(visitor, new Content_1.Content(descriptor, [item]));
52
+ }
53
+ exports.traverseContentItem = traverseContentItem;
54
+ class VisitedCategories {
55
+ constructor(_visitor, category) {
56
+ this._visitor = _visitor;
57
+ const stack = [];
58
+ let curr = category;
59
+ while (curr) {
60
+ stack.push(curr);
61
+ curr = curr.parent;
62
+ }
63
+ stack.reverse();
64
+ this._didVisitAllHierarchy = true;
65
+ this._visitedCategories = [];
66
+ for (curr of stack) {
67
+ if (this._visitor.startCategory({ category: curr })) {
68
+ this._visitedCategories.push(curr);
69
+ }
70
+ else {
71
+ this._didVisitAllHierarchy = false;
72
+ break;
73
+ }
74
+ }
75
+ }
76
+ dispose() {
77
+ while (this._visitedCategories.pop())
78
+ this._visitor.finishCategory();
79
+ }
80
+ get shouldContinue() { return this._didVisitAllHierarchy; }
81
+ }
82
+ function traverseContentItemFields(visitor, fieldHierarchies, item) {
83
+ if (!visitor.startItem({ item }))
84
+ return;
85
+ try {
86
+ fieldHierarchies.forEach((fieldHierarchy) => {
87
+ (0, core_bentley_1.using)(new VisitedCategories(visitor, fieldHierarchy.field.category), (res) => {
88
+ if (res.shouldContinue)
89
+ traverseContentItemField(visitor, fieldHierarchy, item);
90
+ });
91
+ });
92
+ }
93
+ finally {
94
+ visitor.finishItem();
95
+ }
96
+ }
97
+ function traverseContentItemField(visitor, fieldHierarchy, item) {
98
+ if (!visitor.startField({ hierarchy: fieldHierarchy }))
99
+ return;
100
+ try {
101
+ const rootToThisField = createFieldPath(fieldHierarchy.field);
102
+ let parentFieldName;
103
+ const pathUpToField = rootToThisField.slice(undefined, -1);
104
+ for (let i = 0; i < pathUpToField.length; ++i) {
105
+ const parentField = pathUpToField[i];
106
+ const nextField = rootToThisField[i + 1];
107
+ if (item.isFieldMerged(parentField.name)) {
108
+ visitor.processMergedValue({ requestedField: fieldHierarchy.field, mergedField: parentField, parentFieldName });
109
+ return;
110
+ }
111
+ const { emptyNestedItem, convertedItem } = convertNestedContentItemToStructArrayItem(item, parentField, nextField);
112
+ if (emptyNestedItem)
113
+ return;
114
+ item = convertedItem;
115
+ parentFieldName = combineFieldNames(parentField.name, parentFieldName);
116
+ }
117
+ if (item.isFieldMerged(fieldHierarchy.field.name)) {
118
+ visitor.processMergedValue({ requestedField: fieldHierarchy.field, mergedField: fieldHierarchy.field, parentFieldName });
119
+ return;
120
+ }
121
+ if (fieldHierarchy.field.isNestedContentField()) {
122
+ fieldHierarchy = convertNestedContentFieldHierarchyToStructArrayHierarchy(fieldHierarchy, parentFieldName);
123
+ const { emptyNestedItem, convertedItem } = convertNestedContentFieldHierarchyItemToStructArrayItem(item, fieldHierarchy);
124
+ if (emptyNestedItem)
125
+ return;
126
+ item = convertedItem;
127
+ }
128
+ else if (pathUpToField.length > 0) {
129
+ fieldHierarchy = {
130
+ ...fieldHierarchy,
131
+ field: Object.assign(fieldHierarchy.field.clone(), {
132
+ type: {
133
+ valueFormat: TypeDescription_1.PropertyValueFormat.Array,
134
+ typeName: `${fieldHierarchy.field.type.typeName}[]`,
135
+ memberType: fieldHierarchy.field.type,
136
+ },
137
+ }),
138
+ };
139
+ }
140
+ traverseContentItemFieldValue(visitor, fieldHierarchy, item.mergedFieldNames, fieldHierarchy.field.type, parentFieldName, item.values[fieldHierarchy.field.name], item.displayValues[fieldHierarchy.field.name]);
141
+ }
142
+ finally {
143
+ visitor.finishField();
144
+ }
145
+ }
146
+ function traverseContentItemFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue) {
147
+ if (rawValue !== undefined) {
148
+ if (valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Array) {
149
+ (0, core_bentley_1.assert)(Value_1.Value.isArray(rawValue));
150
+ (0, core_bentley_1.assert)(Value_1.DisplayValue.isArray(displayValue));
151
+ return traverseContentItemArrayFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue);
152
+ }
153
+ if (valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Struct) {
154
+ (0, core_bentley_1.assert)(Value_1.Value.isMap(rawValue));
155
+ (0, core_bentley_1.assert)(Value_1.DisplayValue.isMap(displayValue));
156
+ return traverseContentItemStructFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue);
157
+ }
158
+ }
159
+ traverseContentItemPrimitiveFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue);
160
+ }
161
+ function traverseContentItemArrayFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValues, displayValues) {
162
+ (0, core_bentley_1.assert)(rawValues.length === displayValues.length);
163
+ (0, core_bentley_1.assert)(valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Array);
164
+ if (!visitor.startArray({ hierarchy: fieldHierarchy, valueType, parentFieldName, rawValues, displayValues }))
165
+ return;
166
+ try {
167
+ const itemType = valueType.memberType;
168
+ rawValues.forEach((_, i) => {
169
+ traverseContentItemFieldValue(visitor, fieldHierarchy, mergedFieldNames, itemType, parentFieldName, rawValues[i], displayValues[i]);
170
+ });
171
+ }
172
+ finally {
173
+ visitor.finishArray();
174
+ }
175
+ }
176
+ function traverseContentItemStructFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValues, displayValues) {
177
+ (0, core_bentley_1.assert)(valueType.valueFormat === TypeDescription_1.PropertyValueFormat.Struct);
178
+ if (!visitor.startStruct({ hierarchy: fieldHierarchy, valueType, parentFieldName, rawValues, displayValues }))
179
+ return;
180
+ try {
181
+ if (fieldHierarchy.field.isNestedContentField())
182
+ parentFieldName = combineFieldNames(fieldHierarchy.field.name, parentFieldName);
183
+ valueType.members.forEach((memberDescription) => {
184
+ let memberField = fieldHierarchy.childFields.find((f) => f.field.name === memberDescription.name);
185
+ if (!memberField) {
186
+ // Not finding a member field means we're traversing an ECStruct. We still need to carry member information, so we
187
+ // create a fake field to represent the member
188
+ memberField = {
189
+ field: new Fields_1.Field(fieldHierarchy.field.category, memberDescription.name, memberDescription.label, memberDescription.type, fieldHierarchy.field.isReadonly, 0),
190
+ childFields: [],
191
+ };
192
+ }
193
+ traverseContentItemFieldValue(visitor, memberField, mergedFieldNames, memberDescription.type, parentFieldName, rawValues[memberDescription.name], displayValues[memberDescription.name]);
194
+ });
195
+ }
196
+ finally {
197
+ visitor.finishStruct();
198
+ }
199
+ }
200
+ function traverseContentItemPrimitiveFieldValue(visitor, fieldHierarchy, mergedFieldNames, valueType, parentFieldName, rawValue, displayValue) {
201
+ if (-1 !== mergedFieldNames.indexOf(fieldHierarchy.field.name)) {
202
+ visitor.processMergedValue({ mergedField: fieldHierarchy.field, requestedField: fieldHierarchy.field, parentFieldName });
203
+ return;
204
+ }
205
+ visitor.processPrimitiveValue({ field: fieldHierarchy.field, valueType, parentFieldName, rawValue, displayValue });
206
+ }
207
+ /**
208
+ * Parses a list of [[Field]] objects into a list of [[FieldHierarchy]].
209
+ *
210
+ * @param ignoreCategories Enables adding all of the `nestedFields` to parent field's `childFields`
211
+ * without considering categories.
212
+ *
213
+ * @public
214
+ */
215
+ function createFieldHierarchies(fields, ignoreCategories) {
216
+ const hierarchies = new Array();
217
+ const visitField = (category, field, parentField) => {
218
+ let childFields = [];
219
+ if (field.isNestedContentField()) {
220
+ // visit all nested fields
221
+ childFields = visitFields(field.nestedFields, field);
222
+ if (0 === childFields.length)
223
+ return undefined;
224
+ }
225
+ const fieldHierarchy = { field, childFields };
226
+ if (category === parentField?.category || ignoreCategories && parentField) {
227
+ // if categories of this field and its parent field match - return the field hierarchy without
228
+ // including it as a top level field
229
+ return fieldHierarchy;
230
+ }
231
+ addFieldHierarchy(hierarchies, fieldHierarchy);
232
+ return undefined;
233
+ };
234
+ const visitFields = (visitedFields, parentField) => {
235
+ const includedFields = [];
236
+ visitedFields.forEach((field) => {
237
+ const visitedField = visitField(field.category, field, parentField);
238
+ if (visitedField)
239
+ includedFields.push(visitedField);
240
+ });
241
+ return includedFields;
242
+ };
243
+ visitFields(fields, undefined);
244
+ return hierarchies;
245
+ }
246
+ exports.createFieldHierarchies = createFieldHierarchies;
247
+ function findRelatedFields(rootFields, hierarchy) {
248
+ // build a list of parent fields in hierarchy
249
+ const fields = [];
250
+ let currField = hierarchy.field;
251
+ while (currField) {
252
+ fields.push(currField);
253
+ currField = currField.parent;
254
+ }
255
+ for (let rootIndex = 0; rootIndex < rootFields.length; ++rootIndex) {
256
+ const rootFieldHierarchy = rootFields[rootIndex];
257
+ if (rootFieldHierarchy.field.category !== hierarchy.field.category) {
258
+ // only interested in fields with the same category
259
+ continue;
260
+ }
261
+ let first = true;
262
+ currField = rootFieldHierarchy.field;
263
+ while (currField) {
264
+ const index = fields.findIndex((f) => f.name === currField.name);
265
+ if (-1 !== index) {
266
+ return {
267
+ existing: {
268
+ field: currField,
269
+ hierarchy: first ? rootFieldHierarchy : undefined,
270
+ index: rootIndex,
271
+ },
272
+ matchingField: fields[index],
273
+ };
274
+ }
275
+ currField = currField.parent;
276
+ first = false;
277
+ }
278
+ }
279
+ return undefined;
280
+ }
281
+ function buildParentHierarchy(hierarchy, parentField) {
282
+ // note: parentField is found by walking up the parentship relationship
283
+ // from hierarchy.field, so we expect to always find it here
284
+ while (hierarchy.field !== parentField) {
285
+ const hierarchyParent = hierarchy.field.parent;
286
+ (0, core_bentley_1.assert)(hierarchyParent !== undefined);
287
+ hierarchy = { field: hierarchyParent, childFields: [hierarchy] };
288
+ }
289
+ return hierarchy;
290
+ }
291
+ function mergeHierarchies(lhs, rhs) {
292
+ (0, core_bentley_1.assert)(lhs.field.name === rhs.field.name);
293
+ const result = {
294
+ field: lhs.field.clone(),
295
+ childFields: [...lhs.childFields],
296
+ };
297
+ rhs.childFields.forEach((rhsChildHierarchy) => {
298
+ const indexInResult = result.childFields.findIndex((resultHierarchy) => resultHierarchy.field.name === rhsChildHierarchy.field.name);
299
+ if (indexInResult !== -1)
300
+ result.childFields[indexInResult] = mergeHierarchies(result.childFields[indexInResult], rhsChildHierarchy);
301
+ else
302
+ result.childFields.push(rhsChildHierarchy);
303
+ });
304
+ return result;
305
+ }
306
+ /**
307
+ * Adds a field hierarchy into root field hierarchies list. *
308
+ * @public
309
+ */
310
+ function addFieldHierarchy(rootHierarchies, hierarchy) {
311
+ const match = findRelatedFields(rootHierarchies, hierarchy);
312
+ if (!match) {
313
+ rootHierarchies.push(hierarchy);
314
+ return;
315
+ }
316
+ const targetHierarchy = rootHierarchies[match.existing.index];
317
+ const existingHierarchy = match.existing.hierarchy ?? buildParentHierarchy(targetHierarchy, match.existing.field);
318
+ const insertHierarchy = buildParentHierarchy(hierarchy, match.matchingField);
319
+ const mergedHierarchy = mergeHierarchies(existingHierarchy, insertHierarchy);
320
+ mergedHierarchy.field.category = hierarchy.field.category;
321
+ rootHierarchies[match.existing.index] = mergedHierarchy;
322
+ }
323
+ exports.addFieldHierarchy = addFieldHierarchy;
324
+ function createFieldPath(field) {
325
+ const path = [field];
326
+ let currField = field;
327
+ while (currField.parent) {
328
+ currField = currField.parent;
329
+ path.push(currField);
330
+ }
331
+ path.reverse();
332
+ return path;
333
+ }
334
+ /** @internal */
335
+ exports.FIELD_NAMES_SEPARATOR = "$";
336
+ /**
337
+ * Combines given field names in a way that allows them to be parsed back into a list of individual names using the [[parseCombinedFieldNames]] function.
338
+ * @public
339
+ */
340
+ function combineFieldNames(fieldName, parentFieldName) {
341
+ return parentFieldName ? `${parentFieldName}${exports.FIELD_NAMES_SEPARATOR}${fieldName}` : fieldName;
342
+ }
343
+ exports.combineFieldNames = combineFieldNames;
344
+ /**
345
+ * Parses given combined field names string, constructed using [[combineFieldNames]], into a list of individual field names.
346
+ * @public
347
+ */
348
+ function parseCombinedFieldNames(combinedName) {
349
+ return combinedName ? combinedName.split(exports.FIELD_NAMES_SEPARATOR) : [];
350
+ }
351
+ exports.parseCombinedFieldNames = parseCombinedFieldNames;
352
+ function convertNestedContentItemToStructArrayItem(item, field, nextField) {
353
+ const value = item.values[field.name] ?? [];
354
+ (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(value));
355
+ if (value.length === 0)
356
+ return { emptyNestedItem: true, convertedItem: item };
357
+ const nextFieldValues = { raw: [], display: [] };
358
+ value.forEach((ncv) => {
359
+ const nextRawValue = ncv.values[nextField.name];
360
+ const nextDisplayValue = ncv.displayValues[nextField.name];
361
+ if (nextField.isNestedContentField()) {
362
+ if (nextRawValue) {
363
+ (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(nextRawValue));
364
+ nextFieldValues.raw.push(...nextRawValue);
365
+ }
366
+ }
367
+ else {
368
+ nextFieldValues.raw.push(nextRawValue);
369
+ nextFieldValues.display.push(nextDisplayValue);
370
+ }
371
+ });
372
+ const convertedItem = new Item_1.Item(item.primaryKeys, item.label, item.imageId, item.classInfo, { [nextField.name]: nextFieldValues.raw }, { [nextField.name]: nextFieldValues.display }, item.mergedFieldNames, item.extendedData); // eslint-disable-line deprecation/deprecation
373
+ return { emptyNestedItem: false, convertedItem };
374
+ }
375
+ function convertNestedContentFieldHierarchyToStructArrayHierarchy(fieldHierarchy, parentFieldName) {
376
+ const fieldName = fieldHierarchy.field.name;
377
+ const convertedChildFieldHierarchies = fieldHierarchy.childFields.map((child) => {
378
+ if (child.field.isNestedContentField())
379
+ return convertNestedContentFieldHierarchyToStructArrayHierarchy(child, combineFieldNames(fieldName, parentFieldName));
380
+ return child;
381
+ });
382
+ const convertedFieldHierarchy = {
383
+ field: Object.assign(fieldHierarchy.field.clone(), {
384
+ type: {
385
+ valueFormat: TypeDescription_1.PropertyValueFormat.Array,
386
+ typeName: `${fieldHierarchy.field.type.typeName}[]`,
387
+ memberType: {
388
+ valueFormat: TypeDescription_1.PropertyValueFormat.Struct,
389
+ typeName: fieldHierarchy.field.type.typeName,
390
+ members: convertedChildFieldHierarchies.map((member) => ({
391
+ name: member.field.name,
392
+ label: member.field.label,
393
+ type: member.field.type,
394
+ })),
395
+ },
396
+ },
397
+ }),
398
+ childFields: convertedChildFieldHierarchies,
399
+ };
400
+ return convertedFieldHierarchy;
401
+ }
402
+ function convertNestedContentValuesToStructArrayValuesRecursive(fieldHierarchy, ncvs) {
403
+ const result = { raw: [], display: [], mergedFieldNames: [] };
404
+ ncvs.forEach((ncv) => {
405
+ const values = { ...ncv.values };
406
+ const displayValues = { ...ncv.displayValues };
407
+ const mergedFieldNames = [...ncv.mergedFieldNames];
408
+ fieldHierarchy.childFields.forEach((childFieldHierarchy) => {
409
+ const childFieldName = childFieldHierarchy.field.name;
410
+ if (-1 !== ncv.mergedFieldNames.indexOf(childFieldName)) {
411
+ return;
412
+ }
413
+ if (childFieldHierarchy.field.isNestedContentField()) {
414
+ const value = values[childFieldName];
415
+ (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(value));
416
+ const convertedValues = convertNestedContentValuesToStructArrayValuesRecursive(childFieldHierarchy, value);
417
+ values[childFieldName] = convertedValues.raw;
418
+ displayValues[childFieldName] = convertedValues.display;
419
+ mergedFieldNames.push(...convertedValues.mergedFieldNames);
420
+ }
421
+ });
422
+ result.raw.push(values);
423
+ result.display.push(displayValues);
424
+ result.mergedFieldNames.push(...mergedFieldNames);
425
+ });
426
+ return result;
427
+ }
428
+ function convertNestedContentFieldHierarchyItemToStructArrayItem(item, fieldHierarchy) {
429
+ const fieldName = fieldHierarchy.field.name;
430
+ const rawValue = item.values[fieldName];
431
+ (0, core_bentley_1.assert)(Value_1.Value.isNestedContent(rawValue));
432
+ if (rawValue.length === 0)
433
+ return { emptyNestedItem: true, convertedItem: item };
434
+ const converted = convertNestedContentValuesToStructArrayValuesRecursive(fieldHierarchy, rawValue);
435
+ const convertedItem = new Item_1.Item(item.primaryKeys, item.label, item.imageId, item.classInfo, { [fieldName]: converted.raw }, { [fieldName]: converted.display }, converted.mergedFieldNames, item.extendedData); // eslint-disable-line deprecation/deprecation
436
+ return { emptyNestedItem: false, convertedItem };
437
+ }
438
438
  //# sourceMappingURL=ContentTraverser.js.map