@itwin/core-backend 4.0.0-dev.24 → 4.0.0-dev.30

package/lib/cjs/IModelDb.js

@@ -77,8 +77,7 @@ class IModelSettings extends Settings_1.BaseSettings {
     }
     // attempt to resolve a setting from this iModel's settings, otherwise use appWorkspace's settings, otherwise defaultValue.
     resolveSetting(name, resolver, defaultValue) {
-        var _a;
-        return (_a = super.resolveSetting(name, resolver)) !== null && _a !== void 0 ? _a : IModelHost_1.IModelHost.appWorkspace.settings.resolveSetting(name, resolver, defaultValue);
+        return super.resolveSetting(name, resolver) ?? IModelHost_1.IModelHost.appWorkspace.settings.resolveSetting(name, resolver, defaultValue);
     }
 }
 /** An iModel database file. The database file can either be a briefcase or a snapshot.
@@ -155,8 +154,7 @@ class IModelDb extends core_common_1.IModel {
         this.onChangesetApplied.raiseEvent();
     }
     get fontMap() {
-        var _a;
-        return (_a = this._fontMap) !== null && _a !== void 0 ? _a : (this._fontMap = new core_common_1.FontMap(this.nativeDb.readFontMap()));
+        return this._fontMap ?? (this._fontMap = new core_common_1.FontMap(this.nativeDb.readFontMap()));
     }
     /** @internal */
     clearFontMap() {
@@ -173,7 +171,7 @@ class IModelDb extends core_common_1.IModel {
     addNewFont(name, type) {
         this.locks.checkExclusiveLock(core_common_1.IModel.repositoryModelId, "schema", "addNewFont");
         this.clearFontMap();
-        return this.nativeDb.addNewFont({ name, type: type !== null && type !== void 0 ? type : core_common_1.FontType.TrueType });
+        return this.nativeDb.addNewFont({ name, type: type ?? core_common_1.FontType.TrueType });
     }
     /** Check if this iModel has been opened read-only or not. */
     get isReadonly() { return this.openMode === core_bentley_1.OpenMode.Readonly; }
@@ -190,15 +188,14 @@ class IModelDb extends core_common_1.IModel {
     get pathName() { return this.nativeDb.getFilePath(); }
     /** Close this IModel, if it is currently open. */
     close() {
-        var _a, _b;
         if (!this.isOpen)
             return; // don't continue if already closed
         this.beforeClose();
         IModelDb._openDbs.delete(this._fileKey);
-        (_a = this._workspace) === null || _a === void 0 ? void 0 : _a.close();
+        this._workspace?.close();
         this.locks.close();
         this._locks = undefined;
-        (_b = this._codeService) === null || _b === void 0 ? void 0 : _b.close();
+        this._codeService?.close();
         this._codeService = undefined;
         this.nativeDb.closeIModel();
         this._nativeDb = undefined; // the underlying nativeDb has been freed by closeIModel
@@ -227,8 +224,8 @@ class IModelDb extends core_common_1.IModel {
         db.onRootSubjectChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyRootSubjectChanged", db.rootSubject));
         db.onProjectExtentsChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyProjectExtentsChanged", db.projectExtents.toJSON()));
         db.onGlobalOriginChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyGlobalOriginChanged", db.globalOrigin.toJSON()));
-        db.onEcefLocationChanged.addListener(() => { var _a; return IpcHost_1.IpcHost.notifyTxns(db, "notifyEcefLocationChanged", (_a = db.ecefLocation) === null || _a === void 0 ? void 0 : _a.toJSON()); });
-        db.onGeographicCoordinateSystemChanged.addListener(() => { var _a; return IpcHost_1.IpcHost.notifyTxns(db, "notifyGeographicCoordinateSystemChanged", (_a = db.geographicCoordinateSystem) === null || _a === void 0 ? void 0 : _a.toJSON()); });
+        db.onEcefLocationChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyEcefLocationChanged", db.ecefLocation?.toJSON()));
+        db.onGeographicCoordinateSystemChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyGeographicCoordinateSystemChanged", db.geographicCoordinateSystem?.toJSON()));
     }
     /** Returns true if this is a BriefcaseDb
      * @see [[BriefcaseDb.open]]
@@ -271,8 +268,7 @@ class IModelDb extends core_common_1.IModel {
      * @public
      */
     withPreparedStatement(ecsql, callback, logErrors = true) {
-        var _a;
-        const stmt = (_a = this._statementCache.findAndRemove(ecsql)) !== null && _a !== void 0 ? _a : this.prepareStatement(ecsql, logErrors);
+        const stmt = this._statementCache.findAndRemove(ecsql) ?? this.prepareStatement(ecsql, logErrors);
         const release = () => this._statementCache.addOrDispose(stmt);
         try {
             const val = callback(stmt);
@@ -410,8 +406,7 @@ class IModelDb extends core_common_1.IModel {
      * @public
      */
     withPreparedSqliteStatement(sql, callback, logErrors = true) {
-        var _a;
-        const stmt = (_a = this._sqliteStatementCache.findAndRemove(sql)) !== null && _a !== void 0 ? _a : this.prepareSqliteStatement(sql, logErrors);
+        const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql, logErrors);
         const release = () => this._sqliteStatementCache.addOrDispose(stmt);
         try {
             const val = callback(stmt);
@@ -548,8 +543,8 @@ class IModelDb extends core_common_1.IModel {
      * @note This method does not modify the IModel's stored project extents. @see [[updateProjectExtents]].
      */
     computeProjectExtents(options) {
-        const wantFullExtents = true === (options === null || options === void 0 ? void 0 : options.reportExtentsWithOutliers);
-        const wantOutliers = true === (options === null || options === void 0 ? void 0 : options.reportOutliers);
+        const wantFullExtents = true === options?.reportExtentsWithOutliers;
+        const wantOutliers = true === options?.reportOutliers;
         const result = this.nativeDb.computeProjectExtents(wantFullExtents, wantOutliers);
         return {
             extents: core_geometry_1.Range3d.fromJSON(result.extents),
@@ -611,20 +606,20 @@ class IModelDb extends core_common_1.IModel {
      * This method is asynchronous (must be awaited) because, in the case where this IModelDb is a briefcase, this method first obtains the schema lock from the iModel server.
      * You must import a schema into an iModel before you can insert instances of the classes in that schema. See [[Element]]
      * @param schemaFileName  array of Full paths to ECSchema.xml files to be imported.
+     * @param {SchemaImportOptions} options - options during schema import.
      * @throws [[IModelError]] if the schema lock cannot be obtained or there is a problem importing the schema.
      * @note Changes are saved if importSchemas is successful and abandoned if not successful.
      * @see querySchemaVersion
      */
-    async importSchemas(schemaFileNames) {
-        if (this.isSnapshot || this.isStandalone) {
-            const status = this.nativeDb.importSchemas(schemaFileNames);
-            if (core_bentley_1.DbResult.BE_SQLITE_OK !== status)
-                throw new core_common_1.IModelError(status, "Error importing schema");
-            this.clearCaches();
-            return;
-        }
-        await this.acquireSchemaLock();
-        const stat = this.nativeDb.importSchemas(schemaFileNames);
+    async importSchemas(schemaFileNames, options) {
+        if (this.nativeDb.getITwinId() !== core_bentley_1.Guid.empty) // if this iModel is associated with an iTwin, importing schema requires the schema lock
+            await this.acquireSchemaLock();
+        const maybeCustomNativeContext = options?.ecSchemaXmlContext?.nativeContext;
+        const nativeImportOptions = {
+            schemaLockHeld: true,
+            ecSchemaXmlContext: maybeCustomNativeContext,
+        };
+        const stat = this.nativeDb.importSchemas(schemaFileNames, nativeImportOptions);
         if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat) {
             throw new core_common_1.IModelError(stat, "Error importing schema");
         }
@@ -640,16 +635,9 @@ class IModelDb extends core_common_1.IModel {
      * @alpha
      */
     async importSchemaStrings(serializedXmlSchemas) {
-        if (this.isSnapshot || this.isStandalone) {
-            const status = this.nativeDb.importXmlSchemas(serializedXmlSchemas);
-            if (core_bentley_1.DbResult.BE_SQLITE_OK !== status) {
-                throw new core_common_1.IModelError(status, "Error importing schema");
-            }
-            this.clearCaches();
-            return;
-        }
-        await this.acquireSchemaLock();
-        const stat = this.nativeDb.importXmlSchemas(serializedXmlSchemas);
+        if (this.iTwinId && this.iTwinId !== core_bentley_1.Guid.empty) // if this iModel is associated with an iTwin, importing schema requires the schema lock
+            await this.acquireSchemaLock();
+        const stat = this.nativeDb.importXmlSchemas(serializedXmlSchemas, { schemaLockHeld: true });
         if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat)
             throw new core_common_1.IModelError(stat, "Error importing schema");
         this.clearCaches();
@@ -683,16 +671,15 @@ class IModelDb extends core_common_1.IModel {
     }
     /** @internal */
     static openDgnDb(file, openMode, upgradeOptions, props) {
-        var _a;
-        file.key = (_a = file.key) !== null && _a !== void 0 ? _a : core_bentley_1.Guid.createValue();
+        file.key = file.key ?? core_bentley_1.Guid.createValue();
         if (this.tryFindByKey(file.key))
             throw new core_common_1.IModelError(core_bentley_1.IModelStatus.AlreadyOpen, `key [${file.key}] for file [${file.path}] is already in use`);
-        const isUpgradeRequested = (upgradeOptions === null || upgradeOptions === void 0 ? void 0 : upgradeOptions.domain) === core_common_1.DomainOptions.Upgrade || (upgradeOptions === null || upgradeOptions === void 0 ? void 0 : upgradeOptions.profile) === core_common_1.ProfileOptions.Upgrade;
+        const isUpgradeRequested = upgradeOptions?.domain === core_common_1.DomainOptions.Upgrade || upgradeOptions?.profile === core_common_1.ProfileOptions.Upgrade;
         if (isUpgradeRequested && openMode !== core_bentley_1.OpenMode.ReadWrite)
             throw new core_common_1.IModelError(core_bentley_1.IModelStatus.UpgradeFailed, "Cannot upgrade a Readonly Db");
         try {
             const nativeDb = new IModelHost_1.IModelHost.platform.DgnDb();
-            nativeDb.openIModel(file.path, openMode, upgradeOptions, props, props === null || props === void 0 ? void 0 : props.container);
+            nativeDb.openIModel(file.path, openMode, upgradeOptions, props, props?.container);
             return nativeDb;
         }
         catch (err) {
@@ -1218,7 +1205,7 @@ IModelDb._settingPropNamespace = "settings";
          */
         tryGetSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.tryGetElementProps(modeledElementId);
-            if (undefined === (modeledElementProps === null || modeledElementProps === void 0 ? void 0 : modeledElementProps.id) || (core_common_1.IModel.rootSubjectId === modeledElementProps.id))
+            if (undefined === modeledElementProps?.id || (core_common_1.IModel.rootSubjectId === modeledElementProps.id))
                 return undefined;
             return this.tryGetModel(modeledElementProps.id, modelClass);
         }
@@ -1790,7 +1777,7 @@ IModelDb._settingPropNamespace = "settings";
             const categorySelectorProps = elements.getElementProps(viewDefinitionProps.categorySelectorId);
             const displayStyleProps = elements.getElementProps({
                 id: viewDefinitionProps.displayStyleId,
-                displayStyle: options === null || options === void 0 ? void 0 : options.displayStyle,
+                displayStyle: options?.displayStyle,
             });
             const viewStateData = {
                 viewDefinitionProps,
@@ -1996,7 +1983,7 @@ class BriefcaseDb extends IModelDb {
     }
     static tryFindByKey(key) {
         const db = super.tryFindByKey(key);
-        return (db === null || db === void 0 ? void 0 : db.isBriefcaseDb()) ? db : undefined;
+        return db?.isBriefcaseDb() ? db : undefined;
     }
     /**
      * The Guid that identifies the *context* that owns this iModel.
@@ -2041,8 +2028,8 @@ class BriefcaseDb extends IModelDb {
         // good thing computers are fast. Fortunately upgrading should be rare (and the push time will dominate anyway.) Don't try to optimize any of this away.
         await withBriefcaseDb(briefcase, async (db) => db.acquireSchemaLock()); // may not really acquire lock if iModel uses "noLocks" mode.
         try {
-            await this.doUpgrade(briefcase, { profile: core_common_1.ProfileOptions.Upgrade }, "Upgraded profile");
-            await this.doUpgrade(briefcase, { domain: core_common_1.DomainOptions.Upgrade }, "Upgraded domain schemas");
+            await this.doUpgrade(briefcase, { profile: core_common_1.ProfileOptions.Upgrade, schemaLockHeld: true }, "Upgraded profile");
+            await this.doUpgrade(briefcase, { domain: core_common_1.DomainOptions.Upgrade, schemaLockHeld: true }, "Upgraded domain schemas");
         }
         finally {
             await withBriefcaseDb(briefcase, async (db) => db.locks.releaseAllLocks());
@@ -2052,12 +2039,11 @@ class BriefcaseDb extends IModelDb {
      * @param args parameters that specify the file name, and options for opening the briefcase file
      */
     static async open(args) {
-        var _a;
         this.onOpen.raiseEvent(args);
         const file = { path: args.fileName, key: args.key };
         const openMode = args.readonly ? core_bentley_1.OpenMode.Readonly : core_bentley_1.OpenMode.ReadWrite;
         const nativeDb = this.openDgnDb(file, openMode, undefined, args);
-        const briefcaseDb = new BriefcaseDb({ nativeDb, key: (_a = file.key) !== null && _a !== void 0 ? _a : core_bentley_1.Guid.createValue(), openMode, briefcaseId: nativeDb.getBriefcaseId() });
+        const briefcaseDb = new BriefcaseDb({ nativeDb, key: file.key ?? core_bentley_1.Guid.createValue(), openMode, briefcaseId: nativeDb.getBriefcaseId() });
         if (openMode === core_bentley_1.OpenMode.ReadWrite && CodeService_1.CodeService.createForIModel) {
             try {
                 const codeService = CodeService_1.CodeService.createForIModel(briefcaseDb);
@@ -2083,7 +2069,7 @@ class BriefcaseDb extends IModelDb {
         if (this.isReadonly) // we allow pulling changes into a briefcase that is readonly - close and reopen it writeable
             this.closeAndReopen(core_bentley_1.OpenMode.ReadWrite);
         try {
-            await BriefcaseManager_1.BriefcaseManager.pullAndApplyChangesets(this, arg !== null && arg !== void 0 ? arg : {});
+            await BriefcaseManager_1.BriefcaseManager.pullAndApplyChangesets(this, arg ?? {});
             this.initializeIModelDb();
         }
         finally {
@@ -2135,7 +2121,7 @@ class RefreshV2CheckpointSas {
     constructor(sasToken, safetySeconds) {
         /** the time at which the current token should be refreshed (its expiry minus safetySeconds) */
         this._timestamp = 0;
-        this._safetySeconds = safetySeconds !== null && safetySeconds !== void 0 ? safetySeconds : 60 * 60; // default to 1 hour
+        this._safetySeconds = safetySeconds ?? 60 * 60; // default to 1 hour
         this.setTimestamp(sasToken);
     }
     async performRefresh(accessToken, iModel) {
@@ -2190,7 +2176,7 @@ class SnapshotDb extends IModelDb {
     }
     static tryFindByKey(key) {
         const db = super.tryFindByKey(key);
-        return (db === null || db === void 0 ? void 0 : db.isSnapshotDb()) ? db : undefined;
+        return db?.isSnapshotDb() ? db : undefined;
     }
     /** Create an *empty* local [Snapshot]($docs/learning/backend/AccessingIModels.md#snapshot-imodels) iModel file.
      * Snapshots are not synchronized with iModelHub, so do not have a change timeline.
@@ -2232,7 +2218,7 @@ class SnapshotDb extends IModelDb {
         nativeDb.deleteAllTxns();
         nativeDb.resetBriefcaseId(core_common_1.BriefcaseIdValue.Unassigned);
         const snapshotDb = new SnapshotDb(nativeDb, core_bentley_1.Guid.createValue());
-        if (options === null || options === void 0 ? void 0 : options.createClassViews)
+        if (options?.createClassViews)
             snapshotDb._createClassViewsOnClose = true; // save flag that will be checked when close() is called
         return snapshotDb;
     }
@@ -2240,7 +2226,7 @@ class SnapshotDb extends IModelDb {
      * @internal
      */
     static openForApplyChangesets(path, props) {
-        const file = { path, key: props === null || props === void 0 ? void 0 : props.key };
+        const file = { path, key: props?.key };
         const nativeDb = this.openDgnDb(file, core_bentley_1.OpenMode.ReadWrite, undefined, props);
         (0, core_bentley_1.assert)(undefined !== file.key);
         return new SnapshotDb(nativeDb, file.key);
@@ -2252,7 +2238,7 @@ class SnapshotDb extends IModelDb {
      * @throws [[IModelError]] If the file is not found or is not a valid *snapshot*.
      */
     static openFile(path, opts) {
-        const file = { path, key: opts === null || opts === void 0 ? void 0 : opts.key };
+        const file = { path, key: opts?.key };
         const nativeDb = this.openDgnDb(file, core_bentley_1.OpenMode.Readonly, undefined, opts);
         (0, core_bentley_1.assert)(undefined !== file.key);
         return new SnapshotDb(nativeDb, file.key);
@@ -2297,8 +2283,7 @@ class SnapshotDb extends IModelDb {
      * @internal
      */
     async refreshContainerSas(userAccessToken) {
-        var _a;
-        return (_a = this._refreshSas) === null || _a === void 0 ? void 0 : _a.refreshSas(userAccessToken, this);
+        return this._refreshSas?.refreshSas(userAccessToken, this);
     }
     /** @internal */
     beforeClose() {
@@ -2339,7 +2324,7 @@ class StandaloneDb extends BriefcaseDb {
     }
     static tryFindByKey(key) {
         const db = super.tryFindByKey(key);
-        return (db === null || db === void 0 ? void 0 : db.isStandaloneDb()) ? db : undefined;
+        return db?.isStandaloneDb() ? db : undefined;
     }
     /** Create an *empty* standalone iModel.
      * @param filePath The file path for the iModel
@@ -2362,9 +2347,9 @@ class StandaloneDb extends BriefcaseDb {
      * @see [[StandaloneDb.validateSchemas]]
      */
     static upgradeStandaloneSchemas(filePath) {
-        let nativeDb = this.openDgnDb({ path: filePath }, core_bentley_1.OpenMode.ReadWrite, { profile: core_common_1.ProfileOptions.Upgrade });
+        let nativeDb = this.openDgnDb({ path: filePath }, core_bentley_1.OpenMode.ReadWrite, { profile: core_common_1.ProfileOptions.Upgrade, schemaLockHeld: true });
         nativeDb.closeIModel();
-        nativeDb = this.openDgnDb({ path: filePath }, core_bentley_1.OpenMode.ReadWrite, { domain: core_common_1.DomainOptions.Upgrade });
+        nativeDb = this.openDgnDb({ path: filePath }, core_bentley_1.OpenMode.ReadWrite, { domain: core_common_1.DomainOptions.Upgrade, schemaLockHeld: true });
         nativeDb.closeIModel();
     }
     /** Open a standalone iModel file.
@@ -2374,7 +2359,7 @@ class StandaloneDb extends BriefcaseDb {
      * @see [BriefcaseConnection.openStandalone]($frontend) to open a StandaloneDb from the frontend
      */
     static openFile(filePath, openMode = core_bentley_1.OpenMode.ReadWrite, options) {
-        const file = { path: filePath, key: options === null || options === void 0 ? void 0 : options.key };
+        const file = { path: filePath, key: options?.key };
         const nativeDb = this.openDgnDb(file, openMode, undefined, options);
         try {
             const iTwinId = nativeDb.getITwinId();