@itwin/core-backend 4.0.0-dev.80 → 4.0.0-dev.82

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 (116) hide show
  1. package/lib/cjs/BackendHubAccess.js.map +1 -1
  2. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  3. package/lib/cjs/BisCoreSchema.js.map +1 -1
  4. package/lib/cjs/BriefcaseManager.js.map +1 -1
  5. package/lib/cjs/Category.js.map +1 -1
  6. package/lib/cjs/ChangeSummaryManager.js +2 -2
  7. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  8. package/lib/cjs/ChangedElementsDb.js.map +1 -1
  9. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  10. package/lib/cjs/ChannelControl.js.map +1 -1
  11. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  12. package/lib/cjs/CheckpointManager.js +12 -12
  13. package/lib/cjs/CheckpointManager.js.map +1 -1
  14. package/lib/cjs/ClassRegistry.js +5 -5
  15. package/lib/cjs/ClassRegistry.js.map +1 -1
  16. package/lib/cjs/CloudSqlite.d.ts +110 -42
  17. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  18. package/lib/cjs/CloudSqlite.js +42 -7
  19. package/lib/cjs/CloudSqlite.js.map +1 -1
  20. package/lib/cjs/CodeService.d.ts +61 -20
  21. package/lib/cjs/CodeService.d.ts.map +1 -1
  22. package/lib/cjs/CodeService.js +1 -1
  23. package/lib/cjs/CodeService.js.map +1 -1
  24. package/lib/cjs/CodeSpecs.d.ts +6 -3
  25. package/lib/cjs/CodeSpecs.d.ts.map +1 -1
  26. package/lib/cjs/CodeSpecs.js +55 -25
  27. package/lib/cjs/CodeSpecs.js.map +1 -1
  28. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  29. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  30. package/lib/cjs/DevTools.js.map +1 -1
  31. package/lib/cjs/DisplayStyle.js.map +1 -1
  32. package/lib/cjs/ECDb.js.map +1 -1
  33. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  34. package/lib/cjs/ECSqlStatement.js.map +1 -1
  35. package/lib/cjs/Element.js.map +1 -1
  36. package/lib/cjs/ElementAspect.js.map +1 -1
  37. package/lib/cjs/ElementGraphics.js.map +1 -1
  38. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  39. package/lib/cjs/Entity.d.ts +1 -1
  40. package/lib/cjs/Entity.d.ts.map +1 -1
  41. package/lib/cjs/Entity.js +3 -2
  42. package/lib/cjs/Entity.js.map +1 -1
  43. package/lib/cjs/EntityReferences.js.map +1 -1
  44. package/lib/cjs/ExportGraphics.js.map +1 -1
  45. package/lib/cjs/ExternalSource.js.map +1 -1
  46. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  47. package/lib/cjs/GeometrySummary.js +47 -47
  48. package/lib/cjs/GeometrySummary.js.map +1 -1
  49. package/lib/cjs/HubMock.js.map +1 -1
  50. package/lib/cjs/IModelCloneContext.js.map +1 -1
  51. package/lib/cjs/IModelDb.d.ts +11 -5
  52. package/lib/cjs/IModelDb.d.ts.map +1 -1
  53. package/lib/cjs/IModelDb.js +15 -10
  54. package/lib/cjs/IModelDb.js.map +1 -1
  55. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  56. package/lib/cjs/IModelHost.d.ts +42 -29
  57. package/lib/cjs/IModelHost.d.ts.map +1 -1
  58. package/lib/cjs/IModelHost.js +121 -119
  59. package/lib/cjs/IModelHost.js.map +1 -1
  60. package/lib/cjs/IModelJsFs.js.map +1 -1
  61. package/lib/cjs/IpcHost.js.map +1 -1
  62. package/lib/cjs/LineStyle.js.map +1 -1
  63. package/lib/cjs/LocalHub.js +1 -1
  64. package/lib/cjs/LocalHub.js.map +1 -1
  65. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  66. package/lib/cjs/Material.js.map +1 -1
  67. package/lib/cjs/Model.js.map +1 -1
  68. package/lib/cjs/NativeAppStorage.js.map +1 -1
  69. package/lib/cjs/NativeHost.d.ts.map +1 -1
  70. package/lib/cjs/NativeHost.js +1 -3
  71. package/lib/cjs/NativeHost.js.map +1 -1
  72. package/lib/cjs/NavigationRelationship.js.map +1 -1
  73. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  74. package/lib/cjs/PropertyStore.js.map +1 -1
  75. package/lib/cjs/Relationship.js.map +1 -1
  76. package/lib/cjs/RpcBackend.js.map +1 -1
  77. package/lib/cjs/SQLiteDb.js.map +1 -1
  78. package/lib/cjs/Schema.js.map +1 -1
  79. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  80. package/lib/cjs/SqliteStatement.js.map +1 -1
  81. package/lib/cjs/Texture.js.map +1 -1
  82. package/lib/cjs/TileStorage.js.map +1 -1
  83. package/lib/cjs/TxnManager.js.map +1 -1
  84. package/lib/cjs/ViewDefinition.js.map +1 -1
  85. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  86. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  87. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  88. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  89. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  90. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  91. package/lib/cjs/core-backend.d.ts +27 -28
  92. package/lib/cjs/core-backend.d.ts.map +1 -1
  93. package/lib/cjs/core-backend.js +34 -35
  94. package/lib/cjs/core-backend.js.map +1 -1
  95. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  96. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  97. package/lib/cjs/domains/GenericElements.js.map +1 -1
  98. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  99. package/lib/cjs/rpc/multipart.js.map +1 -1
  100. package/lib/cjs/rpc/tracing.js.map +1 -1
  101. package/lib/cjs/rpc/web/logging.js.map +1 -1
  102. package/lib/cjs/rpc/web/request.js.map +1 -1
  103. package/lib/cjs/rpc/web/response.js.map +1 -1
  104. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  105. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  106. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  107. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  108. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  109. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  110. package/lib/cjs/workspace/Settings.js.map +1 -1
  111. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  112. package/lib/cjs/workspace/Workspace.d.ts +3 -6
  113. package/lib/cjs/workspace/Workspace.d.ts.map +1 -1
  114. package/lib/cjs/workspace/Workspace.js +3 -19
  115. package/lib/cjs/workspace/Workspace.js.map +1 -1
  116. package/package.json +11 -11
@@ -8,19 +8,20 @@
8
8
  */
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
10
  exports.FileNameResolver = exports.KnownLocations = exports.Platform = exports.IModelHost = exports.IModelHostConfiguration = void 0;
11
+ // To avoid circular load errors, the "Element" classes must be loaded before IModelHost.
12
+ require("./IModelDb"); // DO NOT REMOVE OR MOVE THIS LINE!
13
+ const os = require("os");
11
14
  const imodeljs_native_1 = require("@bentley/imodeljs-native");
12
- const object_storage_azure_1 = require("@itwin/object-storage-azure");
13
15
  const cloud_agnostic_core_1 = require("@itwin/cloud-agnostic-core");
14
- const object_storage_core_1 = require("@itwin/object-storage-core");
15
16
  const core_bentley_1 = require("@itwin/core-bentley");
16
17
  const core_common_1 = require("@itwin/core-common");
17
18
  const core_telemetry_1 = require("@itwin/core-telemetry");
18
- const inversify_1 = require("inversify");
19
- const os = require("os");
20
- const path = require("path");
19
+ const object_storage_azure_1 = require("@itwin/object-storage-azure");
20
+ const object_storage_core_1 = require("@itwin/object-storage-core");
21
21
  const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
22
22
  const BisCoreSchema_1 = require("./BisCoreSchema");
23
23
  const BriefcaseManager_1 = require("./BriefcaseManager");
24
+ const CloudSqlite_1 = require("./CloudSqlite");
24
25
  const FunctionalSchema_1 = require("./domains/FunctionalSchema");
25
26
  const GenericSchema_1 = require("./domains/GenericSchema");
26
27
  const GeoCoordConfig_1 = require("./GeoCoordConfig");
@@ -35,6 +36,8 @@ const TileStorage_1 = require("./TileStorage");
35
36
  const Settings_1 = require("./workspace/Settings");
36
37
  const SettingsSchemas_1 = require("./workspace/SettingsSchemas");
37
38
  const Workspace_1 = require("./workspace/Workspace");
39
+ const inversify_1 = require("inversify");
40
+ const path_1 = require("path");
38
41
  const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
39
42
  /** Configuration of core-backend.
40
43
  * @public
@@ -98,6 +101,27 @@ class IModelHost {
98
101
  throw new Error("IModelHost.startup must be called first");
99
102
  return this._platform;
100
103
  }
104
+ /**
105
+ * The name of the *Profile* directory (a subdirectory of "[[cacheDir]]/profiles/") for this process.
106
+ *
107
+ * The *Profile* directory is used to cache data that is specific to a type-of-usage of the iTwin.js library.
108
+ * It is important that information in the profile cache be consistent but isolated across sessions (i.e.
109
+ * data for a profile is maintained between runs, but each profile is completely independent and
110
+ * unaffected by the presence ot use of others.)
111
+ * @note **Only one process at a time may be using a given profile**, and an exception will be thrown by [[startup]]
112
+ * if a second process attempts to use the same profile.
113
+ * @beta
114
+ */
115
+ static get profileName() {
116
+ return this._profileName;
117
+ }
118
+ /** The full path of the Profile directory.
119
+ * @see [[profileName]]
120
+ * @beta
121
+ */
122
+ static get profileDir() {
123
+ return (0, path_1.join)(this._cacheDir, "profiles", this._profileName);
124
+ }
101
125
  /** A uniqueId for this session */
102
126
  static get sessionId() { return this.session.sessionId; }
103
127
  static set sessionId(id) { this.session.sessionId = id; }
@@ -125,7 +149,7 @@ class IModelHost {
125
149
  */
126
150
  static async getAccessToken() {
127
151
  try {
128
- return (await this.authorizationClient?.getAccessToken()) ?? "";
152
+ return (await IModelHost.authorizationClient?.getAccessToken()) ?? "";
129
153
  }
130
154
  catch (e) {
131
155
  return "";
@@ -133,22 +157,37 @@ class IModelHost {
133
157
  }
134
158
  /** @internal */
135
159
  static flushLog() {
136
- return this.platform.flushLog();
137
- }
138
- /** @internal */
139
- static loadNative() {
140
- const platform = Platform.load();
141
- this.registerPlatform(platform);
160
+ return IModelHost.platform.flushLog();
142
161
  }
143
162
  static syncNativeLogLevels() {
144
163
  this.platform.clearLogLevelCache();
145
164
  }
146
- static registerPlatform(platform) {
147
- this._platform = platform;
148
- if (undefined === platform)
165
+ static loadNative(options) {
166
+ if (undefined !== this._platform)
149
167
  return;
150
- platform.logger = core_bentley_1.Logger;
151
- core_bentley_1.Logger.logLevelChangedFn = () => IModelHost.syncNativeLogLevels();
168
+ this._platform = core_bentley_1.ProcessDetector.isMobileAppBackend ? process._linkedBinding("iModelJsNative") : imodeljs_native_1.NativeLibrary.load();
169
+ this._platform.logger = core_bentley_1.Logger;
170
+ core_bentley_1.Logger.logLevelChangedFn = () => IModelHost.syncNativeLogLevels(); // the arrow function exists only so that it can be spied in tests
171
+ if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
172
+ this.platform.setCrashReporting(options.crashReportingConfig);
173
+ core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
174
+ enableCrashDumps: options.crashReportingConfig?.enableCrashDumps,
175
+ wantFullMemoryDumps: options.crashReportingConfig?.wantFullMemoryDumps,
176
+ enableNodeReport: options.crashReportingConfig?.enableNodeReport,
177
+ uploadToBentley: options.crashReportingConfig?.uploadToBentley,
178
+ });
179
+ if (options.crashReportingConfig.enableNodeReport) {
180
+ if (process.report !== undefined) {
181
+ process.report.reportOnFatalError = true;
182
+ process.report.reportOnUncaughtException = true;
183
+ process.report.directory = options.crashReportingConfig.crashDir;
184
+ core_bentley_1.Logger.logTrace(loggerCategory, "Configured Node.js crash reporting");
185
+ }
186
+ else {
187
+ core_bentley_1.Logger.logWarning(loggerCategory, "Unable to configure Node.js crash reporting");
188
+ }
189
+ }
190
+ }
152
191
  }
153
192
  /** @internal */
154
193
  static setHubAccess(hubAccess) { this._hubAccess = hubAccess; }
@@ -162,21 +201,30 @@ class IModelHost {
162
201
  * To determine whether one is present, use [[getHubAccess]].
163
202
  */
164
203
  static get hubAccess() {
165
- if (this._hubAccess === undefined)
204
+ if (IModelHost._hubAccess === undefined)
166
205
  throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "No BackendHubAccess supplied in IModelHostOptions");
167
- return this._hubAccess;
206
+ return IModelHost._hubAccess;
168
207
  }
169
208
  static initializeWorkspace(configuration) {
170
- const settingAssets = path.join(KnownLocations.packageAssetsDir, "Settings");
171
- SettingsSchemas_1.SettingsSchemas.addDirectory(path.join(settingAssets, "Schemas"));
209
+ const settingAssets = (0, path_1.join)(KnownLocations.packageAssetsDir, "Settings");
210
+ SettingsSchemas_1.SettingsSchemas.addDirectory((0, path_1.join)(settingAssets, "Schemas"));
172
211
  this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
212
+ // Create the CloudCache for Workspaces. This will fail if another process is already using the same profile.
213
+ try {
214
+ this.appWorkspace.getCloudCache();
215
+ }
216
+ catch (e) {
217
+ throw (e.errorNumber === core_bentley_1.DbResult.BE_SQLITE_BUSY) ? new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_BUSY, `Profile [${this.profileDir}] is already in use by another process`) : e;
218
+ }
173
219
  this.appWorkspace.settings.addDirectory(settingAssets, Settings_1.SettingsPriority.defaults);
174
220
  GeoCoordConfig_1.GeoCoordConfig.onStartup();
175
221
  // allow applications to load their default settings
176
222
  this.onWorkspaceStartup.raiseEvent();
177
223
  }
