@itwin/presentation-common 3.5.0-dev.4 → 3.5.0-dev.43

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 (468) hide show
  1. package/CHANGELOG.md +41 -1
  2. package/lib/cjs/assets/locales/en/BisCore.json +18 -18
  3. package/lib/cjs/assets/locales/en/ECPresentation.json +9 -9
  4. package/lib/cjs/assets/locales/en/RulesEngine.json +5 -5
  5. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  6. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  7. package/lib/cjs/presentation-common/AsyncTasks.js.map +1 -1
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  9. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  10. package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -1
  11. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  12. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  13. package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
  14. package/lib/cjs/presentation-common/EC.d.ts +315 -315
  15. package/lib/cjs/presentation-common/EC.js +270 -270
  16. package/lib/cjs/presentation-common/EC.js.map +1 -1
  17. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  18. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  19. package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
  20. package/lib/cjs/presentation-common/Error.d.ts +45 -45
  21. package/lib/cjs/presentation-common/Error.js +62 -62
  22. package/lib/cjs/presentation-common/Error.js.map +1 -1
  23. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +61 -0
  24. package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -0
  25. package/lib/cjs/presentation-common/InstanceFilterDefinition.js +10 -0
  26. package/lib/cjs/presentation-common/InstanceFilterDefinition.js.map +1 -0
  27. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  28. package/lib/cjs/presentation-common/KeySet.js +418 -418
  29. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  30. package/lib/cjs/presentation-common/LabelDefinition.d.ts +79 -79
  31. package/lib/cjs/presentation-common/LabelDefinition.js +76 -76
  32. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  33. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  34. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  35. package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
  36. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +37 -37
  37. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  38. package/lib/cjs/presentation-common/PresentationIpcInterface.js.map +1 -1
  39. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +242 -242
  40. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  41. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  42. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +181 -181
  43. package/lib/cjs/presentation-common/PresentationRpcInterface.js +102 -102
  44. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  45. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  46. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  47. package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
  48. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  49. package/lib/cjs/presentation-common/RpcRequestsHandler.js +155 -155
  50. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  51. package/lib/cjs/presentation-common/RulesetVariables.d.ts +166 -166
  52. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  53. package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
  54. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  55. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  56. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  57. package/lib/cjs/presentation-common/Update.d.ts +194 -194
  58. package/lib/cjs/presentation-common/Update.js +196 -196
  59. package/lib/cjs/presentation-common/Update.js.map +1 -1
  60. package/lib/cjs/presentation-common/Utils.d.ts +64 -64
  61. package/lib/cjs/presentation-common/Utils.js +45 -45
  62. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  63. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  64. package/lib/cjs/presentation-common/content/Category.js +49 -49
  65. package/lib/cjs/presentation-common/content/Category.js.map +1 -1
  66. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  67. package/lib/cjs/presentation-common/content/Content.js +56 -56
  68. package/lib/cjs/presentation-common/content/Content.js.map +1 -1
  69. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +101 -101
  70. package/lib/cjs/presentation-common/content/ContentTraverser.js +420 -420
  71. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  72. package/lib/cjs/presentation-common/content/Descriptor.d.ts +240 -240
  73. package/lib/cjs/presentation-common/content/Descriptor.js +189 -189
  74. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  75. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  76. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  77. package/lib/cjs/presentation-common/content/DisplayTypes.js.map +1 -1
  78. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  79. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  80. package/lib/cjs/presentation-common/content/Editor.js.map +1 -1
  81. package/lib/cjs/presentation-common/content/Fields.d.ts +282 -282
  82. package/lib/cjs/presentation-common/content/Fields.js +394 -394
  83. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  84. package/lib/cjs/presentation-common/content/Item.d.ts +87 -87
  85. package/lib/cjs/presentation-common/content/Item.js +86 -86
  86. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  87. package/lib/cjs/presentation-common/content/Property.d.ts +51 -51
  88. package/lib/cjs/presentation-common/content/Property.js +36 -36
  89. package/lib/cjs/presentation-common/content/Property.js.map +1 -1
  90. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  91. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  92. package/lib/cjs/presentation-common/content/Renderer.js.map +1 -1
  93. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  94. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  95. package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
  96. package/lib/cjs/presentation-common/content/Value.d.ts +157 -157
  97. package/lib/cjs/presentation-common/content/Value.js +217 -217
  98. package/lib/cjs/presentation-common/content/Value.js.map +1 -1
  99. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +185 -185
  100. package/lib/cjs/presentation-common/hierarchy/Key.js +112 -112
  101. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  102. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +141 -141
  103. package/lib/cjs/presentation-common/hierarchy/Node.js +97 -97
  104. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  105. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  106. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +98 -98
  107. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  108. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  109. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  110. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  111. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  112. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  113. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  114. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  115. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  116. package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
  117. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  118. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  119. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  120. package/lib/cjs/presentation-common/rules/Rule.d.ts +74 -74
  121. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  122. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  123. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +66 -66
  124. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  125. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  126. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  127. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  128. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  129. package/lib/cjs/presentation-common/rules/Variables.d.ts +55 -55
  130. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  131. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  132. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  133. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  134. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  135. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  136. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  137. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  138. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  139. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  140. package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
  141. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  142. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  143. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  144. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  145. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  146. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  147. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  148. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  149. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  150. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  151. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  152. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  153. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  154. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  155. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  156. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  157. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  158. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  159. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  160. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  161. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  162. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  163. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  164. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  165. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  166. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  167. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  168. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  169. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  170. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  171. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  172. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  173. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  174. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  175. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  176. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  177. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  178. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  179. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  180. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  181. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  182. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  183. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  184. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  185. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  186. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  187. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  188. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  189. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  190. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  191. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  192. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  193. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  194. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  195. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  196. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  197. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  198. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  199. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  200. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  201. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  202. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +22 -22
  203. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  204. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  205. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  206. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  207. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  208. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  209. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  210. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  211. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  212. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  213. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  214. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  215. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  216. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  217. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  218. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  219. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  220. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  221. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  222. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  223. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  224. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  225. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  226. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  227. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  228. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +25 -25
  229. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  230. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  231. package/lib/cjs/presentation-common.d.ts +111 -110
  232. package/lib/cjs/presentation-common.d.ts.map +1 -1
  233. package/lib/cjs/presentation-common.js +127 -126
  234. package/lib/cjs/presentation-common.js.map +1 -1
  235. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  236. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  237. package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
  238. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  239. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  240. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
  241. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  242. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  243. package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
  244. package/lib/esm/presentation-common/EC.d.ts +315 -315
  245. package/lib/esm/presentation-common/EC.js +267 -267
  246. package/lib/esm/presentation-common/EC.js.map +1 -1
  247. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  248. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  249. package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
  250. package/lib/esm/presentation-common/Error.d.ts +45 -45
  251. package/lib/esm/presentation-common/Error.js +58 -58
  252. package/lib/esm/presentation-common/Error.js.map +1 -1
  253. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +61 -0
  254. package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -0
  255. package/lib/esm/presentation-common/InstanceFilterDefinition.js +9 -0
  256. package/lib/esm/presentation-common/InstanceFilterDefinition.js.map +1 -0
  257. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  258. package/lib/esm/presentation-common/KeySet.js +414 -414
  259. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  260. package/lib/esm/presentation-common/LabelDefinition.d.ts +79 -79
  261. package/lib/esm/presentation-common/LabelDefinition.js +73 -73
  262. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  263. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  264. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  265. package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
  266. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +37 -37
  267. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  268. package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
  269. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +242 -242
  270. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  271. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  272. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +181 -181
  273. package/lib/esm/presentation-common/PresentationRpcInterface.js +98 -98
  274. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  275. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  276. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  277. package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
  278. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  279. package/lib/esm/presentation-common/RpcRequestsHandler.js +151 -151
  280. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  281. package/lib/esm/presentation-common/RulesetVariables.d.ts +166 -166
  282. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  283. package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
  284. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  285. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  286. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  287. package/lib/esm/presentation-common/Update.d.ts +194 -194
  288. package/lib/esm/presentation-common/Update.js +193 -193
  289. package/lib/esm/presentation-common/Update.js.map +1 -1
  290. package/lib/esm/presentation-common/Utils.d.ts +64 -64
  291. package/lib/esm/presentation-common/Utils.js +41 -41
  292. package/lib/esm/presentation-common/Utils.js.map +1 -1
  293. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  294. package/lib/esm/presentation-common/content/Category.js +46 -46
  295. package/lib/esm/presentation-common/content/Category.js.map +1 -1
  296. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  297. package/lib/esm/presentation-common/content/Content.js +52 -52
  298. package/lib/esm/presentation-common/content/Content.js.map +1 -1
  299. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +101 -101
  300. package/lib/esm/presentation-common/content/ContentTraverser.js +411 -411
  301. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  302. package/lib/esm/presentation-common/content/Descriptor.d.ts +240 -240
  303. package/lib/esm/presentation-common/content/Descriptor.js +185 -185
  304. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  305. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  306. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  307. package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
  308. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  309. package/lib/esm/presentation-common/content/Editor.js +8 -8
  310. package/lib/esm/presentation-common/content/Editor.js.map +1 -1
  311. package/lib/esm/presentation-common/content/Fields.d.ts +282 -282
  312. package/lib/esm/presentation-common/content/Fields.js +387 -387
  313. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  314. package/lib/esm/presentation-common/content/Item.d.ts +87 -87
  315. package/lib/esm/presentation-common/content/Item.js +82 -82
  316. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  317. package/lib/esm/presentation-common/content/Property.d.ts +51 -51
  318. package/lib/esm/presentation-common/content/Property.js +33 -33
  319. package/lib/esm/presentation-common/content/Property.js.map +1 -1
  320. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  321. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  322. package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
  323. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  324. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  325. package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
  326. package/lib/esm/presentation-common/content/Value.d.ts +157 -157
  327. package/lib/esm/presentation-common/content/Value.js +214 -214
  328. package/lib/esm/presentation-common/content/Value.js.map +1 -1
  329. package/lib/esm/presentation-common/hierarchy/Key.d.ts +185 -185
  330. package/lib/esm/presentation-common/hierarchy/Key.js +109 -109
  331. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  332. package/lib/esm/presentation-common/hierarchy/Node.d.ts +141 -141
  333. package/lib/esm/presentation-common/hierarchy/Node.js +94 -94
  334. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  335. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  336. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +95 -95
  337. package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  338. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  339. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  340. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  341. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  342. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  343. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  344. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  345. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  346. package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
  347. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  348. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  349. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  350. package/lib/esm/presentation-common/rules/Rule.d.ts +74 -74
  351. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  352. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  353. package/lib/esm/presentation-common/rules/Ruleset.d.ts +66 -66
  354. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  355. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  356. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  357. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  358. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  359. package/lib/esm/presentation-common/rules/Variables.d.ts +55 -55
  360. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  361. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  362. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  363. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  364. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  365. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  366. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  367. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  368. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  369. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  370. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  371. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  372. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  373. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  374. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  375. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  376. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  377. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  378. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  379. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  380. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  381. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  382. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  383. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  384. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  385. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  386. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  387. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  388. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  389. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  390. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  391. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  392. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  393. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  394. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  395. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  396. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  397. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  398. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  399. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  400. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  401. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  402. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  403. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  404. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  405. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  406. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  407. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  408. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  409. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  410. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  411. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  412. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  413. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  414. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  415. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  416. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  417. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  418. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  419. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  420. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  421. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  422. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  423. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  424. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  425. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  426. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  427. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  428. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  429. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  430. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  431. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  432. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +19 -19
  433. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  434. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  435. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  436. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  437. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  438. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  439. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  440. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  441. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  442. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  443. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  444. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  445. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  446. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  447. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  448. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  449. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  450. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  451. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  452. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  453. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  454. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  455. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  456. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  457. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  458. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +25 -25
  459. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  460. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  461. package/lib/esm/presentation-common.d.ts +111 -110
  462. package/lib/esm/presentation-common.d.ts.map +1 -1
  463. package/lib/esm/presentation-common.js +115 -114
  464. package/lib/esm/presentation-common.js.map +1 -1
  465. package/lib/public/locales/en/BisCore.json +18 -18
  466. package/lib/public/locales/en/ECPresentation.json +9 -9
  467. package/lib/public/locales/en/RulesEngine.json +5 -5
  468. package/package.json +9 -9
