@itwin/core-backend 3.7.7 → 3.7.9

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 (247) hide show
  1. package/CHANGELOG.md +13 -1
  2. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  3. package/lib/cjs/AliCloudStorageService.js +71 -71
  4. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  5. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  6. package/lib/cjs/BackendHubAccess.js +41 -41
  7. package/lib/cjs/BackendHubAccess.js.map +1 -1
  8. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  9. package/lib/cjs/BackendLoggerCategory.js +99 -99
  10. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  11. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  12. package/lib/cjs/BisCoreSchema.js +60 -60
  13. package/lib/cjs/BisCoreSchema.js.map +1 -1
  14. package/lib/cjs/BriefcaseManager.d.ts +170 -170
  15. package/lib/cjs/BriefcaseManager.js +414 -414
  16. package/lib/cjs/BriefcaseManager.js.map +1 -1
  17. package/lib/cjs/Category.d.ts +153 -153
  18. package/lib/cjs/Category.js +243 -243
  19. package/lib/cjs/Category.js.map +1 -1
  20. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  21. package/lib/cjs/ChangeSummaryManager.js +447 -447
  22. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  23. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  24. package/lib/cjs/ChangedElementsDb.js +165 -165
  25. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  26. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  27. package/lib/cjs/ChangedElementsManager.js +88 -88
  28. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  29. package/lib/cjs/CheckpointManager.d.ts +121 -121
  30. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  31. package/lib/cjs/CheckpointManager.js +363 -352
  32. package/lib/cjs/CheckpointManager.js.map +1 -1
  33. package/lib/cjs/ClassRegistry.d.ts +79 -79
  34. package/lib/cjs/ClassRegistry.js +250 -250
  35. package/lib/cjs/ClassRegistry.js.map +1 -1
  36. package/lib/cjs/CloudSqlite.d.ts +350 -350
  37. package/lib/cjs/CloudSqlite.js +153 -153
  38. package/lib/cjs/CloudSqlite.js.map +1 -1
  39. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  40. package/lib/cjs/CloudStorageBackend.js +173 -173
  41. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  42. package/lib/cjs/CodeService.d.ts +396 -396
  43. package/lib/cjs/CodeService.js +63 -63
  44. package/lib/cjs/CodeService.js.map +1 -1
  45. package/lib/cjs/CodeSpecs.d.ts +55 -55
  46. package/lib/cjs/CodeSpecs.js +124 -124
  47. package/lib/cjs/CodeSpecs.js.map +1 -1
  48. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  49. package/lib/cjs/ConcurrentQuery.js +36 -36
  50. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  51. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  52. package/lib/cjs/CustomViewState3dCreator.js +82 -82
  53. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  54. package/lib/cjs/DevTools.d.ts +71 -71
  55. package/lib/cjs/DevTools.js +154 -154
  56. package/lib/cjs/DevTools.js.map +1 -1
  57. package/lib/cjs/DisplayStyle.d.ts +106 -106
  58. package/lib/cjs/DisplayStyle.js +256 -256
  59. package/lib/cjs/DisplayStyle.js.map +1 -1
  60. package/lib/cjs/ECDb.d.ts +194 -194
  61. package/lib/cjs/ECDb.js +355 -355
  62. package/lib/cjs/ECDb.js.map +1 -1
  63. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  64. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  65. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  66. package/lib/cjs/ECSqlStatement.d.ts +473 -473
  67. package/lib/cjs/ECSqlStatement.js +791 -791
  68. package/lib/cjs/ECSqlStatement.js.map +1 -1
  69. package/lib/cjs/Element.d.ts +1109 -1109
  70. package/lib/cjs/Element.js +1427 -1427
  71. package/lib/cjs/Element.js.map +1 -1
  72. package/lib/cjs/ElementAspect.d.ts +179 -179
  73. package/lib/cjs/ElementAspect.js +211 -211
  74. package/lib/cjs/ElementAspect.js.map +1 -1
  75. package/lib/cjs/ElementGraphics.d.ts +9 -9
  76. package/lib/cjs/ElementGraphics.js +41 -41
  77. package/lib/cjs/ElementGraphics.js.map +1 -1
  78. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  79. package/lib/cjs/ElementTreeWalker.js +409 -409
  80. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  81. package/lib/cjs/Entity.d.ts +106 -106
  82. package/lib/cjs/Entity.js +134 -134
  83. package/lib/cjs/Entity.js.map +1 -1
  84. package/lib/cjs/EntityReferences.d.ts +49 -49
  85. package/lib/cjs/EntityReferences.js +95 -95
  86. package/lib/cjs/EntityReferences.js.map +1 -1
  87. package/lib/cjs/ExportGraphics.d.ts +317 -317
  88. package/lib/cjs/ExportGraphics.js +208 -208
  89. package/lib/cjs/ExportGraphics.js.map +1 -1
  90. package/lib/cjs/ExternalSource.d.ts +96 -96
  91. package/lib/cjs/ExternalSource.js +131 -131
  92. package/lib/cjs/ExternalSource.js.map +1 -1
  93. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  94. package/lib/cjs/GeoCoordConfig.js +85 -85
  95. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  96. package/lib/cjs/GeometrySummary.d.ts +4 -4
  97. package/lib/cjs/GeometrySummary.js +380 -380
  98. package/lib/cjs/GeometrySummary.js.map +1 -1
  99. package/lib/cjs/HubMock.d.ts +94 -94
  100. package/lib/cjs/HubMock.js +222 -222
  101. package/lib/cjs/HubMock.js.map +1 -1
  102. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  103. package/lib/cjs/IModelCloneContext.js +15 -15
  104. package/lib/cjs/IModelCloneContext.js.map +1 -1
  105. package/lib/cjs/IModelDb.d.ts +1213 -1213
  106. package/lib/cjs/IModelDb.js +2392 -2392
  107. package/lib/cjs/IModelDb.js.map +1 -1
  108. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  109. package/lib/cjs/IModelElementCloneContext.js +159 -159
  110. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  111. package/lib/cjs/IModelHost.d.ts +370 -369
  112. package/lib/cjs/IModelHost.d.ts.map +1 -1
  113. package/lib/cjs/IModelHost.js +497 -496
  114. package/lib/cjs/IModelHost.js.map +1 -1
  115. package/lib/cjs/IModelJsFs.d.ts +62 -62
  116. package/lib/cjs/IModelJsFs.js +140 -140
  117. package/lib/cjs/IModelJsFs.js.map +1 -1
  118. package/lib/cjs/IpcHost.d.ts +104 -104
  119. package/lib/cjs/IpcHost.js +278 -278
  120. package/lib/cjs/IpcHost.js.map +1 -1
  121. package/lib/cjs/LineStyle.d.ts +311 -311
  122. package/lib/cjs/LineStyle.js +295 -295
  123. package/lib/cjs/LineStyle.js.map +1 -1
  124. package/lib/cjs/LocalHub.d.ts +162 -162
  125. package/lib/cjs/LocalHub.js +585 -585
  126. package/lib/cjs/LocalHub.js.map +1 -1
  127. package/lib/cjs/LocalhostIpcHost.d.ts +21 -21
  128. package/lib/cjs/LocalhostIpcHost.js +81 -81
  129. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  130. package/lib/cjs/Material.d.ts +131 -131
  131. package/lib/cjs/Material.js +181 -181
  132. package/lib/cjs/Material.js.map +1 -1
  133. package/lib/cjs/Model.d.ts +392 -392
  134. package/lib/cjs/Model.js +485 -485
  135. package/lib/cjs/Model.js.map +1 -1
  136. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  137. package/lib/cjs/NativeAppStorage.js +202 -202
  138. package/lib/cjs/NativeAppStorage.js.map +1 -1
  139. package/lib/cjs/NativeHost.d.ts +52 -52
  140. package/lib/cjs/NativeHost.js +163 -163
  141. package/lib/cjs/NativeHost.js.map +1 -1
  142. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  143. package/lib/cjs/NavigationRelationship.js +225 -225
  144. package/lib/cjs/NavigationRelationship.js.map +1 -1
  145. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  146. package/lib/cjs/PromiseMemoizer.js +101 -101
  147. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  148. package/lib/cjs/PropertyStore.d.ts +132 -132
  149. package/lib/cjs/PropertyStore.js +11 -11
  150. package/lib/cjs/PropertyStore.js.map +1 -1
  151. package/lib/cjs/Relationship.d.ts +416 -416
  152. package/lib/cjs/Relationship.js +494 -494
  153. package/lib/cjs/Relationship.js.map +1 -1
  154. package/lib/cjs/RpcBackend.d.ts +5 -5
  155. package/lib/cjs/RpcBackend.js +32 -32
  156. package/lib/cjs/RpcBackend.js.map +1 -1
  157. package/lib/cjs/SQLiteDb.d.ts +219 -219
  158. package/lib/cjs/SQLiteDb.js +214 -214
  159. package/lib/cjs/SQLiteDb.js.map +1 -1
  160. package/lib/cjs/Schema.d.ts +55 -55
  161. package/lib/cjs/Schema.js +83 -83
  162. package/lib/cjs/Schema.js.map +1 -1
  163. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  164. package/lib/cjs/ServerBasedLocks.js +168 -168
  165. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  166. package/lib/cjs/SqliteStatement.d.ts +360 -360
  167. package/lib/cjs/SqliteStatement.js +586 -586
  168. package/lib/cjs/SqliteStatement.js.map +1 -1
  169. package/lib/cjs/Texture.d.ts +58 -58
  170. package/lib/cjs/Texture.js +82 -82
  171. package/lib/cjs/Texture.js.map +1 -1
  172. package/lib/cjs/TileStorage.d.ts +25 -18
  173. package/lib/cjs/TileStorage.d.ts.map +1 -1
  174. package/lib/cjs/TileStorage.js +102 -90
  175. package/lib/cjs/TileStorage.js.map +1 -1
  176. package/lib/cjs/TxnManager.d.ts +202 -202
  177. package/lib/cjs/TxnManager.js +356 -356
  178. package/lib/cjs/TxnManager.js.map +1 -1
  179. package/lib/cjs/ViewDefinition.d.ts +439 -439
  180. package/lib/cjs/ViewDefinition.js +646 -646
  181. package/lib/cjs/ViewDefinition.js.map +1 -1
  182. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  183. package/lib/cjs/ViewStateHydrator.js +103 -103
  184. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  185. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  186. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  187. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  188. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  189. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  190. package/lib/cjs/core-backend.d.ts +184 -184
  191. package/lib/cjs/core-backend.js +204 -204
  192. package/lib/cjs/core-backend.js.map +1 -1
  193. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  194. package/lib/cjs/domains/FunctionalElements.js +145 -145
  195. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  196. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  197. package/lib/cjs/domains/FunctionalSchema.js +40 -40
  198. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  199. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  200. package/lib/cjs/domains/GenericElements.js +263 -263
  201. package/lib/cjs/domains/GenericElements.js.map +1 -1
  202. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  203. package/lib/cjs/domains/GenericSchema.js +28 -28
  204. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  205. package/lib/cjs/rpc/multipart.d.ts +11 -11
  206. package/lib/cjs/rpc/multipart.js +71 -71
  207. package/lib/cjs/rpc/multipart.js.map +1 -1
  208. package/lib/cjs/rpc/tracing.d.ts +28 -28
  209. package/lib/cjs/rpc/tracing.js +74 -74
  210. package/lib/cjs/rpc/tracing.js.map +1 -1
  211. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  212. package/lib/cjs/rpc/web/logging.js +43 -43
  213. package/lib/cjs/rpc/web/logging.js.map +1 -1
  214. package/lib/cjs/rpc/web/request.d.ts +6 -6
  215. package/lib/cjs/rpc/web/request.js +74 -74
  216. package/lib/cjs/rpc/web/request.js.map +1 -1
  217. package/lib/cjs/rpc/web/response.d.ts +6 -6
  218. package/lib/cjs/rpc/web/response.js +106 -106
  219. package/lib/cjs/rpc/web/response.js.map +1 -1
  220. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  221. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  222. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  223. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  224. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +294 -294
  225. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  226. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  227. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +211 -211
  228. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  229. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  230. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
  231. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  232. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  233. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
  234. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  235. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  236. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  237. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  238. package/lib/cjs/workspace/Settings.d.ts +186 -186
  239. package/lib/cjs/workspace/Settings.js +155 -155
  240. package/lib/cjs/workspace/Settings.js.map +1 -1
  241. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  242. package/lib/cjs/workspace/SettingsSchemas.js +191 -191
  243. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  244. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  245. package/lib/cjs/workspace/Workspace.js +543 -543
  246. package/lib/cjs/workspace/Workspace.js.map +1 -1
  247. package/package.json +17 -16
