fix: make sure zod schemas have type annotations (zenstackhq#574)

Eventiva · Jul 10, 2023 · 51985b1 · 51985b1
1 parent 1e1ad8f
commit 51985b1
Show file tree

Hide file tree

Showing 26 changed files with 369 additions and 252 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ dist
 .env.local
 .npmcache
 coverage
+.build
diff --git a/packages/language/package.json b/packages/language/package.json
@@ -9,7 +9,7 @@
         "generate": "langium generate",
         "watch": "concurrently \"langium generate --watch\" \"tsc --watch\"",
         "lint": "eslint src --ext ts",
-        "build": "pnpm lint && pnpm clean && pnpm generate && tsc && copyfiles -F ./README.md ./LICENSE ./package.json dist",
+        "build": "pnpm lint && pnpm clean && pnpm generate && tsc && copyfiles -F ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination '../../../.build'",
         "prepublishOnly": "pnpm build",
         "publish-dev": "pnpm build && pnpm publish --tag dev"
     },

diff --git a/packages/plugins/openapi/package.json b/packages/plugins/openapi/package.json
@@ -14,7 +14,7 @@
   },
   "scripts": {
     "clean": "rimraf dist",
-    "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE dist && copyfiles -u 1 ./src/plugin.zmodel dist",
+    "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE dist && copyfiles -u 1 ./src/plugin.zmodel dist && pnpm pack dist --pack-destination '../../../../.build'",
     "watch": "tsc --watch",
     "lint": "eslint src --ext ts",
     "test": "jest",

diff --git a/packages/plugins/swr/package.json b/packages/plugins/swr/package.json
@@ -10,7 +10,7 @@
     },
     "scripts": {
         "clean": "rimraf dist",
-        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist",
+        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist && pnpm pack dist --pack-destination '../../../../.build'",
         "watch": "tsc --watch",
         "lint": "eslint src --ext ts",
         "test": "jest",

diff --git a/packages/plugins/tanstack-query/package.json b/packages/plugins/tanstack-query/package.json
@@ -10,7 +10,7 @@
     },
     "scripts": {
         "clean": "rimraf dist",
-        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist",
+        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist && pnpm pack dist --pack-destination '../../../../.build'",
         "watch": "tsc --watch",
         "lint": "eslint src --ext ts",
         "test": "jest",

diff --git a/packages/plugins/trpc/package.json b/packages/plugins/trpc/package.json
@@ -10,7 +10,7 @@
     },
     "scripts": {
         "clean": "rimraf dist",
-        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist",
+        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ./LICENSE 'res/**/*' dist && pnpm pack dist --pack-destination '../../../../.build'",
         "watch": "tsc --watch",
         "lint": "eslint src --ext ts",
         "prepublishOnly": "pnpm build",

diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -9,7 +9,7 @@
     },
     "scripts": {
         "clean": "rimraf dist",
-        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ../../LICENSE dist && copyfiles -u1 'res/**/*' dist",
+        "build": "pnpm lint && pnpm clean && tsc && copyfiles ./package.json ./README.md ../../LICENSE dist && copyfiles -u1 'res/**/*' dist && pnpm pack dist --pack-destination '../../../.build'",
         "watch": "tsc --watch",
         "lint": "eslint src --ext ts",
         "prepublishOnly": "pnpm build",

diff --git a/packages/schema/package.json b/packages/schema/package.json
@@ -69,7 +69,7 @@
         "vscode:prepublish": "pnpm bundle",
         "vscode:package": "vsce package --no-dependencies",
         "clean": "rimraf bundle dist",
-        "build": "pnpm clean && pnpm lint && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README-global.md ./LICENSE ./package.json dist && renamer --replace \"README.md\" dist/README-global.md && copyfiles -u 1 \"src/res/*\" dist && node build/post-build.js",
+        "build": "pnpm clean && pnpm lint && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README-global.md ./LICENSE ./package.json dist && renamer --replace \"README.md\" dist/README-global.md && copyfiles -u 1 \"src/res/*\" dist && node build/post-build.js && pnpm pack dist --pack-destination '../../../.build'",
         "bundle": "pnpm clean && pnpm lint && node build/bundle.js --minify",
         "watch": "tsc --watch",
         "lint": "eslint src tests --ext ts",
@@ -127,7 +127,6 @@
         "@typescript-eslint/parser": "^5.42.0",
         "@vscode/vsce": "^2.19.0",
         "@zenstackhq/runtime": "workspace:*",
-        "@zenstackhq/testtools": "workspace:*",
         "concurrently": "^7.4.0",
         "copyfiles": "^2.4.1",
         "dotenv": "^16.0.3",

diff --git a/packages/schema/src/plugins/plugin-utils.ts b/packages/schema/src/plugins/plugin-utils.ts
@@ -40,7 +40,7 @@ export function getDefaultOutputFolder() {
     // Find the real runtime module path, it might be a symlink in pnpm
     let runtimeModulePath = require.resolve('@zenstackhq/runtime');
 
-    if (process.env.NODE_ENV === 'test') {
+    if (process.env.ZENSTACK_TEST === '1') {
         // handling the case when running as tests, resolve relative to CWD
         runtimeModulePath = path.resolve(path.join(process.cwd(), 'node_modules', '@zenstackhq', 'runtime'));
     }

diff --git a/packages/schema/src/plugins/zod/transformer.ts b/packages/schema/src/plugins/zod/transformer.ts
@@ -253,10 +253,9 @@ export default class Transformer {
         if (isAggregateInputType(name)) {
             name = `${name}Type`;
         }
-        const end = `export const ${this.name}ObjectSchema = Schema`;
-        return `const Schema: z.ZodType<Omit<Prisma.${name}, ${AUXILIARY_FIELDS.map((f) => "'" + f + "'").join(
-            '|'
-        )}>> = ${schema};\n\n ${end}`;
+        return `export const ${this.name}ObjectSchema: z.ZodType<Omit<Prisma.${name}, ${AUXILIARY_FIELDS.map(
+            (f) => "'" + f + "'"
+        ).join('|')}>> = ${schema};`;
     }
 
     addFinalWrappers({ zodStringFields }: { zodStringFields: string[] }) {
@@ -390,14 +389,21 @@ export default class Transformer {
             const { selectImport, includeImport, selectZodSchemaLineLazy, includeZodSchemaLineLazy } =
                 this.resolveSelectIncludeImportAndZodSchemaLine(model);
 
-            let imports = [`import { z } from 'zod'`, selectImport, includeImport];
+            let imports = [
+                `import { z } from 'zod'`,
+                this.generateImportPrismaStatement(),
+                selectImport,
+                includeImport,
+            ];
             let codeBody = '';
+            const operations: [string, string][] = [];
 
             if (findUnique) {
                 imports.push(
                     `import { ${modelName}WhereUniqueInputObjectSchema } from '../objects/${modelName}WhereUniqueInput.schema'`
                 );
                 codeBody += `findUnique: z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} where: ${modelName}WhereUniqueInputObjectSchema }),`;
+                operations.push(['findUnique', modelName]);
             }
 
             if (findFirst) {
@@ -412,6 +418,7 @@ export default class Transformer {
                 codeBody += `findFirst: z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} where: ${modelName}WhereInputObjectSchema.optional(), orderBy: z.union([${modelName}OrderByWithRelationInputObjectSchema, ${modelName}OrderByWithRelationInputObjectSchema.array()]).optional(), cursor: ${modelName}WhereUniqueInputObjectSchema.optional(), take: z.number().optional(), skip: z.number().optional(), distinct: z.array(${upperCaseFirst(
                     modelName
                 )}ScalarFieldEnumSchema).optional() }),`;
+                operations.push(['findFirst', modelName]);
             }
 
             if (findMany) {
@@ -426,6 +433,7 @@ export default class Transformer {
                 codeBody += `findMany: z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} where: ${modelName}WhereInputObjectSchema.optional(), orderBy: z.union([${modelName}OrderByWithRelationInputObjectSchema, ${modelName}OrderByWithRelationInputObjectSchema.array()]).optional(), cursor: ${modelName}WhereUniqueInputObjectSchema.optional(), take: z.number().optional(), skip: z.number().optional(), distinct: z.array(${upperCaseFirst(
                     modelName
                 )}ScalarFieldEnumSchema).optional()  }),`;
+                operations.push(['findMany', modelName]);
             }
 
             if (createOne) {
@@ -434,27 +442,31 @@ export default class Transformer {
                     `import { ${modelName}UncheckedCreateInputObjectSchema } from '../objects/${modelName}UncheckedCreateInput.schema'`
                 );
                 codeBody += `create: z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} data: z.union([${modelName}CreateInputObjectSchema, ${modelName}UncheckedCreateInputObjectSchema]) }),`;
+                operations.push(['create', modelName]);
             }
 
             if (createMany) {
                 imports.push(
                     `import { ${modelName}CreateManyInputObjectSchema } from '../objects/${modelName}CreateManyInput.schema'`
                 );
                 codeBody += `createMany: z.object({ data: z.union([${modelName}CreateManyInputObjectSchema, z.array(${modelName}CreateManyInputObjectSchema)]) }),`;
+                operations.push(['createMany', modelName]);
             }
 
             if (deleteOne) {
                 imports.push(
                     `import { ${modelName}WhereUniqueInputObjectSchema } from '../objects/${modelName}WhereUniqueInput.schema'`
                 );
                 codeBody += `'delete': z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} where: ${modelName}WhereUniqueInputObjectSchema  }),`;
+                operations.push(['delete', modelName]);
             }
 
             if (deleteMany) {
                 imports.push(
                     `import { ${modelName}WhereInputObjectSchema } from '../objects/${modelName}WhereInput.schema'`
                 );
                 codeBody += `deleteMany: z.object({ where: ${modelName}WhereInputObjectSchema.optional()  }),`;
+                operations.push(['deleteMany', modelName]);
             }
 
             if (updateOne) {
@@ -464,6 +476,7 @@ export default class Transformer {
                     `import { ${modelName}WhereUniqueInputObjectSchema } from '../objects/${modelName}WhereUniqueInput.schema'`
                 );
                 codeBody += `update: z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} data: z.union([${modelName}UpdateInputObjectSchema, ${modelName}UncheckedUpdateInputObjectSchema]), where: ${modelName}WhereUniqueInputObjectSchema  }),`;
+                operations.push(['update', modelName]);
             }
 
             if (updateMany) {
@@ -473,6 +486,7 @@ export default class Transformer {
                     `import { ${modelName}WhereInputObjectSchema } from '../objects/${modelName}WhereInput.schema'`
                 );
                 codeBody += `updateMany: z.object({ data: z.union([${modelName}UpdateManyMutationInputObjectSchema, ${modelName}UncheckedUpdateManyInputObjectSchema]), where: ${modelName}WhereInputObjectSchema.optional()  }),`;
+                operations.push(['updateMany', modelName]);
             }
 
             if (upsertOne) {
@@ -484,6 +498,7 @@ export default class Transformer {
                     `import { ${modelName}UncheckedUpdateInputObjectSchema } from '../objects/${modelName}UncheckedUpdateInput.schema'`
                 );
                 codeBody += `upsert: z.object({ ${selectZodSchemaLineLazy} ${includeZodSchemaLineLazy} where: ${modelName}WhereUniqueInputObjectSchema, create: z.union([${modelName}CreateInputObjectSchema, ${modelName}UncheckedCreateInputObjectSchema]), update: z.union([${modelName}UpdateInputObjectSchema, ${modelName}UncheckedUpdateInputObjectSchema]) }),`;
+                operations.push(['upsert', modelName]);
             }
 
             const aggregateOperations = [];
@@ -532,6 +547,7 @@ export default class Transformer {
                 codeBody += `aggregate: z.object({ where: ${modelName}WhereInputObjectSchema.optional(), orderBy: z.union([${modelName}OrderByWithRelationInputObjectSchema, ${modelName}OrderByWithRelationInputObjectSchema.array()]).optional(), cursor: ${modelName}WhereUniqueInputObjectSchema.optional(), take: z.number().optional(), skip: z.number().optional(), ${aggregateOperations.join(
                     ', '
                 )} }),`;
+                operations.push(['aggregate', modelNameVar]);
             }
 
             if (groupBy) {
@@ -546,6 +562,7 @@ export default class Transformer {
                 codeBody += `groupBy: z.object({ where: ${modelName}WhereInputObjectSchema.optional(), orderBy: z.union([${modelName}OrderByWithAggregationInputObjectSchema, ${modelName}OrderByWithAggregationInputObjectSchema.array()]).optional(), having: ${modelName}ScalarWhereWithAggregatesInputObjectSchema.optional(), take: z.number().optional(), skip: z.number().optional(), by: z.array(${upperCaseFirst(
                     modelName
                 )}ScalarFieldEnumSchema), ${aggregateOperations.join(', ')} }),`;
+                operations.push(['groupBy', modelNameVar]);
             }
 
             imports = [...new Set(imports)];
@@ -555,7 +572,13 @@ export default class Transformer {
             /* eslint-disable */
             ${imports.join(';\n')}
             
-            export const ${modelName}InputSchema = {
+            type ${modelName}InputSchemaType = {
+${operations
+    .map((op) => indentString(`${op[0]}: z.ZodType<Prisma.${op[1]}${upperCaseFirst(op[0])}Args>`, 4))
+    .join(',\n')}
+            }
+
+            export const ${modelName}InputSchema: ${modelName}InputSchemaType = {
             ${indentString(codeBody, 4)}
             };
                         `;

diff --git a/packages/schema/src/utils/pkg-utils.ts b/packages/schema/src/utils/pkg-utils.ts
@@ -47,9 +47,7 @@ export function installPackage(
     switch (manager) {
         case 'yarn':
             execSync(
-                `yarn --cwd "${projectPath}" add ${exactVersion ? '--exact' : ''} ${pkg}@${tag} ${
-                    dev ? ' --dev' : ''
-                } --ignore-engines`
+                `yarn --cwd "${projectPath}" add ${exactVersion ? '--exact' : ''} ${pkg}@${tag} ${dev ? ' --dev' : ''}`
             );
             break;