@itwin/core-backend 3.3.0-dev.9 → 3.4.0-dev.2

package/lib/cjs/CheckpointManager.d.ts

@@ -1,10 +1,11 @@
 /** @packageDocumentation
  * @module iModels
  */
+import { IModelJsNative } from "@bentley/imodeljs-native";
 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";
+import { SQLiteDb } from "./SQLiteDb";
 /**
  * Properties of a checkpoint
  * @public
@@ -20,10 +21,19 @@ export interface CheckpointProps extends TokenArg {
     /** The number of seconds before the current token expires to attempt to reacquire a new token. Default is 1 hour. */
     readonly reattachSafetySeconds?: number;
 }
+/** Return value from [[ProgressFunction]].
+ *  @public
+ */
+export declare enum ProgressStatus {
+    /** Continue download. */
+    Continue = 0,
+    /** Abort download. */
+    Abort = 1
+}
 /** 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;
+export declare type ProgressFunction = (loaded: number, total: number) => ProgressStatus;
 /** The parameters that specify a request to download a checkpoint file from iModelHub.
  * @internal
  */
@@ -41,6 +51,8 @@ export interface DownloadRequest {
      * function returns a non-zero value, the download is aborted.
      */
     readonly onProgress?: ProgressFunction;
+    /** number of retries for transient failures. Default is 5. */
+    readonly retries?: number;
 }
 /** @internal */
 export interface DownloadJob {
@@ -54,14 +66,24 @@ export declare class Downloads {
     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.
+/**
+ * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.
  * @internal
 */
 export declare class V2CheckpointManager {
-    private static getCommandArgs;
+    static readonly cloudCacheName = "v2Checkpoints";
+    private static _cloudCache?;
+    private static containers;
+    static getFolder(): LocalDirName;
+    static cleanup(): void;
+    static getFileName(checkpoint: CheckpointProps): LocalFileName;
+    private static get cloudCache();
+    /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */
+    private static toCloudContainerProps;
+    private static getContainer;
     static attach(checkpoint: CheckpointProps): Promise<{
-        filePath: LocalFileName;
-        expiryTimestamp: number;
+        dbName: string;
+        container: SQLiteDb.CloudContainer;
     }>;
     private static performDownload;
     /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.

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

@@ -1 +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,EAAe,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAGvE,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;WAiBX,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"}
+{"version":3,"file":"CheckpointManager.d.ts","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAe,cAAc,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,OAAO,EAAyB,UAAU,EAAsD,MAAM,qBAAqB,CAAC;AACrI,OAAO,EACa,WAAW,EAAE,oBAAoB,EAAmD,YAAY,EAAE,aAAa,EAClI,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGlD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;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,cAAc;IACxB,yBAAyB;IACzB,QAAQ,IAAI;IACZ,sBAAsB;IACtB,KAAK,IAAI;CACV;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC;AAEjF;;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;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;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;;;EAGE;AACF,qBAAa,mBAAmB;IAC9B,gBAAuB,cAAc,mBAAmB;IACxD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAsB;IACjD,OAAO,CAAC,MAAM,CAAC,UAAU,CAA8C;WAEzD,SAAS,IAAI,YAAY;WASzB,OAAO,IAAI,IAAI;WAUf,WAAW,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;IAKrE,OAAO,CAAC,MAAM,KAAK,UAAU,GAqB5B;IAED,qKAAqK;IACrK,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAIpC,OAAO,CAAC,MAAM,CAAC,YAAY;WASP,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAA;KAAE,CAAC;mBAmCnG,eAAe;IAYpC;;;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;CAKrC;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;WAiBX,wBAAwB,CAAC,OAAO,EAAE,eAAe;IAgDrE,uGAAuG;WACnF,kBAAkB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B/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

@@ -7,18 +7,29 @@
  * @module iModels
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckpointManager = exports.V1CheckpointManager = exports.V2CheckpointManager = exports.Downloads = void 0;
+exports.CheckpointManager = exports.V1CheckpointManager = exports.V2CheckpointManager = exports.Downloads = exports.ProgressStatus = void 0;
 // cspell:ignore BLOCKCACHE
 const path = require("path");
+const imodeljs_native_1 = require("@bentley/imodeljs-native");
 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 SQLiteDb_1 = require("./SQLiteDb");
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelDb;
+/** Return value from [[ProgressFunction]].
+ *  @public
+ */
+var ProgressStatus;
+(function (ProgressStatus) {
+    /** Continue download. */
+    ProgressStatus[ProgressStatus["Continue"] = 0] = "Continue";
+    /** Abort download. */
+    ProgressStatus[ProgressStatus["Abort"] = 1] = "Abort";
+})(ProgressStatus = exports.ProgressStatus || (exports.ProgressStatus = {}));
 /** @internal */
 class Downloads {
     static async process(job, fn) {
@@ -46,39 +57,109 @@ class Downloads {
 }
 exports.Downloads = Downloads;
 Downloads._active = new Map();
-/** Utility class for attaching to Daemon, opening V2 checkpoints, and downloading them.
+/**
+ * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.
  * @internal
 */
 class V2CheckpointManager {
-    static async getCommandArgs(checkpoint) {
+    static getFolder() {
+        const cloudCachePath = path.join(BriefcaseManager_1.BriefcaseManager.cacheDir, V2CheckpointManager.cloudCacheName);
+        if (!(IModelJsFs_1.IModelJsFs.existsSync(cloudCachePath))) {
+            IModelJsFs_1.IModelJsFs.recursiveMkDirSync(cloudCachePath);
+        }
+        return cloudCachePath;
+    }
+    /* only used by tests that reset the state of the v2checkpointmanager. all dbs should be closed before calling this function. */
+    static cleanup() {
+        var _a;
+        for (const [_, value] of this.containers.entries()) {
+            if (value.isConnected)
+                value.detach();
+        }
+        (_a = this._cloudCache) === null || _a === void 0 ? void 0 : _a.destroy();
+        this._cloudCache = undefined;
+        this.containers.clear();
+    }
+    static getFileName(checkpoint) {
+        const changesetId = checkpoint.changeset.id || "first";
+        return path.join(this.getFolder(), `${changesetId}.bim`);
+    }
+    static get cloudCache() {
+        if (!this._cloudCache) {
+            let rootDir = process.env.CHECKPOINT_CACHE_DIR;
+            if (!rootDir) {
+                rootDir = this.getFolder();
+                core_bentley_1.Logger.logWarning(loggerCategory, `No CHECKPOINT_CACHE_DIR found in process.env, using ${rootDir} instead.`);
+            }
+            else {
+                // Make sure the checkpoint_cache_dir has an iTwinDaemon specific file in it, otherwise fall back to other directory.
+                if (!(IModelJsFs_1.IModelJsFs.existsSync(path.join(rootDir, "portnumber.bcv")))) {
+                    rootDir = this.getFolder();
+                    core_bentley_1.Logger.logWarning(loggerCategory, `No evidence of the iTwinDaemon in provided CHECKPOINT_CACHE_DIR: ${process.env.CHECKPOINT_CACHE_DIR}, using ${rootDir} instead.`);
+                }
+            }
+            this._cloudCache = SQLiteDb_1.SQLiteDb.createCloudCache({ name: this.cloudCacheName, rootDir });
+            // Its fine if its not a daemon, but lets log an info message
+            if (!this._cloudCache.isDaemon)
+                core_bentley_1.Logger.logInfo(loggerCategory, "V2Checkpoint manager running with no iTwinDaemon.");
+        }
+        return this._cloudCache;
+    }
+    /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */
+    static toCloudContainerProps(from) {
+        return { ...from, accessName: from.accountName, accessToken: from.sasToken };
+    }
+    static getContainer(v2Props) {
+        let container = this.containers.get(v2Props.containerId);
+        if (!container) {
+            container = SQLiteDb_1.SQLiteDb.createCloudContainer(this.toCloudContainerProps(v2Props));
+            this.containers.set(v2Props.containerId, container);
+        }
+        return container;
+    }
+    static async attach(checkpoint) {
+        let v2props;
         try {
-            const v2props = await IModelHost_1.IModelHost.hubAccess.queryV2Checkpoint(checkpoint);
+            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.CloudSqlite.Daemon.command("attach", args);
-        if (attachResult.result !== core_bentley_1.DbResult.BE_SQLITE_OK) {
-            const error = `Daemon attach failed: ${attachResult.errMsg}`;
+        try {
+            const container = this.getContainer(v2props);
+            const dbName = v2props.dbName;
+            if (!container.isConnected)
+                container.connect(this.cloudCache);
+            if (IModelHost_1.IModelHost.appWorkspace.settings.getBoolean("Checkpoints/prefetch", false)) {
+                const logPrefetch = async (prefetch) => {
+                    const stopwatch = new core_bentley_1.StopWatch(`[${container.containerId}/${dbName}]`, true);
+                    core_bentley_1.Logger.logInfo(loggerCategory, `Starting prefetch of ${stopwatch.description}`);
+                    const done = await prefetch.promise;
+                    core_bentley_1.Logger.logInfo(loggerCategory, `Prefetch of ${stopwatch.description} complete=${done} (${stopwatch.elapsedSeconds} seconds)`);
+                };
+                // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                logPrefetch(SQLiteDb_1.SQLiteDb.startCloudPrefetch(container, dbName));
+            }
+            return { dbName, container };
+        }
+        catch (e) {
+            const error = `Cloud cache connect failed: ${e.message}`;
             if (checkpoint.expectV2)
                 core_bentley_1.Logger.logError(loggerCategory, error);
-            throw new core_common_1.IModelError(attachResult.result, error);
+            throw new core_common_1.IModelError(e.errorNumber, error);
         }
-        const sasTokenExpiry = new URLSearchParams(args.sasToken).get("se");
-        return { filePath: imodeljs_native_1.CloudSqlite.Daemon.getDbFileName(args), expiryTimestamp: sasTokenExpiry ? Date.parse(sasTokenExpiry) : 0 };
     }
     static async performDownload(job) {
+        const request = job.request;
+        const v2props = await IModelHost_1.IModelHost.hubAccess.queryV2Checkpoint(request.checkpoint);
+        if (!v2props)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "V2 checkpoint not found");
         CheckpointManager.onDownloadV2.raiseEvent(job);
-        return (await IModelHost_1.IModelHost.hubAccess.downloadV2Checkpoint(job.request)).id;
+        const container = SQLiteDb_1.SQLiteDb.createCloudContainer(this.toCloudContainerProps(v2props));
+        await imodeljs_native_1.CloudSqlite.transferDb("download", container, { dbName: v2props.dbName, localFileName: request.localFile, onProgress: request.onProgress });
+        return request.checkpoint.changeset.id;
     }
     /** 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
@@ -89,6 +170,8 @@ class V2CheckpointManager {
     }
 }
 exports.V2CheckpointManager = V2CheckpointManager;
+V2CheckpointManager.cloudCacheName = "v2Checkpoints";
+V2CheckpointManager.containers = new Map();
 /** Utility class to deal with downloading V1 checkpoints from iModelHub.
  * @internal
  */
@@ -118,6 +201,7 @@ class V1CheckpointManager {
     }
     static async performDownload(job) {
         CheckpointManager.onDownloadV1.raiseEvent(job);
+        // eslint-disable-next-line deprecation/deprecation
         return (await IModelHost_1.IModelHost.hubAccess.downloadV1Checkpoint(job.request)).id;
     }
 }
@@ -136,9 +220,9 @@ class CheckpointManager {
             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
+            if (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
+            throw error; // most likely, was aborted
         }
     }
     static async updateToRequestedVersion(request) {
@@ -188,6 +272,7 @@ class CheckpointManager {
     }
     /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */
     static async downloadCheckpoint(request) {
+        var _a;
         if (this.verifyCheckpoint(request.checkpoint, request.localFile))
             return;
         if (request.aliasFiles) {
@@ -198,7 +283,17 @@ class CheckpointManager {
                 }
             }
         }
-        await this.doDownload(request);
+        let retry = request.retries !== undefined ? request.retries : 5;
+        while (true) {
+            try {
+                await this.doDownload(request);
+                break;
+            }
+            catch (e) {
+                if (--retry <= 0 || true !== ((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes("Failure when receiving data from the peer")))
+                    throw e;
+            }
+        }
         return this.updateToRequestedVersion(request);
     }
     /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */

package/lib/cjs/CheckpointManager.js.map

@@ -1 +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,8DAAuE;AACvE,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,6BAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACtE,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,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEpE,OAAO,EAAE,QAAQ,EAAE,6BAAW,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAChI,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,iBAAiB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,OAAO,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,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,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,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,IAAI,WAAW,KAAK,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBACjD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,4DAA4D,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,mCAAmC,OAAO,CAAC,UAAU,CAAC,QAAQ,eAAe,WAAW,EAAE,CAAC,CAAC;;gBAEtN,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oCAAoC,OAAO,CAAC,UAAU,CAAC,QAAQ,eAAe,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;YAClJ,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,CAAC,+DAA+D;oBACrH,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;;AAnJH,8CAoJC;AAnJwB,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 { CloudSqlite, 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<CloudSqlite.DaemonCommandArg> {\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 CloudSqlite.Daemon.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.sasToken).get(\"se\");\r\n\r\n    return { filePath: CloudSqlite.Daemon.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 (await IModelHost.hubAccess.downloadV2Checkpoint(job.request)).id;\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 (await IModelHost.hubAccess.downloadV1Checkpoint(job.request)).id;\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      if (changesetId !== request.checkpoint.changeset.id)\r\n        Logger.logInfo(loggerCategory, `Downloaded previous v2 checkpoint because checkpoint for ${request.checkpoint.changeset.id} not found.  Downloaded: IModel=${request.checkpoint.iModelId}, changeset=${changesetId}`);\r\n      else\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!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\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"]}
+{"version":3,"file":"CheckpointManager.js","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,2BAA2B;AAE3B,6BAA6B;AAC7B,8DAAuE;AACvE,sDAAqI;AACrI,oDAE4B;AAE5B,mEAAgE;AAChE,yDAAsD;AACtD,yCAAkD;AAClD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AAEtC,MAAM,cAAc,GAAG,6CAAqB,CAAC,QAAQ,CAAC;AAsBtD;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,yBAAyB;IACzB,2DAAY,CAAA;IACZ,sBAAsB;IACtB,qDAAS,CAAA;AACX,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAsCD,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;;;EAGE;AACF,MAAa,mBAAmB;IAKvB,MAAM,CAAC,SAAS;QACrB,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,mCAAgB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAChG,IAAI,CAAC,CAAC,uBAAU,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,EAAE;YAC5C,uBAAU,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;SAC/C;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,gIAAgI;IACzH,MAAM,CAAC,OAAO;;QACnB,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE;YAClD,IAAI,KAAK,CAAC,WAAW;gBACnB,KAAK,CAAC,MAAM,EAAE,CAAC;SAClB;QACD,MAAA,IAAI,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,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,EAAE,EAAE,GAAG,WAAW,MAAM,CAAC,CAAC;IAC3D,CAAC;IAEO,MAAM,KAAK,UAAU;QAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,IAAI,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;YAC/C,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC3B,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,uDAAuD,OAAO,WAAW,CAAC,CAAC;aAC9G;iBAAM;gBACL,qHAAqH;gBACrH,IAAI,CAAC,CAAC,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE;oBAClE,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;oBAC3B,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,oEAAoE,OAAO,CAAC,GAAG,CAAC,oBAAoB,WAAW,OAAO,WAAW,CAAC,CAAC;iBACtK;aACF;YAED,IAAI,CAAC,WAAW,GAAG,mBAAQ,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;YAErF,6DAA6D;YAC7D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;gBAC5B,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,mDAAmD,CAAC,CAAC;SACvF;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,qKAAqK;IAC7J,MAAM,CAAC,qBAAqB,CAAC,IAA6B;QAChE,OAAO,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC/E,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,OAAgC;QAC1D,IAAI,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,EAAE;YACd,SAAS,GAAG,mBAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;YAC/E,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;SACrD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAA2B;QACpD,IAAI,OAA4C,CAAC;QACjD,IAAI;YACF,OAAO,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACnE,IAAI,CAAC,OAAO;gBACV,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;SACpC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,iCAAiC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;SAC9F;QAED,IAAI;YACF,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,WAAW;gBACxB,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACrC,IAAI,uBAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,KAAK,CAAC,EAAE;gBAC9E,MAAM,WAAW,GAAG,KAAK,EAAE,QAAgC,EAAE,EAAE;oBAC7D,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC,IAAI,SAAS,CAAC,WAAW,IAAI,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC;oBAC9E,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,wBAAwB,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;oBAChF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;oBACpC,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,SAAS,CAAC,WAAW,aAAa,IAAI,KAAK,SAAS,CAAC,cAAc,WAAW,CAAC,CAAC;gBAChI,CAAC,CAAC;gBACF,mEAAmE;gBACnE,WAAW,CAAC,mBAAQ,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;aAC7D;YACD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SAC9B;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,KAAK,GAAG,+BAA+B,CAAC,CAAC,OAAO,EAAE,CAAC;YACzD,IAAI,UAAU,CAAC,QAAQ;gBACrB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAEzC,MAAM,IAAI,yBAAW,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;SAC7C;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,MAAM,OAAO,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;QAE1E,iBAAiB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,mBAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;QACrF,MAAM,6BAAW,CAAC,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAClJ,OAAO,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;IACzC,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;;AAvHH,kDAwHC;AAvHwB,kCAAc,GAAG,eAAe,CAAC;AAEzC,8BAAU,GAAG,IAAI,GAAG,EAAmC,CAAC;AAuHzE;;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,mDAAmD;QACnD,OAAO,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,CAAC;CACF;AAlCD,kDAkCC;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,IAAI,WAAW,KAAK,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBACjD,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,4DAA4D,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,mCAAmC,OAAO,CAAC,UAAU,CAAC,QAAQ,eAAe,WAAW,EAAE,CAAC,CAAC;;gBAEtN,qBAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oCAAoC,OAAO,CAAC,UAAU,CAAC,QAAQ,eAAe,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;YAClJ,OAAO,WAAW,CAAC;SACpB;QAAC,OAAO,KAAU,EAAE;YACnB,IAAI,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,EAAE,kDAAkD;gBACjG,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAEzD,MAAM,KAAK,CAAC,CAAC,2BAA2B;SACzC;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;YAC7B,IAAI;gBAEF,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,CAAC,+DAA+D;oBACrH,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,IAAI,KAAK,GAAG,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAChE,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC/B,MAAM;aACP;YAAC,OAAO,CAAM,EAAE;gBACf,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,IAAI,MAAK,MAAA,CAAC,CAAC,OAAO,0CAAE,QAAQ,CAAC,2CAA2C,CAAC,CAAA;oBAC3F,MAAM,CAAC,CAAC;aACX;SACF;QACD,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;;AA5JH,8CA6JC;AA5JwB,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 { CloudSqlite, IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { BeEvent, ChangeSetStatus, Guid, GuidString, IModelStatus, Logger, Mutable, OpenMode, StopWatch } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseIdValue, ChangesetId, ChangesetIdWithIndex, ChangesetIndexAndId, IModelError, IModelVersion, LocalDirName, LocalFileName,\r\n} from \"@itwin/core-common\";\r\nimport { V2CheckpointAccessProps } from \"./BackendHubAccess\";\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\nimport { SQLiteDb } from \"./SQLiteDb\";\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/** Return value from [[ProgressFunction]].\r\n *  @public\r\n */\r\nexport enum ProgressStatus {\r\n  /** Continue download. */\r\n  Continue = 0,\r\n  /** Abort download. */\r\n  Abort = 1,\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) => ProgressStatus;\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  /** number of retries for transient failures. Default is 5. */\r\n  readonly retries?: number;\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/**\r\n * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.\r\n * @internal\r\n*/\r\nexport class V2CheckpointManager {\r\n  public static readonly cloudCacheName = \"v2Checkpoints\";\r\n  private static _cloudCache?: SQLiteDb.CloudCache;\r\n  private static containers = new Map<string, SQLiteDb.CloudContainer>();\r\n\r\n  public static getFolder(): LocalDirName {\r\n    const cloudCachePath = path.join(BriefcaseManager.cacheDir, V2CheckpointManager.cloudCacheName);\r\n    if (!(IModelJsFs.existsSync(cloudCachePath))) {\r\n      IModelJsFs.recursiveMkDirSync(cloudCachePath);\r\n    }\r\n    return cloudCachePath;\r\n  }\r\n\r\n  /* only used by tests that reset the state of the v2checkpointmanager. all dbs should be closed before calling this function. */\r\n  public static cleanup(): void {\r\n    for (const [_, value] of this.containers.entries()) {\r\n      if (value.isConnected)\r\n        value.detach();\r\n    }\r\n    this._cloudCache?.destroy();\r\n    this._cloudCache = undefined;\r\n    this.containers.clear();\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(), `${changesetId}.bim`);\r\n  }\r\n\r\n  private static get cloudCache(): SQLiteDb.CloudCache {\r\n    if (!this._cloudCache) {\r\n      let rootDir = process.env.CHECKPOINT_CACHE_DIR;\r\n      if (!rootDir) {\r\n        rootDir = this.getFolder();\r\n        Logger.logWarning(loggerCategory, `No CHECKPOINT_CACHE_DIR found in process.env, using ${rootDir} instead.`);\r\n      } else {\r\n        // Make sure the checkpoint_cache_dir has an iTwinDaemon specific file in it, otherwise fall back to other directory.\r\n        if (!(IModelJsFs.existsSync(path.join(rootDir, \"portnumber.bcv\")))) {\r\n          rootDir = this.getFolder();\r\n          Logger.logWarning(loggerCategory, `No evidence of the iTwinDaemon in provided CHECKPOINT_CACHE_DIR: ${process.env.CHECKPOINT_CACHE_DIR}, using ${rootDir} instead.`);\r\n        }\r\n      }\r\n\r\n      this._cloudCache = SQLiteDb.createCloudCache({ name: this.cloudCacheName, rootDir });\r\n\r\n      // Its fine if its not a daemon, but lets log an info message\r\n      if (!this._cloudCache.isDaemon)\r\n        Logger.logInfo(loggerCategory, \"V2Checkpoint manager running with no iTwinDaemon.\");\r\n    }\r\n    return this._cloudCache;\r\n  }\r\n\r\n  /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */\r\n  private static toCloudContainerProps(from: V2CheckpointAccessProps): CloudSqlite.ContainerAccessProps {\r\n    return { ...from, accessName: from.accountName, accessToken: from.sasToken };\r\n  }\r\n\r\n  private static getContainer(v2Props: V2CheckpointAccessProps) {\r\n    let container = this.containers.get(v2Props.containerId);\r\n    if (!container) {\r\n      container = SQLiteDb.createCloudContainer(this.toCloudContainerProps(v2Props));\r\n      this.containers.set(v2Props.containerId, container);\r\n    }\r\n    return container;\r\n  }\r\n\r\n  public static async attach(checkpoint: CheckpointProps): Promise<{ dbName: string, container: SQLiteDb.CloudContainer }> {\r\n    let v2props: V2CheckpointAccessProps | undefined;\r\n    try {\r\n      v2props = await IModelHost.hubAccess.queryV2Checkpoint(checkpoint);\r\n      if (!v2props)\r\n        throw new Error(\"no checkpoint\");\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    try {\r\n      const container = this.getContainer(v2props);\r\n      const dbName = v2props.dbName;\r\n      if (!container.isConnected)\r\n        container.connect(this.cloudCache);\r\n      if (IModelHost.appWorkspace.settings.getBoolean(\"Checkpoints/prefetch\", false)) {\r\n        const logPrefetch = async (prefetch: SQLiteDb.CloudPrefetch) => {\r\n          const stopwatch = new StopWatch(`[${container.containerId}/${dbName}]`, true);\r\n          Logger.logInfo(loggerCategory, `Starting prefetch of ${stopwatch.description}`);\r\n          const done = await prefetch.promise;\r\n          Logger.logInfo(loggerCategory, `Prefetch of ${stopwatch.description} complete=${done} (${stopwatch.elapsedSeconds} seconds)`);\r\n        };\r\n        // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n        logPrefetch(SQLiteDb.startCloudPrefetch(container, dbName));\r\n      }\r\n      return { dbName, container };\r\n    } catch (e: any) {\r\n      const error = `Cloud cache connect failed: ${e.message}`;\r\n      if (checkpoint.expectV2)\r\n        Logger.logError(loggerCategory, error);\r\n\r\n      throw new IModelError(e.errorNumber, error);\r\n    }\r\n  }\r\n\r\n  private static async performDownload(job: DownloadJob): Promise<ChangesetId> {\r\n    const request = job.request;\r\n    const v2props = await IModelHost.hubAccess.queryV2Checkpoint(request.checkpoint);\r\n    if (!v2props)\r\n      throw new IModelError(IModelStatus.NotFound, \"V2 checkpoint not found\");\r\n\r\n    CheckpointManager.onDownloadV2.raiseEvent(job);\r\n    const container = SQLiteDb.createCloudContainer(this.toCloudContainerProps(v2props));\r\n    await CloudSqlite.transferDb(\"download\", container, { dbName: v2props.dbName, localFileName: request.localFile, onProgress: request.onProgress });\r\n    return request.checkpoint.changeset.id;\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    // eslint-disable-next-line deprecation/deprecation\r\n    return (await IModelHost.hubAccess.downloadV1Checkpoint(job.request)).id;\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      if (changesetId !== request.checkpoint.changeset.id)\r\n        Logger.logInfo(loggerCategory, `Downloaded previous v2 checkpoint because checkpoint for ${request.checkpoint.changeset.id} not found.  Downloaded: IModel=${request.checkpoint.iModelId}, changeset=${changesetId}`);\r\n      else\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: any) {\r\n      if (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      try {\r\n\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!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\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    let retry = request.retries !== undefined ? request.retries : 5;\r\n    while (true) {\r\n      try {\r\n        await this.doDownload(request);\r\n        break;\r\n      } catch (e: any) {\r\n        if (--retry <= 0 || true !== e.message?.includes(\"Failure when receiving data from the peer\"))\r\n          throw e;\r\n      }\r\n    }\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.js

@@ -102,22 +102,22 @@ class ClassRegistry {
             .filter(([_propName, prop]) => prop.isNavigation)
             .map(([propName, _prop]) => propName);
         const isElement = (t) => t.is(Element_1.Element); // Entity.is check but with type information to avoid casts later
-        // a class only gets an automatic `collectPredecessorIds` implementation if:
+        // a class only gets an automatic `collectReferenceIds` implementation if:
         // - it derives from `BisCore:Element`
         // - it is not in the `BisCore` schema
         // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)
         if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {
-            Object.defineProperty(generatedClass.prototype, "collectPredecessorIds", {
+            Object.defineProperty(generatedClass.prototype, "collectReferenceIds", {
                 // first prototype of `this` is its class
-                value(predecessorIds) {
+                value(referenceIds) {
                     // eslint-disable-next-line @typescript-eslint/dot-notation
-                    const superImpl = superclass.prototype["collectPredecessorIds"];
-                    superImpl.call(this, predecessorIds);
+                    const superImpl = superclass.prototype["collectReferenceIds"];
+                    superImpl.call(this, referenceIds);
                     for (const navProp of navigationProps) {
                         const relatedElem = this[navProp]; // cast to any since subclass can have any extensions
                         if (!relatedElem || !core_bentley_1.Id64.isValid(relatedElem.id))
                             continue;
-                        predecessorIds.add(relatedElem.id);
+                        referenceIds.add(relatedElem.id);
                     }
                 },
                 // defaults for methods on a prototype (required for sinon to stub out methods on tests)

package/lib/cjs/ClassRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoF;AACpF,oDAAiF;AACjF,qCAAkC;AAClC,uCAAoC;AAEpC,qCAA2C;AAE3C,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBAAE,MAAM;YAC7D,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;aAC9D,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;aAChD,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,SAAS,GAAG,CAAC,CAAgB,EAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAO,CAAC,CAAC,CAAC,iEAAiE;QAE7I,4EAA4E;QAC5E,sCAAsC;QACtC,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE;YAC1E,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,uBAAuB,EACvB;gBACE,yCAAyC;gBACzC,KAAK,CAA8B,cAAuB;oBACxD,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;oBAChE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;oBACrC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,CAAC,CAAC,qDAAqD;wBAC7H,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAAE,SAAS;wBAC5D,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;qBACpC;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9J,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AAvMH,sCAwMC;AAvMyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAyMvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","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 Schema\r\n */\r\n\r\nimport { DbResult, Id64, Id64Set, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { Element } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\") break;\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    const navigationProps = Object.entries(entityMetaData.properties)\r\n      .filter(([_propName, prop]) => prop.isNavigation)\r\n      .map(([propName, _prop]) => propName);\r\n\r\n    const isElement = (t: typeof Entity): t is typeof Element => t.is(Element); // Entity.is check but with type information to avoid casts later\r\n\r\n    // a class only gets an automatic `collectPredecessorIds` implementation if:\r\n    // - it derives from `BisCore:Element`\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectPredecessorIds\",\r\n        {\r\n          // first prototype of `this` is its class\r\n          value(this: typeof generatedClass, predecessorIds: Id64Set) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectPredecessorIds\"];\r\n            superImpl.call(this, predecessorIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id)) continue;\r\n              predecessorIds.add(relatedElem.id);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => { throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`); };\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}
+{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoF;AACpF,oDAAiF;AACjF,qCAAkC;AAClC,uCAAoC;AAEpC,qCAA2C;AAE3C,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,aAAa;IAExB,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,yBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,2BAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK,gBAAgB;IACT,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,qBAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvC,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,uBAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,eAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,gBAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QAC/E,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,gBAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBAAE,MAAM;YAC7D,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE;gBACvC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;aACP;YACD,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;SACzC;QAED,MAAM,cAAc,SAAG,KAAM,SAAQ,UAAU;gBACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;gBAErD,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;aACnG;iBAFiB,mBAAmB;YAApB,MAAqB,GAAG,IAAK;eAE7C,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;aAC9D,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;aAChD,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;QAExC,MAAM,SAAS,GAAG,CAAC,CAAgB,EAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAO,CAAC,CAAC,CAAC,iEAAiE;QAE7I,0EAA0E;QAC1E,sCAAsC;QACtC,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE;YAC1E,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,qBAAqB,EACrB;gBACE,yCAAyC;gBACzC,KAAK,CAA8B,YAAqB;oBACtD,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;oBAC9D,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;wBACrC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,CAAC,CAAC,qDAAqD;wBAC7H,IAAI,CAAC,WAAW,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAAE,SAAS;wBAC5D,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;qBAClC;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;SACH;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE;YAClC,MAAM,UAAU,GAAG,GAAG,EAAE,GAAG,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9J,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;SACxG;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACtE,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,EAAE,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,eAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACpC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IACnH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAClC;IACH,CAAC;;AAvMH,sCAwMC;AAvMyB,uBAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;AAyMvE;;;GAGG;AACH,MAAa,gBAAgB;IAA7B;QACU,cAAS,GAAgC,IAAI,GAAG,EAA0B,CAAC;IAOrF,CAAC;IALC,wCAAwC;IACjC,IAAI,CAAC,aAAqB,IAAgC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAE1H,gCAAgC;IACzB,GAAG,CAAC,aAAqB,EAAE,QAAwB,IAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjI;AARD,4CAQC","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 Schema\r\n */\r\n\r\nimport { DbResult, Id64, Id64Set, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport { EntityMetaData, IModelError, RelatedElement } from \"@itwin/core-common\";\r\nimport { Entity } from \"./Entity\";\r\nimport { Element } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\n\r\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\r\n\r\n/** The mapping between a BIS class name (in the form \"schema:class\") and its JavaScript constructor function\r\n * @public\r\n */\r\nexport class ClassRegistry {\r\n  private static readonly _classMap = new Map<string, typeof Entity>();\r\n  /** @internal */\r\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\r\n  /** @internal */\r\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\r\n  /** @internal */\r\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\r\n    entityClass.schema = schema;\r\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\r\n    if (this._classMap.has(key)) {\r\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\r\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\r\n      throw new Error(errMsg);\r\n    }\r\n\r\n    this._classMap.set(key, entityClass);\r\n  }\r\n\r\n  /** Generate a proxy Schema for a domain that has not been registered. */\r\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\r\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\r\n      SELECT NULL FROM [ec_CustomAttribute] [c]\r\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\r\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\r\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\r\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\r\n      stmt.bindString(1, domain);\r\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\r\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\r\n    });\r\n\r\n    const schemaClass = class extends Schema {\r\n      public static override get schemaName() { return domain; }\r\n      public static override get missingRequiredBehavior() { return hasBehavior; }\r\n    };\r\n\r\n    Schemas.registerSchema(schemaClass); // register the class before we return it.\r\n    return schemaClass;\r\n  }\r\n\r\n  /** Generate a JavaScript class from Entity metadata.\r\n   * @param entityMetaData The Entity metadata that defines the class\r\n   */\r\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\r\n    const name = entityMetaData.ecclass.split(\":\");\r\n    const domainName = name[0];\r\n    const className = name[1];\r\n\r\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\r\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\r\n\r\n    // make sure schema exists\r\n    let schema = Schemas.getRegisteredSchema(domainName);\r\n    if (undefined === schema)\r\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\r\n\r\n    const superclass = this._classMap.get(entityMetaData.baseClasses[0].toLowerCase());\r\n    if (undefined === superclass)\r\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\r\n\r\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\r\n    // be used to tell if there are any generated classes in the hierarchy\r\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\r\n    let currentSuperclass = superclass;\r\n    const MAX_ITERS = 1000;\r\n    for (let i = 0; i < MAX_ITERS; ++i) {\r\n      if (currentSuperclass.schema.schemaName === \"BisCore\") break;\r\n      if (!currentSuperclass.isGeneratedClass) {\r\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\r\n        break;\r\n      }\r\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\r\n      if (superclassMetaData === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\r\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\r\n      if (maybeNextSuperclass === undefined)\r\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\r\n      currentSuperclass = maybeNextSuperclass;\r\n    }\r\n\r\n    const generatedClass = class extends superclass {\r\n      public static override get className() { return className; }\r\n      private static [isGeneratedClassTag] = true;\r\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\r\n    };\r\n\r\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\r\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\r\n\r\n    const navigationProps = Object.entries(entityMetaData.properties)\r\n      .filter(([_propName, prop]) => prop.isNavigation)\r\n      .map(([propName, _prop]) => propName);\r\n\r\n    const isElement = (t: typeof Entity): t is typeof Element => t.is(Element); // Entity.is check but with type information to avoid casts later\r\n\r\n    // a class only gets an automatic `collectReferenceIds` implementation if:\r\n    // - it derives from `BisCore:Element`\r\n    // - it is not in the `BisCore` schema\r\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\r\n    if (!generatedClassHasNonGeneratedNonCoreAncestor && isElement(superclass)) {\r\n      Object.defineProperty(\r\n        generatedClass.prototype,\r\n        \"collectReferenceIds\",\r\n        {\r\n          // first prototype of `this` is its class\r\n          value(this: typeof generatedClass, referenceIds: Id64Set) {\r\n            // eslint-disable-next-line @typescript-eslint/dot-notation\r\n            const superImpl = superclass.prototype[\"collectReferenceIds\"];\r\n            superImpl.call(this, referenceIds);\r\n            for (const navProp of navigationProps) {\r\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp]; // cast to any since subclass can have any extensions\r\n              if (!relatedElem || !Id64.isValid(relatedElem.id)) continue;\r\n              referenceIds.add(relatedElem.id);\r\n            }\r\n          },\r\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\r\n          writable: true,\r\n          configurable: true,\r\n        }\r\n      );\r\n    }\r\n\r\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\r\n    if (schema.missingRequiredBehavior) {\r\n      const throwError = () => { throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`); };\r\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\r\n    }\r\n\r\n    this.register(generatedClass, schema); // register it before returning\r\n    return generatedClass;\r\n  }\r\n\r\n  /** Register all of the classes found in the given module that derive from Entity. See the example in [[Schema]]\r\n   * @param moduleObj The module to search for subclasses of Entity\r\n   * @param schema The schema for all found classes\r\n   */\r\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\r\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\r\n      const thisClass = moduleObj[thisMember];\r\n      if (thisClass.prototype instanceof Entity)\r\n        this.register(thisClass, schema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\r\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\r\n   */\r\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\r\n    if (metadata === undefined || metadata.ecclass === undefined)\r\n      throw this.makeMetaDataNotFoundError(classFullName);\r\n\r\n    // Make sure we have all base classes registered.\r\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\r\n      this.getClass(metadata.baseClasses[0], iModel);\r\n\r\n    // Now we can generate the class from the classDef.\r\n    return this.generateClassForEntity(metadata, iModel);\r\n  }\r\n\r\n  /** Find a registered class by classFullName.\r\n   * @param classFullName class to find\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class or undefined\r\n   */\r\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\r\n    return this._classMap.get(classFullName.toLowerCase());\r\n  }\r\n\r\n  /** Get the Entity class for the specified Entity className.\r\n   * @param classFullName The full BIS class name of the Entity\r\n   * @param iModel The IModel that contains the class definitions\r\n   * @returns The Entity class\r\n   */\r\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\r\n    const key = classFullName.toLowerCase();\r\n    const ctor = this._classMap.get(key);\r\n    return ctor ? ctor : this.generateClass(key, iModel);\r\n  }\r\n\r\n  /** Unregister a class, by name, if one is already registered.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\r\n   * @param classFullName Name of the class to unregister\r\n   * @return true if the class was unregistered\r\n   * @internal\r\n   */\r\n  public static unregisterCLass(classFullName: string) { return this._classMap.delete(classFullName.toLowerCase()); }\r\n  /** Unregister all classes from a schema.\r\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\r\n   * @param schema Name of the schema to unregister\r\n   * @internal\r\n   */\r\n  public static unregisterClassesFrom(schema: typeof Schema) {\r\n    for (const entry of Array.from(this._classMap)) {\r\n      if (entry[1].schema === schema)\r\n        this.unregisterCLass(entry[0]);\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * A cache that records the mapping between class names and class metadata\r\n * @internal\r\n */\r\nexport class MetaDataRegistry {\r\n  private _registry: Map<string, EntityMetaData> = new Map<string, EntityMetaData>();\r\n\r\n  /** Get the specified Entity metadata */\r\n  public find(classFullName: string): EntityMetaData | undefined { return this._registry.get(classFullName.toLowerCase()); }\r\n\r\n  /** Add metadata to the cache */\r\n  public add(classFullName: string, metaData: EntityMetaData): void { this._registry.set(classFullName.toLowerCase(), metaData); }\r\n}\r\n"]}

package/lib/cjs/CodeSpecs.d.ts

@@ -4,7 +4,7 @@
 import { Id64String } from "@itwin/core-bentley";
 import { CodeScopeSpec, CodeSpec } from "@itwin/core-common";
 import { IModelDb } from "./IModelDb";
-/** Manages [CodeSpecs]($docs/BIS/intro/element-fundamentals.md#codespec) within an [[IModelDb]]
+/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
  * @public
  */
 export declare class CodeSpecs {

package/lib/cjs/CodeSpecs.js

@@ -10,7 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CodeSpecs = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
-/** Manages [CodeSpecs]($docs/BIS/intro/element-fundamentals.md#codespec) within an [[IModelDb]]
+/** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
  * @public
  */
 class CodeSpecs {