@itwin/core-backend 3.4.0-dev.9 → 3.5.0-dev.4

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 (261) hide show
  1. package/CHANGELOG.md +41 -1
  2. package/lib/cjs/AliCloudStorageService.d.ts +23 -17
  3. package/lib/cjs/AliCloudStorageService.d.ts.map +1 -1
  4. package/lib/cjs/AliCloudStorageService.js +71 -68
  5. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  6. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  7. package/lib/cjs/BackendHubAccess.d.ts.map +1 -1
  8. package/lib/cjs/BackendHubAccess.js +41 -41
  9. package/lib/cjs/BackendHubAccess.js.map +1 -1
  10. package/lib/cjs/BackendLoggerCategory.d.ts +91 -87
  11. package/lib/cjs/BackendLoggerCategory.d.ts.map +1 -1
  12. package/lib/cjs/BackendLoggerCategory.js +99 -95
  13. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  14. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  15. package/lib/cjs/BisCoreSchema.js +60 -60
  16. package/lib/cjs/BisCoreSchema.js.map +1 -1
  17. package/lib/cjs/BriefcaseManager.d.ts +165 -165
  18. package/lib/cjs/BriefcaseManager.js +405 -405
  19. package/lib/cjs/BriefcaseManager.js.map +1 -1
  20. package/lib/cjs/Category.d.ts +153 -153
  21. package/lib/cjs/Category.js +243 -243
  22. package/lib/cjs/Category.js.map +1 -1
  23. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  24. package/lib/cjs/ChangeSummaryManager.js +445 -445
  25. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  26. package/lib/cjs/ChangedElementsDb.d.ts +99 -98
  27. package/lib/cjs/ChangedElementsDb.d.ts.map +1 -1
  28. package/lib/cjs/ChangedElementsDb.js +165 -165
  29. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  30. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  31. package/lib/cjs/ChangedElementsManager.js +88 -88
  32. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  33. package/lib/cjs/CheckpointManager.d.ts +120 -122
  34. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  35. package/lib/cjs/CheckpointManager.js +343 -354
  36. package/lib/cjs/CheckpointManager.js.map +1 -1
  37. package/lib/cjs/ClassRegistry.d.ts +71 -71
  38. package/lib/cjs/ClassRegistry.d.ts.map +1 -1
  39. package/lib/cjs/ClassRegistry.js +215 -213
  40. package/lib/cjs/ClassRegistry.js.map +1 -1
  41. package/lib/cjs/CloudSqlite.d.ts +350 -0
  42. package/lib/cjs/CloudSqlite.d.ts.map +1 -0
  43. package/lib/cjs/CloudSqlite.js +152 -0
  44. package/lib/cjs/CloudSqlite.js.map +1 -0
  45. package/lib/cjs/CloudStorageBackend.d.ts +58 -46
  46. package/lib/cjs/CloudStorageBackend.d.ts.map +1 -1
  47. package/lib/cjs/CloudStorageBackend.js +173 -164
  48. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  49. package/lib/cjs/CodeService.d.ts +397 -0
  50. package/lib/cjs/CodeService.d.ts.map +1 -0
  51. package/lib/cjs/CodeService.js +64 -0
  52. package/lib/cjs/CodeService.js.map +1 -0
  53. package/lib/cjs/CodeSpecs.d.ts +50 -50
  54. package/lib/cjs/CodeSpecs.js +112 -112
  55. package/lib/cjs/CodeSpecs.js.map +1 -1
  56. package/lib/cjs/ConcurrentQuery.d.ts +11 -11
  57. package/lib/cjs/ConcurrentQuery.js +30 -30
  58. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  59. package/lib/cjs/CustomViewState3dCreator.d.ts +32 -32
  60. package/lib/cjs/CustomViewState3dCreator.d.ts.map +1 -1
  61. package/lib/cjs/CustomViewState3dCreator.js +113 -98
  62. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  63. package/lib/cjs/DevTools.d.ts +71 -71
  64. package/lib/cjs/DevTools.d.ts.map +1 -1
  65. package/lib/cjs/DevTools.js +154 -154
  66. package/lib/cjs/DevTools.js.map +1 -1
  67. package/lib/cjs/DisplayStyle.d.ts +106 -106
  68. package/lib/cjs/DisplayStyle.js +256 -256
  69. package/lib/cjs/DisplayStyle.js.map +1 -1
  70. package/lib/cjs/ECDb.d.ts +191 -191
  71. package/lib/cjs/ECDb.js +350 -350
  72. package/lib/cjs/ECDb.js.map +1 -1
  73. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  74. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  75. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  76. package/lib/cjs/ECSqlStatement.d.ts +466 -466
  77. package/lib/cjs/ECSqlStatement.js +791 -791
  78. package/lib/cjs/ECSqlStatement.js.map +1 -1
  79. package/lib/cjs/Element.d.ts +1109 -1109
  80. package/lib/cjs/Element.d.ts.map +1 -1
  81. package/lib/cjs/Element.js +1420 -1417
  82. package/lib/cjs/Element.js.map +1 -1
  83. package/lib/cjs/ElementAspect.d.ts +156 -156
  84. package/lib/cjs/ElementAspect.js +178 -178
  85. package/lib/cjs/ElementAspect.js.map +1 -1
  86. package/lib/cjs/ElementGraphics.d.ts +9 -9
  87. package/lib/cjs/ElementGraphics.js +41 -41
  88. package/lib/cjs/ElementGraphics.js.map +1 -1
  89. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  90. package/lib/cjs/ElementTreeWalker.d.ts.map +1 -1
  91. package/lib/cjs/ElementTreeWalker.js +409 -409
  92. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  93. package/lib/cjs/Entity.d.ts +76 -76
  94. package/lib/cjs/Entity.js +82 -82
  95. package/lib/cjs/Entity.js.map +1 -1
  96. package/lib/cjs/ExportGraphics.d.ts +317 -317
  97. package/lib/cjs/ExportGraphics.d.ts.map +1 -1
  98. package/lib/cjs/ExportGraphics.js +208 -208
  99. package/lib/cjs/ExportGraphics.js.map +1 -1
  100. package/lib/cjs/ExternalSource.d.ts +94 -94
  101. package/lib/cjs/ExternalSource.d.ts.map +1 -1
  102. package/lib/cjs/ExternalSource.js +125 -125
  103. package/lib/cjs/ExternalSource.js.map +1 -1
  104. package/lib/cjs/GeoCoordConfig.d.ts +19 -13
  105. package/lib/cjs/GeoCoordConfig.d.ts.map +1 -1
  106. package/lib/cjs/GeoCoordConfig.js +82 -73
  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 +93 -93
  112. package/lib/cjs/HubMock.d.ts.map +1 -1
  113. package/lib/cjs/HubMock.js +190 -190
  114. package/lib/cjs/HubMock.js.map +1 -1
  115. package/lib/cjs/IModelCloneContext.d.ts +85 -85
  116. package/lib/cjs/IModelCloneContext.js +150 -150
  117. package/lib/cjs/IModelCloneContext.js.map +1 -1
  118. package/lib/cjs/IModelDb.d.ts +1164 -1151
  119. package/lib/cjs/IModelDb.d.ts.map +1 -1
  120. package/lib/cjs/IModelDb.js +2324 -2286
  121. package/lib/cjs/IModelDb.js.map +1 -1
  122. package/lib/cjs/IModelHost.d.ts +361 -347
  123. package/lib/cjs/IModelHost.d.ts.map +1 -1
  124. package/lib/cjs/IModelHost.js +489 -455
  125. package/lib/cjs/IModelHost.js.map +1 -1
  126. package/lib/cjs/IModelJsFs.d.ts +62 -62
  127. package/lib/cjs/IModelJsFs.d.ts.map +1 -1
  128. package/lib/cjs/IModelJsFs.js +140 -140
  129. package/lib/cjs/IModelJsFs.js.map +1 -1
  130. package/lib/cjs/IpcHost.d.ts +98 -98
  131. package/lib/cjs/IpcHost.js +234 -234
  132. package/lib/cjs/IpcHost.js.map +1 -1
  133. package/lib/cjs/LineStyle.d.ts +311 -311
  134. package/lib/cjs/LineStyle.js +295 -295
  135. package/lib/cjs/LineStyle.js.map +1 -1
  136. package/lib/cjs/LocalHub.d.ts +162 -162
  137. package/lib/cjs/LocalHub.js +587 -587
  138. package/lib/cjs/LocalHub.js.map +1 -1
  139. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  140. package/lib/cjs/LocalhostIpcHost.js +81 -81
  141. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  142. package/lib/cjs/Material.d.ts +103 -101
  143. package/lib/cjs/Material.d.ts.map +1 -1
  144. package/lib/cjs/Material.js +147 -145
  145. package/lib/cjs/Material.js.map +1 -1
  146. package/lib/cjs/Model.d.ts +386 -386
  147. package/lib/cjs/Model.d.ts.map +1 -1
  148. package/lib/cjs/Model.js +471 -468
  149. package/lib/cjs/Model.js.map +1 -1
  150. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  151. package/lib/cjs/NativeAppStorage.js +202 -202
  152. package/lib/cjs/NativeAppStorage.js.map +1 -1
  153. package/lib/cjs/NativeHost.d.ts +52 -52
  154. package/lib/cjs/NativeHost.js +168 -168
  155. package/lib/cjs/NativeHost.js.map +1 -1
  156. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  157. package/lib/cjs/NavigationRelationship.js +225 -225
  158. package/lib/cjs/NavigationRelationship.js.map +1 -1
  159. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  160. package/lib/cjs/PromiseMemoizer.d.ts.map +1 -1
  161. package/lib/cjs/PromiseMemoizer.js +101 -95
  162. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  163. package/lib/cjs/PropertyStore.d.ts +133 -0
  164. package/lib/cjs/PropertyStore.d.ts.map +1 -0
  165. package/lib/cjs/PropertyStore.js +12 -0
  166. package/lib/cjs/PropertyStore.js.map +1 -0
  167. package/lib/cjs/Relationship.d.ts +400 -400
  168. package/lib/cjs/Relationship.js +465 -465
  169. package/lib/cjs/Relationship.js.map +1 -1
  170. package/lib/cjs/RpcBackend.d.ts +28 -28
  171. package/lib/cjs/RpcBackend.js +126 -126
  172. package/lib/cjs/RpcBackend.js.map +1 -1
  173. package/lib/cjs/SQLiteDb.d.ts +219 -173
  174. package/lib/cjs/SQLiteDb.d.ts.map +1 -1
  175. package/lib/cjs/SQLiteDb.js +214 -211
  176. package/lib/cjs/SQLiteDb.js.map +1 -1
  177. package/lib/cjs/Schema.d.ts +55 -55
  178. package/lib/cjs/Schema.js +83 -83
  179. package/lib/cjs/Schema.js.map +1 -1
  180. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  181. package/lib/cjs/ServerBasedLocks.js +168 -168
  182. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  183. package/lib/cjs/SqliteStatement.d.ts +283 -271
  184. package/lib/cjs/SqliteStatement.d.ts.map +1 -1
  185. package/lib/cjs/SqliteStatement.js +448 -426
  186. package/lib/cjs/SqliteStatement.js.map +1 -1
  187. package/lib/cjs/Texture.d.ts +58 -58
  188. package/lib/cjs/Texture.js +82 -82
  189. package/lib/cjs/Texture.js.map +1 -1
  190. package/lib/cjs/TileStorage.d.ts +19 -0
  191. package/lib/cjs/TileStorage.d.ts.map +1 -0
  192. package/lib/cjs/TileStorage.js +91 -0
  193. package/lib/cjs/TileStorage.js.map +1 -0
  194. package/lib/cjs/TxnManager.d.ts +202 -202
  195. package/lib/cjs/TxnManager.d.ts.map +1 -1
  196. package/lib/cjs/TxnManager.js +356 -353
  197. package/lib/cjs/TxnManager.js.map +1 -1
  198. package/lib/cjs/ViewDefinition.d.ts +435 -435
  199. package/lib/cjs/ViewDefinition.d.ts.map +1 -1
  200. package/lib/cjs/ViewDefinition.js +635 -629
  201. package/lib/cjs/ViewDefinition.js.map +1 -1
  202. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  203. package/lib/cjs/ViewStateHydrator.js +103 -103
  204. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  205. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  206. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  207. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -21
  208. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  209. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  210. package/lib/cjs/core-backend.d.ts +182 -175
  211. package/lib/cjs/core-backend.d.ts.map +1 -1
  212. package/lib/cjs/core-backend.js +202 -195
  213. package/lib/cjs/core-backend.js.map +1 -1
  214. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  215. package/lib/cjs/domains/FunctionalElements.js +145 -145
  216. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  217. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  218. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  219. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  220. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  221. package/lib/cjs/domains/GenericElements.js +263 -263
  222. package/lib/cjs/domains/GenericElements.js.map +1 -1
  223. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  224. package/lib/cjs/domains/GenericSchema.js +28 -28
  225. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  226. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  227. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  228. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  229. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +45 -45
  230. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +262 -262
  231. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  232. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -20
  233. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  234. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +204 -195
  235. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  236. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  237. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts.map +1 -1
  238. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -165
  239. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  240. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  241. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  242. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  243. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  244. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  245. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  246. package/lib/cjs/workspace/Settings.d.ts +186 -186
  247. package/lib/cjs/workspace/Settings.d.ts.map +1 -1
  248. package/lib/cjs/workspace/Settings.js +155 -152
  249. package/lib/cjs/workspace/Settings.js.map +1 -1
  250. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  251. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  252. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  253. package/lib/cjs/workspace/Workspace.d.ts +414 -401
  254. package/lib/cjs/workspace/Workspace.d.ts.map +1 -1
  255. package/lib/cjs/workspace/Workspace.js +543 -534
  256. package/lib/cjs/workspace/Workspace.js.map +1 -1
  257. package/package.json +18 -19
  258. package/lib/cjs/IModelSchemaLoader.d.ts +0 -26
  259. package/lib/cjs/IModelSchemaLoader.d.ts.map +0 -1
  260. package/lib/cjs/IModelSchemaLoader.js +0 -122
  261. package/lib/cjs/IModelSchemaLoader.js.map +0 -1
