first ts-to-zod integration prototype

riccardos77 · riccardos77 · commit 913198cc5191 · 2024-01-22T08:42:53.000+01:00
diff --git a/cli/src/commands/GenerateCommand.ts b/cli/src/commands/GenerateCommand.ts
@@ -233,6 +233,7 @@ export class GenerateCommand extends Command {
     const prettierConfig = await prettier.resolveConfig(process.cwd());
 
     const writeFile = async (file: string, data: string) => {
+      data = "/* eslint-disable */\n" + data;
       await fsExtra.outputFile(
         path.join(process.cwd(), config.outputDir, file),
         prettier.format(data, { parser: "babel-ts", ...prettierConfig })
diff --git a/plugins/typescript/package.json b/plugins/typescript/package.json
@@ -32,6 +32,7 @@
     "lodash": "^4.17.21",
     "openapi3-ts": "^2.0.1",
     "pluralize": "^8.0.0",
+    "ts-to-zod": "^3.6.1",
     "tslib": "^2.3.1",
     "tsutils": "^3.21.0",
     "typescript": "4.8.2"
diff --git a/plugins/typescript/src/core/createNamespaceImport.ts b/plugins/typescript/src/core/createNamespaceImport.ts
@@ -7,11 +7,11 @@ import { factory as f } from "typescript";
  * @param filename path of the module
  * @returns ts.Node of the import declaration
  */
-export const createNamespaceImport = (namespace: string, filename: string) =>
+export const createNamespaceImport = (namespace: string, filename: string, isTypeOnly = true) =>
   f.createImportDeclaration(
     undefined,
     f.createImportClause(
-      true,
+      isTypeOnly,
       undefined,
       f.createNamespaceImport(f.createIdentifier(namespace))
     ),
diff --git a/plugins/typescript/src/core/createOperationFetcherFnNodes.ts b/plugins/typescript/src/core/createOperationFetcherFnNodes.ts
@@ -1,5 +1,6 @@
 import { OperationObject } from "openapi3-ts";
 import ts, { factory as f } from "typescript";
+import { createZodValidatorResponse } from "../utils/zodHelper";
 import { camelizedPathParams } from "./camelizedPathParams";
 
 /**
@@ -20,6 +21,7 @@ export const createOperationFetcherFnNodes = ({
   url,
   verb,
   name,
+  printNodes,
 }: {
   dataType: ts.TypeNode;
   errorType: ts.TypeNode;
@@ -33,6 +35,7 @@ export const createOperationFetcherFnNodes = ({
   url: string;
   verb: string;
   name: string;
+  printNodes: (nodes: ts.Node[]) => string;
 }) => {
   const nodes: ts.Node[] = [];
   if (operation.description) {
@@ -119,6 +122,7 @@ export const createOperationFetcherFnNodes = ({
                               f.createIdentifier("signal")
                             ),
                           ]),
+                      ...createZodValidatorResponse(dataType, printNodes),
                     ],
                     false
                   ),
diff --git a/plugins/typescript/src/generators/generateFetchers.ts b/plugins/typescript/src/generators/generateFetchers.ts
@@ -1,21 +1,22 @@
-import ts, { factory as f } from "typescript";
 import * as c from "case";
 import { get } from "lodash";
+import ts, { factory as f } from "typescript";
 
-import { ConfigBase, Context } from "./types";
 import { PathItemObject } from "openapi3-ts";
+import { ConfigBase, Context } from "./types";
 
-import { getUsedImports } from "../core/getUsedImports";
-import { createWatermark } from "../core/createWatermark";
+import { createNamedImport } from "../core/createNamedImport";
 import { createOperationFetcherFnNodes } from "../core/createOperationFetcherFnNodes";
-import { isVerb } from "../core/isVerb";
-import { isOperationObject } from "../core/isOperationObject";
+import { createWatermark } from "../core/createWatermark";
 import { getOperationTypes } from "../core/getOperationTypes";
-import { createNamedImport } from "../core/createNamedImport";
+import { getUsedImports } from "../core/getUsedImports";
+import { isOperationObject } from "../core/isOperationObject";
+import { isVerb } from "../core/isVerb";
 
+import { createNamespaceImport } from "../core/createNamespaceImport";
 import { getFetcher } from "../templates/fetcher";
 import { getUtils } from "../templates/utils";
-import { createNamespaceImport } from "../core/createNamespaceImport";
+import { createZodNamespaceImport } from "../utils/zodHelper";
 
 export type Config = ConfigBase & {
   /**
@@ -33,6 +34,12 @@ export type Config = ConfigBase & {
    * This will mark the header as optional in the component API
    */
   injectedHeaders?: string[];
+  
+  zodFiles?: {
+    schemas: string;
+    inferredTypes: string;
+    integrationTests: string;
+  }
 };
 
 export const generateFetchers = async (context: Context, config: Config) => {
@@ -172,6 +179,7 @@ export const generateFetchers = async (context: Context, config: Config) => {
             url: route,
             verb,
             name: operationId,
+            printNodes,
           })
         );
       });
