@itwin/core-backend 4.0.0-dev.8 → 4.0.0-dev.81

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 (259) hide show
  1. package/CHANGELOG.md +55 -1
  2. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  3. package/lib/cjs/BackendHubAccess.d.ts.map +1 -1
  4. package/lib/cjs/BackendHubAccess.js +41 -41
  5. package/lib/cjs/BackendHubAccess.js.map +1 -1
  6. package/lib/cjs/BackendLoggerCategory.d.ts +90 -91
  7. package/lib/cjs/BackendLoggerCategory.d.ts.map +1 -1
  8. package/lib/cjs/BackendLoggerCategory.js +98 -99
  9. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  10. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  11. package/lib/cjs/BisCoreSchema.js +60 -60
  12. package/lib/cjs/BriefcaseManager.d.ts +170 -170
  13. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  14. package/lib/cjs/BriefcaseManager.js +408 -414
  15. package/lib/cjs/BriefcaseManager.js.map +1 -1
  16. package/lib/cjs/Category.d.ts +153 -153
  17. package/lib/cjs/Category.js +243 -243
  18. package/lib/cjs/Category.js.map +1 -1
  19. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  20. package/lib/cjs/ChangeSummaryManager.js +444 -445
  21. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  22. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  23. package/lib/cjs/ChangedElementsDb.js +165 -165
  24. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  25. package/lib/cjs/ChangedElementsManager.js +88 -88
  26. package/lib/cjs/ChannelControl.d.ts +70 -0
  27. package/lib/cjs/ChannelControl.d.ts.map +1 -0
  28. package/lib/cjs/ChannelControl.js +89 -0
  29. package/lib/cjs/ChannelControl.js.map +1 -0
  30. package/lib/cjs/CheckpointManager.d.ts +121 -121
  31. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  32. package/lib/cjs/CheckpointManager.js +351 -349
  33. package/lib/cjs/CheckpointManager.js.map +1 -1
  34. package/lib/cjs/ClassRegistry.d.ts +79 -79
  35. package/lib/cjs/ClassRegistry.js +249 -245
  36. package/lib/cjs/ClassRegistry.js.map +1 -1
  37. package/lib/cjs/CloudSqlite.d.ts +423 -350
  38. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  39. package/lib/cjs/CloudSqlite.js +189 -153
  40. package/lib/cjs/CloudSqlite.js.map +1 -1
  41. package/lib/cjs/CodeService.d.ts +437 -396
  42. package/lib/cjs/CodeService.d.ts.map +1 -1
  43. package/lib/cjs/CodeService.js +63 -63
  44. package/lib/cjs/CodeService.js.map +1 -1
  45. package/lib/cjs/CodeSpecs.d.ts +58 -55
  46. package/lib/cjs/CodeSpecs.d.ts.map +1 -1
  47. package/lib/cjs/CodeSpecs.js +154 -124
  48. package/lib/cjs/CodeSpecs.js.map +1 -1
  49. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  50. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  51. package/lib/cjs/ConcurrentQuery.js +36 -36
  52. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  53. package/lib/cjs/CustomViewState3dCreator.d.ts.map +1 -1
  54. package/lib/cjs/CustomViewState3dCreator.js +80 -81
  55. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  56. package/lib/cjs/DevTools.d.ts +74 -71
  57. package/lib/cjs/DevTools.d.ts.map +1 -1
  58. package/lib/cjs/DevTools.js +156 -154
  59. package/lib/cjs/DevTools.js.map +1 -1
  60. package/lib/cjs/DisplayStyle.d.ts +106 -106
  61. package/lib/cjs/DisplayStyle.js +253 -256
  62. package/lib/cjs/DisplayStyle.js.map +1 -1
  63. package/lib/cjs/ECDb.d.ts +194 -191
  64. package/lib/cjs/ECDb.d.ts.map +1 -1
  65. package/lib/cjs/ECDb.js +351 -350
  66. package/lib/cjs/ECDb.js.map +1 -1
  67. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  68. package/lib/cjs/ECSchemaXmlContext.d.ts.map +1 -1
  69. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  70. package/lib/cjs/ECSqlStatement.d.ts +473 -473
  71. package/lib/cjs/ECSqlStatement.js +791 -791
  72. package/lib/cjs/Element.d.ts +1113 -1109
  73. package/lib/cjs/Element.d.ts.map +1 -1
  74. package/lib/cjs/Element.js +1424 -1427
  75. package/lib/cjs/Element.js.map +1 -1
  76. package/lib/cjs/ElementAspect.d.ts +176 -179
  77. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  78. package/lib/cjs/ElementAspect.js +203 -211
  79. package/lib/cjs/ElementAspect.js.map +1 -1
  80. package/lib/cjs/ElementGraphics.d.ts +9 -9
  81. package/lib/cjs/ElementGraphics.js +41 -41
  82. package/lib/cjs/ElementGraphics.js.map +1 -1
  83. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  84. package/lib/cjs/ElementTreeWalker.d.ts.map +1 -1
  85. package/lib/cjs/ElementTreeWalker.js +409 -409
  86. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  87. package/lib/cjs/Entity.d.ts +106 -106
  88. package/lib/cjs/Entity.d.ts.map +1 -1
  89. package/lib/cjs/Entity.js +135 -134
  90. package/lib/cjs/Entity.js.map +1 -1
  91. package/lib/cjs/EntityReferences.d.ts +49 -49
  92. package/lib/cjs/EntityReferences.d.ts.map +1 -1
  93. package/lib/cjs/EntityReferences.js +95 -95
  94. package/lib/cjs/ExportGraphics.d.ts +317 -317
  95. package/lib/cjs/ExportGraphics.d.ts.map +1 -1
  96. package/lib/cjs/ExportGraphics.js +208 -208
  97. package/lib/cjs/ExternalSource.d.ts +96 -96
  98. package/lib/cjs/ExternalSource.js +131 -131
  99. package/lib/cjs/ExternalSource.js.map +1 -1
  100. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  101. package/lib/cjs/GeoCoordConfig.js +85 -85
  102. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  103. package/lib/cjs/GeometrySummary.d.ts +4 -4
  104. package/lib/cjs/GeometrySummary.js +333 -333
  105. package/lib/cjs/GeometrySummary.js.map +1 -1
  106. package/lib/cjs/HubMock.d.ts +94 -94
  107. package/lib/cjs/HubMock.js +220 -222
  108. package/lib/cjs/HubMock.js.map +1 -1
  109. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  110. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  111. package/lib/cjs/IModelCloneContext.js +15 -15
  112. package/lib/cjs/IModelDb.d.ts +1222 -1196
  113. package/lib/cjs/IModelDb.d.ts.map +1 -1
  114. package/lib/cjs/IModelDb.js +2389 -2392
  115. package/lib/cjs/IModelDb.js.map +1 -1
  116. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  117. package/lib/cjs/IModelElementCloneContext.js +159 -159
  118. package/lib/cjs/IModelHost.d.ts +368 -369
  119. package/lib/cjs/IModelHost.d.ts.map +1 -1
  120. package/lib/cjs/IModelHost.js +474 -496
  121. package/lib/cjs/IModelHost.js.map +1 -1
  122. package/lib/cjs/IModelJsFs.d.ts +62 -62
  123. package/lib/cjs/IModelJsFs.js +139 -140
  124. package/lib/cjs/IModelJsFs.js.map +1 -1
  125. package/lib/cjs/IpcHost.d.ts +104 -104
  126. package/lib/cjs/IpcHost.js +276 -278
  127. package/lib/cjs/IpcHost.js.map +1 -1
  128. package/lib/cjs/LineStyle.d.ts +311 -311
  129. package/lib/cjs/LineStyle.js +295 -295
  130. package/lib/cjs/LocalHub.d.ts +162 -162
  131. package/lib/cjs/LocalHub.d.ts.map +1 -1
  132. package/lib/cjs/LocalHub.js +579 -584
  133. package/lib/cjs/LocalHub.js.map +1 -1
  134. package/lib/cjs/LocalhostIpcHost.d.ts +21 -20
  135. package/lib/cjs/LocalhostIpcHost.d.ts.map +1 -1
  136. package/lib/cjs/LocalhostIpcHost.js +79 -81
  137. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  138. package/lib/cjs/Material.d.ts +131 -131
  139. package/lib/cjs/Material.js +180 -181
  140. package/lib/cjs/Material.js.map +1 -1
  141. package/lib/cjs/Model.d.ts +392 -392
  142. package/lib/cjs/Model.d.ts.map +1 -1
  143. package/lib/cjs/Model.js +489 -485
  144. package/lib/cjs/Model.js.map +1 -1
  145. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  146. package/lib/cjs/NativeAppStorage.js +202 -202
  147. package/lib/cjs/NativeAppStorage.js.map +1 -1
  148. package/lib/cjs/NativeHost.d.ts +52 -52
  149. package/lib/cjs/NativeHost.d.ts.map +1 -1
  150. package/lib/cjs/NativeHost.js +158 -163
  151. package/lib/cjs/NativeHost.js.map +1 -1
  152. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  153. package/lib/cjs/NavigationRelationship.js +225 -225
  154. package/lib/cjs/NavigationRelationship.js.map +1 -1
  155. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  156. package/lib/cjs/PromiseMemoizer.d.ts.map +1 -1
  157. package/lib/cjs/PromiseMemoizer.js +101 -101
  158. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  159. package/lib/cjs/PropertyStore.d.ts +132 -132
  160. package/lib/cjs/PropertyStore.js +11 -11
  161. package/lib/cjs/Relationship.d.ts +416 -416
  162. package/lib/cjs/Relationship.js +494 -494
  163. package/lib/cjs/Relationship.js.map +1 -1
  164. package/lib/cjs/RpcBackend.d.ts +5 -5
  165. package/lib/cjs/RpcBackend.js +32 -32
  166. package/lib/cjs/SQLiteDb.d.ts +219 -219
  167. package/lib/cjs/SQLiteDb.js +212 -214
  168. package/lib/cjs/SQLiteDb.js.map +1 -1
  169. package/lib/cjs/Schema.d.ts +55 -55
  170. package/lib/cjs/Schema.js +83 -83
  171. package/lib/cjs/Schema.js.map +1 -1
  172. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  173. package/lib/cjs/ServerBasedLocks.js +168 -168
  174. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  175. package/lib/cjs/SqliteStatement.d.ts +360 -360
  176. package/lib/cjs/SqliteStatement.d.ts.map +1 -1
  177. package/lib/cjs/SqliteStatement.js +586 -586
  178. package/lib/cjs/Texture.d.ts +58 -58
  179. package/lib/cjs/Texture.js +82 -82
  180. package/lib/cjs/Texture.js.map +1 -1
  181. package/lib/cjs/TileStorage.d.ts +44 -18
  182. package/lib/cjs/TileStorage.d.ts.map +1 -1
  183. package/lib/cjs/TileStorage.js +109 -90
  184. package/lib/cjs/TileStorage.js.map +1 -1
  185. package/lib/cjs/TxnManager.d.ts +202 -202
  186. package/lib/cjs/TxnManager.d.ts.map +1 -1
  187. package/lib/cjs/TxnManager.js +356 -356
  188. package/lib/cjs/TxnManager.js.map +1 -1
  189. package/lib/cjs/ViewDefinition.d.ts +435 -439
  190. package/lib/cjs/ViewDefinition.d.ts.map +1 -1
  191. package/lib/cjs/ViewDefinition.js +646 -646
  192. package/lib/cjs/ViewDefinition.js.map +1 -1
  193. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  194. package/lib/cjs/ViewStateHydrator.js +103 -103
  195. package/lib/cjs/core-backend.d.ts +183 -184
  196. package/lib/cjs/core-backend.d.ts.map +1 -1
  197. package/lib/cjs/core-backend.js +207 -204
  198. package/lib/cjs/core-backend.js.map +1 -1
  199. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  200. package/lib/cjs/domains/FunctionalElements.js +145 -145
  201. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  202. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  203. package/lib/cjs/domains/FunctionalSchema.d.ts.map +1 -1
  204. package/lib/cjs/domains/FunctionalSchema.js +39 -40
  205. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  206. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  207. package/lib/cjs/domains/GenericElements.js +263 -263
  208. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  209. package/lib/cjs/domains/GenericSchema.js +28 -28
  210. package/lib/cjs/rpc/multipart.d.ts +11 -11
  211. package/lib/cjs/rpc/multipart.js +71 -71
  212. package/lib/cjs/rpc/tracing.d.ts +28 -28
  213. package/lib/cjs/rpc/tracing.js +73 -74
  214. package/lib/cjs/rpc/tracing.js.map +1 -1
  215. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  216. package/lib/cjs/rpc/web/logging.js +43 -43
  217. package/lib/cjs/rpc/web/request.d.ts +6 -6
  218. package/lib/cjs/rpc/web/request.js +73 -74
  219. package/lib/cjs/rpc/web/request.js.map +1 -1
  220. package/lib/cjs/rpc/web/response.d.ts +6 -6
  221. package/lib/cjs/rpc/web/response.js +105 -106
  222. package/lib/cjs/rpc/web/response.js.map +1 -1
  223. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  224. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  225. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  226. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +293 -294
  227. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  228. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +20 -22
  229. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  230. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +190 -205
  231. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  232. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  233. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +166 -168
  234. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  235. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  236. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +42 -43
  237. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  238. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  239. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  240. package/lib/cjs/workspace/Settings.d.ts +186 -186
  241. package/lib/cjs/workspace/Settings.d.ts.map +1 -1
  242. package/lib/cjs/workspace/Settings.js +154 -155
  243. package/lib/cjs/workspace/Settings.js.map +1 -1
  244. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  245. package/lib/cjs/workspace/SettingsSchemas.js +190 -191
  246. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  247. package/lib/cjs/workspace/Workspace.d.ts +411 -414
  248. package/lib/cjs/workspace/Workspace.d.ts.map +1 -1
  249. package/lib/cjs/workspace/Workspace.js +521 -543
  250. package/lib/cjs/workspace/Workspace.js.map +1 -1
  251. package/package.json +22 -24
  252. package/lib/cjs/AliCloudStorageService.d.ts +0 -24
  253. package/lib/cjs/AliCloudStorageService.d.ts.map +0 -1
  254. package/lib/cjs/AliCloudStorageService.js +0 -72
  255. package/lib/cjs/AliCloudStorageService.js.map +0 -1
  256. package/lib/cjs/CloudStorageBackend.d.ts +0 -59
  257. package/lib/cjs/CloudStorageBackend.d.ts.map +0 -1
  258. package/lib/cjs/CloudStorageBackend.js +0 -174
  259. package/lib/cjs/CloudStorageBackend.js.map +0 -1
