@itwin/core-backend 5.1.0-dev.27 → 5.1.0-dev.29

package/lib/esm/IModelDb.js

@@ -9,7 +9,7 @@ import * as fs from "fs";
 import { join } from "path";
 import * as touch from "touch";
 import { assert, BeEvent, BentleyStatus, ChangeSetStatus, DbChangeStage, DbConflictCause, DbConflictResolution, DbResult, Guid, Id64, IModelStatus, JsonUtils, Logger, LogLevel, LRUMap, OpenMode } from "@itwin/core-bentley";
-import { BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryRowFormat, SchemaState, ViewStoreRpc } from "@itwin/core-common";
+import { BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryRowFormat, SchemaState, ViewStoreError, ViewStoreRpc } from "@itwin/core-common";
 import { Range2d, Range3d } from "@itwin/core-geometry";
 import { BackendLoggerCategory } from "./BackendLoggerCategory";
 import { BriefcaseManager } from "./BriefcaseManager";
@@ -1477,7 +1477,7 @@ function processSchemaWriteStatus(status) {
 /** @public */
 (function (IModelDb) {
     /** The collection of models in an [[IModelDb]].
-     * @public
+     * @public @preview
      */
     class Models {
         _iModel;
@@ -1631,7 +1631,9 @@ function processSchemaWriteStatus(status) {
                 return props.id = this._iModel[_nativeDb].insertModel(props);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `Error inserting model [${err.message}], class=${props.classFullName}`);
+                const error = new IModelError(err.errorNumber, `Error inserting model [${err.message}], class=${props.classFullName}`);
+                error.cause = err;
+                throw error;
             }
         }
         /** Update an existing model.
@@ -1645,7 +1647,9 @@ function processSchemaWriteStatus(status) {
                 this._iModel[_nativeDb].updateModel(props);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `error updating model [${err.message}] id=${props.id}`);
+                const error = new IModelError(err.errorNumber, `Error updating model [${err.message}], id: ${props.id}`);
+                error.cause = err;
+                throw error;
             }
         }
         /** Mark the geometry of [[GeometricModel]] as having changed, by recording an indirect change to its GeometryGuid property.
@@ -1661,7 +1665,7 @@ function processSchemaWriteStatus(status) {
             this._iModel.models[_cache].delete(modelId);
             const error = this._iModel[_nativeDb].updateModelGeometryGuid(modelId);
             if (error !== IModelStatus.Success)
-                throw new IModelError(error, `updating geometry guid for model ${modelId}`);
+                throw new IModelError(error, `Error updating geometry guid for model ${modelId}`);
         }
         /** Delete one or more existing models.
          * @param ids The Ids of the models to be deleted
@@ -1674,7 +1678,9 @@ function processSchemaWriteStatus(status) {
                     this._iModel[_nativeDb].deleteModel(id);
                 }
                 catch (err) {
-                    throw new IModelError(err.errorNumber, `error deleting model [${err.message}] id ${id}`);
+                    const error = new IModelError(err.errorNumber, `Error deleting model [${err.message}], id: ${id}`);
+                    error.cause = err;
+                    throw error;
                 }
             });
         }
@@ -1704,7 +1710,7 @@ function processSchemaWriteStatus(status) {
     }
     IModelDb.Models = Models;
     /** The collection of elements in an [[IModelDb]].
-     * @public
+     * @public @preview
      */
     class Elements {
         _iModel;
@@ -1882,7 +1888,7 @@ function processSchemaWriteStatus(status) {
         /** Insert a new element into the iModel.
          * @param elProps The properties of the new element.
          * @returns The newly inserted element's Id.
-         * @throws [[IModelError]] if unable to insert the element.
+         * @throws [[ITwinError]] if unable to insert the element.
          * @note For convenience, the value of `elProps.id` is updated to reflect the resultant element's id.
          * However when `elProps.federationGuid` is not present or undefined, a new Guid will be generated and stored on the resultant element. But
          * the value of `elProps.federationGuid` is *not* updated. Generally, it is best to re-read the element after inserting (e.g. via [[getElementProps]])
@@ -1912,7 +1918,7 @@ function processSchemaWriteStatus(status) {
          * @param elProps the properties of the element to update.
          * @note The values of `classFullName` and `model` *may not be changed* by this method. Further, it will permute the `elProps` object by adding or
          * overwriting their values to the correct values.
-         * @throws [[IModelError]] if unable to update the element.
+         * @throws [[ITwinError]] if unable to update the element.
          */
         updateElement(elProps) {
             try {
@@ -1931,7 +1937,7 @@ function processSchemaWriteStatus(status) {
         }
         /** Delete one or more elements from this iModel.
          * @param ids The set of Ids of the element(s) to be deleted
-         * @throws [[IModelError]]
+         * @throws [[ITwinError]]
          * @see deleteDefinitionElements
          */
         deleteElement(ids) {
@@ -2218,7 +2224,9 @@ function processSchemaWriteStatus(status) {
                 return this._iModel[_nativeDb].insertElementAspect(aspectProps);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `Error inserting ElementAspect [${err.message}], class: ${aspectProps.classFullName}`);
+                const error = new IModelError(err.errorNumber, `Error inserting ElementAspect [${err.message}], class: ${aspectProps.classFullName}`, aspectProps);
+                error.cause = err;
+                throw error;
             }
         }
         /** Update an exist ElementAspect within the iModel.
@@ -2230,7 +2238,9 @@ function processSchemaWriteStatus(status) {
                 this._iModel[_nativeDb].updateElementAspect(aspectProps);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `Error updating ElementAspect [${err.message}], id: ${aspectProps.id}`);
+                const error = new IModelError(err.errorNumber, `Error updating ElementAspect [${err.message}], id: ${aspectProps.id}`, aspectProps);
+                error.cause = err;
+                throw error;
             }
         }
         /** Delete one or more ElementAspects from this iModel.
@@ -2244,14 +2254,16 @@ function processSchemaWriteStatus(status) {
                     iModel[_nativeDb].deleteElementAspect(aspectInstanceId);
                 }
                 catch (err) {
-                    throw new IModelError(err.errorNumber, `Error deleting ElementAspect [${err.message}], id: ${aspectInstanceId}`);
+                    const error = new IModelError(err.errorNumber, `Error deleting ElementAspect [${err.message}], id: ${aspectInstanceId}`);
+                    error.cause = err;
+                    throw error;
                 }
             });
         }
     }
     IModelDb.Elements = Elements;
     /** The collection of views in an [[IModelDb]].
-     * @public
+     * @public @preview
      */
     class Views {
         _iModel;
@@ -2277,7 +2289,7 @@ function processSchemaWriteStatus(status) {
             if (undefined === props) {
                 const propsString = this._iModel.queryFilePropertyString(Views.viewStoreProperty);
                 if (!propsString)
-                    throw new Error("iModel does not have a default ViewStore");
+                    ViewStoreError.throwError("no-viewstore", { message: "iModel does not have a default ViewStore" });
                 props = JSON.parse(propsString);
             }
             const accessToken = await CloudSqlite.requestToken({
@@ -2398,7 +2410,7 @@ function processSchemaWriteStatus(status) {
         }
         getViewThumbnailArg(viewDefinitionId) {
             if (!Id64.isValid(viewDefinitionId))
-                throw new Error("illegal thumbnail id");
+                throw new IModelError(IModelStatus.BadArg, "illegal thumbnail id");
             return { namespace: "dgn_View", name: "Thumbnail", id: viewDefinitionId };
         }
         /** Get the thumbnail for a view.