@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

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 (366) hide show
  1. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  2. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  3. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  4. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  5. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  6. package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
  7. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  8. package/lib/cjs/presentation-common/EC.d.ts +350 -350
  9. package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
  10. package/lib/cjs/presentation-common/EC.js +290 -290
  11. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  12. package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
  13. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  14. package/lib/cjs/presentation-common/Error.d.ts +47 -47
  15. package/lib/cjs/presentation-common/Error.js +64 -64
  16. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  17. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  18. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
  19. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  20. package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
  21. package/lib/cjs/presentation-common/KeySet.js +428 -428
  22. package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -93
  23. package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
  24. package/lib/cjs/presentation-common/LabelDefinition.js +78 -78
  25. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  26. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  27. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
  28. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  29. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -273
  30. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  31. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  32. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
  33. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  34. package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
  35. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  36. package/lib/cjs/presentation-common/PropertyFormatter.d.ts +30 -30
  37. package/lib/cjs/presentation-common/PropertyFormatter.js +198 -198
  38. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  39. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  40. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  41. package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -166
  42. package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
  43. package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
  44. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  45. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  46. package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
  47. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  48. package/lib/cjs/presentation-common/Update.d.ts +213 -213
  49. package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
  50. package/lib/cjs/presentation-common/Update.js +226 -226
  51. package/lib/cjs/presentation-common/Utils.d.ts +62 -62
  52. package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
  53. package/lib/cjs/presentation-common/Utils.js +43 -43
  54. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  55. package/lib/cjs/presentation-common/content/Category.js +48 -48
  56. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  57. package/lib/cjs/presentation-common/content/Content.js +56 -56
  58. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
  59. package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -437
  60. package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
  61. package/lib/cjs/presentation-common/content/Descriptor.js +191 -191
  62. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  63. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  64. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  65. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  66. package/lib/cjs/presentation-common/content/Fields.d.ts +298 -298
  67. package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
  68. package/lib/cjs/presentation-common/content/Fields.js +393 -393
  69. package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
  70. package/lib/cjs/presentation-common/content/Item.js +84 -84
  71. package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
  72. package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
  73. package/lib/cjs/presentation-common/content/Property.js +40 -40
  74. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  75. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  76. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  77. package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
  78. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  79. package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
  80. package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
  81. package/lib/cjs/presentation-common/content/Value.js +273 -273
  82. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  83. package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
  84. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
  85. package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
  86. package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
  87. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
  88. package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
  89. package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
  90. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  91. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
  92. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  93. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  94. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  95. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  96. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  97. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  98. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  99. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  100. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  101. package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
  102. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  103. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
  104. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  105. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  106. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  107. package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
  108. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  109. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  110. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  111. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  112. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  113. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  114. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  115. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  116. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  117. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  118. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  119. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  120. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  121. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  122. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  123. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  124. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  125. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  126. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  127. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  128. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  129. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  130. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  131. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  132. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  133. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  134. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  135. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  136. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  137. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  138. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  139. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  140. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  141. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  142. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  143. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  144. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  145. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  146. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  147. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  148. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  149. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  150. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  151. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  152. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  153. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  154. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  155. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  156. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  157. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  158. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  159. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  160. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
  161. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  162. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  163. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  164. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  165. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  166. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  167. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  168. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  169. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  170. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  171. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  172. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  173. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  174. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  175. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  176. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  177. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  178. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
  179. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  180. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  181. package/lib/cjs/presentation-common.d.ts +113 -113
  182. package/lib/cjs/presentation-common.js +133 -129
  183. package/lib/cjs/presentation-common.js.map +1 -1
  184. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  185. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  186. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  187. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  188. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  189. package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
  190. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  191. package/lib/esm/presentation-common/EC.d.ts +350 -350
  192. package/lib/esm/presentation-common/EC.d.ts.map +1 -1
  193. package/lib/esm/presentation-common/EC.js +287 -287
  194. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  195. package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
  196. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  197. package/lib/esm/presentation-common/Error.d.ts +47 -47
  198. package/lib/esm/presentation-common/Error.js +60 -60
  199. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
  200. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
  201. package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
  202. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  203. package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
  204. package/lib/esm/presentation-common/KeySet.js +424 -424
  205. package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -93
  206. package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
  207. package/lib/esm/presentation-common/LabelDefinition.js +75 -75
  208. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  209. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  210. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
  211. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  212. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -273
  213. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  214. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  215. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
  216. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  217. package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
  218. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  219. package/lib/esm/presentation-common/PropertyFormatter.d.ts +30 -30
  220. package/lib/esm/presentation-common/PropertyFormatter.js +193 -193
  221. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  222. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  223. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  224. package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -162
  225. package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
  226. package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
  227. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  228. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  229. package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
  230. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  231. package/lib/esm/presentation-common/Update.d.ts +213 -213
  232. package/lib/esm/presentation-common/Update.d.ts.map +1 -1
  233. package/lib/esm/presentation-common/Update.js +223 -223
  234. package/lib/esm/presentation-common/Utils.d.ts +62 -62
  235. package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
  236. package/lib/esm/presentation-common/Utils.js +39 -39
  237. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  238. package/lib/esm/presentation-common/content/Category.js +45 -45
  239. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  240. package/lib/esm/presentation-common/content/Content.js +52 -52
  241. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
  242. package/lib/esm/presentation-common/content/ContentTraverser.js +427 -427
  243. package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
  244. package/lib/esm/presentation-common/content/Descriptor.js +187 -187
  245. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  246. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  247. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  248. package/lib/esm/presentation-common/content/Editor.js +8 -8
  249. package/lib/esm/presentation-common/content/Fields.d.ts +298 -298
  250. package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
  251. package/lib/esm/presentation-common/content/Fields.js +386 -386
  252. package/lib/esm/presentation-common/content/Item.d.ts +85 -85
  253. package/lib/esm/presentation-common/content/Item.js +80 -80
  254. package/lib/esm/presentation-common/content/Property.d.ts +57 -57
  255. package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
  256. package/lib/esm/presentation-common/content/Property.js +37 -37
  257. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  258. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  259. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  260. package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
  261. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  262. package/lib/esm/presentation-common/content/Value.d.ts +189 -189
  263. package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
  264. package/lib/esm/presentation-common/content/Value.js +270 -270
  265. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
  266. package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
  267. package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
  268. package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
  269. package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
  270. package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
  271. package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
  272. package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
  273. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
  274. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
  275. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  276. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  277. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  278. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  279. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  280. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  281. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
  282. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
  283. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  284. package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
  285. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  286. package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
  287. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  288. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  289. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  290. package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
  291. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  292. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  293. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  294. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  295. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  296. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  297. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  298. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
  299. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  300. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  301. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  302. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  303. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  304. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  305. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  306. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  307. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  308. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  309. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  310. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  311. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  312. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  313. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
  314. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  315. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
  316. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  317. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
  318. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  319. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  320. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  321. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  322. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  323. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  324. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  325. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
  326. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  327. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  328. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  329. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
  330. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
  331. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  332. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  333. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  334. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  335. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
  336. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  337. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  338. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  339. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
  340. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  341. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
  342. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
  343. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
  344. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  345. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  346. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
  347. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  348. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  349. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  350. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  351. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
  352. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  353. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  354. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  355. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  356. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  357. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
  358. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  359. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
  360. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  361. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
  362. package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
  363. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  364. package/lib/esm/presentation-common.d.ts +113 -113
  365. package/lib/esm/presentation-common.js +117 -117
  366. package/package.json +12 -12