@@ -1,316 +1,316 @@
1
- /** @packageDocumentation
2
- * @module Core
3
- */
4
- import { Id64String } from "@itwin/core-bentley";
5
- import { FormatProps } from "@itwin/core-quantity";
6
- import { PartialBy } from "./Utils";
7
- /**
8
- * Type of an ECClass ID.
9
- * @public
10
- */
11
- export declare type ClassId = Id64String;
12
- /**
13
- * Type of an ECInstance ID.
14
- * @public
15
- */
16
- export declare type InstanceId = Id64String;
17
- /**
18
- * A key that uniquely identifies an instance in an iModel
19
- * @public
20
- */
21
- export interface InstanceKey {
22
- /** Full class name in format `SchemaName:ClassName` */
23
- className: string;
24
- /** ECInstance ID */
25
- id: InstanceId;
26
- }
27
- /** @public */
28
- export declare namespace InstanceKey {
29
- /** Compare 2 instance keys */
30
- function compare(lhs: InstanceKey, rhs: InstanceKey): number;
31
- /** Serialize [[InstanceKey]] to JSON */
32
- function toJSON(json: InstanceKey): InstanceKeyJSON;
33
- /** Deserialize [[InstanceKey]] from JSON */
34
- function fromJSON(json: InstanceKeyJSON): {
35
- id: string;
36
- className: string;
37
- };
38
- }
39
- /**
40
- * A serialized version of [[InstanceKey]]
41
- * @public
42
- */
43
- export interface InstanceKeyJSON {
44
- className: string;
45
- id: string;
46
- }
47
- /**
48
- * Information about an ECClass
49
- * @public
50
- */
51
- export interface ClassInfo {
52
- /** ECClass ID */
53
- id: ClassId;
54
- /** Full class name in format `SchemaName:ClassName` */
55
- name: string;
56
- /** ECClass label */
57
- label: string;
58
- }
59
- /** @public */
60
- export declare namespace ClassInfo {
61
- /** Serialize [[ClassInfo]] to JSON */
62
- function toJSON(info: ClassInfo): ClassInfoJSON;
63
- /** Deserialize [[ClassInfo]] from JSON */
64
- function fromJSON(json: ClassInfoJSON): ClassInfo;
65
- }
66
- /**
67
- * A serialized version of [[ClassInfo]]
68
- * @public
69
- */
70
- export interface ClassInfoJSON {
71
- id: string;
72
- name: string;
73
- label: string;
74
- }
75
- /**
76
- * A serialized and compressed version of [[ClassInfo]]
77
- * @public
78
- */
79
- export interface CompressedClassInfoJSON {
80
- name: string;
81
- label: string;
82
- }
83
- /**
84
- * A single choice in enumeration
85
- * @public
86
- */
87
- export interface EnumerationChoice {
88
- /** Label of the choice */
89
- label: string;
90
- /** Value of the choice */
91
- value: string | number;
92
- }
93
- /**
94
- * Enumeration information
95
- * @public
96
- */
97
- export interface EnumerationInfo {
98
- /** Available enumeration choices */
99
- choices: EnumerationChoice[];
100
- /** Is the enumeration strict (values only allowed from `choices` list) */
101
- isStrict: boolean;
102
- }
103
- /**
104
- * Kind of quantity information
105
- * @public
106
- */
107
- export interface KindOfQuantityInfo {
108
- /** Full name of KindOfQuantity in format `SchemaName:KindOfQuantityName` */
109
- name: string;
110
- /** Label of KindOfQuantity */
111
- label: string;
112
- /**
113
- * Persistence unit identifier.
114
- * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
115
- */
116
- persistenceUnit: string;
117
- /**
118
- * Active format that was used to format property value.
119
- * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
120
- */
121
- activeFormat?: FormatProps;
122
- }
123
- /**
124
- * Navigation property information
125
- * @beta
126
- */
127
- export interface NavigationPropertyInfo {
128
- /** Information about ECProperty's relationship class */
129
- classInfo: ClassInfo;
130
- /** Is the direction of the relationship forward */
131
- isForwardRelationship: boolean;
132
- /** Information about ECProperty's target class */
133
- targetClassInfo: ClassInfo;
134
- /** Is ECProperty's target class polymorphic */
135
- isTargetPolymorphic: boolean;
136
- }
137
- /** @beta */
138
- export declare namespace NavigationPropertyInfo {
139
- /** Serialize [[NavigationPropertyInfo]] to JSON */
140
- function toJSON(info: NavigationPropertyInfo): NavigationPropertyInfoJSON;
141
- /** Serialize [[NavigationPropertyInfo]] to compressed JSON */
142
- function toCompressedJSON(navigationPropertyInfo: NavigationPropertyInfo, classesMap: {
143
- [id: string]: CompressedClassInfoJSON;
144
- }): NavigationPropertyInfoJSON<string>;
145
- /** Deserialize [[NavigationPropertyInfo]] from JSON */
146
- function fromJSON(json: NavigationPropertyInfo): NavigationPropertyInfo;
147
- /** Deserialize [[NavigationPropertyInfo]] from compressed JSON */
148
- function fromCompressedJSON(compressedNavigationPropertyInfoJSON: NavigationPropertyInfoJSON<string>, classesMap: {
149
- [id: string]: CompressedClassInfoJSON;
150
- }): NavigationPropertyInfo;
151
- }
152
- /**
153
- * A serialized version of [[NavigationPropertyInfo]]
154
- * @beta
155
- */
156
- export interface NavigationPropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
157
- classInfo: TClassInfoJSON;
158
- isForwardRelationship: boolean;
159
- targetClassInfo: TClassInfoJSON;
160
- isTargetPolymorphic: boolean;
161
- }
162
- /**
163
- * A structure that describes an ECProperty
164
- * @public
165
- */
166
- export interface PropertyInfo {
167
- /** Information about ECProperty class */
168
- classInfo: ClassInfo;
169
- /** Name of the ECProperty */
170
- name: string;
171
- /** Type name of the ECProperty */
172
- type: string;
173
- /** Enumeration info if the property is enumerable */
174
- enumerationInfo?: EnumerationInfo;
175
- /**
176
- * Kind of quantity information, if any.
177
- * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
178
- */
179
- kindOfQuantity?: KindOfQuantityInfo;
180
- /** Extended type name of the ECProperty if it has one */
181
- extendedType?: string;
182
- /**
183
- * Navigation property info if the field is navigation type
184
- * @beta
185
- */
186
- navigationPropertyInfo?: NavigationPropertyInfo;
187
- }
188
- /** @public */
189
- export declare namespace PropertyInfo {
190
- /** Serialize [[PropertyInfo]] to JSON */
191
- function toJSON(info: PropertyInfo): PropertyInfoJSON;
192
- /** Serialize [[PropertyInfo]] to compressed JSON */
193
- function toCompressedJSON(propertyInfo: PropertyInfo, classesMap: {
194
- [id: string]: CompressedClassInfoJSON;
195
- }): PropertyInfoJSON<string>;
196
- /** Deserialize [[PropertyInfo]] from JSON */
197
- function fromJSON(json: PropertyInfoJSON): PropertyInfo;
198
- }
199
- /**
200
- * A serialized version of [[PropertyInfo]]
201
- * @public
202
- */
203
- export interface PropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
204
- classInfo: TClassInfoJSON;
205
- name: string;
206
- type: string;
207
- enumerationInfo?: EnumerationInfo;
208
- kindOfQuantity?: KindOfQuantityInfo;
209
- /** @beta */
210
- navigationPropertyInfo?: NavigationPropertyInfoJSON<TClassInfoJSON>;
211
- }
212
- /**
213
- * A structure that describes a related class and the properties of that relationship.
214
- * @public
215
- */
216
- export interface RelatedClassInfo {
217
- /** Information about the source ECClass */
218
- sourceClassInfo: ClassInfo;
219
- /** Information about the target ECClass */
220
- targetClassInfo: ClassInfo;
221
- /** Is target class handled polymorphically */
222
- isPolymorphicTargetClass: boolean;
223
- /** Information about the ECRelationship */
224
- relationshipInfo: ClassInfo;
225
- /** Should relationship be followed in a forward direction to access the related class. */
226
- isForwardRelationship: boolean;
227
- /** Is relationship handled polymorphically */
228
- isPolymorphicRelationship: boolean;
229
- }
230
- /** @public */
231
- export declare namespace RelatedClassInfo {
232
- /** Serialize [[RelatedClassInfo]] to JSON */
233
- function toJSON(info: RelatedClassInfo): RelatedClassInfoJSON;
234
- /** Serialize [[RelatedClassInfo]] to compressed JSON */
235
- function toCompressedJSON(classInfo: RelatedClassInfo, classesMap: {
236
- [id: string]: CompressedClassInfoJSON;
237
- }): RelatedClassInfoJSON<string>;
238
- /** Deserialize [[RelatedClassInfo]] from JSON */
239
- function fromJSON(json: RelatedClassInfoJSON): RelatedClassInfo;
240
- /** Deserialize [[RelatedClassInfo]] from compressed JSON */
241
- function fromCompressedJSON(json: RelatedClassInfoJSON<string>, classesMap: {
242
- [id: string]: CompressedClassInfoJSON;
243
- }): RelatedClassInfo;
244
- /** Check two [[RelatedClassInfo]] or [[StrippedRelatedClassInfo]] for equality */
245
- function equals(lhs: RelatedClassInfo | StrippedRelatedClassInfo, rhs: RelatedClassInfo | StrippedRelatedClassInfo): boolean;
246
- /** Strip given [[RelatedClassInfo]] to [[StrippedRelatedClassInfo]] */
247
- function strip(full: RelatedClassInfo): StrippedRelatedClassInfo;
248
- }
249
- /**
250
- * A serialized version of [[RelatedClassInfo]]
251
- * @public
252
- */
253
- export interface RelatedClassInfoJSON<TClassInfoJSON = ClassInfoJSON> {
254
- sourceClassInfo: TClassInfoJSON;
255
- targetClassInfo: TClassInfoJSON;
256
- isPolymorphicTargetClass?: boolean;
257
- relationshipInfo: TClassInfoJSON;
258
- isForwardRelationship: boolean;
259
- isPolymorphicRelationship?: boolean;
260
- }
261
- /**
262
- * A structure that describes a relationship between source and target classes where
263
- * an actual ECRelationship between them is optional.
264
- * @public
265
- */
266
- export declare type RelatedClassInfoWithOptionalRelationship = PartialBy<RelatedClassInfo, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
267
- /** @public */
268
- export declare type RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON = ClassInfoJSON> = PartialBy<RelatedClassInfoJSON<TClassInfoJSON>, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
269
- /** @public */
270
- export declare namespace RelatedClassInfoWithOptionalRelationship {
271
- /** Serialize [[RelatedClassInfoWithOptionalRelationship]] to compressed JSON */
272
- function toCompressedJSON(classInfo: RelatedClassInfoWithOptionalRelationship, classesMap: {
273
- [id: string]: CompressedClassInfoJSON;
274
- }): RelatedClassInfoWithOptionalRelationshipJSON<string>;
275
- /** Deserialize [[RelatedClassInfoWithOptionalRelationship]] from compressed JSON */
276
- function fromCompressedJSON(json: RelatedClassInfoWithOptionalRelationshipJSON<string>, classesMap: {
277
- [id: string]: CompressedClassInfoJSON;
278
- }): RelatedClassInfoWithOptionalRelationship;
279
- }
280
- /**
281
- * A structure that describes a related class path.
282
- * @public
283
- */
284
- export declare type RelationshipPath = RelatedClassInfo[];
285
- /**
286
- * Serialized [[RelationshipPath]]
287
- * @public
288
- */
289
- export declare type RelationshipPathJSON<TClassInfoJSON = ClassInfoJSON> = RelatedClassInfoJSON<TClassInfoJSON>[];
290
- /** @public */
291
- export declare namespace RelationshipPath {
292
- /** Reverse direction of the given [[RelationshipPath]] */
293
- function reverse(path: RelationshipPath): RelationshipPath;
294
- /** Check two [[RelationshipPath]] or [[StrippedRelationshipPath]] for equality */
295
- function equals(lhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>, rhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>): boolean;
296
- /** Strip given [[RelationshipPath]] to [[StrippedRelationshipPath]] */
297
- function strip(full: RelationshipPath): StrippedRelationshipPath;
298
- }
299
- /**
300
- * Data structure that contains a subset of [[RelatedClassInfo]] required to
301
- * identify the relationship.
302
- * @public
303
- */
304
- export interface StrippedRelatedClassInfo {
305
- sourceClassName: string;
306
- targetClassName: string;
307
- relationshipName: string;
308
- isForwardRelationship: boolean;
309
- }
310
- /**
311
- * Data structure that contains a subset of [[RelationshipPath]] required to
312
- * identify the relationship path.
313
- * @public
314
- */
315
- export declare type StrippedRelationshipPath = StrippedRelatedClassInfo[];
1
+ /** @packageDocumentation
2
+ * @module Core
3
+ */
4
+ import { Id64String } from "@itwin/core-bentley";
5
+ import { FormatProps } from "@itwin/core-quantity";
6
+ import { PartialBy } from "./Utils";
7
+ /**
8
+ * Type of an ECClass ID.
9
+ * @public
10
+ */
11
+ export declare type ClassId = Id64String;
12
+ /**
13
+ * Type of an ECInstance ID.
14
+ * @public
15
+ */
16
+ export declare type InstanceId = Id64String;
17
+ /**
18
+ * A key that uniquely identifies an instance in an iModel
19
+ * @public
20
+ */
21
+ export interface InstanceKey {
22
+ /** Full class name in format `SchemaName:ClassName` */
23
+ className: string;
24
+ /** ECInstance ID */
25
+ id: InstanceId;
26
+ }
27
+ /** @public */
28
+ export declare namespace InstanceKey {
29
+ /** Compare 2 instance keys */
30
+ function compare(lhs: InstanceKey, rhs: InstanceKey): number;
31
+ /** Serialize [[InstanceKey]] to JSON */
32
+ function toJSON(json: InstanceKey): InstanceKeyJSON;
33
+ /** Deserialize [[InstanceKey]] from JSON */
34
+ function fromJSON(json: InstanceKeyJSON): {
35
+ id: string;
36
+ className: string;
37
+ };
38
+ }
39
+ /**
40
+ * A serialized version of [[InstanceKey]]
41
+ * @public
42
+ */
43
+ export interface InstanceKeyJSON {
44
+ className: string;
45
+ id: string;
46
+ }
47
+ /**
48
+ * Information about an ECClass
49
+ * @public
50
+ */
51
+ export interface ClassInfo {
52
+ /** ECClass ID */
53
+ id: ClassId;
54
+ /** Full class name in format `SchemaName:ClassName` */
55
+ name: string;
56
+ /** ECClass label */
57
+ label: string;
58
+ }
59
+ /** @public */
60
+ export declare namespace ClassInfo {
61
+ /** Serialize [[ClassInfo]] to JSON */
62
+ function toJSON(info: ClassInfo): ClassInfoJSON;
63
+ /** Deserialize [[ClassInfo]] from JSON */
64
+ function fromJSON(json: ClassInfoJSON): ClassInfo;
65
+ }
66
+ /**
67
+ * A serialized version of [[ClassInfo]]
68
+ * @public
69
+ */
70
+ export interface ClassInfoJSON {
71
+ id: string;
72
+ name: string;
73
+ label: string;
74
+ }
75
+ /**
76
+ * A serialized and compressed version of [[ClassInfo]]
77
+ * @public
78
+ */
79
+ export interface CompressedClassInfoJSON {
80
+ name: string;
81
+ label: string;
82
+ }
83
+ /**
84
+ * A single choice in enumeration
85
+ * @public
86
+ */
87
+ export interface EnumerationChoice {
88
+ /** Label of the choice */
89
+ label: string;
90
+ /** Value of the choice */
91
+ value: string | number;
92
+ }
93
+ /**
94
+ * Enumeration information
95
+ * @public
96
+ */
97
+ export interface EnumerationInfo {
98
+ /** Available enumeration choices */
99
+ choices: EnumerationChoice[];
100
+ /** Is the enumeration strict (values only allowed from `choices` list) */
101
+ isStrict: boolean;
102
+ }
103
+ /**
104
+ * Kind of quantity information
105
+ * @public
106
+ */
107
+ export interface KindOfQuantityInfo {
108
+ /** Full name of KindOfQuantity in format `SchemaName:KindOfQuantityName` */
109
+ name: string;
110
+ /** Label of KindOfQuantity */
111
+ label: string;
112
+ /**
113
+ * Persistence unit identifier.
114
+ * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
115
+ */
116
+ persistenceUnit: string;
117
+ /**
118
+ * Active format that was used to format property value.
119
+ * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
120
+ */
121
+ activeFormat?: FormatProps;
122
+ }
123
+ /**
124
+ * Navigation property information
125
+ * @beta
126
+ */
127
+ export interface NavigationPropertyInfo {
128
+ /** Information about ECProperty's relationship class */
129
+ classInfo: ClassInfo;
130
+ /** Is the direction of the relationship forward */
131
+ isForwardRelationship: boolean;
132
+ /** Information about ECProperty's target class */
133
+ targetClassInfo: ClassInfo;
134
+ /** Is ECProperty's target class polymorphic */
135
+ isTargetPolymorphic: boolean;
136
+ }
137
+ /** @beta */
138
+ export declare namespace NavigationPropertyInfo {
139
+ /** Serialize [[NavigationPropertyInfo]] to JSON */
140
+ function toJSON(info: NavigationPropertyInfo): NavigationPropertyInfoJSON;
141
+ /** Serialize [[NavigationPropertyInfo]] to compressed JSON */
142
+ function toCompressedJSON(navigationPropertyInfo: NavigationPropertyInfo, classesMap: {
143
+ [id: string]: CompressedClassInfoJSON;
144
+ }): NavigationPropertyInfoJSON<string>;
145
+ /** Deserialize [[NavigationPropertyInfo]] from JSON */
146
+ function fromJSON(json: NavigationPropertyInfo): NavigationPropertyInfo;
147
+ /** Deserialize [[NavigationPropertyInfo]] from compressed JSON */
148
+ function fromCompressedJSON(compressedNavigationPropertyInfoJSON: NavigationPropertyInfoJSON<string>, classesMap: {
149
+ [id: string]: CompressedClassInfoJSON;
150
+ }): NavigationPropertyInfo;
151
+ }
152
+ /**
153
+ * A serialized version of [[NavigationPropertyInfo]]
154
+ * @beta
155
+ */
156
+ export interface NavigationPropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
157
+ classInfo: TClassInfoJSON;
158
+ isForwardRelationship: boolean;
159
+ targetClassInfo: TClassInfoJSON;
160
+ isTargetPolymorphic: boolean;
161
+ }
162
+ /**
163
+ * A structure that describes an ECProperty
164
+ * @public
165
+ */
166
+ export interface PropertyInfo {
167
+ /** Information about ECProperty class */
168
+ classInfo: ClassInfo;
169
+ /** Name of the ECProperty */
170
+ name: string;
171
+ /** Type name of the ECProperty */
172
+ type: string;
173
+ /** Enumeration info if the property is enumerable */
174
+ enumerationInfo?: EnumerationInfo;
175
+ /**
176
+ * Kind of quantity information, if any.
177
+ * @alpha Still not entirely clear how kind of quantities will be handled and what data we'll need
178
+ */
179
+ kindOfQuantity?: KindOfQuantityInfo;
180
+ /** Extended type name of the ECProperty if it has one */
181
+ extendedType?: string;
182
+ /**
183
+ * Navigation property info if the field is navigation type
184
+ * @beta
185
+ */
186
+ navigationPropertyInfo?: NavigationPropertyInfo;
187
+ }
188
+ /** @public */
189
+ export declare namespace PropertyInfo {
190
+ /** Serialize [[PropertyInfo]] to JSON */
191
+ function toJSON(info: PropertyInfo): PropertyInfoJSON;
192
+ /** Serialize [[PropertyInfo]] to compressed JSON */
193
+ function toCompressedJSON(propertyInfo: PropertyInfo, classesMap: {
194
+ [id: string]: CompressedClassInfoJSON;
195
+ }): PropertyInfoJSON<string>;
196
+ /** Deserialize [[PropertyInfo]] from JSON */
197
+ function fromJSON(json: PropertyInfoJSON): PropertyInfo;
198
+ }
199
+ /**
200
+ * A serialized version of [[PropertyInfo]]
201
+ * @public
202
+ */
203
+ export interface PropertyInfoJSON<TClassInfoJSON = ClassInfoJSON> {
204
+ classInfo: TClassInfoJSON;
205
+ name: string;
206
+ type: string;
207
+ enumerationInfo?: EnumerationInfo;
208
+ kindOfQuantity?: KindOfQuantityInfo;
209
+ /** @beta */
210
+ navigationPropertyInfo?: NavigationPropertyInfoJSON<TClassInfoJSON>;
211
+ }
212
+ /**
213
+ * A structure that describes a related class and the properties of that relationship.
214
+ * @public
215
+ */
216
+ export interface RelatedClassInfo {
217
+ /** Information about the source ECClass */
218
+ sourceClassInfo: ClassInfo;
219
+ /** Information about the target ECClass */
220
+ targetClassInfo: ClassInfo;
221
+ /** Is target class handled polymorphically */
222
+ isPolymorphicTargetClass: boolean;
223
+ /** Information about the ECRelationship */
224
+ relationshipInfo: ClassInfo;
225
+ /** Should relationship be followed in a forward direction to access the related class. */
226
+ isForwardRelationship: boolean;
227
+ /** Is relationship handled polymorphically */
228
+ isPolymorphicRelationship: boolean;
229
+ }
230
+ /** @public */
231
+ export declare namespace RelatedClassInfo {
232
+ /** Serialize [[RelatedClassInfo]] to JSON */
233
+ function toJSON(info: RelatedClassInfo): RelatedClassInfoJSON;
234
+ /** Serialize [[RelatedClassInfo]] to compressed JSON */
235
+ function toCompressedJSON(classInfo: RelatedClassInfo, classesMap: {
236
+ [id: string]: CompressedClassInfoJSON;
237
+ }): RelatedClassInfoJSON<string>;
238
+ /** Deserialize [[RelatedClassInfo]] from JSON */
239
+ function fromJSON(json: RelatedClassInfoJSON): RelatedClassInfo;
240
+ /** Deserialize [[RelatedClassInfo]] from compressed JSON */
241
+ function fromCompressedJSON(json: RelatedClassInfoJSON<string>, classesMap: {
242
+ [id: string]: CompressedClassInfoJSON;
243
+ }): RelatedClassInfo;
244
+ /** Check two [[RelatedClassInfo]] or [[StrippedRelatedClassInfo]] for equality */
245
+ function equals(lhs: RelatedClassInfo | StrippedRelatedClassInfo, rhs: RelatedClassInfo | StrippedRelatedClassInfo): boolean;
246
+ /** Strip given [[RelatedClassInfo]] to [[StrippedRelatedClassInfo]] */
247
+ function strip(full: RelatedClassInfo): StrippedRelatedClassInfo;
248
+ }
249
+ /**
250
+ * A serialized version of [[RelatedClassInfo]]
251
+ * @public
252
+ */
253
+ export interface RelatedClassInfoJSON<TClassInfoJSON = ClassInfoJSON> {
254
+ sourceClassInfo: TClassInfoJSON;
255
+ targetClassInfo: TClassInfoJSON;
256
+ isPolymorphicTargetClass?: boolean;
257
+ relationshipInfo: TClassInfoJSON;
258
+ isForwardRelationship: boolean;
259
+ isPolymorphicRelationship?: boolean;
260
+ }
261
+ /**
262
+ * A structure that describes a relationship between source and target classes where
263
+ * an actual ECRelationship between them is optional.
264
+ * @public
265
+ */
266
+ export declare type RelatedClassInfoWithOptionalRelationship = PartialBy<RelatedClassInfo, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
267
+ /** @public */
268
+ export declare type RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON = ClassInfoJSON> = PartialBy<RelatedClassInfoJSON<TClassInfoJSON>, "relationshipInfo" | "isForwardRelationship" | "isPolymorphicRelationship">;
269
+ /** @public */
270
+ export declare namespace RelatedClassInfoWithOptionalRelationship {
271
+ /** Serialize [[RelatedClassInfoWithOptionalRelationship]] to compressed JSON */
272
+ function toCompressedJSON(classInfo: RelatedClassInfoWithOptionalRelationship, classesMap: {
273
+ [id: string]: CompressedClassInfoJSON;
274
+ }): RelatedClassInfoWithOptionalRelationshipJSON<string>;
275
+ /** Deserialize [[RelatedClassInfoWithOptionalRelationship]] from compressed JSON */
276
+ function fromCompressedJSON(json: RelatedClassInfoWithOptionalRelationshipJSON<string>, classesMap: {
277
+ [id: string]: CompressedClassInfoJSON;
278
+ }): RelatedClassInfoWithOptionalRelationship;
279
+ }
280
+ /**
281
+ * A structure that describes a related class path.
282
+ * @public
283
+ */
284
+ export declare type RelationshipPath = RelatedClassInfo[];
285
+ /**
286
+ * Serialized [[RelationshipPath]]
287
+ * @public
288
+ */
289
+ export declare type RelationshipPathJSON<TClassInfoJSON = ClassInfoJSON> = RelatedClassInfoJSON<TClassInfoJSON>[];
290
+ /** @public */
291
+ export declare namespace RelationshipPath {
292
+ /** Reverse direction of the given [[RelationshipPath]] */
293
+ function reverse(path: RelationshipPath): RelationshipPath;
294
+ /** Check two [[RelationshipPath]] or [[StrippedRelationshipPath]] for equality */
295
+ function equals(lhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>, rhs: Array<RelatedClassInfo | StrippedRelatedClassInfo>): boolean;
296
+ /** Strip given [[RelationshipPath]] to [[StrippedRelationshipPath]] */
297
+ function strip(full: RelationshipPath): StrippedRelationshipPath;
298
+ }
299
+ /**
300
+ * Data structure that contains a subset of [[RelatedClassInfo]] required to
301
+ * identify the relationship.
302
+ * @public
303
+ */
304
+ export interface StrippedRelatedClassInfo {
305
+ sourceClassName: string;
306
+ targetClassName: string;
307
+ relationshipName: string;
308
+ isForwardRelationship: boolean;
309
+ }
310
+ /**
311
+ * Data structure that contains a subset of [[RelationshipPath]] required to
312
+ * identify the relationship path.
313
+ * @public
314
+ */
315
+ export declare type StrippedRelationshipPath = StrippedRelatedClassInfo[];
316
316
  //# sourceMappingURL=EC.d.ts.map