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

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 (457) hide show
  1. package/lib/cjs/assets/locales/en/BisCore.json +18 -18
  2. package/lib/cjs/assets/locales/en/ECPresentation.json +9 -9
  3. package/lib/cjs/assets/locales/en/RulesEngine.json +5 -5
  4. package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
  5. package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
  6. package/lib/cjs/presentation-common/AsyncTasks.js.map +1 -1
  7. package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
  8. package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
  9. package/lib/cjs/presentation-common/CommonLoggerCategory.js.map +1 -1
  10. package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
  11. package/lib/cjs/presentation-common/Diagnostics.js +72 -72
  12. package/lib/cjs/presentation-common/Diagnostics.js.map +1 -1
  13. package/lib/cjs/presentation-common/EC.d.ts +315 -315
  14. package/lib/cjs/presentation-common/EC.js +270 -270
  15. package/lib/cjs/presentation-common/EC.js.map +1 -1
  16. package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
  17. package/lib/cjs/presentation-common/ElementProperties.js +9 -9
  18. package/lib/cjs/presentation-common/ElementProperties.js.map +1 -1
  19. package/lib/cjs/presentation-common/Error.d.ts +45 -45
  20. package/lib/cjs/presentation-common/Error.js +62 -62
  21. package/lib/cjs/presentation-common/Error.js.map +1 -1
  22. package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
  23. package/lib/cjs/presentation-common/KeySet.js +418 -418
  24. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  25. package/lib/cjs/presentation-common/LabelDefinition.d.ts +79 -79
  26. package/lib/cjs/presentation-common/LabelDefinition.js +76 -76
  27. package/lib/cjs/presentation-common/LabelDefinition.js.map +1 -1
  28. package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
  29. package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
  30. package/lib/cjs/presentation-common/LocalizationHelper.js.map +1 -1
  31. package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +37 -37
  32. package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
  33. package/lib/cjs/presentation-common/PresentationIpcInterface.js.map +1 -1
  34. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +242 -242
  35. package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
  36. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  37. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +181 -181
  38. package/lib/cjs/presentation-common/PresentationRpcInterface.js +102 -102
  39. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  40. package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
  41. package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
  42. package/lib/cjs/presentation-common/RegisteredRuleset.js.map +1 -1
  43. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
  44. package/lib/cjs/presentation-common/RpcRequestsHandler.js +155 -155
  45. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  46. package/lib/cjs/presentation-common/RulesetVariables.d.ts +166 -166
  47. package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
  48. package/lib/cjs/presentation-common/RulesetVariables.js.map +1 -1
  49. package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
  50. package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
  51. package/lib/cjs/presentation-common/RulesetsFactory.js.map +1 -1
  52. package/lib/cjs/presentation-common/Update.d.ts +194 -194
  53. package/lib/cjs/presentation-common/Update.js +196 -196
  54. package/lib/cjs/presentation-common/Update.js.map +1 -1
  55. package/lib/cjs/presentation-common/Utils.d.ts +64 -64
  56. package/lib/cjs/presentation-common/Utils.js +45 -45
  57. package/lib/cjs/presentation-common/Utils.js.map +1 -1
  58. package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
  59. package/lib/cjs/presentation-common/content/Category.js +49 -49
  60. package/lib/cjs/presentation-common/content/Category.js.map +1 -1
  61. package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
  62. package/lib/cjs/presentation-common/content/Content.js +56 -56
  63. package/lib/cjs/presentation-common/content/Content.js.map +1 -1
  64. package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +101 -101
  65. package/lib/cjs/presentation-common/content/ContentTraverser.js +420 -420
  66. package/lib/cjs/presentation-common/content/ContentTraverser.js.map +1 -1
  67. package/lib/cjs/presentation-common/content/Descriptor.d.ts +240 -240
  68. package/lib/cjs/presentation-common/content/Descriptor.js +189 -189
  69. package/lib/cjs/presentation-common/content/Descriptor.js.map +1 -1
  70. package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
  71. package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
  72. package/lib/cjs/presentation-common/content/DisplayTypes.js.map +1 -1
  73. package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
  74. package/lib/cjs/presentation-common/content/Editor.js +9 -9
  75. package/lib/cjs/presentation-common/content/Editor.js.map +1 -1
  76. package/lib/cjs/presentation-common/content/Fields.d.ts +282 -282
  77. package/lib/cjs/presentation-common/content/Fields.js +394 -394
  78. package/lib/cjs/presentation-common/content/Fields.js.map +1 -1
  79. package/lib/cjs/presentation-common/content/Item.d.ts +87 -87
  80. package/lib/cjs/presentation-common/content/Item.js +86 -86
  81. package/lib/cjs/presentation-common/content/Item.js.map +1 -1
  82. package/lib/cjs/presentation-common/content/Property.d.ts +51 -51
  83. package/lib/cjs/presentation-common/content/Property.js +36 -36
  84. package/lib/cjs/presentation-common/content/Property.js.map +1 -1
  85. package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
  86. package/lib/cjs/presentation-common/content/Renderer.js +9 -9
  87. package/lib/cjs/presentation-common/content/Renderer.js.map +1 -1
  88. package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
  89. package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
  90. package/lib/cjs/presentation-common/content/TypeDescription.js.map +1 -1
  91. package/lib/cjs/presentation-common/content/Value.d.ts +157 -157
  92. package/lib/cjs/presentation-common/content/Value.js +217 -217
  93. package/lib/cjs/presentation-common/content/Value.js.map +1 -1
  94. package/lib/cjs/presentation-common/hierarchy/Key.d.ts +185 -185
  95. package/lib/cjs/presentation-common/hierarchy/Key.js +112 -112
  96. package/lib/cjs/presentation-common/hierarchy/Key.js.map +1 -1
  97. package/lib/cjs/presentation-common/hierarchy/Node.d.ts +141 -141
  98. package/lib/cjs/presentation-common/hierarchy/Node.js +97 -97
  99. package/lib/cjs/presentation-common/hierarchy/Node.js.map +1 -1
  100. package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  101. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +98 -98
  102. package/lib/cjs/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  103. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  104. package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
  105. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  106. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  107. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
  108. package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  109. package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  110. package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
  111. package/lib/cjs/presentation-common/rules/RelationshipDirection.js.map +1 -1
  112. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  113. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
  114. package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  115. package/lib/cjs/presentation-common/rules/Rule.d.ts +74 -74
  116. package/lib/cjs/presentation-common/rules/Rule.js +35 -35
  117. package/lib/cjs/presentation-common/rules/Rule.js.map +1 -1
  118. package/lib/cjs/presentation-common/rules/Ruleset.d.ts +66 -66
  119. package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
  120. package/lib/cjs/presentation-common/rules/Ruleset.js.map +1 -1
  121. package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  122. package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
  123. package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map +1 -1
  124. package/lib/cjs/presentation-common/rules/Variables.d.ts +55 -55
  125. package/lib/cjs/presentation-common/rules/Variables.js +25 -25
  126. package/lib/cjs/presentation-common/rules/Variables.js.map +1 -1
  127. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  128. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
  129. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  130. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  131. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
  132. package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  133. package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
  134. package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
  135. package/lib/cjs/presentation-common/rules/content/ContentRule.js.map +1 -1
  136. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  137. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
  138. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  139. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  140. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
  141. package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  142. package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  143. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
  144. package/lib/cjs/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  145. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  146. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
  147. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  148. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  149. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
  150. package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  151. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  152. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
  153. package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  154. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  155. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
  156. package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  157. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  158. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
  159. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  160. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  161. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
  162. package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  163. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  164. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
  165. package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  166. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  167. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
  168. package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  169. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  170. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
  171. package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  172. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  173. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
  174. package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  175. package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  176. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
  177. package/lib/cjs/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  178. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  179. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
  180. package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  181. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  182. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
  183. package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  184. package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  185. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
  186. package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  187. package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  188. package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
  189. package/lib/cjs/presentation-common/rules/customization/SortingRule.js.map +1 -1
  190. package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  191. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
  192. package/lib/cjs/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  193. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  194. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
  195. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  196. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  197. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +22 -22
  198. package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  199. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  200. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
  201. package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  202. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  203. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
  204. package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  205. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  206. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
  207. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  208. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  209. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
  210. package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  211. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  212. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
  213. package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  214. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  215. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
  216. package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  217. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  218. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
  219. package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  220. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  221. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
  222. package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  223. package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +25 -25
  224. package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
  225. package/lib/cjs/presentation-common/selection/SelectionScope.js.map +1 -1
  226. package/lib/cjs/presentation-common.d.ts +110 -110
  227. package/lib/cjs/presentation-common.js +126 -126
  228. package/lib/cjs/presentation-common.js.map +1 -1
  229. package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
  230. package/lib/esm/presentation-common/AsyncTasks.js +34 -34
  231. package/lib/esm/presentation-common/AsyncTasks.js.map +1 -1
  232. package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
  233. package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
  234. package/lib/esm/presentation-common/CommonLoggerCategory.js.map +1 -1
  235. package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
  236. package/lib/esm/presentation-common/Diagnostics.js +67 -67
  237. package/lib/esm/presentation-common/Diagnostics.js.map +1 -1
  238. package/lib/esm/presentation-common/EC.d.ts +315 -315
  239. package/lib/esm/presentation-common/EC.js +267 -267
  240. package/lib/esm/presentation-common/EC.js.map +1 -1
  241. package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
  242. package/lib/esm/presentation-common/ElementProperties.js +8 -8
  243. package/lib/esm/presentation-common/ElementProperties.js.map +1 -1
  244. package/lib/esm/presentation-common/Error.d.ts +45 -45
  245. package/lib/esm/presentation-common/Error.js +58 -58
  246. package/lib/esm/presentation-common/Error.js.map +1 -1
  247. package/lib/esm/presentation-common/KeySet.d.ts +146 -146
  248. package/lib/esm/presentation-common/KeySet.js +414 -414
  249. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  250. package/lib/esm/presentation-common/LabelDefinition.d.ts +79 -79
  251. package/lib/esm/presentation-common/LabelDefinition.js +73 -73
  252. package/lib/esm/presentation-common/LabelDefinition.js.map +1 -1
  253. package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
  254. package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
  255. package/lib/esm/presentation-common/LocalizationHelper.js.map +1 -1
  256. package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +37 -37
  257. package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
  258. package/lib/esm/presentation-common/PresentationIpcInterface.js.map +1 -1
  259. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +242 -242
  260. package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
  261. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  262. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +181 -181
  263. package/lib/esm/presentation-common/PresentationRpcInterface.js +98 -98
  264. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  265. package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
  266. package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
  267. package/lib/esm/presentation-common/RegisteredRuleset.js.map +1 -1
  268. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
  269. package/lib/esm/presentation-common/RpcRequestsHandler.js +151 -151
  270. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  271. package/lib/esm/presentation-common/RulesetVariables.d.ts +166 -166
  272. package/lib/esm/presentation-common/RulesetVariables.js +52 -52
  273. package/lib/esm/presentation-common/RulesetVariables.js.map +1 -1
  274. package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
  275. package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
  276. package/lib/esm/presentation-common/RulesetsFactory.js.map +1 -1
  277. package/lib/esm/presentation-common/Update.d.ts +194 -194
  278. package/lib/esm/presentation-common/Update.js +193 -193
  279. package/lib/esm/presentation-common/Update.js.map +1 -1
  280. package/lib/esm/presentation-common/Utils.d.ts +64 -64
  281. package/lib/esm/presentation-common/Utils.js +41 -41
  282. package/lib/esm/presentation-common/Utils.js.map +1 -1
  283. package/lib/esm/presentation-common/content/Category.d.ts +49 -49
  284. package/lib/esm/presentation-common/content/Category.js +46 -46
  285. package/lib/esm/presentation-common/content/Category.js.map +1 -1
  286. package/lib/esm/presentation-common/content/Content.d.ts +38 -38
  287. package/lib/esm/presentation-common/content/Content.js +52 -52
  288. package/lib/esm/presentation-common/content/Content.js.map +1 -1
  289. package/lib/esm/presentation-common/content/ContentTraverser.d.ts +101 -101
  290. package/lib/esm/presentation-common/content/ContentTraverser.js +411 -411
  291. package/lib/esm/presentation-common/content/ContentTraverser.js.map +1 -1
  292. package/lib/esm/presentation-common/content/Descriptor.d.ts +240 -240
  293. package/lib/esm/presentation-common/content/Descriptor.js +185 -185
  294. package/lib/esm/presentation-common/content/Descriptor.js.map +1 -1
  295. package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
  296. package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
  297. package/lib/esm/presentation-common/content/DisplayTypes.js.map +1 -1
  298. package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
  299. package/lib/esm/presentation-common/content/Editor.js +8 -8
  300. package/lib/esm/presentation-common/content/Editor.js.map +1 -1
  301. package/lib/esm/presentation-common/content/Fields.d.ts +282 -282
  302. package/lib/esm/presentation-common/content/Fields.js +387 -387
  303. package/lib/esm/presentation-common/content/Fields.js.map +1 -1
  304. package/lib/esm/presentation-common/content/Item.d.ts +87 -87
  305. package/lib/esm/presentation-common/content/Item.js +82 -82
  306. package/lib/esm/presentation-common/content/Item.js.map +1 -1
  307. package/lib/esm/presentation-common/content/Property.d.ts +51 -51
  308. package/lib/esm/presentation-common/content/Property.js +33 -33
  309. package/lib/esm/presentation-common/content/Property.js.map +1 -1
  310. package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
  311. package/lib/esm/presentation-common/content/Renderer.js +8 -8
  312. package/lib/esm/presentation-common/content/Renderer.js.map +1 -1
  313. package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
  314. package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
  315. package/lib/esm/presentation-common/content/TypeDescription.js.map +1 -1
  316. package/lib/esm/presentation-common/content/Value.d.ts +157 -157
  317. package/lib/esm/presentation-common/content/Value.js +214 -214
  318. package/lib/esm/presentation-common/content/Value.js.map +1 -1
  319. package/lib/esm/presentation-common/hierarchy/Key.d.ts +185 -185
  320. package/lib/esm/presentation-common/hierarchy/Key.js +109 -109
  321. package/lib/esm/presentation-common/hierarchy/Key.js.map +1 -1
  322. package/lib/esm/presentation-common/hierarchy/Node.d.ts +141 -141
  323. package/lib/esm/presentation-common/hierarchy/Node.js +94 -94
  324. package/lib/esm/presentation-common/hierarchy/Node.js.map +1 -1
  325. package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +85 -85
  326. package/lib/esm/presentation-common/hierarchy/NodePathElement.js +95 -95
  327. package/lib/esm/presentation-common/hierarchy/NodePathElement.js.map +1 -1
  328. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
  329. package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
  330. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  331. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
  332. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
  333. package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
  334. package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
  335. package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
  336. package/lib/esm/presentation-common/rules/RelationshipDirection.js.map +1 -1
  337. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +53 -53
  338. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
  339. package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
  340. package/lib/esm/presentation-common/rules/Rule.d.ts +74 -74
  341. package/lib/esm/presentation-common/rules/Rule.js +32 -32
  342. package/lib/esm/presentation-common/rules/Rule.js.map +1 -1
  343. package/lib/esm/presentation-common/rules/Ruleset.d.ts +66 -66
  344. package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
  345. package/lib/esm/presentation-common/rules/Ruleset.js.map +1 -1
  346. package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
  347. package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
  348. package/lib/esm/presentation-common/rules/SchemasSpecification.js.map +1 -1
  349. package/lib/esm/presentation-common/rules/Variables.d.ts +55 -55
  350. package/lib/esm/presentation-common/rules/Variables.js +22 -22
  351. package/lib/esm/presentation-common/rules/Variables.js.map +1 -1
  352. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
  353. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
  354. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  355. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
  356. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
  357. package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map +1 -1
  358. package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
  359. package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
  360. package/lib/esm/presentation-common/rules/content/ContentRule.js.map +1 -1
  361. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +55 -55
  362. package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
  363. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  364. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
  365. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
  366. package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js.map +1 -1
  367. package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
  368. package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
  369. package/lib/esm/presentation-common/rules/content/PropertySpecification.js.map +1 -1
  370. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
  371. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
  372. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  373. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
  374. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
  375. package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js.map +1 -1
  376. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
  377. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
  378. package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js.map +1 -1
  379. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
  380. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
  381. package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js.map +1 -1
  382. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
  383. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
  384. package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js.map +1 -1
  385. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +105 -105
  386. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
  387. package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js.map +1 -1
  388. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +93 -93
  389. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
  390. package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map +1 -1
  391. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
  392. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
  393. package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js.map +1 -1
  394. package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
  395. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
  396. package/lib/esm/presentation-common/rules/customization/CustomizationRule.js.map +1 -1
  397. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
  398. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
  399. package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js.map +1 -1
  400. package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +200 -200
  401. package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
  402. package/lib/esm/presentation-common/rules/customization/GroupingRule.js.map +1 -1
  403. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
  404. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
  405. package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js.map +1 -1
  406. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +156 -156
  407. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
  408. package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map +1 -1
  409. package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
  410. package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
  411. package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map +1 -1
  412. package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
  413. package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
  414. package/lib/esm/presentation-common/rules/customization/SortingRule.js.map +1 -1
  415. package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
  416. package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
  417. package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map +1 -1
  418. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +15 -15
  419. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
  420. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js.map +1 -1
  421. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +97 -97
  422. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +19 -19
  423. package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map +1 -1
  424. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
  425. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
  426. package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map +1 -1
  427. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +76 -76
  428. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
  429. package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map +1 -1
  430. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
  431. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
  432. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  433. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
  434. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
  435. package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js.map +1 -1
  436. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
  437. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
  438. package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js.map +1 -1
  439. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
  440. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
  441. package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js.map +1 -1
  442. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +17 -17
  443. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
  444. package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js.map +1 -1
  445. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +36 -36
  446. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
  447. package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js.map +1 -1
  448. package/lib/esm/presentation-common/selection/SelectionScope.d.ts +25 -25
  449. package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
  450. package/lib/esm/presentation-common/selection/SelectionScope.js.map +1 -1
  451. package/lib/esm/presentation-common.d.ts +110 -110
  452. package/lib/esm/presentation-common.js +114 -114
  453. package/lib/esm/presentation-common.js.map +1 -1
  454. package/lib/public/locales/en/BisCore.json +18 -18
  455. package/lib/public/locales/en/ECPresentation.json +9 -9
  456. package/lib/public/locales/en/RulesEngine.json +5 -5
  457. 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