@@ -1,235 +1,235 @@
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.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
- /**
17
- * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
18
- * @note if either end terminates, the other must too.
19
- * @public
20
- */
21
- class IpcHost {
22
- /** Get the implementation of the [IpcSocketBackend]($common) interface. */
23
- static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
24
- /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
25
- static get isValid() { return undefined !== this._ipc; }
26
- /**
27
- * Send a message to the frontend over an Ipc channel.
28
- * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
29
- * @param data The content of the message.
30
- */
31
- static send(channel, ...data) {
32
- this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
33
- }
34
- /**
35
- * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
36
- * @param channel The name of the channel for this handler.
37
- * @param handler A function that supplies the implementation for `channel`
38
- * @note returns A function to call to remove the handler.
39
- */
40
- static handle(channel, handler) {
41
- return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
42
- }
43
- /**
44
- * Establish a handler to receive messages sent via [[IpcApp.send]].
45
- * @param channel The name of the channel for the messages.
46
- * @param listener A function called when messages are sent over `channel`
47
- * @note returns A function to call to remove the listener.
48
- */
49
- static addListener(channel, listener) {
50
- return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
51
- }
52
- /**
53
- * Remove a previously registered listener
54
- * @param channel The name of the channel for the listener previously registered with [[addListener]]
55
- * @param listener The function passed to [[addListener]]
56
- */
57
- static removeListener(channel, listener) {
58
- this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
59
- }
60
- static notify(channel, briefcase, methodName, ...args) {
61
- if (this.isValid)
62
- return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
63
- }
64
- /** @internal */
65
- static notifyIpcFrontend(methodName, ...args) {
66
- return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
67
- }
68
- /** @internal */
69
- static notifyTxns(briefcase, methodName, ...args) {
70
- this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
71
- }
72
- /** @internal */
73
- static notifyEditingScope(briefcase, methodName, ...args) {
74
- this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
75
- }
76
- /**
77
- * Start the backend of an Ipc app.
78
- * @param opt
79
- * @note this method calls [[IModelHost.startup]] internally.
80
- */
81
- static async startup(opt) {
82
- var _a, _b, _c;
83
- this._ipc = (_a = opt === null || opt === void 0 ? void 0 : opt.ipcHost) === null || _a === void 0 ? void 0 : _a.socket;
84
- 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)
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 === null || opt === void 0 ? void 0 : 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
- exports.IpcHost = IpcHost;
98
- IpcHost.noStack = false;
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
- var _a;
122
- try {
123
- const func = impl[funcName];
124
- if (typeof func !== "function")
125
- 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}`);
126
- return { result: await func.call(impl, ...args) };
127
- }
128
- catch (err) {
129
- const ret = {
130
- error: {
131
- name: (err && typeof err === "object") ? err.constructor.name : "Unknown Error",
132
- message: core_bentley_1.BentleyError.getErrorMessage(err),
133
- errorNumber: (_a = err.errorNumber) !== null && _a !== void 0 ? _a : 0,
134
- },
135
- };
136
- if (!IpcHost.noStack)
137
- ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
138
- return ret;
139
- }
140
- });
141
- }
142
- }
143
- exports.IpcHandler = IpcHandler;
144
- /**
145
- * Implementation of IpcAppFunctions
146
- */
147
- class IpcAppHandler extends IpcHandler {
148
- get channelName() { return core_common_1.IpcAppChannel.Functions; }
149
- async log(_timestamp, level, category, message, metaData) {
150
- switch (level) {
151
- case core_bentley_1.LogLevel.Error:
152
- core_bentley_1.Logger.logError(category, message, metaData);
153
- break;
154
- case core_bentley_1.LogLevel.Info:
155
- core_bentley_1.Logger.logInfo(category, message, metaData);
156
- break;
157
- case core_bentley_1.LogLevel.Trace:
158
- core_bentley_1.Logger.logTrace(category, message, metaData);
159
- break;
160
- case core_bentley_1.LogLevel.Warning:
161
- core_bentley_1.Logger.logWarning(category, message, metaData);
162
- break;
163
- }
164
- }
165
- async cancelTileContentRequests(tokenProps, contentIds) {
166
- return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
167
- }
168
- async cancelElementGraphicsRequests(key, requestIds) {
169
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
170
- }
171
- async openBriefcase(args) {
172
- const db = await IModelDb_1.BriefcaseDb.open(args);
173
- return db.toJSON();
174
- }
175
- async openStandalone(filePath, openMode, opts) {
176
- return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
177
- }
178
- async closeIModel(key) {
179
- IModelDb_1.IModelDb.findByKey(key).close();
180
- }
181
- async saveChanges(key, description) {
182
- IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
183
- }
184
- async hasPendingTxns(key) {
185
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
186
- }
187
- async isUndoPossible(key) {
188
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
189
- }
190
- async isRedoPossible(key) {
191
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
192
- }
193
- async getUndoString(key) {
194
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
195
- }
196
- async getRedoString(key) {
197
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
198
- }
199
- async pullChanges(key, toIndex) {
200
- const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
201
- await iModelDb.pullChanges({ toIndex });
202
- return iModelDb.changeset;
203
- }
204
- async pushChanges(key, description) {
205
- const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
206
- await iModelDb.pushChanges({ description });
207
- return iModelDb.changeset;
208
- }
209
- async toggleGraphicalEditingScope(key, startSession) {
210
- const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
211
- if (val.error)
212
- throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
213
- (0, core_bentley_1.assert)(undefined !== val.result);
214
- return val.result;
215
- }
216
- async isGraphicalEditingSupported(key) {
217
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
218
- }
219
- async reverseTxns(key, numOperations) {
220
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
221
- }
222
- async reverseAllTxn(key) {
223
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
224
- }
225
- async reinstateTxn(key) {
226
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
227
- }
228
- async restartTxnSession(key) {
229
- return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
230
- }
231
- async queryConcurrency(pool) {
232
- return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
233
- }
234
- }
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.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
+ /**
17
+ * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
18
+ * @note if either end terminates, the other must too.
19
+ * @public
20
+ */
21
+ class IpcHost {
22
+ /** Get the implementation of the [IpcSocketBackend]($common) interface. */
23
+ static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
24
+ /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
25
+ static get isValid() { return undefined !== this._ipc; }
26
+ /**
27
+ * Send a message to the frontend over an Ipc channel.
28
+ * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
29
+ * @param data The content of the message.
30
+ */
31
+ static send(channel, ...data) {
32
+ this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
33
+ }
34
+ /**
35
+ * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
36
+ * @param channel The name of the channel for this handler.
37
+ * @param handler A function that supplies the implementation for `channel`
38
+ * @note returns A function to call to remove the handler.
39
+ */
40
+ static handle(channel, handler) {
41
+ return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
42
+ }
43
+ /**
44
+ * Establish a handler to receive messages sent via [[IpcApp.send]].
45
+ * @param channel The name of the channel for the messages.
46
+ * @param listener A function called when messages are sent over `channel`
47
+ * @note returns A function to call to remove the listener.
48
+ */
49
+ static addListener(channel, listener) {
50
+ return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
51
+ }
52
+ /**
53
+ * Remove a previously registered listener
54
+ * @param channel The name of the channel for the listener previously registered with [[addListener]]
55
+ * @param listener The function passed to [[addListener]]
56
+ */
57
+ static removeListener(channel, listener) {
58
+ this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
59
+ }
60
+ static notify(channel, briefcase, methodName, ...args) {
61
+ if (this.isValid)
62
+ return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
63
+ }
64
+ /** @internal */
65
+ static notifyIpcFrontend(methodName, ...args) {
66
+ return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
67
+ }
68
+ /** @internal */
69
+ static notifyTxns(briefcase, methodName, ...args) {
70
+ this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
71
+ }
72
+ /** @internal */
73
+ static notifyEditingScope(briefcase, methodName, ...args) {
74
+ this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
75
+ }
76
+ /**
77
+ * Start the backend of an Ipc app.
78
+ * @param opt
79
+ * @note this method calls [[IModelHost.startup]] internally.
80
+ */
81
+ static async startup(opt) {
82
+ var _a, _b, _c;
83
+ this._ipc = (_a = opt === null || opt === void 0 ? void 0 : opt.ipcHost) === null || _a === void 0 ? void 0 : _a.socket;
84
+ 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)
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 === null || opt === void 0 ? void 0 : 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
+ exports.IpcHost = IpcHost;
98
+ IpcHost.noStack = false;
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
+ var _a;
122
+ try {
123
+ const func = impl[funcName];
124
+ if (typeof func !== "function")
125
+ 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}`);
126
+ return { result: await func.call(impl, ...args) };
127
+ }
128
+ catch (err) {
129
+ const ret = {
130
+ error: {
131
+ name: (err && typeof err === "object") ? err.constructor.name : "Unknown Error",
132
+ message: core_bentley_1.BentleyError.getErrorMessage(err),
133
+ errorNumber: (_a = err.errorNumber) !== null && _a !== void 0 ? _a : 0,
134
+ },
135
+ };
136
+ if (!IpcHost.noStack)
137
+ ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
138
+ return ret;
139
+ }
140
+ });
141
+ }
142
+ }
143
+ exports.IpcHandler = IpcHandler;
144
+ /**
145
+ * Implementation of IpcAppFunctions
146
+ */
147
+ class IpcAppHandler extends IpcHandler {
148
+ get channelName() { return core_common_1.IpcAppChannel.Functions; }
149
+ async log(_timestamp, level, category, message, metaData) {
150
+ switch (level) {
151
+ case core_bentley_1.LogLevel.Error:
152
+ core_bentley_1.Logger.logError(category, message, metaData);
153
+ break;
154
+ case core_bentley_1.LogLevel.Info:
155
+ core_bentley_1.Logger.logInfo(category, message, metaData);
156
+ break;
157
+ case core_bentley_1.LogLevel.Trace:
158
+ core_bentley_1.Logger.logTrace(category, message, metaData);
159
+ break;
160
+ case core_bentley_1.LogLevel.Warning:
161
+ core_bentley_1.Logger.logWarning(category, message, metaData);
162
+ break;
163
+ }
164
+ }
165
+ async cancelTileContentRequests(tokenProps, contentIds) {
166
+ return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
167
+ }
168
+ async cancelElementGraphicsRequests(key, requestIds) {
169
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
170
+ }
171
+ async openBriefcase(args) {
172
+ const db = await IModelDb_1.BriefcaseDb.open(args);
173
+ return db.toJSON();
174
+ }
175
+ async openStandalone(filePath, openMode, opts) {
176
+ return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
177
+ }
178
+ async closeIModel(key) {
179
+ IModelDb_1.IModelDb.findByKey(key).close();
180
+ }
181
+ async saveChanges(key, description) {
182
+ IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
183
+ }
184
+ async hasPendingTxns(key) {
185
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
186
+ }
187
+ async isUndoPossible(key) {
188
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
189
+ }
190
+ async isRedoPossible(key) {
191
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
192
+ }
193
+ async getUndoString(key) {
194
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
195
+ }
196
+ async getRedoString(key) {
197
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
198
+ }
199
+ async pullChanges(key, toIndex) {
200
+ const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
201
+ await iModelDb.pullChanges({ toIndex });
202
+ return iModelDb.changeset;
203
+ }
204
+ async pushChanges(key, description) {
205
+ const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
206
+ await iModelDb.pushChanges({ description });
207
+ return iModelDb.changeset;
208
+ }
209
+ async toggleGraphicalEditingScope(key, startSession) {
210
+ const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
211
+ if (val.error)
212
+ throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
213
+ (0, core_bentley_1.assert)(undefined !== val.result);
214
+ return val.result;
215
+ }
216
+ async isGraphicalEditingSupported(key) {
217
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
218
+ }
219
+ async reverseTxns(key, numOperations) {
220
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
221
+ }
222
+ async reverseAllTxn(key) {
223
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
224
+ }
225
+ async reinstateTxn(key) {
226
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
227
+ }
228
+ async restartTxnSession(key) {
229
+ return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
230
+ }
231
+ async queryConcurrency(pool) {
232
+ return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
233
+ }
234
+ }
235
235
  //# sourceMappingURL=IpcHost.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"IpcHost.js","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqG;AACrG,oDAI4B;AAE5B,yCAAiE;AACjE,6CAA6D;AAC7D,oEAAyE;AAmBzE;;;;GAIG;AACH,MAAa,OAAO;IAGlB,2EAA2E;IACnE,MAAM,KAAK,GAAG,KAAuB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,+DAA+D;IACjI,gIAAgI;IACzH,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,OAAyC;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,QAAqB;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,QAAqB;QACjE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,SAAqC,EAAE,UAAkB,EAAE,GAAG,IAAW;QAC9G,IAAI,IAAI,CAAC,OAAO;YACd,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAAsC,UAAa,EAAE,GAAG,IAAwC;QAC7H,OAAO,OAAO,CAAC,IAAI,CAAC,2BAAa,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAmC,SAAqC,EAAE,UAAa,EAAE,GAAG,IAAqC;QACvJ,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAA4C,SAAqC,EAAE,UAAa,EAAE,GAAG,IAA8C;QACjL,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAiB;;QAC3C,IAAI,CAAC,IAAI,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,MAAM,CAAC;QACjC,IAAI,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,UAAU,0CAAE,OAAO;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,sDAAsD;YACxE,aAAa,CAAC,QAAQ,EAAE,CAAC;SAC1B;QAED,MAAM,uBAAU,CAAC,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,uBAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;;AArFH,0BAsFC;AArFe,eAAO,GAAG,KAAK,CAAC;AAuFhC;;;;;;;;;;;GAWG;AACH,MAAsB,UAAU;IAI9B;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,MAAM,IAAI,GAAG,IAAK,IAAY,EAAgB,CAAC,CAAC,uFAAuF;QACvI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAA4B,EAAE;;YACxH,IAAI;gBACF,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;gBACrC,IAAI,OAAO,IAAI,KAAK,UAAU;oBAC5B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,qDAAqD,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;gBAE5K,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;aACnD;YAAC,OAAO,GAAQ,EAAE;gBACjB,MAAM,GAAG,GAAoB;oBAC3B,KAAK,EAAE;wBACL,IAAI,EAAE,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBAC/E,OAAO,EAAE,2BAAY,CAAC,eAAe,CAAC,GAAG,CAAC;wBAC1C,WAAW,EAAE,MAAA,GAAG,CAAC,WAAW,mCAAI,CAAC;qBAClC;iBACF,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,OAAO;oBAClB,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,2BAAY,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACpD,OAAO,GAAG,CAAC;aACZ;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,gCAiCC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,UAAU;IACpC,IAAW,WAAW,KAAK,OAAO,2BAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAErD,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,KAAe,EAAE,QAAgB,EAAE,OAAe,EAAE,QAAc;QACrG,QAAQ,KAAK,EAAE;YACb,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,IAAI;gBAChB,qBAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,OAAO;gBACnB,qBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC/C,MAAM;SACT;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAA0B,EAAE,UAAgC;QACjG,OAAO,IAAA,6CAAyB,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,6BAA6B,CAAC,GAAW,EAAE,UAAoB;QAC1E,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,IAAwB;QACjD,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,QAAkB,EAAE,IAA4B;QAC5F,OAAO,uBAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9E,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW;QAClC,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAoB;QACxD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC5D,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAmB;QACvD,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,GAAW,EAAE,YAAqB;QACzE,MAAM,GAAG,GAAqD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;QAC9I,IAAI,GAAG,CAAC,KAAK;YACX,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;QACtF,IAAA,qBAAM,EAAC,SAAS,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;IACM,KAAK,CAAC,2BAA2B,CAAC,GAAW;QAClD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iCAAiC,EAAE,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,aAAqB;QACzD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACvD,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;IACzD,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,GAAW;QACxC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAkB;QAC9C,OAAO,uBAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { assert, BentleyError, IModelStatus, Logger, LogLevel, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n ChangesetIndex, ChangesetIndexAndId, EditingScopeNotifications, IModelConnectionProps, IModelError, IModelRpcProps, IpcAppChannel, IpcAppFunctions,\r\n IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketBackend, iTwinChannel, OpenBriefcaseProps, RemoveFunction, StandaloneOpenOptions,\r\n TileTreeContentIds, TxnNotifications,\r\n} from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { BriefcaseDb, IModelDb, StandaloneDb } from \"./IModelDb\";\r\nimport { IModelHost, IModelHostOptions } from \"./IModelHost\";\r\nimport { cancelTileContentRequests } from \"./rpc-impl/IModelTileRpcImpl\";\r\n\r\n/**\r\n * Options for [[IpcHost.startup]]\r\n * @public\r\n */\r\nexport interface IpcHostOpts {\r\n iModelHost?: IModelHostOptions;\r\n ipcHost?: {\r\n /** The Ipc socket to use for communications with frontend. Allows undefined only for headless tests. */\r\n socket?: IpcSocketBackend;\r\n\r\n /** don't send stack information on exceptions */\r\n exceptions?: {\r\n noStack?: boolean;\r\n };\r\n };\r\n}\r\n\r\n/**\r\n * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.\r\n * @note if either end terminates, the other must too.\r\n * @public\r\n */\r\nexport class IpcHost {\r\n public static noStack = false;\r\n private static _ipc: IpcSocketBackend | undefined;\r\n /** Get the implementation of the [IpcSocketBackend]($common) interface. */\r\n private static get ipc(): IpcSocketBackend { return this._ipc!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */\r\n public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n /**\r\n * Send a message to the frontend over an Ipc channel.\r\n * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].\r\n * @param data The content of the message.\r\n */\r\n public static send(channel: string, ...data: any[]): void {\r\n this.ipc.send(iTwinChannel(channel), ...data);\r\n }\r\n\r\n /**\r\n * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls\r\n * @param channel The name of the channel for this handler.\r\n * @param handler A function that supplies the implementation for `channel`\r\n * @note returns A function to call to remove the handler.\r\n */\r\n public static handle(channel: string, handler: (...args: any[]) => Promise<any>): RemoveFunction {\r\n return this.ipc.handle(iTwinChannel(channel), handler);\r\n }\r\n /**\r\n * Establish a handler to receive messages sent via [[IpcApp.send]].\r\n * @param channel The name of the channel for the messages.\r\n * @param listener A function called when messages are sent over `channel`\r\n * @note returns A function to call to remove the listener.\r\n */\r\n public static addListener(channel: string, listener: IpcListener): RemoveFunction {\r\n return this.ipc.addListener(iTwinChannel(channel), listener);\r\n }\r\n /**\r\n * Remove a previously registered listener\r\n * @param channel The name of the channel for the listener previously registered with [[addListener]]\r\n * @param listener The function passed to [[addListener]]\r\n */\r\n public static removeListener(channel: string, listener: IpcListener): void {\r\n this.ipc.removeListener(iTwinChannel(channel), listener);\r\n }\r\n\r\n private static notify(channel: string, briefcase: BriefcaseDb | StandaloneDb, methodName: string, ...args: any[]) {\r\n if (this.isValid)\r\n return this.send(`${channel}:${briefcase.key}`, methodName, ...args);\r\n }\r\n\r\n /** @internal */\r\n public static notifyIpcFrontend<T extends keyof IpcAppNotifications>(methodName: T, ...args: Parameters<IpcAppNotifications[T]>) {\r\n return IpcHost.send(IpcAppChannel.AppNotify, methodName, ...args);\r\n }\r\n\r\n /** @internal */\r\n public static notifyTxns<T extends keyof TxnNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<TxnNotifications[T]>) {\r\n this.notify(IpcAppChannel.Txns, briefcase, methodName, ...args);\r\n }\r\n\r\n /** @internal */\r\n public static notifyEditingScope<T extends keyof EditingScopeNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<EditingScopeNotifications[T]>) {\r\n this.notify(IpcAppChannel.EditingScope, briefcase, methodName, ...args);\r\n }\r\n\r\n /**\r\n * Start the backend of an Ipc app.\r\n * @param opt\r\n * @note this method calls [[IModelHost.startup]] internally.\r\n */\r\n public static async startup(opt?: IpcHostOpts): Promise<void> {\r\n this._ipc = opt?.ipcHost?.socket;\r\n if (opt?.ipcHost?.exceptions?.noStack)\r\n this.noStack = true;\r\n\r\n if (this.isValid) { // for tests, we use IpcHost but don't have a frontend\r\n IpcAppHandler.register();\r\n }\r\n\r\n await IModelHost.startup(opt?.iModelHost);\r\n }\r\n\r\n /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */\r\n public static async shutdown(): Promise<void> {\r\n this._ipc = undefined;\r\n await IModelHost.shutdown();\r\n }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc interface.\r\n *\r\n * Create a subclass to implement your Ipc interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyHandler extends IpcHandler implements MyInterface\r\n * ```\r\n * to ensure all methods and signatures are correct.\r\n *\r\n * Then, call `MyClass.register` at startup to connect your class to your channel.\r\n * @public\r\n */\r\nexport abstract class IpcHandler {\r\n /** All subclasses must implement this method to specify their channel name. */\r\n public abstract get channelName(): string;\r\n\r\n /**\r\n * Register this class as the handler for methods on its channel. This static method creates a new instance\r\n * that becomes the handler and is `this` when its methods are called.\r\n * @returns A function that can be called to remove the handler.\r\n * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.\r\n */\r\n public static register(): RemoveFunction {\r\n const impl = new (this as any)() as IpcHandler; // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n return IpcHost.handle(impl.channelName, async (_evt: Event, funcName: string, ...args: any[]): Promise<IpcInvokeReturn> => {\r\n try {\r\n const func = (impl as any)[funcName];\r\n if (typeof func !== \"function\")\r\n throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${impl.constructor.name}.${funcName}\" not found on IpcHandler registered for channel: ${impl.channelName}`);\r\n\r\n return { result: await func.call(impl, ...args) };\r\n } catch (err: any) {\r\n const ret: IpcInvokeReturn = {\r\n error: {\r\n name: (err && typeof err === \"object\") ? err.constructor.name : \"Unknown Error\",\r\n message: BentleyError.getErrorMessage(err),\r\n errorNumber: err.errorNumber ?? 0,\r\n },\r\n };\r\n if (!IpcHost.noStack)\r\n ret.error.stack = BentleyError.getErrorStack(err);\r\n return ret;\r\n }\r\n });\r\n }\r\n}\r\n\r\n/**\r\n * Implementation of IpcAppFunctions\r\n */\r\nclass IpcAppHandler extends IpcHandler implements IpcAppFunctions {\r\n public get channelName() { return IpcAppChannel.Functions; }\r\n\r\n public async log(_timestamp: number, level: LogLevel, category: string, message: string, metaData?: any): Promise<void> {\r\n switch (level) {\r\n case LogLevel.Error:\r\n Logger.logError(category, message, metaData);\r\n break;\r\n case LogLevel.Info:\r\n Logger.logInfo(category, message, metaData);\r\n break;\r\n case LogLevel.Trace:\r\n Logger.logTrace(category, message, metaData);\r\n break;\r\n case LogLevel.Warning:\r\n Logger.logWarning(category, message, metaData);\r\n break;\r\n }\r\n }\r\n\r\n public async cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void> {\r\n return cancelTileContentRequests(tokenProps, contentIds);\r\n }\r\n public async cancelElementGraphicsRequests(key: string, requestIds: string[]): Promise<void> {\r\n return IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);\r\n }\r\n public async openBriefcase(args: OpenBriefcaseProps): Promise<IModelConnectionProps> {\r\n const db = await BriefcaseDb.open(args);\r\n return db.toJSON();\r\n }\r\n public async openStandalone(filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions): Promise<IModelConnectionProps> {\r\n return StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();\r\n }\r\n public async closeIModel(key: string): Promise<void> {\r\n IModelDb.findByKey(key).close();\r\n }\r\n public async saveChanges(key: string, description?: string): Promise<void> {\r\n IModelDb.findByKey(key).saveChanges(description);\r\n }\r\n public async hasPendingTxns(key: string): Promise<boolean> {\r\n return IModelDb.findByKey(key).nativeDb.hasPendingTxns();\r\n }\r\n\r\n public async isUndoPossible(key: string): Promise<boolean> {\r\n return IModelDb.findByKey(key).nativeDb.isUndoPossible();\r\n }\r\n public async isRedoPossible(key: string): Promise<boolean> {\r\n return IModelDb.findByKey(key).nativeDb.isRedoPossible();\r\n }\r\n public async getUndoString(key: string): Promise<string> {\r\n return IModelDb.findByKey(key).nativeDb.getUndoString();\r\n }\r\n public async getRedoString(key: string): Promise<string> {\r\n return IModelDb.findByKey(key).nativeDb.getUndoString();\r\n }\r\n\r\n public async pullChanges(key: string, toIndex?: ChangesetIndex): Promise<ChangesetIndexAndId> {\r\n const iModelDb = BriefcaseDb.findByKey(key);\r\n await iModelDb.pullChanges({ toIndex });\r\n return iModelDb.changeset as ChangesetIndexAndId;\r\n }\r\n public async pushChanges(key: string, description: string): Promise<ChangesetIndexAndId> {\r\n const iModelDb = BriefcaseDb.findByKey(key);\r\n await iModelDb.pushChanges({ description });\r\n return iModelDb.changeset as ChangesetIndexAndId;\r\n }\r\n\r\n public async toggleGraphicalEditingScope(key: string, startSession: boolean): Promise<boolean> {\r\n const val: IModelJsNative.ErrorStatusOrResult<any, boolean> = IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);\r\n if (val.error)\r\n throw new IModelError(val.error.status, \"Failed to toggle graphical editing scope\");\r\n assert(undefined !== val.result);\r\n return val.result;\r\n }\r\n public async isGraphicalEditingSupported(key: string): Promise<boolean> {\r\n return IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();\r\n }\r\n\r\n public async reverseTxns(key: string, numOperations: number): Promise<IModelStatus> {\r\n return IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);\r\n }\r\n public async reverseAllTxn(key: string): Promise<IModelStatus> {\r\n return IModelDb.findByKey(key).nativeDb.reverseAll();\r\n }\r\n public async reinstateTxn(key: string): Promise<IModelStatus> {\r\n return IModelDb.findByKey(key).nativeDb.reinstateTxn();\r\n }\r\n public async restartTxnSession(key: string): Promise<void> {\r\n return IModelDb.findByKey(key).nativeDb.restartTxnSession();\r\n }\r\n\r\n public async queryConcurrency(pool: \"io\" | \"cpu\"): Promise<number> {\r\n return IModelHost.platform.queryConcurrency(pool);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"IpcHost.js","sourceRoot":"","sources":["../../src/IpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAqG;AACrG,oDAI4B;AAE5B,yCAAiE;AACjE,6CAA6D;AAC7D,oEAAyE;AAmBzE;;;;GAIG;AACH,MAAa,OAAO;IAGlB,2EAA2E;IACnE,MAAM,KAAK,GAAG,KAAuB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC,CAAC,+DAA+D;IACjI,gIAAgI;IACzH,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,OAAyC;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,QAAqB;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,QAAqB;QACjE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,IAAA,0BAAY,EAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,SAAqC,EAAE,UAAkB,EAAE,GAAG,IAAW;QAC9G,IAAI,IAAI,CAAC,OAAO;YACd,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAAsC,UAAa,EAAE,GAAG,IAAwC;QAC7H,OAAO,OAAO,CAAC,IAAI,CAAC,2BAAa,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,UAAU,CAAmC,SAAqC,EAAE,UAAa,EAAE,GAAG,IAAqC;QACvJ,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAA4C,SAAqC,EAAE,UAAa,EAAE,GAAG,IAA8C;QACjL,IAAI,CAAC,MAAM,CAAC,2BAAa,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAiB;;QAC3C,IAAI,CAAC,IAAI,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,MAAM,CAAC;QACjC,IAAI,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,UAAU,0CAAE,OAAO;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,sDAAsD;YACxE,aAAa,CAAC,QAAQ,EAAE,CAAC;SAC1B;QAED,MAAM,uBAAU,CAAC,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,mEAAmE;IAC5D,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,uBAAU,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;;AArFH,0BAsFC;AArFe,eAAO,GAAG,KAAK,CAAC;AAuFhC;;;;;;;;;;;GAWG;AACH,MAAsB,UAAU;IAI9B;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,MAAM,IAAI,GAAG,IAAK,IAAY,EAAgB,CAAC,CAAC,uFAAuF;QACvI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAA4B,EAAE;;YACxH,IAAI;gBACF,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;gBACrC,IAAI,OAAO,IAAI,KAAK,UAAU;oBAC5B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,qDAAqD,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;gBAE5K,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;aACnD;YAAC,OAAO,GAAQ,EAAE;gBACjB,MAAM,GAAG,GAAoB;oBAC3B,KAAK,EAAE;wBACL,IAAI,EAAE,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBAC/E,OAAO,EAAE,2BAAY,CAAC,eAAe,CAAC,GAAG,CAAC;wBAC1C,WAAW,EAAE,MAAA,GAAG,CAAC,WAAW,mCAAI,CAAC;qBAClC;iBACF,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,OAAO;oBAClB,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,2BAAY,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBACpD,OAAO,GAAG,CAAC;aACZ;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,gCAiCC;AAED;;GAEG;AACH,MAAM,aAAc,SAAQ,UAAU;IACpC,IAAW,WAAW,KAAK,OAAO,2BAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAErD,KAAK,CAAC,GAAG,CAAC,UAAkB,EAAE,KAAe,EAAE,QAAgB,EAAE,OAAe,EAAE,QAAc;QACrG,QAAQ,KAAK,EAAE;YACb,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,IAAI;gBAChB,qBAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC5C,MAAM;YACR,KAAK,uBAAQ,CAAC,KAAK;gBACjB,qBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC7C,MAAM;YACR,KAAK,uBAAQ,CAAC,OAAO;gBACnB,qBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC/C,MAAM;SACT;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAA0B,EAAE,UAAgC;QACjG,OAAO,IAAA,6CAAyB,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,6BAA6B,CAAC,GAAW,EAAE,UAAoB;QAC1E,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,IAAwB;QACjD,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,QAAkB,EAAE,IAA4B;QAC5F,OAAO,uBAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9E,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW;QAClC,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAoB;QACxD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,cAAc,CAAC,GAAW;QACrC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IAC3D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,OAAwB;QAC5D,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IACM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,WAAmB;QACvD,MAAM,QAAQ,GAAG,sBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,SAAgC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,GAAW,EAAE,YAAqB;QACzE,MAAM,GAAG,GAAqD,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;QAC9I,IAAI,GAAG,CAAC,KAAK;YACX,MAAM,IAAI,yBAAW,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;QACtF,IAAA,qBAAM,EAAC,SAAS,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC,MAAM,CAAC;IACpB,CAAC;IACM,KAAK,CAAC,2BAA2B,CAAC,GAAW;QAClD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iCAAiC,EAAE,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,aAAqB;QACzD,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,aAAa,CAAC,GAAW;QACpC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;IACvD,CAAC;IACM,KAAK,CAAC,YAAY,CAAC,GAAW;QACnC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;IACzD,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,GAAW;QACxC,OAAO,mBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,IAAkB;QAC9C,OAAO,uBAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { assert, BentleyError, IModelStatus, Logger, LogLevel, OpenMode } from \"@itwin/core-bentley\";\nimport {\n ChangesetIndex, ChangesetIndexAndId, EditingScopeNotifications, IModelConnectionProps, IModelError, IModelRpcProps, IpcAppChannel, IpcAppFunctions,\n IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketBackend, iTwinChannel, OpenBriefcaseProps, RemoveFunction, StandaloneOpenOptions,\n TileTreeContentIds, TxnNotifications,\n} from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { BriefcaseDb, IModelDb, StandaloneDb } from \"./IModelDb\";\nimport { IModelHost, IModelHostOptions } from \"./IModelHost\";\nimport { cancelTileContentRequests } from \"./rpc-impl/IModelTileRpcImpl\";\n\n/**\n * Options for [[IpcHost.startup]]\n * @public\n */\nexport interface IpcHostOpts {\n iModelHost?: IModelHostOptions;\n ipcHost?: {\n /** The Ipc socket to use for communications with frontend. Allows undefined only for headless tests. */\n socket?: IpcSocketBackend;\n\n /** don't send stack information on exceptions */\n exceptions?: {\n noStack?: boolean;\n };\n };\n}\n\n/**\n * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.\n * @note if either end terminates, the other must too.\n * @public\n */\nexport class IpcHost {\n public static noStack = false;\n private static _ipc: IpcSocketBackend | undefined;\n /** Get the implementation of the [IpcSocketBackend]($common) interface. */\n private static get ipc(): IpcSocketBackend { return this._ipc!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\n /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */\n public static get isValid(): boolean { return undefined !== this._ipc; }\n\n /**\n * Send a message to the frontend over an Ipc channel.\n * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].\n * @param data The content of the message.\n */\n public static send(channel: string, ...data: any[]): void {\n this.ipc.send(iTwinChannel(channel), ...data);\n }\n\n /**\n * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls\n * @param channel The name of the channel for this handler.\n * @param handler A function that supplies the implementation for `channel`\n * @note returns A function to call to remove the handler.\n */\n public static handle(channel: string, handler: (...args: any[]) => Promise<any>): RemoveFunction {\n return this.ipc.handle(iTwinChannel(channel), handler);\n }\n /**\n * Establish a handler to receive messages sent via [[IpcApp.send]].\n * @param channel The name of the channel for the messages.\n * @param listener A function called when messages are sent over `channel`\n * @note returns A function to call to remove the listener.\n */\n public static addListener(channel: string, listener: IpcListener): RemoveFunction {\n return this.ipc.addListener(iTwinChannel(channel), listener);\n }\n /**\n * Remove a previously registered listener\n * @param channel The name of the channel for the listener previously registered with [[addListener]]\n * @param listener The function passed to [[addListener]]\n */\n public static removeListener(channel: string, listener: IpcListener): void {\n this.ipc.removeListener(iTwinChannel(channel), listener);\n }\n\n private static notify(channel: string, briefcase: BriefcaseDb | StandaloneDb, methodName: string, ...args: any[]) {\n if (this.isValid)\n return this.send(`${channel}:${briefcase.key}`, methodName, ...args);\n }\n\n /** @internal */\n public static notifyIpcFrontend<T extends keyof IpcAppNotifications>(methodName: T, ...args: Parameters<IpcAppNotifications[T]>) {\n return IpcHost.send(IpcAppChannel.AppNotify, methodName, ...args);\n }\n\n /** @internal */\n public static notifyTxns<T extends keyof TxnNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<TxnNotifications[T]>) {\n this.notify(IpcAppChannel.Txns, briefcase, methodName, ...args);\n }\n\n /** @internal */\n public static notifyEditingScope<T extends keyof EditingScopeNotifications>(briefcase: BriefcaseDb | StandaloneDb, methodName: T, ...args: Parameters<EditingScopeNotifications[T]>) {\n this.notify(IpcAppChannel.EditingScope, briefcase, methodName, ...args);\n }\n\n /**\n * Start the backend of an Ipc app.\n * @param opt\n * @note this method calls [[IModelHost.startup]] internally.\n */\n public static async startup(opt?: IpcHostOpts): Promise<void> {\n this._ipc = opt?.ipcHost?.socket;\n if (opt?.ipcHost?.exceptions?.noStack)\n this.noStack = true;\n\n if (this.isValid) { // for tests, we use IpcHost but don't have a frontend\n IpcAppHandler.register();\n }\n\n await IModelHost.startup(opt?.iModelHost);\n }\n\n /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */\n public static async shutdown(): Promise<void> {\n this._ipc = undefined;\n await IModelHost.shutdown();\n }\n}\n\n/**\n * Base class for all implementations of an Ipc interface.\n *\n * Create a subclass to implement your Ipc interface. Your class should be declared like this:\n * ```ts\n * class MyHandler extends IpcHandler implements MyInterface\n * ```\n * to ensure all methods and signatures are correct.\n *\n * Then, call `MyClass.register` at startup to connect your class to your channel.\n * @public\n */\nexport abstract class IpcHandler {\n /** All subclasses must implement this method to specify their channel name. */\n public abstract get channelName(): string;\n\n /**\n * Register this class as the handler for methods on its channel. This static method creates a new instance\n * that becomes the handler and is `this` when its methods are called.\n * @returns A function that can be called to remove the handler.\n * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.\n */\n public static register(): RemoveFunction {\n const impl = new (this as any)() as IpcHandler; // create an instance of subclass. \"as any\" is necessary because base class is abstract\n return IpcHost.handle(impl.channelName, async (_evt: Event, funcName: string, ...args: any[]): Promise<IpcInvokeReturn> => {\n try {\n const func = (impl as any)[funcName];\n if (typeof func !== \"function\")\n throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${impl.constructor.name}.${funcName}\" not found on IpcHandler registered for channel: ${impl.channelName}`);\n\n return { result: await func.call(impl, ...args) };\n } catch (err: any) {\n const ret: IpcInvokeReturn = {\n error: {\n name: (err && typeof err === \"object\") ? err.constructor.name : \"Unknown Error\",\n message: BentleyError.getErrorMessage(err),\n errorNumber: err.errorNumber ?? 0,\n },\n };\n if (!IpcHost.noStack)\n ret.error.stack = BentleyError.getErrorStack(err);\n return ret;\n }\n });\n }\n}\n\n/**\n * Implementation of IpcAppFunctions\n */\nclass IpcAppHandler extends IpcHandler implements IpcAppFunctions {\n public get channelName() { return IpcAppChannel.Functions; }\n\n public async log(_timestamp: number, level: LogLevel, category: string, message: string, metaData?: any): Promise<void> {\n switch (level) {\n case LogLevel.Error:\n Logger.logError(category, message, metaData);\n break;\n case LogLevel.Info:\n Logger.logInfo(category, message, metaData);\n break;\n case LogLevel.Trace:\n Logger.logTrace(category, message, metaData);\n break;\n case LogLevel.Warning:\n Logger.logWarning(category, message, metaData);\n break;\n }\n }\n\n public async cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void> {\n return cancelTileContentRequests(tokenProps, contentIds);\n }\n public async cancelElementGraphicsRequests(key: string, requestIds: string[]): Promise<void> {\n return IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);\n }\n public async openBriefcase(args: OpenBriefcaseProps): Promise<IModelConnectionProps> {\n const db = await BriefcaseDb.open(args);\n return db.toJSON();\n }\n public async openStandalone(filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions): Promise<IModelConnectionProps> {\n return StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();\n }\n public async closeIModel(key: string): Promise<void> {\n IModelDb.findByKey(key).close();\n }\n public async saveChanges(key: string, description?: string): Promise<void> {\n IModelDb.findByKey(key).saveChanges(description);\n }\n public async hasPendingTxns(key: string): Promise<boolean> {\n return IModelDb.findByKey(key).nativeDb.hasPendingTxns();\n }\n\n public async isUndoPossible(key: string): Promise<boolean> {\n return IModelDb.findByKey(key).nativeDb.isUndoPossible();\n }\n public async isRedoPossible(key: string): Promise<boolean> {\n return IModelDb.findByKey(key).nativeDb.isRedoPossible();\n }\n public async getUndoString(key: string): Promise<string> {\n return IModelDb.findByKey(key).nativeDb.getUndoString();\n }\n public async getRedoString(key: string): Promise<string> {\n return IModelDb.findByKey(key).nativeDb.getUndoString();\n }\n\n public async pullChanges(key: string, toIndex?: ChangesetIndex): Promise<ChangesetIndexAndId> {\n const iModelDb = BriefcaseDb.findByKey(key);\n await iModelDb.pullChanges({ toIndex });\n return iModelDb.changeset as ChangesetIndexAndId;\n }\n public async pushChanges(key: string, description: string): Promise<ChangesetIndexAndId> {\n const iModelDb = BriefcaseDb.findByKey(key);\n await iModelDb.pushChanges({ description });\n return iModelDb.changeset as ChangesetIndexAndId;\n }\n\n public async toggleGraphicalEditingScope(key: string, startSession: boolean): Promise<boolean> {\n const val: IModelJsNative.ErrorStatusOrResult<any, boolean> = IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);\n if (val.error)\n throw new IModelError(val.error.status, \"Failed to toggle graphical editing scope\");\n assert(undefined !== val.result);\n return val.result;\n }\n public async isGraphicalEditingSupported(key: string): Promise<boolean> {\n return IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();\n }\n\n public async reverseTxns(key: string, numOperations: number): Promise<IModelStatus> {\n return IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);\n }\n public async reverseAllTxn(key: string): Promise<IModelStatus> {\n return IModelDb.findByKey(key).nativeDb.reverseAll();\n }\n public async reinstateTxn(key: string): Promise<IModelStatus> {\n return IModelDb.findByKey(key).nativeDb.reinstateTxn();\n }\n public async restartTxnSession(key: string): Promise<void> {\n return IModelDb.findByKey(key).nativeDb.restartTxnSession();\n }\n\n public async queryConcurrency(pool: \"io\" | \"cpu\"): Promise<number> {\n return IModelHost.platform.queryConcurrency(pool);\n }\n}\n"]}