@itwin/core-backend 3.3.0-dev.7 → 3.3.0-dev.70

package/lib/cjs/IModelHost.d.ts

@@ -2,9 +2,9 @@
  * @module IModelHost
  */
 import { IModelJsNative } from "@bentley/imodeljs-native";
-import { TelemetryManager } from "@itwin/core-telemetry";
 import { AccessToken, BeEvent, GuidString, Mutable } from "@itwin/core-bentley";
 import { AuthorizationClient, LocalDirName, SessionProps } from "@itwin/core-common";
+import { TelemetryManager } from "@itwin/core-telemetry";
 import { BackendHubAccess } from "./BackendHubAccess";
 import { AzureBlobStorageCredentials, CloudStorageService, CloudStorageTileUploader } from "./CloudStorageBackend";
 import { Workspace, WorkspaceOpts } from "./workspace/Workspace";
@@ -39,10 +39,11 @@ export interface CrashReportingConfig {
     /** Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false */
     uploadToBentley?: boolean;
 }
-/** Configuration of core-backend.
+/**
+ * Options for [[IModelHost.startup]]
  * @public
  */
-export declare class IModelHostConfiguration {
+export interface IModelHostOptions {
     /**
      * Root of the directory holding all the files that iTwin.js caches
      * - If not specified at startup a platform specific default is used -
@@ -58,13 +59,15 @@ export declare class IModelHostConfiguration {
      * @see [[IModelHost.cacheDir]] for the value it's set to after startup
      */
     cacheDir?: LocalDirName;
-    /** Options for creating the [[Workspace]]
+    /** The directory where application assets are found. */
+    appAssetsDir?: LocalDirName;
+    /**
+     * Options for creating the [[Workspace]]
      * @beta
      */
     workspace?: WorkspaceOpts;
-    /** The directory where the app's assets are found. */
-    appAssetsDir?: LocalDirName;
-    /** The kind of iModel hub server to use.
+    /**
+     * The kind of iModel hub server to use.
      * @beta
      */
     hubAccess?: BackendHubAccess;
@@ -89,31 +92,19 @@ export declare class IModelHostConfiguration {
     /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a "pending" status.
      * @internal
      */
-    tileTreeRequestTimeout: number;
+    tileTreeRequestTimeout?: number;
     /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a "pending" status.
      * @internal
      */
-    tileContentRequestTimeout: number;
-    /** The default time, in milliseconds, used for [[tileTreeRequestTimeout]] and [[tileContentRequestTimeout]]. To change this, override one or both of those properties.
-     * @internal
-     */
-    static defaultTileRequestTimeout: number;
-    /** The default time, in seconds, used for [[logTileLoadTimeThreshold]]. To change this, override that property.
-     * @internal
-     */
-    static defaultLogTileLoadTimeThreshold: number;
+    tileContentRequestTimeout?: number;
     /** The backend will log when a tile took longer to load than this threshold in seconds.
      * @internal
      */
-    logTileLoadTimeThreshold: number;
-    /** The default size, in bytes, used for [[logTileSizeThreshold]]. To change this, override that property.
-     * @internal
-     */
-    static defaultLogTileSizeThreshold: number;
+    logTileLoadTimeThreshold?: number;
     /** The backend will log when a tile is loaded with a size in bytes above this threshold.
      * @internal
      */
-    logTileSizeThreshold: number;
+    logTileSizeThreshold?: number;
     /** Crash-reporting configuration
      * @alpha
      */
@@ -123,6 +114,39 @@ export declare class IModelHostConfiguration {
      */
     authorizationClient?: AuthorizationClient;
 }
+/** Configuration of core-backend.
+ * @public
+ */
+export declare class IModelHostConfiguration implements IModelHostOptions {
+    static defaultTileRequestTimeout: number;
+    static defaultLogTileLoadTimeThreshold: number;
+    static defaultLogTileSizeThreshold: number;
+    appAssetsDir?: LocalDirName;
+    cacheDir?: LocalDirName;
+    /** @beta */
+    workspace?: WorkspaceOpts;
+    /** @beta */
+    hubAccess?: BackendHubAccess;
+    /** @beta */
+    authorizationClient?: AuthorizationClient;
+    /** @beta */
+    tileCacheService?: CloudStorageService;
+    /** @beta */
+    restrictTileUrlsByClientIp?: boolean;
+    compressCachedTiles?: boolean;
+    /** @beta */
+    tileCacheAzureCredentials?: AzureBlobStorageCredentials;
+    /** @internal */
+    tileTreeRequestTimeout: number;
+    /** @internal */
+    tileContentRequestTimeout: number;
+    /** @internal */
+    logTileLoadTimeThreshold: number;
+    /** @internal */
+    logTileSizeThreshold: number;
+    /** @alpha */
+    crashReportingConfig?: CrashReportingConfig;
+}
 /** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.
  * See [the learning article]($docs/learning/backend/IModelHost.md)
  * @public
@@ -138,7 +162,9 @@ export declare class IModelHost {
     private static _platform?;
     /** @internal */
     static get platform(): typeof IModelJsNative;
-    static configuration?: IModelHostConfiguration;
+    static configuration?: IModelHostOptions;
+    /** Event raised during startup to allow loading settings data */
+    static readonly onWorkspaceStartup: BeEvent<() => void>;
     /** Event raised just after the backend IModelHost was started */
     static readonly onAfterStartup: BeEvent<() => void>;
     /** Event raised just before the backend IModelHost is to be shut down */
@@ -181,28 +207,34 @@ export declare class IModelHost {
     private static validateNativePlatformVersion;
     /**
      * @internal
-     * @note Use [[IModelHostConfiguration.tileCacheService]] to set the service provider.
+     * @note Use [[IModelHostOptions.tileCacheService]] to set the service provider.
      */
     static tileCacheService?: CloudStorageService;
     /** @internal */
     static tileUploader?: CloudStorageTileUploader;
-    private static _hubAccess;
+    private static _hubAccess?;
     /** @internal */
-    static setHubAccess(hubAccess: BackendHubAccess): void;
+    static setHubAccess(hubAccess: BackendHubAccess | undefined): void;
+    /** get the current hubAccess, if present.
+     * @beta
+     */
+    static getHubAccess(): BackendHubAccess | undefined;
     /** Provides access to the IModelHub for this IModelHost
      * @beta
-     * @note If [[IModelHostConfiguration.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
+     * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
+     * To determine whether one is present, use [[getHubAccess]].
      */
     static get hubAccess(): BackendHubAccess;
+    private static initializeWorkspace;
     private static _isValid;
     /** Returns true if IModelHost is started.  */
     static get isValid(): boolean;
     /** This method must be called before any iTwin.js services are used.
-     * @param configuration Host configuration data.
+     * @param options Host configuration data.
      * Raises [[onAfterStartup]].
      * @see [[shutdown]].
      */
-    static startup(configuration?: IModelHostConfiguration): Promise<void>;
+    static startup(options?: IModelHostOptions): Promise<void>;
     private static _briefcaseCacheDir;
     private static logStartup;
     private static setupHostDirs;
@@ -228,11 +260,11 @@ export declare class IModelHost {
     static getCrashReportProperties(): CrashReportingConfigNameValuePair[];
     /** The directory where application assets may be found */
     static get appAssetsDir(): string | undefined;
-    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a "pending" status.
+    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
      * @internal
      */
     static get tileTreeRequestTimeout(): number;
-    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a "pending" status.
+    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a "pending" status.
      * @internal
      */
     static get tileContentRequestTimeout(): number;
@@ -253,6 +285,12 @@ export declare class IModelHost {
      */
     static get compressCachedTiles(): boolean;
     private static setupTileCache;
+    /** @internal */
+    static computeSchemaChecksum(arg: {
+        schemaXmlPath: string;
+        referencePaths: string[];
+        exactMatch?: boolean;
+    }): string;
 }
 /** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].
  * @public

package/lib/cjs/IModelHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IModelHost.d.ts","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAU,OAAO,EAAQ,UAAU,EAAkC,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC/I,OAAO,EAAE,mBAAmB,EAA8B,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACjH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAItD,OAAO,EAAoB,2BAA2B,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAUrI,OAAO,EAAkB,SAAS,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAQjF,aAAa;AACb,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wOAAwO;IACxO,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0KAA0K;IAC1K,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,MAAM,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAC7C;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,uBAAuB;IAElC;;;;;;;;;;;;;OAaG;IACI,QAAQ,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACI,SAAS,CAAC,EAAE,aAAa,CAAC;IAEjC,sDAAsD;IAC/C,YAAY,CAAC,EAAE,YAAY,CAAC;IAEnC;;OAEG;IACI,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACI,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAE/D;;;;OAIG;IACI,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IAE9C;;OAEG;IACI,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACI,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACI,sBAAsB,SAAqD;IAClF;;OAEG;IACI,yBAAyB,SAAqD;IACrF;;OAEG;IACH,OAAc,yBAAyB,SAAa;IAEpD;;OAEG;IACH,OAAc,+BAA+B,SAAM;IACnD;;OAEG;IACI,wBAAwB,EAAE,MAAM,CAA2D;IAElG;;OAEG;IACH,OAAc,2BAA2B,SAAgB;IACzD;;OAEG;IACI,oBAAoB,EAAE,MAAM,CAAuD;IAE1F;;OAEG;IACI,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAEnD;;OAEG;IACI,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;CAClD;AAkCD;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO;IACP,OAAc,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAExD,aAAa;IACb,gBAAuB,SAAS,mBAA0B;IAE1D,OAAc,cAAc,SAAM;IAClC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAM;IAC9B,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAY;IAEzC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAwB;IACjD,gBAAgB;IAChB,WAAkB,QAAQ,IAAI,OAAO,cAAc,CAIlD;IAED,OAAc,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACtD,iEAAiE;IACjE,gBAAuB,cAAc,gBAAqB,IAAI,EAAI;IAElE,yEAAyE;IACzE,gBAAuB,gBAAgB,gBAAqB,IAAI,EAAI;IAEpE,gBAAgB;IAChB,gBAAuB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAyE;IAE9H,kCAAkC;IAClC,WAAkB,SAAS,IACK,UAAU,CADsB;IAChE,WAAkB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAkC;IAE5E,mJAAmJ;IACnJ,WAAkB,aAAa,IACK,MAAM,CAD8B;IACxE,WAAkB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAsC;IAEhF,qJAAqJ;IACrJ,WAAkB,kBAAkB,IACU,MAAM,CAD8B;IAClF,WAAkB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAgD;IAEpG,wDAAwD;IACxD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;;;;OAKG;IACH,WAAkB,YAAY,IAAI,SAAS,CAAgC;IAE3E,wGAAwG;IACxG,OAAc,wBAAwB,CAAC,EAAE,gBAAgB,CAAC;IAE1D;;;;;;OAMG;WACiB,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAQ1D,gBAAgB;WACF,QAAQ;IAGtB,gBAAgB;WACF,UAAU,IAAI,IAAI;IAKhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAW/B,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAa5C;;;OAGG;IACH,OAAc,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IAErD,gBAAgB;IAChB,OAAc,YAAY,CAAC,EAAE,wBAAwB,CAAC;IAEtD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAmB;IAC5C,gBAAgB;WACF,YAAY,CAAC,SAAS,EAAE,gBAAgB;IAEtD;;;OAGG;IACH,WAAkB,SAAS,IAAI,gBAAgB,CAQ9C;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,8CAA8C;IAC9C,WAAkB,OAAO,YAA4B;IACrD;;;;OAIG;WACiB,OAAO,CAAC,aAAa,GAAE,uBAAuD,GAAG,OAAO,CAAC,IAAI,CAAC;IA8ElH,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAe;IAEhD,OAAO,CAAC,MAAM,CAAC,UAAU;IAuBzB,OAAO,CAAC,MAAM,CAAC,aAAa;IAU5B,iGAAiG;WAC7E,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAe7C;;;;;OAKG;WACW,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAKvE;;;;OAIG;WACW,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3D;;;OAGG;WACW,wBAAwB,IAAI,iCAAiC,EAAE;IAK7E,0DAA0D;IAC1D,WAAkB,YAAY,IAAI,MAAM,GAAG,SAAS,CAAuG;IAE3J;;OAEG;IACH,WAAkB,sBAAsB,IAAI,MAAM,CAEjD;IACD;;OAEG;IACH,WAAkB,yBAAyB,IAAI,MAAM,CAEpD;IAED,2FAA2F;IAC3F,WAAkB,wBAAwB,IAAI,MAAM,CAAiK;IACrN,4FAA4F;IAC5F,WAAkB,oBAAoB,IAAI,MAAM,CAAyJ;IAEzM;;OAEG;IACH,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;OAEG;IACH,WAAkB,0BAA0B,IAAI,OAAO,CAA2H;IAElL;;OAEG;IACH,WAAkB,mBAAmB,IAAI,OAAO,CAAoE;IAEpH,OAAO,CAAC,MAAM,CAAC,cAAc;CAmB9B;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,oCAAoC;IACpC,WAAkB,YAAY,IAAI,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAEzF;IAED,gBAAgB;WACF,IAAI,IAAI,OAAO,cAAc;CAG5C;AAED;;GAEG;AACH,qBAAa,cAAc;IAEzB,iEAAiE;IACjE,WAAkB,eAAe,IAAI,MAAM,CAAqD;IAEhG,8DAA8D;IAC9D,WAAkB,gBAAgB,IAAI,MAAM,CAE3C;IAED,+BAA+B;IAC/B,WAAkB,MAAM,IAAI,MAAM,CAEjC;CACF;AAED;;;;GAIG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAO1C;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACjE;;;;OAIG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAOnD"}
+{"version":3,"file":"IModelHost.d.ts","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,WAAW,EAAU,OAAO,EAAQ,UAAU,EAAkC,OAAO,EAAmB,MAAM,qBAAqB,CAAC;AAC/I,OAAO,EAAE,mBAAmB,EAA8B,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACjH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAItD,OAAO,EAAoB,2BAA2B,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAarI,OAAO,EAAkB,SAAS,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAMjF,aAAa;AACb,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wOAAwO;IACxO,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0KAA0K;IAC1K,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,MAAM,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAC7C;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,wDAAwD;IACxD,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAExD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IAEvC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;CAC3C;AAED;;GAEG;AACH,qBAAa,uBAAwB,YAAW,iBAAiB;IAC/D,OAAc,yBAAyB,SAAa;IACpD,OAAc,+BAA+B,SAAM;IACnD,OAAc,2BAA2B,SAAgB;IAElD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,YAAY,CAAC;IAE/B,YAAY;IACL,SAAS,CAAC,EAAE,aAAa,CAAC;IACjC,YAAY;IACL,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACpC,YAAY;IACL,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IACjD,YAAY;IACL,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IAC9C,YAAY;IACL,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACrC,YAAY;IACL,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;IAC/D,gBAAgB;IACT,sBAAsB,SAAqD;IAClF,gBAAgB;IACT,yBAAyB,SAAqD;IACrF,gBAAgB;IACT,wBAAwB,SAA2D;IAC1F,gBAAgB;IACT,oBAAoB,SAAuD;IAClF,aAAa;IACN,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CACpD;AAmCD;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO;IACP,OAAc,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAExD,aAAa;IACb,gBAAuB,SAAS,mBAA0B;IAE1D,OAAc,cAAc,SAAM;IAClC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAM;IAC9B,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAY;IAEzC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAwB;IACjD,gBAAgB;IAChB,WAAkB,QAAQ,IAAI,OAAO,cAAc,CAIlD;IAED,OAAc,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAEhD,iEAAiE;IACjE,gBAAuB,kBAAkB,gBAAqB,IAAI,EAAI;IAEtE,iEAAiE;IACjE,gBAAuB,cAAc,gBAAqB,IAAI,EAAI;IAElE,yEAAyE;IACzE,gBAAuB,gBAAgB,gBAAqB,IAAI,EAAI;IAEpE,gBAAgB;IAChB,gBAAuB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAyE;IAE9H,kCAAkC;IAClC,WAAkB,SAAS,IACK,UAAU,CADsB;IAChE,WAAkB,SAAS,CAAC,EAAE,EAAE,UAAU,EAAkC;IAE5E,mJAAmJ;IACnJ,WAAkB,aAAa,IACK,MAAM,CAD8B;IACxE,WAAkB,aAAa,CAAC,EAAE,EAAE,MAAM,EAAsC;IAEhF,qJAAqJ;IACrJ,WAAkB,kBAAkB,IACU,MAAM,CAD8B;IAClF,WAAkB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAgD;IAEpG,wDAAwD;IACxD,WAAkB,QAAQ,IAAI,YAAY,CAA2B;IAErE;;;;;OAKG;IACH,WAAkB,YAAY,IAAI,SAAS,CAAgC;IAE3E,wGAAwG;IACxG,OAAc,wBAAwB,CAAC,EAAE,gBAAgB,CAAC;IAE1D;;;;;;OAMG;WACiB,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAQ1D,gBAAgB;WACF,QAAQ;IAGtB,gBAAgB;WACF,UAAU,IAAI,IAAI;IAKhC,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAW/B,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAa5C;;;OAGG;IACH,OAAc,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IAErD,gBAAgB;IAChB,OAAc,YAAY,CAAC,EAAE,wBAAwB,CAAC;IAEtD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAmB;IAC7C,gBAAgB;WACF,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,SAAS;IAElE;;OAEG;WACW,YAAY,IAAI,gBAAgB,GAAG,SAAS;IAE1D;;;;OAIG;IACH,WAAkB,SAAS,IAAI,gBAAgB,CAI9C;IAED,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,8CAA8C;IAC9C,WAAkB,OAAO,YAA4B;IACrD;;;;OAIG;WACiB,OAAO,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+EvE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAe;IAEhD,OAAO,CAAC,MAAM,CAAC,UAAU;IAuBzB,OAAO,CAAC,MAAM,CAAC,aAAa;IAU5B,iGAAiG;WAC7E,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAe7C;;;;;OAKG;WACW,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAKvE;;;;OAIG;WACW,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3D;;;OAGG;WACW,wBAAwB,IAAI,iCAAiC,EAAE;IAK7E,0DAA0D;IAC1D,WAAkB,YAAY,IAAI,MAAM,GAAG,SAAS,CAAuG;IAE3J;;OAEG;IACH,WAAkB,sBAAsB,IAAI,MAAM,CAEjD;IACD;;OAEG;IACH,WAAkB,yBAAyB,IAAI,MAAM,CAEpD;IAED,2FAA2F;IAC3F,WAAkB,wBAAwB,IAAI,MAAM,CAA0H;IAC9K,4FAA4F;IAC5F,WAAkB,oBAAoB,IAAI,MAAM,CAAkH;IAElK;;OAEG;IACH,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;OAEG;IACH,WAAkB,0BAA0B,IAAI,OAAO,CAA2H;IAElL;;OAEG;IACH,WAAkB,mBAAmB,IAAI,OAAO,CAAoE;IAEpH,OAAO,CAAC,MAAM,CAAC,cAAc;IAoB7B,gBAAgB;WACF,qBAAqB,CAAC,GAAG,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAM;CAG5H;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,oCAAoC;IACpC,WAAkB,YAAY,IAAI,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAEzF;IAED,gBAAgB;WACF,IAAI,IAAI,OAAO,cAAc;CAG5C;AAED;;GAEG;AACH,qBAAa,cAAc;IAEzB,iEAAiE;IACjE,WAAkB,eAAe,IAAI,MAAM,CAAqD;IAEhG,8DAA8D;IAC9D,WAAkB,gBAAgB,IAAI,MAAM,CAE3C;IAED,+BAA+B;IAC/B,WAAkB,MAAM,IAAI,MAAM,CAEjC;CACF;AAED;;;;GAIG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D;;;;OAIG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAO1C;;;OAGG;IACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IACjE;;;;OAIG;IACI,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAOnD"}

package/lib/cjs/IModelHost.js

@@ -12,15 +12,16 @@ const os = require("os");
 const path = require("path");
 const semver = require("semver");
 const imodeljs_native_1 = require("@bentley/imodeljs-native");
-const core_telemetry_1 = require("@itwin/core-telemetry");
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
+const core_telemetry_1 = require("@itwin/core-telemetry");
 const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
 const BisCoreSchema_1 = require("./BisCoreSchema");
 const BriefcaseManager_1 = require("./BriefcaseManager");
 const CloudStorageBackend_1 = require("./CloudStorageBackend");
 const FunctionalSchema_1 = require("./domains/FunctionalSchema");
 const GenericSchema_1 = require("./domains/GenericSchema");
+const GeoCoordConfig_1 = require("./GeoCoordConfig");
 const IModelJsFs_1 = require("./IModelJsFs");
 const DevToolsRpcImpl_1 = require("./rpc-impl/DevToolsRpcImpl");
 const IModelReadRpcImpl_1 = require("./rpc-impl/IModelReadRpcImpl");
@@ -28,54 +29,37 @@ const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
 const SnapshotIModelRpcImpl_1 = require("./rpc-impl/SnapshotIModelRpcImpl");
 const WipRpcImpl_1 = require("./rpc-impl/WipRpcImpl");
 const RpcBackend_1 = require("./RpcBackend");
-const Workspace_1 = require("./workspace/Workspace");
 const Settings_1 = require("./workspace/Settings");
-const SettingsSpecRegistry_1 = require("./workspace/SettingsSpecRegistry");
+const SettingsSchemas_1 = require("./workspace/SettingsSchemas");
+const Workspace_1 = require("./workspace/Workspace");
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
 /** Configuration of core-backend.
  * @public
  */
 class IModelHostConfiguration {
     constructor() {
-        /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a "pending" status.
-         * @internal
-         */
+        /** @internal */
         this.tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
-        /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a "pending" status.
-         * @internal
-         */
+        /** @internal */
         this.tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
-        /** The backend will log when a tile took longer to load than this threshold in seconds.
-         * @internal
-         */
+        /** @internal */
         this.logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;
-        /** The backend will log when a tile is loaded with a size in bytes above this threshold.
-         * @internal
-         */
+        /** @internal */
         this.logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;
     }
 }
 exports.IModelHostConfiguration = IModelHostConfiguration;
-/** The default time, in milliseconds, used for [[tileTreeRequestTimeout]] and [[tileContentRequestTimeout]]. To change this, override one or both of those properties.
- * @internal
- */
 IModelHostConfiguration.defaultTileRequestTimeout = 20 * 1000;
-/** The default time, in seconds, used for [[logTileLoadTimeThreshold]]. To change this, override that property.
- * @internal
- */
 IModelHostConfiguration.defaultLogTileLoadTimeThreshold = 40;
-/** The default size, in bytes, used for [[logTileSizeThreshold]]. To change this, override that property.
- * @internal
- */
 IModelHostConfiguration.defaultLogTileSizeThreshold = 20 * 1000000;
 /**
- * Settings for the application workspace.
+ * Settings for `IModelHost.appWorkspace`.
  * @note this includes the default dictionary from the SettingsSpecRegistry
  */
 class ApplicationSettings extends Settings_1.BaseSettings {
     constructor() {
         super();
-        this._remove = SettingsSpecRegistry_1.SettingsSpecRegistry.onSpecsChanged.addListener(() => this.updateDefaults());
+        this._remove = SettingsSchemas_1.SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());
         this.updateDefaults();
     }
     verifyPriority(priority) {
@@ -84,9 +68,9 @@ class ApplicationSettings extends Settings_1.BaseSettings {
     }
     updateDefaults() {
         const defaults = {};
-        for (const [specName, val] of SettingsSpecRegistry_1.SettingsSpecRegistry.allSpecs) {
+        for (const [schemaName, val] of SettingsSchemas_1.SettingsSchemas.allSchemas) {
             if (val.default)
-                defaults[specName] = val.default;
+                defaults[schemaName] = val.default;
         }
         this.addDictionary("_default_", 0, defaults);
     }
@@ -145,7 +129,7 @@ class IModelHost {
     }
     /** @internal */
     static flushLog() {
-        return this.platform.DgnDb.flushLog();
+        return this.platform.flushLog();
     }
     /** @internal */
     static loadNative() {
@@ -174,33 +158,45 @@ class IModelHost {
     }
     /** @internal */
     static setHubAccess(hubAccess) { this._hubAccess = hubAccess; }
+    /** get the current hubAccess, if present.
+     * @beta
+     */
+    static getHubAccess() { return this._hubAccess; }
     /** Provides access to the IModelHub for this IModelHost
      * @beta
-     * @note If [[IModelHostConfiguration.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
+     * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
+     * To determine whether one is present, use [[getHubAccess]].
      */
     static get hubAccess() {
-        // Strictly speaking, _hubAccess should be marked as possibly undefined since it's not needed for Snapshot iModels.
-        // However, a decision was made to not provide that type annotation so callers aren't forced to constantly check for
-        // something that's required in all other workflows.
-        // This check is here to provide a better error message when hubAccess is inadvertently undefined.
         if (this._hubAccess === undefined)
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "IModelHost.hubAccess is undefined. Specify an implementation in your IModelHostConfiguration");
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "No BackendHubAccess supplied in IModelHostOptions");
         return this._hubAccess;
     }
+    static initializeWorkspace(configuration) {
+        const settingAssets = path.join(KnownLocations.packageAssetsDir, "Settings");
+        SettingsSchemas_1.SettingsSchemas.addDirectory(path.join(settingAssets, "Schemas"));
+        this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
+        this.appWorkspace.settings.addDirectory(settingAssets, Settings_1.SettingsPriority.defaults);
+        GeoCoordConfig_1.GeoCoordConfig.onStartup();
+        // allow applications to load their default settings
+        this.onWorkspaceStartup.raiseEvent();
+    }
     /** Returns true if IModelHost is started.  */
     static get isValid() { return this._isValid; }
     /** This method must be called before any iTwin.js services are used.
-     * @param configuration Host configuration data.
+     * @param options Host configuration data.
      * Raises [[onAfterStartup]].
      * @see [[shutdown]].
      */
-    static async startup(configuration = new IModelHostConfiguration()) {
+    static async startup(options) {
+        var _a, _b, _c, _d;
         if (this._isValid)
             return; // we're already initialized
         this._isValid = true;
+        options = options !== null && options !== void 0 ? options : {};
         if (IModelHost.sessionId === "")
             IModelHost.sessionId = core_bentley_1.Guid.createValue();
-        this.authorizationClient = configuration.authorizationClient;
+        this.authorizationClient = options.authorizationClient;
         this.logStartup();
         this.backendVersion = require("../../package.json").version; // eslint-disable-line @typescript-eslint/no-var-requires
         (0, RpcBackend_1.initializeRpcBackend)();
@@ -209,27 +205,24 @@ class IModelHost {
                 this.loadNative();
             }
             catch (error) {
-                core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (configuration));
+                core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (options));
                 throw error;
             }
         }
-        if (configuration.crashReportingConfig && configuration.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
-            this.platform.setCrashReporting(configuration.crashReportingConfig);
-            core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", () => {
-                var _a, _b, _c, _d;
-                return ({
-                    enableCrashDumps: (_a = configuration.crashReportingConfig) === null || _a === void 0 ? void 0 : _a.enableCrashDumps,
-                    wantFullMemoryDumps: (_b = configuration.crashReportingConfig) === null || _b === void 0 ? void 0 : _b.wantFullMemoryDumps,
-                    enableNodeReport: (_c = configuration.crashReportingConfig) === null || _c === void 0 ? void 0 : _c.enableNodeReport,
-                    uploadToBentley: (_d = configuration.crashReportingConfig) === null || _d === void 0 ? void 0 : _d.uploadToBentley,
-                });
+        if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
+            this.platform.setCrashReporting(options.crashReportingConfig);
+            core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
+                enableCrashDumps: (_a = options.crashReportingConfig) === null || _a === void 0 ? void 0 : _a.enableCrashDumps,
+                wantFullMemoryDumps: (_b = options.crashReportingConfig) === null || _b === void 0 ? void 0 : _b.wantFullMemoryDumps,
+                enableNodeReport: (_c = options.crashReportingConfig) === null || _c === void 0 ? void 0 : _c.enableNodeReport,
+                uploadToBentley: (_d = options.crashReportingConfig) === null || _d === void 0 ? void 0 : _d.uploadToBentley,
             });
-            if (configuration.crashReportingConfig.enableNodeReport) {
+            if (options.crashReportingConfig.enableNodeReport) {
                 try {
                     // node-report reports on V8 fatal errors and unhandled exceptions/Promise rejections.
                     const nodereport = require("node-report/api"); // eslint-disable-line @typescript-eslint/no-var-requires
                     nodereport.setEvents("exception+fatalerror+apicall");
-                    nodereport.setDirectory(configuration.crashReportingConfig.crashDir);
+                    nodereport.setDirectory(options.crashReportingConfig.crashDir);
                     nodereport.setVerbose("yes");
                     core_bentley_1.Logger.logTrace(loggerCategory, "Configured native crash reporting (node-report)");
                 }
@@ -238,8 +231,8 @@ class IModelHost {
                 }
             }
         }
-        this.setupHostDirs(configuration);
-        this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
+        this.setupHostDirs(options);
+        this.initializeWorkspace(options);
         BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
         [
             IModelReadRpcImpl_1.IModelReadRpcImpl,
@@ -253,13 +246,13 @@ class IModelHost {
             GenericSchema_1.GenericSchema,
             FunctionalSchema_1.FunctionalSchema,
         ].forEach((schema) => schema.registerSchema()); // register all of the schemas
-        if (undefined !== configuration.hubAccess)
-            IModelHost._hubAccess = configuration.hubAccess;
-        IModelHost.configuration = configuration;
-        IModelHost.setupTileCache();
+        if (undefined !== options.hubAccess)
+            this._hubAccess = options.hubAccess;
+        this.configuration = options;
+        this.setupTileCache();
         this.platform.setUseTileCache(IModelHost.tileCacheService ? false : true);
         process.once("beforeExit", IModelHost.shutdown);
-        IModelHost.onAfterStartup.raiseEvent();
+        this.onAfterStartup.raiseEvent();
     }
     static logStartup() {
         if (!core_bentley_1.Logger.isEnabled(loggerCategory, core_bentley_1.LogLevel.Trace))
@@ -334,22 +327,24 @@ class IModelHost {
     }
     /** The directory where application assets may be found */
     static get appAssetsDir() { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }
-    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a "pending" status.
+    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
      * @internal
      */
     static get tileTreeRequestTimeout() {
-        return undefined !== IModelHost.configuration ? IModelHost.configuration.tileTreeRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;
+        var _a, _b;
+        return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileTreeRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
     }
-    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a "pending" status.
+    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a "pending" status.
      * @internal
      */
     static get tileContentRequestTimeout() {
-        return undefined !== IModelHost.configuration ? IModelHost.configuration.tileContentRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;
+        var _a, _b;
+        return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileContentRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
     }
     /** The backend will log when a tile took longer to load than this threshold in seconds. */
-    static get logTileLoadTimeThreshold() { return undefined !== IModelHost.configuration ? IModelHost.configuration.logTileLoadTimeThreshold : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
+    static get logTileLoadTimeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileLoadTimeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
     /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
-    static get logTileSizeThreshold() { return undefined !== IModelHost.configuration ? IModelHost.configuration.logTileSizeThreshold : IModelHostConfiguration.defaultLogTileSizeThreshold; }
+    static get logTileSizeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileSizeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileSizeThreshold; }
     /** Whether external tile caching is active.
      * @internal
      */
@@ -382,12 +377,18 @@ class IModelHost {
             throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Cannot use both Azure and custom cloud storage providers for tile cache.");
         }
     }
+    /** @internal */
+    static computeSchemaChecksum(arg) {
+        return this.platform.computeSchemaChecksum(arg);
+    }
 }
 exports.IModelHost = IModelHost;
 /** @alpha */
 IModelHost.telemetry = new core_telemetry_1.TelemetryManager();
 IModelHost.backendVersion = "";
 IModelHost._cacheDir = "";
+/** Event raised during startup to allow loading settings data */
+IModelHost.onWorkspaceStartup = new core_bentley_1.BeEvent();
 /** Event raised just after the backend IModelHost was started */
 IModelHost.onAfterStartup = new core_bentley_1.BeEvent();
 /** Event raised just before the backend IModelHost is to be shut down */