@itwin/core-backend 3.3.0-dev.27 → 3.3.0-dev.28

package/lib/cjs/HubMock.d.ts

@@ -0,0 +1,99 @@
+import { GuidString } from "@itwin/core-bentley";
+import { ChangesetFileProps, ChangesetIndex, ChangesetIndexAndId, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName } from "@itwin/core-common";
+import { AcquireNewBriefcaseIdArg, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, ChangesetRangeArg, CheckpointArg, CreateNewIModelProps, IModelIdArg, IModelNameArg, LockMap, LockProps, V2CheckpointAccessProps } from "./BackendHubAccess";
+import { CheckpointProps } from "./CheckpointManager";
+import { LocalHub } from "./LocalHub";
+/**
+ * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
+ *
+ * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
+ * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
+ * - waste network and data center resources (i.e. $$$s),
+ * - interfere with other tests running on the same or other systems, and
+ * - (far worse) are the source of test flakiness outside of the api being tested.
+ *
+ * This class can be used to create tests that do not require authentication, are synchronous,
+ * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
+ * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
+ *
+ * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
+ * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
+ * low level testing of the core apis only.
+ *
+ * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
+ * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
+ * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
+ * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
+ * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
+ *
+ * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.
+ * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
+ * computer.
+ *
+ * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
+ * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
+ *
+ * @internal
+ */
+export declare class HubMock {
+    private static mockRoot;
+    private static hubs;
+    private static _saveHubAccess;
+    private static _iTwinId;
+    /** Determine whether a test us currently being run under HubMock */
+    static get isValid(): boolean;
+    static get iTwinId(): string;
+    /**
+     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
+     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
+     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
+     */
+    static startup(mockName: LocalDirName, outputDir: string): void;
+    /** Stop a HubMock that was previously started with [[startup]]
+     * @note this function throws an exception if any of the iModels used during the tests are left open.
+     */
+    static shutdown(): void;
+    static findLocalHub(iModelId: GuidString): LocalHub;
+    /** create a [[LocalHub]] for an iModel.  */
+    static createNewIModel(arg: CreateNewIModelProps): Promise<GuidString>;
+    /** remove the [[LocalHub]] for an iModel */
+    static destroy(iModelId: GuidString): void;
+    /** All methods below are mocks of the [[BackendHubAccess]] interface */
+    static getChangesetFromNamedVersion(arg: IModelIdArg & {
+        versionName: string;
+    }): Promise<ChangesetProps>;
+    private static changesetIndexFromArg;
+    static getChangesetFromVersion(arg: IModelIdArg & {
+        version: IModelVersion;
+    }): Promise<ChangesetProps>;
+    static getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps>;
+    private static getAccessToken;
+    static getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]>;
+    static acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number>;
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    static releaseBriefcase(arg: BriefcaseIdArg): Promise<void>;
+    static downloadChangeset(arg: ChangesetArg & {
+        targetDir: LocalDirName;
+    }): Promise<ChangesetFileProps>;
+    static downloadChangesets(arg: ChangesetRangeArg & {
+        targetDir: LocalDirName;
+    }): Promise<ChangesetFileProps[]>;
+    static queryChangeset(arg: ChangesetArg): Promise<ChangesetProps>;
+    static queryChangesets(arg: IModelIdArg & {
+        range?: ChangesetRange;
+    }): Promise<ChangesetProps[]>;
+    static pushChangeset(arg: IModelIdArg & {
+        changesetProps: ChangesetFileProps;
+    }): Promise<ChangesetIndex>;
+    static queryV2Checkpoint(_arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined>;
+    static downloadV2Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId>;
+    static downloadV1Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId>;
+    static releaseAllLocks(arg: BriefcaseDbArg): Promise<void>;
+    static queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]>;
+    static acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void>;
+    static queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined>;
+    static deleteIModel(arg: IModelIdArg & {
+        iTwinId: GuidString;
+    }): Promise<void>;
+}
+//# sourceMappingURL=HubMock.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HubMock.d.ts","sourceRoot":"","sources":["../../src/HubMock.ts"],"names":[],"mappings":"AAOA,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EACrH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,wBAAwB,EACN,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,oBAAoB,EAAE,WAAW,EAAE,aAAa,EAClJ,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAC5C,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAClD,OAAO,CAAC,MAAM,CAAC,IAAI,CAA+B;IAClD,OAAO,CAAC,MAAM,CAAC,cAAc,CAA+B;IAC5D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAyB;IAEhD,oEAAoE;IACpE,WAAkB,OAAO,YAA0C;IAEnE,WAAkB,OAAO,WAIxB;IAED;;;;OAIG;WACW,OAAO,CAAC,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM;IAc/D;;OAEG;WACW,QAAQ;WAkBR,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,QAAQ;IAO1D,4CAA4C;WACxB,eAAe,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAUnF,4CAA4C;WAC9B,OAAO,CAAC,QAAQ,EAAE,UAAU;IAK1C,wEAAwE;WAEpD,4BAA4B,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrH,OAAO,CAAC,MAAM,CAAC,qBAAqB;WAIhB,uBAAuB,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;WAiB/F,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;mBAI5D,cAAc;WAIf,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;WAKtD,qBAAqB,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzF,gHAAgH;WAC5F,gBAAgB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;WAIpD,iBAAiB,CAAC,GAAG,EAAE,YAAY,GAAG;QAAE,SAAS,EAAE,YAAY,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;WAI/F,kBAAkB,CAAC,GAAG,EAAE,iBAAiB,GAAG;QAAE,SAAS,EAAE,YAAY,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;WAIvG,cAAc,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;WAI1D,eAAe,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,KAAK,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;WAIzF,aAAa,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,cAAc,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;WAIjG,iBAAiB,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;WAItF,oBAAoB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;WAItE,oBAAoB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;WAItE,eAAe,CAAC,GAAG,EAAE,cAAc;WAKnC,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;WAIzD,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;WAIhE,iBAAiB,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;WAStE,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG;QAAE,OAAO,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5F"}

package/lib/cjs/HubMock.js

