@itwin/core-backend 5.0.0-dev.98 → 5.0.0

package/lib/esm/ViewStore.js

@@ -6,7 +6,7 @@
  * @module ViewDefinitions
  */
 import { CompressedId64Set, Id64, Logger } from "@itwin/core-bentley";
-import { IModel, ViewStoreRpc, } from "@itwin/core-common";
+import { IModel, ViewStoreError, ViewStoreRpc, } from "@itwin/core-common";
 import { CloudSqlite } from "./CloudSqlite";
 import { VersionedSqliteDb } from "./SQLiteDb";
 import { Category } from "./Category";
@@ -92,7 +92,7 @@ export var ViewStore;
         if (typeof id === "number")
             return id;
         if (!ViewStoreRpc.isViewStoreId(id) && !isGuidRowString(id))
-            throw new Error(`invalid value: ${id}`);
+            ViewStoreError.throwError("invalid-value", { message: `invalid value: ${id}` });
         return parseInt(id.slice(1), 36);
     };
     const maybeToRowId = (id) => undefined === id ? undefined : ViewStore.toRowId(id);
@@ -106,7 +106,7 @@ export var ViewStore;
     };
     const validateName = (name, msg) => {
         if (name.trim().length === 0 || (/[@^#<>:"/\\"`'|?*\u0000-\u001F]/g.test(name)))
-            throw new Error(`illegal ${msg} name "${name}"`);
+            ViewStoreError.throwError("invalid-value", { message: `illegal ${msg} name "${name}"` });
     };
     ViewStore.defaultViewGroupId = 1;
     class ViewDb extends VersionedSqliteDb {
@@ -295,7 +295,7 @@ export var ViewStore;
         async deleteViewGroup(args) {
             const rowId = this.findViewGroup(args.name);
             if (rowId === 1)
-                throw new Error("Cannot delete root group");
+                ViewStoreError.throwError("group-error", { message: "Cannot delete root group" });
             return this.deleteFromTable(ViewStore.tableName.viewGroups, rowId);
         }
         deleteModelSelectorSync(id) {
@@ -431,7 +431,7 @@ export var ViewStore;
         }
         async updateViewShared(arg) {
             if (!arg.isShared && arg.owner === undefined)
-                throw new Error("owner must be defined for private views");
+                ViewStoreError.throwError("no-owner", { message: "owner must be defined for private views" });
             this.withSqliteStatement(`UPDATE ${ViewStore.tableName.views} SET private=?,owner=? WHERE Id=?`, (stmt) => {
                 stmt.bindBoolean(1, !arg.isShared);
                 stmt.maybeBindString(2, arg.owner);
@@ -648,7 +648,7 @@ export var ViewStore;
                 if (isGuidRowString(id)) {
                     // member is already a guid row. Make sure it exists.
                     if (undefined === this.getGuid(ViewStore.toRowId(id)))
-                        throw new Error(`${memberName} id does not exist`);
+                        ViewStoreError.throwError("invalid-member", { message: `${memberName} id does not exist` });
                     return;
                 }
                 const guidRow = this.toGuidRow(id);
@@ -657,7 +657,7 @@ export var ViewStore;
                     return;
                 }
             }
-            throw new Error(`invalid ${memberName}: ${id} `);
+            ViewStoreError.throwError("invalid-member", { message: `invalid ${memberName}: ${id} ` });
         }
         fromGuidRowMember(base, memberName) {
             const id = base?.[memberName];
@@ -670,7 +670,7 @@ export var ViewStore;
                     return;
                 }
             }
-            throw new Error(`invalid ${memberName}: ${id} `);
+            ViewStoreError.throwError("invalid-member", { message: `invalid ${memberName}: ${id} ` });
         }
         verifyRowId(table, rowIdString) {
             try {
@@ -678,12 +678,12 @@ export var ViewStore;
                 this.withSqliteStatement(`SELECT 1 FROM ${table} WHERE Id=?`, (stmt) => {
                     stmt.bindInteger(1, rowId);
                     if (!stmt.nextRow())
-                        throw new Error(`missing: ${rowIdString} `);
+                        ViewStoreError.throwError("not-found", { message: `missing: ${rowIdString} ` });
                 });
                 return rowId;
             }
             catch (err) {
-                throw new Error(`invalid Id for ${table}: ${err.message} `);
+                ViewStoreError.throwError("invalid-value", { message: `invalid Id for ${table}: ${err.message} ` });
             }
         }
         scriptToGuids(script) {
@@ -738,7 +738,7 @@ export var ViewStore;
                 selector.query = { ...selector.query }; // shallow copy
                 selector.query.from = selector.query.from.toLowerCase().replace(".", ":").replace("bis:", "biscore:");
                 if (!this.iModel.getJsClass(selector.query.from).is(entity))
-                    throw new Error(`query must select from ${entity.classFullName}`);
+                    ViewStoreError.throwError("invalid-value", { message: `query must select from ${entity.classFullName}` });
                 if (selector.query.adds)
                     selector.query.adds = this.toCompressedGuidRows(selector.query.adds);
                 if (selector.query.removes)
@@ -746,14 +746,14 @@ export var ViewStore;
             }
             else {
                 if (!(selector.ids.length))
-                    throw new Error(`Selector must specify at least one ${entity.className}`);
+                    ViewStoreError.throwError("invalid-value", { message: `Selector must specify at least one ${entity.className}` });
                 selector.ids = this.toCompressedGuidRows(selector.ids);
             }
             return JSON.stringify(selector);
         }
         querySelectorValues(json, bindings) {
             if (typeof json !== "object")
-                throw new Error("invalid selector");
+                ViewStoreError.throwError("invalid-value", { message: "invalid selector" });
             const props = json;
             if (!props.query) {
                 // there's no query, so the ids are the list of elements
@@ -763,7 +763,8 @@ export var ViewStore;
             const sql = `SELECT ECInstanceId FROM ${query.only ? "ONLY " : ""}${query.from}${query.where ? ` WHERE ${query.where}` : ""}`;
             const ids = new Set();
             try {
-                this.iModel.withStatement(sql, (stmt) => {
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                this.iModel.withPreparedStatement(sql, (stmt) => {
                     if (bindings)
                         stmt.bindValues(bindings);
                     for (const el of stmt) {
@@ -796,7 +797,7 @@ export var ViewStore;
             const rowId = this.getRowId(ViewStore.tableName.categorySelectors, args);
             const row = this.getCategorySelectorRow(rowId);
             if (undefined === row)
-                throw new Error("CategorySelector not found");
+                ViewStoreError.throwError("not-found", { message: "CategorySelector not found" });
             const props = blankElementProps({}, "BisCore:CategorySelector", rowId, row.name);
             props.categories = this.querySelectorValues(JSON.parse(row.json), args.bindings);
             return props;
@@ -817,7 +818,7 @@ export var ViewStore;
             const rowId = this.getRowId(ViewStore.tableName.modelSelectors, args);
             const row = this.getModelSelectorRow(rowId);
             if (undefined === row)
-                throw new Error("ModelSelector not found");
+                ViewStoreError.throwError("not-found", { message: "ModelSelector not found" });
             const props = blankElementProps({}, "BisCore:ModelSelector", rowId, row?.name);
             props.models = this.querySelectorValues(JSON.parse(row.json), args.bindings);
             return props;
@@ -828,7 +829,7 @@ export var ViewStore;
         makeTimelineJson(timeline) {
             timeline = cloneProps(timeline);
             if (!Array.isArray(timeline))
-                throw new Error("Timeline has no entries");
+                ViewStoreError.throwError("not-found", { message: "Timeline has no entries" });
             return JSON.stringify(this.scriptToGuids(timeline));
         }
         async addTimeline(args) {
@@ -844,7 +845,7 @@ export var ViewStore;
             const rowId = this.getRowId(ViewStore.tableName.timelines, args);
             const row = this.getTimelineRow(rowId);
             if (undefined === row)
-                throw new Error("Timeline not found");
+                ViewStoreError.throwError("not-found", { message: "Timeline not found" });
             const props = blankElementProps({}, "BisCore:RenderTimeline", rowId, row?.name);
             props.script = JSON.stringify(this.scriptFromGuids(JSON.parse(row.json), false));
             return props;
@@ -903,7 +904,7 @@ export var ViewStore;
             const rowId = this.getRowId(ViewStore.tableName.displayStyles, args);
             const row = this.getDisplayStyleRow(rowId);
             if (undefined === row)
-                throw new Error("DisplayStyle not found");
+                ViewStoreError.throwError("not-found", { message: "DisplayStyle not found" });
             const val = JSON.parse(row.json);
             const props = blankElementProps({}, val.className, rowId, row.name);
             props.jsonProperties = { styles: val.settings };
@@ -964,7 +965,7 @@ export var ViewStore;
         addViewDefinition(args) {
             const name = args.viewDefinition.code.value;
             if (name === undefined)
-                throw new Error("ViewDefinition must have a name");
+                ViewStoreError.throwError("not-found", { message: "ViewDefinition must have a name" });
             const groupId = args.group ? this.findViewGroup(args.group) : ViewStore.defaultViewGroupId;
             const maybeRow = (rowString) => rowString ? ViewStore.toRowId(rowString) : undefined;
             const viewDef = this.makeViewDefinitionProps(args.viewDefinition);
@@ -1004,7 +1005,7 @@ export var ViewStore;
             const viewId = ViewStore.toRowId(args.viewId);
             const row = this.getViewRow(viewId);
             if (undefined === row)
-                throw new Error("View not found");
+                ViewStoreError.throwError("not-found", { message: "View not found" });
             const props = blankElementProps(JSON.parse(row.json), row.className, viewId, row.name);
             this.fromGuidRowMember(props, "baseModelId");
             this.fromGuidRowMember(props.jsonProperties?.viewDetails, "acs");
@@ -1016,7 +1017,7 @@ export var ViewStore;
         async addOrReplaceThumbnail(args) {
             const viewRow = this.getViewRow(ViewStore.toRowId(args.viewId));
             if (viewRow === undefined)
-                throw new Error("View not found");
+                ViewStoreError.throwError("not-found", { message: "View not found" });
             const format = { format: args.thumbnail.format, height: args.thumbnail.height, width: args.thumbnail.width };
             this.addOrReplaceThumbnailRow({ data: args.thumbnail.image, viewId: ViewStore.toRowId(args.viewId), format, owner: args.owner });
         }
@@ -1092,12 +1093,12 @@ export var ViewStore;
             const groupId = args.group ? this.findViewGroup(args.group) : ViewStore.defaultViewGroupId;
             const viewRow = this.getViewRow(ViewStore.toRowId(args.defaultView));
             if (viewRow === undefined)
-                throw new Error("View not found");
+                ViewStoreError.throwError("not-found", { message: "View not found" });
             if (viewRow.groupId !== groupId)
-                throw new Error("View is not in the specified group");
+                ViewStoreError.throwError("not-found", { message: "View is not in the specified group" });
             const groupRow = this.getViewGroup(groupId);
             if (groupRow === undefined)
-                throw new Error("View group not found");
+                ViewStoreError.throwError("not-found", { message: "View group not found" });
             this.withSqliteStatement(`UPDATE ${ViewStore.tableName.viewGroups} SET defaultViewId=? WHERE Id=?`, (stmt) => {
                 stmt.bindInteger(1, groupId);
                 stmt.bindInteger(2, ViewStore.toRowId(args.defaultView));
@@ -1172,7 +1173,7 @@ export var ViewStore;
             }
             else {
                 if (args.categorySelectorProps === undefined)
-                    throw new Error("Must supply categorySelector");
+                    ViewStoreError.throwError("not-found", { message: "Must supply categorySelector" });
                 args.viewDefinition.categorySelectorId = await this.addCategorySelector({ selector: { ids: args.categorySelectorProps.categories }, owner });
             }
             const spatialDef = args.viewDefinition;
@@ -1183,14 +1184,14 @@ export var ViewStore;
                 spatialDef.modelSelectorId = await this.addModelSelector({ selector: { ids: args.modelSelectorProps.models }, owner });
             }
             else if (args.viewDefinition.classFullName === "BisCore:SpatialViewDefinition") {
-                throw new Error("Must supply modelSelector for Spatial views");
+                ViewStoreError.throwError("not-found", { message: "Must supply modelSelector for Spatial views" });
             }
             if (ViewStoreRpc.isViewStoreId(spatialDef.displayStyleId)) {
                 this.verifyRowId(ViewStore.tableName.displayStyles, spatialDef.displayStyleId);
             }
             else {
                 if (args.displayStyleProps === undefined || args.displayStyleProps.jsonProperties?.styles === undefined)
-                    throw new Error("Must supply valid displayStyle");
+                    ViewStoreError.throwError("not-found", { message: "Must supply valid displayStyle" });
                 spatialDef.displayStyleId = await this.addDisplayStyle({ className: args.displayStyleProps.classFullName, settings: args.displayStyleProps.jsonProperties.styles, owner });
             }
             const viewId = this.addViewDefinition(args);
@@ -1204,7 +1205,7 @@ export var ViewStore;
             const rowId = ViewStore.toRowId(arg.viewId);
             const viewRow = this.getViewRow(rowId);
             if (viewRow === undefined)
-                throw new Error("View not found");
+                ViewStoreError.throwError("not-found", { message: "View not found" });
             this.deleteViewRow(rowId);
             const hasName = (table, nameRow) => {
                 const name = this.withSqliteStatement(`SELECT name FROM ${table} WHERE Id=?`, (stmt) => {