fix: clean up generation of logical prisma client (#1082)

zenstackhq · Mar 6, 2024 · 6e7993a · 6e7993a
1 parent 430ab62
commit 6e7993a
Show file tree

Hide file tree

Showing 37 changed files with 961 additions and 757 deletions.
diff --git a/packages/plugins/openapi/src/generator-base.ts b/packages/plugins/openapi/src/generator-base.ts
@@ -1,5 +1,5 @@
 import type { DMMF } from '@prisma/generator-helper';
-import { PluginError, PluginOptions, getDataModels, hasAttribute } from '@zenstackhq/sdk';
+import { PluginError, PluginOptions, PluginResult, getDataModels, hasAttribute } from '@zenstackhq/sdk';
 import { Model } from '@zenstackhq/sdk/ast';
 import type { OpenAPIV3_1 as OAPI } from 'openapi-types';
 import semver from 'semver';
@@ -12,7 +12,7 @@ export abstract class OpenAPIGeneratorBase {
 
     constructor(protected model: Model, protected options: PluginOptions, protected dmmf: DMMF.Document) {}
 
-    abstract generate(): string[];
+    abstract generate(): PluginResult;
 
     protected get includedModels() {
         return getDataModels(this.model).filter((d) => !hasAttribute(d, '@@openapi.ignore'));

diff --git a/packages/plugins/openapi/src/index.ts b/packages/plugins/openapi/src/index.ts
@@ -1,12 +1,14 @@
-import type { DMMF } from '@prisma/generator-helper';
-import { PluginError, PluginOptions } from '@zenstackhq/sdk';
-import { Model } from '@zenstackhq/sdk/ast';
+import { PluginError, PluginFunction } from '@zenstackhq/sdk';
 import { RESTfulOpenAPIGenerator } from './rest-generator';
 import { RPCOpenAPIGenerator } from './rpc-generator';
 
 export const name = 'OpenAPI';
 
-export default async function run(model: Model, options: PluginOptions, dmmf: DMMF.Document) {
+const run: PluginFunction = async (model, options, dmmf) => {
+    if (!dmmf) {
+        throw new Error('DMMF is required');
+    }
+
     const flavor = options.flavor ? (options.flavor as string) : 'rpc';
 
     switch (flavor) {
@@ -17,4 +19,6 @@ export default async function run(model: Model, options: PluginOptions, dmmf: DM
         default:
             throw new PluginError(name, `Unknown flavor: ${flavor}`);
     }
-}
+};
+
+export default run;
diff --git a/packages/plugins/openapi/src/rest-generator.ts b/packages/plugins/openapi/src/rest-generator.ts
@@ -76,7 +76,7 @@ export class RESTfulOpenAPIGenerator extends OpenAPIGeneratorBase {
             fs.writeFileSync(output, JSON.stringify(openapi, undefined, 2));
         }
 
-        return this.warnings;
+        return { warnings: this.warnings };
     }
 
     private generatePaths(): OAPI.PathsObject {

diff --git a/packages/plugins/openapi/src/rpc-generator.ts b/packages/plugins/openapi/src/rpc-generator.ts
@@ -89,7 +89,7 @@ export class RPCOpenAPIGenerator extends OpenAPIGeneratorBase {
             fs.writeFileSync(output, JSON.stringify(openapi, undefined, 2));
         }
 
-        return this.warnings;
+        return { warnings: this.warnings };
     }
 
     private generatePaths(components: OAPI.ComponentsObject): OAPI.PathsObject {

diff --git a/packages/plugins/swr/src/generator.ts b/packages/plugins/swr/src/generator.ts
@@ -49,26 +49,27 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
             warnings.push(`Unable to find mapping for model ${dataModel.name}`);
             return;
         }
-        generateModelHooks(project, outDir, dataModel, mapping, legacyMutations);
+        generateModelHooks(project, outDir, dataModel, mapping, legacyMutations, options);
     });
 
     await saveProject(project);
-    return warnings;
+    return { warnings };
 }
 
 function generateModelHooks(
     project: Project,
     outDir: string,
     model: DataModel,
     mapping: DMMF.ModelMapping,
-    legacyMutations: boolean
+    legacyMutations: boolean,
+    options: PluginOptions
 ) {
     const fileName = paramCase(model.name);
     const sf = project.createSourceFile(path.join(outDir, `${fileName}.ts`), undefined, { overwrite: true });
 
     sf.addStatements('/* eslint-disable */');
 
-    const prismaImport = getPrismaClientImportSpec(model.$container, outDir);
+    const prismaImport = getPrismaClientImportSpec(outDir, options);
     sf.addImportDeclaration({
         namedImports: ['Prisma'],
         isTypeOnly: true,

diff --git a/packages/plugins/swr/src/index.ts b/packages/plugins/swr/src/index.ts
@@ -1,10 +1,13 @@
-import type { DMMF } from '@prisma/generator-helper';
-import type { PluginOptions } from '@zenstackhq/sdk';
-import type { Model } from '@zenstackhq/sdk/ast';
+import type { PluginFunction } from '@zenstackhq/sdk';
 import { generate } from './generator';
 
 export const name = 'SWR';
 
-export default async function run(model: Model, options: PluginOptions, dmmf: DMMF.Document) {
+const run: PluginFunction = async (model, options, dmmf) => {
+    if (!dmmf) {
+        throw new Error('DMMF is required');
+    }
     return generate(model, options, dmmf);
-}
+};
+
+export default run;
diff --git a/packages/plugins/tanstack-query/src/generator.ts b/packages/plugins/tanstack-query/src/generator.ts
@@ -55,11 +55,11 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
             warnings.push(`Unable to find mapping for model ${dataModel.name}`);
             return;
         }
-        generateModelHooks(target, version, project, outDir, dataModel, mapping);
+        generateModelHooks(target, version, project, outDir, dataModel, mapping, options);
     });
 
     await saveProject(project);
