@povio/openapi-codegen-cli 0.8.0 → 0.8.1

package/package.json

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

package/src/generators/templates/partials/casl-ability-function.hbs

@@ -1,8 +1,8 @@
 /**
- * Use for `{{queryName endpoint}}` {{#if (isQuery endpoint)}}query{{else}}mutation{{/if}} ability. {{#if (hasAbilityConditions endpoint)}}For global ability, omit the object parameter.{{/if}}{{#if (abilityDescription endpoint)}}
+ * Use for {{{genCaslAbilityQuery endpoint}}} ability. {{#if (hasAbilityConditions endpoint)}}For global ability, omit the object parameter.{{/if}}{{#if (abilityDescription endpoint)}}
  * @description {{abilityDescription endpoint}}{{/if}} 
 {{#if (hasAbilityConditions endpoint)}}{{#each (abilityConditionsTypes endpoint) as | propertyType |}} * @param { {{propertyType.type}}{{propertyType.zodSchemaName}} } object.{{propertyType.name}} {{propertyType.name}} from {{propertyType.info}}
-{{/each}}{{/if}} * @returns { {{abilityTypeName endpoint}} } An ability tuple indicating the user's ability to use `{{queryName endpoint}}` {{#if (isQuery endpoint)}}query{{else}}mutation{{/if}}
+{{/each}}{{/if}} * @returns { {{abilityTypeName endpoint}} } An ability tuple indicating the user's ability to use {{{genCaslAbilityQuery endpoint}}}
  */
 export const {{abilityFunctionName endpoint}} = (
   {{#if (hasAbilityConditions endpoint)}}object?: { {{#each (abilityConditionsTypes endpoint) as | propertyType |}}{{propertyType.name}}{{#unless propertyType.required}}?{{/unless}}: {{propertyType.type}}{{propertyType.zodSchemaName}}, {{/each}} } {{/if}}

package/src/generators/templates/partials/casl-ability-query.hbs

@@ -0,0 +1 @@
+{{#if (isQuery endpoint)}}{{#if (isMutation endpoint)}}`{{queryName endpoint}}` query or `{{queryName endpoint mutation=true}}` mutation{{else}}`{{queryName endpoint}}` query{{/if}}{{else}}`{{queryName endpoint}}` mutation{{/if}}

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

@@ -8,14 +8,24 @@
 {{/each}}{{/if}} * @param { AppInfiniteQueryOptions } options Infinite query options
  * @returns { UseInfiniteQueryResult<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
- */{{else}}
+ */{{else if query}}
  /** 
- * {{#if (isQuery endpoint)}}Query{{else}}Mutation{{/if}} `{{queryName endpoint}}`{{#if endpoint.summary}}
+ * Query `{{queryName endpoint}}`{{#if endpoint.summary}}{{#if endpoint.fileDownload}} - 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}} } {{#if (isQuery ../endpoint)}}object{{else}}mutation{{/if}}.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
-{{/each}}{{/if}} * @param {{#if (isQuery endpoint)}}{ AppQueryOptions{{#if hasFileActionQueryOptions}} & {{fileActionQueryOptionsType}}{{/if}} } options Query options{{else}}{ AppMutationOptions{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}} } options Mutation options{{/if}}
- * @returns { {{#if (isQuery endpoint)}}UseQueryResult{{else}}UseMutationResult{{/if}}<{{{importedZodSchemaInferedType endpoint.response}}}> } {{endpoint.responseDescription}}
+{{#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}}
+ * @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}}
+ * @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}}
  * @statusCodes [{{commaSeparated endpoint.responseStatusCodes}}]
  */{{/if}}

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

@@ -1,12 +1,12 @@
 {{! Js docs }}
-{{{genQueryJsDocs endpoint}}}
+{{{genQueryJsDocs endpoint mutation=true}}}
 {{! Mutation definition}}
-export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint includeFileParam=true}}} }>{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
+export const {{queryName endpoint mutation=true}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint includeFileParam=true}}} }>{{#if hasInvalidateQueryOptions}} & {{invalidateQueryOptionsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   {{#if hasInvalidateQueryOptions}} const queryClient = useQueryClient();{{/if}}
 
   return {{queryHook}}({
-    mutationFn: {{#if hasFileUpload}}async {{/if}}({{#if (endpointParams endpoint includeFileParam=true)}} { {{{endpointArgs endpoint includeFileParam=true}}} } {{/if}}) => {{#if hasFileUpload}} {
-      const uploadInstructions = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{#if hasFileUpload}}; 
+    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}}; 
       
       if (file && uploadInstructions.url) {
         await axios.put(uploadInstructions.url, file, {

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

@@ -1,14 +1,10 @@
 {{! Js docs }}
-{{{genQueryJsDocs endpoint}}}
+{{{genQueryJsDocs endpoint query=true}}}
 {{! Query definition}}
-export const {{queryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint}}} }: { {{{genEndpointParams endpoint}}} }, {{/if}}options?: AppQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasFileActionQueryOptions}} & {{fileActionQueryOptionsType}}{{/if}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
+export const {{queryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint}}} }: { {{{genEndpointParams endpoint}}} }, {{/if}}options?: AppQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   return {{queryHook}}({
     queryKey: keys.{{endpointName endpoint}}({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint}}}{{/if}}),
-    queryFn: {{#if hasFileDownload}}async {{/if}}{{#if hasQueryFn}}() => {{#if hasFileDownload}} {
-      const res = await{{/if}} {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{else}}{{importedEndpointName endpoint}}{{/if}}{{#if hasFileDownload}}; 
-      responseFileAction(res, options);
-      return res;
-    }{{/if}},
+    queryFn: {{#if hasQueryFn}}() => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{else}}{{importedEndpointName endpoint}}{{/if}},
     ...options,
   });
 };

package/src/generators/templates/queries.hbs

@@ -8,10 +8,6 @@
 {{#if hasInvalidateQueriesImport}}
 {{{genImport invalidateQueriesImport}}}
 {{/if}}
-{{! File action import }}
-{{#if hasFileActionImport}}
-{{{genImport fileActionImport}}}
-{{/if}}
 {{! React query types import }}
 {{{genImport queryTypesImport}}}
 {{! Models import }}
@@ -36,11 +32,9 @@ export const {{queriesModuleName}} = "{{namespace}}";
 {{#each endpoints as | endpoint |}}
 {{{genQuery endpoint}}}
 
-{{#if ../generateInfiniteQueries}}
-{{#if (isInfiniteQuery endpoint)}}
+{{{genMutation endpoint}}}
+
 {{{genInfiniteQuery endpoint}}}
-{{/if}}
-{{/if}}
 
 {{/each}}
 

package/src/assets/fileAction.ts

@@ -1,47 +0,0 @@
-import { AxiosResponse, AxiosResponseHeaders } from "axios";
-
-export interface FileActionQueryOptions {
-  fileName?: string;
-  downloadFile?: boolean;
-  previewFile?: boolean;
-}
-
-export function responseFileAction(res: AxiosResponse<Blob>, options?: FileActionQueryOptions) {
-  const fileName = extractFilename(res.headers as AxiosResponseHeaders);
-
-  fileAction(res.data, { ...options, fileName: options?.fileName ?? fileName });
-}
-
-export function fileAction(blob: Blob, options?: FileActionQueryOptions) {
-  const url = URL.createObjectURL(blob);
-  const a = document.createElement("a");
-  a.download = options?.fileName ?? "download";
-  a.rel = "noopener";
-  a.href = url;
-
-  if (options?.downloadFile) {
-    setTimeout(() => a.dispatchEvent(new MouseEvent("click")), 0);
-  }
-
-  if (options?.previewFile) {
-    window.open(url, "_blank");
-  }
-
-  setTimeout(() => URL.revokeObjectURL(url), 40000); // Cleanup after 40s
-}
-
-function extractFilename(headers: AxiosResponseHeaders): string | undefined {
-  const contentDisposition = Object.keys(headers).find((key) => key.toLowerCase() === "content-disposition");
-
-  if (!contentDisposition) {
-    return undefined;
-  }
-
-  const contentDispositionValue = headers[contentDisposition] as string | undefined;
-  if (!contentDispositionValue) {
-    return undefined;
-  }
-
-  const filenameMatch = /filename=["']?([^"';]+)/i.exec(contentDispositionValue);
-  return filenameMatch ? filenameMatch[1] : undefined;
-}