@povio/openapi-codegen-cli 0.8.2 → 0.9.0

package/package.json

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

package/src/assets/zodExtended.ts

@@ -0,0 +1,24 @@
+/* eslint-disable no-useless-escape */
+import { z } from "zod";
+
+export const zodExtended = {
+  sortingString: (enumSchema: z.ZodEnum<[string, ...string[]]>) =>
+    z.string().superRefine((val, ctx) => {
+      if (!isSortingStringValid(val, enumSchema)) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: "Invalid order string.",
+        });
+      }
+    }),
+};
+
+function isSortingStringValid(val: string, enumSchema: z.ZodEnum<[string, ...string[]]>) {
+  if (val === "" || enumSchema.options.length === 0) {
+    return true;
+  }
+
+  const prefixedEnumOptions = `([+-]?(${enumSchema.options.join("|")}))`;
+  const commaSeparatedOptions = `(${prefixedEnumOptions})(\s*,\s*${prefixedEnumOptions})*`;
+  return new RegExp(`^${commaSeparatedOptions}$`).test(val);
+}

package/src/generators/templates/endpoints.hbs

@@ -8,6 +8,10 @@
 {{#if hasZodImport}}
 {{{genImport zodImport}}}
 {{/if}}
+{{! Zod extended import }}
+{{#if hasZodExtendedImport}}
+{{{genImport zodExtendedImport}}}
+{{/if}}
 {{! Models import }}
 {{#each modelsImports as | modelsImport |}}
 {{{genImport modelsImport}}}

package/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}}},
+        {{{param.name}}}{{#if param.parameterSortingEnumSchemaName}}: {{{genEndpointParamSorting param.parameterSortingEnumSchemaName param.name}}}{{/if}}, 
         {{else}}
-        {{{param.name}}}: {{param.value}},
+        {{{param.name}}}: {{#if param.parameterSortingEnumSchemaName}}{{{genEndpointParamSorting param.parameterSortingEnumSchemaName param.value}}}{{else}}{{param.value}}{{/if}},
         {{/if}}
         {{/each}}
     },

package/src/generators/templates/partials/endpoint-param-sorting.hbs

@@ -0,0 +1 @@
+{{zodExtended}}.{{sortingString}}({{importedZodSchemaName enumSchemaName}}).parse({{paramName}})

package/src/generators/templates/partials/query-js-docs.hbs

@@ -10,22 +10,22 @@
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{else if query}}
  /** 
- * Query `{{queryName endpoint}}`{{#if endpoint.summary}}{{#if endpoint.fileDownload}} - recommended when file should be cached{{/if}}
+ * Query `{{queryName endpoint}}`{{#if endpoint.summary}}{{#if endpoint.mediaDownload}} - recommended when file should be cached{{/if}}
  * @summary {{addAsteriskAfterNewLine endpoint.summary}}{{/if}}{{#if endpoint.description}} 
  * @description {{addAsteriskAfterNewLine endpoint.description}}{{/if}}{{#if endpoint.acl}}
  * @permission Requires `{{abilityFunctionName endpoint}}` ability {{/if}}
 {{#if (endpointParams endpoint includeFileParam=true)}}{{#each (endpointParams endpoint includeFileParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
 {{/each}}{{/if}} * @param { AppQueryOptions } options Query options
- * @returns { UseQueryResult<{{#if endpoint.fileDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.fileDownload}}>{{/if}}> } {{endpoint.responseDescription}}
+ * @returns { UseQueryResult<{{#if endpoint.mediaDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.mediaDownload}}>{{/if}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{else if mutation}}
  /** 
- * Mutation `{{queryName endpoint mutation=true}}`{{#if endpoint.summary}}{{#if endpoint.fileDownload}} - recommended when file should not be cached{{/if}}
+ * Mutation `{{queryName endpoint mutation=true}}`{{#if endpoint.summary}}{{#if endpoint.mediaDownload}} - recommended when file should not be cached{{/if}}
  * @summary {{addAsteriskAfterNewLine endpoint.summary}}{{/if}}{{#if endpoint.description}} 
  * @description {{addAsteriskAfterNewLine endpoint.description}}{{/if}}{{#if endpoint.acl}}
  * @permission Requires `{{abilityFunctionName endpoint}}` ability {{/if}}
 {{#if (endpointParams endpoint includeFileParam=true)}}{{#each (endpointParams endpoint includeFileParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } mutation.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
 {{/each}}{{/if}} * @param { AppMutationOptions{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}} } options Mutation options
- * @returns { UseMutationResult<{{#if endpoint.fileDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.fileDownload}}>{{/if}}> } {{endpoint.responseDescription}}
+ * @returns { UseMutationResult<{{#if endpoint.mediaDownload}}AxiosResponse<{{/if}}{{{importedZodSchemaInferedType endpoint.response}}}{{#if endpoint.mediaDownload}}>{{/if}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{/if}}

package/src/generators/templates/partials/query-use-mutation.hbs

@@ -5,8 +5,8 @@ export const {{queryName endpoint mutation=true}} = (options?: AppMutationOption
   {{#if hasInvalidateQueryOptions}} const queryClient = useQueryClient();{{/if}}
 
   return {{queryHook}}({
-    mutationFn: {{#if endpoint.fileUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if endpoint.fileUpload}} {
-      const uploadInstructions = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{#if endpoint.fileUpload}}; 
+    mutationFn: {{#if endpoint.mediaUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if endpoint.mediaUpload}} {
+      const uploadInstructions = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{#if endpoint.mediaUpload}}; 
       
       if (file && uploadInstructions.url) {
         await axios.put(uploadInstructions.url, file, {