@@ -1,188 +1,188 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Content
7
- */
8
- import { assert } from "@itwin/core-bentley";
9
- import { RelatedClassInfo, RelatedClassInfoWithOptionalRelationship, } from "../EC";
10
- import { CategoryDescription } from "./Category";
11
- import { Field, getFieldByName } from "./Fields";
12
- /** @public */
13
- export var SelectClassInfo;
14
- (function (SelectClassInfo) {
15
- /** Deserialize [[SelectClassInfo]] from compressed JSON */
16
- function fromCompressedJSON(json, classesMap) {
17
- assert(classesMap.hasOwnProperty(json.selectClassInfo));
18
- return {
19
- selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },
20
- isSelectPolymorphic: json.isSelectPolymorphic,
21
- ...(json.navigationPropertyClasses ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) } : undefined),
22
- ...(json.relatedInstancePaths ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
23
- ...(json.pathFromInputToSelectClass ? { pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)) } : undefined),
24
- ...(json.relatedPropertyPaths ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
25
- };
26
- }
27
- SelectClassInfo.fromCompressedJSON = fromCompressedJSON;
28
- /** Serialize [[SelectClassInfo]] to compressed JSON */
29
- function toCompressedJSON(selectClass, classesMap) {
30
- const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;
31
- classesMap[id] = leftOverClassInfo;
32
- return {
33
- selectClassInfo: id,
34
- isSelectPolymorphic: selectClass.isSelectPolymorphic,
35
- ...(selectClass.relatedInstancePaths ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) } : undefined),
36
- ...(selectClass.navigationPropertyClasses ? { navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)) } : undefined),
37
- ...(selectClass.pathFromInputToSelectClass ? { pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)) } : undefined),
38
- ...(selectClass.relatedPropertyPaths ? { relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => RelatedClassInfo.toCompressedJSON(relatedClass, classesMap))) } : undefined),
39
- };
40
- }
41
- SelectClassInfo.toCompressedJSON = toCompressedJSON;
42
- /**
43
- * Deserialize [[SelectClassInfo]] list from JSON
44
- * @param json JSON or JSON serialized to string to deserialize from
45
- * @returns Deserialized [[SelectClassInfo]] objects list
46
- *
47
- * @internal
48
- */
49
- function listFromCompressedJSON(json, classesMap) {
50
- return json.map((sci) => fromCompressedJSON(sci, classesMap));
51
- }
52
- SelectClassInfo.listFromCompressedJSON = listFromCompressedJSON;
53
- })(SelectClassInfo || (SelectClassInfo = {}));
54
- /**
55
- * Flags that control content format.
56
- * @public
57
- */
58
- export var ContentFlags;
59
- (function (ContentFlags) {
60
- /** Each content record only has [[InstanceKey]] and no data */
61
- ContentFlags[ContentFlags["KeysOnly"] = 1] = "KeysOnly";
62
- /**
63
- * Each content record additionally has an image id
64
- * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
65
- */
66
- ContentFlags[ContentFlags["ShowImages"] = 2] = "ShowImages";
67
- /** Each content record additionally has a display label */
68
- ContentFlags[ContentFlags["ShowLabels"] = 4] = "ShowLabels";
69
- /** All content records are merged into a single record (see [Merging values]($docs/presentation/content/terminology#value-merging)) */
70
- ContentFlags[ContentFlags["MergeResults"] = 8] = "MergeResults";
71
- /** Content has only distinct values */
72
- ContentFlags[ContentFlags["DistinctValues"] = 16] = "DistinctValues";
73
- /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */
74
- ContentFlags[ContentFlags["NoFields"] = 32] = "NoFields";
75
- /**
76
- * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which
77
- * given input key at the cost of performance creating those items.
78
- */
79
- ContentFlags[ContentFlags["IncludeInputKeys"] = 256] = "IncludeInputKeys";
80
- /**
81
- * Produce content descriptor that is not intended for querying content. Allows the implementation to omit certain
82
- * operations to make obtaining content descriptor faster.
83
- * @internal
84
- */
85
- ContentFlags[ContentFlags["DescriptorOnly"] = 512] = "DescriptorOnly";
86
- })(ContentFlags || (ContentFlags = {}));
87
- /**
88
- * Data sorting direction
89
- * @public
90
- */
91
- export var SortDirection;
92
- (function (SortDirection) {
93
- SortDirection[SortDirection["Ascending"] = 0] = "Ascending";
94
- SortDirection[SortDirection["Descending"] = 1] = "Descending";
95
- })(SortDirection || (SortDirection = {}));
96
- /**
97
- * Data structure that describes content: fields, sorting, filtering, format, etc.
98
- * Descriptor may be changed to control how content is created.
99
- *
100
- * @public
101
- */
102
- export class Descriptor {
103
- /** Construct a new Descriptor using a [[DescriptorSource]] */
104
- constructor(source) {
105
- this.connectionId = source.connectionId;
106
- this.inputKeysHash = source.inputKeysHash;
107
- this.selectionInfo = source.selectionInfo;
108
- this.displayType = source.displayType;
109
- this.contentFlags = source.contentFlags;
110
- this.selectClasses = [...source.selectClasses];
111
- this.categories = [...source.categories];
112
- this.fields = [...source.fields];
113
- this.sortingField = source.sortingField;
114
- this.sortDirection = source.sortDirection;
115
- this.filterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line deprecation/deprecation
116
- this.fieldsFilterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line deprecation/deprecation
117
- this.instanceFilter = source.instanceFilter;
118
- }
119
- /** Serialize [[Descriptor]] to JSON */
120
- toJSON() {
121
- const classesMap = {};
122
- const selectClasses = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));
123
- const fields = this.fields.map((field) => field.toCompressedJSON(classesMap));
124
- return Object.assign({
125
- displayType: this.displayType,
126
- contentFlags: this.contentFlags,
127
- categories: this.categories.map(CategoryDescription.toJSON),
128
- fields,
129
- selectClasses,
130
- classesMap,
131
- }, this.connectionId !== undefined && { connectionId: this.connectionId }, this.inputKeysHash !== undefined && { inputKeysHash: this.inputKeysHash },
132
- // istanbul ignore next
133
- this.contentOptions !== undefined && { contentOptions: this.contentOptions }, // eslint-disable-line deprecation/deprecation
134
- this.sortingField !== undefined && { sortingFieldName: this.sortingField.name }, this.sortDirection !== undefined && { sortDirection: this.sortDirection }, this.filterExpression !== undefined && { filterExpression: this.filterExpression }, // eslint-disable-line deprecation/deprecation
135
- this.fieldsFilterExpression !== undefined && { fieldsFilterExpression: this.fieldsFilterExpression }, this.instanceFilter !== undefined && { instanceFilter: this.instanceFilter }, this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo });
136
- }
137
- /** Deserialize [[Descriptor]] from JSON */
138
- static fromJSON(json) {
139
- if (!json)
140
- return undefined;
141
- const { classesMap, ...leftOverJson } = json;
142
- const categories = CategoryDescription.listFromJSON(json.categories);
143
- const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);
144
- const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));
145
- return new Descriptor({
146
- ...leftOverJson,
147
- selectClasses,
148
- categories,
149
- fields,
150
- sortingField: getFieldByName(fields, json.sortingFieldName, true),
151
- });
152
- }
153
- static getFieldsFromJSON(json, factory) {
154
- return json.map((fieldJson) => {
155
- const field = factory(fieldJson);
156
- if (field)
157
- field.rebuildParentship();
158
- return field;
159
- }).filter((field) => !!field);
160
- }
161
- /**
162
- * Get field by its name
163
- * @param name Name of the field to find
164
- * @param recurse Recurse into nested fields
165
- */
166
- getFieldByName(name, recurse) {
167
- return getFieldByName(this.fields, name, recurse);
168
- }
169
- /**
170
- * Create descriptor overrides object from this descriptor.
171
- * @public
172
- */
173
- createDescriptorOverrides() {
174
- const overrides = {};
175
- if (this.displayType)
176
- overrides.displayType = this.displayType;
177
- if (this.contentFlags !== 0)
178
- overrides.contentFlags = this.contentFlags;
179
- if (this.filterExpression || this.fieldsFilterExpression) // eslint-disable-line deprecation/deprecation
180
- overrides.fieldsFilterExpression = this.fieldsFilterExpression ?? this.filterExpression; // eslint-disable-line deprecation/deprecation
181
- if (this.instanceFilter)
182
- overrides.instanceFilter = this.instanceFilter;
183
- if (this.sortingField)
184
- overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: this.sortDirection ?? SortDirection.Ascending };
185
- return overrides;
186
- }
187
- }
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Content
7
+ */
8
+ import { assert } from "@itwin/core-bentley";
9
+ import { RelatedClassInfo, RelatedClassInfoWithOptionalRelationship, } from "../EC";
10
+ import { CategoryDescription } from "./Category";
11
+ import { Field, getFieldByName } from "./Fields";
12
+ /** @public */
13
+ export var SelectClassInfo;
14
+ (function (SelectClassInfo) {
15
+ /** Deserialize [[SelectClassInfo]] from compressed JSON */
16
+ function fromCompressedJSON(json, classesMap) {
17
+ assert(classesMap.hasOwnProperty(json.selectClassInfo));
18
+ return {
19
+ selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },
20
+ isSelectPolymorphic: json.isSelectPolymorphic,
21
+ ...(json.navigationPropertyClasses ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) } : undefined),
22
+ ...(json.relatedInstancePaths ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
23
+ ...(json.pathFromInputToSelectClass ? { pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)) } : undefined),
24
+ ...(json.relatedPropertyPaths ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
25
+ };
26
+ }
27
+ SelectClassInfo.fromCompressedJSON = fromCompressedJSON;
28
+ /** Serialize [[SelectClassInfo]] to compressed JSON */
29
+ function toCompressedJSON(selectClass, classesMap) {
30
+ const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;
31
+ classesMap[id] = leftOverClassInfo;
32
+ return {
33
+ selectClassInfo: id,
34
+ isSelectPolymorphic: selectClass.isSelectPolymorphic,
35
+ ...(selectClass.relatedInstancePaths ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) } : undefined),
36
+ ...(selectClass.navigationPropertyClasses ? { navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)) } : undefined),
37
+ ...(selectClass.pathFromInputToSelectClass ? { pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)) } : undefined),
38
+ ...(selectClass.relatedPropertyPaths ? { relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => RelatedClassInfo.toCompressedJSON(relatedClass, classesMap))) } : undefined),
39
+ };
40
+ }
41
+ SelectClassInfo.toCompressedJSON = toCompressedJSON;
42
+ /**
43
+ * Deserialize [[SelectClassInfo]] list from JSON
44
+ * @param json JSON or JSON serialized to string to deserialize from
45
+ * @returns Deserialized [[SelectClassInfo]] objects list
46
+ *
47
+ * @internal
48
+ */
49
+ function listFromCompressedJSON(json, classesMap) {
50
+ return json.map((sci) => fromCompressedJSON(sci, classesMap));
51
+ }
52
+ SelectClassInfo.listFromCompressedJSON = listFromCompressedJSON;
53
+ })(SelectClassInfo || (SelectClassInfo = {}));
54
+ /**
55
+ * Flags that control content format.
56
+ * @public
57
+ */
58
+ export var ContentFlags;
59
+ (function (ContentFlags) {
60
+ /** Each content record only has [[InstanceKey]] and no data */
61
+ ContentFlags[ContentFlags["KeysOnly"] = 1] = "KeysOnly";
62
+ /**
63
+ * Each content record additionally has an image id
64
+ * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
65
+ */
66
+ ContentFlags[ContentFlags["ShowImages"] = 2] = "ShowImages";
67
+ /** Each content record additionally has a display label */
68
+ ContentFlags[ContentFlags["ShowLabels"] = 4] = "ShowLabels";
69
+ /** All content records are merged into a single record (see [Merging values]($docs/presentation/content/terminology#value-merging)) */
70
+ ContentFlags[ContentFlags["MergeResults"] = 8] = "MergeResults";
71
+ /** Content has only distinct values */
72
+ ContentFlags[ContentFlags["DistinctValues"] = 16] = "DistinctValues";
73
+ /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */
74
+ ContentFlags[ContentFlags["NoFields"] = 32] = "NoFields";
75
+ /**
76
+ * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which
77
+ * given input key at the cost of performance creating those items.
78
+ */
79
+ ContentFlags[ContentFlags["IncludeInputKeys"] = 256] = "IncludeInputKeys";
80
+ /**
81
+ * Produce content descriptor that is not intended for querying content. Allows the implementation to omit certain
82
+ * operations to make obtaining content descriptor faster.
83
+ * @internal
84
+ */
85
+ ContentFlags[ContentFlags["DescriptorOnly"] = 512] = "DescriptorOnly";
86
+ })(ContentFlags || (ContentFlags = {}));
87
+ /**
88
+ * Data sorting direction
89
+ * @public
90
+ */
91
+ export var SortDirection;
92
+ (function (SortDirection) {
93
+ SortDirection[SortDirection["Ascending"] = 0] = "Ascending";
94
+ SortDirection[SortDirection["Descending"] = 1] = "Descending";
95
+ })(SortDirection || (SortDirection = {}));
96
+ /**
97
+ * Data structure that describes content: fields, sorting, filtering, format, etc.
98
+ * Descriptor may be changed to control how content is created.
99
+ *
100
+ * @public
101
+ */
102
+ export class Descriptor {
103
+ /** Construct a new Descriptor using a [[DescriptorSource]] */
104
+ constructor(source) {
105
+ this.connectionId = source.connectionId;
106
+ this.inputKeysHash = source.inputKeysHash;
107
+ this.selectionInfo = source.selectionInfo;
108
+ this.displayType = source.displayType;
109
+ this.contentFlags = source.contentFlags;
110
+ this.selectClasses = [...source.selectClasses];
111
+ this.categories = [...source.categories];
112
+ this.fields = [...source.fields];
113
+ this.sortingField = source.sortingField;
114
+ this.sortDirection = source.sortDirection;
115
+ this.filterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line deprecation/deprecation
116
+ this.fieldsFilterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line deprecation/deprecation
117
+ this.instanceFilter = source.instanceFilter;
118
+ }
119
+ /** Serialize [[Descriptor]] to JSON */
120
+ toJSON() {
121
+ const classesMap = {};
122
+ const selectClasses = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));
123
+ const fields = this.fields.map((field) => field.toCompressedJSON(classesMap));
124
+ return Object.assign({
125
+ displayType: this.displayType,
126
+ contentFlags: this.contentFlags,
127
+ categories: this.categories.map(CategoryDescription.toJSON),
128
+ fields,
129
+ selectClasses,
130
+ classesMap,
131
+ }, this.connectionId !== undefined && { connectionId: this.connectionId }, this.inputKeysHash !== undefined && { inputKeysHash: this.inputKeysHash },
132
+ // istanbul ignore next
133
+ this.contentOptions !== undefined && { contentOptions: this.contentOptions }, // eslint-disable-line deprecation/deprecation
134
+ this.sortingField !== undefined && { sortingFieldName: this.sortingField.name }, this.sortDirection !== undefined && { sortDirection: this.sortDirection }, this.filterExpression !== undefined && { filterExpression: this.filterExpression }, // eslint-disable-line deprecation/deprecation
135
+ this.fieldsFilterExpression !== undefined && { fieldsFilterExpression: this.fieldsFilterExpression }, this.instanceFilter !== undefined && { instanceFilter: this.instanceFilter }, this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo });
136
+ }
137
+ /** Deserialize [[Descriptor]] from JSON */
138
+ static fromJSON(json) {
139
+ if (!json)
140
+ return undefined;
141
+ const { classesMap, ...leftOverJson } = json;
142
+ const categories = CategoryDescription.listFromJSON(json.categories);
143
+ const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);
144
+ const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));
145
+ return new Descriptor({
146
+ ...leftOverJson,
147
+ selectClasses,
148
+ categories,
149
+ fields,
150
+ sortingField: getFieldByName(fields, json.sortingFieldName, true),
151
+ });
152
+ }
153
+ static getFieldsFromJSON(json, factory) {
154
+ return json.map((fieldJson) => {
155
+ const field = factory(fieldJson);
156
+ if (field)
157
+ field.rebuildParentship();
158
+ return field;
159
+ }).filter((field) => !!field);
160
+ }
161
+ /**
162
+ * Get field by its name
163
+ * @param name Name of the field to find
164
+ * @param recurse Recurse into nested fields
165
+ */
166
+ getFieldByName(name, recurse) {
167
+ return getFieldByName(this.fields, name, recurse);
168
+ }
169
+ /**
170
+ * Create descriptor overrides object from this descriptor.
171
+ * @public
172
+ */
173
+ createDescriptorOverrides() {
174
+ const overrides = {};
175
+ if (this.displayType)
176
+ overrides.displayType = this.displayType;
177
+ if (this.contentFlags !== 0)
178
+ overrides.contentFlags = this.contentFlags;
179
+ if (this.filterExpression || this.fieldsFilterExpression) // eslint-disable-line deprecation/deprecation
180
+ overrides.fieldsFilterExpression = this.fieldsFilterExpression ?? this.filterExpression; // eslint-disable-line deprecation/deprecation
181
+ if (this.instanceFilter)
182
+ overrides.instanceFilter = this.instanceFilter;
183
+ if (this.sortingField)
184
+ overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: this.sortDirection ?? SortDirection.Ascending };
185
+ return overrides;
186
+ }
187
+ }
188
188
  //# sourceMappingURL=Descriptor.js.map
