feat: support Prisma v5 (#587)

Author: ymc9

.github/workflows/build-test.yml

@@ -18,9 +18,17 @@ jobs:
         strategy:
             matrix:
                 node-version: [18.x]
+                prisma-version: [v4, v5]
 
         steps:
-            - uses: actions/checkout@v3
+            - name: Checkout
+              uses: actions/checkout@v3
+
+            - name: Set Prisma Version
+              if: ${{ matrix.prisma-version == 'v5' }}
+              shell: bash
+              run: |
+                  bash ./script/test-prisma-v5.sh
 
             - name: Install pnpm
               uses: pnpm/action-setup@v2

package.json

@@ -16,6 +16,7 @@
     "devDependencies": {
         "@changesets/cli": "^2.26.0",
         "concurrently": "^7.4.0",
+        "replace-in-file": "^7.0.1",
         "tsup": "^7.1.0"
     }
 }

packages/plugins/openapi/package.json

@@ -24,7 +24,7 @@
   "author": "ZenStack Team",
   "license": "MIT",
   "dependencies": {
-    "@prisma/generator-helper": "4.10.0",
+    "@prisma/generator-helper": "^5.0.0",
     "@zenstackhq/runtime": "workspace:*",
     "@zenstackhq/sdk": "workspace:*",
     "change-case": "^4.1.2",
@@ -36,10 +36,9 @@
     "zod-validation-error": "^0.2.1"
   },
   "devDependencies": {
-    "@prisma/internals": "4.10.0",
     "@readme/openapi-parser": "^2.4.0",
     "@types/jest": "^29.5.0",
-    "@types/lower-case-first": "^1.0.1",
+    "@types/node": "^18.0.0",
     "@types/pluralize": "^0.0.29",
     "@types/tmp": "^0.2.3",
     "@typescript-eslint/eslint-plugin": "^5.54.0",

packages/plugins/openapi/src/generator-base.ts

@@ -1,4 +1,4 @@
-import { DMMF } from '@prisma/generator-helper';
+import type { DMMF } from '@prisma/generator-helper';
 import { PluginError, PluginOptions, getDataModels, hasAttribute } from '@zenstackhq/sdk';
 import { Model } from '@zenstackhq/sdk/ast';
 import type { OpenAPIV3_1 as OAPI } from 'openapi-types';

packages/plugins/openapi/src/index.ts

@@ -1,4 +1,4 @@
-import { DMMF } from '@prisma/generator-helper';
+import type { DMMF } from '@prisma/generator-helper';
 import { PluginError, PluginOptions } from '@zenstackhq/sdk';
 import { Model } from '@zenstackhq/sdk/ast';
 import { RESTfulOpenAPIGenerator } from './rest-generator';

packages/plugins/openapi/src/rest-generator.ts

@@ -1,6 +1,6 @@
 // Inspired by: https://github.com/omar-dulaimi/prisma-trpc-generator
 
-import { DMMF } from '@prisma/generator-helper';
+import type { DMMF } from '@prisma/generator-helper';
 import {
     AUXILIARY_FIELDS,
     analyzePolicies,

packages/plugins/openapi/src/rpc-generator.ts

@@ -713,7 +713,12 @@ export class RPCOpenAPIGenerator extends OpenAPIGeneratorBase {
         const fields = input.fields.filter((f) => !AUXILIARY_FIELDS.includes(f.name));
         for (const field of fields) {
             const options = field.inputTypes
-                .filter((f) => f.type !== 'Null')
+                .filter(
+                    (f) =>
+                        f.type !== 'Null' &&
+                        // fieldRefTypes refer to other fields in the model and don't need to be generated as part of schema
+                        f.location !== 'fieldRefTypes'
+                )
                 .map((f) => {
                     return this.wrapArray(this.prismaTypeToOpenAPIType(f.type), f.isList);
                 });

packages/plugins/prisma-types.ts

@@ -0,0 +1,12 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/// Types copied over from Prisma's generated code to avoid being broken due to Prisma upgrades
+
+export type Enumerable<T> = T | Array<T>;
+
+type _TupleToUnion<T> = T extends (infer E)[] ? E : never;
+
+export type TupleToUnion<K extends readonly any[]> = _TupleToUnion<K>;
+
+export type MaybeTupleToUnion<T> = T extends any[] ? TupleToUnion<T> : T;
+
+export type PickEnumerable<T, K extends Enumerable<keyof T> | keyof T> = Pick<T, MaybeTupleToUnion<K>>;

packages/plugins/swr/package.json

@@ -25,7 +25,7 @@
     "author": "ZenStack Team",
     "license": "MIT",
     "dependencies": {
-        "@prisma/generator-helper": "4.10.0",
+        "@prisma/generator-helper": "^5.0.0",
         "@zenstackhq/runtime": "workspace:*",
         "@zenstackhq/sdk": "workspace:*",
         "change-case": "^4.1.2",
@@ -37,10 +37,9 @@
     "devDependencies": {
         "@tanstack/react-query": "^4.28.0",
         "@types/jest": "^29.5.0",
-        "@types/lower-case-first": "^1.0.1",
+        "@types/node": "^18.0.0",
         "@types/react": "18.2.0",
         "@types/tmp": "^0.2.3",
-        "@types/upper-case-first": "^1.1.2",
         "@zenstackhq/testtools": "workspace:*",
         "copyfiles": "^2.4.1",
         "jest": "^29.5.0",

packages/plugins/swr/src/generator.ts

@@ -1,4 +1,4 @@
-import { DMMF } from '@prisma/generator-helper';
+import type { DMMF } from '@prisma/generator-helper';
 import {
     PluginOptions,
     createProject,
@@ -59,7 +59,7 @@ function generateModelHooks(project: Project, outDir: string, model: DataModel,
     });
     sf.addStatements([
         `import { useContext } from 'react';`,
-        `import { RequestHandlerContext, type RequestOptions } from '@zenstackhq/swr/runtime';`,
+        `import { RequestHandlerContext, type RequestOptions, type PickEnumerable } from '@zenstackhq/swr/runtime';`,
         `import * as request from '@zenstackhq/swr/runtime';`,
     ]);
 
@@ -193,7 +193,7 @@ function generateModelHooks(project: Project, outDir: string, model: DataModel,
             `HasSelectOrTake extends Prisma.Or<Prisma.Extends<'skip', Prisma.Keys<T>>, Prisma.Extends<'take', Prisma.Keys<T>>>`,
             `OrderByArg extends Prisma.True extends HasSelectOrTake ? { orderBy: Prisma.${model.name}GroupByArgs['orderBy'] }: { orderBy?: Prisma.${model.name}GroupByArgs['orderBy'] },`,
             `OrderFields extends Prisma.ExcludeUnderscoreKeys<Prisma.Keys<Prisma.MaybeTupleToUnion<T['orderBy']>>>`,
-            `ByFields extends Prisma.TupleToUnion<T['by']>`,
+            `ByFields extends Prisma.MaybeTupleToUnion<T['by']>`,
             `ByValid extends Prisma.Has<ByFields, OrderFields>`,
             `HavingFields extends Prisma.GetHavingFields<T['having']>`,
             `HavingValid extends Prisma.Has<ByFields, HavingFields>`,
@@ -243,7 +243,7 @@ function generateModelHooks(project: Project, outDir: string, model: DataModel,
         ];
         const inputType = `Prisma.SubsetIntersection<T, Prisma.${model.name}GroupByArgs, OrderByArg> & InputErrors`;
         const returnType = `{} extends InputErrors ? 
-        Array<Prisma.PickArray<Prisma.${model.name}GroupByOutputType, T['by']> &
+        Array<PickEnumerable<Prisma.${model.name}GroupByOutputType, T['by']> &
           {
             [P in ((keyof T) & (keyof Prisma.${model.name}GroupByOutputType))]: P extends '_count'
               ? T[P] extends boolean