@itwin/core-backend 3.5.0-dev.8 → 3.5.1

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 (279) hide show
  1. package/CHANGELOG.md +112 -1
  2. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  3. package/lib/cjs/AliCloudStorageService.js +71 -71
  4. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  5. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  6. package/lib/cjs/BackendHubAccess.js +41 -41
  7. package/lib/cjs/BackendHubAccess.js.map +1 -1
  8. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  9. package/lib/cjs/BackendLoggerCategory.js +99 -99
  10. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  11. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  12. package/lib/cjs/BisCoreSchema.js +60 -60
  13. package/lib/cjs/BisCoreSchema.js.map +1 -1
  14. package/lib/cjs/BriefcaseManager.d.ts +170 -165
  15. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  16. package/lib/cjs/BriefcaseManager.js +413 -405
  17. package/lib/cjs/BriefcaseManager.js.map +1 -1
  18. package/lib/cjs/Category.d.ts +153 -153
  19. package/lib/cjs/Category.js +243 -243
  20. package/lib/cjs/Category.js.map +1 -1
  21. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  22. package/lib/cjs/ChangeSummaryManager.d.ts.map +1 -1
  23. package/lib/cjs/ChangeSummaryManager.js +447 -445
  24. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  25. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  26. package/lib/cjs/ChangedElementsDb.js +165 -165
  27. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  28. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  29. package/lib/cjs/ChangedElementsManager.js +88 -88
  30. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  31. package/lib/cjs/CheckpointManager.d.ts +120 -120
  32. package/lib/cjs/CheckpointManager.js +343 -343
  33. package/lib/cjs/CheckpointManager.js.map +1 -1
  34. package/lib/cjs/ClassRegistry.d.ts +79 -71
  35. package/lib/cjs/ClassRegistry.d.ts.map +1 -1
  36. package/lib/cjs/ClassRegistry.js +249 -215
  37. package/lib/cjs/ClassRegistry.js.map +1 -1
  38. package/lib/cjs/CloudSqlite.d.ts +350 -349
  39. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  40. package/lib/cjs/CloudSqlite.js +152 -151
  41. package/lib/cjs/CloudSqlite.js.map +1 -1
  42. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  43. package/lib/cjs/CloudStorageBackend.js +173 -173
  44. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  45. package/lib/cjs/CodeService.d.ts +396 -396
  46. package/lib/cjs/CodeService.js +63 -63
  47. package/lib/cjs/CodeService.js.map +1 -1
  48. package/lib/cjs/CodeSpecs.d.ts +50 -50
  49. package/lib/cjs/CodeSpecs.js +112 -112
  50. package/lib/cjs/CodeSpecs.js.map +1 -1
  51. package/lib/cjs/ConcurrentQuery.d.ts +13 -11
  52. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  53. package/lib/cjs/ConcurrentQuery.js +36 -30
  54. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  55. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -32
  56. package/lib/cjs/CustomViewState3dCreator.d.ts.map +1 -1
  57. package/lib/cjs/CustomViewState3dCreator.js +81 -113
  58. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  59. package/lib/cjs/DevTools.d.ts +71 -71
  60. package/lib/cjs/DevTools.js +154 -154
  61. package/lib/cjs/DevTools.js.map +1 -1
  62. package/lib/cjs/DisplayStyle.d.ts +106 -106
  63. package/lib/cjs/DisplayStyle.d.ts.map +1 -1
  64. package/lib/cjs/DisplayStyle.js +256 -256
  65. package/lib/cjs/DisplayStyle.js.map +1 -1
  66. package/lib/cjs/ECDb.d.ts +191 -191
  67. package/lib/cjs/ECDb.js +350 -350
  68. package/lib/cjs/ECDb.js.map +1 -1
  69. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  70. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  71. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  72. package/lib/cjs/ECSqlStatement.d.ts +466 -466
  73. package/lib/cjs/ECSqlStatement.js +791 -791
  74. package/lib/cjs/ECSqlStatement.js.map +1 -1
  75. package/lib/cjs/Element.d.ts +1102 -1109
  76. package/lib/cjs/Element.d.ts.map +1 -1
  77. package/lib/cjs/Element.js +1416 -1420
  78. package/lib/cjs/Element.js.map +1 -1
  79. package/lib/cjs/ElementAspect.d.ts +176 -156
  80. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  81. package/lib/cjs/ElementAspect.js +211 -178
  82. package/lib/cjs/ElementAspect.js.map +1 -1
  83. package/lib/cjs/ElementGraphics.d.ts +9 -9
  84. package/lib/cjs/ElementGraphics.js +41 -41
  85. package/lib/cjs/ElementGraphics.js.map +1 -1
  86. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  87. package/lib/cjs/ElementTreeWalker.js +409 -409
  88. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  89. package/lib/cjs/Entity.d.ts +106 -76
  90. package/lib/cjs/Entity.d.ts.map +1 -1
  91. package/lib/cjs/Entity.js +134 -82
  92. package/lib/cjs/Entity.js.map +1 -1
  93. package/lib/cjs/EntityReferences.d.ts +50 -0
  94. package/lib/cjs/EntityReferences.d.ts.map +1 -0
  95. package/lib/cjs/EntityReferences.js +96 -0
  96. package/lib/cjs/EntityReferences.js.map +1 -0
  97. package/lib/cjs/ExportGraphics.d.ts +317 -317
  98. package/lib/cjs/ExportGraphics.js +208 -208
  99. package/lib/cjs/ExportGraphics.js.map +1 -1
  100. package/lib/cjs/ExternalSource.d.ts +96 -94
  101. package/lib/cjs/ExternalSource.d.ts.map +1 -1
  102. package/lib/cjs/ExternalSource.js +131 -125
  103. package/lib/cjs/ExternalSource.js.map +1 -1
  104. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  105. package/lib/cjs/GeoCoordConfig.d.ts.map +1 -1
  106. package/lib/cjs/GeoCoordConfig.js +85 -82
  107. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  108. package/lib/cjs/GeometrySummary.d.ts +4 -4
  109. package/lib/cjs/GeometrySummary.js +380 -380
  110. package/lib/cjs/GeometrySummary.js.map +1 -1
  111. package/lib/cjs/HubMock.d.ts +94 -93
  112. package/lib/cjs/HubMock.d.ts.map +1 -1
  113. package/lib/cjs/HubMock.js +222 -190
  114. package/lib/cjs/HubMock.js.map +1 -1
  115. package/lib/cjs/IModelCloneContext.d.ts +8 -85
  116. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  117. package/lib/cjs/IModelCloneContext.js +15 -150
  118. package/lib/cjs/IModelCloneContext.js.map +1 -1
  119. package/lib/cjs/IModelDb.d.ts +1183 -1164
  120. package/lib/cjs/IModelDb.d.ts.map +1 -1
  121. package/lib/cjs/IModelDb.js +2374 -2324
  122. package/lib/cjs/IModelDb.js.map +1 -1
  123. package/lib/cjs/IModelElementCloneContext.d.ts +90 -0
  124. package/lib/cjs/IModelElementCloneContext.d.ts.map +1 -0
  125. package/lib/cjs/IModelElementCloneContext.js +160 -0
  126. package/lib/cjs/IModelElementCloneContext.js.map +1 -0
  127. package/lib/cjs/IModelHost.d.ts +370 -361
  128. package/lib/cjs/IModelHost.d.ts.map +1 -1
  129. package/lib/cjs/IModelHost.js +496 -489
  130. package/lib/cjs/IModelHost.js.map +1 -1
  131. package/lib/cjs/IModelJsFs.d.ts +62 -62
  132. package/lib/cjs/IModelJsFs.js +140 -140
  133. package/lib/cjs/IModelJsFs.js.map +1 -1
  134. package/lib/cjs/IpcHost.d.ts +104 -98
  135. package/lib/cjs/IpcHost.d.ts.map +1 -1
  136. package/lib/cjs/IpcHost.js +278 -234
  137. package/lib/cjs/IpcHost.js.map +1 -1
  138. package/lib/cjs/LineStyle.d.ts +311 -311
  139. package/lib/cjs/LineStyle.js +295 -295
  140. package/lib/cjs/LineStyle.js.map +1 -1
  141. package/lib/cjs/LocalHub.d.ts +162 -162
  142. package/lib/cjs/LocalHub.js +587 -587
  143. package/lib/cjs/LocalHub.js.map +1 -1
  144. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  145. package/lib/cjs/LocalhostIpcHost.js +81 -81
  146. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  147. package/lib/cjs/Material.d.ts +103 -103
  148. package/lib/cjs/Material.js +147 -147
  149. package/lib/cjs/Material.js.map +1 -1
  150. package/lib/cjs/Model.d.ts +392 -386
  151. package/lib/cjs/Model.d.ts.map +1 -1
  152. package/lib/cjs/Model.js +485 -471
  153. package/lib/cjs/Model.js.map +1 -1
  154. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  155. package/lib/cjs/NativeAppStorage.js +202 -202
  156. package/lib/cjs/NativeAppStorage.js.map +1 -1
  157. package/lib/cjs/NativeHost.d.ts +52 -52
  158. package/lib/cjs/NativeHost.d.ts.map +1 -1
  159. package/lib/cjs/NativeHost.js +163 -168
  160. package/lib/cjs/NativeHost.js.map +1 -1
  161. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  162. package/lib/cjs/NavigationRelationship.js +225 -225
  163. package/lib/cjs/NavigationRelationship.js.map +1 -1
  164. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  165. package/lib/cjs/PromiseMemoizer.d.ts.map +1 -1
  166. package/lib/cjs/PromiseMemoizer.js +101 -101
  167. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  168. package/lib/cjs/PropertyStore.d.ts +132 -132
  169. package/lib/cjs/PropertyStore.js +11 -11
  170. package/lib/cjs/PropertyStore.js.map +1 -1
  171. package/lib/cjs/Relationship.d.ts +416 -400
  172. package/lib/cjs/Relationship.d.ts.map +1 -1
  173. package/lib/cjs/Relationship.js +494 -465
  174. package/lib/cjs/Relationship.js.map +1 -1
  175. package/lib/cjs/RpcBackend.d.ts +5 -28
  176. package/lib/cjs/RpcBackend.d.ts.map +1 -1
  177. package/lib/cjs/RpcBackend.js +31 -126
  178. package/lib/cjs/RpcBackend.js.map +1 -1
  179. package/lib/cjs/SQLiteDb.d.ts +219 -219
  180. package/lib/cjs/SQLiteDb.js +214 -214
  181. package/lib/cjs/SQLiteDb.js.map +1 -1
  182. package/lib/cjs/Schema.d.ts +55 -55
  183. package/lib/cjs/Schema.js +83 -83
  184. package/lib/cjs/Schema.js.map +1 -1
  185. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  186. package/lib/cjs/ServerBasedLocks.js +168 -168
  187. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  188. package/lib/cjs/SqliteStatement.d.ts +360 -283
  189. package/lib/cjs/SqliteStatement.d.ts.map +1 -1
  190. package/lib/cjs/SqliteStatement.js +586 -448
  191. package/lib/cjs/SqliteStatement.js.map +1 -1
  192. package/lib/cjs/Texture.d.ts +58 -58
  193. package/lib/cjs/Texture.js +82 -82
  194. package/lib/cjs/Texture.js.map +1 -1
  195. package/lib/cjs/TileStorage.d.ts +18 -18
  196. package/lib/cjs/TileStorage.js +90 -90
  197. package/lib/cjs/TileStorage.js.map +1 -1
  198. package/lib/cjs/TxnManager.d.ts +202 -202
  199. package/lib/cjs/TxnManager.js +356 -356
  200. package/lib/cjs/TxnManager.js.map +1 -1
  201. package/lib/cjs/ViewDefinition.d.ts +439 -435
  202. package/lib/cjs/ViewDefinition.d.ts.map +1 -1
  203. package/lib/cjs/ViewDefinition.js +646 -635
  204. package/lib/cjs/ViewDefinition.js.map +1 -1
  205. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  206. package/lib/cjs/ViewStateHydrator.js +103 -103
  207. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  208. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  209. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  210. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  211. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  212. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  213. package/lib/cjs/core-backend.d.ts +184 -182
  214. package/lib/cjs/core-backend.d.ts.map +1 -1
  215. package/lib/cjs/core-backend.js +204 -202
  216. package/lib/cjs/core-backend.js.map +1 -1
  217. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  218. package/lib/cjs/domains/FunctionalElements.js +145 -145
  219. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  220. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  221. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  222. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  223. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  224. package/lib/cjs/domains/GenericElements.js +263 -263
  225. package/lib/cjs/domains/GenericElements.js.map +1 -1
  226. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  227. package/lib/cjs/domains/GenericSchema.js +28 -28
  228. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  229. package/lib/cjs/rpc/multipart.d.ts +12 -0
  230. package/lib/cjs/rpc/multipart.d.ts.map +1 -0
  231. package/lib/cjs/rpc/multipart.js +71 -0
  232. package/lib/cjs/rpc/multipart.js.map +1 -0
  233. package/lib/cjs/rpc/tracing.d.ts +29 -0
  234. package/lib/cjs/rpc/tracing.d.ts.map +1 -0
  235. package/lib/cjs/rpc/tracing.js +74 -0
  236. package/lib/cjs/rpc/tracing.js.map +1 -0
  237. package/lib/cjs/rpc/web/logging.d.ts +10 -0
  238. package/lib/cjs/rpc/web/logging.d.ts.map +1 -0
  239. package/lib/cjs/rpc/web/logging.js +43 -0
  240. package/lib/cjs/rpc/web/logging.js.map +1 -0
  241. package/lib/cjs/rpc/web/request.d.ts +7 -0
  242. package/lib/cjs/rpc/web/request.d.ts.map +1 -0
  243. package/lib/cjs/rpc/web/request.js +74 -0
  244. package/lib/cjs/rpc/web/request.js.map +1 -0
  245. package/lib/cjs/rpc/web/response.d.ts +7 -0
  246. package/lib/cjs/rpc/web/response.d.ts.map +1 -0
  247. package/lib/cjs/rpc/web/response.js +106 -0
  248. package/lib/cjs/rpc/web/response.js.map +1 -0
  249. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  250. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  251. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  252. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -45
  253. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts.map +1 -1
  254. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +291 -262
  255. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  256. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  257. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  258. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +202 -204
  259. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  260. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  261. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  262. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  263. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  264. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  265. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  266. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  267. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  268. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  269. package/lib/cjs/workspace/Settings.d.ts +186 -186
  270. package/lib/cjs/workspace/Settings.js +155 -155
  271. package/lib/cjs/workspace/Settings.js.map +1 -1
  272. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  273. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  274. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  275. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  276. package/lib/cjs/workspace/Workspace.d.ts.map +1 -1
  277. package/lib/cjs/workspace/Workspace.js +543 -543
  278. package/lib/cjs/workspace/Workspace.js.map +1 -1
  279. package/package.json +14 -14