@@ -1,22 +1,22 @@
1
- /** @packageDocumentation
2
- * @module Content
3
- */
4
- /**
5
- * Displayed content types. Affects how the content is formatted, e.g.
6
- * the [[ContentFlags]].
7
- *
8
- * @public
9
- */
10
- export declare enum DefaultContentDisplayTypes {
11
- /** Unknown content type. */
12
- Undefined = "Undefined",
13
- /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
14
- Grid = "Grid",
15
- /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
16
- PropertyPane = "PropertyPane",
17
- /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
18
- List = "List",
19
- /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
20
- Viewport = "Graphics"
21
- }
1
+ /** @packageDocumentation
2
+ * @module Content
3
+ */
4
+ /**
5
+ * Displayed content types. Affects how the content is formatted, e.g.
6
+ * the [[ContentFlags]].
7
+ *
8
+ * @public
9
+ */
10
+ export declare enum DefaultContentDisplayTypes {
11
+ /** Unknown content type. */
12
+ Undefined = "Undefined",
13
+ /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
14
+ Grid = "Grid",
15
+ /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
16
+ PropertyPane = "PropertyPane",
17
+ /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
18
+ List = "List",
19
+ /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
20
+ Viewport = "Graphics"
21
+ }
22
22
  //# sourceMappingURL=DisplayTypes.d.ts.map
