@itwin/core-backend 3.6.0-dev.21 → 3.6.0-dev.22

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 (243) hide show
  1. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  2. package/lib/cjs/AliCloudStorageService.js +71 -71
  3. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  4. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  5. package/lib/cjs/BackendHubAccess.js +41 -41
  6. package/lib/cjs/BackendHubAccess.js.map +1 -1
  7. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  8. package/lib/cjs/BackendLoggerCategory.js +99 -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/BisCoreSchema.js.map +1 -1
  13. package/lib/cjs/BriefcaseManager.d.ts +170 -170
  14. package/lib/cjs/BriefcaseManager.js +413 -413
  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 +447 -447
  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/ChangedElementsDb.js.map +1 -1
  25. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  26. package/lib/cjs/ChangedElementsManager.js +88 -88
  27. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  28. package/lib/cjs/CheckpointManager.d.ts +122 -122
  29. package/lib/cjs/CheckpointManager.js +343 -343
  30. package/lib/cjs/CheckpointManager.js.map +1 -1
  31. package/lib/cjs/ClassRegistry.d.ts +79 -79
  32. package/lib/cjs/ClassRegistry.js +249 -249
  33. package/lib/cjs/ClassRegistry.js.map +1 -1
  34. package/lib/cjs/CloudSqlite.d.ts +350 -350
  35. package/lib/cjs/CloudSqlite.js +152 -152
  36. package/lib/cjs/CloudSqlite.js.map +1 -1
  37. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  38. package/lib/cjs/CloudStorageBackend.js +173 -173
  39. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  40. package/lib/cjs/CodeService.d.ts +396 -396
  41. package/lib/cjs/CodeService.js +63 -63
  42. package/lib/cjs/CodeService.js.map +1 -1
  43. package/lib/cjs/CodeSpecs.d.ts +50 -50
  44. package/lib/cjs/CodeSpecs.js +112 -112
  45. package/lib/cjs/CodeSpecs.js.map +1 -1
  46. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  47. package/lib/cjs/ConcurrentQuery.js +36 -36
  48. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  49. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  50. package/lib/cjs/CustomViewState3dCreator.js +81 -81
  51. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  52. package/lib/cjs/DevTools.d.ts +71 -71
  53. package/lib/cjs/DevTools.js +154 -154
  54. package/lib/cjs/DevTools.js.map +1 -1
  55. package/lib/cjs/DisplayStyle.d.ts +106 -106
  56. package/lib/cjs/DisplayStyle.js +256 -256
  57. package/lib/cjs/DisplayStyle.js.map +1 -1
  58. package/lib/cjs/ECDb.d.ts +191 -191
  59. package/lib/cjs/ECDb.js +350 -350
  60. package/lib/cjs/ECDb.js.map +1 -1
  61. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  62. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  63. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  64. package/lib/cjs/ECSqlStatement.d.ts +466 -466
  65. package/lib/cjs/ECSqlStatement.js +791 -791
  66. package/lib/cjs/ECSqlStatement.js.map +1 -1
  67. package/lib/cjs/Element.d.ts +1102 -1102
  68. package/lib/cjs/Element.js +1416 -1416
  69. package/lib/cjs/Element.js.map +1 -1
  70. package/lib/cjs/ElementAspect.d.ts +176 -176
  71. package/lib/cjs/ElementAspect.js +211 -211
  72. package/lib/cjs/ElementAspect.js.map +1 -1
  73. package/lib/cjs/ElementGraphics.d.ts +9 -9
  74. package/lib/cjs/ElementGraphics.js +41 -41
  75. package/lib/cjs/ElementGraphics.js.map +1 -1
  76. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  77. package/lib/cjs/ElementTreeWalker.js +409 -409
  78. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  79. package/lib/cjs/Entity.d.ts +106 -106
  80. package/lib/cjs/Entity.js +134 -134
  81. package/lib/cjs/Entity.js.map +1 -1
  82. package/lib/cjs/EntityReferences.d.ts +49 -49
  83. package/lib/cjs/EntityReferences.js +95 -95
  84. package/lib/cjs/EntityReferences.js.map +1 -1
  85. package/lib/cjs/ExportGraphics.d.ts +317 -317
  86. package/lib/cjs/ExportGraphics.js +208 -208
  87. package/lib/cjs/ExportGraphics.js.map +1 -1
  88. package/lib/cjs/ExternalSource.d.ts +96 -96
  89. package/lib/cjs/ExternalSource.js +131 -131
  90. package/lib/cjs/ExternalSource.js.map +1 -1
  91. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  92. package/lib/cjs/GeoCoordConfig.js +85 -85
  93. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  94. package/lib/cjs/GeometrySummary.d.ts +4 -4
  95. package/lib/cjs/GeometrySummary.js +380 -380
  96. package/lib/cjs/GeometrySummary.js.map +1 -1
  97. package/lib/cjs/HubMock.d.ts +94 -94
  98. package/lib/cjs/HubMock.js +222 -222
  99. package/lib/cjs/HubMock.js.map +1 -1
  100. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  101. package/lib/cjs/IModelCloneContext.js +15 -15
  102. package/lib/cjs/IModelCloneContext.js.map +1 -1
  103. package/lib/cjs/IModelDb.d.ts +1183 -1183
  104. package/lib/cjs/IModelDb.js +2374 -2374
  105. package/lib/cjs/IModelDb.js.map +1 -1
  106. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  107. package/lib/cjs/IModelElementCloneContext.js +159 -159
  108. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  109. package/lib/cjs/IModelHost.d.ts +370 -370
  110. package/lib/cjs/IModelHost.js +496 -496
  111. package/lib/cjs/IModelHost.js.map +1 -1
  112. package/lib/cjs/IModelJsFs.d.ts +62 -62
  113. package/lib/cjs/IModelJsFs.js +140 -140
  114. package/lib/cjs/IModelJsFs.js.map +1 -1
  115. package/lib/cjs/IpcHost.d.ts +104 -104
  116. package/lib/cjs/IpcHost.js +278 -278
  117. package/lib/cjs/IpcHost.js.map +1 -1
  118. package/lib/cjs/LineStyle.d.ts +311 -311
  119. package/lib/cjs/LineStyle.js +295 -295
  120. package/lib/cjs/LineStyle.js.map +1 -1
  121. package/lib/cjs/LocalHub.d.ts +162 -162
  122. package/lib/cjs/LocalHub.js +587 -587
  123. package/lib/cjs/LocalHub.js.map +1 -1
  124. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  125. package/lib/cjs/LocalhostIpcHost.js +81 -81
  126. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  127. package/lib/cjs/Material.d.ts +103 -103
  128. package/lib/cjs/Material.js +147 -147
  129. package/lib/cjs/Material.js.map +1 -1
  130. package/lib/cjs/Model.d.ts +392 -392
  131. package/lib/cjs/Model.js +485 -485
  132. package/lib/cjs/Model.js.map +1 -1
  133. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  134. package/lib/cjs/NativeAppStorage.js +202 -202
  135. package/lib/cjs/NativeAppStorage.js.map +1 -1
  136. package/lib/cjs/NativeHost.d.ts +52 -52
  137. package/lib/cjs/NativeHost.js +163 -163
  138. package/lib/cjs/NativeHost.js.map +1 -1
  139. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  140. package/lib/cjs/NavigationRelationship.js +225 -225
  141. package/lib/cjs/NavigationRelationship.js.map +1 -1
  142. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  143. package/lib/cjs/PromiseMemoizer.js +101 -101
  144. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  145. package/lib/cjs/PropertyStore.d.ts +132 -132
  146. package/lib/cjs/PropertyStore.js +11 -11
  147. package/lib/cjs/PropertyStore.js.map +1 -1
  148. package/lib/cjs/Relationship.d.ts +416 -416
  149. package/lib/cjs/Relationship.js +494 -494
  150. package/lib/cjs/Relationship.js.map +1 -1
  151. package/lib/cjs/RpcBackend.d.ts +5 -5
  152. package/lib/cjs/RpcBackend.js +31 -31
  153. package/lib/cjs/RpcBackend.js.map +1 -1
  154. package/lib/cjs/SQLiteDb.d.ts +219 -219
  155. package/lib/cjs/SQLiteDb.js +214 -214
  156. package/lib/cjs/SQLiteDb.js.map +1 -1
  157. package/lib/cjs/Schema.d.ts +55 -55
  158. package/lib/cjs/Schema.js +83 -83
  159. package/lib/cjs/Schema.js.map +1 -1
  160. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  161. package/lib/cjs/ServerBasedLocks.js +168 -168
  162. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  163. package/lib/cjs/SqliteStatement.d.ts +360 -360
  164. package/lib/cjs/SqliteStatement.js +586 -586
  165. package/lib/cjs/SqliteStatement.js.map +1 -1
  166. package/lib/cjs/Texture.d.ts +58 -58
  167. package/lib/cjs/Texture.js +82 -82
  168. package/lib/cjs/Texture.js.map +1 -1
  169. package/lib/cjs/TileStorage.d.ts +18 -18
  170. package/lib/cjs/TileStorage.js +90 -90
  171. package/lib/cjs/TileStorage.js.map +1 -1
  172. package/lib/cjs/TxnManager.d.ts +202 -202
  173. package/lib/cjs/TxnManager.js +356 -356
  174. package/lib/cjs/TxnManager.js.map +1 -1
  175. package/lib/cjs/ViewDefinition.d.ts +439 -439
  176. package/lib/cjs/ViewDefinition.js +646 -646
  177. package/lib/cjs/ViewDefinition.js.map +1 -1
  178. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  179. package/lib/cjs/ViewStateHydrator.js +103 -103
  180. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  181. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  182. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  183. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  184. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  185. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  186. package/lib/cjs/core-backend.d.ts +184 -184
  187. package/lib/cjs/core-backend.js +204 -204
  188. package/lib/cjs/core-backend.js.map +1 -1
  189. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  190. package/lib/cjs/domains/FunctionalElements.js +145 -145
  191. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  192. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  193. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  194. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  195. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  196. package/lib/cjs/domains/GenericElements.js +263 -263
  197. package/lib/cjs/domains/GenericElements.js.map +1 -1
  198. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  199. package/lib/cjs/domains/GenericSchema.js +28 -28
  200. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  201. package/lib/cjs/rpc/multipart.d.ts +11 -11
  202. package/lib/cjs/rpc/multipart.js +70 -70
  203. package/lib/cjs/rpc/multipart.js.map +1 -1
  204. package/lib/cjs/rpc/tracing.d.ts +28 -28
  205. package/lib/cjs/rpc/tracing.js +73 -73
  206. package/lib/cjs/rpc/tracing.js.map +1 -1
  207. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  208. package/lib/cjs/rpc/web/logging.js +42 -42
  209. package/lib/cjs/rpc/web/logging.js.map +1 -1
  210. package/lib/cjs/rpc/web/request.d.ts +6 -6
  211. package/lib/cjs/rpc/web/request.js +73 -73
  212. package/lib/cjs/rpc/web/request.js.map +1 -1
  213. package/lib/cjs/rpc/web/response.d.ts +6 -6
  214. package/lib/cjs/rpc/web/response.js +105 -105
  215. package/lib/cjs/rpc/web/response.js.map +1 -1
  216. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  217. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  218. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  219. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  220. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +291 -291
  221. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  222. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  223. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +202 -202
  224. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  225. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  226. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  227. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  228. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  229. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  230. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  231. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  232. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  233. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  234. package/lib/cjs/workspace/Settings.d.ts +186 -186
  235. package/lib/cjs/workspace/Settings.js +155 -155
  236. package/lib/cjs/workspace/Settings.js.map +1 -1
  237. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  238. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  239. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  240. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  241. package/lib/cjs/workspace/Workspace.js +543 -543
  242. package/lib/cjs/workspace/Workspace.js.map +1 -1
  243. package/package.json +11 -11
@@ -1,279 +1,279 @@
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;
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 && typeof err === "object") ? err.constructor.name : "Unknown Error",
133
- message: core_bentley_1.BentleyError.getErrorMessage(err),
134
- errorNumber: (_a = err.errorNumber) !== null && _a !== void 0 ? _a : 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
+ 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;
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 && typeof err === "object") ? err.constructor.name : "Unknown Error",
133
+ message: core_bentley_1.BentleyError.getErrorMessage(err),
134
+ errorNumber: (_a = err.errorNumber) !== null && _a !== void 0 ? _a : 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;
279
279
  //# sourceMappingURL=IpcHost.js.map