178
- /** Returns true if IModelHost is started. */
179
- static get isValid() { return this._isValid; }
224
+ /** true between a successful call to [[startup]] and before [[shutdown]] */
225
+ static get isValid() {
226
+ return IModelHost._isValid;
227
+ }
180
228
  /** This method must be called before any iTwin.js services are used.
181
229
  * @param options Host configuration data.
182
230
  * Raises [[onAfterStartup]].
@@ -187,44 +235,15 @@ class IModelHost {
187
235
  return; // we're already initialized
188
236
  this._isValid = true;
189
237
  options = options ?? {};
190
- if (IModelHost.sessionId === "")
191
- IModelHost.sessionId = core_bentley_1.Guid.createValue();
238
+ if (this.sessionId === "")
239
+ this.sessionId = core_bentley_1.Guid.createValue();
192
240
  this.authorizationClient = options.authorizationClient;
193
- this.logStartup();
194
241
  this.backendVersion = require("../../package.json").version; // eslint-disable-line @typescript-eslint/no-var-requires
195
242
  (0, RpcBackend_1.initializeRpcBackend)(options.enableOpenTelemetry);
196
- if (this._platform === undefined) {
197
- try {
198
- this.loadNative();
199
- }
200
- catch (error) {
201
- core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (options));
202
- throw error;
203
- }
204
- }
205
- if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
206
- this.platform.setCrashReporting(options.crashReportingConfig);
207
- core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
208
- enableCrashDumps: options.crashReportingConfig?.enableCrashDumps,
209
- wantFullMemoryDumps: options.crashReportingConfig?.wantFullMemoryDumps,
210
- enableNodeReport: options.crashReportingConfig?.enableNodeReport,
211
- uploadToBentley: options.crashReportingConfig?.uploadToBentley,
212
- });
213
- if (options.crashReportingConfig.enableNodeReport) {
214
- if (process.report !== undefined) {
215
- process.report.reportOnFatalError = true;
216
- process.report.reportOnUncaughtException = true;
217
- process.report.directory = options.crashReportingConfig.crashDir;
218
- core_bentley_1.Logger.logTrace(loggerCategory, "Configured Node.js crash reporting");
219
- }
220
- else {
221
- core_bentley_1.Logger.logWarning(loggerCategory, "Unable to configure Node.js crash reporting");
222
- }
223
- }
224
- }
225
- this.setupHostDirs(options);
243
+ this.loadNative(options);
244
+ this.setupCacheDir(options);
226
245
  this.initializeWorkspace(options);
227
- BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
246
+ BriefcaseManager_1.BriefcaseManager.initialize((0, path_1.join)(this._cacheDir, "imodels"));
228
247
  [
229
248
  IModelReadRpcImpl_1.IModelReadRpcImpl,
230
249
  IModelTileRpcImpl_1.IModelTileRpcImpl,
@@ -244,78 +263,55 @@ class IModelHost {
244
263
  process.once("beforeExit", IModelHost.shutdown);
245
264
  this.onAfterStartup.raiseEvent();
246
265
  }
247
- static logStartup() {
248
- if (!core_bentley_1.Logger.isEnabled(loggerCategory, core_bentley_1.LogLevel.Trace))
249
- return;
250
- // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing
251
- let startupInfo = {};
252
- const serviceName = process.env.FABRIC_SERVICE_NAME;
253
- if (serviceName) {
254
- // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85
255
- const serviceNameComponents = serviceName.split("/");
256
- if (serviceNameComponents.length === 7) {
257
- startupInfo = {
258
- ...startupInfo,
259
- iTwinId: serviceNameComponents[4],
260
- iModelId: serviceNameComponents[5],
261
- changesetId: serviceNameComponents[6],
262
- };
263
- }
264
- }
265
- core_bentley_1.Logger.logTrace(loggerCategory, "IModelHost.startup", () => startupInfo);
266
- }
267
- static setupHostDirs(configuration) {
268
- const setupDir = (dir) => {
269
- dir = path.normalize(dir);
270
- IModelJsFs_1.IModelJsFs.recursiveMkDirSync(dir);
271
- return dir;
272
- };
273
- this._cacheDir = setupDir(configuration.cacheDir ?? imodeljs_native_1.NativeLibrary.defaultCacheDir);
274
- this._briefcaseCacheDir = path.join(this._cacheDir, "imodels");
266
+ static setupCacheDir(configuration) {
267
+ this._cacheDir = (0, path_1.normalize)(configuration.cacheDir ?? imodeljs_native_1.NativeLibrary.defaultCacheDir);
268
+ IModelJsFs_1.IModelJsFs.recursiveMkDirSync(this._cacheDir);
269
+ this._profileName = configuration.profileName ?? "default";
270
+ core_bentley_1.Logger.logInfo(loggerCategory, `cacheDir: [${this.cacheDir}], profileDir: [${this.profileDir}]`);
275
271
  }
276
272
  /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
277
273
  static async shutdown() {
278
- // NB: This method is set as a node listener where `this` is unbound
279
- if (!IModelHost._isValid)
274
+ // Note: This method is set as a node listener where `this` is unbound. Call private method to
275
+ // ensure `this` is correct. Don't combine these methods.
276
+ return IModelHost.doShutdown();
277
+ }
278
+ static async doShutdown() {
279
+ if (!this._isValid)
280
280
  return;
281
- IModelHost._isValid = false;
282
- IModelHost.onBeforeShutdown.raiseEvent();
283
- IModelHost.configuration = undefined;
284
- IModelHost.tileStorage = undefined;
285
- IModelHost._appWorkspace?.close();
286
- IModelHost._appWorkspace = undefined;
287
- Workspace_1.ITwinWorkspace.finalize();
281
+ this._isValid = false;
282
+ this.onBeforeShutdown.raiseEvent();
283
+ this.configuration = undefined;
284
+ this.tileStorage = undefined;
285
+ this._appWorkspace?.close();
286
+ this._appWorkspace = undefined;
287
+ CloudSqlite_1.CloudSqlite.CloudCaches.destroy();
288
288
  process.removeListener("beforeExit", IModelHost.shutdown);
289
289
  }
290
290
  /**
291
291
  * Add or update a property that should be included in a crash report.
292
- * @param name The name of the property
293
- * @param value The value of the property
294
- * @alpha
292
+ * @internal
295
293
  */
296
294
  static setCrashReportProperty(name, value) {
297
- (0, core_bentley_1.assert)(undefined !== this._platform);
298
- this._platform.setCrashReportProperty(name, value);
295
+ this.platform.setCrashReportProperty(name, value);
299
296
  }
300
297
  /**
301
298
  * Remove a previously defined property so that will not be included in a crash report.
302
- * @param name The name of the property
303
- * @alpha
299
+ * @internal
304
300
  */
305
301
  static removeCrashReportProperty(name) {
306
- (0, core_bentley_1.assert)(undefined !== this._platform);
307
- this._platform.setCrashReportProperty(name, undefined);
302
+ this.platform.setCrashReportProperty(name, undefined);
308
303
  }
309
304
  /**
310
305
  * Get all properties that will be included in a crash report.
311
- * @alpha
306
+ * @internal
312
307
  */
313
308
  static getCrashReportProperties() {
314
- (0, core_bentley_1.assert)(undefined !== this._platform);
315
- return this._platform.getCrashReportProperties();
309
+ return this.platform.getCrashReportProperties();
316
310
  }
317
311
  /** The directory where application assets may be found */
318
- static get appAssetsDir() { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }
312
+ static get appAssetsDir() {
313
+ return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined;
314
+ }
319
315
  /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
320
316
  * @internal
321
317
  */
@@ -329,9 +325,13 @@ class IModelHost {
329
325
  return IModelHost.configuration?.tileContentRequestTimeout ?? IModelHostConfiguration.defaultTileRequestTimeout;
330
326
  }
331
327
  /** The backend will log when a tile took longer to load than this threshold in seconds. */
