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

package/lib/cjs/IModelDb.js

@@ -16,12 +16,14 @@ const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
 const BriefcaseManager_1 = require("./BriefcaseManager");
 const CheckpointManager_1 = require("./CheckpointManager");
 const ClassRegistry_1 = require("./ClassRegistry");
+const CodeService_1 = require("./CodeService");
 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 GeoCoordConfig_1 = require("./GeoCoordConfig");
 const IModelHost_1 = require("./IModelHost");
 const IModelJsFs_1 = require("./IModelJsFs");
 const IpcHost_1 = require("./IpcHost");
@@ -33,7 +35,7 @@ const TxnManager_1 = require("./TxnManager");
 const ViewDefinition_1 = require("./ViewDefinition");
 const Settings_1 = require("./workspace/Settings");
 const Workspace_1 = require("./workspace/Workspace");
-const GeoCoordConfig_1 = require("./GeoCoordConfig");
+// spell:ignore fontid fontmap
 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 {
@@ -120,6 +122,8 @@ class IModelDb extends core_common_1.IModel {
             });
         }
     }
+    /** @alpha */
+    get codeService() { return this._codeService; }
     /**
      * Get the [[LockControl]] for this iModel.
      * @beta
@@ -131,7 +135,7 @@ class IModelDb extends core_common_1.IModel {
      */
     get workspace() {
         if (undefined === this._workspace)
-            this._workspace = new Workspace_1.ITwinWorkspace(new IModelSettings(), IModelHost_1.IModelHost.appWorkspace);
+            this._workspace = new Workspace_1.ITwinWorkspace(new IModelSettings());
         return this._workspace;
     }
     /** Acquire the exclusive schema lock on this iModel.
@@ -186,7 +190,7 @@ class IModelDb extends core_common_1.IModel {
     get pathName() { return this.nativeDb.getFilePath(); }
     /** Close this IModel, if it is currently open. */
     close() {
-        var _a;
+        var _a, _b;
         if (!this.isOpen)
             return; // don't continue if already closed
         this.beforeClose();
@@ -194,6 +198,8 @@ class IModelDb extends core_common_1.IModel {
         (_a = this._workspace) === null || _a === void 0 ? void 0 : _a.close();
         this.locks.close();
         this._locks = undefined;
+        (_b = this._codeService) === null || _b === void 0 ? void 0 : _b.close();
+        this._codeService = undefined;
         this.nativeDb.closeIModel();
         this._nativeDb = undefined; // the underlying nativeDb has been freed by closeIModel
     }
@@ -740,9 +746,13 @@ class IModelDb extends core_common_1.IModel {
         return this._classMetaDataRegistry;
     }
     /** Get the linkTableRelationships for this IModel */
-    get relationships() { return this._relationships || (this._relationships = new Relationship_1.Relationships(this)); }
+    get relationships() {
+        return this._relationships || (this._relationships = new Relationship_1.Relationships(this));
+    }
     /** Get the CodeSpecs in this IModel. */
-    get codeSpecs() { return (this._codeSpecs !== undefined) ? this._codeSpecs : (this._codeSpecs = new CodeSpecs_1.CodeSpecs(this)); }
+    get codeSpecs() {
+        return (this._codeSpecs !== undefined) ? this._codeSpecs : (this._codeSpecs = new CodeSpecs_1.CodeSpecs(this));
+    }
     /** @internal */
     insertCodeSpec(codeSpec) {
         return this.nativeDb.insertCodeSpec(codeSpec.name, codeSpec.properties);
@@ -834,6 +844,14 @@ class IModelDb extends core_common_1.IModel {
         if (metaData.baseClasses !== undefined && metaData.baseClasses.length > 0)
             metaData.baseClasses.forEach((baseClassName) => this.loadMetaData(baseClassName));
     }
+    /** Returns the full schema for the input name.
+     * @param name The name of the schema e.g. 'BisCore'
+     * @returns The SchemaProps for the requested schema
+     * @throws if the schema can not be found or loaded.
+     */
+    getSchemaProps(name) {
+        return this.nativeDb.getSchemaProps(name);
+    }
     /** Query if this iModel contains the definition of the specified class.
      * @param classFullName The full name of the class, for example, SomeSchema:SomeClass
      * @returns true if the iModel contains the class definition or false if not.
@@ -1290,11 +1308,14 @@ IModelDb._settingPropNamespace = "settings";
          * @throws [[IModelError]] if the element is not found or cannot be loaded.
          * @see tryGetElementProps
          */
-        getElementProps(elementId) {
-            const elementProps = this.tryGetElementProps(elementId);
-            if (undefined === elementProps)
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `reading element=${elementId}`);
-            return elementProps;
+        getElementProps(props) {
+            if (typeof props === "string") {
+                props = core_bentley_1.Id64.isId64(props) ? { id: props } : { federationGuid: props };
+            }
+            else if (props instanceof core_common_1.Code) {
+                props = { code: props };
+            }
+            return this._iModel.nativeDb.getElement(props);
         }
         /** Get properties of an Element by Id, FederationGuid, or Code
          * @returns The properties of the element or `undefined` if the element is not found.
@@ -1336,6 +1357,8 @@ IModelDb._settingPropNamespace = "settings";
                 elementId = core_bentley_1.Id64.isId64(elementId) ? { id: elementId } : { federationGuid: elementId };
             else if (elementId instanceof core_common_1.Code)
                 elementId = { code: elementId };
+            else
+                elementId.onlyBaseProperties = false; // we must load all properties to construct the element.
             const elementProps = this.tryGetElementJson(elementId);
             if (undefined === elementProps)
                 return undefined; // no Element with that elementId found
@@ -1396,7 +1419,8 @@ IModelDb._settingPropNamespace = "settings";
                 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}`);
+                err.message = `error inserting element: ${err.message}`;
+                throw err;
             }
         }
         /** Update some properties of an existing element.
@@ -1411,7 +1435,8 @@ IModelDb._settingPropNamespace = "settings";
                 this._iModel.nativeDb.updateElement(elProps);
             }
             catch (err) {
-                throw new core_common_1.IModelError(err.errorNumber, `Error updating element [${err.message}], id:${elProps.id}`);
+                err.message = `error updating element: ${err.message}`;
+                throw err;
             }
         }
         /** Delete one or more elements from this iModel.
@@ -1426,7 +1451,8 @@ IModelDb._settingPropNamespace = "settings";
                     iModel.nativeDb.deleteElement(id);
                 }
                 catch (err) {
-                    throw new core_common_1.IModelError(err.errorNumber, `Error deleting element [${err.message}], id:${id}`);
+                    err.message = `error deleting element: ${err.message}`;
+                    throw err;
                 }
             });
         }
@@ -1448,9 +1474,10 @@ IModelDb._settingPropNamespace = "settings";
             const usedIdSet = usageInfo.usedIds ? core_bentley_1.Id64.toIdSet(usageInfo.usedIds) : new Set();
             const deleteIfUnused = (ids, used) => {
                 if (ids) {
-                    ids.forEach((id) => { if (!used.has(id)) {
-                        this._iModel.elements.deleteElement(id);
-                    } });
+                    ids.forEach((id) => {
+                        if (!used.has(id))
+                            this._iModel.elements.deleteElement(id);
+                    });
                 }
             };
             try {
@@ -1476,15 +1503,12 @@ IModelDb._settingPropNamespace = "settings";
             if (usageInfo.viewDefinitionIds) {
                 // take another pass in case a deleted ViewDefinition was the only usage of these view-related DefinitionElements
                 let viewRelatedIds = [];
-                if (usageInfo.displayStyleIds) {
+                if (usageInfo.displayStyleIds)
                     viewRelatedIds = viewRelatedIds.concat(usageInfo.displayStyleIds.filter((id) => usedIdSet.has(id)));
-                }
-                if (usageInfo.categorySelectorIds) {
+                if (usageInfo.categorySelectorIds)
                     viewRelatedIds = viewRelatedIds.concat(usageInfo.categorySelectorIds.filter((id) => usedIdSet.has(id)));
-                }
-                if (usageInfo.modelSelectorIds) {
+                if (usageInfo.modelSelectorIds)
                     viewRelatedIds = viewRelatedIds.concat(usageInfo.modelSelectorIds.filter((id) => usedIdSet.has(id)));
-                }
                 if (viewRelatedIds.length > 0) {
                     const viewRelatedUsageInfo = this._iModel.nativeDb.queryDefinitionElementUsage(viewRelatedIds);
                     if (viewRelatedUsageInfo) {
@@ -1498,9 +1522,10 @@ IModelDb._settingPropNamespace = "settings";
                         finally {
                             this._iModel.nativeDb.endPurgeOperation();
                         }
-                        viewRelatedIds.forEach((id) => { if (!usedViewRelatedIdSet.has(id)) {
-                            usedIdSet.delete(id);
-                        } });
+                        viewRelatedIds.forEach((id) => {
+                            if (!usedViewRelatedIdSet.has(id))
+                                usedIdSet.delete(id);
+                        });
                     }
                 }
             }
@@ -1965,6 +1990,17 @@ class BriefcaseDb extends IModelDb {
         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() });
+        if (openMode === core_bentley_1.OpenMode.ReadWrite && CodeService_1.CodeService.createForIModel) {
+            try {
+                const codeService = CodeService_1.CodeService.createForIModel(briefcaseDb);
+                briefcaseDb._codeService = codeService;
+                this.onCodeServiceCreated.raiseEvent(codeService);
+            }
+            catch (e) {
+                if (e.errorId !== "NoCodeIndex") // no code index means iModel isn't enforcing codes.
+                    throw e;
+            }
+        }
         BriefcaseManager_1.BriefcaseManager.logUsage(briefcaseDb);
         this.onOpened.raiseEvent(briefcaseDb, args);
         return briefcaseDb;
@@ -2022,6 +2058,8 @@ BriefcaseDb.onOpen = new core_bentley_1.BeEvent();
  * ```
  */
 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.
  */