@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/CheckpointManager.d.ts

@@ -0,0 +1,101 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { BeEvent, GuidString } from "@itwin/core-bentley";
+import { ChangesetId, ChangesetIdWithIndex, LocalDirName, LocalFileName } from "@itwin/core-common";
+import { IModelJsNative } from "@bentley/imodeljs-native";
+import { SnapshotDb, TokenArg } from "./IModelDb";
+/**
+ * Properties of a checkpoint
+ * @public
+ */
+export interface CheckpointProps extends TokenArg {
+    readonly expectV2?: boolean;
+    /** iTwin that the iModel belongs to */
+    readonly iTwinId: GuidString;
+    /** Id of the iModel */
+    readonly iModelId: GuidString;
+    /** changeset for the checkpoint */
+    readonly changeset: ChangesetIdWithIndex;
+    /** The number of seconds before the current token expires to attempt to reacquire a new token. Default is 1 hour. */
+    readonly reattachSafetySeconds?: number;
+}
+/** Called to show progress during a download. If this function returns non-zero, the download is aborted.
+ *  @public
+ */
+export declare type ProgressFunction = (loaded: number, total: number) => number;
+/** The parameters that specify a request to download a checkpoint file from iModelHub.
+ * @internal
+ */
+export interface DownloadRequest {
+    /** name of local file to hold the downloaded data. */
+    localFile: LocalFileName;
+    /** A list of full fileName paths to test before downloading. If a valid file exists by one of these names,
+     * no download is performed and `localFile` is updated to reflect the fact that the file exists with that name.
+     * This can be used, for example, to look for checkpoints from previous versions if the naming strategy changes.
+     */
+    readonly aliasFiles?: ReadonlyArray<string>;
+    /** Properties of the checkpoint to be downloaded */
+    readonly checkpoint: CheckpointProps;
+    /** If present, this function will be called to indicate progress as the briefcase is downloaded. If this
+     * function returns a non-zero value, the download is aborted.
+     */
+    readonly onProgress?: ProgressFunction;
+}
+/** @internal */
+export interface DownloadJob {
+    request: DownloadRequest;
+    promise?: Promise<any>;
+}
+/** @internal */
+export declare class Downloads {
+    private static _active;
+    private static process;
+    static isInProgress(pathName: LocalFileName): DownloadJob | undefined;
+    static download<T>(request: DownloadRequest, downloadFn: (job: DownloadJob) => Promise<T>): Promise<any>;
+}
+/** Utility class for attaching to Daemon, opening V2 checkpoints, and downloading them.
+ * @internal
+*/
+export declare class V2CheckpointManager {
+    private static getCommandArgs;
+    static attach(checkpoint: CheckpointProps): Promise<{
+        filePath: LocalFileName;
+        expiryTimestamp: number;
+    }>;
+    private static performDownload;
+    /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.
+     * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will
+     * be the same as the requested changesetId or the most recent checkpoint before it.)
+     */
+    static downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId>;
+}
+/** Utility class to deal with downloading V1 checkpoints from iModelHub.
+ * @internal
+ */
+export declare class V1CheckpointManager {
+    static getFolder(iModelId: GuidString): LocalDirName;
+    static getFileName(checkpoint: CheckpointProps): LocalFileName;
+    static getCheckpointDb(request: DownloadRequest): Promise<SnapshotDb>;
+    /** Download a V1 checkpoint */
+    static downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId>;
+    private static downloadAndOpen;
+    private static performDownload;
+}
+/** @internal  */
+export declare class CheckpointManager {
+    static readonly onDownloadV1: BeEvent<(job: DownloadJob) => void>;
+    static readonly onDownloadV2: BeEvent<(job: DownloadJob) => void>;
+    static getKey(checkpoint: CheckpointProps): string;
+    private static doDownload;
+    static updateToRequestedVersion(request: DownloadRequest): Promise<void>;
+    /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */
+    static downloadCheckpoint(request: DownloadRequest): Promise<void>;
+    /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */
+    static validateCheckpointGuids(checkpoint: CheckpointProps, nativeDb: IModelJsNative.DgnDb): void;
+    /** @returns true if the file is the checkpoint requested */
+    static verifyCheckpoint(checkpoint: CheckpointProps, fileName: LocalFileName): boolean;
+    /** try to open an existing local file to satisfy a download request */
+    static tryOpenLocalFile(request: DownloadRequest): SnapshotDb | undefined;
+}
+//# sourceMappingURL=CheckpointManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CheckpointManager.d.ts","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,OAAO,EAAmC,UAAU,EAA2C,MAAM,qBAAqB,CAAC;AACpI,OAAO,EAAoB,WAAW,EAAE,oBAAoB,EAAmD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACvK,OAAO,EAAoC,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG5F,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAMlD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,qHAAqH;IACrH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,SAAS,EAAE,aAAa,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAE5C,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC;CACxC;AAED,gBAAgB;AAChB,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;CACxB;AAED,gBAAgB;AAChB,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC;mBAEnC,OAAO;WAUd,YAAY,CAAC,QAAQ,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS;WAIxD,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC;CAUvG;AAED;;EAEE;AACF,qBAAa,mBAAmB;mBACT,cAAc;WAYf,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,aAAa,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,CAAC;mBAmBjG,eAAe;IAKpC;;;OAGG;WACiB,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAGvF;AAED;;GAEG;AACH,qBAAa,mBAAmB;WAChB,SAAS,CAAC,QAAQ,EAAE,UAAU,GAAG,YAAY;WAI7C,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;WAKjD,eAAe,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAKlF,+BAA+B;WACX,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;mBAIjE,eAAe;mBASf,eAAe;CAIrC;AAED,iBAAiB;AACjB,qBAAa,iBAAiB;IAC5B,gBAAuB,YAAY,gBAAqB,WAAW,KAAK,IAAI,EAAI;IAChF,gBAAuB,YAAY,gBAAqB,WAAW,KAAK,IAAI,EAAI;WAClE,MAAM,CAAC,UAAU,EAAE,eAAe;mBAE3B,UAAU;WAcX,wBAAwB,CAAC,OAAO,EAAE,eAAe;IAgDrE,uGAAuG;WACnF,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB/E,6FAA6F;WAC/E,uBAAuB,CAAC,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,CAAC,KAAK;IAsBjG,4DAA4D;WAC9C,gBAAgB,CAAC,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO;IAmB7F,uEAAuE;WACzD,gBAAgB,CAAC,OAAO,EAAE,eAAe,GAAG,UAAU,GAAG,SAAS;CAgBjF"}

