@itwin/core-backend 3.6.0 → 3.7.0-dev.1

package/lib/cjs/IModelHost.d.ts

@@ -1,370 +1,370 @@
-/** @packageDocumentation
- * @module IModelHost
- */
-import { IModelJsNative } from "@bentley/imodeljs-native";
-import { ServerStorage } from "@itwin/object-storage-core";
-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 { TileStorage } from "./TileStorage";
-import { Workspace, WorkspaceOpts } from "./workspace/Workspace";
-/** @alpha */
-export interface CrashReportingConfigNameValuePair {
-    name: string;
-    value: string;
-}
-/** Configuration of the crash-reporting system.
- * @alpha
- */
-export interface CrashReportingConfig {
-    /** The directory to which *.dmp and/or iModelJsNativeCrash*.properties.txt files are written. This directory will be created if it does not already exist. */
-    crashDir: string;
-    /** max # .dmp files that may exist in crashDir. The default is 50. */
-    maxDumpsInDir?: number;
-    /** 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. */
-    enableCrashDumps?: boolean;
-    /** If enableCrashDumps is true, do you want a full-memory dump? Defaults to false. */
-    wantFullMemoryDumps?: boolean;
-    /** 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. */
-    enableNodeReport?: boolean;
-    /** Additional name, value pairs to write to iModelJsNativeCrash*.properties.txt file in the event of a crash. */
-    params?: CrashReportingConfigNameValuePair[];
-    /** Run this .js file to process .dmp and Node.js crash reporting .json files in the event of a crash.
-     * This script will be executed with a single command-line parameter: the name of the dump or Node.js report file.
-     * In the case of a dump file, there will be a second file with the same basename and the extension ".properties.txt".
-     * Since it runs in a separate process, this script will have no access to the Javascript
-     * context of the exiting backend. No default.
-     */
-    dumpProcessorScriptFileName?: string;
-    /** Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false */
-    uploadToBentley?: boolean;
-}
-/**
- * Options for [[IModelHost.startup]]
- * @public
- */
-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 -
-     *   - Windows: $(HOMEDIR)/AppData/Local/iModelJs/
-     *   - Mac/iOS: $(HOMEDIR)/Library/Caches/iModelJs/
-     *   - Linux:   $(HOMEDIR)/.cache/iModelJs/
-     *   where $(HOMEDIR) is documented [here](https://nodejs.org/api/os.html#os_os_homedir)
-     * - if specified, ensure it is set to a folder with read/write access.
-     * - Sub-folders within this folder organize various caches -
-     *   - bc/ -> Briefcases
-     *   - appSettings/ -> Offline application settings (only relevant in native applications)
-     *   - etc.
-     * @see [[IModelHost.cacheDir]] for the value it's set to after startup
-     */
-    cacheDir?: LocalDirName;
-    /** The directory where application assets are found. */
-    appAssetsDir?: LocalDirName;
-    /**
-     * Options for creating the [[Workspace]]
-     * @beta
-     */
-    workspace?: WorkspaceOpts;
-    /**
-     * The kind of iModel hub server to use.
-     * @beta
-     */
-    hubAccess?: BackendHubAccess;
-    /** 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.
-     * @beta
-     */
-    tileCacheAzureCredentials?: AzureBlobStorageCredentials;
-    /**
-     * @beta
-     * @deprecated in 3.x. use tileCacheStorage
-     */
-    tileCacheService?: CloudStorageService;
-    /**
-     * @beta
-     * @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),
-     *       set this property with a custom ServerStorage.
-     */
-    tileCacheStorage?: ServerStorage;
-    /** 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.
-     * The local cache is used only if an external cache has not been configured via [[tileCacheService]], [[tileCacheStorage]], and [[tileCacheAzureCredentials]].
-     * Defaults to 1 GB. Must be an unsigned integer. A value of zero disables the local cache entirely.
-     * @beta
-     */
-    maxTileCacheDbSize?: number;
-    /** Whether to restrict tile cache URLs by client IP address (if available).
-     * @beta
-     */
-    restrictTileUrlsByClientIp?: boolean;
-    /**
-     * Whether to enable OpenTelemetry tracing
-     * @beta
-     */
-    enableOpenTelemetry?: boolean;
-    /** Whether to compress cached tiles.
-     * Defaults to `true`.
-     */
-    compressCachedTiles?: boolean;
-    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a "pending" status.
-     * @internal
-     */
-    tileTreeRequestTimeout?: number;
-    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a "pending" status.
-     * @internal
-     */
-    tileContentRequestTimeout?: number;
-    /** The backend will log when a tile took longer to load than this threshold in seconds.
-     * @internal
-     */
-    logTileLoadTimeThreshold?: number;
-    /** The backend will log when a tile is loaded with a size in bytes above this threshold.
-     * @internal
-     */
-    logTileSizeThreshold?: number;
-    /** Crash-reporting configuration
-     * @alpha
-     */
-    crashReportingConfig?: CrashReportingConfig;
-    /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */
-    authorizationClient?: AuthorizationClient;
-}
-/** Configuration of core-backend.
- * @public
- */
-export declare class IModelHostConfiguration implements IModelHostOptions {
-    static defaultTileRequestTimeout: number;
-    static defaultLogTileLoadTimeThreshold: number;
-    static defaultLogTileSizeThreshold: number;
-    /** @internal */
-    static defaultMaxTileCacheDbSize: number;
-    appAssetsDir?: LocalDirName;
-    cacheDir?: LocalDirName;
-    /** @beta */
-    workspace?: WorkspaceOpts;
-    /** @beta */
-    hubAccess?: BackendHubAccess;
-    /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */
-    authorizationClient?: AuthorizationClient;
-    /** @beta @deprecated in 3.x. */
-    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
- */
-export declare class IModelHost {
-    private constructor();
-    /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */
-    static authorizationClient?: AuthorizationClient;
-    /** @alpha */
-    static readonly telemetry: TelemetryManager;
-    static backendVersion: string;
-    private static _cacheDir;
-    private static _appWorkspace?;
-    private static _platform?;
-    /** @internal */
-    static get platform(): typeof IModelJsNative;
-    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 */
-    static readonly onBeforeShutdown: BeEvent<() => void>;
-    /** @internal */
-    static readonly session: Mutable<SessionProps>;
-    /** A uniqueId for this session */
-    static get sessionId(): GuidString;
-    static set sessionId(id: GuidString);
-    /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */
-    static get applicationId(): string;
-    static set applicationId(id: string);
-    /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
-    static get applicationVersion(): string;
-    static set applicationVersion(version: string);
-    /** Root directory holding files that iTwin.js caches */
-    static get cacheDir(): LocalDirName;
-    /** The application [[Workspace]] for this `IModelHost`
-     * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).
-     * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and
-     * attempting to add them to this Workspace will fail.
-     * @beta
-     */
-    static get appWorkspace(): Workspace;
-    /** The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. */
-    static snapshotFileNameResolver?: FileNameResolver;
-    /** Get the current access token for this IModelHost, or a blank string if none is available.
-     * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
-     * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
-     * obtains the token and forwards it to the frontend.
-     * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value
-     * returned by this method may change over time throughout the course of a session.
-     */
-    static getAccessToken(): Promise<AccessToken>;
-    /** @internal */
-    static flushLog(): void;
-    /** @internal */
-    static loadNative(): void;
-    private static syncNativeLogLevels;
-    private static registerPlatform;
-    /**
-     * @internal
-     * @deprecated in 3.x.
-     * @note Use [[IModelHostOptions.tileCacheService]] to set the service provider.
-     */
-    static tileCacheService?: CloudStorageService;
-    /** @internal */
-    static tileStorage?: TileStorage;
-    /**
-     * @internal
-     * @deprecated in 3.x.
-     */
-    static tileUploader?: CloudStorageTileUploader;
-    private static _hubAccess?;
-    /** @internal */
-    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 [[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 options Host configuration data.
-     * Raises [[onAfterStartup]].
-     * @see [[shutdown]].
-     */
-    static startup(options?: IModelHostOptions): Promise<void>;
-    private static _briefcaseCacheDir;
-    private static logStartup;
-    private static setupHostDirs;
-    /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
-    static shutdown(): Promise<void>;
-    /**
-     * Add or update a property that should be included in a crash report.
-     * @param name The name of the property
-     * @param value The value of the property
-     * @alpha
-     */
-    static setCrashReportProperty(name: string, value: string): void;
-    /**
-     * Remove a previously defined property so that will not be included in a crash report.
-     * @param name The name of the property
-     * @alpha
-     */
-    static removeCrashReportProperty(name: string): void;
-    /**
-     * Get all properties that will be included in a crash report.
-     * @alpha
-     */
-    static getCrashReportProperties(): CrashReportingConfigNameValuePair[];
-    /** The directory where application assets may be found */
-    static get appAssetsDir(): string | undefined;
-    /** 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 should wait before returning a "pending" status.
-     * @internal
-     */
-    static get tileContentRequestTimeout(): number;
-    /** The backend will log when a tile took longer to load than this threshold in seconds. */
-    static get logTileLoadTimeThreshold(): number;
-    /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
-    static get logTileSizeThreshold(): number;
-    /** Whether external tile caching is active.
-     * @internal
-     */
-    static get usingExternalTileCache(): boolean;
-    /** Whether to restrict tile cache URLs by client IP address.
-     * @internal
-     */
-    static get restrictTileUrlsByClientIp(): boolean;
-    /** Whether to compress cached tiles.
-     * @internal
-     */
-    static get compressCachedTiles(): boolean;
-    private static setupTileCache;
-    private static setupAzureTileCache;
-    /** @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
- */
-export declare class Platform {
-    /** Get the name of the platform. */
-    static get platformName(): "win32" | "linux" | "darwin" | "ios" | "android" | "uwp";
-    /** @internal */
-    static load(): typeof IModelJsNative;
-}
-/** Well known directories that may be used by the application. Also see [[Platform]]
- * @public
- */
-export declare class KnownLocations {
-    /** The directory where the imodeljs-native assets are stored. */
-    static get nativeAssetsDir(): string;
-    /** The directory where the core-backend assets are stored. */
-    static get packageAssetsDir(): string;
-    /** The temporary directory. */
-    static get tmpdir(): string;
-}
-/** Extend this class to provide custom file name resolution behavior.
- * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.
- * @see [[IModelHost.snapshotFileNameResolver]]
- * @public
- */
-export declare abstract class FileNameResolver {
-    /** Resolve a file name from the specified key.
-     * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.
-     * @returns The resolved file name or `undefined` if not found.
-     */
-    tryResolveKey(_fileKey: string): string | undefined;
-    /** Resolve a file name from the specified key.
-     * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.
-     * @returns The resolved file name.
-     * @throws [[IModelError]] if not found.
-     */
-    resolveKey(fileKey: string): string;
-    /** Resolve the input file name, which may be a partial name, into a full path file name.
-     * @param inFileName The partial file name.
-     * @returns The resolved full path file name or `undefined` if not found.
-     */
-    tryResolveFileName(inFileName: string): string | undefined;
-    /** Resolve the input file name, which may be a partial name, into a full path file name.
-     * @param inFileName The partial file name.
-     * @returns The resolved full path file name.
-     * @throws [[IModelError]] if not found.
-     */
-    resolveFileName(inFileName: string): string;
-}
+/** @packageDocumentation
+ * @module IModelHost
+ */
+import { IModelJsNative } from "@bentley/imodeljs-native";
+import { ServerStorage } from "@itwin/object-storage-core";
+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 { TileStorage } from "./TileStorage";
+import { Workspace, WorkspaceOpts } from "./workspace/Workspace";
+/** @alpha */
+export interface CrashReportingConfigNameValuePair {
+    name: string;
+    value: string;
+}
+/** Configuration of the crash-reporting system.
+ * @alpha
+ */
+export interface CrashReportingConfig {
+    /** The directory to which *.dmp and/or iModelJsNativeCrash*.properties.txt files are written. This directory will be created if it does not already exist. */
+    crashDir: string;
+    /** max # .dmp files that may exist in crashDir. The default is 50. */
+    maxDumpsInDir?: number;
+    /** 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. */
+    enableCrashDumps?: boolean;
+    /** If enableCrashDumps is true, do you want a full-memory dump? Defaults to false. */
+    wantFullMemoryDumps?: boolean;
+    /** 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. */
+    enableNodeReport?: boolean;
+    /** Additional name, value pairs to write to iModelJsNativeCrash*.properties.txt file in the event of a crash. */
+    params?: CrashReportingConfigNameValuePair[];
+    /** Run this .js file to process .dmp and Node.js crash reporting .json files in the event of a crash.
+     * This script will be executed with a single command-line parameter: the name of the dump or Node.js report file.
+     * In the case of a dump file, there will be a second file with the same basename and the extension ".properties.txt".
+     * Since it runs in a separate process, this script will have no access to the Javascript
+     * context of the exiting backend. No default.
+     */
+    dumpProcessorScriptFileName?: string;
+    /** Upload crash dump and node-reports to Bentley's crash-reporting service? Defaults to false */
+    uploadToBentley?: boolean;
+}
+/**
+ * Options for [[IModelHost.startup]]
+ * @public
+ */
+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 -
+     *   - Windows: $(HOMEDIR)/AppData/Local/iModelJs/
+     *   - Mac/iOS: $(HOMEDIR)/Library/Caches/iModelJs/
+     *   - Linux:   $(HOMEDIR)/.cache/iModelJs/
+     *   where $(HOMEDIR) is documented [here](https://nodejs.org/api/os.html#os_os_homedir)
+     * - if specified, ensure it is set to a folder with read/write access.
+     * - Sub-folders within this folder organize various caches -
+     *   - bc/ -> Briefcases
+     *   - appSettings/ -> Offline application settings (only relevant in native applications)
+     *   - etc.
+     * @see [[IModelHost.cacheDir]] for the value it's set to after startup
+     */
+    cacheDir?: LocalDirName;
+    /** The directory where application assets are found. */
+    appAssetsDir?: LocalDirName;
+    /**
+     * Options for creating the [[Workspace]]
+     * @beta
+     */
+    workspace?: WorkspaceOpts;
+    /**
+     * The kind of iModel hub server to use.
+     * @beta
+     */
+    hubAccess?: BackendHubAccess;
+    /** 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.
+     * @beta
+     */
+    tileCacheAzureCredentials?: AzureBlobStorageCredentials;
+    /**
+     * @beta
+     * @deprecated in 3.x. Use [[tileCacheStorage]] instead.
+     */
+    tileCacheService?: CloudStorageService;
+    /**
+     * @beta
+     * @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),
+     *       set this property with a custom ServerStorage.
+     */
+    tileCacheStorage?: ServerStorage;
+    /** 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.
+     * The local cache is used only if an external cache has not been configured via [[tileCacheService]], [[tileCacheStorage]], and [[tileCacheAzureCredentials]].
+     * Defaults to 1 GB. Must be an unsigned integer. A value of zero disables the local cache entirely.
+     * @beta
+     */
+    maxTileCacheDbSize?: number;
+    /** Whether to restrict tile cache URLs by client IP address (if available).
+     * @beta
+     */
+    restrictTileUrlsByClientIp?: boolean;
+    /**
+     * Whether to enable OpenTelemetry tracing
+     * @beta
+     */
+    enableOpenTelemetry?: boolean;
+    /** Whether to compress cached tiles.
+     * Defaults to `true`.
+     */
+    compressCachedTiles?: boolean;
+    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileTreeProps]($common) should wait before returning a "pending" status.
+     * @internal
+     */
+    tileTreeRequestTimeout?: number;
+    /** The time, in milliseconds, for which [IModelTileRpcInterface.requestTileContent]($common) should wait before returning a "pending" status.
+     * @internal
+     */
+    tileContentRequestTimeout?: number;
+    /** The backend will log when a tile took longer to load than this threshold in seconds.
+     * @internal
+     */
+    logTileLoadTimeThreshold?: number;
+    /** The backend will log when a tile is loaded with a size in bytes above this threshold.
+     * @internal
+     */
+    logTileSizeThreshold?: number;
+    /** Crash-reporting configuration
+     * @alpha
+     */
+    crashReportingConfig?: CrashReportingConfig;
+    /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */
+    authorizationClient?: AuthorizationClient;
+}
+/** Configuration of core-backend.
+ * @public
+ */
+export declare class IModelHostConfiguration implements IModelHostOptions {
+    static defaultTileRequestTimeout: number;
+    static defaultLogTileLoadTimeThreshold: number;
+    static defaultLogTileSizeThreshold: number;
+    /** @internal */
+    static defaultMaxTileCacheDbSize: number;
+    appAssetsDir?: LocalDirName;
+    cacheDir?: LocalDirName;
+    /** @beta */
+    workspace?: WorkspaceOpts;
+    /** @beta */
+    hubAccess?: BackendHubAccess;
+    /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */
+    authorizationClient?: AuthorizationClient;
+    /** @beta @deprecated in 3.x. Use [[tileCacheStorage]] instead. */
+    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
+ */
+export declare class IModelHost {
+    private constructor();
+    /** The AuthorizationClient used to obtain [AccessToken]($bentley)s. */
+    static authorizationClient?: AuthorizationClient;
+    /** @alpha */
+    static readonly telemetry: TelemetryManager;
+    static backendVersion: string;
+    private static _cacheDir;
+    private static _appWorkspace?;
+    private static _platform?;
+    /** @internal */
+    static get platform(): typeof IModelJsNative;
+    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 */
+    static readonly onBeforeShutdown: BeEvent<() => void>;
+    /** @internal */
+    static readonly session: Mutable<SessionProps>;
+    /** A uniqueId for this session */
+    static get sessionId(): GuidString;
+    static set sessionId(id: GuidString);
+    /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */
+    static get applicationId(): string;
+    static set applicationId(id: string);
+    /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
+    static get applicationVersion(): string;
+    static set applicationVersion(version: string);
+    /** Root directory holding files that iTwin.js caches */
+    static get cacheDir(): LocalDirName;
+    /** The application [[Workspace]] for this `IModelHost`
+     * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).
+     * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and
+     * attempting to add them to this Workspace will fail.
+     * @beta
+     */
+    static get appWorkspace(): Workspace;
+    /** The optional [[FileNameResolver]] that resolves keys and partial file names for snapshot iModels. */
+    static snapshotFileNameResolver?: FileNameResolver;
+    /** Get the current access token for this IModelHost, or a blank string if none is available.
+     * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
+     * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
+     * obtains the token and forwards it to the frontend.
+     * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value
+     * returned by this method may change over time throughout the course of a session.
+     */
+    static getAccessToken(): Promise<AccessToken>;
+    /** @internal */
+    static flushLog(): void;
+    /** @internal */
+    static loadNative(): void;
+    private static syncNativeLogLevels;
+    private static registerPlatform;
+    /**
+     * @internal
+     * @deprecated in 3.x. Use [[IModelHost.tileStorage]] instead.
+     * @note Use [[IModelHostOptions.tileCacheService]] to set the service provider.
+     */
+    static tileCacheService?: CloudStorageService;
+    /** @internal */
+    static tileStorage?: TileStorage;
+    /**
+     * @internal
+     * @deprecated in 3.x. Use [[IModelHost.tileStorage]] instead.
+     */
+    static tileUploader?: CloudStorageTileUploader;
+    private static _hubAccess?;
+    /** @internal */
+    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 [[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 options Host configuration data.
+     * Raises [[onAfterStartup]].
+     * @see [[shutdown]].
+     */
+    static startup(options?: IModelHostOptions): Promise<void>;
+    private static _briefcaseCacheDir;
+    private static logStartup;
+    private static setupHostDirs;
+    /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
+    static shutdown(): Promise<void>;
+    /**
+     * Add or update a property that should be included in a crash report.
+     * @param name The name of the property
+     * @param value The value of the property
+     * @alpha
+     */
+    static setCrashReportProperty(name: string, value: string): void;
+    /**
+     * Remove a previously defined property so that will not be included in a crash report.
+     * @param name The name of the property
+     * @alpha
+     */
+    static removeCrashReportProperty(name: string): void;
+    /**
+     * Get all properties that will be included in a crash report.
+     * @alpha
+     */
+    static getCrashReportProperties(): CrashReportingConfigNameValuePair[];
+    /** The directory where application assets may be found */
+    static get appAssetsDir(): string | undefined;
+    /** 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 should wait before returning a "pending" status.
+     * @internal
+     */
+    static get tileContentRequestTimeout(): number;
+    /** The backend will log when a tile took longer to load than this threshold in seconds. */
+    static get logTileLoadTimeThreshold(): number;
+    /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
+    static get logTileSizeThreshold(): number;
+    /** Whether external tile caching is active.
+     * @internal
+     */
+    static get usingExternalTileCache(): boolean;
+    /** Whether to restrict tile cache URLs by client IP address.
+     * @internal
+     */
+    static get restrictTileUrlsByClientIp(): boolean;
+    /** Whether to compress cached tiles.
+     * @internal
+     */
+    static get compressCachedTiles(): boolean;
+    private static setupTileCache;
+    private static setupAzureTileCache;
+    /** @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
+ */
+export declare class Platform {
+    /** Get the name of the platform. */
+    static get platformName(): "win32" | "linux" | "darwin" | "ios" | "android" | "uwp";
+    /** @internal */
+    static load(): typeof IModelJsNative;
+}
+/** Well known directories that may be used by the application. Also see [[Platform]]
+ * @public
+ */
+export declare class KnownLocations {
+    /** The directory where the imodeljs-native assets are stored. */
+    static get nativeAssetsDir(): string;
+    /** The directory where the core-backend assets are stored. */
+    static get packageAssetsDir(): string;
+    /** The temporary directory. */
+    static get tmpdir(): string;
+}
+/** Extend this class to provide custom file name resolution behavior.
+ * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.
+ * @see [[IModelHost.snapshotFileNameResolver]]
+ * @public
+ */
+export declare abstract class FileNameResolver {
+    /** Resolve a file name from the specified key.
+     * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.
+     * @returns The resolved file name or `undefined` if not found.
+     */
+    tryResolveKey(_fileKey: string): string | undefined;
+    /** Resolve a file name from the specified key.
+     * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.
+     * @returns The resolved file name.
+     * @throws [[IModelError]] if not found.
+     */
+    resolveKey(fileKey: string): string;
+    /** Resolve the input file name, which may be a partial name, into a full path file name.
+     * @param inFileName The partial file name.
+     * @returns The resolved full path file name or `undefined` if not found.
+     */
+    tryResolveFileName(inFileName: string): string | undefined;
+    /** Resolve the input file name, which may be a partial name, into a full path file name.
+     * @param inFileName The partial file name.
+     * @returns The resolved full path file name.
+     * @throws [[IModelError]] if not found.
+     */
+    resolveFileName(inFileName: string): string;
+}
 //# sourceMappingURL=IModelHost.d.ts.map