@@ -0,0 +1,195 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubMock = void 0;
+const path_1 = require("path");
+const sinon = require("sinon");
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelHost_1 = require("./IModelHost");
+const IModelJsFs_1 = require("./IModelJsFs");
+const LocalHub_1 = require("./LocalHub");
+/**
+ * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
+ *
+ * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
+ * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
+ * - waste network and data center resources (i.e. $$$s),
+ * - interfere with other tests running on the same or other systems, and
+ * - (far worse) are the source of test flakiness outside of the api being tested.
+ *
+ * This class can be used to create tests that do not require authentication, are synchronous,
+ * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
+ * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
+ *
+ * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
+ * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
+ * low level testing of the core apis only.
+ *
+ * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
+ * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
+ * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
+ * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
+ * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
+ *
+ * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.
+ * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
+ * computer.
+ *
+ * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
+ * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
+ *
+ * @internal
+ */
+class HubMock {
+    /** Determine whether a test us currently being run under HubMock */
+    static get isValid() { return undefined !== this.mockRoot; }
+    static get iTwinId() {
+        if (undefined === this._iTwinId)
+            throw new Error("Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed");
+        return this._iTwinId;
+    }
+    /**
+     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
+     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
+     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
+     */
+    static startup(mockName, outputDir) {
+        if (this.isValid)
+            throw new Error("Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed");
+        this.hubs.clear();
+        this.mockRoot = (0, path_1.join)(outputDir, "HubMock", mockName);
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync(this.mockRoot);
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
+        this._saveHubAccess = IModelHost_1.IModelHost.getHubAccess();
+        IModelHost_1.IModelHost.setHubAccess(this);
+        HubMock._iTwinId = core_bentley_1.Guid.createValue(); // all iModels for this test get the same "iTwinId"
+    }
+    /** Stop a HubMock that was previously started with [[startup]]
+     * @note this function throws an exception if any of the iModels used during the tests are left open.
+     */
+    static shutdown() {
+        if (!this.isValid)
+            return;
+        HubMock._iTwinId = undefined;
+        for (const hub of this.hubs)
+            hub[1].cleanup();
+        this.hubs.clear();
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        IModelJsFs_1.IModelJsFs.removeSync(this.mockRoot);
+        sinon.restore();
+        IModelHost_1.IModelHost.setHubAccess(this._saveHubAccess);
+        this.mockRoot = undefined;
+    }
+    static findLocalHub(iModelId) {
+        const hub = this.hubs.get(iModelId);
+        if (!hub)
+            throw new Error(`local hub for iModel ${iModelId} not created`);
+        return hub;
+    }
+    /** create a [[LocalHub]] for an iModel.  */
+    static async createNewIModel(arg) {
+        if (!this.mockRoot)
+            throw new Error("call startup first");
+        const props = { ...arg, iModelId: core_bentley_1.Guid.createValue() };
+        const mock = new LocalHub_1.LocalHub((0, path_1.join)(this.mockRoot, props.iModelId), props);
+        this.hubs.set(props.iModelId, mock);
+        return props.iModelId;
+    }
+    /** remove the [[LocalHub]] for an iModel */
+    static destroy(iModelId) {
+        this.findLocalHub(iModelId).cleanup();
+        this.hubs.delete(iModelId);
+    }
+    /** All methods below are mocks of the [[BackendHubAccess]] interface */
+    static async getChangesetFromNamedVersion(arg) {
+        return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);
+    }
+    static changesetIndexFromArg(arg) {
+        return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);
+    }
+    static async getChangesetFromVersion(arg) {
+        const hub = this.findLocalHub(arg.iModelId);
+        const version = arg.version;
+        if (version.isFirst)
+            return hub.getChangesetByIndex(0);
+        const asOf = version.getAsOfChangeSet();
+        if (asOf)
+            return hub.getChangesetById(asOf);
+        const versionName = version.getName();
+        if (versionName)
+            return hub.findNamedVersion(versionName);
+        return hub.getLatestChangeset();
+    }
+    static async getLatestChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).getLatestChangeset();
+    }
+    static async getAccessToken(arg) {
+        var _a;
+        return (_a = arg.accessToken) !== null && _a !== void 0 ? _a : await IModelHost_1.IModelHost.getAccessToken();
+    }
+    static async getMyBriefcaseIds(arg) {
+        const accessToken = await this.getAccessToken(arg);
+        return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);
+    }
+    static async acquireNewBriefcaseId(arg) {
+        const accessToken = await this.getAccessToken(arg);
+        return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);
+    }
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    static async releaseBriefcase(arg) {
+        return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);
+    }
+    static async downloadChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });
+    }
+    static async downloadChangesets(arg) {
+        return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });
+    }
+    static async queryChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));
+    }
+    static async queryChangesets(arg) {
+        return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);
+    }
+    static async pushChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);
+    }
+    static async queryV2Checkpoint(_arg) {
+        return undefined;
+    }
+    static async downloadV2Checkpoint(arg) {
+        return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });
+    }
+    static async downloadV1Checkpoint(arg) {
+        return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });
+    }
+    static async releaseAllLocks(arg) {
+        const hub = this.findLocalHub(arg.iModelId);
+        hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });
+    }
+    static async queryAllLocks(_arg) {
+        return [];
+    }
+    static async acquireLocks(arg, locks) {
+        this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);
+    }
+    static async queryIModelByName(arg) {
+        for (const hub of this.hubs) {
+            const localHub = hub[1];
+            if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)
+                return localHub.iModelId;
+        }
+        return undefined;
+    }
+    static async deleteIModel(arg) {
+        return this.destroy(arg.iModelId);
+    }
+}
+exports.HubMock = HubMock;
+HubMock.hubs = new Map();
+//# sourceMappingURL=HubMock.js.map

