Merge pull request #32 from poviolabs/feature/request-params-parse

Add optional request params parsing

Author: monikaboz

README.md

@@ -50,6 +50,7 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
   --axiosRequestConfig                Include Axios request config parameters in query hooks (default: false)
   --infiniteQueries                   Generate infinite queries for paginated API endpoints (default: false)
   --mutationEffects                   Add mutation effects options to mutation hooks (default: true)
+  --parseRequestParams                Add Zod parsing to API endpoints (default: false)
 
   --standalone                        Generate any missing supporting classes/types, e.g., REST client class, React Query type extensions, etc. (default: false)
   --baseUrl                           (Requires `--standalone`) Base URL for the REST client; falls back to the OpenAPI spec if not provided

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"

src/commands/generate.command.ts

@@ -69,6 +69,13 @@ class GenerateOptions implements GenerateParams {
   })
   mutationEffects!: boolean;
 
+  @YargOption({
+    envAlias: "parseRequestParams",
+    default: DEFAULT_GENERATE_OPTIONS.parseRequestParams,
+    type: "boolean",
+  })
+  parseRequestParams!: boolean;
+
   @YargOption({ envAlias: "axiosRequestConfig", default: DEFAULT_GENERATE_OPTIONS.axiosRequestConfig, type: "boolean" })
   axiosRequestConfig!: boolean;
 

src/commands/generate.ts