@@ -1,157 +1,177 @@
1
- /** @packageDocumentation
2
- * @module ElementAspects
3
- */
4
- import { ChannelRootAspectProps, ElementAspectProps, ExternalSourceAspectProps, RelatedElement } from "@itwin/core-common";
5
- import { Entity } from "./Entity";
6
- import { IModelDb } from "./IModelDb";
7
- import { Id64String } from "@itwin/core-bentley";
8
- /** Argument for the `ElementAspect.onXxx` static methods
9
- * @beta
10
- */
11
- export interface OnAspectArg {
12
- /** The iModel for the aspect affected by this event. */
13
- iModel: IModelDb;
14
- }
15
- /** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.
16
- * @beta
17
- */
18
- export interface OnAspectPropsArg extends OnAspectArg {
19
- /** The new properties of the aspect affected by this event. */
20
- props: Readonly<ElementAspectProps>;
21
- }
22
- /** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.
23
- * @beta
24
- */
25
- export interface OnAspectIdArg extends OnAspectArg {
26
- /** The Id of the aspect affected by this event */
27
- aspectId: Id64String;
28
- }
29
- /** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.
30
- * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.
31
- * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.
32
- * @public
33
- */
34
- export declare class ElementAspect extends Entity {
35
- /** @internal */
36
- static get className(): string;
37
- element: RelatedElement;
38
- /** @internal */
39
- constructor(props: ElementAspectProps, iModel: IModelDb);
40
- /** @internal */
41
- toJSON(): ElementAspectProps;
42
- /** Called before a new ElementAspect is inserted.
43
- * @note throw an exception to disallow the insert
44
- * @note If you override this method, you must call super.
45
- * @beta
46
- */
47
- protected static onInsert(_arg: OnAspectPropsArg): void;
48
- /** Called after a new ElementAspect was inserted.
49
- * @note If you override this method, you must call super.
50
- * @beta
51
- */
52
- protected static onInserted(_arg: OnAspectPropsArg): void;
53
- /** Called before an ElementAspect is updated.
54
- * @note throw an exception to disallow the update
55
- * @note If you override this method, you must call super.
56
- * @beta
57
- */
58
- protected static onUpdate(_arg: OnAspectPropsArg): void;
59
- /** Called after an ElementAspect was updated.
60
- * @note If you override this method, you must call super.
61
- * @beta
62
- */
63
- protected static onUpdated(_arg: OnAspectPropsArg): void;
64
- /** Called before an ElementAspect is deleted.
65
- * @note throw an exception to disallow the delete
66
- * @note If you override this method, you must call super.
67
- * @beta
68
- */
69
- protected static onDelete(_arg: OnAspectIdArg): void;
70
- /** Called after an ElementAspect was deleted.
71
- * @note If you override this method, you must call super.
72
- * @beta
73
- */
74
- protected static onDeleted(_arg: OnAspectIdArg): void;
75
- }
76
- /** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.
77
- * @public
78
- */
79
- export declare class ElementUniqueAspect extends ElementAspect {
80
- /** @internal */
81
- static get className(): string;
82
- }
83
- /** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.
84
- * @public
85
- */
86
- export declare class ElementMultiAspect extends ElementAspect {
87
- /** @internal */
88
- static get className(): string;
89
- }
90
- /** A ChannelRootAspect identifies an Element as the root of a *channel* which is a subset of the overall iModel hierarchy that is independently maintained.
91
- * @note The associated ECClass was added to the BisCore schema in version 1.0.10
92
- * @public
93
- */
94
- export declare class ChannelRootAspect extends ElementUniqueAspect {
95
- /** @internal */
96
- static get className(): string;
97
- /** The owner of the channel */
98
- owner: string;
99
- /** @internal */
100
- constructor(props: ChannelRootAspectProps, iModel: IModelDb);
101
- /** @internal */
102
- toJSON(): ChannelRootAspectProps;
103
- /** Insert a ChannelRootAspect on the specified element. */
104
- static insert(iModel: IModelDb, ownerId: Id64String, ownerDescription: string): void;
105
- }
106
- /** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.
107
- * @note The associated ECClass was added to the BisCore schema in version 1.0.2
108
- * @public
109
- */
110
- export declare class ExternalSourceAspect extends ElementMultiAspect {
111
- /** @internal */
112
- static get className(): string;
113
- /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source. */
114
- scope: RelatedElement;
115
- /** The identifier of the object in the source repository. */
116
- identifier: string;
117
- /** The kind of object within the source repository. */
118
- kind: string;
119
- /** The cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. */
120
- checksum?: string;
121
- /** An optional value that is typically a version number or a pseudo version number like last modified time.
122
- * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.
123
- * If present, this value must be guaranteed to change when any of the source object's content changes.
124
- */
125
- version?: string;
126
- /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process. */
127
- jsonProperties?: string;
128
- /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */
129
- source?: RelatedElement;
130
- /** @internal */
131
- constructor(props: ExternalSourceAspectProps, iModel: IModelDb);
132
- /** Look up the ElementId of the element that contains an aspect with the specified Scope, Kind, and Identifier
133
- */
134
- static findBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): {
135
- elementId?: Id64String;
136
- aspectId?: Id64String;
137
- };
138
- /** @internal */
139
- toJSON(): ExternalSourceAspectProps;
140
- }
141
- /** @public */
142
- export declare namespace ExternalSourceAspect {
143
- /** Standard values for the `Kind` property of `ExternalSourceAspect`.
144
- * @public
145
- */
146
- enum Kind {
147
- /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */
148
- Element = "Element",
149
- /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */
150
- Relationship = "Relationship",
151
- /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance
152
- * @see [[ExternalSourceAspect.scope]]
153
- */
154
- Scope = "Scope"
155
- }
156
- }
1
+ /** @packageDocumentation
2
+ * @module ElementAspects
3
+ */
4
+ import { ChannelRootAspectProps, ElementAspectProps, EntityReferenceSet, ExternalSourceAspectProps, RelatedElement } from "@itwin/core-common";
5
+ import { Entity } from "./Entity";
6
+ import { IModelDb } from "./IModelDb";
7
+ import { Id64String } from "@itwin/core-bentley";
8
+ /** Argument for the `ElementAspect.onXxx` static methods
9
+ * @beta
10
+ */
11
+ export interface OnAspectArg {
12
+ /** The iModel for the aspect affected by this event. */
13
+ iModel: IModelDb;
14
+ }
15
+ /** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.
16
+ * @beta
17
+ */
18
+ export interface OnAspectPropsArg extends OnAspectArg {
19
+ /** The new properties of the aspect affected by this event. */
20
+ props: Readonly<ElementAspectProps>;
21
+ }
22
+ /** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.
23
+ * @beta
24
+ */
25
+ export interface OnAspectIdArg extends OnAspectArg {
26
+ /** The Id of the aspect affected by this event */
27
+ aspectId: Id64String;
28
+ }
29
+ /** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.
30
+ * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.
31
+ * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.
32
+ * @public
33
+ */
34
+ export declare class ElementAspect extends Entity {
35
+ /** @internal */
36
+ static get className(): string;
37
+ element: RelatedElement;
38
+ /** @internal */
39
+ constructor(props: ElementAspectProps, iModel: IModelDb);
40
+ /** @internal */
41
+ toJSON(): ElementAspectProps;
42
+ /** Called before a new ElementAspect is inserted.
43
+ * @note throw an exception to disallow the insert
44
+ * @note If you override this method, you must call super.
45
+ * @beta
46
+ */
47
+ protected static onInsert(_arg: OnAspectPropsArg): void;
48
+ /** Called after a new ElementAspect was inserted.
49
+ * @note If you override this method, you must call super.
50
+ * @beta
51
+ */
52
+ protected static onInserted(_arg: OnAspectPropsArg): void;
53
+ /** Called before an ElementAspect is updated.
54
+ * @note throw an exception to disallow the update
55
+ * @note If you override this method, you must call super.
56
+ * @beta
57
+ */
58
+ protected static onUpdate(_arg: OnAspectPropsArg): void;
59
+ /** Called after an ElementAspect was updated.
60
+ * @note If you override this method, you must call super.
61
+ * @beta
62
+ */
63
+ protected static onUpdated(_arg: OnAspectPropsArg): void;
64
+ /** Called before an ElementAspect is deleted.
65
+ * @note throw an exception to disallow the delete
66
+ * @note If you override this method, you must call super.
67
+ * @beta
68
+ */
69
+ protected static onDelete(_arg: OnAspectIdArg): void;
70
+ /** Called after an ElementAspect was deleted.
71
+ * @note If you override this method, you must call super.
72
+ * @beta
73
+ */
74
+ protected static onDeleted(_arg: OnAspectIdArg): void;
75
+ }
76
+ /** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.
77
+ * @public
78
+ */
79
+ export declare class ElementUniqueAspect extends ElementAspect {
80
+ /** @internal */
81
+ static get className(): string;
82
+ }
83
+ /** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.
84
+ * @public
85
+ */
86
+ export declare class ElementMultiAspect extends ElementAspect {
87
+ /** @internal */
88
+ static get className(): string;
89
+ }
90
+ /** A ChannelRootAspect identifies an Element as the root of a *channel* which is a subset of the overall iModel hierarchy that is independently maintained.
91
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.10
92
+ * @public
93
+ */
94
+ export declare class ChannelRootAspect extends ElementUniqueAspect {
95
+ /** @internal */
96
+ static get className(): string;
97
+ /** The owner of the channel */
98
+ owner: string;
99
+ /** @internal */
100
+ constructor(props: ChannelRootAspectProps, iModel: IModelDb);
101
+ /** @internal */
102
+ toJSON(): ChannelRootAspectProps;
103
+ /** Insert a ChannelRootAspect on the specified element. */
104
+ static insert(iModel: IModelDb, ownerId: Id64String, ownerDescription: string): void;
105
+ }
106
+ /** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.
107
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.2
108
+ * @public
109
+ */
110
+ export declare class ExternalSourceAspect extends ElementMultiAspect {
111
+ /** @internal */
112
+ static get className(): string;
113
+ /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.
114
+ * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.
115
+ * all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.
116
+ */
117
+ scope: RelatedElement;
118
+ /** The identifier of the object in the source repository. */
119
+ identifier: string;
120
+ /** The kind of object within the source repository. */
121
+ kind: string;
122
+ /** The cryptographic hash (any algorithm) of the source object's content. If defined, it must be guaranteed to change when the source object's content changes. */
123
+ checksum?: string;
124
+ /** An optional value that is typically a version number or a pseudo version number like last modified time.
125
+ * It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided.
126
+ * If present, this value must be guaranteed to change when any of the source object's content changes.
127
+ */
128
+ version?: string;
129
+ /** A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process. */
130
+ jsonProperties?: string;
131
+ /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */
132
+ source?: RelatedElement;
133
+ /** @internal */
134
+ constructor(props: ExternalSourceAspectProps, iModel: IModelDb);
135
+ /** @deprecated findAllBySource */
136
+ static findBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): {
137
+ elementId?: Id64String;
138
+ aspectId?: Id64String;
139
+ };
140
+ /** Look up the elements that contain one or more ExternalSourceAspect with the specified Scope, Kind, and Identifier.
141
+ * The result of this function is an array of all of the ExternalSourceAspects that were found, each associated with the owning element.
142
+ * A given element could have more than one ExternalSourceAspect with the given scope, kind, and identifier.
143
+ * Also, many elements could have ExternalSourceAspect with the same scope, kind, and identifier.
144
+ * Therefore, the result array could have more than one entry with the same elementId.
145
+ * Aspects are never shared. Each aspect has its own unique ECInstanceId.
146
+ * @param iModelDb The iModel to query
147
+ * @param scope The scope of the ExternalSourceAspects to find
148
+ * @param kind The kind of the ExternalSourceAspects to find
149
+ * @param identifier The identifier of the ExternalSourceAspects to find
150
+ * @returns the query results
151
+ */
152
+ static findAllBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): Array<{
153
+ elementId: Id64String;
154
+ aspectId: Id64String;
155
+ }>;
156
+ /** @internal */
157
+ toJSON(): ExternalSourceAspectProps;
158
+ /** @internal */
159
+ protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
160
+ }
161
+ /** @public */
162
+ export declare namespace ExternalSourceAspect {
163
+ /** Standard values for the `Kind` property of `ExternalSourceAspect`.
164
+ * @public
165
+ */
166
+ enum Kind {
167
+ /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */
168
+ Element = "Element",
169
+ /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */
170
+ Relationship = "Relationship",
171
+ /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance
172
+ * @see [[ExternalSourceAspect.scope]]
173
+ */
174
+ Scope = "Scope"
175
+ }
176
+ }
157
177
  //# sourceMappingURL=ElementAspect.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ElementAspect.d.ts","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC3H,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAY,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,MAAM,EAAE,QAAQ,CAAC;CAClB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,+DAA+D;IAC/D,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;CACrC;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,kDAAkD;IAClD,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IACnE,OAAO,EAAE,cAAc,CAAC;IAE/B,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvD,gBAAgB;IACA,MAAM,IAAI,kBAAkB;IAM5C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEvD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEzD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEvD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAEpD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;CACtD;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAiC;CAChF;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,mBAAmB;IACxD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAE9E,+BAA+B;IACxB,KAAK,EAAE,MAAM,CAAC;IAErB,gBAAgB;gBACJ,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,QAAQ;IAK3D,gBAAgB;IACA,MAAM,IAAI,sBAAsB;IAMhD,2DAA2D;WAC7C,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM;CAQrF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAEjF,kIAAkI;IAC3H,KAAK,EAAE,cAAc,CAAC;IAC7B,6DAA6D;IACtD,UAAU,EAAE,MAAM,CAAC;IAC1B,uDAAuD;IAChD,IAAI,EAAE,MAAM,CAAC;IACpB,mKAAmK;IAC5J,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACI,OAAO,CAAC,EAAE,MAAM,CAAC;IACxB,yJAAyJ;IAClJ,cAAc,CAAC,EAAE,MAAM,CAAC;IAC/B,iHAAiH;IAC1G,MAAM,CAAC,EAAE,cAAc,CAAC;IAE/B,gBAAgB;gBACJ,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;IAW9D;OACG;WACW,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG;QAAE,SAAS,CAAC,EAAE,UAAU,CAAC;QAAC,QAAQ,CAAC,EAAE,UAAU,CAAA;KAAE;IAgBtJ,gBAAgB;IACA,MAAM,IAAI,yBAAyB;CAWpD;AAED,cAAc;AACd,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,KAAY,IAAI;QACd,oFAAoF;QACpF,OAAO,YAAY;QACnB,yFAAyF;QACzF,YAAY,iBAAiB;QAC7B;;WAEG;QACH,KAAK,UAAU;KAChB;CACF"}
