@itwin/core-backend 3.0.0-extension.0 → 3.1.0-dev.11

package/lib/cjs/IModelDb.js

@@ -19,7 +19,6 @@ const ClassRegistry_1 = require("./ClassRegistry");
 const CodeSpecs_1 = require("./CodeSpecs");
 const ConcurrentQuery_1 = require("./ConcurrentQuery");
 const ECSqlStatement_1 = require("./ECSqlStatement");
-const Element_1 = require("./Element");
 const ElementAspect_1 = require("./ElementAspect");
 const ElementGraphics_1 = require("./ElementGraphics");
 const IModelHost_1 = require("./IModelHost");
@@ -31,6 +30,8 @@ const ServerBasedLocks_1 = require("./ServerBasedLocks");
 const SqliteStatement_1 = require("./SqliteStatement");
 const TxnManager_1 = require("./TxnManager");
 const ViewDefinition_1 = require("./ViewDefinition");
+const Settings_1 = require("./workspace/Settings");
+const Workspace_1 = require("./workspace/Workspace");
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelDb;
 /** A null-implementation of LockControl that does not attempt to limit access between briefcases. This relies on change-merging to resolve conflicts. */
 class NoLocks {
@@ -42,8 +43,7 @@ class NoLocks {
     checkExclusiveLock() { }
     checkSharedLock() { }
     elementWasCreated() { }
-    async acquireExclusiveLock() { }
-    async acquireSharedLock() { }
+    async acquireLocks() { }
     async releaseAllLocks() { }
 }
 /** @internal */
@@ -62,6 +62,21 @@ const withBriefcaseDb = async (briefcase, fn) => {
         db.close();
     }
 };
+/**
+ * Settings for an individual iModel. May only include settings priority for iModel, iTwin and organization.
+ * @note if there is more than one iModel for an iTwin or organization, they will *each* hold a copy of the settings for those priorities.
+ */
+class IModelSettings extends Settings_1.BaseSettings {
+    verifyPriority(priority) {
+        if (priority <= Settings_1.SettingsPriority.application)
+            throw new Error("Use IModelHost.appSettings");
+    }
+    // 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);
+    }
+}
 /** An iModel database file. The database file can either be a briefcase or a snapshot.
  * @see [Accessing iModels]($docs/learning/backend/AccessingIModels.md)
  * @see [About IModelDb]($docs/learning/backend/IModelDb.md)
@@ -78,7 +93,6 @@ class IModelDb extends core_common_1.IModel {
         this.tiles = new IModelDb.Tiles(this);
         this._statementCache = new SqliteStatement_1.StatementCache();
         this._sqliteStatementCache = new SqliteStatement_1.StatementCache();
-        this._concurrentQueryStats = { resetTimerHandle: null, logTimerHandle: null, lastActivityTime: Date.now(), dispose: () => { } };
         this._snaps = new Map();
         /** @internal */
         this._locks = new NoLocks();