@@ -1,180 +1,177 @@
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
- * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.
131
- * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.
132
- */
133
- jsonProperties?: string;
134
- /** The source of the imported/synchronized object. Should point to an instance of [ExternalSource]($backend). */
135
- source?: RelatedElement;
136
- /** @internal */
137
- constructor(props: ExternalSourceAspectProps, iModel: IModelDb);
138
- /** @deprecated in 3.x. findAllBySource */
139
- static findBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): {
140
- elementId?: Id64String;
141
- aspectId?: Id64String;
142
- };
143
- /** Look up the elements that contain one or more ExternalSourceAspect with the specified Scope, Kind, and Identifier.
144
- * The result of this function is an array of all of the ExternalSourceAspects that were found, each associated with the owning element.
145
- * A given element could have more than one ExternalSourceAspect with the given scope, kind, and identifier.
146
- * Also, many elements could have ExternalSourceAspect with the same scope, kind, and identifier.
147
- * Therefore, the result array could have more than one entry with the same elementId.
148
- * Aspects are never shared. Each aspect has its own unique ECInstanceId.
149
- * @param iModelDb The iModel to query
150
- * @param scope The scope of the ExternalSourceAspects to find
151
- * @param kind The kind of the ExternalSourceAspects to find
152
- * @param identifier The identifier of the ExternalSourceAspects to find
153
- * @returns the query results
154
- */
155
- static findAllBySource(iModelDb: IModelDb, scope: Id64String, kind: string, identifier: string): Array<{
156
- elementId: Id64String;
157
- aspectId: Id64String;
158
- }>;
159
- /** @internal */
160
- toJSON(): ExternalSourceAspectProps;
161
- /** @internal */
162
- protected collectReferenceConcreteIds(referenceIds: EntityReferenceSet): void;
163
- }
164
- /** @public */
165
- export declare namespace ExternalSourceAspect {
166
- /** Standard values for the `Kind` property of `ExternalSourceAspect`.
167
- * @public
168
- */
169
- enum Kind {
170
- /** Indicates that the [[ExternalSourceAspect]] is storing [[Element]] provenance */
171
- Element = "Element",
172
- /** Indicates that the [[ExternalSourceAspect]] is storing [[Relationship]] provenance */
173
- Relationship = "Relationship",
174
- /** Indicates that the [[ExternalSourceAspect]] is storing *scope* provenance
175
- * @see [[ExternalSourceAspect.scope]]
176
- */
177
- Scope = "Scope"
178
- }
179
- }
1
+ /** @packageDocumentation
2
+ * @module ElementAspects
3
+ */
4
+ import { 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
+ /** The model for the aspect affected by this event */
15
+ model: Id64String;
16
+ }
17
+ /** Argument for the `ElementAspect.onXxx` static methods that supply the properties of an aspect to be inserted or updated.
18
+ * @beta
19
+ */
20
+ export interface OnAspectPropsArg extends OnAspectArg {
21
+ /** The new properties of the aspect affected by this event. */
22
+ props: Readonly<ElementAspectProps>;
23
+ }
24
+ /** Argument for the `ElementAspect.onXxx` static methods that only supply the Id of the affected aspect.
25
+ * @beta
26
+ */
27
+ export interface OnAspectIdArg extends OnAspectArg {
28
+ /** The Id of the aspect affected by this event */
29
+ aspectId: Id64String;
30
+ }
31
+ /** An Element Aspect is a class that defines a set of properties that are related to (and owned by) a single element.
32
+ * Semantically, an ElementAspect can be considered part of the Element. Thus, an ElementAspect is deleted if its owning Element is deleted.
33
+ * BIS Guideline: Subclass ElementUniqueAspect or ElementMultiAspect rather than subclassing ElementAspect directly.
34
+ * @public
35
+ */
36
+ export declare class ElementAspect extends Entity {
37
+ /** @internal */
38
+ static get className(): string;
39
+ element: RelatedElement;
40
+ /** @internal */
41
+ constructor(props: ElementAspectProps, iModel: IModelDb);
42
+ /** @internal */
43
+ toJSON(): ElementAspectProps;
44
+ /** Called before a new ElementAspect is inserted.
45
+ * @note throw an exception to disallow the insert
46
+ * @note If you override this method, you must call super.
47
+ * @beta
48
+ */
49
+ protected static onInsert(arg: OnAspectPropsArg): void;
50
+ /** Called after a new ElementAspect was inserted.
51
+ * @note If you override this method, you must call super.
52
+ * @beta
53
+ */
54
+ protected static onInserted(_arg: OnAspectPropsArg): void;
55
+ /** Called before an ElementAspect is updated.
56
+ * @note throw an exception to disallow the update
57
+ * @note If you override this method, you must call super.
58
+ * @beta
59
+ */
60
+ protected static onUpdate(arg: OnAspectPropsArg): void;
61
+ /** Called after an ElementAspect was updated.
62
+ * @note If you override this method, you must call super.
63
+ * @beta
64
+ */
65
+ protected static onUpdated(_arg: OnAspectPropsArg): void;
66
+ /** Called before an ElementAspect is deleted.
67
+ * @note throw an exception to disallow the delete
68
+ * @note If you override this method, you must call super.
69
+ * @beta
70
+ */
71
+ protected static onDelete(arg: OnAspectIdArg): void;
72
+ /** Called after an ElementAspect was deleted.
73
+ * @note If you override this method, you must call super.
74
+ * @beta
75
+ */
76
+ protected static onDeleted(_arg: OnAspectIdArg): void;
77
+ }
78
+ /** An Element Unique Aspect is an ElementAspect where there can be only zero or one instance of the Element Aspect class per Element.
79
+ * @public
80
+ */
81
+ export declare class ElementUniqueAspect extends ElementAspect {
82
+ /** @internal */
83
+ static get className(): string;
84
+ }
85
+ /** An Element Multi-Aspect is an ElementAspect where there can be **n** instances of the Element Aspect class per Element.
86
+ * @public
87
+ */
88
+ export declare class ElementMultiAspect extends ElementAspect {
89
+ /** @internal */
90
+ static get className(): string;
91
+ }
92
+ /**
93
+ * @public
94
+ */
95
+ export declare class ChannelRootAspect extends ElementUniqueAspect {
96
+ /** @internal */
97
+ static get className(): string;
98
+ /** Insert a ChannelRootAspect on the specified element.
99
+ * @deprecated in 4.0 use [[ChannelControl.insertChannelSubject]]
100
+ */
101
+ static insert(iModel: IModelDb, ownerId: Id64String, channelName: string): void;
102
+ }
103
+ /** An ElementMultiAspect that stores synchronization information for an Element originating from an external source.
104
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.2
105
+ * @public
106
+ */
107
+ export declare class ExternalSourceAspect extends ElementMultiAspect {
108
+ /** @internal */
109
+ static get className(): string;
110
+ /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.
111
+ * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.
112
+ * all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.
113
+ */
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
+ * @note Warning: in a future major release, the type of `jsonProperties` will be changed to object, and itwin.js will automatically stringify it when writing to the iModel.
128
+ * This will be a breaking change, since application code will have to change from supplying a string to supplying an object.
129
+ */
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 in 3.x. 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
+ }
180
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,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;;;OAGG;IACI,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,0CAA0C;WAC5B,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"}
1
+ {"version":3,"file":"ElementAspect.d.ts","sourceRoot":"","sources":["../../src/ElementAspect.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA0B,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;IACjB,sDAAsD;IACtD,KAAK,EAAE,UAAU,CAAC;CACnB;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,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAItD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAEzD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,IAAI;IAItD;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAInD;;;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;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,mBAAmB;IACxD,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;OAEG;WACW,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM;CAIhF;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;;;OAGG;IACI,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,0CAA0C;WAC5B,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"}