merge dev to main (v2.5.2)

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-monorepo",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "description": "",
     "scripts": {
         "build": "pnpm -r build",

packages/ide/jetbrains/build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "dev.zenstack"
-version = "2.5.1"
+version = "2.5.2"
 
 repositories {
     mavenCentral()

packages/ide/jetbrains/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jetbrains",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "displayName": "ZenStack JetBrains IDE Plugin",
   "description": "ZenStack JetBrains IDE plugin",
   "homepage": "https://zenstack.dev",

packages/language/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/language",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "displayName": "ZenStack modeling language compiler",
     "description": "ZenStack modeling language compiler",
     "homepage": "https://zenstack.dev",

packages/misc/redwood/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/redwood",
     "displayName": "ZenStack RedwoodJS Integration",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "description": "CLI and runtime for integrating ZenStack with RedwoodJS projects.",
     "repository": {
         "type": "git",

packages/plugins/openapi/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenstackhq/openapi",
   "displayName": "ZenStack Plugin and Runtime for OpenAPI",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "description": "ZenStack plugin and runtime supporting OpenAPI",
   "main": "index.js",
   "repository": {

packages/plugins/swr/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/swr",
     "displayName": "ZenStack plugin for generating SWR hooks",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "description": "ZenStack plugin for generating SWR hooks",
     "main": "index.js",
     "repository": {

packages/plugins/tanstack-query/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/tanstack-query",
     "displayName": "ZenStack plugin for generating tanstack-query hooks",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "description": "ZenStack plugin for generating tanstack-query hooks",
     "main": "index.js",
     "exports": {

packages/plugins/trpc/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/trpc",
     "displayName": "ZenStack plugin for tRPC",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "description": "ZenStack plugin for tRPC",
     "main": "index.js",
     "repository": {

packages/runtime/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@zenstackhq/runtime",
     "displayName": "ZenStack Runtime Library",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "description": "Runtime of ZenStack for both client-side and server-side environments.",
     "repository": {
         "type": "git",
@@ -98,6 +98,7 @@
         "semver": "^7.5.2",
         "superjson": "^1.13.0",
         "tiny-invariant": "^1.3.1",
+        "traverse": "^0.6.10",
         "ts-pattern": "^4.3.0",
         "tslib": "^2.4.1",
         "upper-case-first": "^2.0.2",
@@ -118,6 +119,7 @@
         "@types/pluralize": "^0.0.29",
         "@types/safe-json-stringify": "^1.1.5",
         "@types/semver": "^7.3.13",
+        "@types/traverse": "^0.6.37",
         "@types/uuid": "^8.3.4"
     }
 }

packages/runtime/src/enhancements/node/delegate.ts

@@ -2,6 +2,7 @@
 import deepmerge, { type ArrayMergeOptions } from 'deepmerge';
 import { isPlainObject } from 'is-plain-object';
 import { lowerCaseFirst } from 'lower-case-first';
+import traverse from 'traverse';
 import { DELEGATE_AUX_RELATION_PREFIX } from '../../constants';
 import {
     FieldInfo,
@@ -77,6 +78,10 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
         this.injectWhereHierarchy(model, args?.where);
         this.injectSelectIncludeHierarchy(model, args);
 
+        // discriminator field is needed during post process to determine the
+        // actual concrete model type
+        this.ensureDiscriminatorSelection(model, args);
+
         if (args.orderBy) {
             // `orderBy` may contain fields from base types
             this.injectWhereHierarchy(this.model, args.orderBy);
@@ -94,6 +99,23 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
         }
     }
 
+    private ensureDiscriminatorSelection(model: string, args: any) {
+        const modelInfo = getModelInfo(this.options.modelMeta, model);
+        if (!modelInfo?.discriminator) {
+            return;
+        }
+
+        if (args.select && typeof args.select === 'object') {
+            args.select[modelInfo.discriminator] = true;
+            return;
+        }
+
+        if (args.omit && typeof args.omit === 'object') {
+            args.omit[modelInfo.discriminator] = false;
+            return;
+        }
+    }
+
     private injectWhereHierarchy(model: string, where: any) {
         if (!where || !isPlainObject(where)) {
             return;
@@ -168,16 +190,20 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
                         }
                     }
 
-                    if (value !== undefined) {
-                        if (value?.orderBy) {
+                    // refetch the field select/include value because it may have been
+                    // updated during injection
+                    const fieldValue = args[kind][field];
+
+                    if (fieldValue !== undefined) {
+                        if (fieldValue.orderBy) {
                             // `orderBy` may contain fields from base types
-                            this.injectWhereHierarchy(fieldInfo.type, value.orderBy);
+                            this.injectWhereHierarchy(fieldInfo.type, fieldValue.orderBy);
                         }
 
-                        if (this.injectBaseFieldSelect(model, field, value, args, kind)) {
+                        if (this.injectBaseFieldSelect(model, field, fieldValue, args, kind)) {
                             delete args[kind][field];
                         } else if (fieldInfo.isDataModel) {
-                            let nextValue = value;
+                            let nextValue = fieldValue;
                             if (nextValue === true) {
                                 // make sure the payload is an object
                                 args[kind][field] = nextValue = {};
@@ -333,6 +359,8 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
             );
         }
 
+        this.sanitizeMutationPayload(args.data);
+
         if (isDelegateModel(this.options.modelMeta, this.model)) {
             throw prismaClientValidationError(
                 this.prisma,
@@ -348,6 +376,24 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
         return this.doCreate(this.prisma, this.model, args);
     }
 
+    private sanitizeMutationPayload(data: any) {
+        if (!data) {
+            return;
+        }
+
+        const prisma = this.prisma;
+        const prismaModule = this.options.prismaModule;
+        traverse(data).forEach(function () {
+            if (this.key?.startsWith(DELEGATE_AUX_RELATION_PREFIX)) {
+                throw prismaClientValidationError(
+                    prisma,
+                    prismaModule,
+                    `Auxiliary relation field "${this.key}" cannot be set directly`
+                );
+            }
+        });
+    }
+
     override createMany(args: { data: any; skipDuplicates?: boolean }): Promise<{ count: number }> {
         if (!args) {
             throw prismaClientValidationError(this.prisma, this.options.prismaModule, 'query argument is required');
@@ -360,6 +406,8 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
             );
         }
 
+        this.sanitizeMutationPayload(args.data);
+
         if (!this.involvesDelegateModel(this.model)) {
             return super.createMany(args);
         }
@@ -399,6 +447,8 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
             );
         }
 
+        this.sanitizeMutationPayload(args.data);
+
         if (!this.involvesDelegateModel(this.model)) {
             return super.createManyAndReturn(args);
         }
@@ -585,6 +635,8 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
             );
         }
 
+        this.sanitizeMutationPayload(args.data);
+
         if (!this.involvesDelegateModel(this.model)) {
             return super.update(args);
         }
@@ -604,6 +656,8 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
             );
         }
 
+        this.sanitizeMutationPayload(args.data);
+
         if (!this.involvesDelegateModel(this.model)) {
             return super.updateMany(args);
         }
@@ -631,6 +685,9 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
             );
         }
 
+        this.sanitizeMutationPayload(args.update);
+        this.sanitizeMutationPayload(args.create);
+
         if (isDelegateModel(this.options.modelMeta, this.model)) {
             throw prismaClientValidationError(
                 this.prisma,
@@ -1158,11 +1215,11 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
         const base = this.getBaseModel(model);
 
         if (base) {
-            // merge base fields
+            // fully merge base fields
             const baseRelationName = this.makeAuxRelationName(base);
             const baseData = entity[baseRelationName];
             if (baseData && typeof baseData === 'object') {
-                const baseAssembled = this.assembleUp(base.name, baseData);
+                const baseAssembled = this.assembleHierarchy(base.name, baseData);
                 Object.assign(result, baseAssembled);
             }
         }
@@ -1209,14 +1266,14 @@ export class DelegateProxyHandler extends DefaultPrismaProxyHandler {
         const modelInfo = getModelInfo(this.options.modelMeta, model, true);
 
         if (modelInfo.discriminator) {
-            // model is a delegate, merge sub model fields
+            // model is a delegate, fully merge concrete model fields
             const subModelName = entity[modelInfo.discriminator];
             if (subModelName) {
                 const subModel = getModelInfo(this.options.modelMeta, subModelName, true);
                 const subRelationName = this.makeAuxRelationName(subModel);
                 const subData = entity[subRelationName];
                 if (subData && typeof subData === 'object') {
-                    const subAssembled = this.assembleDown(subModel.name, subData);
+                    const subAssembled = this.assembleHierarchy(subModel.name, subData);
                     Object.assign(result, subAssembled);
                 }
             }

packages/runtime/src/enhancements/node/omit.ts

@@ -5,6 +5,7 @@ import { enumerate, getModelFields, resolveField } from '../../cross';
 import { DbClientContract } from '../../types';
 import { InternalEnhancementOptions } from './create-enhancement';
 import { DefaultPrismaProxyHandler, makeProxy } from './proxy';
+import { QueryUtils } from './query-utils';
 
 /**
  * Gets an enhanced Prisma client that supports `@omit` attribute.
@@ -21,8 +22,11 @@ export function withOmit<DbClient extends object>(prisma: DbClient, options: Int
 }
 
 class OmitHandler extends DefaultPrismaProxyHandler {
+    private queryUtils: QueryUtils;
+
     constructor(prisma: DbClientContract, model: string, options: InternalEnhancementOptions) {
         super(prisma, model, options);
+        this.queryUtils = new QueryUtils(prisma, options);
     }
 
     // base override
@@ -67,8 +71,10 @@ class OmitHandler extends DefaultPrismaProxyHandler {
     }
 
     private async doPostProcess(entityData: any, model: string) {
+        const realModel = this.queryUtils.getDelegateConcreteModel(model, entityData);
+
         for (const field of getModelFields(entityData)) {
-            const fieldInfo = await resolveField(this.options.modelMeta, model, field);
+            const fieldInfo = await resolveField(this.options.modelMeta, realModel, field);
             if (!fieldInfo) {
                 continue;
             }

packages/runtime/src/enhancements/node/policy/policy-utils.ts

@@ -1381,7 +1381,10 @@ export class PolicyUtil extends QueryUtils {
         // preserve the original data as it may be needed for checking field-level readability,
         // while the "data" will be manipulated during traversal (deleting unreadable fields)
         const origData = this.safeClone(data);
-        return this.doPostProcessForRead(data, model, origData, queryArgs, this.hasFieldLevelPolicy(model));
+
+        // use the concrete model if the data is a polymorphic entity
+        const realModel = this.getDelegateConcreteModel(model, data);
+        return this.doPostProcessForRead(data, realModel, origData, queryArgs, this.hasFieldLevelPolicy(realModel));
     }
 
     private doPostProcessForRead(

packages/runtime/src/enhancements/node/query-utils.ts

@@ -214,4 +214,22 @@ export class QueryUtils {
     safeClone(value: unknown): any {
         return value ? clone(value) : value === undefined || value === null ? {} : value;
     }
+
+    getDelegateConcreteModel(model: string, data: any) {
+        if (!data || typeof data !== 'object') {
+            return model;
+        }
+
+        const modelInfo = getModelInfo(this.options.modelMeta, model);
+        if (modelInfo?.discriminator) {
+            // model has a discriminator so it can be a polymorphic base,
+            // need to find the concrete model
+            const concreteModelName = data[modelInfo.discriminator];
+            if (concreteModelName) {
+                return concreteModelName;
+            }
+        }
+
+        return model;
+    }
 }

packages/schema/package.json

@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack Language Tools",
     "description": "FullStack enhancement for Prisma ORM: seamless integration from database to UI",
-    "version": "2.5.1",
+    "version": "2.5.2",
     "author": {
         "name": "ZenStack Team"
     },

packages/schema/src/language-server/zmodel-scope.ts

@@ -204,7 +204,7 @@ export class ZModelScopeProvider extends DefaultScopeProvider {
     private createScopeForContainingModel(node: AstNode, globalScope: Scope) {
         const model = getContainerOfType(node, isDataModel);
         if (model) {
-            return this.createScopeForNodes(model.fields, globalScope);
+            return this.createScopeForModel(model, globalScope);
         } else {
             return EMPTY_SCOPE;
         }