@itwin/core-backend 3.3.0-dev.3 → 3.3.0-dev.30

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log - @itwin/core-backend
 
-This log was last generated on Fri, 15 Apr 2022 13:49:25 GMT and should not be manually modified.
+This log was last generated on Fri, 10 Jun 2022 16:11:36 GMT and should not be manually modified.
+
+## 3.2.2
+Fri, 10 Jun 2022 16:11:36 GMT
+
+_Version update only_
+
+## 3.2.1
+Tue, 07 Jun 2022 15:02:56 GMT
+
+_Version update only_
+
+## 3.2.0
+Fri, 20 May 2022 13:10:54 GMT
+
+### Updates
+
+- Added new additionalTransformPath property to GeodeticDatums and tests
+- changed name of GCS in test dataset
+- Create an ios test project to run webpacked core tests.
+- Added "getMassPropertiesPerCandidate" RPC operation to IModelReadRpcInterface which returns mass properties for each candidate separately.
+- Add two new rpcimpls, hydrateViewState and getCustomViewState3dData
+- add imodel import context state saving/loading functions for transformer
 
 ## 3.1.3
 Fri, 15 Apr 2022 13:49:25 GMT

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.  */