package/lib/cjs/CheckpointManager.js

@@ -0,0 +1,257 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckpointManager = exports.V1CheckpointManager = exports.V2CheckpointManager = exports.Downloads = void 0;
+// cspell:ignore BLOCKCACHE
+const path = require("path");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const imodeljs_native_1 = require("@bentley/imodeljs-native");
+const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
+const BriefcaseManager_1 = require("./BriefcaseManager");
+const IModelDb_1 = require("./IModelDb");
+const IModelHost_1 = require("./IModelHost");
+const IModelJsFs_1 = require("./IModelJsFs");
+const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelDb;
+/** @internal */
+class Downloads {
+    static async process(job, fn) {
+        const jobName = job.request.localFile; // save this, it can change inside call to `fn`!
+        this._active.set(jobName, job);
+        try {
+            return await fn(job);
+        }
+        finally {
+            this._active.delete(jobName);
+        }
+    }
+    static isInProgress(pathName) {
+        return this._active.get(pathName);
+    }
+    static async download(request, downloadFn) {
+        const pathName = request.localFile;
+        let job = this.isInProgress(pathName);
+        if (undefined !== job)
+            return job.promise;
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync(path.dirname(pathName));
+        job = { request };
+        return job.promise = this.process(job, downloadFn);
+    }
+}
+exports.Downloads = Downloads;
+Downloads._active = new Map();
+/** Utility class for attaching to Daemon, opening V2 checkpoints, and downloading them.
+ * @internal
+*/
+class V2CheckpointManager {
+    static async getCommandArgs(checkpoint) {
+        try {
+            const v2props = await IModelHost_1.IModelHost.hubAccess.queryV2Checkpoint(checkpoint);
+            if (!v2props)
+                throw new Error("no checkpoint");
+            return { ...v2props, daemonDir: process.env.BLOCKCACHE_DIR, writeable: false };
+        }
+        catch (err) {
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `V2 checkpoint not found: err: ${err.message}`);
+        }
+    }
+    static async attach(checkpoint) {
+        const args = await this.getCommandArgs(checkpoint);
+        if (undefined === args.daemonDir || args.daemonDir === "")
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "Invalid config: BLOCKCACHE_DIR is not set");
+        // We can assume that a BCVDaemon process is already started if BLOCKCACHE_DIR was set, so we need to just tell the daemon to attach to the Storage Container
+        const attachResult = await imodeljs_native_1.BlobDaemon.command("attach", args);
+        if (attachResult.result !== core_bentley_1.DbResult.BE_SQLITE_OK) {
+            const error = `Daemon attach failed: ${attachResult.errMsg}`;
+            if (checkpoint.expectV2)
+                core_bentley_1.Logger.logError(loggerCategory, error);
+            throw new core_common_1.IModelError(attachResult.result, error);
+        }
+        const sasTokenExpiry = new URLSearchParams(args.auth).get("se");
+        return { filePath: imodeljs_native_1.BlobDaemon.getDbFileName(args), expiryTimestamp: sasTokenExpiry ? Date.parse(sasTokenExpiry) : 0 };
+    }
+    static async performDownload(job) {
+        CheckpointManager.onDownloadV2.raiseEvent(job);
+        return IModelHost_1.IModelHost.hubAccess.downloadV2Checkpoint(job.request);
+    }
+    /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.
+     * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will
+     * be the same as the requested changesetId or the most recent checkpoint before it.)
+     */
+    static async downloadCheckpoint(request) {
+        return Downloads.download(request, async (job) => this.performDownload(job));
+    }
+}
+exports.V2CheckpointManager = V2CheckpointManager;
+/** Utility class to deal with downloading V1 checkpoints from iModelHub.
+ * @internal
+ */
+class V1CheckpointManager {
+    static getFolder(iModelId) {
+        return path.join(BriefcaseManager_1.BriefcaseManager.getIModelPath(iModelId), "checkpoints");
+    }
+    static getFileName(checkpoint) {
+        const changesetId = checkpoint.changeset.id || "first";
+        return path.join(this.getFolder(checkpoint.iModelId), `${changesetId}.bim`);
+    }
+    static async getCheckpointDb(request) {
+        const db = IModelDb_1.SnapshotDb.tryFindByKey(CheckpointManager.getKey(request.checkpoint));
+        return (undefined !== db) ? db : Downloads.download(request, async (job) => this.downloadAndOpen(job));
+    }
+    /** Download a V1 checkpoint */
+    static async downloadCheckpoint(request) {
+        return Downloads.download(request, async (job) => this.performDownload(job));
+    }
+    static async downloadAndOpen(job) {
+        const db = CheckpointManager.tryOpenLocalFile(job.request);
+        if (db)
+            return db;
+        await this.performDownload(job);
+        await CheckpointManager.updateToRequestedVersion(job.request);
+        return IModelDb_1.SnapshotDb.openCheckpointV1(job.request.localFile, job.request.checkpoint);
+    }
+    static async performDownload(job) {
+        CheckpointManager.onDownloadV1.raiseEvent(job);
+        return IModelHost_1.IModelHost.hubAccess.downloadV1Checkpoint(job.request);
+    }
+}
+exports.V1CheckpointManager = V1CheckpointManager;
+/** @internal  */
+class CheckpointManager {
+    static getKey(checkpoint) { return `${checkpoint.iModelId}:${checkpoint.changeset.id}`; }
+    static async doDownload(request) {
+        try {
+            // first see if there's a V2 checkpoint available.
+            const changesetId = await V2CheckpointManager.downloadCheckpoint(request);
+            core_bentley_1.Logger.logInfo(loggerCategory, `Downloaded v2 checkpoint: IModel=${request.checkpoint.iModelId}, changeset=${request.checkpoint.changeset.id}`);
+            return changesetId;
+        }
+        catch (error) {
+            if (error instanceof core_common_1.IModelError && error.errorNumber === core_bentley_1.IModelStatus.NotFound) // No V2 checkpoint available, try a v1 checkpoint
+                return V1CheckpointManager.downloadCheckpoint(request);
+            throw (error); // most likely, was aborted
+        }
+    }
+    static async updateToRequestedVersion(request) {
+        var _a;
+        const checkpoint = request.checkpoint;
+        const targetFile = request.localFile;
+        const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId, changeset: checkpoint.changeset };
+        try {
+            // Open checkpoint for write
+            const db = IModelDb_1.SnapshotDb.openForApplyChangesets(targetFile);
+            const nativeDb = db.nativeDb;
+            try {
+                if (nativeDb.hasPendingTxns()) {
+                    core_bentley_1.Logger.logWarning(loggerCategory, "Checkpoint with Txns found - deleting them", () => traceInfo);
+                    nativeDb.deleteAllTxns();
+                }
+                if (nativeDb.getBriefcaseId() !== core_common_1.BriefcaseIdValue.Unassigned)
+                    nativeDb.resetBriefcaseId(core_common_1.BriefcaseIdValue.Unassigned);
+                CheckpointManager.validateCheckpointGuids(checkpoint, nativeDb);
+                // Apply change sets if necessary
+                const currentChangeset = nativeDb.getCurrentChangeset();
+                if (currentChangeset.id !== checkpoint.changeset.id) {
+                    const accessToken = checkpoint.accessToken;
+                    const toIndex = (_a = checkpoint.changeset.index) !== null && _a !== void 0 ? _a : (await IModelHost_1.IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId: checkpoint.iModelId, version: core_common_1.IModelVersion.asOfChangeSet(checkpoint.changeset.id) })).index;
+                    await BriefcaseManager_1.BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });
+                }
+                else {
+                    // make sure the parent changeset index is saved in the file - old versions didn't have it.
+                    currentChangeset.index = checkpoint.changeset.index;
+                    nativeDb.saveLocalValue("parentChangeSet", JSON.stringify(currentChangeset));
+                }
+            }
+            finally {
+                db.saveChanges();
+                db.close();
+            }
+        }
+        catch (error) {
+            core_bentley_1.Logger.logError(loggerCategory, "Error downloading checkpoint - deleting it", () => traceInfo);
+            IModelJsFs_1.IModelJsFs.removeSync(targetFile);
+            if (error.errorNumber === core_bentley_1.ChangeSetStatus.CorruptedChangeStream || error.errorNumber === core_bentley_1.ChangeSetStatus.InvalidId || error.errorNumber === core_bentley_1.ChangeSetStatus.InvalidVersion) {
+                core_bentley_1.Logger.logError(loggerCategory, "Detected potential corruption of change sets. Deleting them to enable retries", () => traceInfo);
+                BriefcaseManager_1.BriefcaseManager.deleteChangeSetsFromLocalDisk(checkpoint.iModelId);
+            }
+            throw error;
+        }
+    }
+    /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */
+    static async downloadCheckpoint(request) {
+        if (this.verifyCheckpoint(request.checkpoint, request.localFile))
+            return;
+        if (request.aliasFiles) {
+            for (const alias of request.aliasFiles) {
+                if (this.verifyCheckpoint(request.checkpoint, alias)) {
+                    request.localFile = alias;
+                    return;
+                }
+            }
+        }
+        await this.doDownload(request);
+        return this.updateToRequestedVersion(request);
+    }
+    /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */
+    static validateCheckpointGuids(checkpoint, nativeDb) {
+        const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId };
+        const dbChangeset = nativeDb.getCurrentChangeset();
+        const iModelId = core_bentley_1.Guid.normalize(nativeDb.getIModelId());
+        if (iModelId !== core_bentley_1.Guid.normalize(checkpoint.iModelId)) {
+            if (nativeDb.isReadonly())
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.ValidationFailed, "iModelId is not properly set up in the checkpoint");
+            core_bentley_1.Logger.logWarning(loggerCategory, "iModelId is not properly set up in the checkpoint. Updated checkpoint to the correct iModelId.", () => ({ ...traceInfo, dbGuid: iModelId }));
+            nativeDb.setIModelId(core_bentley_1.Guid.normalize(checkpoint.iModelId));
+            // Required to reset the ChangeSetId because setDbGuid clears the value.
+            nativeDb.saveLocalValue("ParentChangeSetId", dbChangeset.id);
+            if (undefined !== dbChangeset.index)
+                nativeDb.saveLocalValue("parentChangeSet", JSON.stringify(dbChangeset));
+        }
+        const iTwinId = core_bentley_1.Guid.normalize(nativeDb.getITwinId());
+        if (iTwinId !== core_bentley_1.Guid.normalize(checkpoint.iTwinId))
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.ValidationFailed, "iTwinId was not properly set up in the checkpoint");
+    }
+    /** @returns true if the file is the checkpoint requested */
+    static verifyCheckpoint(checkpoint, fileName) {
+        if (!IModelJsFs_1.IModelJsFs.existsSync(fileName))
+            return false;
+        const nativeDb = new IModelHost_1.IModelHost.platform.DgnDb();
+        try {
+            nativeDb.openIModel(fileName, core_bentley_1.OpenMode.Readonly);
+        }
+        catch (error) {
+            return false;
+        }
+        const isValid = checkpoint.iModelId === nativeDb.getIModelId() && checkpoint.changeset.id === nativeDb.getCurrentChangeset().id;
+        nativeDb.closeIModel();
+        if (!isValid)
+            IModelJsFs_1.IModelJsFs.removeSync(fileName);
+        return isValid;
+    }
+    /** try to open an existing local file to satisfy a download request */
+    static tryOpenLocalFile(request) {
+        const checkpoint = request.checkpoint;
+        if (this.verifyCheckpoint(checkpoint, request.localFile))
+            return IModelDb_1.SnapshotDb.openCheckpointV1(request.localFile, checkpoint);
+        // check a list of aliases for finding checkpoints downloaded to non-default locations (e.g. from older versions)
+        if (request.aliasFiles) {
+            for (const alias of request.aliasFiles) {
+                if (this.verifyCheckpoint(checkpoint, alias)) {
+                    request.localFile = alias;
+                    return IModelDb_1.SnapshotDb.openCheckpointV1(alias, checkpoint);
+                }
+            }
+        }
+        return undefined;
+    }
+}
+exports.CheckpointManager = CheckpointManager;
+CheckpointManager.onDownloadV1 = new core_bentley_1.BeEvent();
+CheckpointManager.onDownloadV2 = new core_bentley_1.BeEvent();
+//# sourceMappingURL=CheckpointManager.js.map