1
+ {"version":3,"file":"ElementAspect.d.ts","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC/I,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAY,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,MAAM,EAAE,QAAQ,CAAC;CAClB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,+DAA+D;IAC/D,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;CACrC;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,kDAAkD;IAClD,QAAQ,EAAE,UAAU,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA4B;IACnE,OAAO,EAAE,cAAc,CAAC;IAE/B,gBAAgB;gBACJ,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,QAAQ;IAKvD,gBAAgB;IACA,MAAM,IAAI,kBAAkB;IAM5C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEvD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEzD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEvD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAEpD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;CACtD;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAiC;CAChF;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,mBAAmB;IACxD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAE9E,+BAA+B;IACxB,KAAK,EAAE,MAAM,CAAC;IAErB,gBAAgB;gBACJ,KAAK,EAAE,sBAAsB,EAAE,MAAM,EAAE,QAAQ;IAK3D,gBAAgB;IACA,MAAM,IAAI,sBAAsB;IAMhD,2DAA2D;WAC7C,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM;CAQrF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAmC;IAEjF;;;OAGG;IACI,KAAK,EAAE,cAAc,CAAC;IAC7B,6DAA6D;IACtD,UAAU,EAAE,MAAM,CAAC;IAC1B,uDAAuD;IAChD,IAAI,EAAE,MAAM,CAAC;IACpB,mKAAmK;IAC5J,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACI,OAAO,CAAC,EAAE,MAAM,CAAC;IACxB,yJAAyJ;IAClJ,cAAc,CAAC,EAAE,MAAM,CAAC;IAC/B,iHAAiH;IAC1G,MAAM,CAAC,EAAE,cAAc,CAAC;IAE/B,gBAAgB;gBACJ,KAAK,EAAE,yBAAyB,EAAE,MAAM,EAAE,QAAQ;IAW9D,kCAAkC;WACpB,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG;QAAE,SAAS,CAAC,EAAE,UAAU,CAAC;QAAC,QAAQ,CAAC,EAAE,UAAU,CAAA;KAAE;IAgBtJ;;;;;;;;;;;MAWE;WACY,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAAC;QAAE,SAAS,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAAC;IAc9J,gBAAgB;IACA,MAAM,IAAI,yBAAyB;IAYnD,gBAAgB;cACG,2BAA2B,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAQvF;AAED,cAAc;AACd,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,KAAY,IAAI;QACd,oFAAoF;QACpF,OAAO,YAAY;QACnB,yFAAyF;QACzF,YAAY,iBAAiB;QAC7B;;WAEG;QACH,KAAK,UAAU;KAChB;CACF"}