package/lib/cjs/HubMock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubMock.js","sourceRoot":"","sources":["../../src/HubMock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,+BAA4B;AAC5B,+BAA+B;AAC/B,sDAAuD;AAUvD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,OAAO;IAMlB,oEAAoE;IAC7D,MAAM,KAAK,OAAO,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE5D,MAAM,KAAK,OAAO;QACvB,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,MAAM,IAAI,KAAK,CAAC,0JAA0J,CAAC,CAAC;QAC9K,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,QAAsB,EAAE,SAAiB;QAC7D,IAAI,IAAI,CAAC,OAAO;YACd,MAAM,IAAI,KAAK,CAAC,0JAA0J,CAAC,CAAC;QAE9K,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrD,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,uBAAU,CAAC,YAAY,EAAE,CAAC;QAEhD,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,QAAQ,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,mDAAmD;IAC5F,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO;QAET,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,oEAAoE;QACpE,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;QACxC,oEAAoE;QACpE,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;QACtC,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAoB;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,cAAc,CAAC,CAAC;QAClE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAyB;QAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAExC,MAAM,KAAK,GAAG,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,mBAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,mBAAQ,CAAC,IAAA,WAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,OAAO,CAAC,QAAoB;QACxC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,wEAAwE;IAEjE,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,GAA0C;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,GAAiB;QACpD,OAAO,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACzI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAA6C;QACvF,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,IAAI,OAAO,CAAC,OAAO;YACjB,OAAO,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACxC,IAAI,IAAI;YACN,OAAO,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,WAAW;YACb,OAAO,GAAG,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE3C,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAClC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAgB;QACrD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9D,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAa;;QAC/C,OAAO,MAAA,GAAG,CAAC,WAAW,mCAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;IAC9D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAgB;QACpD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAA6B;QACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IAChG,CAAC;IAED,gHAAgH;IACzG,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAmB;QACtD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAA+C;QACnF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IACjI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAoD;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC5G,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAiB;QAClD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAA6C;QAC/E,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,GAAyD;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAqB;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAkB;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAkB;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAmB;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,GAAG,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAClH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAoB;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAmB,EAAE,KAAc;QAClE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAkB;QACtD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,QAAQ,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU;gBAC5E,OAAO,QAAQ,CAAC,QAAQ,CAAC;SAC5B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAA0C;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;;AAzLH,0BA0LC;AAxLgB,YAAI,GAAG,IAAI,GAAG,EAAoB,CAAC","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\r\nimport { join } from \"path\";\r\nimport * as sinon from \"sinon\";\r\nimport { Guid, GuidString } from \"@itwin/core-bentley\";\r\nimport {\r\n  ChangesetFileProps, ChangesetIndex, ChangesetIndexAndId, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName,\r\n} from \"@itwin/core-common\";\r\nimport {\r\n  AcquireNewBriefcaseIdArg,\r\n  BackendHubAccess, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, ChangesetRangeArg, CheckpointArg, CreateNewIModelProps, IModelIdArg, IModelNameArg,\r\n  LockMap, LockProps, V2CheckpointAccessProps,\r\n} from \"./BackendHubAccess\";\r\nimport { CheckpointProps } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { LocalHub } from \"./LocalHub\";\r\nimport { TokenArg } from \"./IModelDb\";\r\n\r\n/**\r\n * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.\r\n *\r\n * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:\r\n * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs\r\n * - waste network and data center resources (i.e. $$$s),\r\n * - interfere with other tests running on the same or other systems, and\r\n * - (far worse) are the source of test flakiness outside of the api being tested.\r\n *\r\n * This class can be used to create tests that do not require authentication, are synchronous,\r\n * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside\r\n * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.\r\n *\r\n * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests\r\n * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to\r\n * low level testing of the core apis only.\r\n *\r\n * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be\r\n * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean\r\n * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the\r\n * test against a \"real\" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your\r\n * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)\r\n *\r\n * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.\r\n * They use mock (aka \"bogus\") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current\r\n * computer.\r\n *\r\n * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests\r\n * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.\r\n *\r\n * @internal\r\n */\r\nexport class HubMock {\r\n  private static mockRoot: LocalDirName | undefined;\r\n  private static hubs = new Map<string, LocalHub>();\r\n  private static _saveHubAccess: BackendHubAccess | undefined;\r\n  private static _iTwinId: GuidString | undefined;\r\n\r\n  /** Determine whether a test us currently being run under HubMock */\r\n  public static get isValid() { return undefined !== this.mockRoot; }\r\n\r\n  public static get iTwinId() {\r\n    if (undefined === this._iTwinId)\r\n      throw new Error(\"Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed\");\r\n    return this._iTwinId;\r\n  }\r\n\r\n  /**\r\n   * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].\r\n   * @param mockName a unique name (e.g. \"MyTest\") for this HubMock to disambiguate tests when more than one is simultaneously active.\r\n   * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.\r\n   */\r\n  public static startup(mockName: LocalDirName, outputDir: string) {\r\n    if (this.isValid)\r\n      throw new Error(\"Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed\");\r\n\r\n    this.hubs.clear();\r\n    this.mockRoot = join(outputDir, \"HubMock\", mockName);\r\n    IModelJsFs.recursiveMkDirSync(this.mockRoot);\r\n    IModelJsFs.purgeDirSync(this.mockRoot);\r\n    this._saveHubAccess = IModelHost.getHubAccess();\r\n\r\n    IModelHost.setHubAccess(this);\r\n    HubMock._iTwinId = Guid.createValue(); // all iModels for this test get the same \"iTwinId\"\r\n  }\r\n\r\n  /** Stop a HubMock that was previously started with [[startup]]\r\n   * @note this function throws an exception if any of the iModels used during the tests are left open.\r\n   */\r\n  public static shutdown() {\r\n    if (!this.isValid)\r\n      return;\r\n\r\n    HubMock._iTwinId = undefined;\r\n    for (const hub of this.hubs)\r\n      hub[1].cleanup();\r\n\r\n    this.hubs.clear();\r\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n    IModelJsFs.purgeDirSync(this.mockRoot!);\r\n    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\r\n    IModelJsFs.removeSync(this.mockRoot!);\r\n    sinon.restore();\r\n    IModelHost.setHubAccess(this._saveHubAccess);\r\n    this.mockRoot = undefined;\r\n  }\r\n\r\n  public static findLocalHub(iModelId: GuidString): LocalHub {\r\n    const hub = this.hubs.get(iModelId);\r\n    if (!hub)\r\n      throw new Error(`local hub for iModel ${iModelId} not created`);\r\n    return hub;\r\n  }\r\n\r\n  /** create a [[LocalHub]] for an iModel.  */\r\n  public static async createNewIModel(arg: CreateNewIModelProps): Promise<GuidString> {\r\n    if (!this.mockRoot)\r\n      throw new Error(\"call startup first\");\r\n\r\n    const props = { ...arg, iModelId: Guid.createValue() };\r\n    const mock = new LocalHub(join(this.mockRoot, props.iModelId), props);\r\n    this.hubs.set(props.iModelId, mock);\r\n    return props.iModelId;\r\n  }\r\n\r\n  /** remove the [[LocalHub]] for an iModel */\r\n  public static destroy(iModelId: GuidString) {\r\n    this.findLocalHub(iModelId).cleanup();\r\n    this.hubs.delete(iModelId);\r\n  }\r\n\r\n  /** All methods below are mocks of the [[BackendHubAccess]] interface */\r\n\r\n  public static async getChangesetFromNamedVersion(arg: IModelIdArg & { versionName: string }): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);\r\n  }\r\n\r\n  private static changesetIndexFromArg(arg: ChangesetArg) {\r\n    return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);\r\n  }\r\n\r\n  public static async getChangesetFromVersion(arg: IModelIdArg & { version: IModelVersion }): Promise<ChangesetProps> {\r\n    const hub = this.findLocalHub(arg.iModelId);\r\n    const version = arg.version;\r\n    if (version.isFirst)\r\n      return hub.getChangesetByIndex(0);\r\n\r\n    const asOf = version.getAsOfChangeSet();\r\n    if (asOf)\r\n      return hub.getChangesetById(asOf);\r\n\r\n    const versionName = version.getName();\r\n    if (versionName)\r\n      return hub.findNamedVersion(versionName);\r\n\r\n    return hub.getLatestChangeset();\r\n  }\r\n\r\n  public static async getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).getLatestChangeset();\r\n  }\r\n\r\n  private static async getAccessToken(arg: TokenArg) {\r\n    return arg.accessToken ?? await IModelHost.getAccessToken();\r\n  }\r\n\r\n  public static async getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]> {\r\n    const accessToken = await this.getAccessToken(arg);\r\n    return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);\r\n  }\r\n\r\n  public static async acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number> {\r\n    const accessToken = await this.getAccessToken(arg);\r\n    return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);\r\n  }\r\n\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  public static async releaseBriefcase(arg: BriefcaseIdArg): Promise<void> {\r\n    return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);\r\n  }\r\n\r\n  public static async downloadChangeset(arg: ChangesetArg & { targetDir: LocalDirName }): Promise<ChangesetFileProps> {\r\n    return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });\r\n  }\r\n\r\n  public static async downloadChangesets(arg: ChangesetRangeArg & { targetDir: LocalDirName }): Promise<ChangesetFileProps[]> {\r\n    return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });\r\n  }\r\n\r\n  public static async queryChangeset(arg: ChangesetArg): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));\r\n  }\r\n\r\n  public static async queryChangesets(arg: IModelIdArg & { range?: ChangesetRange }): Promise<ChangesetProps[]> {\r\n    return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);\r\n  }\r\n\r\n  public static async pushChangeset(arg: IModelIdArg & { changesetProps: ChangesetFileProps }): Promise<ChangesetIndex> {\r\n    return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);\r\n  }\r\n\r\n  public static async queryV2Checkpoint(_arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined> {\r\n    return undefined;\r\n  }\r\n\r\n  public static async downloadV2Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId> {\r\n    return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });\r\n  }\r\n\r\n  public static async downloadV1Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId> {\r\n    return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });\r\n  }\r\n\r\n  public static async releaseAllLocks(arg: BriefcaseDbArg) {\r\n    const hub = this.findLocalHub(arg.iModelId);\r\n    hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });\r\n  }\r\n\r\n  public static async queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]> {\r\n    return [];\r\n  }\r\n\r\n  public static async acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void> {\r\n    this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);\r\n  }\r\n\r\n  public static async queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined> {\r\n    for (const hub of this.hubs) {\r\n      const localHub = hub[1];\r\n      if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)\r\n        return localHub.iModelId;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public static async deleteIModel(arg: IModelIdArg & { iTwinId: GuidString }): Promise<void> {\r\n    return this.destroy(arg.iModelId);\r\n  }\r\n}\r\n"]}