@@ -230,6 +238,7 @@ export const generateFetchers = async (context: Context, config: Config) => {
       createWatermark(context.openAPIDocument.info),
       createNamespaceImport("Fetcher", `./${fetcherFilename}`),
       createNamedImport(fetcherImports, `./${fetcherFilename}`),
+      ...createZodNamespaceImport(config.zodFiles?.schemas),
       ...usedImportsNodes,
       ...nodes,
     ])
diff --git a/plugins/typescript/src/generators/generateReactQueryComponents.ts b/plugins/typescript/src/generators/generateReactQueryComponents.ts
@@ -16,6 +16,7 @@ import { createNamedImport } from "../core/createNamedImport";
 import { getFetcher } from "../templates/fetcher";
 import { getContext } from "../templates/context";
 import { getUtils } from "../templates/utils";
+import { createZodNamespaceImport } from "../utils/zodHelper";
 import { createNamespaceImport } from "../core/createNamespaceImport";
 import { camelizedPathParams } from "../core/camelizedPathParams";
 
@@ -35,6 +36,12 @@ export type Config = ConfigBase & {
    * This will mark the header as optional in the component API
    */
   injectedHeaders?: string[];
+
+  zodFiles?: {
+    schemas: string;
+    inferredTypes: string;
+    integrationTests: string;
+  }
 };
 
 export const generateReactQueryComponents = async (
@@ -58,9 +65,9 @@ export const generateReactQueryComponents = async (
         return (
           printer.printNode(ts.EmitHint.Unspecified, node, sourceFile) +
           (ts.isJSDoc(node) ||
-          (ts.isImportDeclaration(node) &&
-            nodes[i + 1] &&
-            ts.isImportDeclaration(nodes[i + 1]))
+            (ts.isImportDeclaration(node) &&
+              nodes[i + 1] &&
+              ts.isImportDeclaration(nodes[i + 1]))
             ? ""
             : "\n")
         );
@@ -195,28 +202,29 @@ export const generateReactQueryComponents = async (
             url: route,
             verb,
             name: operationFetcherFnName,
+            printNodes,
           }),
           ...(component === "useQuery"
             ? createQueryHook({
-                operationFetcherFnName,
-                operation,
-                dataType,
-                errorType,
-                variablesType,
-                contextHookName,
-                name: `use${c.pascal(operationId)}`,
-                operationId,
-                url: route,
-              })
+              operationFetcherFnName,
+              operation,
+              dataType,
+              errorType,
+              variablesType,
+              contextHookName,
+              name: `use${c.pascal(operationId)}`,
+              operationId,
+              url: route,
+            })
             : createMutationHook({
-                operationFetcherFnName,
-                operation,
-                dataType,
-                errorType,
-                variablesType,
-                contextHookName,
-                name: `use${c.pascal(operationId)}`,
-              }))
+              operationFetcherFnName,
+              operation,
+              dataType,
+              errorType,
+              variablesType,
+              contextHookName,
+              name: `use${c.pascal(operationId)}`,
+            }))
         );
       });
     }