@@ -1,497 +1,498 @@
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 IModelHost
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.FileNameResolver = exports.KnownLocations = exports.Platform = exports.IModelHost = exports.IModelHostConfiguration = void 0;
11
- const imodeljs_native_1 = require("@bentley/imodeljs-native");
12
- const object_storage_azure_1 = require("@itwin/object-storage-azure");
13
- const cloud_agnostic_core_1 = require("@itwin/cloud-agnostic-core");
14
- const object_storage_core_1 = require("@itwin/object-storage-core");
15
- const core_bentley_1 = require("@itwin/core-bentley");
16
- const core_common_1 = require("@itwin/core-common");
17
- const core_telemetry_1 = require("@itwin/core-telemetry");
18
- const inversify_1 = require("inversify");
19
- const os = require("os");
20
- const path = require("path");
21
- const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
22
- const BisCoreSchema_1 = require("./BisCoreSchema");
23
- const BriefcaseManager_1 = require("./BriefcaseManager");
24
- const CloudStorageBackend_1 = require("./CloudStorageBackend");
25
- const FunctionalSchema_1 = require("./domains/FunctionalSchema");
26
- const GenericSchema_1 = require("./domains/GenericSchema");
27
- const GeoCoordConfig_1 = require("./GeoCoordConfig");
28
- const IModelJsFs_1 = require("./IModelJsFs");
29
- const DevToolsRpcImpl_1 = require("./rpc-impl/DevToolsRpcImpl");
30
- const IModelReadRpcImpl_1 = require("./rpc-impl/IModelReadRpcImpl");
31
- const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
32
- const SnapshotIModelRpcImpl_1 = require("./rpc-impl/SnapshotIModelRpcImpl");
33
- const WipRpcImpl_1 = require("./rpc-impl/WipRpcImpl");
34
- const RpcBackend_1 = require("./RpcBackend");
35
- const TileStorage_1 = require("./TileStorage");
36
- const Settings_1 = require("./workspace/Settings");
37
- const SettingsSchemas_1 = require("./workspace/SettingsSchemas");
38
- const Workspace_1 = require("./workspace/Workspace");
39
- const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
40
- /** Configuration of core-backend.
41
- * @public
42
- */
43
- class IModelHostConfiguration {
44
- constructor() {
45
- /** @internal */
46
- this.tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
47
- /** @internal */
48
- this.tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
49
- /** @internal */
50
- this.logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;
51
- /** @internal */
52
- this.logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;
53
- }
54
- }
55
- exports.IModelHostConfiguration = IModelHostConfiguration;
56
- IModelHostConfiguration.defaultTileRequestTimeout = 20 * 1000;
57
- IModelHostConfiguration.defaultLogTileLoadTimeThreshold = 40;
58
- IModelHostConfiguration.defaultLogTileSizeThreshold = 20 * 1000000;
59
- /** @internal */
60
- IModelHostConfiguration.defaultMaxTileCacheDbSize = 1024 * 1024 * 1024;
61
- /**
62
- * Settings for `IModelHost.appWorkspace`.
63
- * @note this includes the default dictionary from the SettingsSpecRegistry
64
- */
65
- class ApplicationSettings extends Settings_1.BaseSettings {
66
- constructor() {
67
- super();
68
- this._remove = SettingsSchemas_1.SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());
69
- this.updateDefaults();
70
- }
71
- verifyPriority(priority) {
72
- if (priority >= Settings_1.SettingsPriority.iModel) // iModel settings may not appear in ApplicationSettings
73
- throw new Error("Use IModelSettings");
74
- }
75
- updateDefaults() {
76
- const defaults = {};
77
- for (const [schemaName, val] of SettingsSchemas_1.SettingsSchemas.allSchemas) {
78
- if (val.default)
79
- defaults[schemaName] = val.default;
80
- }
81
- this.addDictionary("_default_", 0, defaults);
82
- }
83
- close() {
84
- if (this._remove) {
85
- this._remove();
86
- this._remove = undefined;
87
- }
88
- }
89
- }
90
- /** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.
91
- * See [the learning article]($docs/learning/backend/IModelHost.md)
92
- * @public
93
- */
94
- class IModelHost {
95
- constructor() { }
96
- /** @internal */
97
- static get platform() {
98
- if (this._platform === undefined)
99
- throw new Error("IModelHost.startup must be called first");
100
- return this._platform;
101
- }
102
- /** A uniqueId for this session */
103
- static get sessionId() { return this.session.sessionId; }
104
- static set sessionId(id) { this.session.sessionId = id; }
105
- /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */
106
- static get applicationId() { return this.session.applicationId; }
107
- static set applicationId(id) { this.session.applicationId = id; }
108
- /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
109
- static get applicationVersion() { return this.session.applicationVersion; }
110
- static set applicationVersion(version) { this.session.applicationVersion = version; }
111
- /** Root directory holding files that iTwin.js caches */
112
- static get cacheDir() { return this._cacheDir; }
113
- /** The application [[Workspace]] for this `IModelHost`
114
- * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).
115
- * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and
116
- * attempting to add them to this Workspace will fail.
117
- * @beta
118
- */
119
- static get appWorkspace() { return this._appWorkspace; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
120
- /** Get the current access token for this IModelHost, or a blank string if none is available.
121
- * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
122
- * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
123
- * obtains the token and forwards it to the frontend.
124
- * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value
125
- * returned by this method may change over time throughout the course of a session.
126
- */
127
- static async getAccessToken() {
128
- var _a, _b;
129
- try {
130
- return (_b = (await ((_a = this.authorizationClient) === null || _a === void 0 ? void 0 : _a.getAccessToken()))) !== null && _b !== void 0 ? _b : "";
131
- }
132
- catch (e) {
133
- return "";
134
- }
135
- }
136
- /** @internal */
137
- static flushLog() {
138
- return this.platform.flushLog();
139
- }
140
- /** @internal */
141
- static loadNative() {
142
- const platform = Platform.load();
143
- this.registerPlatform(platform);
144
- }
145
- static syncNativeLogLevels() {
146
- this.platform.clearLogLevelCache();
147
- }
148
- static registerPlatform(platform) {
149
- this._platform = platform;
150
- if (undefined === platform)
151
- return;
152
- platform.logger = core_bentley_1.Logger;
153
- core_bentley_1.Logger.logLevelChangedFn = () => IModelHost.syncNativeLogLevels();
154
- }
155
- /** @internal */
156
- static setHubAccess(hubAccess) { this._hubAccess = hubAccess; }
157
- /** get the current hubAccess, if present.
158
- * @beta
159
- */
160
- static getHubAccess() { return this._hubAccess; }
161
- /** Provides access to the IModelHub for this IModelHost
162
- * @beta
163
- * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
164
- * To determine whether one is present, use [[getHubAccess]].
165
- */
166
- static get hubAccess() {
167
- if (this._hubAccess === undefined)
168
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "No BackendHubAccess supplied in IModelHostOptions");
169
- return this._hubAccess;
170
- }
171
- static initializeWorkspace(configuration) {
172
- const settingAssets = path.join(KnownLocations.packageAssetsDir, "Settings");
173
- SettingsSchemas_1.SettingsSchemas.addDirectory(path.join(settingAssets, "Schemas"));
174
- this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
175
- this.appWorkspace.settings.addDirectory(settingAssets, Settings_1.SettingsPriority.defaults);
176
- GeoCoordConfig_1.GeoCoordConfig.onStartup();
177
- // allow applications to load their default settings
178
- this.onWorkspaceStartup.raiseEvent();
179
- }
180
- /** Returns true if IModelHost is started. */
181
- static get isValid() { return this._isValid; }
182
- /** This method must be called before any iTwin.js services are used.
183
- * @param options Host configuration data.
184
- * Raises [[onAfterStartup]].
185
- * @see [[shutdown]].
186
- */
187
- static async startup(options) {
188
- var _a, _b, _c, _d;
189
- if (this._isValid)
190
- return; // we're already initialized
191
- this._isValid = true;
192
- options = options !== null && options !== void 0 ? options : {};
193
- if (IModelHost.sessionId === "")
194
- IModelHost.sessionId = core_bentley_1.Guid.createValue();
195
- this.authorizationClient = options.authorizationClient;
196
- this.logStartup();
197
- this.backendVersion = require("../../package.json").version; // eslint-disable-line @typescript-eslint/no-var-requires
198
- (0, RpcBackend_1.initializeRpcBackend)(options.enableOpenTelemetry);
199
- if (this._platform === undefined) {
200
- try {
201
- this.loadNative();
202
- }
203
- catch (error) {
204
- core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (options));
205
- throw error;
206
- }
207
- }
208
- if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
209
- this.platform.setCrashReporting(options.crashReportingConfig);
210
- core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
211
- enableCrashDumps: (_a = options.crashReportingConfig) === null || _a === void 0 ? void 0 : _a.enableCrashDumps,
212
- wantFullMemoryDumps: (_b = options.crashReportingConfig) === null || _b === void 0 ? void 0 : _b.wantFullMemoryDumps,
213
- enableNodeReport: (_c = options.crashReportingConfig) === null || _c === void 0 ? void 0 : _c.enableNodeReport,
214
- uploadToBentley: (_d = options.crashReportingConfig) === null || _d === void 0 ? void 0 : _d.uploadToBentley,
215
- });
216
- if (options.crashReportingConfig.enableNodeReport) {
217
- if (process.report !== undefined) {
218
- process.report.reportOnFatalError = true;
219
- process.report.reportOnUncaughtException = true;
220
- process.report.directory = options.crashReportingConfig.crashDir;
221
- core_bentley_1.Logger.logTrace(loggerCategory, "Configured Node.js crash reporting");
222
- }
223
- else {
224
- core_bentley_1.Logger.logWarning(loggerCategory, "Unable to configure Node.js crash reporting");
225
- }
226
- }
227
- }
228
- this.setupHostDirs(options);
229
- this.initializeWorkspace(options);
230
- BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
231
- [
232
- IModelReadRpcImpl_1.IModelReadRpcImpl,
233
- IModelTileRpcImpl_1.IModelTileRpcImpl,
234
- SnapshotIModelRpcImpl_1.SnapshotIModelRpcImpl,
235
- WipRpcImpl_1.WipRpcImpl,
236
- DevToolsRpcImpl_1.DevToolsRpcImpl,
237
- ].forEach((rpc) => rpc.register()); // register all of the RPC implementations
238
- [
239
- BisCoreSchema_1.BisCoreSchema,
240
- GenericSchema_1.GenericSchema,
241
- FunctionalSchema_1.FunctionalSchema,
242
- ].forEach((schema) => schema.registerSchema()); // register all of the schemas
243
- if (undefined !== options.hubAccess)
244
- this._hubAccess = options.hubAccess;
245
- this.configuration = options;
246
- this.setupTileCache();
247
- process.once("beforeExit", IModelHost.shutdown);
248
- this.onAfterStartup.raiseEvent();
249
- }
250
- static logStartup() {
251
- if (!core_bentley_1.Logger.isEnabled(loggerCategory, core_bentley_1.LogLevel.Trace))
252
- return;
253
- // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing
254
- let startupInfo = {};
255
- const serviceName = process.env.FABRIC_SERVICE_NAME;
256
- if (serviceName) {
257
- // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85
258
- const serviceNameComponents = serviceName.split("/");
259
- if (serviceNameComponents.length === 7) {
260
- startupInfo = {
261
- ...startupInfo,
262
- iTwinId: serviceNameComponents[4],
263
- iModelId: serviceNameComponents[5],
264
- changesetId: serviceNameComponents[6],
265
- };
266
- }
267
- }
268
- core_bentley_1.Logger.logTrace(loggerCategory, "IModelHost.startup", () => startupInfo);
269
- }
270
- static setupHostDirs(configuration) {
271
- var _a;
272
- const setupDir = (dir) => {
273
- dir = path.normalize(dir);
274
- IModelJsFs_1.IModelJsFs.recursiveMkDirSync(dir);
275
- return dir;
276
- };
277
- this._cacheDir = setupDir((_a = configuration.cacheDir) !== null && _a !== void 0 ? _a : imodeljs_native_1.NativeLibrary.defaultCacheDir);
278
- this._briefcaseCacheDir = path.join(this._cacheDir, "imodels");
279
- }
280
- /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
281
- static async shutdown() {
282
- var _a;
283
- // NB: This method is set as a node listener where `this` is unbound
284
- if (!IModelHost._isValid)
285
- return;
286
- IModelHost._isValid = false;
287
- IModelHost.onBeforeShutdown.raiseEvent();
288
- IModelHost.configuration = undefined;
289
- // eslint-disable-next-line deprecation/deprecation
290
- IModelHost.tileCacheService = undefined;
291
- // eslint-disable-next-line deprecation/deprecation
292
- IModelHost.tileUploader = undefined;
293
- IModelHost.tileStorage = undefined;
294
- (_a = IModelHost._appWorkspace) === null || _a === void 0 ? void 0 : _a.close();
295
- IModelHost._appWorkspace = undefined;
296
- Workspace_1.ITwinWorkspace.finalize();
297
- process.removeListener("beforeExit", IModelHost.shutdown);
298
- }
299
- /**
300
- * Add or update a property that should be included in a crash report.
301
- * @param name The name of the property
302
- * @param value The value of the property
303
- * @alpha
304
- */
305
- static setCrashReportProperty(name, value) {
306
- (0, core_bentley_1.assert)(undefined !== this._platform);
307
- this._platform.setCrashReportProperty(name, value);
308
- }
309
- /**
310
- * Remove a previously defined property so that will not be included in a crash report.
311
- * @param name The name of the property
312
- * @alpha
313
- */
314
- static removeCrashReportProperty(name) {
315
- (0, core_bentley_1.assert)(undefined !== this._platform);
316
- this._platform.setCrashReportProperty(name, undefined);
317
- }
318
- /**
319
- * Get all properties that will be included in a crash report.
320
- * @alpha
321
- */
322
- static getCrashReportProperties() {
323
- (0, core_bentley_1.assert)(undefined !== this._platform);
324
- return this._platform.getCrashReportProperties();
325
- }
326
- /** The directory where application assets may be found */
327
- static get appAssetsDir() { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }
328
- /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
329
- * @internal
330
- */
331
- static get tileTreeRequestTimeout() {
332
- var _a, _b;
333
- return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileTreeRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
334
- }
335
- /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a "pending" status.
336
- * @internal
337
- */
338
- static get tileContentRequestTimeout() {
339
- var _a, _b;
340
- return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileContentRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
341
- }
342
- /** The backend will log when a tile took longer to load than this threshold in seconds. */
343
- static get logTileLoadTimeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileLoadTimeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
344
- /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
345
- static get logTileSizeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileSizeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileSizeThreshold; }
346
- /** Whether external tile caching is active.
347
- * @internal
348
- */
349
- static get usingExternalTileCache() {
350
- return undefined !== IModelHost.tileStorage;
351
- }
352
- /** Whether to restrict tile cache URLs by client IP address.
353
- * @internal
354
- */
355
- static get restrictTileUrlsByClientIp() { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }
356
- /** Whether to compress cached tiles.
357
- * @internal
358
- */
359
- static get compressCachedTiles() { var _a; return false !== ((_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.compressCachedTiles); }
360
- static setupTileCache() {
361
- var _a;
362
- (0, core_bentley_1.assert)(undefined !== IModelHost.configuration);
363
- const config = IModelHost.configuration;
364
- // eslint-disable-next-line deprecation/deprecation
365
- const service = config.tileCacheService;
366
- const storage = config.tileCacheStorage;
367
- const credentials = config.tileCacheAzureCredentials;
368
- if (!service && !storage && !credentials) {
369
- this.platform.setMaxTileCacheSize((_a = config.maxTileCacheDbSize) !== null && _a !== void 0 ? _a : IModelHostConfiguration.defaultMaxTileCacheDbSize);
370
- return;
371
- }
372
- this.platform.setMaxTileCacheSize(0);
373
- // eslint-disable-next-line deprecation/deprecation
374
- IModelHost.tileUploader = new CloudStorageBackend_1.CloudStorageTileUploader();
375
- if (credentials) {
376
- if (storage || service)
377
- throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Cannot use both Azure and custom cloud storage providers for tile cache.");
378
- this.setupAzureTileCache(credentials);
379
- }
380
- if (service) {
381
- if (!storage)
382
- core_bentley_1.Logger.logWarning(loggerCategory, "Using tileCacheService without tileCacheStorage is unsupported");
383
- IModelHost.tileCacheService = service; // eslint-disable-line deprecation/deprecation
384
- }
385
- if (storage)
386
- IModelHost.tileStorage = new TileStorage_1.TileStorage(storage);
387
- }
388
- static setupAzureTileCache(credentials) {
389
- var _a;
390
- const config = {
391
- // eslint-disable-next-line @typescript-eslint/naming-convention
392
- ServerSideStorage: {
393
- dependencyName: "azure",
394
- accountName: credentials.account,
395
- accountKey: credentials.accessKey,
396
- baseUrl: (_a = credentials.baseUrl) !== null && _a !== void 0 ? _a : `https://${credentials.account}.blob.core.windows.net`,
397
- },
398
- };
399
- const ioc = new inversify_1.Container();
400
- ioc.bind(cloud_agnostic_core_1.Types.dependenciesConfig).toConstantValue(config);
401
- new object_storage_azure_1.AzureServerStorageBindings().register(ioc, config.ServerSideStorage);
402
- IModelHost.tileStorage = new TileStorage_1.TileStorage(ioc.get(object_storage_core_1.ServerStorage));
403
- // eslint-disable-next-line deprecation/deprecation
404
- IModelHost.tileCacheService = new CloudStorageBackend_1.AzureBlobStorage(credentials); // needed for backwards compatibility with old frontends
405
- }
406
- /** @internal */
407
- static computeSchemaChecksum(arg) {
408
- return this.platform.computeSchemaChecksum(arg);
409
- }
410
- }
411
- exports.IModelHost = IModelHost;
412
- /** @alpha */
413
- IModelHost.telemetry = new core_telemetry_1.TelemetryManager();
414
- IModelHost.backendVersion = "";
415
- IModelHost._cacheDir = "";
416
- /** Event raised during startup to allow loading settings data */
417
- IModelHost.onWorkspaceStartup = new core_bentley_1.BeEvent();
418
- /** Event raised just after the backend IModelHost was started */
419
- IModelHost.onAfterStartup = new core_bentley_1.BeEvent();
420
- /** Event raised just before the backend IModelHost is to be shut down */
421
- IModelHost.onBeforeShutdown = new core_bentley_1.BeEvent();
422
- /** @internal */
423
- IModelHost.session = { applicationId: "2686", applicationVersion: "1.0.0", sessionId: "" };
424
- IModelHost._isValid = false;
425
- /** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].
426
- * @public
427
- */
428
- class Platform {
429
- /** Get the name of the platform. */
430
- static get platformName() {
431
- return process.platform;
432
- }
433
- /** @internal */
434
- static load() {
435
- return core_bentley_1.ProcessDetector.isMobileAppBackend ? process._linkedBinding("iModelJsNative") : imodeljs_native_1.NativeLibrary.load();
436
- }
437
- }
438
- exports.Platform = Platform;
439
- /** Well known directories that may be used by the application. Also see [[Platform]]
440
- * @public
441
- */
442
- class KnownLocations {
443
- /** The directory where the imodeljs-native assets are stored. */
444
- static get nativeAssetsDir() { return IModelHost.platform.DgnDb.getAssetsDir(); }
445
- /** The directory where the core-backend assets are stored. */
446
- static get packageAssetsDir() {
447
- return path.join(__dirname, "assets");
448
- }
449
- /** The temporary directory. */
450
- static get tmpdir() {
451
- return os.tmpdir();
452
- }
453
- }
454
- exports.KnownLocations = KnownLocations;
455
- /** Extend this class to provide custom file name resolution behavior.
456
- * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.
457
- * @see [[IModelHost.snapshotFileNameResolver]]
458
- * @public
459
- */
460
- class FileNameResolver {
461
- /** Resolve a file name from the specified key.
462
- * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.
463
- * @returns The resolved file name or `undefined` if not found.
464
- */
465
- tryResolveKey(_fileKey) { return undefined; }
466
- /** Resolve a file name from the specified key.
467
- * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.
468
- * @returns The resolved file name.
469
- * @throws [[IModelError]] if not found.
470
- */
471
- resolveKey(fileKey) {
472
- const resolvedFileName = this.tryResolveKey(fileKey);
473
- if (undefined === resolvedFileName) {
474
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${fileKey} not resolved`);
475
- }
476
- return resolvedFileName;
477
- }
478
- /** Resolve the input file name, which may be a partial name, into a full path file name.
479
- * @param inFileName The partial file name.
480
- * @returns The resolved full path file name or `undefined` if not found.
481
- */
482
- tryResolveFileName(inFileName) { return inFileName; }
483
- /** Resolve the input file name, which may be a partial name, into a full path file name.
484
- * @param inFileName The partial file name.
485
- * @returns The resolved full path file name.
486
- * @throws [[IModelError]] if not found.
487
- */
488
- resolveFileName(inFileName) {
489
- const resolvedFileName = this.tryResolveFileName(inFileName);
490
- if (undefined === resolvedFileName) {
491
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${inFileName} not resolved`);
492
- }
493
- return resolvedFileName;
494
- }
495
- }
496
- exports.FileNameResolver = FileNameResolver;
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 IModelHost
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.FileNameResolver = exports.KnownLocations = exports.Platform = exports.IModelHost = exports.IModelHostConfiguration = void 0;
11
+ require("reflect-metadata"); // this has to be before @itwin/object-storage-* and @itwin/cloud-agnostic-core imports because those packages contain decorators that use this polyfill.
12
+ const imodeljs_native_1 = require("@bentley/imodeljs-native");
13
+ const object_storage_azure_1 = require("@itwin/object-storage-azure");
14
+ const cloud_agnostic_core_1 = require("@itwin/cloud-agnostic-core");
15
+ const object_storage_core_1 = require("@itwin/object-storage-core");
16
+ const core_bentley_1 = require("@itwin/core-bentley");
17
+ const core_common_1 = require("@itwin/core-common");
18
+ const core_telemetry_1 = require("@itwin/core-telemetry");
19
+ const inversify_1 = require("inversify");
20
+ const os = require("os");
21
+ const path = require("path");
22
+ const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
23
+ const BisCoreSchema_1 = require("./BisCoreSchema");
24
+ const BriefcaseManager_1 = require("./BriefcaseManager");
25
+ const CloudStorageBackend_1 = require("./CloudStorageBackend");
26
+ const FunctionalSchema_1 = require("./domains/FunctionalSchema");
27
+ const GenericSchema_1 = require("./domains/GenericSchema");
28
+ const GeoCoordConfig_1 = require("./GeoCoordConfig");
29
+ const IModelJsFs_1 = require("./IModelJsFs");
30
+ const DevToolsRpcImpl_1 = require("./rpc-impl/DevToolsRpcImpl");
31
+ const IModelReadRpcImpl_1 = require("./rpc-impl/IModelReadRpcImpl");
32
+ const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
33
+ const SnapshotIModelRpcImpl_1 = require("./rpc-impl/SnapshotIModelRpcImpl");
34
+ const WipRpcImpl_1 = require("./rpc-impl/WipRpcImpl");
35
+ const RpcBackend_1 = require("./RpcBackend");
36
+ const TileStorage_1 = require("./TileStorage");
37
+ const Settings_1 = require("./workspace/Settings");
38
+ const SettingsSchemas_1 = require("./workspace/SettingsSchemas");
39
+ const Workspace_1 = require("./workspace/Workspace");
40
+ const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
41
+ /** Configuration of core-backend.
42
+ * @public
43
+ */
44
+ class IModelHostConfiguration {
45
+ constructor() {
46
+ /** @internal */
47
+ this.tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
48
+ /** @internal */
49
+ this.tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
50
+ /** @internal */
51
+ this.logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;
52
+ /** @internal */
53
+ this.logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;
54
+ }
55
+ }
56
+ exports.IModelHostConfiguration = IModelHostConfiguration;
57
+ IModelHostConfiguration.defaultTileRequestTimeout = 20 * 1000;
58
+ IModelHostConfiguration.defaultLogTileLoadTimeThreshold = 40;
59
+ IModelHostConfiguration.defaultLogTileSizeThreshold = 20 * 1000000;
60
+ /** @internal */
61
+ IModelHostConfiguration.defaultMaxTileCacheDbSize = 1024 * 1024 * 1024;
62
+ /**
63
+ * Settings for `IModelHost.appWorkspace`.
64
+ * @note this includes the default dictionary from the SettingsSpecRegistry
65
+ */
66
+ class ApplicationSettings extends Settings_1.BaseSettings {
67
+ constructor() {
68
+ super();
69
+ this._remove = SettingsSchemas_1.SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());
70
+ this.updateDefaults();
71
+ }
72
+ verifyPriority(priority) {
73
+ if (priority >= Settings_1.SettingsPriority.iModel) // iModel settings may not appear in ApplicationSettings
74
+ throw new Error("Use IModelSettings");
75
+ }
76
+ updateDefaults() {
77
+ const defaults = {};
78
+ for (const [schemaName, val] of SettingsSchemas_1.SettingsSchemas.allSchemas) {
79
+ if (val.default)
80
+ defaults[schemaName] = val.default;
81
+ }
82
+ this.addDictionary("_default_", 0, defaults);
83
+ }
84
+ close() {
85
+ if (this._remove) {
86
+ this._remove();
87
+ this._remove = undefined;
88
+ }
89
+ }
90
+ }
91
+ /** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.
92
+ * See [the learning article]($docs/learning/backend/IModelHost.md)
93
+ * @public
94
+ */
95
+ class IModelHost {
96
+ constructor() { }
97
+ /** @internal */
98
+ static get platform() {
99
+ if (this._platform === undefined)
100
+ throw new Error("IModelHost.startup must be called first");
101
+ return this._platform;
102
+ }
103
+ /** A uniqueId for this session */
104
+ static get sessionId() { return this.session.sessionId; }
105
+ static set sessionId(id) { this.session.sessionId = id; }
106
+ /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */
107
+ static get applicationId() { return this.session.applicationId; }
108
+ static set applicationId(id) { this.session.applicationId = id; }
109
+ /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
110
+ static get applicationVersion() { return this.session.applicationVersion; }
111
+ static set applicationVersion(version) { this.session.applicationVersion = version; }
112
+ /** Root directory holding files that iTwin.js caches */
113
+ static get cacheDir() { return this._cacheDir; }
114
+ /** The application [[Workspace]] for this `IModelHost`
115
+ * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).
116
+ * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and
117
+ * attempting to add them to this Workspace will fail.
118
+ * @beta
119
+ */
120
+ static get appWorkspace() { return this._appWorkspace; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
121
+ /** Get the current access token for this IModelHost, or a blank string if none is available.
122
+ * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
123
+ * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
124
+ * obtains the token and forwards it to the frontend.
125
+ * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value
126
+ * returned by this method may change over time throughout the course of a session.
127
+ */
128
+ static async getAccessToken() {
129
+ var _a, _b;
130
+ try {
131
+ return (_b = (await ((_a = this.authorizationClient) === null || _a === void 0 ? void 0 : _a.getAccessToken()))) !== null && _b !== void 0 ? _b : "";
132
+ }
133
+ catch (e) {
134
+ return "";
135
+ }
136
+ }
137
+ /** @internal */
138
+ static flushLog() {
139
+ return this.platform.flushLog();
140
+ }
141
+ /** @internal */
142
+ static loadNative() {
143
+ const platform = Platform.load();
144
+ this.registerPlatform(platform);
145
+ }
146
+ static syncNativeLogLevels() {
147
+ this.platform.clearLogLevelCache();
148
+ }
149
+ static registerPlatform(platform) {
150
+ this._platform = platform;
151
+ if (undefined === platform)
152
+ return;
153
+ platform.logger = core_bentley_1.Logger;
154
+ core_bentley_1.Logger.logLevelChangedFn = () => IModelHost.syncNativeLogLevels();
155
+ }
156
+ /** @internal */
157
+ static setHubAccess(hubAccess) { this._hubAccess = hubAccess; }
158
+ /** get the current hubAccess, if present.
159
+ * @beta
160
+ */
161
+ static getHubAccess() { return this._hubAccess; }
162
+ /** Provides access to the IModelHub for this IModelHost
163
+ * @beta
164
+ * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
165
+ * To determine whether one is present, use [[getHubAccess]].
166
+ */
167
+ static get hubAccess() {
168
+ if (this._hubAccess === undefined)
169
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "No BackendHubAccess supplied in IModelHostOptions");
170
+ return this._hubAccess;
171
+ }
172
+ static initializeWorkspace(configuration) {
173
+ const settingAssets = path.join(KnownLocations.packageAssetsDir, "Settings");
174
+ SettingsSchemas_1.SettingsSchemas.addDirectory(path.join(settingAssets, "Schemas"));
175
+ this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
176
+ this.appWorkspace.settings.addDirectory(settingAssets, Settings_1.SettingsPriority.defaults);
177
+ GeoCoordConfig_1.GeoCoordConfig.onStartup();
178
+ // allow applications to load their default settings
179
+ this.onWorkspaceStartup.raiseEvent();
180
+ }
181
+ /** Returns true if IModelHost is started. */
182
+ static get isValid() { return this._isValid; }
183
+ /** This method must be called before any iTwin.js services are used.
184
+ * @param options Host configuration data.
185
+ * Raises [[onAfterStartup]].
186
+ * @see [[shutdown]].
187
+ */
188
+ static async startup(options) {
189
+ var _a, _b, _c, _d;
190
+ if (this._isValid)
191
+ return; // we're already initialized
192
+ this._isValid = true;
193
+ options = options !== null && options !== void 0 ? options : {};
194
+ if (IModelHost.sessionId === "")
195
+ IModelHost.sessionId = core_bentley_1.Guid.createValue();
196
+ this.authorizationClient = options.authorizationClient;
197
+ this.logStartup();
198
+ this.backendVersion = require("../../package.json").version; // eslint-disable-line @typescript-eslint/no-var-requires
199
+ (0, RpcBackend_1.initializeRpcBackend)(options.enableOpenTelemetry);
200
+ if (this._platform === undefined) {
201
+ try {
202
+ this.loadNative();
203
+ }
204
+ catch (error) {
205
+ core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (options));
206
+ throw error;
207
+ }
208
+ }
209
+ if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
210
+ this.platform.setCrashReporting(options.crashReportingConfig);
211
+ core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
212
+ enableCrashDumps: (_a = options.crashReportingConfig) === null || _a === void 0 ? void 0 : _a.enableCrashDumps,
213
+ wantFullMemoryDumps: (_b = options.crashReportingConfig) === null || _b === void 0 ? void 0 : _b.wantFullMemoryDumps,
214
+ enableNodeReport: (_c = options.crashReportingConfig) === null || _c === void 0 ? void 0 : _c.enableNodeReport,
215
+ uploadToBentley: (_d = options.crashReportingConfig) === null || _d === void 0 ? void 0 : _d.uploadToBentley,
216
+ });
217
+ if (options.crashReportingConfig.enableNodeReport) {
218
+ if (process.report !== undefined) {
219
+ process.report.reportOnFatalError = true;
220
+ process.report.reportOnUncaughtException = true;
221
+ process.report.directory = options.crashReportingConfig.crashDir;
222
+ core_bentley_1.Logger.logTrace(loggerCategory, "Configured Node.js crash reporting");
223
+ }
224
+ else {
225
+ core_bentley_1.Logger.logWarning(loggerCategory, "Unable to configure Node.js crash reporting");
226
+ }
227
+ }
228
+ }
229
+ this.setupHostDirs(options);
230
+ this.initializeWorkspace(options);
231
+ BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
232
+ [
233
+ IModelReadRpcImpl_1.IModelReadRpcImpl,
234
+ IModelTileRpcImpl_1.IModelTileRpcImpl,
235
+ SnapshotIModelRpcImpl_1.SnapshotIModelRpcImpl,
236
+ WipRpcImpl_1.WipRpcImpl,
237
+ DevToolsRpcImpl_1.DevToolsRpcImpl,
238
+ ].forEach((rpc) => rpc.register()); // register all of the RPC implementations
239
+ [
240
+ BisCoreSchema_1.BisCoreSchema,
241
+ GenericSchema_1.GenericSchema,
242
+ FunctionalSchema_1.FunctionalSchema,
243
+ ].forEach((schema) => schema.registerSchema()); // register all of the schemas
244
+ if (undefined !== options.hubAccess)
245
+ this._hubAccess = options.hubAccess;
246
+ this.configuration = options;
247
+ this.setupTileCache();
248
+ process.once("beforeExit", IModelHost.shutdown);
249
+ this.onAfterStartup.raiseEvent();
250
+ }
251
+ static logStartup() {
252
+ if (!core_bentley_1.Logger.isEnabled(loggerCategory, core_bentley_1.LogLevel.Trace))
253
+ return;
254
+ // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing
255
+ let startupInfo = {};
256
+ const serviceName = process.env.FABRIC_SERVICE_NAME;
257
+ if (serviceName) {
258
+ // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85
259
+ const serviceNameComponents = serviceName.split("/");
260
+ if (serviceNameComponents.length === 7) {
261
+ startupInfo = {
262
+ ...startupInfo,
263
+ iTwinId: serviceNameComponents[4],
264
+ iModelId: serviceNameComponents[5],
265
+ changesetId: serviceNameComponents[6],
266
+ };
267
+ }
268
+ }
269
+ core_bentley_1.Logger.logTrace(loggerCategory, "IModelHost.startup", () => startupInfo);
270
+ }
271
+ static setupHostDirs(configuration) {
272
+ var _a;
273
+ const setupDir = (dir) => {
274
+ dir = path.normalize(dir);
275
+ IModelJsFs_1.IModelJsFs.recursiveMkDirSync(dir);
276
+ return dir;
277
+ };
278
+ this._cacheDir = setupDir((_a = configuration.cacheDir) !== null && _a !== void 0 ? _a : imodeljs_native_1.NativeLibrary.defaultCacheDir);
279
+ this._briefcaseCacheDir = path.join(this._cacheDir, "imodels");
280
+ }
281
+ /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
282
+ static async shutdown() {
283
+ var _a;
284
+ // NB: This method is set as a node listener where `this` is unbound
285
+ if (!IModelHost._isValid)
286
+ return;
287
+ IModelHost._isValid = false;
288
+ IModelHost.onBeforeShutdown.raiseEvent();
289
+ IModelHost.configuration = undefined;
290
+ // eslint-disable-next-line deprecation/deprecation
291
+ IModelHost.tileCacheService = undefined;
292
+ // eslint-disable-next-line deprecation/deprecation
293
+ IModelHost.tileUploader = undefined;
294
+ IModelHost.tileStorage = undefined;
295
+ (_a = IModelHost._appWorkspace) === null || _a === void 0 ? void 0 : _a.close();
296
+ IModelHost._appWorkspace = undefined;
297
+ Workspace_1.ITwinWorkspace.finalize();
298
+ process.removeListener("beforeExit", IModelHost.shutdown);
299
+ }
300
+ /**
301
+ * Add or update a property that should be included in a crash report.
302
+ * @param name The name of the property
303
+ * @param value The value of the property
304
+ * @alpha
305
+ */
306
+ static setCrashReportProperty(name, value) {
307
+ (0, core_bentley_1.assert)(undefined !== this._platform);
308
+ this._platform.setCrashReportProperty(name, value);
309
+ }
310
+ /**
311
+ * Remove a previously defined property so that will not be included in a crash report.
312
+ * @param name The name of the property
313
+ * @alpha
314
+ */
315
+ static removeCrashReportProperty(name) {
316
+ (0, core_bentley_1.assert)(undefined !== this._platform);
317
+ this._platform.setCrashReportProperty(name, undefined);
318
+ }
319
+ /**
320
+ * Get all properties that will be included in a crash report.
321
+ * @alpha
322
+ */
323
+ static getCrashReportProperties() {
324
+ (0, core_bentley_1.assert)(undefined !== this._platform);
325
+ return this._platform.getCrashReportProperties();
326
+ }
327
+ /** The directory where application assets may be found */
328
+ static get appAssetsDir() { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }
329
+ /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
330
+ * @internal
331
+ */
332
+ static get tileTreeRequestTimeout() {
333
+ var _a, _b;
334
+ return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileTreeRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
335
+ }
336
+ /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a "pending" status.
337
+ * @internal
338
+ */
339
+ static get tileContentRequestTimeout() {
340
+ var _a, _b;
341
+ return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileContentRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
342
+ }
343
+ /** The backend will log when a tile took longer to load than this threshold in seconds. */
344
+ static get logTileLoadTimeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileLoadTimeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
345
+ /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
346
+ static get logTileSizeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileSizeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileSizeThreshold; }
347
+ /** Whether external tile caching is active.
348
+ * @internal
349
+ */
350
+ static get usingExternalTileCache() {
351
+ return undefined !== IModelHost.tileStorage;
352
+ }
353
+ /** Whether to restrict tile cache URLs by client IP address.
354
+ * @internal
355
+ */
356
+ static get restrictTileUrlsByClientIp() { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }
357
+ /** Whether to compress cached tiles.
358
+ * @internal
359
+ */
360
+ static get compressCachedTiles() { var _a; return false !== ((_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.compressCachedTiles); }
361
+ static setupTileCache() {
362
+ var _a;
363
+ (0, core_bentley_1.assert)(undefined !== IModelHost.configuration);
364
+ const config = IModelHost.configuration;
365
+ // eslint-disable-next-line deprecation/deprecation
366
+ const service = config.tileCacheService;
367
+ const storage = config.tileCacheStorage;
368
+ const credentials = config.tileCacheAzureCredentials;
369
+ if (!service && !storage && !credentials) {
370
+ this.platform.setMaxTileCacheSize((_a = config.maxTileCacheDbSize) !== null && _a !== void 0 ? _a : IModelHostConfiguration.defaultMaxTileCacheDbSize);
371
+ return;
372
+ }
373
+ this.platform.setMaxTileCacheSize(0);
374
+ // eslint-disable-next-line deprecation/deprecation
375
+ IModelHost.tileUploader = new CloudStorageBackend_1.CloudStorageTileUploader();
376
+ if (credentials) {
377
+ if (storage || service)
378
+ throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Cannot use both Azure and custom cloud storage providers for tile cache.");
379
+ this.setupAzureTileCache(credentials);
380
+ }
381
+ if (service) {
382
+ if (!storage)
383
+ core_bentley_1.Logger.logWarning(loggerCategory, "Using tileCacheService without tileCacheStorage is unsupported");
384
+ IModelHost.tileCacheService = service; // eslint-disable-line deprecation/deprecation
385
+ }
386
+ if (storage)
387
+ IModelHost.tileStorage = new TileStorage_1.TileStorage(storage);
388
+ }
389
+ static setupAzureTileCache(credentials) {
390
+ var _a;
391
+ const config = {
392
+ // eslint-disable-next-line @typescript-eslint/naming-convention
393
+ ServerSideStorage: {
394
+ dependencyName: "azure",
395
+ accountName: credentials.account,
396
+ accountKey: credentials.accessKey,
397
+ baseUrl: (_a = credentials.baseUrl) !== null && _a !== void 0 ? _a : `https://${credentials.account}.blob.core.windows.net`,
398
+ },
399
+ };
400
+ const ioc = new inversify_1.Container();
401
+ ioc.bind(cloud_agnostic_core_1.Types.dependenciesConfig).toConstantValue(config);
402
+ new object_storage_azure_1.AzureServerStorageBindings().register(ioc, config.ServerSideStorage);
403
+ IModelHost.tileStorage = new TileStorage_1.TileStorage(ioc.get(object_storage_core_1.ServerStorage));
404
+ // eslint-disable-next-line deprecation/deprecation
405
+ IModelHost.tileCacheService = new CloudStorageBackend_1.AzureBlobStorage(credentials); // needed for backwards compatibility with old frontends
406
+ }
407
+ /** @internal */
408
+ static computeSchemaChecksum(arg) {
409
+ return this.platform.computeSchemaChecksum(arg);
410
+ }
411
+ }
412
+ exports.IModelHost = IModelHost;
413
+ /** @alpha */
414
+ IModelHost.telemetry = new core_telemetry_1.TelemetryManager();
415
+ IModelHost.backendVersion = "";
416
+ IModelHost._cacheDir = "";
417
+ /** Event raised during startup to allow loading settings data */
418
+ IModelHost.onWorkspaceStartup = new core_bentley_1.BeEvent();
419
+ /** Event raised just after the backend IModelHost was started */
420
+ IModelHost.onAfterStartup = new core_bentley_1.BeEvent();
421
+ /** Event raised just before the backend IModelHost is to be shut down */
422
+ IModelHost.onBeforeShutdown = new core_bentley_1.BeEvent();
423
+ /** @internal */
424
+ IModelHost.session = { applicationId: "2686", applicationVersion: "1.0.0", sessionId: "" };
425
+ IModelHost._isValid = false;
426
+ /** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].
427
+ * @public
428
+ */
429
+ class Platform {
430
+ /** Get the name of the platform. */
431
+ static get platformName() {
432
+ return process.platform;
433
+ }
434
+ /** @internal */
435
+ static load() {
436
+ return core_bentley_1.ProcessDetector.isMobileAppBackend ? process._linkedBinding("iModelJsNative") : imodeljs_native_1.NativeLibrary.load();
437
+ }
438
+ }
439
+ exports.Platform = Platform;
440
+ /** Well known directories that may be used by the application. Also see [[Platform]]
441
+ * @public
442
+ */
443
+ class KnownLocations {
444
+ /** The directory where the imodeljs-native assets are stored. */
445
+ static get nativeAssetsDir() { return IModelHost.platform.DgnDb.getAssetsDir(); }
446
+ /** The directory where the core-backend assets are stored. */
447
+ static get packageAssetsDir() {
448
+ return path.join(__dirname, "assets");
449
+ }
450
+ /** The temporary directory. */
451
+ static get tmpdir() {
452
+ return os.tmpdir();
453
+ }
454
+ }
455
+ exports.KnownLocations = KnownLocations;
456
+ /** Extend this class to provide custom file name resolution behavior.
457
+ * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.
458
+ * @see [[IModelHost.snapshotFileNameResolver]]
459
+ * @public
460
+ */
461
+ class FileNameResolver {
462
+ /** Resolve a file name from the specified key.
463
+ * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.
464
+ * @returns The resolved file name or `undefined` if not found.
465
+ */
466
+ tryResolveKey(_fileKey) { return undefined; }
467
+ /** Resolve a file name from the specified key.
468
+ * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.
469
+ * @returns The resolved file name.
470
+ * @throws [[IModelError]] if not found.
471
+ */
472
+ resolveKey(fileKey) {
473
+ const resolvedFileName = this.tryResolveKey(fileKey);
474
+ if (undefined === resolvedFileName) {
475
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${fileKey} not resolved`);
476
+ }
477
+ return resolvedFileName;
478
+ }
479
+ /** Resolve the input file name, which may be a partial name, into a full path file name.
480
+ * @param inFileName The partial file name.
481
+ * @returns The resolved full path file name or `undefined` if not found.
482
+ */
483
+ tryResolveFileName(inFileName) { return inFileName; }
484
+ /** Resolve the input file name, which may be a partial name, into a full path file name.
485
+ * @param inFileName The partial file name.
486
+ * @returns The resolved full path file name.
487
+ * @throws [[IModelError]] if not found.
488
+ */
489
+ resolveFileName(inFileName) {
490
+ const resolvedFileName = this.tryResolveFileName(inFileName);
491
+ if (undefined === resolvedFileName) {
492
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${inFileName} not resolved`);
493
+ }
494
+ return resolvedFileName;
495
+ }
496
+ }
497
+ exports.FileNameResolver = FileNameResolver;
497
498
  //# sourceMappingURL=IModelHost.js.map