package/lib/cjs/CheckpointManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheckpointManager.js","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,2BAA2B;AAE3B,6BAA6B;AAC7B,sDAAoI;AACpI,oDAAuK;AACvK,8DAA4F;AAC5F,mEAAgE;AAChE,yDAAsD;AACtD,yCAAkD;AAClD,6CAA0C;AAC1C,6CAA0C;AAE1C,MAAM,cAAc,GAAG,6CAAqB,CAAC,QAAQ,CAAC;AAuDtD,gBAAgB;AAChB,MAAa,SAAS;IAGZ,MAAM,CAAC,KAAK,CAAC,OAAO,CAAI,GAAgB,EAAE,EAAoC;QACpF,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,gDAAgD;QACvF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC/B,IAAI;YACF,OAAO,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;SACtB;gBAAS;YACR,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SAC9B;IACH,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAuB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAI,OAAwB,EAAE,UAA4C;QACpG,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,SAAS,KAAK,GAAG;YACnB,OAAO,GAAG,CAAC,OAAO,CAAC;QAErB,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtD,GAAG,GAAG,EAAE,OAAO,EAAE,CAAC;QAClB,OAAO,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;;AA1BH,8BA2BC;AA1BgB,iBAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;AA4B1D;;EAEE;AACF,MAAa,mBAAmB;IACtB,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,UAA2B;QAC7D,IAAI;YACF,MAAM,OAAO,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACzE,IAAI,CAAC,OAAO;gBACV,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;YAEnC,OAAO,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;SAChF;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,iCAAiC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;SAC9F;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAA2B;QACpD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,EAAE;YACvD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,2CAA2C,CAAC,CAAC;QAE9F,6JAA6J;QAC7J,MAAM,YAAY,GAAG,MAAM,4BAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,YAAY,CAAC,MAAM,KAAK,uBAAQ,CAAC,YAAY,EAAE;YACjD,MAAM,KAAK,GAAG,yBAAyB,YAAY,CAAC,MAAM,EAAE,CAAC;YAC7D,IAAI,UAAU,CAAC,QAAQ;gBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAEzC,MAAM,IAAI,yBAAW,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,MAAM,cAAc,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEhE,OAAO,EAAE,QAAQ,EAAE,4BAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,iBAAiB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,OAAO,uBAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB;QAC7D,OAAO,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,GAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;CACF;AA5CD,kDA4CC;AAED;;GAEG;AACH,MAAa,mBAAmB;IACvB,MAAM,CAAC,SAAS,CAAC,QAAoB;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,mCAAgB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAA2B;QACnD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,OAAO,CAAC;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,GAAG,WAAW,MAAM,CAAC,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAwB;QAC1D,MAAM,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QACjF,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,GAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IACtH,CAAC;IAED,+BAA+B;IACxB,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB;QAC7D,OAAO,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,GAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,MAAM,EAAE,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,EAAE;YACJ,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9D,OAAO,qBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,iBAAiB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,OAAO,uBAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAjCD,kDAiCC;AAED,iBAAiB;AACjB,MAAa,iBAAiB;IAGrB,MAAM,CAAC,MAAM,CAAC,UAA2B,IAAI,OAAO,GAAG,UAAU,CAAC,QAAQ,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAEzG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAwB;QACtD,IAAI;YACF,kDAAkD;YAClD,MAAM,WAAW,GAAG,MAAM,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC1E,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oCAAoC,OAAO,CAAC,UAAU,CAAC,QAAQ,eAAe,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;YAChJ,OAAO,WAAW,CAAC;SACpB;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,yBAAW,IAAI,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,EAAE,kDAAkD;gBACjI,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEzD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,2BAA2B;SAC3C;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,OAAwB;;QACnE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,CAAC;QAClH,IAAI;YACF,4BAA4B;YAC5B,MAAM,EAAE,GAAG,qBAAU,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;YACzD,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAC;YAE7B,IAAI;gBACF,IAAI,QAAQ,CAAC,cAAc,EAAE,EAAE;oBAC7B,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,4CAA4C,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;oBACjG,QAAQ,CAAC,aAAa,EAAE,CAAC;iBAC1B;gBAED,IAAI,QAAQ,CAAC,cAAc,EAAE,KAAK,8BAAgB,CAAC,UAAU;oBAC3D,QAAQ,CAAC,gBAAgB,CAAC,8BAAgB,CAAC,UAAU,CAAC,CAAC;gBAEzD,iBAAiB,CAAC,uBAAuB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBAChE,iCAAiC;gBACjC,MAAM,gBAAgB,GAAiC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;gBACtF,IAAI,gBAAgB,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE;oBACnD,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;oBAC3C,MAAM,OAAO,GAAG,MAAA,UAAU,CAAC,SAAS,CAAC,KAAK,mCACxC,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;oBAC5K,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;iBAC7E;qBAAM;oBACL,2FAA2F;oBAC3F,gBAAgB,CAAC,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,KAAM,CAAC;oBACrD,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC;iBAC9E;aACF;oBAAS;gBACR,EAAE,CAAC,WAAW,EAAE,CAAC;gBACjB,EAAE,CAAC,KAAK,EAAE,CAAC;aACZ;SACF;QAAC,OAAO,KAAU,EAAE;YAEnB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4CAA4C,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/F,uBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAElC,IAAI,KAAK,CAAC,WAAW,KAAK,8BAAe,CAAC,qBAAqB,IAAI,KAAK,CAAC,WAAW,KAAK,8BAAe,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,KAAK,8BAAe,CAAC,cAAc,EAAE;gBAC1K,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,+EAA+E,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBAClI,mCAAgB,CAAC,6BAA6B,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aACrE;YACD,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED,uGAAuG;IAChG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB;QAC7D,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC;YAC9D,OAAO;QAET,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE;gBACtC,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE;oBACpD,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC;oBAC1B,OAAO;iBACR;aACF;SACF;QAED,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,6FAA6F;IACtF,MAAM,CAAC,uBAAuB,CAAC,UAA2B,EAAE,QAA8B;QAC/F,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;QAEjF,MAAM,WAAW,GAAG,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAG,mBAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;QACxD,IAAI,QAAQ,KAAK,mBAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACpD,IAAI,QAAQ,CAAC,UAAU,EAAE;gBACvB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;YAE5G,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,gGAAgG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;YAChL,QAAQ,CAAC,WAAW,CAAC,mBAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC1D,wEAAwE;YACxE,QAAQ,CAAC,cAAc,CAAC,mBAAmB,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,WAAW,CAAC,KAAK;gBACjC,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;SAC3E;QAED,MAAM,OAAO,GAAG,mBAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACtD,IAAI,OAAO,KAAK,mBAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;IAC9G,CAAC;IAED,4DAA4D;IACrD,MAAM,CAAC,gBAAgB,CAAC,UAA2B,EAAE,QAAuB;QACjF,IAAI,CAAC,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YAClC,OAAO,KAAK,CAAC;QAEf,MAAM,QAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjD,IAAI;YACF,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,uBAAQ,CAAC,QAAQ,CAAC,CAAC;SAClD;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,KAAK,CAAC;SACd;QAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,KAAK,QAAQ,CAAC,WAAW,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,KAAK,QAAQ,CAAC,mBAAmB,EAAE,CAAC,EAAE,CAAC;QAChI,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO;YACV,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,gBAAgB,CAAC,OAAwB;QACrD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC;YACtD,OAAO,qBAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAEpE,iHAAiH;QACjH,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE;gBACtC,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE;oBAC5C,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC;oBAC1B,OAAO,qBAAU,CAAC,gBAAgB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;iBACvD;aACF;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;;AAhJH,8CAiJC;AAhJwB,8BAAY,GAAG,IAAI,sBAAO,EAA8B,CAAC;AACzD,8BAAY,GAAG,IAAI,sBAAO,EAA8B,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/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\n// cspell:ignore BLOCKCACHE\r\n\r\nimport * as path from \"path\";\r\nimport { BeEvent, ChangeSetStatus, DbResult, Guid, GuidString, IModelStatus, Logger, Mutable, OpenMode } from \"@itwin/core-bentley\";\r\nimport { BriefcaseIdValue, ChangesetId, ChangesetIdWithIndex, ChangesetIndexAndId, IModelError, IModelVersion, LocalDirName, LocalFileName } from \"@itwin/core-common\";\r\nimport { BlobDaemon, BlobDaemonCommandArg, IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { BriefcaseManager } from \"./BriefcaseManager\";\r\nimport { SnapshotDb, TokenArg } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\n\r\nconst loggerCategory = BackendLoggerCategory.IModelDb;\r\n\r\n/**\r\n * Properties of a checkpoint\r\n * @public\r\n */\r\nexport interface CheckpointProps extends TokenArg {\r\n  readonly expectV2?: boolean;\r\n\r\n  /** iTwin that the iModel belongs to */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** Id of the iModel */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** changeset for the checkpoint */\r\n  readonly changeset: ChangesetIdWithIndex;\r\n\r\n  /** The number of seconds before the current token expires to attempt to reacquire a new token. Default is 1 hour. */\r\n  readonly reattachSafetySeconds?: number;\r\n}\r\n\r\n/** Called to show progress during a download. If this function returns non-zero, the download is aborted.\r\n *  @public\r\n */\r\nexport type ProgressFunction = (loaded: number, total: number) => number;\r\n\r\n/** The parameters that specify a request to download a checkpoint file from iModelHub.\r\n * @internal\r\n */\r\nexport interface DownloadRequest {\r\n  /** name of local file to hold the downloaded data. */\r\n  localFile: LocalFileName;\r\n\r\n  /** A list of full fileName paths to test before downloading. If a valid file exists by one of these names,\r\n   * no download is performed and `localFile` is updated to reflect the fact that the file exists with that name.\r\n   * This can be used, for example, to look for checkpoints from previous versions if the naming strategy changes.\r\n   */\r\n  readonly aliasFiles?: ReadonlyArray<string>;\r\n\r\n  /** Properties of the checkpoint to be downloaded */\r\n  readonly checkpoint: CheckpointProps;\r\n\r\n  /** If present, this function will be called to indicate progress as the briefcase is downloaded. If this\r\n   * function returns a non-zero value, the download is aborted.\r\n   */\r\n  readonly onProgress?: ProgressFunction;\r\n}\r\n\r\n/** @internal */\r\nexport interface DownloadJob {\r\n  request: DownloadRequest;\r\n  promise?: Promise<any>;\r\n}\r\n\r\n/** @internal */\r\nexport class Downloads {\r\n  private static _active = new Map<string, DownloadJob>();\r\n\r\n  private static async process<T>(job: DownloadJob, fn: (job: DownloadJob) => Promise<T>) {\r\n    const jobName = job.request.localFile; // save this, it can change inside call to `fn`!\r\n    this._active.set(jobName, job);\r\n    try {\r\n      return await fn(job);\r\n    } finally {\r\n      this._active.delete(jobName);\r\n    }\r\n  }\r\n\r\n  public static isInProgress(pathName: LocalFileName): DownloadJob | undefined {\r\n    return this._active.get(pathName);\r\n  }\r\n\r\n  public static async download<T>(request: DownloadRequest, downloadFn: (job: DownloadJob) => Promise<T>) {\r\n    const pathName = request.localFile;\r\n    let job = this.isInProgress(pathName);\r\n    if (undefined !== job)\r\n      return job.promise;\r\n\r\n    IModelJsFs.recursiveMkDirSync(path.dirname(pathName));\r\n    job = { request };\r\n    return job.promise = this.process(job, downloadFn);\r\n  }\r\n}\r\n\r\n/** Utility class for attaching to Daemon, opening V2 checkpoints, and downloading them.\r\n * @internal\r\n*/\r\nexport class V2CheckpointManager {\r\n  private static async getCommandArgs(checkpoint: CheckpointProps): Promise<BlobDaemonCommandArg> {\r\n    try {\r\n      const v2props = await IModelHost.hubAccess.queryV2Checkpoint(checkpoint);\r\n      if (!v2props)\r\n        throw new Error(\"no checkpoint\");\r\n\r\n      return { ...v2props, daemonDir: process.env.BLOCKCACHE_DIR, writeable: false };\r\n    } catch (err: any) {\r\n      throw new IModelError(IModelStatus.NotFound, `V2 checkpoint not found: err: ${err.message}`);\r\n    }\r\n  }\r\n\r\n  public static async attach(checkpoint: CheckpointProps): Promise<{ filePath: LocalFileName, expiryTimestamp: number }> {\r\n    const args = await this.getCommandArgs(checkpoint);\r\n    if (undefined === args.daemonDir || args.daemonDir === \"\")\r\n      throw new IModelError(IModelStatus.BadRequest, \"Invalid config: BLOCKCACHE_DIR is not set\");\r\n\r\n    // We can assume that a BCVDaemon process is already started if BLOCKCACHE_DIR was set, so we need to just tell the daemon to attach to the Storage Container\r\n    const attachResult = await BlobDaemon.command(\"attach\", args);\r\n    if (attachResult.result !== DbResult.BE_SQLITE_OK) {\r\n      const error = `Daemon attach failed: ${attachResult.errMsg}`;\r\n      if (checkpoint.expectV2)\r\n        Logger.logError(loggerCategory, error);\r\n\r\n      throw new IModelError(attachResult.result, error);\r\n    }\r\n    const sasTokenExpiry = new URLSearchParams(args.auth).get(\"se\");\r\n\r\n    return { filePath: BlobDaemon.getDbFileName(args), expiryTimestamp: sasTokenExpiry ? Date.parse(sasTokenExpiry) : 0 };\r\n  }\r\n\r\n  private static async performDownload(job: DownloadJob): Promise<ChangesetId> {\r\n    CheckpointManager.onDownloadV2.raiseEvent(job);\r\n    return IModelHost.hubAccess.downloadV2Checkpoint(job.request);\r\n  }\r\n\r\n  /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.\r\n   * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will\r\n   * be the same as the requested changesetId or the most recent checkpoint before it.)\r\n   */\r\n  public static async downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId> {\r\n    return Downloads.download(request, async (job: DownloadJob) => this.performDownload(job));\r\n  }\r\n}\r\n\r\n/** Utility class to deal with downloading V1 checkpoints from iModelHub.\r\n * @internal\r\n */\r\nexport class V1CheckpointManager {\r\n  public static getFolder(iModelId: GuidString): LocalDirName {\r\n    return path.join(BriefcaseManager.getIModelPath(iModelId), \"checkpoints\");\r\n  }\r\n\r\n  public static getFileName(checkpoint: CheckpointProps): LocalFileName {\r\n    const changesetId = checkpoint.changeset.id || \"first\";\r\n    return path.join(this.getFolder(checkpoint.iModelId), `${changesetId}.bim`);\r\n  }\r\n\r\n  public static async getCheckpointDb(request: DownloadRequest): Promise<SnapshotDb> {\r\n    const db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(request.checkpoint));\r\n    return (undefined !== db) ? db : Downloads.download(request, async (job: DownloadJob) => this.downloadAndOpen(job));\r\n  }\r\n\r\n  /** Download a V1 checkpoint */\r\n  public static async downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId> {\r\n    return Downloads.download(request, async (job: DownloadJob) => this.performDownload(job));\r\n  }\r\n\r\n  private static async downloadAndOpen(job: DownloadJob) {\r\n    const db = CheckpointManager.tryOpenLocalFile(job.request);\r\n    if (db)\r\n      return db;\r\n    await this.performDownload(job);\r\n    await CheckpointManager.updateToRequestedVersion(job.request);\r\n    return SnapshotDb.openCheckpointV1(job.request.localFile, job.request.checkpoint);\r\n  }\r\n\r\n  private static async performDownload(job: DownloadJob): Promise<ChangesetId> {\r\n    CheckpointManager.onDownloadV1.raiseEvent(job);\r\n    return IModelHost.hubAccess.downloadV1Checkpoint(job.request);\r\n  }\r\n}\r\n\r\n/** @internal  */\r\nexport class CheckpointManager {\r\n  public static readonly onDownloadV1 = new BeEvent<(job: DownloadJob) => void>();\r\n  public static readonly onDownloadV2 = new BeEvent<(job: DownloadJob) => void>();\r\n  public static getKey(checkpoint: CheckpointProps) { return `${checkpoint.iModelId}:${checkpoint.changeset.id}`; }\r\n\r\n  private static async doDownload(request: DownloadRequest): Promise<ChangesetId> {\r\n    try {\r\n      // first see if there's a V2 checkpoint available.\r\n      const changesetId = await V2CheckpointManager.downloadCheckpoint(request);\r\n      Logger.logInfo(loggerCategory, `Downloaded v2 checkpoint: IModel=${request.checkpoint.iModelId}, changeset=${request.checkpoint.changeset.id}`);\r\n      return changesetId;\r\n    } catch (error) {\r\n      if (error instanceof IModelError && error.errorNumber === IModelStatus.NotFound) // No V2 checkpoint available, try a v1 checkpoint\r\n        return V1CheckpointManager.downloadCheckpoint(request);\r\n\r\n      throw (error); // most likely, was aborted\r\n    }\r\n  }\r\n\r\n  public static async updateToRequestedVersion(request: DownloadRequest) {\r\n    const checkpoint = request.checkpoint;\r\n    const targetFile = request.localFile;\r\n    const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId, changeset: checkpoint.changeset };\r\n    try {\r\n      // Open checkpoint for write\r\n      const db = SnapshotDb.openForApplyChangesets(targetFile);\r\n      const nativeDb = db.nativeDb;\r\n\r\n      try {\r\n        if (nativeDb.hasPendingTxns()) {\r\n          Logger.logWarning(loggerCategory, \"Checkpoint with Txns found - deleting them\", () => traceInfo);\r\n          nativeDb.deleteAllTxns();\r\n        }\r\n\r\n        if (nativeDb.getBriefcaseId() !== BriefcaseIdValue.Unassigned)\r\n          nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned);\r\n\r\n        CheckpointManager.validateCheckpointGuids(checkpoint, nativeDb);\r\n        // Apply change sets if necessary\r\n        const currentChangeset: Mutable<ChangesetIndexAndId> = nativeDb.getCurrentChangeset();\r\n        if (currentChangeset.id !== checkpoint.changeset.id) {\r\n          const accessToken = checkpoint.accessToken;\r\n          const toIndex = checkpoint.changeset.index ??\r\n            (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId: checkpoint.iModelId, version: IModelVersion.asOfChangeSet(checkpoint.changeset.id) })).index;\r\n          await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\r\n        } else {\r\n          // make sure the parent changeset index is saved in the file - old versions didn't have it.\r\n          currentChangeset.index = checkpoint.changeset.index!;\r\n          nativeDb.saveLocalValue(\"parentChangeSet\", JSON.stringify(currentChangeset));\r\n        }\r\n      } finally {\r\n        db.saveChanges();\r\n        db.close();\r\n      }\r\n    } catch (error: any) {\r\n\r\n      Logger.logError(loggerCategory, \"Error downloading checkpoint - deleting it\", () => traceInfo);\r\n      IModelJsFs.removeSync(targetFile);\r\n\r\n      if (error.errorNumber === ChangeSetStatus.CorruptedChangeStream || error.errorNumber === ChangeSetStatus.InvalidId || error.errorNumber === ChangeSetStatus.InvalidVersion) {\r\n        Logger.logError(loggerCategory, \"Detected potential corruption of change sets. Deleting them to enable retries\", () => traceInfo);\r\n        BriefcaseManager.deleteChangeSetsFromLocalDisk(checkpoint.iModelId);\r\n      }\r\n      throw error;\r\n    }\r\n  }\r\n\r\n  /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */\r\n  public static async downloadCheckpoint(request: DownloadRequest): Promise<void> {\r\n    if (this.verifyCheckpoint(request.checkpoint, request.localFile))\r\n      return;\r\n\r\n    if (request.aliasFiles) {\r\n      for (const alias of request.aliasFiles) {\r\n        if (this.verifyCheckpoint(request.checkpoint, alias)) {\r\n          request.localFile = alias;\r\n          return;\r\n        }\r\n      }\r\n    }\r\n\r\n    await this.doDownload(request);\r\n    return this.updateToRequestedVersion(request);\r\n  }\r\n\r\n  /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */\r\n  public static validateCheckpointGuids(checkpoint: CheckpointProps, nativeDb: IModelJsNative.DgnDb) {\r\n    const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId };\r\n\r\n    const dbChangeset = nativeDb.getCurrentChangeset();\r\n    const iModelId = Guid.normalize(nativeDb.getIModelId());\r\n    if (iModelId !== Guid.normalize(checkpoint.iModelId)) {\r\n      if (nativeDb.isReadonly())\r\n        throw new IModelError(IModelStatus.ValidationFailed, \"iModelId is not properly set up in the checkpoint\");\r\n\r\n      Logger.logWarning(loggerCategory, \"iModelId is not properly set up in the checkpoint. Updated checkpoint to the correct iModelId.\", () => ({ ...traceInfo, dbGuid: iModelId }));\r\n      nativeDb.setIModelId(Guid.normalize(checkpoint.iModelId));\r\n      // Required to reset the ChangeSetId because setDbGuid clears the value.\r\n      nativeDb.saveLocalValue(\"ParentChangeSetId\", dbChangeset.id);\r\n      if (undefined !== dbChangeset.index)\r\n        nativeDb.saveLocalValue(\"parentChangeSet\", JSON.stringify(dbChangeset));\r\n    }\r\n\r\n    const iTwinId = Guid.normalize(nativeDb.getITwinId());\r\n    if (iTwinId !== Guid.normalize(checkpoint.iTwinId))\r\n      throw new IModelError(IModelStatus.ValidationFailed, \"iTwinId was not properly set up in the checkpoint\");\r\n  }\r\n\r\n  /** @returns true if the file is the checkpoint requested */\r\n  public static verifyCheckpoint(checkpoint: CheckpointProps, fileName: LocalFileName): boolean {\r\n    if (!IModelJsFs.existsSync(fileName))\r\n      return false;\r\n\r\n    const nativeDb = new IModelHost.platform.DgnDb();\r\n    try {\r\n      nativeDb.openIModel(fileName, OpenMode.Readonly);\r\n    } catch (error) {\r\n      return false;\r\n    }\r\n\r\n    const isValid = checkpoint.iModelId === nativeDb.getIModelId() && checkpoint.changeset.id === nativeDb.getCurrentChangeset().id;\r\n    nativeDb.closeIModel();\r\n    if (!isValid)\r\n      IModelJsFs.removeSync(fileName);\r\n\r\n    return isValid;\r\n  }\r\n\r\n  /** try to open an existing local file to satisfy a download request */\r\n  public static tryOpenLocalFile(request: DownloadRequest): SnapshotDb | undefined {\r\n    const checkpoint = request.checkpoint;\r\n    if (this.verifyCheckpoint(checkpoint, request.localFile))\r\n      return SnapshotDb.openCheckpointV1(request.localFile, checkpoint);\r\n\r\n    // check a list of aliases for finding checkpoints downloaded to non-default locations (e.g. from older versions)\r\n    if (request.aliasFiles) {\r\n      for (const alias of request.aliasFiles) {\r\n        if (this.verifyCheckpoint(checkpoint, alias)) {\r\n          request.localFile = alias;\r\n          return SnapshotDb.openCheckpointV1(alias, checkpoint);\r\n        }\r\n      }\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n"]}

