@itwin/core-backend 5.9.0-dev.8 → 5.9.0

package/lib/esm/ViewStore.js

@@ -6,7 +6,7 @@
  * @module ViewDefinitions
  */
 import { CompressedId64Set, Id64, Logger } from "@itwin/core-bentley";
-import { IModel, ViewStoreError, ViewStoreRpc, } from "@itwin/core-common";
+import { IModel, resolveNavPropId, ViewStoreError, ViewStoreRpc, } from "@itwin/core-common";
 import { CloudSqlite } from "./CloudSqlite";
 import { VersionedSqliteDb } from "./SQLiteDb";
 import { Category } from "./Category";
@@ -948,11 +948,25 @@ export var ViewStore;
         }
         makeViewDefinitionProps(viewDefinition) {
             const viewDef = cloneProps(viewDefinition); // don't modify input
-            this.verifyRowId(ViewStore.tableName.categorySelectors, viewDef.categorySelectorId);
-            this.verifyRowId(ViewStore.tableName.displayStyles, viewDef.displayStyleId);
-            if (viewDef.modelSelectorId)
-                this.verifyRowId(ViewStore.tableName.modelSelectors, viewDef.modelSelectorId);
-            this.toGuidRowMember(viewDef, "baseModelId");
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            this.verifyRowId(ViewStore.tableName.categorySelectors, resolveNavPropId(viewDef.categorySelector, viewDef.categorySelectorId));
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            this.verifyRowId(ViewStore.tableName.displayStyles, resolveNavPropId(viewDef.displayStyle, viewDef.displayStyleId));
+            const spatialViewDefinitionProps = viewDef;
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const effectiveModelSelectorId = resolveNavPropId(spatialViewDefinitionProps.modelSelector, spatialViewDefinitionProps.modelSelectorId);
+            if (effectiveModelSelectorId) {
+                this.verifyRowId(ViewStore.tableName.modelSelectors, effectiveModelSelectorId);
+            }
+            const viewDef2d = viewDef;
+            if (viewDef2d.baseModel) {
+                this.toGuidRowMember(viewDef2d.baseModel, "id");
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                viewDef2d.baseModelId = viewDef2d.baseModel.id; // keep deprecated field in sync
+            }
+            else {
+                this.toGuidRowMember(viewDef, "baseModelId");
+            }
             this.toGuidRowMember(viewDef.jsonProperties?.viewDetails, "acs");
             const props = viewDef;
             delete props.id;
@@ -970,6 +984,7 @@ export var ViewStore;
             const maybeRow = (rowString) => rowString ? ViewStore.toRowId(rowString) : undefined;
             const viewDef = this.makeViewDefinitionProps(args.viewDefinition);
             try {
+                const spatialViewDefinitionProps = viewDef;
                 return this.addViewRow({
                     name,
                     className: viewDef.classFullName,
@@ -977,9 +992,12 @@ export var ViewStore;
                     groupId,
                     isPrivate: args.isPrivate,
                     json: JSON.stringify(viewDef),
-                    modelSel: maybeRow(viewDef.modelSelectorId),
-                    categorySel: ViewStore.toRowId(viewDef.categorySelectorId),
-                    displayStyle: ViewStore.toRowId(viewDef.displayStyleId),
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
+                    modelSel: maybeRow(resolveNavPropId(spatialViewDefinitionProps.modelSelector, spatialViewDefinitionProps.modelSelectorId)),
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
+                    categorySel: ViewStore.toRowId(resolveNavPropId(viewDef.categorySelector, viewDef.categorySelectorId)),
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
+                    displayStyle: ViewStore.toRowId(resolveNavPropId(viewDef.displayStyle, viewDef.displayStyleId)),
                 });
             }
             catch (e) {
@@ -992,11 +1010,15 @@ export var ViewStore;
         async updateViewDefinition(args) {
             const maybeRow = (rowString) => rowString ? ViewStore.toRowId(rowString) : undefined;
             const viewDef = this.makeViewDefinitionProps(args.viewDefinition);
+            const spatialViewDefinitionProps = viewDef;
             this.withSqliteStatement(`UPDATE ${ViewStore.tableName.views} SET json=?,modelSel=?,categorySel=?,displayStyle=? WHERE Id=?`, (stmt) => {
                 stmt.bindString(1, JSON.stringify(viewDef));
-                stmt.maybeBindInteger(2, maybeRow(viewDef.modelSelectorId));
-                stmt.bindInteger(3, ViewStore.toRowId(viewDef.categorySelectorId));
-                stmt.bindInteger(4, ViewStore.toRowId(viewDef.displayStyleId));
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                stmt.maybeBindInteger(2, maybeRow(resolveNavPropId(spatialViewDefinitionProps.modelSelector, spatialViewDefinitionProps.modelSelectorId)));
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                stmt.bindInteger(3, ViewStore.toRowId(resolveNavPropId(viewDef.categorySelector, viewDef.categorySelectorId)));
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                stmt.bindInteger(4, ViewStore.toRowId(resolveNavPropId(viewDef.displayStyle, viewDef.displayStyleId)));
                 stmt.bindInteger(5, ViewStore.toRowId(args.viewId));
                 stmt.stepForWrite();
             });
@@ -1007,7 +1029,15 @@ export var ViewStore;
             if (undefined === row)
                 ViewStoreError.throwError("not-found", { message: "View not found" });
             const props = blankElementProps(JSON.parse(row.json), row.className, viewId, row.name);
-            this.fromGuidRowMember(props, "baseModelId");
+            const props2d = props;
+            if (props2d.baseModel) {
+                this.fromGuidRowMember(props2d.baseModel, "id");
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                props2d.baseModelId = props2d.baseModel.id; // keep deprecated field in sync
+            }
+            else {
+                this.fromGuidRowMember(props, "baseModelId");
+            }
             this.fromGuidRowMember(props.jsonProperties?.viewDetails, "acs");
             return props;
         }
@@ -1168,31 +1198,43 @@ export var ViewStore;
         }
         async addView(args) {
             const owner = args.owner;
-            if (ViewStoreRpc.isViewStoreId(args.viewDefinition.categorySelectorId)) {
-                this.verifyRowId(ViewStore.tableName.categorySelectors, args.viewDefinition.categorySelectorId);
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const categorySelectorId = resolveNavPropId(args.viewDefinition.categorySelector, args.viewDefinition.categorySelectorId);
+            if (ViewStoreRpc.isViewStoreId(categorySelectorId)) {
+                this.verifyRowId(ViewStore.tableName.categorySelectors, categorySelectorId);
             }
             else {
                 if (args.categorySelectorProps === undefined)
                     ViewStoreError.throwError("not-found", { message: "Must supply categorySelector" });
-                args.viewDefinition.categorySelectorId = await this.addCategorySelector({ selector: { ids: args.categorySelectorProps.categories }, owner });
+                args.viewDefinition.categorySelector = { id: await this.addCategorySelector({ selector: { ids: args.categorySelectorProps.categories }, owner }) };
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                args.viewDefinition.categorySelectorId = args.viewDefinition.categorySelector.id; // for backward compatibility
             }
             const spatialDef = args.viewDefinition;
-            if (ViewStoreRpc.isViewStoreId(spatialDef.modelSelectorId)) {
-                this.verifyRowId(ViewStore.tableName.modelSelectors, spatialDef.modelSelectorId);
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const modelSelectorId = resolveNavPropId(spatialDef.modelSelector, spatialDef.modelSelectorId);
+            if (ViewStoreRpc.isViewStoreId(modelSelectorId)) {
+                this.verifyRowId(ViewStore.tableName.modelSelectors, modelSelectorId);
             }
             else if (args.modelSelectorProps) {
-                spatialDef.modelSelectorId = await this.addModelSelector({ selector: { ids: args.modelSelectorProps.models }, owner });
+                spatialDef.modelSelector = { id: await this.addModelSelector({ selector: { ids: args.modelSelectorProps.models }, owner }) };
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                spatialDef.modelSelectorId = spatialDef.modelSelector.id; // for backward compatibility
             }
             else if (args.viewDefinition.classFullName === "BisCore:SpatialViewDefinition") {
                 ViewStoreError.throwError("not-found", { message: "Must supply modelSelector for Spatial views" });
             }
-            if (ViewStoreRpc.isViewStoreId(spatialDef.displayStyleId)) {
-                this.verifyRowId(ViewStore.tableName.displayStyles, spatialDef.displayStyleId);
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            const displayStyleId = resolveNavPropId(spatialDef.displayStyle, spatialDef.displayStyleId);
+            if (ViewStoreRpc.isViewStoreId(displayStyleId)) {
+                this.verifyRowId(ViewStore.tableName.displayStyles, displayStyleId);
             }
             else {
                 if (args.displayStyleProps === undefined || args.displayStyleProps.jsonProperties?.styles === undefined)
                     ViewStoreError.throwError("not-found", { message: "Must supply valid displayStyle" });
-                spatialDef.displayStyleId = await this.addDisplayStyle({ className: args.displayStyleProps.classFullName, settings: args.displayStyleProps.jsonProperties.styles, owner });
+                spatialDef.displayStyle = { id: await this.addDisplayStyle({ className: args.displayStyleProps.classFullName, settings: args.displayStyleProps.jsonProperties.styles, owner }) };
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                spatialDef.displayStyleId = spatialDef.displayStyle.id; // for backward compatibility
             }
             const viewId = this.addViewDefinition(args);
             if (args.tags)