@itwin/core-backend 5.0.0-dev.4 → 5.0.0-dev.40

package/lib/cjs/IModelDb.js

@@ -46,6 +46,7 @@ const WorkspaceImpl_1 = require("./internal/workspace/WorkspaceImpl");
 const SettingsImpl_1 = require("./internal/workspace/SettingsImpl");
 const NativePlatform_1 = require("./internal/NativePlatform");
 const NoLocks_1 = require("./internal/NoLocks");
+const IModelDbFontsImpl_1 = require("./internal/IModelDbFontsImpl");
 const Symbols_1 = require("./internal/Symbols");
 // spell:ignore fontid fontmap
 const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelDb;
@@ -85,10 +86,18 @@ class IModelSettings extends SettingsImpl_1.SettingsImpl {
  * @public
  */
 class IModelDb extends core_common_1.IModel {
+    /** Keep track of open imodels to support `tryFind` for RPC purposes */
+    static { this._openDbs = new Map(); }
+    static { this.defaultLimit = 1000; } // default limit for batching queries
+    static { this.maxLimit = 10000; } // maximum limit for batching queries
     /** @alpha */
     get codeService() { return this._codeService; }
     /** The [[LockControl]] that orchestrates [concurrent editing]($docs/learning/backend/ConcurrencyControl.md) of this iModel. */
     get locks() { return this._locks; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    /** Provides methods for interacting with [font-related information]($docs/learning/backend/Fonts.md) stored in this iModel.
+     * @beta
+     */
+    get fonts() { return this._fonts; }
     /**
      * Get the [[Workspace]] for this iModel.
      * @beta
@@ -118,25 +127,14 @@ class IModelDb extends core_common_1.IModel {
     restartDefaultTxn() {
         this[Symbols_1._nativeDb].restartDefaultTxn();
     }
+    /** @deprecated in 5.0.0. Use [[fonts]]. */
     get fontMap() {
-        return this._fontMap ?? (this._fontMap = new core_common_1.FontMap(this[Symbols_1._nativeDb].readFontMap()));
+        return this._fontMap ?? (this._fontMap = new core_common_1.FontMap(this[Symbols_1._nativeDb].readFontMap())); // eslint-disable-line @typescript-eslint/no-deprecated
     }
     /** @internal */
     clearFontMap() {
-        this._fontMap = undefined;
-    }
-    /**
-     * Add a new font name/type to the FontMap for this iModel and return its FontId.
-     * @param name The name of the font to add
-     * @param type The type of the font. Default is TrueType.
-     * @returns The FontId for the newly added font. If a font by that name/type already exists, this method does not fail, it returns the existing Id.
-     * @see [FontId and FontMap]($docs/learning/backend/Fonts.md#fontid-and-fontmap)
-     * @beta
-     */
-    addNewFont(name, type) {
-        this.locks.checkExclusiveLock(core_common_1.IModel.repositoryModelId, "schema", "addNewFont");
-        this.clearFontMap();
-        return this[Symbols_1._nativeDb].addNewFont({ name, type: type ?? core_common_1.FontType.TrueType });
+        this._fontMap = undefined; // eslint-disable-line @typescript-eslint/no-deprecated
+        this[Symbols_1._nativeDb].invalidateFontMap();
     }
     /** Check if this iModel has been opened read-only or not. */
     get isReadonly() { return this.openMode === core_bentley_1.OpenMode.Readonly; }
@@ -145,10 +143,6 @@ class IModelDb extends core_common_1.IModel {
         (0, core_bentley_1.assert)(undefined !== super.iModelId);
         return super.iModelId;
     } // GuidString | undefined for the IModel superclass, but required for all IModelDb subclasses
-    /** @internal
-     * @deprecated in 4.8. This internal API will be removed in 5.0. Use IModelDb's public API instead.
-     */
-    get nativeDb() { return this[Symbols_1._nativeDb]; }
     /** Get the full path fileName of this iModelDb
      * @note this member is only valid while the iModel is opened.
      */
@@ -173,6 +167,7 @@ class IModelDb extends core_common_1.IModel {
         this.channels = (0, ChannelAdmin_1.createChannelControl)(this);
         this._statementCache = new SqliteStatement_1.StatementCache();
         this._sqliteStatementCache = new SqliteStatement_1.StatementCache();
+        this._fonts = (0, IModelDbFontsImpl_1.createIModelDbFonts)(this);
         this._snaps = new Map();
         /** @internal */
         this._locks = (0, NoLocks_1.createNoOpLockControl)();
@@ -1192,6 +1187,7 @@ class IModelDb extends core_common_1.IModel {
     async generateElementGraphics(request) {
         return (0, ElementGraphics_1.generateElementGraphics)(request, this);
     }
+    static { this._settingPropNamespace = "settings"; }
     /** 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.
@@ -1284,13 +1280,54 @@ class IModelDb extends core_common_1.IModel {
             justification: core_geometry_1.Range2d.fromJSON(props.justification),
         };
     }
+    /** Writes the contents of a single ECSchema to a file on the local file system.
+     * @beta
+     */
+    exportSchema(args) {
+        processSchemaWriteStatus(this[Symbols_1._nativeDb].exportSchema(args.schemaName, args.outputDirectory, args.outputFileName));
+    }
+    /** Writes the contents of all ECSchemas in this iModel to files in a directory on the local file system.
+     * @beta
+     */
+    exportSchemas(outputDirectory) {
+        processSchemaWriteStatus(this[Symbols_1._nativeDb].exportSchemas(outputDirectory));
+    }
+    /** Attempt to simplify the geometry stream of a single [[GeometricElement]] or [[GeometryPart]] as specified by `args`.
+     * @beta
+     */
+    simplifyElementGeometry(args) {
+        return this[Symbols_1._nativeDb].simplifyElementGeometry(args);
+    }
+    /** Attempts to optimize all of the geometry in this iModel by identifying [[GeometryPart]]s that are referenced by exactly one
+     * element's geometry stream. Each such reference is replaced by inserting the part's geometry directly into the element's geometry stream.
+     * Then, the no-longer-used geometry part is deleted.
+     * This can improve performance when a connector inadvertently creates large numbers of parts that are each only used once.
+     * @beta
+     */
+    inlineGeometryParts() {
+        return this[Symbols_1._nativeDb].inlineGeometryPartReferences();
+    }
+    /** Returns a string representation of the error that most recently arose during an operation on the underlying SQLite database.
+     * If no errors have occurred, an empty string is returned.
+     * Otherwise, a string of the format `message (code)` is returned, where `message` is a human-readable diagnostic string and `code` is an integer status code.
+     * See [SQLite error codes and messages](https://www.sqlite.org/c3ref/errcode.html)
+     * @note Do not rely upon this value or its specific contents in error handling logic. It is only intended for use in debugging.
+     */
+    getLastError() {
+        return this[Symbols_1._nativeDb].getLastError();
+    }
 }
 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";
+function processSchemaWriteStatus(status) {
+    switch (status) {
+        case 0 /* SchemaWriteStatus.Success */: return;
+        case 1 /* SchemaWriteStatus.FailedToSaveXml */: throw new Error("Failed to save schema XML");
+        case 2 /* SchemaWriteStatus.FailedToCreateXml */: throw new Error("Failed to create schema XML");
+        case 3 /* SchemaWriteStatus.FailedToCreateJson */: throw new Error("Failed to create schema JSON");
+        case 4 /* SchemaWriteStatus.FailedToWriteFile */: throw new Error("Failed to write schema file");
+        default: throw new Error("Unknown error while exporting schema");
+    }
+}
 /** @public */
 (function (IModelDb) {
     /** The collection of models in an [[IModelDb]].
@@ -1671,9 +1708,9 @@ IModelDb._settingPropNamespace = "settings";
          * the value of `elProps.federationGuid` is *not* updated. Generally, it is best to re-read the element after inserting (e.g. via [[getElementProps]])
          * if you intend to continue working with it. That will ensure its values reflect the persistent state.
          */
-        insertElement(elProps) {
+        insertElement(elProps, options) {
             try {
-                return elProps.id = this._iModel[Symbols_1._nativeDb].insertElement(elProps);
+                return elProps.id = this._iModel[Symbols_1._nativeDb].insertElement(elProps, options);
             }
             catch (err) {
                 err.message = `Error inserting element [${err.message}]`;
@@ -1893,6 +1930,7 @@ IModelDb._settingPropNamespace = "settings";
             }
             return this._queryAspect(aspectInstanceId, aspectClassFullName);
         }
+        static { this.classMap = new Map(); }
         runInstanceQuery(sql, elementId, excludedClassFullNames) {
             return this._iModel.withPreparedStatement(sql, (statement) => {
                 statement.bindId("elementId", elementId);
@@ -2009,7 +2047,6 @@ IModelDb._settingPropNamespace = "settings";
             });
         }
     }
-    Elements.classMap = new Map();
     IModelDb.Elements = Elements;
     /** The collection of views in an [[IModelDb]].
      * @public
@@ -2019,6 +2056,7 @@ IModelDb._settingPropNamespace = "settings";
         constructor(_iModel) {
             this._iModel = _iModel;
         }
+        static { this.viewStoreProperty = { namespace: "itwinjs", name: "DefaultViewStore" }; }
         get hasViewStore() { return undefined !== this._viewStore; }
         /** @beta */
         get viewStore() {
@@ -2070,6 +2108,8 @@ IModelDb._settingPropNamespace = "settings";
             });
             return props;
         }
+        /** Default parameters for iterating/querying ViewDefinitions. Includes all subclasses of ViewDefinition, excluding only those marked 'private'. */
+        static { this.defaultQueryParams = { from: "BisCore.ViewDefinition", where: "IsPrivate=FALSE" }; }
         /** Iterate all ViewDefinitions matching the supplied query.
          * @param params Specifies the query by which views are selected.
          * @param callback Function invoked for each ViewDefinition matching the query. Return false to terminate iteration, true to continue.
@@ -2206,9 +2246,6 @@ IModelDb._settingPropNamespace = "settings";
             this._iModel.saveFileProperty(spec, undefined, blob8);
         }
     }
-    Views.viewStoreProperty = { namespace: "itwinjs", name: "DefaultViewStore" };
-    /** Default parameters for iterating/querying ViewDefinitions. Includes all subclasses of ViewDefinition, excluding only those marked 'private'. */
-    Views.defaultQueryParams = { from: "BisCore.ViewDefinition", where: "IsPrivate=FALSE" };
     IModelDb.Views = Views;
     /** Represents the current state of a pollable tile content request.
    * Note: lack of a "completed" state because polling a completed request returns the content as a Uint8Array.
@@ -2300,6 +2337,27 @@ class BriefcaseDb extends IModelDb {
     get isBriefcase() { return true; }
     /** @internal */
     get skipSyncSchemasOnPullAndPush() { return this._skipSyncSchemasOnPullAndPush ?? false; }
+    /**
+     * Event raised just before a BriefcaseDb is opened. Supplies the arguments that will be used to open the BriefcaseDb.
+     * Throw an exception to stop the open.
+     *
+     * **Example:**
+     * ``` ts
+     * [[include:BriefcaseDb.onOpen]]
+     * ```
+     */
+    static { this.onOpen = new core_bentley_1.BeEvent(); }
+    /**
+     * Event raised just after a BriefcaseDb is opened. Supplies the newly opened BriefcaseDb and the arguments that were used to open it.
+     *
+     * **Example:**
+     * ``` ts
+     * [[include:BriefcaseDb.onOpened]]
+     * ```
+     */
+    static { this.onOpened = new core_bentley_1.BeEvent(); }
+    /** @alpha */
+    static { this.onCodeServiceCreated = new core_bentley_1.BeEvent(); }
     static findByKey(key) {
         return super.findByKey(key);
     }
@@ -2748,32 +2806,14 @@ class BriefcaseDb extends IModelDb {
         this.txns.touchWatchFile();
     }
     close() {
+        if (this.isBriefcase && this.isOpen && !this.isReadonly && this.txns.changeMergeManager.inProgress()) {
+            this.abandonChanges();
+        }
         super.close();
         this.onClosed.raiseEvent();
     }
 }
 exports.BriefcaseDb = BriefcaseDb;
-/**
- * Event raised just before a BriefcaseDb is opened. Supplies the arguments that will be used to open the BriefcaseDb.
- * Throw an exception to stop the open.
- *
- * **Example:**
- * ``` ts
- * [[include:BriefcaseDb.onOpen]]
- * ```
- */
-BriefcaseDb.onOpen = new core_bentley_1.BeEvent();
-/**
- * Event raised just after a BriefcaseDb is opened. Supplies the newly opened BriefcaseDb and the arguments that were used to open it.
- *
- * **Example:**
- * ``` ts
- * [[include:BriefcaseDb.onOpened]]
- * ```
- */
-BriefcaseDb.onOpened = new core_bentley_1.BeEvent();
-/** @alpha */
-BriefcaseDb.onCodeServiceCreated = new core_bentley_1.BeEvent();
 /** Used to reattach Daemon from a user's accessToken for V2 checkpoints.
  * @note Reattach only happens if the previous access token either has expired or is about to expire within an application-supplied safety duration.
  */
@@ -2827,9 +2867,11 @@ class RefreshV2CheckpointSas {
  */
 class SnapshotDb extends IModelDb {
     get isSnapshot() { return true; }
+    static { this.onOpen = new core_bentley_1.BeEvent(); }
+    static { this.onOpened = new core_bentley_1.BeEvent(); }
     constructor(nativeDb, key) {
-        super({ nativeDb, key, changeset: nativeDb.getCurrentChangeset() }); // eslint-disable-line @typescript-eslint/no-deprecated
-        this._openMode = nativeDb.isReadonly() ? core_bentley_1.OpenMode.Readonly : core_bentley_1.OpenMode.ReadWrite; // eslint-disable-line @typescript-eslint/no-deprecated
+        super({ nativeDb, key, changeset: nativeDb.getCurrentChangeset() });
+        this._openMode = nativeDb.isReadonly() ? core_bentley_1.OpenMode.Readonly : core_bentley_1.OpenMode.ReadWrite;
     }
     static findByKey(key) {
         return super.findByKey(key);
@@ -2869,7 +2911,7 @@ class SnapshotDb extends IModelDb {
         iModelDb.performCheckpoint();
         IModelJsFs_1.IModelJsFs.copySync(iModelDb.pathName, snapshotFile);
         const nativeDb = new NativePlatform_1.IModelNative.platform.DgnDb();
-        nativeDb.openIModel(snapshotFile, core_bentley_1.OpenMode.ReadWrite, undefined, options);
+        nativeDb.openIModel(snapshotFile, core_bentley_1.OpenMode.ReadWrite, undefined);
         nativeDb.vacuum();
         // Replace iModelId if seedFile is a snapshot, preserve iModelId if seedFile is an iModelHub-managed briefcase
         if (!BriefcaseManager_1.BriefcaseManager.isValidBriefcaseId(nativeDb.getBriefcaseId()))
@@ -2968,8 +3010,6 @@ class SnapshotDb extends IModelDb {
     }
 }
 exports.SnapshotDb = SnapshotDb;
-SnapshotDb.onOpen = new core_bentley_1.BeEvent();
-SnapshotDb.onOpened = new core_bentley_1.BeEvent();
 /**
  * Standalone iModels are read/write files that are not associated with an iTwin or managed by iModelHub.
  * They are relevant only for testing, or for small-scale single-user scenarios.
@@ -3062,6 +3102,22 @@ class StandaloneDb extends BriefcaseDb {
             throw error;
         }
     }
+    /** Convert an iModel stored on the local file system into a StandaloneDb, chiefly for testing purposes.
+     * The file must not be open in any application.
+     * @param iModelFileName the path to the iModel on the local file system.
+     * @beta
+     */
+    static convertToStandalone(iModelFileName) {
+        const nativeDb = new NativePlatform_1.IModelNative.platform.DgnDb();
+        nativeDb.openIModel(iModelFileName, core_bentley_1.OpenMode.ReadWrite);
+        nativeDb.setITwinId(core_bentley_1.Guid.empty); // empty iTwinId means "standalone"
+        nativeDb.saveChanges(); // save change to iTwinId
+        nativeDb.deleteAllTxns(); // necessary before resetting briefcaseId
+        nativeDb.resetBriefcaseId(core_common_1.BriefcaseIdValue.Unassigned); // standalone iModels should always have BriefcaseId unassigned
+        nativeDb.saveLocalValue("StandaloneEdit", JSON.stringify({ txns: true }));
+        nativeDb.saveChanges(); // save change to briefcaseId
+        nativeDb.closeFile();
+    }
 }
 exports.StandaloneDb = StandaloneDb;
 //# sourceMappingURL=IModelDb.js.map