package/lib/cjs/ClassRegistry.d.ts

@@ -0,0 +1,72 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { EntityMetaData, IModelError } from "@itwin/core-common";
+import { Entity } from "./Entity";
+import { IModelDb } from "./IModelDb";
+import { Schema } from "./Schema";
+/** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
+ * @public
+ */
+export declare class ClassRegistry {
+    private static readonly _classMap;
+    /** @internal */
+    static isNotFoundError(err: any): boolean;
+    /** @internal */
+    static makeMetaDataNotFoundError(className: string): IModelError;
+    /** @internal */
+    static register(entityClass: typeof Entity, schema: typeof Schema): void;
+    /** Generate a proxy Schema for a domain that has not been registered. */
+    private static generateProxySchema;
+    /** Generate a JavaScript class from Entity metadata.
+     * @param entityMetaData The Entity metadata that defines the class
+     */
+    private static generateClassForEntity;
+    /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]
+     * @param moduleObj The module to search for subclasses of Entity
+     * @param schema The schema for all found classes
+     */
+    static registerModule(moduleObj: any, schema: typeof Schema): void;
+    /**
+     * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
+     * class. This function also ensures that all of the base classes of the Entity exist and are registered.
+     */
+    private static generateClass;
+    /** Find a registered class by classFullName.
+     * @param classFullName class to find
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class or undefined
+     */
+    static findRegisteredClass(classFullName: string): typeof Entity | undefined;
+    /** Get the Entity class for the specified Entity className.
+     * @param classFullName The full BIS class name of the Entity
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class
+     */
+    static getClass(classFullName: string, iModel: IModelDb): typeof Entity;
+    /** Unregister a class, by name, if one is already registered.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
+     * @param classFullName Name of the class to unregister
+     * @return true if the class was unregistered
+     * @internal
+     */
+    static unregisterCLass(classFullName: string): boolean;
+    /** Unregister all classes from a schema.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
+     * @param schema Name of the schema to unregister
+     * @internal
+     */
+    static unregisterClassesFrom(schema: typeof Schema): void;
+}
+/**
+ * A cache that records the mapping between class names and class metadata
+ * @internal
+ */
+export declare class MetaDataRegistry {
+    private _registry;
+    /** Get the specified Entity metadata */
+    find(classFullName: string): EntityMetaData | undefined;
+    /** Add metadata to the cache */
+    add(classFullName: string, metaData: EntityMetaData): void;
+}
+//# sourceMappingURL=ClassRegistry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAG3C;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAoC;IACrE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE,gBAAgB;WACF,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAYxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAWlC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAgCrC;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAM9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IACnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAkE;IAEnF,wCAAwC;IACjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAE9D,gCAAgC;IACzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAClE"}