332
- static get logTileLoadTimeThreshold() { return IModelHost.configuration?.logTileLoadTimeThreshold ?? IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
328
+ static get logTileLoadTimeThreshold() {
329
+ return IModelHost.configuration?.logTileLoadTimeThreshold ?? IModelHostConfiguration.defaultLogTileLoadTimeThreshold;
330
+ }
333
331
  /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
334
- static get logTileSizeThreshold() { return IModelHost.configuration?.logTileSizeThreshold ?? IModelHostConfiguration.defaultLogTileSizeThreshold; }
332
+ static get logTileSizeThreshold() {
333
+ return IModelHost.configuration?.logTileSizeThreshold ?? IModelHostConfiguration.defaultLogTileSizeThreshold;
334
+ }
335
335
  /** Whether external tile caching is active.
336
336
  * @internal
337
337
  */
@@ -341,11 +341,15 @@ class IModelHost {
341
341
  /** Whether to restrict tile cache URLs by client IP address.
342
342
  * @internal
343
343
  */
344
- static get restrictTileUrlsByClientIp() { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }
344
+ static get restrictTileUrlsByClientIp() {
345
+ return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false);
346
+ }
345
347
  /** Whether to compress cached tiles.
346
348
  * @internal
347
349
  */
348
- static get compressCachedTiles() { return false !== IModelHost.configuration?.compressCachedTiles; }
350
+ static get compressCachedTiles() {
351
+ return false !== IModelHost.configuration?.compressCachedTiles;
352
+ }
349
353
  static setupTileCache() {
350
354
  (0, core_bentley_1.assert)(undefined !== IModelHost.configuration);
351
355
  const config = IModelHost.configuration;
@@ -398,7 +402,7 @@ IModelHost.onBeforeShutdown = new core_bentley_1.BeEvent();
398
402
  IModelHost.session = { applicationId: "2686", applicationVersion: "1.0.0", sessionId: "" };
399
403
  IModelHost._isValid = false;
400
404
  exports.IModelHost = IModelHost;
401
- /** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].
405
+ /** Information about the platform on which the app is running.
402
406
  * @public
403
407
  */
404
408
  class Platform {
@@ -406,21 +410,19 @@ class Platform {
406
410
  static get platformName() {
407
411
  return process.platform;
408
412
  }
409
- /** @internal */
410
- static load() {
411
- return core_bentley_1.ProcessDetector.isMobileAppBackend ? process._linkedBinding("iModelJsNative") : imodeljs_native_1.NativeLibrary.load();
412
- }
413
413
  }
414
414
  exports.Platform = Platform;
415
- /** Well known directories that may be used by the application. Also see [[Platform]]
415
+ /** Well known directories that may be used by the application.
416
416
  * @public
417
417
  */
418
418
  class KnownLocations {
419
419
  /** The directory where the imodeljs-native assets are stored. */
420
- static get nativeAssetsDir() { return IModelHost.platform.DgnDb.getAssetsDir(); }
420
+ static get nativeAssetsDir() {
421
+ return IModelHost.platform.DgnDb.getAssetsDir();
422
+ }
421
423
  /** The directory where the core-backend assets are stored. */
422
424
  static get packageAssetsDir() {
423
- return path.join(__dirname, "assets");
425
+ return (0, path_1.join)(__dirname, "assets");
424
426
  }
425
427
  /** The temporary directory. */
426
428
  static get tmpdir() {
@@ -1 +1 @@
1
- {"version":3,"file":"IModelHost.js","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,8DAAyE;AACzE,sEAAyE;AACzE,oEAAyF;AACzF,oEAA2D;AAC3D,sDAA+I;AAC/I,oDAAiH;AACjH,0DAAyD;AACzD,yCAAsC;AACtC,yBAAyB;AACzB,6BAA6B;AAE7B,mEAAgE;AAChE,mDAAgD;AAChD,yDAAsD;AACtD,iEAA8D;AAC9D,2DAAwD;AACxD,qDAAkD;AAClD,6CAA0C;AAC1C,gEAA6D;AAC7D,oEAAiE;AACjE,oEAAiE;AACjE,4EAAyE;AACzE,sDAAmD;AACnD,6CAAoD;AACpD,+CAA4C;AAC5C,mDAAyF;AACzF,iEAA8D;AAC9D,qDAAiF;AAEjF,MAAM,cAAc,GAAG,6CAAqB,CAAC,UAAU,CAAC;AA+IxD;;GAEG;AACH,MAAa,uBAAuB;IAApC;QAqBE,gBAAgB;QACT,2BAAsB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAClF,gBAAgB;QACT,8BAAyB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QACrF,gBAAgB;QACT,6BAAwB,GAAG,uBAAuB,CAAC,+BAA+B,CAAC;QAC1F,gBAAgB;QACT,yBAAoB,GAAG,uBAAuB,CAAC,2BAA2B,CAAC;IAGpF,CAAC;;AA9Be,iDAAyB,GAAG,EAAE,GAAG,IAAI,AAAZ,CAAa;AACtC,uDAA+B,GAAG,EAAE,AAAL,CAAM;AACrC,mDAA2B,GAAG,EAAE,GAAG,OAAO,AAAf,CAAgB;AACzD,gBAAgB;AACF,iDAAyB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,AAArB,CAAsB;AALlD,0DAAuB;AAiCpC;;;GAGG;AACH,MAAM,mBAAoB,SAAQ,uBAAY;IAEzB,cAAc,CAAC,QAA0B;QAC1D,IAAI,QAAQ,IAAI,2BAAgB,CAAC,MAAM,EAAE,wDAAwD;YAC/F,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IACO,cAAc;QACpB,MAAM,QAAQ,GAAsB,EAAE,CAAC;QACvC,KAAK,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,iCAAe,CAAC,UAAU,EAAE;YAC1D,IAAI,GAAG,CAAC,OAAO;gBACb,QAAQ,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;SACtC;QACD,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAqB,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,iCAAe,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEe,KAAK;QACnB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,UAAU;IACrB,gBAAwB,CAAC;IAazB,gBAAgB;IACT,MAAM,KAAK,QAAQ;QACxB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAgBD,kCAAkC;IAC3B,MAAM,KAAK,SAAS,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,MAAM,KAAK,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;IAE5E,mJAAmJ;IAC5I,MAAM,KAAK,aAAa,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,aAAa,CAAC,EAAU,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC,CAAC,CAAC;IAEhF,qJAAqJ;IAC9I,MAAM,KAAK,kBAAkB,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,MAAM,KAAK,kBAAkB,CAAC,OAAe,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAEpG,wDAAwD;IACjD,MAAM,KAAK,QAAQ,KAAmB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACI,MAAM,KAAK,YAAY,KAAgB,OAAO,IAAI,CAAC,aAAc,CAAC,CAAC,CAAC,CAAC,+DAA+D;IAK3I;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc;QAChC,IAAI;YACF,OAAO,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC;SACjE;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,UAAU;QACtB,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IACO,MAAM,CAAC,mBAAmB;QAChC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACrC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,QAA+B;QAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,SAAS,KAAK,QAAQ;YACxB,OAAO;QAET,QAAQ,CAAC,MAAM,GAAG,qBAAM,CAAC;QACzB,qBAAM,CAAC,iBAAiB,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC;IACpE,CAAC;IAMD,gBAAgB;IACT,MAAM,CAAC,YAAY,CAAC,SAAuC,IAAI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;IAEpG;;OAEG;IACI,MAAM,CAAC,YAAY,KAAmC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEtF;;;;OAIG;IACI,MAAM,KAAK,SAAS;QACzB,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAC/B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,mDAAmD,CAAC,CAAC;QACtG,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,aAAgC;QACjE,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;QAC7E,iCAAe,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,GAAG,IAAI,0BAAc,CAAC,IAAI,mBAAmB,EAAE,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QAC5F,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,2BAAgB,CAAC,QAAQ,CAAC,CAAC;QAElF,+BAAc,CAAC,SAAS,EAAE,CAAC;QAC3B,oDAAoD;QACpD,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC;IACvC,CAAC;IAGD,8CAA8C;IACvC,MAAM,KAAK,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAA2B;QACrD,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO,CAAC,4BAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE;YAC7B,UAAU,CAAC,SAAS,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QAEvD,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,yDAAyD;QACtH,IAAA,iCAAoB,EAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAElD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;YAChC,IAAI;gBACF,IAAI,CAAC,UAAU,EAAE,CAAC;aACnB;YAAC,OAAO,KAAK,EAAE;gBACd,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,mDAAmD,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;gBACtG,MAAM,KAAK,CAAC;aACb;SACF;QAED,IAAI,OAAO,CAAC,oBAAoB,IAAI,OAAO,CAAC,oBAAoB,CAAC,QAAQ,IAAI,CAAC,8BAAe,CAAC,oBAAoB,IAAI,CAAC,8BAAe,CAAC,kBAAkB,EAAE;YACzJ,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YAE9D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4BAA4B,EAAE;gBAC5D,gBAAgB,EAAE,OAAO,CAAC,oBAAoB,EAAE,gBAAgB;gBAChE,mBAAmB,EAAE,OAAO,CAAC,oBAAoB,EAAE,mBAAmB;gBACtE,gBAAgB,EAAE,OAAO,CAAC,oBAAoB,EAAE,gBAAgB;gBAChE,eAAe,EAAE,OAAO,CAAC,oBAAoB,EAAE,eAAe;aAC/D,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;gBACjD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE;oBAChC,OAAO,CAAC,MAAM,CAAC,kBAAkB,GAAG,IAAI,CAAC;oBACzC,OAAO,CAAC,MAAM,CAAC,yBAAyB,GAAG,IAAI,CAAC;oBAChD,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC;oBACjE,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,oCAAoC,CAAC,CAAC;iBACvE;qBAAM;oBACL,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,6CAA6C,CAAC,CAAC;iBAClF;aACF;SACF;QAED,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAElC,mCAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAErD;YACE,qCAAiB;YACjB,qCAAiB;YACjB,6CAAqB;YACrB,uBAAU;YACV,iCAAe;SAChB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,0CAA0C;QAE9E;YACE,6BAAa;YACb,6BAAa;YACb,mCAAgB;SACjB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,8BAA8B;QAE9E,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QAEtC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAIO,MAAM,CAAC,UAAU;QACvB,IAAI,CAAC,qBAAM,CAAC,SAAS,CAAC,cAAc,EAAE,uBAAQ,CAAC,KAAK,CAAC;YACnD,OAAO;QAET,uIAAuI;QACvI,IAAI,WAAW,GAAQ,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACpD,IAAI,WAAW,EAAE;YACf,sKAAsK;YACtK,MAAM,qBAAqB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrD,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtC,WAAW,GAAG;oBACZ,GAAG,WAAW;oBACd,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;oBACjC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC;oBAClC,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAC;iBACtC,CAAC;aACH;SACF;QAED,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,oBAAoB,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,aAAgC;QAC3D,MAAM,QAAQ,GAAG,CAAC,GAAiB,EAAE,EAAE;YACrC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC1B,uBAAU,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YACnC,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,IAAI,+BAAa,CAAC,eAAe,CAAC,CAAC;QACnF,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,iGAAiG;IAC1F,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,oEAAoE;QACpE,IAAI,CAAC,UAAU,CAAC,QAAQ;YACtB,OAAO;QAET,UAAU,CAAC,QAAQ,GAAG,KAAK,CAAC;QAC5B,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;QACzC,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrC,UAAU,CAAC,WAAW,GAAG,SAAS,CAAC;QACnC,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC;QAClC,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrC,0BAAc,CAAC,QAAQ,EAAE,CAAC;QAC1B,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa;QAC9D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,yBAAyB,CAAC,IAAY;QAClD,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB;QACpC,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,EAAE,CAAC;IACnD,CAAC;IAED,0DAA0D;IACnD,MAAM,KAAK,YAAY,KAAyB,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE3J;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,UAAU,CAAC,aAAa,EAAE,sBAAsB,IAAI,uBAAuB,CAAC,yBAAyB,CAAC;IAC/G,CAAC;IACD;;OAEG;IACI,MAAM,KAAK,yBAAyB;QACzC,OAAO,UAAU,CAAC,aAAa,EAAE,yBAAyB,IAAI,uBAAuB,CAAC,yBAAyB,CAAC;IAClH,CAAC;IAED,2FAA2F;IACpF,MAAM,KAAK,wBAAwB,KAAa,OAAO,UAAU,CAAC,aAAa,EAAE,wBAAwB,IAAI,uBAAuB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IAC9K,4FAA4F;IACrF,MAAM,KAAK,oBAAoB,KAAa,OAAO,UAAU,CAAC,aAAa,EAAE,oBAAoB,IAAI,uBAAuB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAElK;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,SAAS,KAAK,UAAU,CAAC,WAAW,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,0BAA0B,KAAc,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAElL;;OAEG;IACI,MAAM,KAAK,mBAAmB,KAAc,OAAO,KAAK,KAAK,UAAU,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAE5G,MAAM,CAAC,cAAc;QAC3B,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACxC,MAAM,WAAW,GAAG,MAAM,CAAC,yBAAyB,CAAC;QAErD,IAAI,CAAC,OAAO,IAAI,CAAC,WAAW,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,CAAC,kBAAkB,IAAI,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;YAClH,OAAO;SACR;QAED,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,WAAW,EAAE;YACf,IAAI,OAAO;gBACT,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,0EAA0E,CAAC,CAAC;YACzH,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;SACvC;QACD,IAAI,OAAO;YACT,UAAU,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAwC;QACzE,MAAM,MAAM,GAAG;YACb,gEAAgE;YAChE,iBAAiB,EAAE;gBACjB,cAAc,EAAE,OAAO;gBACvB,WAAW,EAAE,WAAW,CAAC,OAAO;gBAChC,UAAU,EAAE,WAAW,CAAC,SAAS;gBACjC,OAAO,EAAE,WAAW,CAAC,OAAO,IAAI,WAAW,WAAW,CAAC,OAAO,wBAAwB;aACvF;SACF,CAAC;QACF,MAAM,GAAG,GAAc,IAAI,qBAAS,EAAE,CAAC;QACvC,GAAG,CAAC,IAAI,CAAqB,2BAAc,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACxF,IAAI,iDAA0B,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACzE,UAAU,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAa,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,qBAAqB,CAAC,GAA8E;QAChH,OAAO,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;;AAjXD,aAAa;AACU,oBAAS,GAAG,IAAI,iCAAgB,EAAE,CAAC;AAE5C,yBAAc,GAAG,EAAE,CAAC;AACnB,oBAAS,GAAG,EAAE,CAAC;AAa9B,iEAAiE;AAC1C,6BAAkB,GAAG,IAAI,sBAAO,EAAc,CAAC;AAEtE,iEAAiE;AAC1C,yBAAc,GAAG,IAAI,sBAAO,EAAc,CAAC;AAElE,yEAAyE;AAClD,2BAAgB,GAAG,IAAI,sBAAO,EAAc,CAAC;AAEpE,gBAAgB;AACO,kBAAO,GAA0B,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;AAmG/G,mBAAQ,GAAG,KAAK,CAAC;AApIrB,gCAAU;AA0XvB;;GAEG;AACH,MAAa,QAAQ;IACnB,oCAAoC;IAC7B,MAAM,KAAK,YAAY;QAC5B,OAAO,OAAO,CAAC,QAAe,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,IAAI;QAChB,OAAO,8BAAe,CAAC,kBAAkB,CAAC,CAAC,CAAE,OAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,+BAAa,CAAC,IAAI,EAAE,CAAC;IACvH,CAAC;CACF;AAVD,4BAUC;AAED;;GAEG;AACH,MAAa,cAAc;IAEzB,iEAAiE;IAC1D,MAAM,KAAK,eAAe,KAAa,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAEhG,8DAA8D;IACvD,MAAM,KAAK,gBAAgB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,+BAA+B;IACxB,MAAM,KAAK,MAAM;QACtB,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;CACF;AAdD,wCAcC;AAED;;;;GAIG;AACH,MAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAgB,IAAwB,OAAO,SAAS,CAAC,CAAC,CAAC;IAChF;;;;OAIG;IACI,UAAU,CAAC,OAAe;QAC/B,MAAM,gBAAgB,GAAuB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,OAAO,eAAe,CAAC,CAAC;SACzE;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD;;;OAGG;IACI,kBAAkB,CAAC,UAAkB,IAAwB,OAAO,UAAU,CAAC,CAAC,CAAC;IACxF;;;;OAIG;IACI,eAAe,CAAC,UAAkB;QACvC,MAAM,gBAAgB,GAAuB,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACjF,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,UAAU,eAAe,CAAC,CAAC;SAC5E;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF;AAnCD,4CAmCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module IModelHost\r\n */\r\n\r\nimport { IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { AzureServerStorageBindings } from \"@itwin/object-storage-azure\";\r\nimport { DependenciesConfig, Types as ExtensionTypes } from \"@itwin/cloud-agnostic-core\";\r\nimport { ServerStorage } from \"@itwin/object-storage-core\";\r\nimport { AccessToken, assert, BeEvent, Guid, GuidString, IModelStatus, Logger, LogLevel, Mutable, ProcessDetector } from \"@itwin/core-bentley\";\r\nimport { AuthorizationClient, BentleyStatus, IModelError, LocalDirName, SessionProps } from \"@itwin/core-common\";\r\nimport { TelemetryManager } from \"@itwin/core-telemetry\";\r\nimport { Container } from \"inversify\";\r\nimport * as os from \"os\";\r\nimport * as path from \"path\";\r\nimport { BackendHubAccess } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BisCoreSchema } from \"./BisCoreSchema\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { FunctionalSchema } from \"./domains/FunctionalSchema\";\r\nimport { GenericSchema } from \"./domains/GenericSchema\";\r\nimport { GeoCoordConfig } from \"./GeoCoordConfig\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { DevToolsRpcImpl } from \"./rpc-impl/DevToolsRpcImpl\";\r\nimport { IModelReadRpcImpl } from \"./rpc-impl/IModelReadRpcImpl\";\r\nimport { IModelTileRpcImpl } from \"./rpc-impl/IModelTileRpcImpl\";\r\nimport { SnapshotIModelRpcImpl } from \"./rpc-impl/SnapshotIModelRpcImpl\";\r\nimport { WipRpcImpl } from \"./rpc-impl/WipRpcImpl\";\r\nimport { initializeRpcBackend } from \"./RpcBackend\";\r\nimport { TileStorage } from \"./TileStorage\";\r\nimport { BaseSettings, SettingDictionary, SettingsPriority } from \"./workspace/Settings\";\r\nimport { SettingsSchemas } from \"./workspace/SettingsSchemas\";\r\nimport { ITwinWorkspace, Workspace, WorkspaceOpts } from \"./workspace/Workspace\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.IModelHost;\r\n\r\n// cspell:ignore nodereport fatalerror apicall alicloud rpcs\r\n\r\n/** @alpha */\r\nexport interface CrashReportingConfigNameValuePair {\r\n name: string;\r\n value: string;\r\n}\r\n\r\n/** Configuration of the crash-reporting system.\r\n * @alpha\r\n */\r\nexport interface CrashReportingConfig {\r\n /** The directory to which *.dmp and/or iModelJsNativeCrash*.properties.txt files are written. This directory will be created if it does not already exist. */\r\n crashDir: string;\r\n /** max # .dmp files that may exist in crashDir. The default is 50. */\r\n maxDumpsInDir?: number;\r\n /** Enable crash-dumps? If so, .dmp and .properties.txt files will be generated and written to crashDir in the event of an unhandled native-code exception. If not, only .properties.txt files will be written. The default is false. */\r\n enableCrashDumps?: boolean;\r\n /** If enableCrashDumps is true, do you want a full-memory dump? Defaults to false. */\r\n wantFullMemoryDumps?: boolean;\r\n /** Enable Node.js crash reporting? If so, report files will be generated in the event of an unhandled exception or fatal error and written to crashDir. The default is false. */\r\n enableNodeReport?: boolean;\r\n /** Additional name, value pairs to write to iModelJsNativeCrash*.properties.txt file in the event of a crash. */\r\n params?: CrashReportingConfigNameValuePair[];\r\n /** Run this .js file to process .dmp and Node.js crash reporting .json files in the event of a crash.\r\n * This script will be executed with a single command-line parameter: the name of the dump or Node.js report file.\r\n * In the case of a dump file, there will be a second file with the same basename and the extension \".properties.txt\".\r\n * Since it runs in a separate process, this script will have no access to the Javascript\r\n * context of the exiting backend. No default.\r\n */\r\n dumpProcessorScriptFileName?: string;\r\n /** Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false */\r\n uploadToBentley?: boolean;\r\n}\r\n\r\n/** @beta */\r\nexport interface AzureBlobStorageCredentials {\r\n account: string;\r\n accessKey: string;\r\n baseUrl?: string;\r\n}\r\n\r\n/**\r\n * Options for [[IModelHost.startup]]\r\n * @public\r\n */\r\nexport interface IModelHostOptions {\r\n /**\r\n * Root of the directory holding all the files that iTwin.js caches\r\n * - If not specified at startup a platform specific default is used -\r\n * - Windows: $(HOMEDIR)/AppData/Local/iModelJs/\r\n * - Mac/iOS: $(HOMEDIR)/Library/Caches/iModelJs/\r\n * - Linux: $(HOMEDIR)/.cache/iModelJs/\r\n * where $(HOMEDIR) is documented [here](https://nodejs.org/api/os.html#os_os_homedir)\r\n * - if specified, ensure it is set to a folder with read/write access.\r\n * - Sub-folders within this folder organize various caches -\r\n * - bc/ -> Briefcases\r\n * - appSettings/ -> Offline application settings (only relevant in native applications)\r\n * - etc.\r\n * @see [[IModelHost.cacheDir]] for the value it's set to after startup\r\n */\r\n cacheDir?: LocalDirName;\r\n\r\n /** The directory where application assets are found. */\r\n appAssetsDir?: LocalDirName;\r\n\r\n /**\r\n * Options for creating the [[Workspace]]\r\n * @beta\r\n */\r\n workspace?: WorkspaceOpts;\r\n\r\n /**\r\n * The kind of iModel hub server to use.\r\n * @beta\r\n */\r\n hubAccess?: BackendHubAccess;\r\n\r\n /** The Azure blob storage credentials to use for the tile cache service. If omitted and no external service implementation is provided, a local cache will be used.\r\n * @beta\r\n */\r\n tileCacheAzureCredentials?: AzureBlobStorageCredentials;\r\n\r\n /**\r\n * @beta\r\n * @note A reference implementation is set for AzureServerStorage from @itwin/object-storage-azure if [[tileCacheAzureCredentials]] property is set. To supply a different implementation for any service provider (such as AWS),\r\n * set this property with a custom ServerStorage.\r\n */\r\n tileCacheStorage?: ServerStorage;\r\n\r\n /** The maximum size in bytes to which a local sqlite database used for caching tiles can grow before it is purged of least-recently-used tiles.\r\n * The local cache is used only if an external cache has not been configured via [[tileCacheStorage]], and [[tileCacheAzureCredentials]].\r\n * Defaults to 1 GB. Must be an unsigned integer. A value of zero disables the local cache entirely.\r\n * @beta\r\n */\r\n maxTileCacheDbSize?: number;\r\n\r\n /** Whether to restrict tile cache URLs by client IP address (if available).\r\n * @beta\r\n */\r\n restrictTileUrlsByClientIp?: boolean;\r\n\r\n /** Whether to enable OpenTelemetry tracing.\r\n * Defaults to `false`.\r\n */\r\n enableOpenTelemetry?: boolean;\r\n\r\n /** Whether to compress cached tiles.\r\n * Defaults to `true`.\r\n */\r\n compressCachedTiles?: boolean;\r\n\r\n /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n */\r\n tileTreeRequestTimeout?: number;\r\n\r\n /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a \"pending\" status.\r\n * @internal\r\n */\r\n tileContentRequestTimeout?: number;\r\n\r\n /** The backend will log when a tile took longer to load than this threshold in seconds.\r\n * @internal\r\n */\r\n logTileLoadTimeThreshold?: number;\r\n\r\n /** The backend will log when a tile is loaded with a size in bytes above this threshold.\r\n * @internal\r\n */\r\n logTileSizeThreshold?: number;\r\n\r\n /** Crash-reporting configuration\r\n * @alpha\r\n */\r\n crashReportingConfig?: CrashReportingConfig;\r\n\r\n /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */\r\n authorizationClient?: AuthorizationClient;\r\n}\r\n\r\n/** Configuration of core-backend.\r\n * @public\r\n */\r\nexport class IModelHostConfiguration implements IModelHostOptions {\r\n public static defaultTileRequestTimeout = 20 * 1000;\r\n public static defaultLogTileLoadTimeThreshold = 40;\r\n public static defaultLogTileSizeThreshold = 20 * 1000000;\r\n /** @internal */\r\n public static defaultMaxTileCacheDbSize = 1024 * 1024 * 1024;\r\n\r\n public appAssetsDir?: LocalDirName;\r\n public cacheDir?: LocalDirName;\r\n\r\n /** @beta */\r\n public workspace?: WorkspaceOpts;\r\n /** @beta */\r\n public hubAccess?: BackendHubAccess;\r\n /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */\r\n public authorizationClient?: AuthorizationClient;\r\n /** @beta */\r\n public restrictTileUrlsByClientIp?: boolean;\r\n public compressCachedTiles?: boolean;\r\n /** @beta */\r\n public tileCacheAzureCredentials?: AzureBlobStorageCredentials;\r\n /** @internal */\r\n public tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n /** @internal */\r\n public tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n /** @internal */\r\n public logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\r\n /** @internal */\r\n public logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;\r\n /** @alpha */\r\n public crashReportingConfig?: CrashReportingConfig;\r\n}\r\n\r\n/**\r\n * Settings for `IModelHost.appWorkspace`.\r\n * @note this includes the default dictionary from the SettingsSpecRegistry\r\n */\r\nclass ApplicationSettings extends BaseSettings {\r\n private _remove?: VoidFunction;\r\n protected override verifyPriority(priority: SettingsPriority) {\r\n if (priority >= SettingsPriority.iModel) // iModel settings may not appear in ApplicationSettings\r\n throw new Error(\"Use IModelSettings\");\r\n }\r\n private updateDefaults() {\r\n const defaults: SettingDictionary = {};\r\n for (const [schemaName, val] of SettingsSchemas.allSchemas) {\r\n if (val.default)\r\n defaults[schemaName] = val.default;\r\n }\r\n this.addDictionary(\"_default_\", 0 as SettingsPriority, defaults);\r\n }\r\n\r\n public constructor() {\r\n super();\r\n this._remove = SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());\r\n this.updateDefaults();\r\n }\r\n\r\n public override close() {\r\n if (this._remove) {\r\n this._remove();\r\n this._remove = undefined;\r\n }\r\n }\r\n}\r\n\r\n/** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.\r\n * See [the learning article]($docs/learning/backend/IModelHost.md)\r\n * @public\r\n */\r\nexport class IModelHost {\r\n private constructor() { }\r\n\r\n /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */\r\n public static authorizationClient?: AuthorizationClient;\r\n\r\n /** @alpha */\r\n public static readonly telemetry = new TelemetryManager();\r\n\r\n public static backendVersion = \"\";\r\n private static _cacheDir = \"\";\r\n private static _appWorkspace?: Workspace;\r\n\r\n private static _platform?: typeof IModelJsNative;\r\n /** @internal */\r\n public static get platform(): typeof IModelJsNative {\r\n if (this._platform === undefined)\r\n throw new Error(\"IModelHost.startup must be called first\");\r\n return this._platform;\r\n }\r\n\r\n public static configuration?: IModelHostOptions;\r\n\r\n /** Event raised during startup to allow loading settings data */\r\n public static readonly onWorkspaceStartup = new BeEvent<() => void>();\r\n\r\n /** Event raised just after the backend IModelHost was started */\r\n public static readonly onAfterStartup = new BeEvent<() => void>();\r\n\r\n /** Event raised just before the backend IModelHost is to be shut down */\r\n public static readonly onBeforeShutdown = new BeEvent<() => void>();\r\n\r\n /** @internal */\r\n public static readonly session: Mutable<SessionProps> = { applicationId: \"2686\", applicationVersion: \"1.0.0\", sessionId: \"\" };\r\n\r\n /** A uniqueId for this session */\r\n public static get sessionId() { return this.session.sessionId; }\r\n public static set sessionId(id: GuidString) { this.session.sessionId = id; }\r\n\r\n /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */\r\n public static get applicationId() { return this.session.applicationId; }\r\n public static set applicationId(id: string) { this.session.applicationId = id; }\r\n\r\n /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */\r\n public static get applicationVersion() { return this.session.applicationVersion; }\r\n public static set applicationVersion(version: string) { this.session.applicationVersion = version; }\r\n\r\n /** Root directory holding files that iTwin.js caches */\r\n public static get cacheDir(): LocalDirName { return this._cacheDir; }\r\n\r\n /** The application [[Workspace]] for this `IModelHost`\r\n * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).\r\n * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and\r\n * attempting to add them to this Workspace will fail.\r\n * @beta\r\n */\r\n public static get appWorkspace(): Workspace { return this._appWorkspace!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n\r\n /** The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. */\r\n public static snapshotFileNameResolver?: FileNameResolver;\r\n\r\n /** Get the current access token for this IModelHost, or a blank string if none is available.\r\n * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)\r\n * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend\r\n * obtains the token and forwards it to the frontend.\r\n * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value\r\n * returned by this method may change over time throughout the course of a session.\r\n */\r\n public static async getAccessToken(): Promise<AccessToken> {\r\n try {\r\n return (await this.authorizationClient?.getAccessToken()) ?? \"\";\r\n } catch (e) {\r\n return \"\";\r\n }\r\n }\r\n\r\n /** @internal */\r\n public static flushLog() {\r\n return this.platform.flushLog();\r\n }\r\n /** @internal */\r\n public static loadNative(): void {\r\n const platform = Platform.load();\r\n this.registerPlatform(platform);\r\n }\r\n private static syncNativeLogLevels() {\r\n this.platform.clearLogLevelCache();\r\n }\r\n\r\n private static registerPlatform(platform: typeof IModelJsNative): void {\r\n this._platform = platform;\r\n if (undefined === platform)\r\n return;\r\n\r\n platform.logger = Logger;\r\n Logger.logLevelChangedFn = () => IModelHost.syncNativeLogLevels();\r\n }\r\n\r\n /** @internal */\r\n public static tileStorage?: TileStorage;\r\n\r\n private static _hubAccess?: BackendHubAccess;\r\n /** @internal */\r\n public static setHubAccess(hubAccess: BackendHubAccess | undefined) { this._hubAccess = hubAccess; }\r\n\r\n /** get the current hubAccess, if present.\r\n * @beta\r\n */\r\n public static getHubAccess(): BackendHubAccess | undefined { return this._hubAccess; }\r\n\r\n /** Provides access to the IModelHub for this IModelHost\r\n * @beta\r\n * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.\r\n * To determine whether one is present, use [[getHubAccess]].\r\n */\r\n public static get hubAccess(): BackendHubAccess {\r\n if (this._hubAccess === undefined)\r\n throw new IModelError(IModelStatus.BadRequest, \"No BackendHubAccess supplied in IModelHostOptions\");\r\n return this._hubAccess;\r\n }\r\n\r\n private static initializeWorkspace(configuration: IModelHostOptions) {\r\n const settingAssets = path.join(KnownLocations.packageAssetsDir, \"Settings\");\r\n SettingsSchemas.addDirectory(path.join(settingAssets, \"Schemas\"));\r\n this._appWorkspace = new ITwinWorkspace(new ApplicationSettings(), configuration.workspace);\r\n this.appWorkspace.settings.addDirectory(settingAssets, SettingsPriority.defaults);\r\n\r\n GeoCoordConfig.onStartup();\r\n // allow applications to load their default settings\r\n this.onWorkspaceStartup.raiseEvent();\r\n }\r\n\r\n private static _isValid = false;\r\n /** Returns true if IModelHost is started. */\r\n public static get isValid() { return this._isValid; }\r\n /** This method must be called before any iTwin.js services are used.\r\n * @param options Host configuration data.\r\n * Raises [[onAfterStartup]].\r\n * @see [[shutdown]].\r\n */\r\n public static async startup(options?: IModelHostOptions): Promise<void> {\r\n if (this._isValid)\r\n return; // we're already initialized\r\n this._isValid = true;\r\n\r\n options = options ?? {};\r\n if (IModelHost.sessionId === \"\")\r\n IModelHost.sessionId = Guid.createValue();\r\n\r\n this.authorizationClient = options.authorizationClient;\r\n\r\n this.logStartup();\r\n\r\n this.backendVersion = require(\"../../package.json\").version; // eslint-disable-line @typescript-eslint/no-var-requires\r\n initializeRpcBackend(options.enableOpenTelemetry);\r\n\r\n if (this._platform === undefined) {\r\n try {\r\n this.loadNative();\r\n } catch (error) {\r\n Logger.logError(loggerCategory, \"Error registering/loading the native platform API\", () => (options));\r\n throw error;\r\n }\r\n }\r\n\r\n if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !ProcessDetector.isElectronAppBackend && !ProcessDetector.isMobileAppBackend) {\r\n this.platform.setCrashReporting(options.crashReportingConfig);\r\n\r\n Logger.logTrace(loggerCategory, \"Configured crash reporting\", {\r\n enableCrashDumps: options.crashReportingConfig?.enableCrashDumps,\r\n wantFullMemoryDumps: options.crashReportingConfig?.wantFullMemoryDumps,\r\n enableNodeReport: options.crashReportingConfig?.enableNodeReport,\r\n uploadToBentley: options.crashReportingConfig?.uploadToBentley,\r\n });\r\n\r\n if (options.crashReportingConfig.enableNodeReport) {\r\n if (process.report !== undefined) {\r\n process.report.reportOnFatalError = true;\r\n process.report.reportOnUncaughtException = true;\r\n process.report.directory = options.crashReportingConfig.crashDir;\r\n Logger.logTrace(loggerCategory, \"Configured Node.js crash reporting\");\r\n } else {\r\n Logger.logWarning(loggerCategory, \"Unable to configure Node.js crash reporting\");\r\n }\r\n }\r\n }\r\n\r\n this.setupHostDirs(options);\r\n this.initializeWorkspace(options);\r\n\r\n BriefcaseManager.initialize(this._briefcaseCacheDir);\r\n\r\n [\r\n IModelReadRpcImpl,\r\n IModelTileRpcImpl,\r\n SnapshotIModelRpcImpl,\r\n WipRpcImpl,\r\n DevToolsRpcImpl,\r\n ].forEach((rpc) => rpc.register()); // register all of the RPC implementations\r\n\r\n [\r\n BisCoreSchema,\r\n GenericSchema,\r\n FunctionalSchema,\r\n ].forEach((schema) => schema.registerSchema()); // register all of the schemas\r\n\r\n if (undefined !== options.hubAccess)\r\n this._hubAccess = options.hubAccess;\r\n\r\n this.configuration = options;\r\n this.setupTileCache();\r\n\r\n process.once(\"beforeExit\", IModelHost.shutdown);\r\n this.onAfterStartup.raiseEvent();\r\n }\r\n\r\n private static _briefcaseCacheDir: LocalDirName;\r\n\r\n private static logStartup() {\r\n if (!Logger.isEnabled(loggerCategory, LogLevel.Trace))\r\n return;\r\n\r\n // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing\r\n let startupInfo: any = {};\r\n const serviceName = process.env.FABRIC_SERVICE_NAME;\r\n if (serviceName) {\r\n // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85\r\n const serviceNameComponents = serviceName.split(\"/\");\r\n if (serviceNameComponents.length === 7) {\r\n startupInfo = {\r\n ...startupInfo,\r\n iTwinId: serviceNameComponents[4],\r\n iModelId: serviceNameComponents[5],\r\n changesetId: serviceNameComponents[6],\r\n };\r\n }\r\n }\r\n\r\n Logger.logTrace(loggerCategory, \"IModelHost.startup\", () => startupInfo);\r\n }\r\n\r\n private static setupHostDirs(configuration: IModelHostOptions) {\r\n const setupDir = (dir: LocalDirName) => {\r\n dir = path.normalize(dir);\r\n IModelJsFs.recursiveMkDirSync(dir);\r\n return dir;\r\n };\r\n this._cacheDir = setupDir(configuration.cacheDir ?? NativeLibrary.defaultCacheDir);\r\n this._briefcaseCacheDir = path.join(this._cacheDir, \"imodels\");\r\n }\r\n\r\n /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */\r\n public static async shutdown(): Promise<void> {\r\n // NB: This method is set as a node listener where `this` is unbound\r\n if (!IModelHost._isValid)\r\n return;\r\n\r\n IModelHost._isValid = false;\r\n IModelHost.onBeforeShutdown.raiseEvent();\r\n IModelHost.configuration = undefined;\r\n IModelHost.tileStorage = undefined;\r\n IModelHost._appWorkspace?.close();\r\n IModelHost._appWorkspace = undefined;\r\n ITwinWorkspace.finalize();\r\n process.removeListener(\"beforeExit\", IModelHost.shutdown);\r\n }\r\n\r\n /**\r\n * Add or update a property that should be included in a crash report.\r\n * @param name The name of the property\r\n * @param value The value of the property\r\n * @alpha\r\n */\r\n public static setCrashReportProperty(name: string, value: string): void {\r\n assert(undefined !== this._platform);\r\n this._platform.setCrashReportProperty(name, value);\r\n }\r\n\r\n /**\r\n * Remove a previously defined property so that will not be included in a crash report.\r\n * @param name The name of the property\r\n * @alpha\r\n */\r\n public static removeCrashReportProperty(name: string): void {\r\n assert(undefined !== this._platform);\r\n this._platform.setCrashReportProperty(name, undefined);\r\n }\r\n\r\n /**\r\n * Get all properties that will be included in a crash report.\r\n * @alpha\r\n */\r\n public static getCrashReportProperties(): CrashReportingConfigNameValuePair[] {\r\n assert(undefined !== this._platform);\r\n return this._platform.getCrashReportProperties();\r\n }\r\n\r\n /** The directory where application assets may be found */\r\n public static get appAssetsDir(): string | undefined { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }\r\n\r\n /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a \"pending\" status.\r\n * @internal\r\n */\r\n public static get tileTreeRequestTimeout(): number {\r\n return IModelHost.configuration?.tileTreeRequestTimeout ?? IModelHostConfiguration.defaultTileRequestTimeout;\r\n }\r\n /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a \"pending\" status.\r\n * @internal\r\n */\r\n public static get tileContentRequestTimeout(): number {\r\n return IModelHost.configuration?.tileContentRequestTimeout ?? IModelHostConfiguration.defaultTileRequestTimeout;\r\n }\r\n\r\n /** The backend will log when a tile took longer to load than this threshold in seconds. */\r\n public static get logTileLoadTimeThreshold(): number { return IModelHost.configuration?.logTileLoadTimeThreshold ?? IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }\r\n /** The backend will log when a tile is loaded with a size in bytes above this threshold. */\r\n public static get logTileSizeThreshold(): number { return IModelHost.configuration?.logTileSizeThreshold ?? IModelHostConfiguration.defaultLogTileSizeThreshold; }\r\n\r\n /** Whether external tile caching is active.\r\n * @internal\r\n */\r\n public static get usingExternalTileCache(): boolean {\r\n return undefined !== IModelHost.tileStorage;\r\n }\r\n\r\n /** Whether to restrict tile cache URLs by client IP address.\r\n * @internal\r\n */\r\n public static get restrictTileUrlsByClientIp(): boolean { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }\r\n\r\n /** Whether to compress cached tiles.\r\n * @internal\r\n */\r\n public static get compressCachedTiles(): boolean { return false !== IModelHost.configuration?.compressCachedTiles; }\r\n\r\n private static setupTileCache() {\r\n assert(undefined !== IModelHost.configuration);\r\n const config = IModelHost.configuration;\r\n const storage = config.tileCacheStorage;\r\n const credentials = config.tileCacheAzureCredentials;\r\n\r\n if (!storage && !credentials) {\r\n this.platform.setMaxTileCacheSize(config.maxTileCacheDbSize ?? IModelHostConfiguration.defaultMaxTileCacheDbSize);\r\n return;\r\n }\r\n\r\n this.platform.setMaxTileCacheSize(0);\r\n if (credentials) {\r\n if (storage)\r\n throw new IModelError(BentleyStatus.ERROR, \"Cannot use both Azure and custom cloud storage providers for tile cache.\");\r\n this.setupAzureTileCache(credentials);\r\n }\r\n if (storage)\r\n IModelHost.tileStorage = new TileStorage(storage);\r\n }\r\n\r\n private static setupAzureTileCache(credentials: AzureBlobStorageCredentials) {\r\n const config = {\r\n // eslint-disable-next-line @typescript-eslint/naming-convention\r\n ServerSideStorage: {\r\n dependencyName: \"azure\",\r\n accountName: credentials.account,\r\n accountKey: credentials.accessKey,\r\n baseUrl: credentials.baseUrl ?? `https://${credentials.account}.blob.core.windows.net`,\r\n },\r\n };\r\n const ioc: Container = new Container();\r\n ioc.bind<DependenciesConfig>(ExtensionTypes.dependenciesConfig).toConstantValue(config);\r\n new AzureServerStorageBindings().register(ioc, config.ServerSideStorage);\r\n IModelHost.tileStorage = new TileStorage(ioc.get(ServerStorage));\r\n }\r\n\r\n /** @internal */\r\n public static computeSchemaChecksum(arg: { schemaXmlPath: string, referencePaths: string[], exactMatch?: boolean }): string {\r\n return this.platform.computeSchemaChecksum(arg);\r\n }\r\n}\r\n\r\n/** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].\r\n * @public\r\n */\r\nexport class Platform {\r\n /** Get the name of the platform. */\r\n public static get platformName(): \"win32\" | \"linux\" | \"darwin\" | \"ios\" | \"android\" | \"uwp\" {\r\n return process.platform as any;\r\n }\r\n\r\n /** @internal */\r\n public static load(): typeof IModelJsNative {\r\n return ProcessDetector.isMobileAppBackend ? (process as any)._linkedBinding(\"iModelJsNative\") : NativeLibrary.load();\r\n }\r\n}\r\n\r\n/** Well known directories that may be used by the application. Also see [[Platform]]\r\n * @public\r\n */\r\nexport class KnownLocations {\r\n\r\n /** The directory where the imodeljs-native assets are stored. */\r\n public static get nativeAssetsDir(): string { return IModelHost.platform.DgnDb.getAssetsDir(); }\r\n\r\n /** The directory where the core-backend assets are stored. */\r\n public static get packageAssetsDir(): string {\r\n return path.join(__dirname, \"assets\");\r\n }\r\n\r\n /** The temporary directory. */\r\n public static get tmpdir(): string {\r\n return os.tmpdir();\r\n }\r\n}\r\n\r\n/** Extend this class to provide custom file name resolution behavior.\r\n * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.\r\n * @see [[IModelHost.snapshotFileNameResolver]]\r\n * @public\r\n */\r\nexport abstract class FileNameResolver {\r\n /** Resolve a file name from the specified key.\r\n * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.\r\n * @returns The resolved file name or `undefined` if not found.\r\n */\r\n public tryResolveKey(_fileKey: string): string | undefined { return undefined; }\r\n /** Resolve a file name from the specified key.\r\n * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.\r\n * @returns The resolved file name.\r\n * @throws [[IModelError]] if not found.\r\n */\r\n public resolveKey(fileKey: string): string {\r\n const resolvedFileName: string | undefined = this.tryResolveKey(fileKey);\r\n if (undefined === resolvedFileName) {\r\n throw new IModelError(IModelStatus.NotFound, `${fileKey} not resolved`);\r\n }\r\n return resolvedFileName;\r\n }\r\n /** Resolve the input file name, which may be a partial name, into a full path file name.\r\n * @param inFileName The partial file name.\r\n * @returns The resolved full path file name or `undefined` if not found.\r\n */\r\n public tryResolveFileName(inFileName: string): string | undefined { return inFileName; }\r\n /** Resolve the input file name, which may be a partial name, into a full path file name.\r\n * @param inFileName The partial file name.\r\n * @returns The resolved full path file name.\r\n * @throws [[IModelError]] if not found.\r\n */\r\n public resolveFileName(inFileName: string): string {\r\n const resolvedFileName: string | undefined = this.tryResolveFileName(inFileName);\r\n if (undefined === resolvedFileName) {\r\n throw new IModelError(IModelStatus.NotFound, `${inFileName} not resolved`);\r\n }\r\n return resolvedFileName;\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"IModelHost.js","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yFAAyF;AACzF,sBAAoB,CAAC,mCAAmC;AAExD,yBAAyB;AACzB,8DAAyE;AACzE,oEAAyF;AACzF,sDAA+I;AAC/I,oDAAiH;AACjH,0DAAyD;AACzD,sEAAyE;AACzE,oEAA2D;AAE3D,mEAAgE;AAChE,mDAAgD;AAChD,yDAAsD;AACtD,+CAA4C;AAC5C,iEAA8D;AAC9D,2DAAwD;AACxD,qDAAkD;AAClD,6CAA0C;AAC1C,gEAA6D;AAC7D,oEAAiE;AACjE,oEAAiE;AACjE,4EAAyE;AACzE,sDAAmD;AACnD,6CAAoD;AACpD,+CAA4C;AAC5C,mDAAyF;AACzF,iEAA8D;AAC9D,qDAAiF;AACjF,yCAAsC;AACtC,+BAAuD;AAEvD,MAAM,cAAc,GAAG,6CAAqB,CAAC,UAAU,CAAC;AAkJxD;;GAEG;AACH,MAAa,uBAAuB;IAApC;QAqBE,gBAAgB;QACT,2BAAsB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAClF,gBAAgB;QACT,8BAAyB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QACrF,gBAAgB;QACT,6BAAwB,GAAG,uBAAuB,CAAC,+BAA+B,CAAC;QAC1F,gBAAgB;QACT,yBAAoB,GAAG,uBAAuB,CAAC,2BAA2B,CAAC;IAGpF,CAAC;;AA9Be,iDAAyB,GAAG,EAAE,GAAG,IAAI,AAAZ,CAAa;AACtC,uDAA+B,GAAG,EAAE,AAAL,CAAM;AACrC,mDAA2B,GAAG,EAAE,GAAG,OAAO,AAAf,CAAgB;AACzD,gBAAgB;AACF,iDAAyB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,AAArB,CAAsB;AALlD,0DAAuB;AAiCpC;;;GAGG;AACH,MAAM,mBAAoB,SAAQ,uBAAY;IAEzB,cAAc,CAAC,QAA0B;QAC1D,IAAI,QAAQ,IAAI,2BAAgB,CAAC,MAAM,EAAE,wDAAwD;YAC/F,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IACO,cAAc;QACpB,MAAM,QAAQ,GAAsB,EAAE,CAAC;QACvC,KAAK,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,iCAAe,CAAC,UAAU,EAAE;YAC1D,IAAI,GAAG,CAAC,OAAO;gBACb,QAAQ,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;SACtC;QACD,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAqB,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,iCAAe,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEe,KAAK;QACnB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,UAAU;IACrB,gBAAwB,CAAC;IAczB,gBAAgB;IACT,MAAM,KAAK,QAAQ;QACxB,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;YAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAID;;;;;;;;;;OAUG;IACI,MAAM,KAAK,WAAW;QAC3B,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;IAcD,kCAAkC;IAC3B,MAAM,KAAK,SAAS,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,MAAM,KAAK,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC;IAE5E,mJAAmJ;IAC5I,MAAM,KAAK,aAAa,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,aAAa,CAAC,EAAU,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC,CAAC,CAAC;IAEhF,qJAAqJ;IAC9I,MAAM,KAAK,kBAAkB,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,MAAM,KAAK,kBAAkB,CAAC,OAAe,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAEpG,wDAAwD;IACjD,MAAM,KAAK,QAAQ,KAAmB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACI,MAAM,KAAK,YAAY,KAAgB,OAAO,IAAI,CAAC,aAAc,CAAC,CAAC,CAAC,CAAC,+DAA+D;IAK3I;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc;QAChC,IAAI;YACF,OAAO,CAAC,MAAM,UAAU,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC;SACvE;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,QAAQ;QACpB,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACxC,CAAC;IAEO,MAAM,CAAC,mBAAmB;QAChC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACrC,CAAC;IACO,MAAM,CAAC,UAAU,CAAC,OAA0B;QAClD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO;QAET,IAAI,CAAC,SAAS,GAAG,8BAAe,CAAC,kBAAkB,CAAC,CAAC,CAAE,OAAe,CAAC,cAAc,CAAC,gBAAgB,CAA0B,CAAC,CAAC,CAAC,+BAAa,CAAC,IAAI,EAAE,CAAC;QACxJ,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,qBAAM,CAAC;QAC/B,qBAAM,CAAC,iBAAiB,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC,kEAAkE;QAErI,IAAI,OAAO,CAAC,oBAAoB,IAAI,OAAO,CAAC,oBAAoB,CAAC,QAAQ,IAAI,CAAC,8BAAe,CAAC,oBAAoB,IAAI,CAAC,8BAAe,CAAC,kBAAkB,EAAE;YACzJ,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;YAE9D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4BAA4B,EAAE;gBAC5D,gBAAgB,EAAE,OAAO,CAAC,oBAAoB,EAAE,gBAAgB;gBAChE,mBAAmB,EAAE,OAAO,CAAC,oBAAoB,EAAE,mBAAmB;gBACtE,gBAAgB,EAAE,OAAO,CAAC,oBAAoB,EAAE,gBAAgB;gBAChE,eAAe,EAAE,OAAO,CAAC,oBAAoB,EAAE,eAAe;aAC/D,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;gBACjD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE;oBAChC,OAAO,CAAC,MAAM,CAAC,kBAAkB,GAAG,IAAI,CAAC;oBACzC,OAAO,CAAC,MAAM,CAAC,yBAAyB,GAAG,IAAI,CAAC;oBAChD,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC;oBACjE,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,oCAAoC,CAAC,CAAC;iBACvE;qBAAM;oBACL,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,6CAA6C,CAAC,CAAC;iBAClF;aACF;SACF;IACH,CAAC;IAMD,gBAAgB;IACT,MAAM,CAAC,YAAY,CAAC,SAAuC,IAAI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;IAEpG;;OAEG;IACI,MAAM,CAAC,YAAY,KAAmC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEtF;;;;OAIG;IACI,MAAM,KAAK,SAAS;QACzB,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS;YACrC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,mDAAmD,CAAC,CAAC;QACtG,OAAO,UAAU,CAAC,UAAU,CAAC;IAC/B,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,aAAgC;QACjE,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,cAAc,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;QACxE,iCAAe,CAAC,YAAY,CAAC,IAAA,WAAI,EAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,aAAa,GAAG,IAAI,0BAAc,CAAC,IAAI,mBAAmB,EAAE,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QAE5F,6GAA6G;QAC7G,IAAI;YACF,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;SACnC;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,CAAC,CAAC,CAAC,WAAW,KAAK,uBAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,yBAAW,CAAC,uBAAQ,CAAC,cAAc,EAAE,YAAY,IAAI,CAAC,UAAU,wCAAwC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvK;QAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,2BAAgB,CAAC,QAAQ,CAAC,CAAC;QAElF,+BAAc,CAAC,SAAS,EAAE,CAAC;QAC3B,oDAAoD;QACpD,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC;IACvC,CAAC;IAID,4EAA4E;IACrE,MAAM,KAAK,OAAO;QACvB,OAAO,UAAU,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAA2B;QACrD,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO,CAAC,4BAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,IAAI,CAAC,SAAS,KAAK,EAAE;YACvB,IAAI,CAAC,SAAS,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAEtC,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QAEvD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,yDAAyD;QACtH,IAAA,iCAAoB,EAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAElD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAElC,mCAAgB,CAAC,UAAU,CAAC,IAAA,WAAI,EAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;QAE7D;YACE,qCAAiB;YACjB,qCAAiB;YACjB,6CAAqB;YACrB,uBAAU;YACV,iCAAe;SAChB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,0CAA0C;QAE9E;YACE,6BAAa;YACb,6BAAa;YACb,mCAAgB;SACjB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,8BAA8B;QAE9E,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QAEtC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,aAAgC;QAC3D,IAAI,CAAC,SAAS,GAAG,IAAA,gBAAY,EAAC,aAAa,CAAC,QAAQ,IAAI,+BAAa,CAAC,eAAe,CAAC,CAAC;QACvF,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,CAAC,YAAY,GAAG,aAAa,CAAC,WAAW,IAAI,SAAS,CAAC;QAC3D,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,IAAI,CAAC,QAAQ,mBAAmB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;IACnG,CAAC;IAED,iGAAiG;IAC1F,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,8FAA8F;QAC9F,yDAAyD;QACzD,OAAO,UAAU,CAAC,UAAU,EAAE,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,OAAO;QAET,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAE/B,yBAAW,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAClC,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAY,EAAE,KAAa;QAC9D,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,yBAAyB,CAAC,IAAY;QAClD,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAC;IAClD,CAAC;IAED,0DAA0D;IACnD,MAAM,KAAK,YAAY;QAC5B,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;IACpG,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,UAAU,CAAC,aAAa,EAAE,sBAAsB,IAAI,uBAAuB,CAAC,yBAAyB,CAAC;IAC/G,CAAC;IACD;;OAEG;IACI,MAAM,KAAK,yBAAyB;QACzC,OAAO,UAAU,CAAC,aAAa,EAAE,yBAAyB,IAAI,uBAAuB,CAAC,yBAAyB,CAAC;IAClH,CAAC;IAED,2FAA2F;IACpF,MAAM,KAAK,wBAAwB;QACxC,OAAO,UAAU,CAAC,aAAa,EAAE,wBAAwB,IAAI,uBAAuB,CAAC,+BAA+B,CAAC;IACvH,CAAC;IACD,4FAA4F;IACrF,MAAM,KAAK,oBAAoB;QACpC,OAAO,UAAU,CAAC,aAAa,EAAE,oBAAoB,IAAI,uBAAuB,CAAC,2BAA2B,CAAC;IAC/G,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,SAAS,KAAK,UAAU,CAAC,WAAW,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,0BAA0B;QAC1C,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxH,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,mBAAmB;QACnC,OAAO,KAAK,KAAK,UAAU,CAAC,aAAa,EAAE,mBAAmB,CAAC;IACjE,CAAC;IAEO,MAAM,CAAC,cAAc;QAC3B,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC;QACxC,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC;QACxC,MAAM,WAAW,GAAG,MAAM,CAAC,yBAAyB,CAAC;QAErD,IAAI,CAAC,OAAO,IAAI,CAAC,WAAW,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,CAAC,kBAAkB,IAAI,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;YAClH,OAAO;SACR;QAED,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,WAAW,EAAE;YACf,IAAI,OAAO;gBACT,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,0EAA0E,CAAC,CAAC;YACzH,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;SACvC;QACD,IAAI,OAAO;YACT,UAAU,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,WAAwC;QACzE,MAAM,MAAM,GAAG;YACb,gEAAgE;YAChE,iBAAiB,EAAE;gBACjB,cAAc,EAAE,OAAO;gBACvB,WAAW,EAAE,WAAW,CAAC,OAAO;gBAChC,UAAU,EAAE,WAAW,CAAC,SAAS;gBACjC,OAAO,EAAE,WAAW,CAAC,OAAO,IAAI,WAAW,WAAW,CAAC,OAAO,wBAAwB;aACvF;SACF,CAAC;QACF,MAAM,GAAG,GAAc,IAAI,qBAAS,EAAE,CAAC;QACvC,GAAG,CAAC,IAAI,CAAqB,2BAAc,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACxF,IAAI,iDAA0B,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACzE,UAAU,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAa,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,qBAAqB,CAAC,GAA8E;QAChH,OAAO,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAClD,CAAC;;AArXD,aAAa;AACU,oBAAS,GAAG,IAAI,iCAAgB,EAAE,CAAC;AAE5C,yBAAc,GAAG,EAAE,CAAC;AAEnB,oBAAS,GAAG,EAAE,CAAC;AAoC9B,iEAAiE;AAC1C,6BAAkB,GAAG,IAAI,sBAAO,EAAc,CAAC;AAEtE,iEAAiE;AAC1C,yBAAc,GAAG,IAAI,sBAAO,EAAc,CAAC;AAElE,yEAAyE;AAClD,2BAAgB,GAAG,IAAI,sBAAO,EAAc,CAAC;AAEpE,gBAAgB;AACO,kBAAO,GAA0B,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;AA4H/G,mBAAQ,GAAG,KAAK,CAAC;AArLrB,gCAAU;AA8XvB;;GAEG;AACH,MAAa,QAAQ;IACnB,oCAAoC;IAC7B,MAAM,KAAK,YAAY;QAC5B,OAAO,OAAO,CAAC,QAAe,CAAC;IACjC,CAAC;CACF;AALD,4BAKC;AAED;;GAEG;AACH,MAAa,cAAc;IAEzB,iEAAiE;IAC1D,MAAM,KAAK,eAAe;QAC/B,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;IAClD,CAAC;IAED,8DAA8D;IACvD,MAAM,KAAK,gBAAgB;QAChC,OAAO,IAAA,WAAI,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,+BAA+B;IACxB,MAAM,KAAK,MAAM;QACtB,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;CACF;AAhBD,wCAgBC;AAED;;;;GAIG;AACH,MAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAgB,IAAwB,OAAO,SAAS,CAAC,CAAC,CAAC;IAChF;;;;OAIG;IACI,UAAU,CAAC,OAAe;QAC/B,MAAM,gBAAgB,GAAuB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,OAAO,eAAe,CAAC,CAAC;SACzE;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD;;;OAGG;IACI,kBAAkB,CAAC,UAAkB,IAAwB,OAAO,UAAU,CAAC,CAAC,CAAC;IACxF;;;;OAIG;IACI,eAAe,CAAC,UAAkB;QACvC,MAAM,gBAAgB,GAAuB,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACjF,IAAI,SAAS,KAAK,gBAAgB,EAAE;YAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,GAAG,UAAU,eAAe,CAAC,CAAC;SAC5E;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF;AAnCD,4CAmCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module IModelHost\n */\n\n// To avoid circular load errors, the \"Element\" classes must be loaded before IModelHost.\nimport \"./IModelDb\"; // DO NOT REMOVE OR MOVE THIS LINE!\n\nimport * as os from \"os\";\nimport { IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\nimport { DependenciesConfig, Types as ExtensionTypes } from \"@itwin/cloud-agnostic-core\";\nimport { AccessToken, assert, BeEvent, DbResult, Guid, GuidString, IModelStatus, Logger, Mutable, ProcessDetector } from \"@itwin/core-bentley\";\nimport { AuthorizationClient, BentleyStatus, IModelError, LocalDirName, SessionProps } from \"@itwin/core-common\";\nimport { TelemetryManager } from \"@itwin/core-telemetry\";\nimport { AzureServerStorageBindings } from \"@itwin/object-storage-azure\";\nimport { ServerStorage } from \"@itwin/object-storage-core\";\nimport { BackendHubAccess } from \"./BackendHubAccess\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { BisCoreSchema } from \"./BisCoreSchema\";\nimport { BriefcaseManager } from \"./BriefcaseManager\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { FunctionalSchema } from \"./domains/FunctionalSchema\";\nimport { GenericSchema } from \"./domains/GenericSchema\";\nimport { GeoCoordConfig } from \"./GeoCoordConfig\";\nimport { IModelJsFs } from \"./IModelJsFs\";\nimport { DevToolsRpcImpl } from \"./rpc-impl/DevToolsRpcImpl\";\nimport { IModelReadRpcImpl } from \"./rpc-impl/IModelReadRpcImpl\";\nimport { IModelTileRpcImpl } from \"./rpc-impl/IModelTileRpcImpl\";\nimport { SnapshotIModelRpcImpl } from \"./rpc-impl/SnapshotIModelRpcImpl\";\nimport { WipRpcImpl } from \"./rpc-impl/WipRpcImpl\";\nimport { initializeRpcBackend } from \"./RpcBackend\";\nimport { TileStorage } from \"./TileStorage\";\nimport { BaseSettings, SettingDictionary, SettingsPriority } from \"./workspace/Settings\";\nimport { SettingsSchemas } from \"./workspace/SettingsSchemas\";\nimport { ITwinWorkspace, Workspace, WorkspaceOpts } from \"./workspace/Workspace\";\nimport { Container } from \"inversify\";\nimport { join, normalize as normalizeDir } from \"path\";\n\nconst loggerCategory = BackendLoggerCategory.IModelHost;\n\n// cspell:ignore nodereport fatalerror apicall alicloud rpcs inversify\n\n/** @internal */\nexport interface CrashReportingConfigNameValuePair {\n name: string;\n value: string;\n}\n\n/** Configuration of the crash-reporting system.\n * @internal\n */\nexport interface CrashReportingConfig {\n /** The directory to which *.dmp and/or iModelJsNativeCrash*.properties.txt files are written. This directory will be created if it does not already exist. */\n crashDir: string;\n /** max # .dmp files that may exist in crashDir. The default is 50. */\n maxDumpsInDir?: number;\n /** Enable crash-dumps? If so, .dmp and .properties.txt files will be generated and written to crashDir in the event of an unhandled native-code exception. If not, only .properties.txt files will be written. The default is false. */\n enableCrashDumps?: boolean;\n /** If enableCrashDumps is true, do you want a full-memory dump? Defaults to false. */\n wantFullMemoryDumps?: boolean;\n /** Enable Node.js crash reporting? If so, report files will be generated in the event of an unhandled exception or fatal error and written to crashDir. The default is false. */\n enableNodeReport?: boolean;\n /** Additional name, value pairs to write to iModelJsNativeCrash*.properties.txt file in the event of a crash. */\n params?: CrashReportingConfigNameValuePair[];\n /** Run this .js file to process .dmp and Node.js crash reporting .json files in the event of a crash.\n * This script will be executed with a single command-line parameter: the name of the dump or Node.js report file.\n * In the case of a dump file, there will be a second file with the same basename and the extension \".properties.txt\".\n * Since it runs in a separate process, this script will have no access to the Javascript\n * context of the exiting backend. No default.\n */\n dumpProcessorScriptFileName?: string;\n /** Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false */\n uploadToBentley?: boolean;\n}\n\n/** @beta */\nexport interface AzureBlobStorageCredentials {\n account: string;\n accessKey: string;\n baseUrl?: string;\n}\n\n/**\n * Options for [[IModelHost.startup]]\n * @public\n */\nexport interface IModelHostOptions {\n /**\n * The name of the *Profile* subdirectory of [[cacheDir]] for this process. If not present, \"default\" is used.\n * @see [[IModelHost.profileName]]\n * @beta\n */\n profileName?: string;\n\n /**\n * Root of the directory holding all the files that iTwin.js caches\n * - If not specified at startup a platform specific default is used -\n * - Windows: $(HOMEDIR)/AppData/Local/iModelJs/\n * - Mac/iOS: $(HOMEDIR)/Library/Caches/iModelJs/\n * - Linux: $(HOMEDIR)/.cache/iModelJs/\n * where $(HOMEDIR) is documented [here](https://nodejs.org/api/os.html#os_os_homedir)\n * - if specified, ensure it is set to a folder with read/write access.\n * @see [[IModelHost.cacheDir]] for the value it's set to after startup\n */\n cacheDir?: LocalDirName;\n\n /** The directory where application assets are found. */\n appAssetsDir?: LocalDirName;\n\n /**\n * Options for creating the [[Workspace]]\n * @beta\n */\n workspace?: WorkspaceOpts;\n\n /**\n * The kind of iModel hub server to use.\n * @beta\n */\n hubAccess?: BackendHubAccess;\n\n /** The Azure blob storage credentials to use for the tile cache service. If omitted and no external service implementation is provided, a local cache will be used.\n * @beta\n */\n tileCacheAzureCredentials?: AzureBlobStorageCredentials;\n\n /**\n * @beta\n * @note A reference implementation is set for AzureServerStorage from @itwin/object-storage-azure if [[tileCacheAzureCredentials]] property is set. To supply a different implementation for any service provider (such as AWS),\n * set this property with a custom ServerStorage.\n */\n tileCacheStorage?: ServerStorage;\n\n /** The maximum size in bytes to which a local sqlite database used for caching tiles can grow before it is purged of least-recently-used tiles.\n * The local cache is used only if an external cache has not been configured via [[tileCacheStorage]], and [[tileCacheAzureCredentials]].\n * Defaults to 1 GB. Must be an unsigned integer. A value of zero disables the local cache entirely.\n * @beta\n */\n maxTileCacheDbSize?: number;\n\n /** Whether to restrict tile cache URLs by client IP address (if available).\n * @beta\n */\n restrictTileUrlsByClientIp?: boolean;\n\n /** Whether to enable OpenTelemetry tracing.\n * Defaults to `false`.\n */\n enableOpenTelemetry?: boolean;\n\n /** Whether to compress cached tiles.\n * Defaults to `true`.\n */\n compressCachedTiles?: boolean;\n\n /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a \"pending\" status.\n * @internal\n */\n tileTreeRequestTimeout?: number;\n\n /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a \"pending\" status.\n * @internal\n */\n tileContentRequestTimeout?: number;\n\n /** The backend will log when a tile took longer to load than this threshold in seconds.\n * @internal\n */\n logTileLoadTimeThreshold?: number;\n\n /** The backend will log when a tile is loaded with a size in bytes above this threshold.\n * @internal\n */\n logTileSizeThreshold?: number;\n\n /** Crash-reporting configuration\n * @internal\n */\n crashReportingConfig?: CrashReportingConfig;\n\n /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */\n authorizationClient?: AuthorizationClient;\n}\n\n/** Configuration of core-backend.\n * @public\n */\nexport class IModelHostConfiguration implements IModelHostOptions {\n public static defaultTileRequestTimeout = 20 * 1000;\n public static defaultLogTileLoadTimeThreshold = 40;\n public static defaultLogTileSizeThreshold = 20 * 1000000;\n /** @internal */\n public static defaultMaxTileCacheDbSize = 1024 * 1024 * 1024;\n\n public appAssetsDir?: LocalDirName;\n public cacheDir?: LocalDirName;\n\n /** @beta */\n public workspace?: WorkspaceOpts;\n /** @beta */\n public hubAccess?: BackendHubAccess;\n /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */\n public authorizationClient?: AuthorizationClient;\n /** @beta */\n public restrictTileUrlsByClientIp?: boolean;\n public compressCachedTiles?: boolean;\n /** @beta */\n public tileCacheAzureCredentials?: AzureBlobStorageCredentials;\n /** @internal */\n public tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\n /** @internal */\n public tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\n /** @internal */\n public logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\n /** @internal */\n public logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;\n /** @internal */\n public crashReportingConfig?: CrashReportingConfig;\n}\n\n/**\n * Settings for `IModelHost.appWorkspace`.\n * @note this includes the default dictionary from the SettingsSpecRegistry\n */\nclass ApplicationSettings extends BaseSettings {\n private _remove?: VoidFunction;\n protected override verifyPriority(priority: SettingsPriority) {\n if (priority >= SettingsPriority.iModel) // iModel settings may not appear in ApplicationSettings\n throw new Error(\"Use IModelSettings\");\n }\n private updateDefaults() {\n const defaults: SettingDictionary = {};\n for (const [schemaName, val] of SettingsSchemas.allSchemas) {\n if (val.default)\n defaults[schemaName] = val.default;\n }\n this.addDictionary(\"_default_\", 0 as SettingsPriority, defaults);\n }\n\n public constructor() {\n super();\n this._remove = SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());\n this.updateDefaults();\n }\n\n public override close() {\n if (this._remove) {\n this._remove();\n this._remove = undefined;\n }\n }\n}\n\n/** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.\n * See [the learning article]($docs/learning/backend/IModelHost.md)\n * @public\n */\nexport class IModelHost {\n private constructor() { }\n\n /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */\n public static authorizationClient?: AuthorizationClient;\n\n /** @alpha */\n public static readonly telemetry = new TelemetryManager();\n\n public static backendVersion = \"\";\n private static _profileName: string;\n private static _cacheDir = \"\";\n private static _appWorkspace?: Workspace;\n\n private static _platform?: typeof IModelJsNative;\n /** @internal */\n public static get platform(): typeof IModelJsNative {\n if (this._platform === undefined)\n throw new Error(\"IModelHost.startup must be called first\");\n return this._platform;\n }\n\n public static configuration?: IModelHostOptions;\n\n /**\n * The name of the *Profile* directory (a subdirectory of \"[[cacheDir]]/profiles/\") for this process.\n *\n * The *Profile* directory is used to cache data that is specific to a type-of-usage of the iTwin.js library.\n * It is important that information in the profile cache be consistent but isolated across sessions (i.e.\n * data for a profile is maintained between runs, but each profile is completely independent and\n * unaffected by the presence ot use of others.)\n * @note **Only one process at a time may be using a given profile**, and an exception will be thrown by [[startup]]\n * if a second process attempts to use the same profile.\n * @beta\n */\n public static get profileName(): string {\n return this._profileName;\n }\n\n /** The full path of the Profile directory.\n * @see [[profileName]]\n * @beta\n */\n public static get profileDir(): LocalDirName {\n return join(this._cacheDir, \"profiles\", this._profileName);\n }\n\n /** Event raised during startup to allow loading settings data */\n public static readonly onWorkspaceStartup = new BeEvent<() => void>();\n\n /** Event raised just after the backend IModelHost was started */\n public static readonly onAfterStartup = new BeEvent<() => void>();\n\n /** Event raised just before the backend IModelHost is to be shut down */\n public static readonly onBeforeShutdown = new BeEvent<() => void>();\n\n /** @internal */\n public static readonly session: Mutable<SessionProps> = { applicationId: \"2686\", applicationVersion: \"1.0.0\", sessionId: \"\" };\n\n /** A uniqueId for this session */\n public static get sessionId() { return this.session.sessionId; }\n public static set sessionId(id: GuidString) { this.session.sessionId = id; }\n\n /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */\n public static get applicationId() { return this.session.applicationId; }\n public static set applicationId(id: string) { this.session.applicationId = id; }\n\n /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */\n public static get applicationVersion() { return this.session.applicationVersion; }\n public static set applicationVersion(version: string) { this.session.applicationVersion = version; }\n\n /** Root directory holding files that iTwin.js caches */\n public static get cacheDir(): LocalDirName { return this._cacheDir; }\n\n /** The application [[Workspace]] for this `IModelHost`\n * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).\n * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and\n * attempting to add them to this Workspace will fail.\n * @beta\n */\n public static get appWorkspace(): Workspace { return this._appWorkspace!; } // eslint-disable-line @typescript-eslint/no-non-null-assertion\n\n /** The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. */\n public static snapshotFileNameResolver?: FileNameResolver;\n\n /** Get the current access token for this IModelHost, or a blank string if none is available.\n * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)\n * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend\n * obtains the token and forwards it to the frontend.\n * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value\n * returned by this method may change over time throughout the course of a session.\n */\n public static async getAccessToken(): Promise<AccessToken> {\n try {\n return (await IModelHost.authorizationClient?.getAccessToken()) ?? \"\";\n } catch (e) {\n return \"\";\n }\n }\n\n /** @internal */\n public static flushLog() {\n return IModelHost.platform.flushLog();\n }\n\n private static syncNativeLogLevels() {\n this.platform.clearLogLevelCache();\n }\n private static loadNative(options: IModelHostOptions) {\n if (undefined !== this._platform)\n return;\n\n this._platform = ProcessDetector.isMobileAppBackend ? (process as any)._linkedBinding(\"iModelJsNative\") as typeof IModelJsNative : NativeLibrary.load();\n this._platform.logger = Logger;\n Logger.logLevelChangedFn = () => IModelHost.syncNativeLogLevels(); // the arrow function exists only so that it can be spied in tests\n\n if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !ProcessDetector.isElectronAppBackend && !ProcessDetector.isMobileAppBackend) {\n this.platform.setCrashReporting(options.crashReportingConfig);\n\n Logger.logTrace(loggerCategory, \"Configured crash reporting\", {\n enableCrashDumps: options.crashReportingConfig?.enableCrashDumps,\n wantFullMemoryDumps: options.crashReportingConfig?.wantFullMemoryDumps,\n enableNodeReport: options.crashReportingConfig?.enableNodeReport,\n uploadToBentley: options.crashReportingConfig?.uploadToBentley,\n });\n\n if (options.crashReportingConfig.enableNodeReport) {\n if (process.report !== undefined) {\n process.report.reportOnFatalError = true;\n process.report.reportOnUncaughtException = true;\n process.report.directory = options.crashReportingConfig.crashDir;\n Logger.logTrace(loggerCategory, \"Configured Node.js crash reporting\");\n } else {\n Logger.logWarning(loggerCategory, \"Unable to configure Node.js crash reporting\");\n }\n }\n }\n }\n\n /** @internal */\n public static tileStorage?: TileStorage;\n\n private static _hubAccess?: BackendHubAccess;\n /** @internal */\n public static setHubAccess(hubAccess: BackendHubAccess | undefined) { this._hubAccess = hubAccess; }\n\n /** get the current hubAccess, if present.\n * @beta\n */\n public static getHubAccess(): BackendHubAccess | undefined { return this._hubAccess; }\n\n /** Provides access to the IModelHub for this IModelHost\n * @beta\n * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.\n * To determine whether one is present, use [[getHubAccess]].\n */\n public static get hubAccess(): BackendHubAccess {\n if (IModelHost._hubAccess === undefined)\n throw new IModelError(IModelStatus.BadRequest, \"No BackendHubAccess supplied in IModelHostOptions\");\n return IModelHost._hubAccess;\n }\n\n private static initializeWorkspace(configuration: IModelHostOptions) {\n const settingAssets = join(KnownLocations.packageAssetsDir, \"Settings\");\n SettingsSchemas.addDirectory(join(settingAssets, \"Schemas\"));\n this._appWorkspace = new ITwinWorkspace(new ApplicationSettings(), configuration.workspace);\n\n // Create the CloudCache for Workspaces. This will fail if another process is already using the same profile.\n try {\n this.appWorkspace.getCloudCache();\n } catch (e: any) {\n throw (e.errorNumber === DbResult.BE_SQLITE_BUSY) ? new IModelError(DbResult.BE_SQLITE_BUSY, `Profile [${this.profileDir}] is already in use by another process`) : e;\n }\n\n this.appWorkspace.settings.addDirectory(settingAssets, SettingsPriority.defaults);\n\n GeoCoordConfig.onStartup();\n // allow applications to load their default settings\n this.onWorkspaceStartup.raiseEvent();\n }\n\n private static _isValid = false;\n\n /** true between a successful call to [[startup]] and before [[shutdown]] */\n public static get isValid() {\n return IModelHost._isValid;\n }\n\n /** This method must be called before any iTwin.js services are used.\n * @param options Host configuration data.\n * Raises [[onAfterStartup]].\n * @see [[shutdown]].\n */\n public static async startup(options?: IModelHostOptions): Promise<void> {\n if (this._isValid)\n return; // we're already initialized\n this._isValid = true;\n\n options = options ?? {};\n if (this.sessionId === \"\")\n this.sessionId = Guid.createValue();\n\n this.authorizationClient = options.authorizationClient;\n\n this.backendVersion = require(\"../../package.json\").version; // eslint-disable-line @typescript-eslint/no-var-requires\n initializeRpcBackend(options.enableOpenTelemetry);\n\n this.loadNative(options);\n this.setupCacheDir(options);\n this.initializeWorkspace(options);\n\n BriefcaseManager.initialize(join(this._cacheDir, \"imodels\"));\n\n [\n IModelReadRpcImpl,\n IModelTileRpcImpl,\n SnapshotIModelRpcImpl,\n WipRpcImpl,\n DevToolsRpcImpl,\n ].forEach((rpc) => rpc.register()); // register all of the RPC implementations\n\n [\n BisCoreSchema,\n GenericSchema,\n FunctionalSchema,\n ].forEach((schema) => schema.registerSchema()); // register all of the schemas\n\n if (undefined !== options.hubAccess)\n this._hubAccess = options.hubAccess;\n\n this.configuration = options;\n this.setupTileCache();\n\n process.once(\"beforeExit\", IModelHost.shutdown);\n this.onAfterStartup.raiseEvent();\n }\n\n private static setupCacheDir(configuration: IModelHostOptions) {\n this._cacheDir = normalizeDir(configuration.cacheDir ?? NativeLibrary.defaultCacheDir);\n IModelJsFs.recursiveMkDirSync(this._cacheDir);\n\n this._profileName = configuration.profileName ?? \"default\";\n Logger.logInfo(loggerCategory, `cacheDir: [${this.cacheDir}], profileDir: [${this.profileDir}]`);\n }\n\n /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */\n public static async shutdown(): Promise<void> {\n // Note: This method is set as a node listener where `this` is unbound. Call private method to\n // ensure `this` is correct. Don't combine these methods.\n return IModelHost.doShutdown();\n }\n\n private static async doShutdown() {\n if (!this._isValid)\n return;\n\n this._isValid = false;\n this.onBeforeShutdown.raiseEvent();\n this.configuration = undefined;\n this.tileStorage = undefined;\n this._appWorkspace?.close();\n this._appWorkspace = undefined;\n\n CloudSqlite.CloudCaches.destroy();\n process.removeListener(\"beforeExit\", IModelHost.shutdown);\n }\n\n /**\n * Add or update a property that should be included in a crash report.\n * @internal\n */\n public static setCrashReportProperty(name: string, value: string): void {\n this.platform.setCrashReportProperty(name, value);\n }\n\n /**\n * Remove a previously defined property so that will not be included in a crash report.\n * @internal\n */\n public static removeCrashReportProperty(name: string): void {\n this.platform.setCrashReportProperty(name, undefined);\n }\n\n /**\n * Get all properties that will be included in a crash report.\n * @internal\n */\n public static getCrashReportProperties(): CrashReportingConfigNameValuePair[] {\n return this.platform.getCrashReportProperties();\n }\n\n /** The directory where application assets may be found */\n public static get appAssetsDir(): string | undefined {\n return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined;\n }\n\n /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a \"pending\" status.\n * @internal\n */\n public static get tileTreeRequestTimeout(): number {\n return IModelHost.configuration?.tileTreeRequestTimeout ?? IModelHostConfiguration.defaultTileRequestTimeout;\n }\n /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a \"pending\" status.\n * @internal\n */\n public static get tileContentRequestTimeout(): number {\n return IModelHost.configuration?.tileContentRequestTimeout ?? IModelHostConfiguration.defaultTileRequestTimeout;\n }\n\n /** The backend will log when a tile took longer to load than this threshold in seconds. */\n public static get logTileLoadTimeThreshold(): number {\n return IModelHost.configuration?.logTileLoadTimeThreshold ?? IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\n }\n /** The backend will log when a tile is loaded with a size in bytes above this threshold. */\n public static get logTileSizeThreshold(): number {\n return IModelHost.configuration?.logTileSizeThreshold ?? IModelHostConfiguration.defaultLogTileSizeThreshold;\n }\n\n /** Whether external tile caching is active.\n * @internal\n */\n public static get usingExternalTileCache(): boolean {\n return undefined !== IModelHost.tileStorage;\n }\n\n /** Whether to restrict tile cache URLs by client IP address.\n * @internal\n */\n public static get restrictTileUrlsByClientIp(): boolean {\n return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false);\n }\n\n /** Whether to compress cached tiles.\n * @internal\n */\n public static get compressCachedTiles(): boolean {\n return false !== IModelHost.configuration?.compressCachedTiles;\n }\n\n private static setupTileCache() {\n assert(undefined !== IModelHost.configuration);\n const config = IModelHost.configuration;\n const storage = config.tileCacheStorage;\n const credentials = config.tileCacheAzureCredentials;\n\n if (!storage && !credentials) {\n this.platform.setMaxTileCacheSize(config.maxTileCacheDbSize ?? IModelHostConfiguration.defaultMaxTileCacheDbSize);\n return;\n }\n\n this.platform.setMaxTileCacheSize(0);\n if (credentials) {\n if (storage)\n throw new IModelError(BentleyStatus.ERROR, \"Cannot use both Azure and custom cloud storage providers for tile cache.\");\n this.setupAzureTileCache(credentials);\n }\n if (storage)\n IModelHost.tileStorage = new TileStorage(storage);\n }\n\n private static setupAzureTileCache(credentials: AzureBlobStorageCredentials) {\n const config = {\n // eslint-disable-next-line @typescript-eslint/naming-convention\n ServerSideStorage: {\n dependencyName: \"azure\",\n accountName: credentials.account,\n accountKey: credentials.accessKey,\n baseUrl: credentials.baseUrl ?? `https://${credentials.account}.blob.core.windows.net`,\n },\n };\n const ioc: Container = new Container();\n ioc.bind<DependenciesConfig>(ExtensionTypes.dependenciesConfig).toConstantValue(config);\n new AzureServerStorageBindings().register(ioc, config.ServerSideStorage);\n IModelHost.tileStorage = new TileStorage(ioc.get(ServerStorage));\n }\n\n /** @internal */\n public static computeSchemaChecksum(arg: { schemaXmlPath: string, referencePaths: string[], exactMatch?: boolean }): string {\n return this.platform.computeSchemaChecksum(arg);\n }\n}\n\n/** Information about the platform on which the app is running.\n * @public\n */\nexport class Platform {\n /** Get the name of the platform. */\n public static get platformName(): \"win32\" | \"linux\" | \"darwin\" | \"ios\" | \"android\" | \"uwp\" {\n return process.platform as any;\n }\n}\n\n/** Well known directories that may be used by the application.\n * @public\n */\nexport class KnownLocations {\n\n /** The directory where the imodeljs-native assets are stored. */\n public static get nativeAssetsDir(): LocalDirName {\n return IModelHost.platform.DgnDb.getAssetsDir();\n }\n\n /** The directory where the core-backend assets are stored. */\n public static get packageAssetsDir(): LocalDirName {\n return join(__dirname, \"assets\");\n }\n\n /** The temporary directory. */\n public static get tmpdir(): LocalDirName {\n return os.tmpdir();\n }\n}\n\n/** Extend this class to provide custom file name resolution behavior.\n * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.\n * @see [[IModelHost.snapshotFileNameResolver]]\n * @public\n */\nexport abstract class FileNameResolver {\n /** Resolve a file name from the specified key.\n * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.\n * @returns The resolved file name or `undefined` if not found.\n */\n public tryResolveKey(_fileKey: string): string | undefined { return undefined; }\n /** Resolve a file name from the specified key.\n * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.\n * @returns The resolved file name.\n * @throws [[IModelError]] if not found.\n */\n public resolveKey(fileKey: string): string {\n const resolvedFileName: string | undefined = this.tryResolveKey(fileKey);\n if (undefined === resolvedFileName) {\n throw new IModelError(IModelStatus.NotFound, `${fileKey} not resolved`);\n }\n return resolvedFileName;\n }\n /** Resolve the input file name, which may be a partial name, into a full path file name.\n * @param inFileName The partial file name.\n * @returns The resolved full path file name or `undefined` if not found.\n */\n public tryResolveFileName(inFileName: string): string | undefined { return inFileName; }\n /** Resolve the input file name, which may be a partial name, into a full path file name.\n * @param inFileName The partial file name.\n * @returns The resolved full path file name.\n * @throws [[IModelError]] if not found.\n */\n public resolveFileName(inFileName: string): string {\n const resolvedFileName: string | undefined = this.tryResolveFileName(inFileName);\n if (undefined === resolvedFileName) {\n throw new IModelError(IModelStatus.NotFound, `${inFileName} not resolved`);\n }\n return resolvedFileName;\n }\n}\n"]}