@@ -232,25 +240,25 @@ export const generateReactQueryComponents = async (
     keyManagerItems.length > 0
       ? f.createUnionTypeNode(keyManagerItems)
       : f.createTypeLiteralNode([
-          f.createPropertySignature(
-            undefined,
-            f.createIdentifier("path"),
-            undefined,
-            f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
-          ),
-          f.createPropertySignature(
-            undefined,
-            f.createIdentifier("operationId"),
-            undefined,
-            f.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword)
-          ),
-          f.createPropertySignature(
-            undefined,
-            f.createIdentifier("variables"),
-            undefined,
-            f.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)
-          ),
-        ])
+        f.createPropertySignature(
+          undefined,
+          f.createIdentifier("path"),
+          undefined,
+          f.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+        ),
+        f.createPropertySignature(
+          undefined,
+          f.createIdentifier("operationId"),
+          undefined,
+          f.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword)
+        ),
+        f.createPropertySignature(
+          undefined,
+          f.createIdentifier("variables"),
+          undefined,
+          f.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)
+        ),
+      ])
   );
 
   const { nodes: usedImportsNodes, keys: usedImportsKeys } = getUsedImports(
@@ -276,6 +284,7 @@ export const generateReactQueryComponents = async (
       ),
       createNamespaceImport("Fetcher", `./${fetcherFilename}`),
       createNamedImport(fetcherFn, `./${fetcherFilename}`),
+      ...createZodNamespaceImport(config.zodFiles?.schemas),
       ...usedImportsNodes,
       ...nodes,
       queryKeyManager,
diff --git a/plugins/typescript/src/generators/generateReactQueryFunctions.ts b/plugins/typescript/src/generators/generateReactQueryFunctions.ts
@@ -19,6 +19,7 @@ import { getFetcher } from "../templates/fetcher";
 import { getContext } from "../templates/context";
 import { getUtils } from "../templates/utils";
 import { createNamespaceImport } from "../core/createNamespaceImport";
+import { createZodNamespaceImport } from "../utils/zodHelper";
 import { camelizedPathParams } from "../core/camelizedPathParams";
 
 export type Config = ConfigBase & {
@@ -37,6 +38,12 @@ export type Config = ConfigBase & {
    * This will mark the header as optional in the component API
    */
   injectedHeaders?: string[];
+  
+  zodFiles?: {
+    schemas: string;
+    inferredTypes: string;
+    integrationTests: string;
+  }
 };
 
 export const generateReactQueryFunctions = async (
@@ -199,6 +206,7 @@ export const generateReactQueryFunctions = async (
               url: route,
               verb,
               name: operationFetcherFnName,
+              printNodes,
             }),
             ...createOperationQueryFnNodes({
               operationFetcherFnName,
@@ -275,6 +283,7 @@ export const generateReactQueryFunctions = async (
       ),
       createNamespaceImport("Fetcher", `./${fetcherFilename}`),
       createNamedImport(fetcherFn, `./${fetcherFilename}`),
+      ...createZodNamespaceImport(config.zodFiles?.schemas),
       ...usedImportsNodes,
       ...nodes,
       queryKeyManager,
diff --git a/plugins/typescript/src/generators/generateZod.ts b/plugins/typescript/src/generators/generateZod.ts
@@ -0,0 +1,52 @@
+import * as c from "case";
+import { GenerateProps, generate } from "ts-to-zod";
+import { ConfigBase, Context } from "../generators/types";
+
+export type Config = ConfigBase & {
+    /**
+     * Generated files paths from `generateSchemaTypes`
+     */
+    schemasFiles: {
+        requestBodies: string;
+        schemas: string;
+        parameters: string;
+        responses: string;
+    };
+    generateProps?: GenerateProps;
+    writeInferredTypes?: boolean
+    writeIntegrationTests?: boolean
+};
+
+export const generateZod = async (context: Context, config: Config) => {
+    const result = generate({
+        sourceText: await context.readFile(config.schemasFiles.schemas + ".ts"),
+        ...config.generateProps,
+    })
+
+    const filenamePrefix =
+        c.snake(config.filenamePrefix ?? context.openAPIDocument.info.title) + "-";
+
+    const formatFilename = config.filenameCase ? c[config.filenameCase] : c.camel;
+
+    const zodFiles = {
+        schemas: formatFilename(filenamePrefix + "-zod-schemas"),
+        inferredTypes: formatFilename(filenamePrefix + "-zod-inferred-types"),
+        integrationTests: formatFilename(filenamePrefix + "-zod-integration-tests"),
+    }
+
+    if (result.errors.length === 0) {
+        await context.writeFile(zodFiles.schemas + ".ts", result.getZodSchemasFile("./" + config.schemasFiles.schemas));
+
+        if (config.writeInferredTypes !== false) {
+            await context.writeFile(zodFiles.inferredTypes + ".ts", result.getInferredTypes("./" + zodFiles.schemas));
+
+            if (config.writeIntegrationTests !== false) {
+                await context.writeFile(zodFiles.integrationTests + ".ts", result.getIntegrationTestFile("./" + zodFiles.inferredTypes, "./" + zodFiles.schemas));
+            }
+        }
+    } else {
+        console.log(`⚠️ Zod Generate finished with errors!`, result.errors);
+    }
+
+    return zodFiles
+}
diff --git a/plugins/typescript/src/index.ts b/plugins/typescript/src/index.ts
@@ -3,6 +3,7 @@ export { generateSchemaTypes } from "./generators/generateSchemaTypes";
 export { generateReactQueryComponents } from "./generators/generateReactQueryComponents";
 export { generateReactQueryFunctions } from "./generators/generateReactQueryFunctions";
 export { generateFetchers } from "./generators/generateFetchers";
+export { generateZod } from "./generators/generateZod";
 
 // Utils
 export { renameComponent } from "./utils/renameComponent";
diff --git a/plugins/typescript/src/templates/fetcher.ts b/plugins/typescript/src/templates/fetcher.ts
diff --git a/plugins/typescript/src/utils/zodHelper.ts b/plugins/typescript/src/utils/zodHelper.ts