package/lib/cjs/ClassRegistry.js

@@ -0,0 +1,154 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetaDataRegistry = exports.ClassRegistry = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const Entity_1 = require("./Entity");
+const Schema_1 = require("./Schema");
+const IModelSchemaLoader_1 = require("./IModelSchemaLoader");
+/** The mapping between a BIS class name (in the form "schema:class") and its JavaScript constructor function
+ * @public
+ */
+class ClassRegistry {
+    /** @internal */
+    static isNotFoundError(err) { return (err instanceof core_common_1.IModelError) && (err.errorNumber === core_bentley_1.IModelStatus.NotFound); }
+    /** @internal */
+    static makeMetaDataNotFoundError(className) { return new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `metadata not found for ${className}`); }
+    /** @internal */
+    static register(entityClass, schema) {
+        entityClass.schema = schema;
+        const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();
+        if (this._classMap.has(key)) {
+            const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;
+            core_bentley_1.Logger.logError("core-frontend.classRegistry", errMsg);
+            throw new Error(errMsg);
+        }
+        this._classMap.set(key, entityClass);
+    }
+    /** Generate a proxy Schema for a domain that has not been registered. */
+    static generateProxySchema(domain, iModel) {
+        var _a;
+        const hasBehavior = undefined !== ((_a = new IModelSchemaLoader_1.IModelSchemaLoader(iModel).getSchema(domain).customAttributes) === null || _a === void 0 ? void 0 : _a.get("BisCore.SchemaHasBehavior"));
+        const schemaClass = class extends Schema_1.Schema {
+            static get schemaName() { return domain; }
+            static get missingRequiredBehavior() { return hasBehavior; }
+        };
+        Schema_1.Schemas.registerSchema(schemaClass); // register the class before we return it.
+        return schemaClass;
+    }
+    /** Generate a JavaScript class from Entity metadata.
+     * @param entityMetaData The Entity metadata that defines the class
+     */
+    static generateClassForEntity(entityMetaData, iModel) {
+        const name = entityMetaData.ecclass.split(":");
+        const domainName = name[0];
+        const className = name[1];
+        if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `class ${name} has no superclass`);
+        // make sure schema exists
+        let schema = Schema_1.Schemas.getRegisteredSchema(domainName);
+        if (undefined === schema)
+            schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too
+        // this method relies on the caller having previously created/registered all superclasses
+        const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());
+        if (undefined === superclass)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `cannot find superclass for class ${name}`);
+        const generatedClass = class extends superclass {
+            static get className() { return className; }
+        };
+        // the above line creates an anonymous class. For help debugging, set the "constructor.name" property to be the same as the bisClassName.
+        Object.defineProperty(generatedClass, "name", { get: () => className }); // this is the (only) way to change that readonly property.
+        // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations
+        if (schema.missingRequiredBehavior) {
+            const throwError = () => { throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`); };
+            superclass.protectedOperations.forEach((operation) => generatedClass[operation] = throwError);
+        }
+        this.register(generatedClass, schema); // register it before returning
+        return generatedClass;
+    }
+    /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]
+     * @param moduleObj The module to search for subclasses of Entity
+     * @param schema The schema for all found classes
+     */
+    static registerModule(moduleObj, schema) {
+        for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in
+            const thisClass = moduleObj[thisMember];
+            if (thisClass.prototype instanceof Entity_1.Entity)
+                this.register(thisClass, schema);
+        }
+    }
+    /**
+     * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
+     * class. This function also ensures that all of the base classes of the Entity exist and are registered.
+     */
+    static generateClass(classFullName, iModel) {
+        const metadata = iModel.classMetaDataRegistry.find(classFullName);
+        if (metadata === undefined || metadata.ecclass === undefined)
+            throw this.makeMetaDataNotFoundError(classFullName);
+        // Make sure we have all base classes registered.
+        if (metadata.baseClasses && (0 !== metadata.baseClasses.length))
+            this.getClass(metadata.baseClasses[0], iModel);
+        // Now we can generate the class from the classDef.
+        return this.generateClassForEntity(metadata, iModel);
+    }
+    /** Find a registered class by classFullName.
+     * @param classFullName class to find
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class or undefined
+     */
+    static findRegisteredClass(classFullName) {
+        return this._classMap.get(classFullName.toLowerCase());
+    }
+    /** Get the Entity class for the specified Entity className.
+     * @param classFullName The full BIS class name of the Entity
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class
+     */
+    static getClass(classFullName, iModel) {
+        const key = classFullName.toLowerCase();
+        const ctor = this._classMap.get(key);
+        return ctor ? ctor : this.generateClass(key, iModel);
+    }
+    /** Unregister a class, by name, if one is already registered.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
+     * @param classFullName Name of the class to unregister
+     * @return true if the class was unregistered
+     * @internal
+     */
+    static unregisterCLass(classFullName) { return this._classMap.delete(classFullName.toLowerCase()); }
+    /** Unregister all classes from a schema.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
+     * @param schema Name of the schema to unregister
+     * @internal
+     */
+    static unregisterClassesFrom(schema) {
+        for (const entry of Array.from(this._classMap)) {
+            if (entry[1].schema === schema)
+                this.unregisterCLass(entry[0]);
+        }
+    }
+}
+exports.ClassRegistry = ClassRegistry;
+ClassRegistry._classMap = new Map();
+/**
+ * A cache that records the mapping between class names and class metadata
+ * @internal
+ */
+class MetaDataRegistry {
+    constructor() {
+        this._registry = new Map();
+    }
+    /** Get the specified Entity metadata */
+    find(classFullName) { return this._registry.get(classFullName.toLowerCase()); }
+    /** Add metadata to the cache */
+    add(classFullName, metaData) { this._registry.set(classFullName.toLowerCase(), metaData); }
+}
+exports.MetaDataRegistry = MetaDataRegistry;
+//# sourceMappingURL=ClassRegistry.js.map