@itwin/core-backend 4.0.0-dev.6 → 4.0.0-dev.61

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 (253) hide show
  1. package/CHANGELOG.md +89 -67
  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 +355 -350
  38. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  39. package/lib/cjs/CloudSqlite.js +154 -153
  40. package/lib/cjs/CloudSqlite.js.map +1 -1
  41. package/lib/cjs/CodeService.d.ts +396 -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 +55 -55
  46. package/lib/cjs/CodeSpecs.js +124 -124
  47. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  48. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  49. package/lib/cjs/ConcurrentQuery.js +36 -36
  50. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  51. package/lib/cjs/CustomViewState3dCreator.d.ts.map +1 -1
  52. package/lib/cjs/CustomViewState3dCreator.js +82 -81
  53. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  54. package/lib/cjs/DevTools.d.ts +74 -71
  55. package/lib/cjs/DevTools.d.ts.map +1 -1
  56. package/lib/cjs/DevTools.js +156 -154
  57. package/lib/cjs/DevTools.js.map +1 -1
  58. package/lib/cjs/DisplayStyle.d.ts +106 -106
  59. package/lib/cjs/DisplayStyle.js +253 -256
  60. package/lib/cjs/DisplayStyle.js.map +1 -1
  61. package/lib/cjs/ECDb.d.ts +194 -191
  62. package/lib/cjs/ECDb.d.ts.map +1 -1
  63. package/lib/cjs/ECDb.js +353 -350
  64. package/lib/cjs/ECDb.js.map +1 -1
  65. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  66. package/lib/cjs/ECSchemaXmlContext.d.ts.map +1 -1
  67. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  68. package/lib/cjs/ECSqlStatement.d.ts +473 -473
  69. package/lib/cjs/ECSqlStatement.js +791 -791
  70. package/lib/cjs/Element.d.ts +1113 -1109
  71. package/lib/cjs/Element.d.ts.map +1 -1
  72. package/lib/cjs/Element.js +1424 -1427
  73. package/lib/cjs/Element.js.map +1 -1
  74. package/lib/cjs/ElementAspect.d.ts +176 -179
  75. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  76. package/lib/cjs/ElementAspect.js +203 -211
  77. package/lib/cjs/ElementAspect.js.map +1 -1
  78. package/lib/cjs/ElementGraphics.d.ts +9 -9
  79. package/lib/cjs/ElementGraphics.js +41 -41
  80. package/lib/cjs/ElementGraphics.js.map +1 -1
  81. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  82. package/lib/cjs/ElementTreeWalker.d.ts.map +1 -1
  83. package/lib/cjs/ElementTreeWalker.js +409 -409
  84. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  85. package/lib/cjs/Entity.d.ts +106 -106
  86. package/lib/cjs/Entity.d.ts.map +1 -1
  87. package/lib/cjs/Entity.js +134 -134
  88. package/lib/cjs/Entity.js.map +1 -1
  89. package/lib/cjs/EntityReferences.d.ts +49 -49
  90. package/lib/cjs/EntityReferences.d.ts.map +1 -1
  91. package/lib/cjs/EntityReferences.js +95 -95
  92. package/lib/cjs/ExportGraphics.d.ts +317 -317
  93. package/lib/cjs/ExportGraphics.d.ts.map +1 -1
  94. package/lib/cjs/ExportGraphics.js +208 -208
  95. package/lib/cjs/ExternalSource.d.ts +96 -96
  96. package/lib/cjs/ExternalSource.js +131 -131
  97. package/lib/cjs/ExternalSource.js.map +1 -1
  98. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  99. package/lib/cjs/GeoCoordConfig.js +85 -85
  100. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  101. package/lib/cjs/GeometrySummary.d.ts +4 -4
  102. package/lib/cjs/GeometrySummary.js +333 -333
  103. package/lib/cjs/GeometrySummary.js.map +1 -1
  104. package/lib/cjs/HubMock.d.ts +94 -94
  105. package/lib/cjs/HubMock.js +220 -222
  106. package/lib/cjs/HubMock.js.map +1 -1
  107. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  108. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  109. package/lib/cjs/IModelCloneContext.js +15 -15
  110. package/lib/cjs/IModelDb.d.ts +1216 -1196
  111. package/lib/cjs/IModelDb.d.ts.map +1 -1
  112. package/lib/cjs/IModelDb.js +2387 -2392
  113. package/lib/cjs/IModelDb.js.map +1 -1
  114. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  115. package/lib/cjs/IModelElementCloneContext.js +159 -159
  116. package/lib/cjs/IModelHost.d.ts +356 -369
  117. package/lib/cjs/IModelHost.d.ts.map +1 -1
  118. package/lib/cjs/IModelHost.js +472 -496
  119. package/lib/cjs/IModelHost.js.map +1 -1
  120. package/lib/cjs/IModelJsFs.d.ts +62 -62
  121. package/lib/cjs/IModelJsFs.js +139 -140
  122. package/lib/cjs/IModelJsFs.js.map +1 -1
  123. package/lib/cjs/IpcHost.d.ts +104 -104
  124. package/lib/cjs/IpcHost.js +276 -278
  125. package/lib/cjs/IpcHost.js.map +1 -1
  126. package/lib/cjs/LineStyle.d.ts +311 -311
  127. package/lib/cjs/LineStyle.js +295 -295
  128. package/lib/cjs/LocalHub.d.ts +162 -162
  129. package/lib/cjs/LocalHub.d.ts.map +1 -1
  130. package/lib/cjs/LocalHub.js +579 -584
  131. package/lib/cjs/LocalHub.js.map +1 -1
  132. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  133. package/lib/cjs/LocalhostIpcHost.js +79 -81
  134. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  135. package/lib/cjs/Material.d.ts +131 -131
  136. package/lib/cjs/Material.js +180 -181
  137. package/lib/cjs/Material.js.map +1 -1
  138. package/lib/cjs/Model.d.ts +392 -392
  139. package/lib/cjs/Model.d.ts.map +1 -1
  140. package/lib/cjs/Model.js +489 -485
  141. package/lib/cjs/Model.js.map +1 -1
  142. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  143. package/lib/cjs/NativeAppStorage.js +202 -202
  144. package/lib/cjs/NativeAppStorage.js.map +1 -1
  145. package/lib/cjs/NativeHost.d.ts +52 -52
  146. package/lib/cjs/NativeHost.js +160 -163
  147. package/lib/cjs/NativeHost.js.map +1 -1
  148. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  149. package/lib/cjs/NavigationRelationship.js +225 -225
  150. package/lib/cjs/NavigationRelationship.js.map +1 -1
  151. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  152. package/lib/cjs/PromiseMemoizer.d.ts.map +1 -1
  153. package/lib/cjs/PromiseMemoizer.js +101 -101
  154. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  155. package/lib/cjs/PropertyStore.d.ts +132 -132
  156. package/lib/cjs/PropertyStore.js +11 -11
  157. package/lib/cjs/Relationship.d.ts +416 -416
  158. package/lib/cjs/Relationship.js +494 -494
  159. package/lib/cjs/Relationship.js.map +1 -1
  160. package/lib/cjs/RpcBackend.d.ts +5 -5
  161. package/lib/cjs/RpcBackend.js +32 -32
  162. package/lib/cjs/SQLiteDb.d.ts +219 -219
  163. package/lib/cjs/SQLiteDb.js +212 -214
  164. package/lib/cjs/SQLiteDb.js.map +1 -1
  165. package/lib/cjs/Schema.d.ts +55 -55
  166. package/lib/cjs/Schema.js +83 -83
  167. package/lib/cjs/Schema.js.map +1 -1
  168. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  169. package/lib/cjs/ServerBasedLocks.js +168 -168
  170. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  171. package/lib/cjs/SqliteStatement.d.ts +360 -360
  172. package/lib/cjs/SqliteStatement.d.ts.map +1 -1
  173. package/lib/cjs/SqliteStatement.js +586 -586
  174. package/lib/cjs/Texture.d.ts +58 -58
  175. package/lib/cjs/Texture.js +82 -82
  176. package/lib/cjs/Texture.js.map +1 -1
  177. package/lib/cjs/TileStorage.d.ts +18 -18
  178. package/lib/cjs/TileStorage.js +87 -90
  179. package/lib/cjs/TileStorage.js.map +1 -1
  180. package/lib/cjs/TxnManager.d.ts +202 -202
  181. package/lib/cjs/TxnManager.d.ts.map +1 -1
  182. package/lib/cjs/TxnManager.js +356 -356
  183. package/lib/cjs/TxnManager.js.map +1 -1
  184. package/lib/cjs/ViewDefinition.d.ts +435 -439
  185. package/lib/cjs/ViewDefinition.d.ts.map +1 -1
  186. package/lib/cjs/ViewDefinition.js +646 -646
  187. package/lib/cjs/ViewDefinition.js.map +1 -1
  188. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  189. package/lib/cjs/ViewStateHydrator.js +103 -103
  190. package/lib/cjs/core-backend.d.ts +183 -184
  191. package/lib/cjs/core-backend.d.ts.map +1 -1
  192. package/lib/cjs/core-backend.js +207 -204
  193. package/lib/cjs/core-backend.js.map +1 -1
  194. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  195. package/lib/cjs/domains/FunctionalElements.js +145 -145
  196. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  197. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  198. package/lib/cjs/domains/FunctionalSchema.d.ts.map +1 -1
  199. package/lib/cjs/domains/FunctionalSchema.js +39 -40
  200. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  201. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  202. package/lib/cjs/domains/GenericElements.js +263 -263
  203. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  204. package/lib/cjs/domains/GenericSchema.js +28 -28
  205. package/lib/cjs/rpc/multipart.d.ts +11 -11
  206. package/lib/cjs/rpc/multipart.js +71 -71
  207. package/lib/cjs/rpc/tracing.d.ts +28 -28
  208. package/lib/cjs/rpc/tracing.js +73 -74
  209. package/lib/cjs/rpc/tracing.js.map +1 -1
  210. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  211. package/lib/cjs/rpc/web/logging.js +43 -43
  212. package/lib/cjs/rpc/web/request.d.ts +6 -6
  213. package/lib/cjs/rpc/web/request.js +73 -74
  214. package/lib/cjs/rpc/web/request.js.map +1 -1
  215. package/lib/cjs/rpc/web/response.d.ts +6 -6
  216. package/lib/cjs/rpc/web/response.js +105 -106
  217. package/lib/cjs/rpc/web/response.js.map +1 -1
  218. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  219. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  220. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  221. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +293 -294
  222. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  223. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +20 -22
  224. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  225. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +187 -205
  226. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  227. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  228. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +166 -168
  229. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  230. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  231. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +42 -43
  232. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  233. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  234. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  235. package/lib/cjs/workspace/Settings.d.ts +186 -186
  236. package/lib/cjs/workspace/Settings.d.ts.map +1 -1
  237. package/lib/cjs/workspace/Settings.js +154 -155
  238. package/lib/cjs/workspace/Settings.js.map +1 -1
  239. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  240. package/lib/cjs/workspace/SettingsSchemas.js +190 -191
  241. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  242. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  243. package/lib/cjs/workspace/Workspace.js +537 -543
  244. package/lib/cjs/workspace/Workspace.js.map +1 -1
  245. package/package.json +19 -19
  246. package/lib/cjs/AliCloudStorageService.d.ts +0 -24
  247. package/lib/cjs/AliCloudStorageService.d.ts.map +0 -1
  248. package/lib/cjs/AliCloudStorageService.js +0 -72
  249. package/lib/cjs/AliCloudStorageService.js.map +0 -1
  250. package/lib/cjs/CloudStorageBackend.d.ts +0 -59
  251. package/lib/cjs/CloudStorageBackend.d.ts.map +0 -1
  252. package/lib/cjs/CloudStorageBackend.js +0 -174
  253. package/lib/cjs/CloudStorageBackend.js.map +0 -1