@@ -90,6 +104,8 @@ class IModelDb extends core_common_1.IModel {
         this.nativeDb.setIModelDb(this);
         this.initializeIModelDb();
         IModelDb._openDbs.set(this._fileKey, this);
+        this._workspace = new Workspace_1.ITwinWorkspace(new IModelSettings(), IModelHost_1.IModelHost.appWorkspace);
+        this.loadSettingDictionaries();
         if (undefined === IModelDb._shutdownListener) { // the first time we create an IModelDb, add a listener to close any orphan files at shutdown.
             IModelDb._shutdownListener = IModelHost_1.IModelHost.onBeforeShutdown.addListener(() => {
                 IModelDb._openDbs.forEach((db) => {
@@ -103,16 +119,21 @@ class IModelDb extends core_common_1.IModel {
         }
     }
     /**
-     * Get the lock control for this iModel.
+     * Get the [[LockControl]] for this iModel.
      * @beta
      */
-    get locks() { return this._locks; }
+    get locks() { return this._locks; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    /**
+     * Get the [[Workspace]] for this iModel.
+     * @beta
+     */
+    get workspace() { return this._workspace; }
     /** Acquire the exclusive schema lock on this iModel.
      * > Note: To acquire the schema lock, all other briefcases must first release *all* their locks. No other briefcases
      * will be able to acquire *any* locks while the schema lock is held.
      */
     async acquireSchemaLock() {
-        return this.locks.acquireExclusiveLock(core_common_1.IModel.repositoryModelId);
+        return this.locks.acquireLocks({ exclusive: core_common_1.IModel.repositoryModelId });
     }
     /** determine whether the schema lock is currently held for this iModel. */
     get holdsSchemaLock() {
@@ -124,13 +145,17 @@ 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())); }
+    /** @internal */
     embedFont(prop) { this._fontMap = undefined; return this.nativeDb.embedFont(prop); }
     /** Check if this iModel has been opened read-only or not. */
     get isReadonly() { return this.openMode === core_bentley_1.OpenMode.Readonly; }
     /** The Guid that identifies this iModel. */
-    get iModelId() { return super.iModelId; } // GuidString | undefined for the IModel superclass, but required for all IModelDb subclasses
+    get iModelId() {
+        (0, core_bentley_1.assert)(undefined !== super.iModelId);
+        return super.iModelId;
+    } // GuidString | undefined for the IModel superclass, but required for all IModelDb subclasses
     /** @internal*/
-    get nativeDb() { return this._nativeDb; }
+    get nativeDb() { return this._nativeDb; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
     /** Get the full path fileName of this iModelDb
      * @note this member is only valid while the iModel is opened.
      */
@@ -141,6 +166,7 @@ class IModelDb extends core_common_1.IModel {
             return; // don't continue if already closed
         this.beforeClose();
         IModelDb._openDbs.delete(this._fileKey);
+        this._workspace.close();
         this.locks.close();
         this._locks = undefined;
         this.nativeDb.closeIModel();
@@ -155,7 +181,6 @@ class IModelDb extends core_common_1.IModel {
     beforeClose() {
         this.onBeforeClose.raiseEvent();
         this.clearCaches();
-        this._concurrentQueryStats.dispose();
     }
     /** @internal */
     initializeIModelDb() {
@@ -274,7 +299,7 @@ class IModelDb extends core_common_1.IModel {
         }
         const executor = {
             execute: async (request) => {
-                return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this._nativeDb, request);
+                return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this.nativeDb, request);
             },
         };
         return new core_common_1.ECSqlReader(executor, ecsql, params, config);
@@ -289,20 +314,16 @@ class IModelDb extends core_common_1.IModel {
      *
      * @param ecsql The ECSQL statement to execute
      * @param params The values to bind to the parameters (if the ECSQL has any).
-     * @param rowFormat Specify what format the row will be returned. It default to Array format though to make it compilable with previous version use *QueryRowFormat.UseJsPropertyNames*
      * @param options Allow to specify certain flags which control how query is executed.
      * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.
      * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.
      * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query
      */
-    async *query(ecsql, params, rowFormat = core_common_1.QueryRowFormat.UseArrayIndexes, options) {
+    async *query(ecsql, params, options) {
         const builder = new core_common_1.QueryOptionsBuilder(options);
-        if (rowFormat === core_common_1.QueryRowFormat.UseJsPropertyNames) {
-            builder.setConvertClassIdsToNames(true);
-        }
         const reader = this.createQueryReader(ecsql, params, builder.getOptions());
         while (await reader.step())
-            yield reader.formatCurrentRow(rowFormat);
+            yield reader.formatCurrentRow();
     }
     /** Compute number of rows that would be returned by the ECSQL.
      *
@@ -312,7 +333,7 @@ class IModelDb extends core_common_1.IModel {
      *
      * @param ecsql The ECSQL statement to execute
      * @param params The values to bind to the parameters (if the ECSQL has any).
-     * See "[iModel.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" for details.
+     * See "[iTwin.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" for details.
      * @returns Return row count.
      * @throws [IModelError]($common) If the statement is invalid
      */
@@ -334,14 +355,13 @@ class IModelDb extends core_common_1.IModel {
      * @param token None empty restart token. The previous query with same token would be cancelled. This would cause
      * exception which user code must handle.
      * @param params The values to bind to the parameters (if the ECSQL has any).
-     * @param rowFormat Specify what format the row will be returned. It default to Array format though to make it compilable with previous version use *QueryRowFormat.UseJsPropertyNames*
      * @param options Allow to specify certain flags which control how query is executed.
      * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.
      * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.
      * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query
      */
-    async *restartQuery(token, ecsql, params, rowFormat = core_common_1.QueryRowFormat.UseArrayIndexes, options) {
-        for await (const row of this.query(ecsql, params, rowFormat, new core_common_1.QueryOptionsBuilder(options).setRestartToken(token).getOptions())) {
+    async *restartQuery(token, ecsql, params, options) {
+        for await (const row of this.query(ecsql, params, new core_common_1.QueryOptionsBuilder(options).setRestartToken(token).getOptions())) {
             yield row;
         }
     }
@@ -762,6 +782,7 @@ class IModelDb extends core_common_1.IModel {
         const val = this.nativeDb.getECClassMetaData(className[0], className[1]);
         if (val.error)
             throw new core_common_1.IModelError(val.error.status, `Error getting class meta data for: ${classFullName}`);
+        (0, core_bentley_1.assert)(undefined !== val.result);
         const metaData = new core_common_1.EntityMetaData(JSON.parse(val.result));
         this.classMetaDataRegistry.add(classFullName, metaData);
         // Recursive, to make sure that base classes are cached.
@@ -917,7 +938,7 @@ class IModelDb extends core_common_1.IModel {
      * that list.
      *  * The results of changing [ExportPartGraphicsOptions]($core-backend) during the
      *    [ExportPartGraphicsOptions.onPartGraphics]($core-backend) callback are not defined.
-     *  * See export-gltf under test-apps in the iModel.js monorepo for a working reference.
+     *  * See export-gltf under test-apps in the iTwin.js monorepo for a working reference.
      * @returns 0 is successful, status otherwise
      * @public
      */
@@ -931,17 +952,9 @@ class IModelDb extends core_common_1.IModel {
     elementGeometryRequest(requestProps) {
         return this.nativeDb.processGeometryStream(requestProps);
     }
-    /** Update the geometry stream for the supplied element from binary format data instead of json.
-     * @returns DbResult.BE_SQLITE_OK if successful
-     * @alpha
-     */
-    elementGeometryUpdate(updateProps) {
-        return this.nativeDb.updateGeometryStream(updateProps);
-    }
     /** Create brep geometry for inclusion in an element's geometry stream.
      * @returns DbResult.BE_SQLITE_OK if successful
      * @throws [[IModelError]] to report issues with input geometry or parameters
-     * @see [IModelDb.elementGeometryUpdate]($core-backend)
      * @alpha
      */
     createBRepGeometry(createProps) {
@@ -953,12 +966,61 @@ class IModelDb extends core_common_1.IModel {
     async generateElementGraphics(request) {
         return (0, ElementGraphics_1.generateElementGraphics)(request, this);
     }
+    /** Save a `SettingDictionary` in this iModel that will be loaded into [[workspace.settings]] every time this iModel is opened in future sessions.
+     * @param name The name for the SettingDictionary. If a dictionary by that name already exists in the iModel, its value is replaced.
+     * @param dict The SettingDictionary object to stringify and save.
+     * @note All saved `SettingDictionary`s are loaded into [[workspace.settings]] every time an iModel is opened.
+     * @beta
+     */
+    saveSettingDictionary(name, dict) {
+        this.withSqliteStatement("REPLACE INTO be_Prop(id,SubId,TxnMode,Namespace,Name,strData) VALUES(0,0,0,?,?,?)", (stmt) => {
+            stmt.bindString(1, IModelDb._settingPropNamespace);
+            stmt.bindString(2, name);
+            stmt.bindString(3, JSON.stringify(dict));
+            const rc = stmt.step();
+            if (rc !== core_bentley_1.DbResult.BE_SQLITE_DONE)
+                throw new core_common_1.IModelError(rc, "cannot save setting");
+        });
+        this.saveChanges("add settings");
+    }
+    /** Delete a SettingDictionary, previously added with [[saveSettingDictionary]], from this iModel.
+     * @param name The name of the dictionary to delete.
+     * @beta
+     */
+    deleteSettingDictionary(name) {
+        this.withSqliteStatement("DELETE FROM be_Prop WHERE Namespace=? AND Name=?", (stmt) => {
+            stmt.bindString(1, IModelDb._settingPropNamespace);
+            stmt.bindString(2, name);
+            const rc = stmt.step();
+            if (rc !== core_bentley_1.DbResult.BE_SQLITE_DONE)
+                throw new core_common_1.IModelError(rc, "cannot delete setting");
+        });
+        this.saveChanges("delete settings");
+    }
+    /** Load all setting dictionaries in this iModel into `this.workspace.settings` */
+    loadSettingDictionaries() {
+        if (!this.nativeDb.isOpen())
+            return;
+        this.withSqliteStatement("SELECT Name,StrData FROM be_Prop WHERE Namespace=?", (stmt) => {
+            stmt.bindString(1, IModelDb._settingPropNamespace);
+            while (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW) {
+                try {
+                    const dict = JSON.parse(stmt.getValueString(1));
+                    this.workspace.settings.addDictionary(stmt.getValueString(0), Settings_1.SettingsPriority.iModel, dict);
+                }
+                catch (e) {
+                    core_bentley_1.UnexpectedErrors.handle(e);
+                }
+            }
+        });
+    }
 }
 exports.IModelDb = IModelDb;
 /** Keep track of open imodels to support `tryFind` for RPC purposes */
 IModelDb._openDbs = new Map();
 IModelDb.defaultLimit = 1000; // default limit for batching queries
 IModelDb.maxLimit = 10000; // maximum limit for batching queries
+IModelDb._settingPropNamespace = "settings";
 /** @public */
 (function (IModelDb) {
     /** The collection of models in an [[IModelDb]].
@@ -1023,13 +1085,11 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         tryGetModel(modelId, modelClass) {
             const modelProps = this.tryGetModelProps(modelId);
-            if (undefined === modelProps) {
+            if (undefined === modelProps)
                 return undefined; // no Model with that modelId found
-            }
             const model = this._iModel.constructEntity(modelProps);
-            if (undefined === modelClass) {
+            if (undefined === modelClass)
                 return model; // modelClass was not specified, cannot call instanceof to validate
-            }
             return model instanceof modelClass ? model : undefined;
         }
         /** Read the properties for a Model as a json string.
@@ -1068,7 +1128,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         getSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.getElementProps(modeledElementId);
-            if (modeledElementProps.id === core_common_1.IModel.rootSubjectId)
+            if (undefined === modeledElementProps.id || modeledElementProps.id === core_common_1.IModel.rootSubjectId)
                 throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "Root subject does not have a sub-model");
             return this.getModel(modeledElementProps.id, modelClass);
         }
@@ -1081,7 +1141,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         tryGetSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.tryGetElementProps(modeledElementId);
-            if ((undefined === modeledElementProps) || (core_common_1.IModel.rootSubjectId === modeledElementProps.id))
+            if (undefined === (modeledElementProps === null || modeledElementProps === void 0 ? void 0 : modeledElementProps.id) || (core_common_1.IModel.rootSubjectId === modeledElementProps.id))
                 return undefined;
             return this.tryGetModel(modeledElementProps.id, modelClass);
         }
@@ -1098,7 +1158,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         insertModel(props) {
             try {
-                return props.id = this._iModel.nativeDb.insertModel(props instanceof Model_1.Model ? props.toJSON() : props);
+                return props.id = this._iModel.nativeDb.insertModel(props);
             }
             catch (err) {
                 throw new core_common_1.IModelError(err.errorNumber, `Error inserting model [${err.message}], class=${props.classFullName}`);
@@ -1110,7 +1170,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         updateModel(props) {
             try {
-                this._iModel.nativeDb.updateModel(props instanceof Model_1.Model ? props.toJSON() : props);
+                this._iModel.nativeDb.updateModel(props);
             }
             catch (err) {
                 throw new core_common_1.IModelError(err.errorNumber, `error updating model [${err.message}] id=${props.id}`);
@@ -1227,20 +1287,16 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          * @see getElement
          */
         tryGetElement(elementId, elementClass) {
-            if (typeof elementId === "string") {
+            if (typeof elementId === "string")
                 elementId = core_bentley_1.Id64.isId64(elementId) ? { id: elementId } : { federationGuid: elementId };
-            }
-            else if (elementId instanceof core_common_1.Code) {
+            else if (elementId instanceof core_common_1.Code)
                 elementId = { code: elementId };
-            }
             const elementProps = this.tryGetElementJson(elementId);
-            if (undefined === elementProps) {
+            if (undefined === elementProps)
                 return undefined; // no Element with that elementId found
-            }
             const element = this._iModel.constructEntity(elementProps);
-            if (undefined === elementClass) {
+            if (undefined === elementClass)
                 return element; // elementClass was not specified, cannot call instanceof to validate
-            }
             return element instanceof elementClass ? element : undefined;
         }
         /** Query for the Id of the element that has a specified code.
@@ -1292,7 +1348,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         insertElement(elProps) {
             try {
-                return elProps.id = this._iModel.nativeDb.insertElement(elProps instanceof Element_1.Element ? elProps.toJSON() : elProps);
+                return elProps.id = this._iModel.nativeDb.insertElement(elProps);
             }
             catch (err) {
                 throw new core_common_1.IModelError(err.errorNumber, `insertElement with class=${elProps.classFullName}: ${err.message}`);
@@ -1307,7 +1363,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
          */
         updateElement(elProps) {
             try {
-                this._iModel.nativeDb.updateElement(elProps instanceof Element_1.Element ? elProps.toJSON() : elProps);
+                this._iModel.nativeDb.updateElement(elProps);
             }
             catch (err) {
                 throw new core_common_1.IModelError(err.errorNumber, `Error updating element [${err.message}], id:${elProps.id}`);
@@ -1760,6 +1816,7 @@ IModelDb.maxLimit = 10000; // maximum limit for batching queries
             if (undefined !== ret.error) {
                 throw new core_common_1.IModelError(ret.error.status, `TreeId=${treeId} TileId=${tileId}`);
             }
+            (0, core_bentley_1.assert)(undefined !== ret.result);
             return ret.result;
         }
     }
@@ -1789,8 +1846,11 @@ class BriefcaseDb extends IModelDb {
         const db = super.tryFindByKey(key);
         return (db === null || db === void 0 ? void 0 : db.isBriefcaseDb()) ? db : undefined;
     }
-    /** The Guid that identifies the *context* that owns this iModel. */
-    get iTwinId() { return super.iTwinId; } // GuidString | undefined for the superclass, but required for BriefcaseDb
+    /**
+     * The Guid that identifies the *context* that owns this iModel.
+     * GuidString | undefined for the superclass, but required for BriefcaseDb
+     * */
+    get iTwinId() { return super.iTwinId; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
     /**
      * Determine whether this BriefcaseDb should use a lock server.
      * All must be true:
@@ -1919,6 +1979,7 @@ class DaemonReattach {
         core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.BackendLoggerCategory.Authorization, "attempting to reattach checkpoint");
         try {
             // this exchanges the supplied user accessToken for an expiring blob-store token to read the checkpoint.
+            (0, core_bentley_1.assert)(undefined !== iModel.iTwinId);
             const response = await CheckpointManager_1.V2CheckpointManager.attach({ accessToken, iTwinId: iModel.iTwinId, iModelId: iModel.iModelId, changeset: iModel.changeset });
             core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.BackendLoggerCategory.Authorization, "reattached checkpoint successfully");
             this.setTimestamp(response.expiryTimestamp);
@@ -2012,6 +2073,7 @@ class SnapshotDb extends IModelDb {
     static openForApplyChangesets(path, props) {
         const file = { path, key: props === null || props === void 0 ? void 0 : 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);
     }
     /** Open a read-only iModel *snapshot*.
@@ -2023,6 +2085,7 @@ class SnapshotDb extends IModelDb {
     static openFile(path, opts) {
         const file = { path, key: opts === null || opts === void 0 ? void 0 : 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);
     }
     /** Open a previously downloaded V1 checkpoint file.
@@ -2149,6 +2212,7 @@ class StandaloneDb extends BriefcaseDb {
             const iTwinId = nativeDb.getITwinId();
             if (iTwinId !== core_bentley_1.Guid.empty) // a "standalone" iModel means it is not associated with an iTwin
                 throw new core_common_1.IModelError(core_bentley_1.IModelStatus.WrongIModel, `${filePath} is not a Standalone iModel. iTwinId=${iTwinId}`);
+            (0, core_bentley_1.assert)(undefined !== file.key);
             return new StandaloneDb({ nativeDb, key: file.key, openMode, briefcaseId: core_common_1.BriefcaseIdValue.Unassigned });
         }
         catch (error) {