@@ -28,6 +28,7 @@ export type GenerateParams = {
   | "infiniteQueries"
   | "axiosRequestConfig"
   | "mutationEffects"
+  | "parseRequestParams"
 >;
 
 export async function generate({ input, excludeTags, monorepo, prettier, verbose, ...params }: GenerateParams) {

src/generators/const/options.const.ts

@@ -44,6 +44,7 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   restClientImportPath: TEMPLATE_IMPORTS.appRestClient.template,
   errorHandlingImportPath: TEMPLATE_IMPORTS.errorHandling.template,
   removeOperationPrefixEndingWith: "Controller_",
+  parseRequestParams: false,
   // Queries options
   queryTypesImportPath: TEMPLATE_IMPORTS.queryTypes.template,
   axiosRequestConfig: false,

src/generators/generate/generateEndpoints.ts

@@ -11,7 +11,6 @@ import {
   getZodExtendedImportPath,
 } from "../utils/generate/generate.utils";
 import { getHbsTemplateDelegate } from "../utils/hbs/hbs-template.utils";
-import { isString } from "../utils/string.utils";
 import { isNamedZodSchema } from "../utils/zod-schema.utils";
 
 export function generateEndpoints({ resolver, data, tag = "" }: GenerateTypeParams) {
@@ -25,32 +24,34 @@ export function generateEndpoints({ resolver, data, tag = "" }: GenerateTypePara
     from: getAppRestClientImportPath(resolver.options),
   };
 
-  const hasZodExtendedImport = endpoints.some((endpoint) =>
-    endpoint.parameters.some((param) => param.parameterSortingEnumSchemaName),
-  );
-  const zodExtendedImport: Import = {
-    bindings: [ZOD_EXTENDED.name],
-    from: getZodExtendedImportPath(resolver.options),
-  };
-
   const hasAxiosRequestConfig = resolver.options.axiosRequestConfig;
   const hasAxiosImport = hasAxiosRequestConfig;
   const axiosImport: Import = {
     bindings: hasAxiosRequestConfig ? [AXIOS_REQUEST_CONFIG_TYPE] : [],
     from: AXIOS_IMPORT.from,
   };
 
-  const endpointResponseSchemas = endpoints.map((endpoint) => endpoint.response);
-  const hasZodImport = endpointResponseSchemas.some((response) => !isNamedZodSchema(response));
+  const generateParse = resolver.options.parseRequestParams;
 
   const endpointParams = endpoints.reduce((prev, curr) => [...prev, ...curr.parameters], [] as EndpointParameter[]);
+  const endpointParamsParseSchemas = endpointParams
+    .filter((param) => !["Path", "Header"].includes(param.type))
+    .map((param) => param.parameterSortingEnumSchemaName ?? param.zodSchema);
+  const endpointResponseSchemas = endpoints.map((endpoint) => endpoint.response);
+  const zodSchemas = getUniqueArray([...endpointResponseSchemas, ...(generateParse ? endpointParamsParseSchemas : [])]);
+
+  const hasZodImport = zodSchemas.some((schema) => !isNamedZodSchema(schema));
+
+  const hasZodExtendedImport = resolver.options.parseRequestParams && endpointParamsParseSchemas.length > 0;
+  const zodExtendedImport: Import = {
+    bindings: [ZOD_EXTENDED.name],
+    from: getZodExtendedImportPath(resolver.options),
+  };
+
   const modelsImports = getModelsImports({
     resolver,
     tag,
-    zodSchemas: getUniqueArray([
-      ...endpointResponseSchemas.filter(isNamedZodSchema),
-      ...endpointParams.map((param) => param.parameterSortingEnumSchemaName).filter(isString),
-    ]),
+    zodSchemas: zodSchemas.filter(isNamedZodSchema),
     zodSchemasAsTypes: getUniqueArray(endpointParams.map((param) => param.zodSchema).filter(isNamedZodSchema)),
   });
 
@@ -72,5 +73,6 @@ export function generateEndpoints({ resolver, data, tag = "" }: GenerateTypePara
     axiosRequestConfigName: AXIOS_REQUEST_CONFIG_NAME,
     axiosRequestConfigType: AXIOS_REQUEST_CONFIG_TYPE,
     endpoints,
+    generateParse,
   });
 }

src/generators/templates/endpoints.hbs

@@ -30,7 +30,7 @@ export const {{endpointName endpoint}} = ({{{genEndpointParams endpoint}}}{{#if
         `{{endpointPath endpoint}}`,
         {{! Body }}
         {{#with (endpointBody endpoint) as | endpointBody |}}
-        {{#if endpointBody}}{{endpointBody.name}}, {{/if}}
+        {{#if endpointBody}}{{#if ../../generateParse}}{{{genEndpointParamParse endpointBody endpointBody.name}}}{{else}}{{endpointBody.name}}{{/if}}, {{/if}}
         {{/with}}
         {{! Config }}
         {{{genEndpointConfig endpoint}}}

src/generators/templates/partials/endpoint-config.hbs

@@ -7,9 +7,9 @@
     params: {
         {{#each endpointConfig.params as | param |}}
         {{#if (isEqual param.name param.value) }}
-        {{{param.name}}}{{#if param.parameterSortingEnumSchemaName}}: {{{genEndpointParamSorting param.parameterSortingEnumSchemaName param.name}}}{{/if}}, 
+        {{{param.name}}}{{#if ../generateParse}}: {{{genEndpointParamParse param param.name}}}{{/if}}, 
         {{else}}
-        {{{param.name}}}: {{#if param.parameterSortingEnumSchemaName}}{{{genEndpointParamSorting param.parameterSortingEnumSchemaName param.value}}}{{else}}{{param.value}}{{/if}},
+        {{{param.name}}}: {{#if ../generateParse}}{{{genEndpointParamParse param param.value}}}{{else}}{{param.value}}{{/if}},
         {{/if}}
         {{/each}}
     },

src/generators/templates/partials/endpoint-param-parse.hbs

@@ -0,0 +1 @@
+{{zodExtended}}.{{parse}}({{#if param.parameterSortingEnumSchemaName}}{{zodExtended}}.{{sortingString}}({{importedZodSchemaName param.parameterSortingEnumSchemaName}}){{#if addOptional}}.optional(){{/if}}{{else}}{{importedZodSchemaName param.zodSchema}}{{#if addOptional}}.optional(){{/if}}{{/if}}, {{paramName}})