@@ -1,279 +1,277 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module NativeApp
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.throttleProgressCallback = exports.IpcHandler = exports.IpcHost = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const core_common_1 = require("@itwin/core-common");
13
- const IModelDb_1 = require("./IModelDb");
14
- const IModelHost_1 = require("./IModelHost");
15
- const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
16
- const CheckpointManager_1 = require("./CheckpointManager");
17
- /**
18
- * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
19
- * @note if either end terminates, the other must too.
20
- * @public
21
- */
22
- class IpcHost {
23
- /** Get the implementation of the [IpcSocketBackend]($common) interface. */
24
- static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
25
- /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
26
- static get isValid() { return undefined !== this._ipc; }
27
- /**
28
- * Send a message to the frontend over an Ipc channel.
29
- * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
30
- * @param data The content of the message.
31
- */
32
- static send(channel, ...data) {
33
- this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
34
- }
35
- /**
36
- * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
37
- * @param channel The name of the channel for this handler.
38
- * @param handler A function that supplies the implementation for `channel`
39
- * @note returns A function to call to remove the handler.
40
- */
41
- static handle(channel, handler) {
42
- return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
43
- }
44
- /**
45
- * Establish a handler to receive messages sent via [[IpcApp.send]].
46
- * @param channel The name of the channel for the messages.
47
- * @param listener A function called when messages are sent over `channel`
48
- * @note returns A function to call to remove the listener.
49
- */
50
- static addListener(channel, listener) {
51
- return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
52
- }
53
- /**
54
- * Remove a previously registered listener
55
- * @param channel The name of the channel for the listener previously registered with [[addListener]]
56
- * @param listener The function passed to [[addListener]]
57
- */
58
- static removeListener(channel, listener) {
59
- this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
60
- }
61
- static notify(channel, briefcase, methodName, ...args) {
62
- if (this.isValid)
63
- return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
64
- }
65
- /** @internal */
66
- static notifyIpcFrontend(methodName, ...args) {
67
- return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
68
- }
69
- /** @internal */
70
- static notifyTxns(briefcase, methodName, ...args) {
71
- this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
72
- }
73
- /** @internal */
74
- static notifyEditingScope(briefcase, methodName, ...args) {
75
- this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
76
- }
77
- /**
78
- * Start the backend of an Ipc app.
79
- * @param opt
80
- * @note this method calls [[IModelHost.startup]] internally.
81
- */
82
- static async startup(opt) {
83
- var _a, _b, _c;
84
- this._ipc = (_a = opt === null || opt === void 0 ? void 0 : opt.ipcHost) === null || _a === void 0 ? void 0 : _a.socket;
85
- if ((_c = (_b = opt === null || opt === void 0 ? void 0 : opt.ipcHost) === null || _b === void 0 ? void 0 : _b.exceptions) === null || _c === void 0 ? void 0 : _c.noStack)
86
- this.noStack = true;
87
- if (this.isValid) { // for tests, we use IpcHost but don't have a frontend
88
- IpcAppHandler.register();
89
- }
90
- await IModelHost_1.IModelHost.startup(opt === null || opt === void 0 ? void 0 : opt.iModelHost);
91
- }
92
- /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
93
- static async shutdown() {
94
- this._ipc = undefined;
95
- await IModelHost_1.IModelHost.shutdown();
96
- }
97
- }
98
- exports.IpcHost = IpcHost;
99
- IpcHost.noStack = false;
100
- /**
101
- * Base class for all implementations of an Ipc interface.
102
- *
103
- * Create a subclass to implement your Ipc interface. Your class should be declared like this:
104
- * ```ts
105
- * class MyHandler extends IpcHandler implements MyInterface
106
- * ```
107
- * to ensure all methods and signatures are correct.
108
- *
109
- * Then, call `MyClass.register` at startup to connect your class to your channel.
110
- * @public
111
- */
112
- class IpcHandler {
113
- /**
114
- * Register this class as the handler for methods on its channel. This static method creates a new instance
115
- * that becomes the handler and is `this` when its methods are called.
116
- * @returns A function that can be called to remove the handler.
117
- * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
118
- */
119
- static register() {
120
- const impl = new this(); // create an instance of subclass. "as any" is necessary because base class is abstract
121
- return IpcHost.handle(impl.channelName, async (_evt, funcName, ...args) => {
122
- var _a, _b, _c, _d;
123
- try {
124
- const func = impl[funcName];
125
- if (typeof func !== "function")
126
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.FunctionNotFound, `Method "${impl.constructor.name}.${funcName}" not found on IpcHandler registered for channel: ${impl.channelName}`);
127
- return { result: await func.call(impl, ...args) };
128
- }
129
- catch (err) {
130
- const ret = {
131
- error: {
132
- name: err.hasOwnProperty("name") ? err.name : (_b = (_a = err.constructor) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : "Unknown Error",
133
- message: (_c = err.message) !== null && _c !== void 0 ? _c : core_bentley_1.BentleyError.getErrorMessage(err),
134
- errorNumber: (_d = err.errorNumber) !== null && _d !== void 0 ? _d : 0,
135
- },
136
- };
137
- if (!IpcHost.noStack)
138
- ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
139
- return ret;
140
- }
141
- });
142
- }
143
- }
144
- exports.IpcHandler = IpcHandler;
145
- /**
146
- * Implementation of IpcAppFunctions
147
- */
148
- class IpcAppHandler extends IpcHandler {
149
- constructor() {
150
- super(...arguments);
151
- this._iModelKeyToPullStatus = new Map();
152
- }
153
- get channelName() { return core_common_1.IpcAppChannel.Functions; }
154
- async log(_timestamp, level, category, message, metaData) {
155
- switch (level) {
156
- case core_bentley_1.LogLevel.Error:
157
- core_bentley_1.Logger.logError(category, message, metaData);
158
- break;
159
- case core_bentley_1.LogLevel.Info:
160
- core_bentley_1.Logger.logInfo(category, message, metaData);
161
- break;
162
- case core_bentley_1.LogLevel.Trace:
163
- core_bentley_1.Logger.logTrace(category, message, metaData);
164
- break;
165
- case core_bentley_1.LogLevel.Warning:
166
- core_bentley_1.Logger.logWarning(category, message, metaData);
167
- break;
168
- }
169
- }
170
- async cancelTileContentRequests(tokenProps, contentIds) {
171
- return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
172
- }
173
- async cancelElementGraphicsRequests(key, requestIds) {
174
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
175
- }
176
- async openBriefcase(args) {
177
- const db = await IModelDb_1.BriefcaseDb.open(args);
178
- return db.toJSON();
179
- }
180
- async openStandalone(filePath, openMode, opts) {
181
- return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
182
- }
183
- async closeIModel(key) {
184
- IModelDb_1.IModelDb.findByKey(key).close();
185
- }
186
- async saveChanges(key, description) {
187
- IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
188
- }
189
- async hasPendingTxns(key) {
190
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
191
- }
192
- async isUndoPossible(key) {
193
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
194
- }
195
- async isRedoPossible(key) {
196
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
197
- }
198
- async getUndoString(key) {
199
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
200
- }
201
- async getRedoString(key) {
202
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
203
- }
204
- async pullChanges(key, toIndex, options) {
205
- const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
206
- this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Continue);
207
- const checkAbort = () => { var _a; return (_a = this._iModelKeyToPullStatus.get(key)) !== null && _a !== void 0 ? _a : CheckpointManager_1.ProgressStatus.Continue; };
208
- let onProgress;
209
- if (options === null || options === void 0 ? void 0 : options.reportProgress) {
210
- const progressCallback = (loaded, total) => {
211
- IpcHost.send((0, core_common_1.getPullChangesIpcChannel)(iModelDb.iModelId), { loaded, total });
212
- return checkAbort();
213
- };
214
- onProgress = throttleProgressCallback(progressCallback, checkAbort, options === null || options === void 0 ? void 0 : options.progressInterval);
215
- }
216
- else if (options === null || options === void 0 ? void 0 : options.enableCancellation) {
217
- onProgress = checkAbort;
218
- }
219
- try {
220
- await iModelDb.pullChanges({ toIndex, onProgress });
221
- }
222
- finally {
223
- this._iModelKeyToPullStatus.delete(key);
224
- }
225
- return iModelDb.changeset;
226
- }
227
- async cancelPullChangesRequest(key) {
228
- this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Abort);
229
- }
230
- async pushChanges(key, description) {
231
- const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
232
- await iModelDb.pushChanges({ description });
233
- return iModelDb.changeset;
234
- }
235
- async toggleGraphicalEditingScope(key, startSession) {
236
- const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
237
- if (val.error)
238
- throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
239
- (0, core_bentley_1.assert)(undefined !== val.result);
240
- return val.result;
241
- }
242
- async isGraphicalEditingSupported(key) {
243
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
244
- }
245
- async reverseTxns(key, numOperations) {
246
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
247
- }
248
- async reverseAllTxn(key) {
249
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
250
- }
251
- async reinstateTxn(key) {
252
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
253
- }
254
- async restartTxnSession(key) {
255
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
256
- }
257
- async queryConcurrency(pool) {
258
- return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
259
- }
260
- }
261
- /**
262
- * Prevents progress callback being called more frequently when provided interval.
263
- * @internal
264
- */
265
- function throttleProgressCallback(func, checkAbort, progressInterval) {
266
- const interval = progressInterval !== null && progressInterval !== void 0 ? progressInterval : 250; // by default, only send progress events every 250 milliseconds
267
- let nextTime = Date.now() + interval;
268
- const progressCallback = (loaded, total) => {
269
- const now = Date.now();
270
- if (loaded >= total || now >= nextTime) {
271
- nextTime = now + interval;
272
- return func(loaded, total);
273
- }
274
- return checkAbort();
275
- };
276
- return progressCallback;
277
- }
278
- exports.throttleProgressCallback = throttleProgressCallback;
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module NativeApp
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.throttleProgressCallback = exports.IpcHandler = exports.IpcHost = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_common_1 = require("@itwin/core-common");
13
+ const IModelDb_1 = require("./IModelDb");
14
+ const IModelHost_1 = require("./IModelHost");
15
+ const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
16
+ const CheckpointManager_1 = require("./CheckpointManager");
17
+ /**
18
+ * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
19
+ * @note if either end terminates, the other must too.
20
+ * @public
21
+ */
22
+ class IpcHost {
23
+ /** Get the implementation of the [IpcSocketBackend]($common) interface. */
24
+ static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
25
+ /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
26
+ static get isValid() { return undefined !== this._ipc; }
27
+ /**
28
+ * Send a message to the frontend over an Ipc channel.
29
+ * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
30
+ * @param data The content of the message.
31
+ */
32
+ static send(channel, ...data) {
33
+ this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
34
+ }
35
+ /**
36
+ * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
37
+ * @param channel The name of the channel for this handler.
38
+ * @param handler A function that supplies the implementation for `channel`
39
+ * @note returns A function to call to remove the handler.
40
+ */
41
+ static handle(channel, handler) {
42
+ return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
43
+ }
44
+ /**
45
+ * Establish a handler to receive messages sent via [[IpcApp.send]].
46
+ * @param channel The name of the channel for the messages.
47
+ * @param listener A function called when messages are sent over `channel`
48
+ * @note returns A function to call to remove the listener.
49
+ */
50
+ static addListener(channel, listener) {
51
+ return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
52
+ }
53
+ /**
54
+ * Remove a previously registered listener
55
+ * @param channel The name of the channel for the listener previously registered with [[addListener]]
56
+ * @param listener The function passed to [[addListener]]
57
+ */
58
+ static removeListener(channel, listener) {
59
+ this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
60
+ }
61
+ static notify(channel, briefcase, methodName, ...args) {
62
+ if (this.isValid)
63
+ return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
64
+ }
65
+ /** @internal */
66
+ static notifyIpcFrontend(methodName, ...args) {
67
+ return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
68
+ }
69
+ /** @internal */
70
+ static notifyTxns(briefcase, methodName, ...args) {
71
+ this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
72
+ }
73
+ /** @internal */
74
+ static notifyEditingScope(briefcase, methodName, ...args) {
75
+ this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
76
+ }
77
+ /**
78
+ * Start the backend of an Ipc app.
79
+ * @param opt
80
+ * @note this method calls [[IModelHost.startup]] internally.
81
+ */
82
+ static async startup(opt) {
83
+ this._ipc = opt?.ipcHost?.socket;
84
+ if (opt?.ipcHost?.exceptions?.noStack)
85
+ this.noStack = true;
86
+ if (this.isValid) { // for tests, we use IpcHost but don't have a frontend
87
+ IpcAppHandler.register();
88
+ }
89
+ await IModelHost_1.IModelHost.startup(opt?.iModelHost);
90
+ }
91
+ /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
92
+ static async shutdown() {
93
+ this._ipc = undefined;
94
+ await IModelHost_1.IModelHost.shutdown();
95
+ }
96
+ }
97
+ IpcHost.noStack = false;
98
+ exports.IpcHost = IpcHost;
99
+ /**
100
+ * Base class for all implementations of an Ipc interface.
101
+ *
102
+ * Create a subclass to implement your Ipc interface. Your class should be declared like this:
103
+ * ```ts
104
+ * class MyHandler extends IpcHandler implements MyInterface
105
+ * ```
106
+ * to ensure all methods and signatures are correct.
107
+ *
108
+ * Then, call `MyClass.register` at startup to connect your class to your channel.
109
+ * @public
110
+ */
111
+ class IpcHandler {
112
+ /**
113
+ * Register this class as the handler for methods on its channel. This static method creates a new instance
114
+ * that becomes the handler and is `this` when its methods are called.
115
+ * @returns A function that can be called to remove the handler.
116
+ * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
117
+ */
118
+ static register() {
119
+ const impl = new this(); // create an instance of subclass. "as any" is necessary because base class is abstract
120
+ return IpcHost.handle(impl.channelName, async (_evt, funcName, ...args) => {
121
+ try {
122
+ const func = impl[funcName];
123
+ if (typeof func !== "function")
124
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.FunctionNotFound, `Method "${impl.constructor.name}.${funcName}" not found on IpcHandler registered for channel: ${impl.channelName}`);
125
+ return { result: await func.call(impl, ...args) };
126
+ }
127
+ catch (err) {
128
+ const ret = {
129
+ error: {
130
+ name: err.hasOwnProperty("name") ? err.name : err.constructor?.name ?? "Unknown Error",
131
+ message: err.message ?? core_bentley_1.BentleyError.getErrorMessage(err),
132
+ errorNumber: err.errorNumber ?? 0,
133
+ },
134
+ };
135
+ if (!IpcHost.noStack)
136
+ ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
137
+ return ret;
138
+ }
139
+ });
140
+ }
141
+ }
142
+ exports.IpcHandler = IpcHandler;
143
+ /**
144
+ * Implementation of IpcAppFunctions
145
+ */
146
+ class IpcAppHandler extends IpcHandler {
147
+ constructor() {
148
+ super(...arguments);
149
+ this._iModelKeyToPullStatus = new Map();
150
+ }
151
+ get channelName() { return core_common_1.IpcAppChannel.Functions; }
152
+ async log(_timestamp, level, category, message, metaData) {
153
+ switch (level) {
154
+ case core_bentley_1.LogLevel.Error:
155
+ core_bentley_1.Logger.logError(category, message, metaData);
156
+ break;
157
+ case core_bentley_1.LogLevel.Info:
158
+ core_bentley_1.Logger.logInfo(category, message, metaData);
159
+ break;
160
+ case core_bentley_1.LogLevel.Trace:
161
+ core_bentley_1.Logger.logTrace(category, message, metaData);
162
+ break;
163
+ case core_bentley_1.LogLevel.Warning:
164
+ core_bentley_1.Logger.logWarning(category, message, metaData);
165
+ break;
166
+ }
167
+ }
168
+ async cancelTileContentRequests(tokenProps, contentIds) {
169
+ return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
170
+ }
171
+ async cancelElementGraphicsRequests(key, requestIds) {
172
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
173
+ }
174
+ async openBriefcase(args) {
175
+ const db = await IModelDb_1.BriefcaseDb.open(args);
176
+ return db.toJSON();
177
+ }
178
+ async openStandalone(filePath, openMode, opts) {
179
+ return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
180
+ }
181
+ async closeIModel(key) {
182
+ IModelDb_1.IModelDb.findByKey(key).close();
183
+ }
184
+ async saveChanges(key, description) {
185
+ IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
186
+ }
187
+ async hasPendingTxns(key) {
188
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
189
+ }
190
+ async isUndoPossible(key) {
191
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
192
+ }
193
+ async isRedoPossible(key) {
194
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
195
+ }
196
+ async getUndoString(key) {
197
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
198
+ }
199
+ async getRedoString(key) {
200
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
201
+ }
202
+ async pullChanges(key, toIndex, options) {
203
+ const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
204
+ this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Continue);
205
+ const checkAbort = () => this._iModelKeyToPullStatus.get(key) ?? CheckpointManager_1.ProgressStatus.Continue;
206
+ let onProgress;
207
+ if (options?.reportProgress) {
208
+ const progressCallback = (loaded, total) => {
209
+ IpcHost.send((0, core_common_1.getPullChangesIpcChannel)(iModelDb.iModelId), { loaded, total });
210
+ return checkAbort();
211
+ };
212
+ onProgress = throttleProgressCallback(progressCallback, checkAbort, options?.progressInterval);
213
+ }
214
+ else if (options?.enableCancellation) {
215
+ onProgress = checkAbort;
216
+ }
217
+ try {
218
+ await iModelDb.pullChanges({ toIndex, onProgress });
219
+ }
220
+ finally {
221
+ this._iModelKeyToPullStatus.delete(key);
222
+ }
223
+ return iModelDb.changeset;
224
+ }
225
+ async cancelPullChangesRequest(key) {
226
+ this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Abort);
227
+ }
228
+ async pushChanges(key, description) {
229
+ const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
230
+ await iModelDb.pushChanges({ description });
231
+ return iModelDb.changeset;
232
+ }
233
+ async toggleGraphicalEditingScope(key, startSession) {
234
+ const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
235
+ if (val.error)
236
+ throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
237
+ (0, core_bentley_1.assert)(undefined !== val.result);
238
+ return val.result;
239
+ }
240
+ async isGraphicalEditingSupported(key) {
241
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
242
+ }
243
+ async reverseTxns(key, numOperations) {
244
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
245
+ }
246
+ async reverseAllTxn(key) {
247
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
248
+ }
249
+ async reinstateTxn(key) {
250
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
251
+ }
252
+ async restartTxnSession(key) {
253
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
254
+ }
255
+ async queryConcurrency(pool) {
256
+ return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
257
+ }
258
+ }
259
+ /**
260
+ * Prevents progress callback being called more frequently when provided interval.
261
+ * @internal
262
+ */
263
+ function throttleProgressCallback(func, checkAbort, progressInterval) {
264
+ const interval = progressInterval ?? 250; // by default, only send progress events every 250 milliseconds
265
+ let nextTime = Date.now() + interval;
266
+ const progressCallback = (loaded, total) => {
267
+ const now = Date.now();
268
+ if (loaded >= total || now >= nextTime) {
269
+ nextTime = now + interval;
270
+ return func(loaded, total);
271
+ }
272
+ return checkAbort();
273
+ };
274
+ return progressCallback;
275
+ }
276
+ exports.throttleProgressCallback = throttleProgressCallback;
279
277
  //# sourceMappingURL=IpcHost.js.map