@@ -1,27 +1,27 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Content
7
- */
8
- /**
9
- * Displayed content types. Affects how the content is formatted, e.g.
10
- * the [[ContentFlags]].
11
- *
12
- * @public
13
- */
14
- export var DefaultContentDisplayTypes;
15
- (function (DefaultContentDisplayTypes) {
16
- /** Unknown content type. */
17
- DefaultContentDisplayTypes["Undefined"] = "Undefined";
18
- /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
19
- DefaultContentDisplayTypes["Grid"] = "Grid";
20
- /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
21
- DefaultContentDisplayTypes["PropertyPane"] = "PropertyPane";
22
- /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
23
- DefaultContentDisplayTypes["List"] = "List";
24
- /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
25
- DefaultContentDisplayTypes["Viewport"] = "Graphics";
26
- })(DefaultContentDisplayTypes || (DefaultContentDisplayTypes = {}));
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Content
7
+ */
8
+ /**
9
+ * Displayed content types. Affects how the content is formatted, e.g.
10
+ * the [[ContentFlags]].
11
+ *
12
+ * @public
13
+ */
14
+ export var DefaultContentDisplayTypes;
15
+ (function (DefaultContentDisplayTypes) {
16
+ /** Unknown content type. */
17
+ DefaultContentDisplayTypes["Undefined"] = "Undefined";
18
+ /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
19
+ DefaultContentDisplayTypes["Grid"] = "Grid";
20
+ /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
21
+ DefaultContentDisplayTypes["PropertyPane"] = "PropertyPane";
22
+ /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
23
+ DefaultContentDisplayTypes["List"] = "List";
24
+ /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
25
+ DefaultContentDisplayTypes["Viewport"] = "Graphics";
26
+ })(DefaultContentDisplayTypes || (DefaultContentDisplayTypes = {}));
27
27
  //# sourceMappingURL=DisplayTypes.js.map
@@ -1,16 +1,16 @@
1
- /** @packageDocumentation
2
- * @module Content
3
- */
4
- /**
5
- * A data structure which describes property editor used
6
- * for a content [[Field]].
7
- *
8
- * @public
9
- */
10
- export interface EditorDescription {
11
- /** Unique name */
12
- name: string;
13
- /** Editor-specific parameters */
14
- params?: any;
15
- }
1
+ /** @packageDocumentation
2
+ * @module Content
3
+ */
4
+ /**
5
+ * A data structure which describes property editor used
6
+ * for a content [[Field]].
7
+ *
8
+ * @public
9
+ */
10
+ export interface EditorDescription {
11
+ /** Unique name */
12
+ name: string;
13
+ /** Editor-specific parameters */
14
+ params?: any;
15
+ }
16
16
  //# sourceMappingURL=Editor.d.ts.map
@@ -1,9 +1,9 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Content
7
- */
8
- export {};
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Content
7
+ */
8
+ export {};
9
9
  //# sourceMappingURL=Editor.js.map