package/lib/cjs/IModelHost.d.ts

@@ -186,12 +186,17 @@ export declare class IModelHost {
     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.
+     * To determine whether one is present, use [[getHubAccess]].
      */
     static get hubAccess(): BackendHubAccess;
     private static _isValid;

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,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,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,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"}

package/lib/cjs/IModelHost.js

@@ -174,17 +174,18 @@ 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.
+     * 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 IModelHostConfiguration");
         return this._hubAccess;
     }
     /** Returns true if IModelHost is started.  */

package/lib/cjs/IModelHost.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelHost.js","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,iCAAiC;AACjC,8DAAyE;AACzE,0DAAyD;AACzD,sDAA+I;AAC/I,oDAAiH;AAEjH,mEAAgE;AAChE,mDAAgD;AAChD,yDAAsD;AACtD,+DAAqI;AACrI,iEAA8D;AAC9D,2DAAwD;AACxD,6CAA0C;AAC1C,gEAA6D;AAC7D,oEAAiE;AACjE,oEAAiE;AACjE,4EAAyE;AACzE,sDAAmD;AACnD,6CAAoD;AACpD,qDAAiF;AACjF,mDAAyF;AACzF,2EAAwE;AAExE,MAAM,cAAc,GAAG,6CAAqB,CAAC,UAAU,CAAC;AAqCxD;;GAEG;AACH,MAAa,uBAAuB;IAApC;QAqDE;;WAEG;QACI,2BAAsB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAClF;;WAEG;QACI,8BAAyB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAUrF;;WAEG;QACI,6BAAwB,GAAW,uBAAuB,CAAC,+BAA+B,CAAC;QAMlG;;WAEG;QACI,yBAAoB,GAAW,uBAAuB,CAAC,2BAA2B,CAAC;IAW5F,CAAC;;AA7FD,0DA6FC;AAhCC;;GAEG;AACW,iDAAyB,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpD;;GAEG;AACW,uDAA+B,GAAG,EAAE,CAAC;AAMnD;;GAEG;AACW,mDAA2B,GAAG,EAAE,GAAG,OAAO,CAAC;AAiB3D;;;GAGG;AACH,MAAM,mBAAoB,SAAQ,uBAAY;IAe5C;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,2CAAoB,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAjBkB,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,QAAQ,EAAE,GAAG,CAAC,IAAI,2CAAoB,CAAC,QAAQ,EAAE;YAC3D,IAAI,GAAG,CAAC,OAAO;gBACb,QAAQ,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;SACpC;QACD,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAOe,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;IAWzB,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;IAYD,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,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,mBAAmB,0CAAE,cAAc,EAAE,CAAA,CAAC,mCAAI,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,KAAK,CAAC,QAAQ,EAAE,CAAC;IACxC,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;IAEO,MAAM,CAAC,gBAAgB,CAAC,QAA+B;QAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,SAAS,KAAK,QAAQ;YACxB,OAAO;QAET,IAAI,CAAC,8BAAe,CAAC,kBAAkB;YACrC,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAEvC,QAAQ,CAAC,MAAM,GAAG,qBAAM,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,6BAA6B;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAAC,CAAC,yDAAyD;QACzJ,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1C,IAAI,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC;YAChD,OAAO;QACT,IAAI,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE;YAC/D,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC,CAAC,iCAAiC;YAChG,OAAO;SACR;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,+BAA+B,WAAW,qCAAqC,eAAe,GAAG,CAAC,CAAC;IACpJ,CAAC;IAYD,gBAAgB;IACT,MAAM,CAAC,YAAY,CAAC,SAA2B,IAAI,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;IAExF;;;OAGG;IACI,MAAM,KAAK,SAAS;QACzB,mHAAmH;QACnH,oHAAoH;QACpH,oDAAoD;QACpD,kGAAkG;QAClG,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAC/B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,8FAA8F,CAAC,CAAC;QACjJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAGD,8CAA8C;IACvC,MAAM,KAAK,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAyC,IAAI,uBAAuB,EAAE;QAChG,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO,CAAC,4BAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE;YAC7B,UAAU,CAAC,SAAS,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC,mBAAmB,CAAC;QAE7D,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,yDAAyD;QACtH,IAAA,iCAAoB,GAAE,CAAC;QAEvB,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,aAAa,CAAC,CAAC,CAAC;gBAC5G,MAAM,KAAK,CAAC;aACb;SACF;QAED,IAAI,aAAa,CAAC,oBAAoB,IAAI,aAAa,CAAC,oBAAoB,CAAC,QAAQ,IAAI,CAAC,8BAAe,CAAC,oBAAoB,IAAI,CAAC,8BAAe,CAAC,kBAAkB,EAAE;YACrK,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YAEpE,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4BAA4B,EAAE,GAAG,EAAE;;gBAAC,OAAA,CAAC;oBACnE,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,mBAAmB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,mBAAmB;oBAC5E,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,eAAe,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,eAAe;iBACrE,CAAC,CAAA;aAAA,CAAC,CAAC;YAEJ,IAAI,aAAa,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;gBACvD,IAAI;oBACF,sFAAsF;oBACtF,MAAM,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,yDAAyD;oBACxG,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;oBACrD,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;oBACrE,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iDAAiD,CAAC,CAAC;iBACpF;gBAAC,OAAO,GAAG,EAAE;oBACZ,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,+BAA+B,CAAC,CAAC;iBACpE;aACF;SACF;QAED,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,0BAAc,CAAC,IAAI,mBAAmB,EAAE,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QAE5F,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,aAAa,CAAC,SAAS;YACvC,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC;QAClD,UAAU,CAAC,aAAa,GAAG,aAAa,CAAC;QACzC,UAAU,CAAC,cAAc,EAAE,CAAC;QAE5B,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAE1E,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChD,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACzC,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,aAAsC;;QACjE,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,MAAA,aAAa,CAAC,QAAQ,mCAAI,+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,gBAAgB,GAAG,SAAS,CAAC;QACxC,UAAU,CAAC,YAAY,GAAG,SAAS,CAAC;QACpC,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAChC,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrC,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,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACtJ,CAAC;IACD;;OAEG;IACI,MAAM,KAAK,yBAAyB;QACzC,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACzJ,CAAC;IAED,2FAA2F;IACpF,MAAM,KAAK,wBAAwB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC,uBAAuB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACrN,4FAA4F;IACrF,MAAM,KAAK,oBAAoB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAEzM;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,SAAS,KAAK,UAAU,CAAC,gBAAgB,CAAC;IACnD,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,aAAc,OAAO,KAAK,MAAK,MAAA,UAAU,CAAC,aAAa,0CAAE,mBAAmB,CAAA,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;YAC1B,OAAO;QAET,UAAU,CAAC,YAAY,GAAG,IAAI,8CAAwB,EAAE,CAAC;QAEzD,IAAI,WAAW,IAAI,CAAC,OAAO,EAAE;YAC3B,UAAU,CAAC,gBAAgB,GAAG,IAAI,sCAAgB,CAAC,WAAW,CAAC,CAAC;SACjE;aAAM,IAAI,CAAC,WAAW,IAAI,OAAO,EAAE;YAClC,UAAU,CAAC,gBAAgB,GAAG,OAAO,CAAC;SACvC;aAAM;YACL,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,0EAA0E,CAAC,CAAC;SACxH;IACH,CAAC;;AAlWH,gCAmWC;AA/VC,aAAa;AACU,oBAAS,GAAG,IAAI,iCAAgB,EAAE,CAAC;AAE5C,yBAAc,GAAG,EAAE,CAAC;AACnB,oBAAS,GAAG,EAAE,CAAC;AAY9B,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;AAwG/G,mBAAQ,GAAG,KAAK,CAAC;AAkOlC;;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 * as os from \"os\";\r\nimport * as path from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { TelemetryManager } from \"@itwin/core-telemetry\";\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 { BackendHubAccess } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BisCoreSchema } from \"./BisCoreSchema\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { AzureBlobStorage, AzureBlobStorageCredentials, CloudStorageService, CloudStorageTileUploader } from \"./CloudStorageBackend\";\r\nimport { FunctionalSchema } from \"./domains/FunctionalSchema\";\r\nimport { GenericSchema } from \"./domains/GenericSchema\";\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 { ITwinWorkspace, Workspace, WorkspaceOpts } from \"./workspace/Workspace\";\r\nimport { BaseSettings, SettingDictionary, SettingsPriority } from \"./workspace/Settings\";\r\nimport { SettingsSpecRegistry } from \"./workspace/SettingsSpecRegistry\";\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-report? If so, node-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-report 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-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/** Configuration of core-backend.\r\n * @public\r\n */\r\nexport class IModelHostConfiguration {\r\n\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  public cacheDir?: LocalDirName;\r\n\r\n  /** Options for creating the [[Workspace]]\r\n   * @beta\r\n   */\r\n  public workspace?: WorkspaceOpts;\r\n\r\n  /** The directory where the app's assets are found. */\r\n  public appAssetsDir?: LocalDirName;\r\n\r\n  /** The kind of iModel hub server to use.\r\n   * @beta\r\n   */\r\n  public 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  public tileCacheAzureCredentials?: AzureBlobStorageCredentials;\r\n\r\n  /**\r\n   * @beta\r\n   * @note A reference implementation is set for [[AzureBlobStorage]] 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 [[CloudStorageService]].\r\n   */\r\n  public tileCacheService?: CloudStorageService;\r\n\r\n  /** Whether to restrict tile cache URLs by client IP address (if available).\r\n   * @beta\r\n   */\r\n  public restrictTileUrlsByClientIp?: boolean;\r\n\r\n  /** Whether to compress cached tiles.\r\n   * Defaults to `true`.\r\n   */\r\n  public 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  public tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\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  public tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n  /** The default time, in milliseconds, used for [[tileTreeRequestTimeout]] and [[tileContentRequestTimeout]]. To change this, override one or both of those properties.\r\n   * @internal\r\n   */\r\n  public static defaultTileRequestTimeout = 20 * 1000;\r\n\r\n  /** The default time, in seconds, used for [[logTileLoadTimeThreshold]]. To change this, override that property.\r\n   * @internal\r\n   */\r\n  public static defaultLogTileLoadTimeThreshold = 40;\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  public logTileLoadTimeThreshold: number = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\r\n\r\n  /** The default size, in bytes, used for [[logTileSizeThreshold]]. To change this, override that property.\r\n   * @internal\r\n   */\r\n  public static defaultLogTileSizeThreshold = 20 * 1000000;\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  public logTileSizeThreshold: number = IModelHostConfiguration.defaultLogTileSizeThreshold;\r\n\r\n  /** Crash-reporting configuration\r\n   * @alpha\r\n   */\r\n  public crashReportingConfig?: CrashReportingConfig;\r\n\r\n  /** The AuthorizationClient used to get accessTokens\r\n   * @beta\r\n   */\r\n  public authorizationClient?: AuthorizationClient;\r\n}\r\n\r\n/**\r\n * Settings for the application workspace.\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 [specName, val] of SettingsSpecRegistry.allSpecs) {\r\n      if (val.default)\r\n        defaults[specName] = val.default;\r\n    }\r\n    this.addDictionary(\"_default_\", 0, defaults);\r\n  }\r\n\r\n  public constructor() {\r\n    super();\r\n    this._remove = SettingsSpecRegistry.onSpecsChanged.addListener(() => this.updateDefaults());\r\n    this.updateDefaults();\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  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?: IModelHostConfiguration;\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.DgnDb.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\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    if (!ProcessDetector.isMobileAppBackend)\r\n      this.validateNativePlatformVersion();\r\n\r\n    platform.logger = Logger;\r\n  }\r\n\r\n  private static validateNativePlatformVersion(): void {\r\n    const requiredVersion = require(\"../../package.json\").dependencies[\"@bentley/imodeljs-native\"]; // eslint-disable-line @typescript-eslint/no-var-requires\r\n    const thisVersion = this.platform.version;\r\n    if (semver.satisfies(thisVersion, requiredVersion))\r\n      return;\r\n    if (IModelJsFs.existsSync(path.join(__dirname, \"DevBuild.txt\"))) {\r\n      console.log(\"Bypassing version checks for development build\"); // eslint-disable-line no-console\r\n      return;\r\n    }\r\n    this._platform = undefined;\r\n    throw new IModelError(IModelStatus.BadRequest, `imodeljs-native version is (${thisVersion}). core-backend requires version (${requiredVersion})`);\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   * @note Use [[IModelHostConfiguration.tileCacheService]] to set the service provider.\r\n   */\r\n  public static tileCacheService?: CloudStorageService;\r\n\r\n  /** @internal */\r\n  public static tileUploader?: CloudStorageTileUploader;\r\n\r\n  private static _hubAccess: BackendHubAccess;\r\n  /** @internal */\r\n  public static setHubAccess(hubAccess: BackendHubAccess) { this._hubAccess = hubAccess; }\r\n\r\n  /** Provides access to the IModelHub for this IModelHost\r\n   * @beta\r\n   * @note If [[IModelHostConfiguration.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.\r\n   */\r\n  public static get hubAccess(): BackendHubAccess {\r\n    // Strictly speaking, _hubAccess should be marked as possibly undefined since it's not needed for Snapshot iModels.\r\n    // However, a decision was made to not provide that type annotation so callers aren't forced to constantly check for\r\n    // something that's required in all other workflows.\r\n    // This check is here to provide a better error message when hubAccess is inadvertently undefined.\r\n    if (this._hubAccess === undefined)\r\n      throw new IModelError(IModelStatus.BadRequest, \"IModelHost.hubAccess is undefined. Specify an implementation in your IModelHostConfiguration\");\r\n    return this._hubAccess;\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 configuration Host configuration data.\r\n   * Raises [[onAfterStartup]].\r\n   * @see [[shutdown]].\r\n   */\r\n  public static async startup(configuration: IModelHostConfiguration = new IModelHostConfiguration()): Promise<void> {\r\n    if (this._isValid)\r\n      return; // we're already initialized\r\n    this._isValid = true;\r\n\r\n    if (IModelHost.sessionId === \"\")\r\n      IModelHost.sessionId = Guid.createValue();\r\n\r\n    this.authorizationClient = configuration.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();\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\", () => (configuration));\r\n        throw error;\r\n      }\r\n    }\r\n\r\n    if (configuration.crashReportingConfig && configuration.crashReportingConfig.crashDir && !ProcessDetector.isElectronAppBackend && !ProcessDetector.isMobileAppBackend) {\r\n      this.platform.setCrashReporting(configuration.crashReportingConfig);\r\n\r\n      Logger.logTrace(loggerCategory, \"Configured crash reporting\", () => ({\r\n        enableCrashDumps: configuration.crashReportingConfig?.enableCrashDumps,\r\n        wantFullMemoryDumps: configuration.crashReportingConfig?.wantFullMemoryDumps,\r\n        enableNodeReport: configuration.crashReportingConfig?.enableNodeReport,\r\n        uploadToBentley: configuration.crashReportingConfig?.uploadToBentley,\r\n      }));\r\n\r\n      if (configuration.crashReportingConfig.enableNodeReport) {\r\n        try {\r\n          // node-report reports on V8 fatal errors and unhandled exceptions/Promise rejections.\r\n          const nodereport = require(\"node-report/api\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n          nodereport.setEvents(\"exception+fatalerror+apicall\");\r\n          nodereport.setDirectory(configuration.crashReportingConfig.crashDir);\r\n          nodereport.setVerbose(\"yes\");\r\n          Logger.logTrace(loggerCategory, \"Configured native crash reporting (node-report)\");\r\n        } catch (err) {\r\n          Logger.logWarning(loggerCategory, \"node-report is not installed.\");\r\n        }\r\n      }\r\n    }\r\n\r\n    this.setupHostDirs(configuration);\r\n    this._appWorkspace = new ITwinWorkspace(new ApplicationSettings(), configuration.workspace);\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 !== configuration.hubAccess)\r\n      IModelHost._hubAccess = configuration.hubAccess;\r\n    IModelHost.configuration = configuration;\r\n    IModelHost.setupTileCache();\r\n\r\n    this.platform.setUseTileCache(IModelHost.tileCacheService ? false : true);\r\n\r\n    process.once(\"beforeExit\", IModelHost.shutdown);\r\n    IModelHost.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: IModelHostConfiguration) {\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.tileCacheService = undefined;\r\n    IModelHost.tileUploader = undefined;\r\n    IModelHost.appWorkspace.close();\r\n    IModelHost._appWorkspace = undefined;\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]($common) should wait before returning a \"pending\" status.\r\n   * @internal\r\n   */\r\n  public static get tileTreeRequestTimeout(): number {\r\n    return undefined !== IModelHost.configuration ? IModelHost.configuration.tileTreeRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;\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  public static get tileContentRequestTimeout(): number {\r\n    return undefined !== IModelHost.configuration ? 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 undefined !== IModelHost.configuration ? 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 undefined !== IModelHost.configuration ? 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.tileCacheService;\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 service = config.tileCacheService;\r\n    const credentials = config.tileCacheAzureCredentials;\r\n\r\n    if (!service && !credentials)\r\n      return;\r\n\r\n    IModelHost.tileUploader = new CloudStorageTileUploader();\r\n\r\n    if (credentials && !service) {\r\n      IModelHost.tileCacheService = new AzureBlobStorage(credentials);\r\n    } else if (!credentials && service) {\r\n      IModelHost.tileCacheService = service;\r\n    } else {\r\n      throw new IModelError(BentleyStatus.ERROR, \"Cannot use both Azure and custom cloud storage providers for tile cache.\");\r\n    }\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"]}
+{"version":3,"file":"IModelHost.js","sourceRoot":"","sources":["../../src/IModelHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,iCAAiC;AACjC,8DAAyE;AACzE,0DAAyD;AACzD,sDAA+I;AAC/I,oDAAiH;AAEjH,mEAAgE;AAChE,mDAAgD;AAChD,yDAAsD;AACtD,+DAAqI;AACrI,iEAA8D;AAC9D,2DAAwD;AACxD,6CAA0C;AAC1C,gEAA6D;AAC7D,oEAAiE;AACjE,oEAAiE;AACjE,4EAAyE;AACzE,sDAAmD;AACnD,6CAAoD;AACpD,qDAAiF;AACjF,mDAAyF;AACzF,2EAAwE;AAExE,MAAM,cAAc,GAAG,6CAAqB,CAAC,UAAU,CAAC;AAqCxD;;GAEG;AACH,MAAa,uBAAuB;IAApC;QAqDE;;WAEG;QACI,2BAAsB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAClF;;WAEG;QACI,8BAAyB,GAAG,uBAAuB,CAAC,yBAAyB,CAAC;QAUrF;;WAEG;QACI,6BAAwB,GAAW,uBAAuB,CAAC,+BAA+B,CAAC;QAMlG;;WAEG;QACI,yBAAoB,GAAW,uBAAuB,CAAC,2BAA2B,CAAC;IAW5F,CAAC;;AA7FD,0DA6FC;AAhCC;;GAEG;AACW,iDAAyB,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpD;;GAEG;AACW,uDAA+B,GAAG,EAAE,CAAC;AAMnD;;GAEG;AACW,mDAA2B,GAAG,EAAE,GAAG,OAAO,CAAC;AAiB3D;;;GAGG;AACH,MAAM,mBAAoB,SAAQ,uBAAY;IAe5C;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,2CAAoB,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAjBkB,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,QAAQ,EAAE,GAAG,CAAC,IAAI,2CAAoB,CAAC,QAAQ,EAAE;YAC3D,IAAI,GAAG,CAAC,OAAO;gBACb,QAAQ,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;SACpC;QACD,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAOe,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;IAWzB,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;IAYD,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,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,mBAAmB,0CAAE,cAAc,EAAE,CAAA,CAAC,mCAAI,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,KAAK,CAAC,QAAQ,EAAE,CAAC;IACxC,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;IAEO,MAAM,CAAC,gBAAgB,CAAC,QAA+B;QAC7D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,SAAS,KAAK,QAAQ;YACxB,OAAO;QAET,IAAI,CAAC,8BAAe,CAAC,kBAAkB;YACrC,IAAI,CAAC,6BAA6B,EAAE,CAAC;QAEvC,QAAQ,CAAC,MAAM,GAAG,qBAAM,CAAC;IAC3B,CAAC;IAEO,MAAM,CAAC,6BAA6B;QAC1C,MAAM,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAAC,CAAC,yDAAyD;QACzJ,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1C,IAAI,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC;YAChD,OAAO;QACT,IAAI,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,EAAE;YAC/D,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC,CAAC,iCAAiC;YAChG,OAAO;SACR;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,+BAA+B,WAAW,qCAAqC,eAAe,GAAG,CAAC,CAAC;IACpJ,CAAC;IAYD,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,yDAAyD,CAAC,CAAC;QAC5G,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAGD,8CAA8C;IACvC,MAAM,KAAK,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAyC,IAAI,uBAAuB,EAAE;QAChG,IAAI,IAAI,CAAC,QAAQ;YACf,OAAO,CAAC,4BAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,UAAU,CAAC,SAAS,KAAK,EAAE;YAC7B,UAAU,CAAC,SAAS,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC,mBAAmB,CAAC;QAE7D,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,CAAC,yDAAyD;QACtH,IAAA,iCAAoB,GAAE,CAAC;QAEvB,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,aAAa,CAAC,CAAC,CAAC;gBAC5G,MAAM,KAAK,CAAC;aACb;SACF;QAED,IAAI,aAAa,CAAC,oBAAoB,IAAI,aAAa,CAAC,oBAAoB,CAAC,QAAQ,IAAI,CAAC,8BAAe,CAAC,oBAAoB,IAAI,CAAC,8BAAe,CAAC,kBAAkB,EAAE;YACrK,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YAEpE,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4BAA4B,EAAE,GAAG,EAAE;;gBAAC,OAAA,CAAC;oBACnE,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,mBAAmB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,mBAAmB;oBAC5E,gBAAgB,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,gBAAgB;oBACtE,eAAe,EAAE,MAAA,aAAa,CAAC,oBAAoB,0CAAE,eAAe;iBACrE,CAAC,CAAA;aAAA,CAAC,CAAC;YAEJ,IAAI,aAAa,CAAC,oBAAoB,CAAC,gBAAgB,EAAE;gBACvD,IAAI;oBACF,sFAAsF;oBACtF,MAAM,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,yDAAyD;oBACxG,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;oBACrD,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;oBACrE,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iDAAiD,CAAC,CAAC;iBACpF;gBAAC,OAAO,GAAG,EAAE;oBACZ,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,+BAA+B,CAAC,CAAC;iBACpE;aACF;SACF;QAED,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,0BAAc,CAAC,IAAI,mBAAmB,EAAE,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QAE5F,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,aAAa,CAAC,SAAS;YACvC,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC;QAClD,UAAU,CAAC,aAAa,GAAG,aAAa,CAAC;QACzC,UAAU,CAAC,cAAc,EAAE,CAAC;QAE5B,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAE1E,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChD,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;IACzC,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,aAAsC;;QACjE,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,MAAA,aAAa,CAAC,QAAQ,mCAAI,+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,gBAAgB,GAAG,SAAS,CAAC;QACxC,UAAU,CAAC,YAAY,GAAG,SAAS,CAAC;QACpC,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAChC,UAAU,CAAC,aAAa,GAAG,SAAS,CAAC;QACrC,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,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACtJ,CAAC;IACD;;OAEG;IACI,MAAM,KAAK,yBAAyB;QACzC,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC,CAAC,uBAAuB,CAAC,yBAAyB,CAAC;IACzJ,CAAC;IAED,2FAA2F;IACpF,MAAM,KAAK,wBAAwB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC,uBAAuB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACrN,4FAA4F;IACrF,MAAM,KAAK,oBAAoB,KAAa,OAAO,SAAS,KAAK,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IAEzM;;OAEG;IACI,MAAM,KAAK,sBAAsB;QACtC,OAAO,SAAS,KAAK,UAAU,CAAC,gBAAgB,CAAC;IACnD,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,aAAc,OAAO,KAAK,MAAK,MAAA,UAAU,CAAC,aAAa,0CAAE,mBAAmB,CAAA,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;YAC1B,OAAO;QAET,UAAU,CAAC,YAAY,GAAG,IAAI,8CAAwB,EAAE,CAAC;QAEzD,IAAI,WAAW,IAAI,CAAC,OAAO,EAAE;YAC3B,UAAU,CAAC,gBAAgB,GAAG,IAAI,sCAAgB,CAAC,WAAW,CAAC,CAAC;SACjE;aAAM,IAAI,CAAC,WAAW,IAAI,OAAO,EAAE;YAClC,UAAU,CAAC,gBAAgB,GAAG,OAAO,CAAC;SACvC;aAAM;YACL,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,0EAA0E,CAAC,CAAC;SACxH;IACH,CAAC;;AApWH,gCAqWC;AAjWC,aAAa;AACU,oBAAS,GAAG,IAAI,iCAAgB,EAAE,CAAC;AAE5C,yBAAc,GAAG,EAAE,CAAC;AACnB,oBAAS,GAAG,EAAE,CAAC;AAY9B,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;AA0G/G,mBAAQ,GAAG,KAAK,CAAC;AAkOlC;;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 * as os from \"os\";\r\nimport * as path from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative, NativeLibrary } from \"@bentley/imodeljs-native\";\r\nimport { TelemetryManager } from \"@itwin/core-telemetry\";\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 { BackendHubAccess } from \"./BackendHubAccess\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BisCoreSchema } from \"./BisCoreSchema\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { AzureBlobStorage, AzureBlobStorageCredentials, CloudStorageService, CloudStorageTileUploader } from \"./CloudStorageBackend\";\r\nimport { FunctionalSchema } from \"./domains/FunctionalSchema\";\r\nimport { GenericSchema } from \"./domains/GenericSchema\";\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 { ITwinWorkspace, Workspace, WorkspaceOpts } from \"./workspace/Workspace\";\r\nimport { BaseSettings, SettingDictionary, SettingsPriority } from \"./workspace/Settings\";\r\nimport { SettingsSpecRegistry } from \"./workspace/SettingsSpecRegistry\";\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-report? If so, node-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-report 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-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/** Configuration of core-backend.\r\n * @public\r\n */\r\nexport class IModelHostConfiguration {\r\n\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  public cacheDir?: LocalDirName;\r\n\r\n  /** Options for creating the [[Workspace]]\r\n   * @beta\r\n   */\r\n  public workspace?: WorkspaceOpts;\r\n\r\n  /** The directory where the app's assets are found. */\r\n  public appAssetsDir?: LocalDirName;\r\n\r\n  /** The kind of iModel hub server to use.\r\n   * @beta\r\n   */\r\n  public 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  public tileCacheAzureCredentials?: AzureBlobStorageCredentials;\r\n\r\n  /**\r\n   * @beta\r\n   * @note A reference implementation is set for [[AzureBlobStorage]] 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 [[CloudStorageService]].\r\n   */\r\n  public tileCacheService?: CloudStorageService;\r\n\r\n  /** Whether to restrict tile cache URLs by client IP address (if available).\r\n   * @beta\r\n   */\r\n  public restrictTileUrlsByClientIp?: boolean;\r\n\r\n  /** Whether to compress cached tiles.\r\n   * Defaults to `true`.\r\n   */\r\n  public 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  public tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\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  public tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;\r\n  /** The default time, in milliseconds, used for [[tileTreeRequestTimeout]] and [[tileContentRequestTimeout]]. To change this, override one or both of those properties.\r\n   * @internal\r\n   */\r\n  public static defaultTileRequestTimeout = 20 * 1000;\r\n\r\n  /** The default time, in seconds, used for [[logTileLoadTimeThreshold]]. To change this, override that property.\r\n   * @internal\r\n   */\r\n  public static defaultLogTileLoadTimeThreshold = 40;\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  public logTileLoadTimeThreshold: number = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;\r\n\r\n  /** The default size, in bytes, used for [[logTileSizeThreshold]]. To change this, override that property.\r\n   * @internal\r\n   */\r\n  public static defaultLogTileSizeThreshold = 20 * 1000000;\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  public logTileSizeThreshold: number = IModelHostConfiguration.defaultLogTileSizeThreshold;\r\n\r\n  /** Crash-reporting configuration\r\n   * @alpha\r\n   */\r\n  public crashReportingConfig?: CrashReportingConfig;\r\n\r\n  /** The AuthorizationClient used to get accessTokens\r\n   * @beta\r\n   */\r\n  public authorizationClient?: AuthorizationClient;\r\n}\r\n\r\n/**\r\n * Settings for the application workspace.\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 [specName, val] of SettingsSpecRegistry.allSpecs) {\r\n      if (val.default)\r\n        defaults[specName] = val.default;\r\n    }\r\n    this.addDictionary(\"_default_\", 0, defaults);\r\n  }\r\n\r\n  public constructor() {\r\n    super();\r\n    this._remove = SettingsSpecRegistry.onSpecsChanged.addListener(() => this.updateDefaults());\r\n    this.updateDefaults();\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  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?: IModelHostConfiguration;\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.DgnDb.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\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    if (!ProcessDetector.isMobileAppBackend)\r\n      this.validateNativePlatformVersion();\r\n\r\n    platform.logger = Logger;\r\n  }\r\n\r\n  private static validateNativePlatformVersion(): void {\r\n    const requiredVersion = require(\"../../package.json\").dependencies[\"@bentley/imodeljs-native\"]; // eslint-disable-line @typescript-eslint/no-var-requires\r\n    const thisVersion = this.platform.version;\r\n    if (semver.satisfies(thisVersion, requiredVersion))\r\n      return;\r\n    if (IModelJsFs.existsSync(path.join(__dirname, \"DevBuild.txt\"))) {\r\n      console.log(\"Bypassing version checks for development build\"); // eslint-disable-line no-console\r\n      return;\r\n    }\r\n    this._platform = undefined;\r\n    throw new IModelError(IModelStatus.BadRequest, `imodeljs-native version is (${thisVersion}). core-backend requires version (${requiredVersion})`);\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   * @note Use [[IModelHostConfiguration.tileCacheService]] to set the service provider.\r\n   */\r\n  public static tileCacheService?: CloudStorageService;\r\n\r\n  /** @internal */\r\n  public static tileUploader?: CloudStorageTileUploader;\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 [[IModelHostConfiguration.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 IModelHostConfiguration\");\r\n    return this._hubAccess;\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 configuration Host configuration data.\r\n   * Raises [[onAfterStartup]].\r\n   * @see [[shutdown]].\r\n   */\r\n  public static async startup(configuration: IModelHostConfiguration = new IModelHostConfiguration()): Promise<void> {\r\n    if (this._isValid)\r\n      return; // we're already initialized\r\n    this._isValid = true;\r\n\r\n    if (IModelHost.sessionId === \"\")\r\n      IModelHost.sessionId = Guid.createValue();\r\n\r\n    this.authorizationClient = configuration.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();\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\", () => (configuration));\r\n        throw error;\r\n      }\r\n    }\r\n\r\n    if (configuration.crashReportingConfig && configuration.crashReportingConfig.crashDir && !ProcessDetector.isElectronAppBackend && !ProcessDetector.isMobileAppBackend) {\r\n      this.platform.setCrashReporting(configuration.crashReportingConfig);\r\n\r\n      Logger.logTrace(loggerCategory, \"Configured crash reporting\", () => ({\r\n        enableCrashDumps: configuration.crashReportingConfig?.enableCrashDumps,\r\n        wantFullMemoryDumps: configuration.crashReportingConfig?.wantFullMemoryDumps,\r\n        enableNodeReport: configuration.crashReportingConfig?.enableNodeReport,\r\n        uploadToBentley: configuration.crashReportingConfig?.uploadToBentley,\r\n      }));\r\n\r\n      if (configuration.crashReportingConfig.enableNodeReport) {\r\n        try {\r\n          // node-report reports on V8 fatal errors and unhandled exceptions/Promise rejections.\r\n          const nodereport = require(\"node-report/api\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n          nodereport.setEvents(\"exception+fatalerror+apicall\");\r\n          nodereport.setDirectory(configuration.crashReportingConfig.crashDir);\r\n          nodereport.setVerbose(\"yes\");\r\n          Logger.logTrace(loggerCategory, \"Configured native crash reporting (node-report)\");\r\n        } catch (err) {\r\n          Logger.logWarning(loggerCategory, \"node-report is not installed.\");\r\n        }\r\n      }\r\n    }\r\n\r\n    this.setupHostDirs(configuration);\r\n    this._appWorkspace = new ITwinWorkspace(new ApplicationSettings(), configuration.workspace);\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 !== configuration.hubAccess)\r\n      IModelHost._hubAccess = configuration.hubAccess;\r\n    IModelHost.configuration = configuration;\r\n    IModelHost.setupTileCache();\r\n\r\n    this.platform.setUseTileCache(IModelHost.tileCacheService ? false : true);\r\n\r\n    process.once(\"beforeExit\", IModelHost.shutdown);\r\n    IModelHost.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: IModelHostConfiguration) {\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.tileCacheService = undefined;\r\n    IModelHost.tileUploader = undefined;\r\n    IModelHost.appWorkspace.close();\r\n    IModelHost._appWorkspace = undefined;\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]($common) should wait before returning a \"pending\" status.\r\n   * @internal\r\n   */\r\n  public static get tileTreeRequestTimeout(): number {\r\n    return undefined !== IModelHost.configuration ? IModelHost.configuration.tileTreeRequestTimeout : IModelHostConfiguration.defaultTileRequestTimeout;\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  public static get tileContentRequestTimeout(): number {\r\n    return undefined !== IModelHost.configuration ? 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 undefined !== IModelHost.configuration ? 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 undefined !== IModelHost.configuration ? 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.tileCacheService;\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 service = config.tileCacheService;\r\n    const credentials = config.tileCacheAzureCredentials;\r\n\r\n    if (!service && !credentials)\r\n      return;\r\n\r\n    IModelHost.tileUploader = new CloudStorageTileUploader();\r\n\r\n    if (credentials && !service) {\r\n      IModelHost.tileCacheService = new AzureBlobStorage(credentials);\r\n    } else if (!credentials && service) {\r\n      IModelHost.tileCacheService = service;\r\n    } else {\r\n      throw new IModelError(BentleyStatus.ERROR, \"Cannot use both Azure and custom cloud storage providers for tile cache.\");\r\n    }\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"]}