-    return warnings;
+    return { warnings };
 }
 
 function generateQueryHook(
@@ -286,7 +286,8 @@ function generateModelHooks(
     project: Project,
     outDir: string,
     model: DataModel,
-    mapping: DMMF.ModelMapping
+    mapping: DMMF.ModelMapping,
+    options: PluginOptions
 ) {
     const modelNameCap = upperCaseFirst(model.name);
     const prismaVersion = getPrismaVersion();
@@ -295,7 +296,7 @@ function generateModelHooks(
 
     sf.addStatements('/* eslint-disable */');
 
-    const prismaImport = getPrismaClientImportSpec(model.$container, outDir);
+    const prismaImport = getPrismaClientImportSpec(outDir, options);
     sf.addImportDeclaration({
         namedImports: ['Prisma', model.name],
         isTypeOnly: true,

diff --git a/packages/plugins/tanstack-query/src/index.ts b/packages/plugins/tanstack-query/src/index.ts
@@ -1,10 +1,13 @@
-import type { DMMF } from '@prisma/generator-helper';
-import type { PluginOptions } from '@zenstackhq/sdk';
-import type { Model } from '@zenstackhq/sdk/ast';
+import type { PluginFunction } from '@zenstackhq/sdk';
 import { generate } from './generator';
 
 export const name = 'Tanstack Query';
 
-export default async function run(model: Model, options: PluginOptions, dmmf: DMMF.Document) {
+const run: PluginFunction = async (model, options, dmmf) => {
+    if (!dmmf) {
+        throw new Error('DMMF is required');
+    }
     return generate(model, options, dmmf);
-}
+};
+
+export default run;
diff --git a/packages/plugins/trpc/src/generator.ts b/packages/plugins/trpc/src/generator.ts
@@ -72,7 +72,8 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
         generateModelActions,
         generateClientHelpers,
         model,
-        zodSchemasImport
+        zodSchemasImport,
+        options
     );
     createHelper(outDir);
 
@@ -86,7 +87,8 @@ function createAppRouter(
     generateModelActions: string[] | undefined,
     generateClientHelpers: string[] | undefined,
     zmodel: Model,
-    zodSchemasImport: string
+    zodSchemasImport: string,
+    options: PluginOptions
 ) {
     const indexFile = path.resolve(outDir, 'routers', `index.ts`);
     const appRouter = project.createSourceFile(indexFile, undefined, {
@@ -95,7 +97,7 @@ function createAppRouter(
 
     appRouter.addStatements('/* eslint-disable */');
 
-    const prismaImport = getPrismaClientImportSpec(zmodel, path.dirname(indexFile));
+    const prismaImport = getPrismaClientImportSpec(path.dirname(indexFile), options);
     appRouter.addImportDeclarations([
         {
             namedImports: [
@@ -169,8 +171,8 @@ function createAppRouter(
                         outDir,
                         generateModelActions,
                         generateClientHelpers,
-                        zmodel,
-                        zodSchemasImport
+                        zodSchemasImport,
+                        options
                     );
 
                     appRouter.addImportDeclaration({
@@ -239,8 +241,8 @@ function generateModelCreateRouter(
     outputDir: string,
     generateModelActions: string[] | undefined,
     generateClientHelpers: string[] | undefined,
-    zmodel: Model,
-    zodSchemasImport: string
+    zodSchemasImport: string,
+    options: PluginOptions
 ) {
     const modelRouter = project.createSourceFile(path.resolve(outputDir, 'routers', `${model}.router.ts`), undefined, {
         overwrite: true,
@@ -258,7 +260,7 @@ function generateModelCreateRouter(
     generateRouterSchemaImport(modelRouter, zodSchemasImport);
     generateHelperImport(modelRouter);
     if (generateClientHelpers) {
-        generateRouterTypingImports(modelRouter, zmodel);
+        generateRouterTypingImports(modelRouter, options);
     }
 
     const createRouterFunc = modelRouter.addFunction({

diff --git a/packages/plugins/trpc/src/helpers.ts b/packages/plugins/trpc/src/helpers.ts
@@ -1,6 +1,5 @@
 import type { DMMF } from '@prisma/generator-helper';
-import { PluginError, getPrismaClientImportSpec } from '@zenstackhq/sdk';
-import { Model } from '@zenstackhq/sdk/ast';
+import { PluginError, getPrismaClientImportSpec, type PluginOptions } from '@zenstackhq/sdk';
 import { lowerCaseFirst } from 'lower-case-first';
 import { CodeBlockWriter, SourceFile } from 'ts-morph';
 import { upperCaseFirst } from 'upper-case-first';
@@ -225,9 +224,9 @@ export function generateRouterTyping(writer: CodeBlockWriter, opType: string, mo
     });
 }
 
-export function generateRouterTypingImports(sourceFile: SourceFile, model: Model) {
+export function generateRouterTypingImports(sourceFile: SourceFile, options: PluginOptions) {
     const importingDir = sourceFile.getDirectoryPath();
-    const prismaImport = getPrismaClientImportSpec(model, importingDir);
+    const prismaImport = getPrismaClientImportSpec(importingDir, options);
     sourceFile.addStatements([
         `import type { Prisma } from '${prismaImport}';`,
         `import type { UseTRPCMutationOptions, UseTRPCMutationResult, UseTRPCQueryOptions, UseTRPCQueryResult, UseTRPCInfiniteQueryOptions, UseTRPCInfiniteQueryResult } from '@trpc/react-query/shared';`,

diff --git a/packages/plugins/trpc/src/index.ts b/packages/plugins/trpc/src/index.ts
@@ -1,11 +1,14 @@
-import type { DMMF } from '@prisma/generator-helper';
-import { PluginOptions } from '@zenstackhq/sdk';
-import { Model } from '@zenstackhq/sdk/ast';
+import type { PluginFunction } from '@zenstackhq/sdk';
 import { generate } from './generator';
 
 export const name = 'tRPC';
 export const dependencies = ['@core/zod'];
 
-export default async function run(model: Model, options: PluginOptions, dmmf: DMMF.Document) {
+const run: PluginFunction = async (model, options, dmmf) => {
+    if (!dmmf) {
+        throw new Error('DMMF is required');
+    }
     return generate(model, options, dmmf);
-}
+};
+
+export default run;
diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -46,6 +46,9 @@
             "import": "./cross/index.mjs",
             "require": "./cross/index.js",
             "default": "./cross/index.js"
+        },
+        "./prisma": {
+            "types": "./prisma.d.ts"
         }
     },
     "publishConfig": {

diff --git a/packages/runtime/res/prisma.d.ts b/packages/runtime/res/prisma.d.ts
@@ -0,0 +1 @@
+export type * from '.zenstack/prisma';
diff --git a/packages/runtime/src/prisma.d.ts b/packages/runtime/src/prisma.d.ts
@@ -0,0 +1,2 @@
+// @ts-expect-error stub for re-exporting PrismaClient
+export type * from '.zenstack/prisma';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// @ts-expect-error stub for re-exporting PrismaClient
		export type * from '.zenstack/prisma';