@povio/openapi-codegen-cli 0.7.2 → 0.8.1

package/package.json

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

package/src/assets/rest-client.ts

@@ -6,15 +6,9 @@ interface RequestInfo<ZResDto extends z.ZodRawShape, ResDto, Res> {
   resSchema: z.ZodEffects<z.ZodObject<ZResDto, "strip", z.ZodTypeAny, ResDto>, Res> | z.ZodSchema<Res>;
 }
 
-type Method = "get" | "post" | "patch" | "put" | "delete";
-
-const MethodHasBody: Record<Method, boolean> = {
-  get: false,
-  post: true,
-  patch: true,
-  put: true,
-  delete: true,
-};
+interface RequestConfig<RawRes extends boolean = false> {
+  rawResponse?: RawRes;
+}
 
 export class RestClient {
   private client: AxiosInstance;
@@ -44,64 +38,60 @@ export class RestClient {
     interceptor.removeInterceptor(this.client);
   }
 
-  public async get<ZResDto extends z.ZodRawShape, ResDto, Res>(
+  public async get<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
     requestInfo: RequestInfo<ZResDto, ResDto, Res>,
     url: string,
-    config?: AxiosRequestConfig,
-  ): Promise<Res> {
-    return this.makeRequest(requestInfo, "get", url, undefined, config);
+    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
+  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    return this.makeRequest(requestInfo, { ...requestConfig, method: "get", url });
   }
 
-  public async post<ZResDto extends z.ZodRawShape, ResDto, Res>(
+  public async post<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
     requestInfo: RequestInfo<ZResDto, ResDto, Res>,
     url: string,
     data?: any,
-    config?: AxiosRequestConfig,
-  ): Promise<Res> {
-    return this.makeRequest(requestInfo, "post", url, data, config);
+    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
+  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    return this.makeRequest(requestInfo, { ...requestConfig, method: "post", url, data });
   }
 
-  public async patch<ZResDto extends z.ZodRawShape, ResDto, Res>(
+  public async patch<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
     requestInfo: RequestInfo<ZResDto, ResDto, Res>,
     url: string,
     data?: any,
-    config?: AxiosRequestConfig,
-  ): Promise<Res> {
-    return this.makeRequest(requestInfo, "patch", url, data, config);
+    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
+  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    return this.makeRequest(requestInfo, { ...requestConfig, method: "patch", url, data });
   }
 
-  public async put<ZResDto extends z.ZodRawShape, ResDto, Res>(
+  public async put<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
     requestInfo: RequestInfo<ZResDto, ResDto, Res>,
     url: string,
     data?: any,
-    config?: AxiosRequestConfig,
-  ): Promise<Res> {
-    return this.makeRequest(requestInfo, "put", url, data, config);
+    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
+  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    return this.makeRequest(requestInfo, { ...requestConfig, method: "put", url, data });
   }
 
-  public async delete<ZResDto extends z.ZodRawShape, ResDto, Res>(
+  public async delete<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
     requestInfo: RequestInfo<ZResDto, ResDto, Res>,
     url: string,
     data?: any,
-    config?: AxiosRequestConfig,
-  ): Promise<Res> {
-    return this.makeRequest(requestInfo, "delete", url, data, config);
+    requestConfig?: AxiosRequestConfig & RequestConfig<RawRes>,
+  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    return this.makeRequest(requestInfo, { ...requestConfig, method: "delete", url, data });
   }
 
-  private async makeRequest<ZResDto extends z.ZodRawShape, ResDto, Res>(
+  private async makeRequest<ZResDto extends z.ZodRawShape, ResDto, Res, RawRes extends boolean = false>(
     requestInfo: RequestInfo<ZResDto, ResDto, Res>,
-    method: Method,
-    url: string,
-    data?: any,
-    config?: AxiosRequestConfig,
-  ): Promise<Res> {
-    let res: AxiosResponse;
-    if (MethodHasBody[method]) {
-      res = await this.client[method](url, data, config);
-    } else {
-      res = await this.client[method](url, config);
-    }
+    requestConfig: AxiosRequestConfig & RequestConfig<RawRes>,
+  ): Promise<RawRes extends true ? AxiosResponse<Res> : Res> {
+    const { rawResponse, ...config } = requestConfig;
+
+    const res = await this.client(config);
+
+    const resData = requestInfo.resSchema.parse(res.data);
 
-    return requestInfo.resSchema.parse(res);
+    return (rawResponse ? { ...res, data: resData } : resData) as RawRes extends true ? AxiosResponse<Res> : Res;
   }
 }

package/src/generators/templates/app-acl.hbs

@@ -10,4 +10,4 @@ export type AppAbilities =
 {{#if includeNamespace}}{{#each namespaces as | namespace |}} | {{namespace}}.{{../allAbilities}}{{/each}}
 {{else}}{{#each tags as | tag |}} | {{tagAllAbilitiesName tag}}{{/each}}{{/if}}
 
-export type AppAbility = PureAbility<AppAbilities>;
+export type AppAbility = PureAbility<AppAbilities>;

package/src/generators/templates/app-rest-client.hbs

@@ -4,4 +4,4 @@ export const {{appRestClientName}} = new RestClient({
   config: {
     baseURL: "{{baseUrl}}"
   },
-});
+});

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/endpoint-config.hbs

@@ -22,4 +22,10 @@
         {{/each}}
     },
     {{/if}}
+    {{#if hasBlobResponse}}
+    responseType: "blob",
+    {{/if}}
+    {{#if hasFileDownload}}
+    rawResponse: true,
+    {{/if}}
 }

package/src/generators/templates/partials/endpoint-params.hbs

@@ -1 +1 @@
-{{#each (endpointParams endpoint extra) as | endpointParam |}}{{endpointParam.name}}{{#unless endpointParam.required}}?{{/unless}}: {{endpointParam.type}}, {{/each}}
+{{#each (endpointParams endpoint options) as | endpointParam |}}{{endpointParam.name}}{{#unless endpointParam.required}}?{{/unless}}: {{endpointParam.type}}, {{/each}}

package/src/generators/templates/partials/import.hbs

@@ -1 +1 @@
-import { {{commaSeparated import.bindings}} } from "{{import.from}}";
+import {{importNames import.bindings import.defaultImport}} from "{{import.from}}";

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

@@ -4,18 +4,28 @@
  * @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)}}{{#each (endpointParams endpoint infiniteQuery "removePageParam") as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
+{{#if (endpointParams endpoint)}}{{#each (endpointParams endpoint infiniteQuery removePageParam=true) as | endpointParam |}} * @param { {{endpointParam.type}} } object.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
 {{/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)}}{{#each (endpointParams endpoint) as | endpointParam |}} * @param { {{endpointParam.type}} } {{#if (isQuery ../endpoint)}}object{{else}}mutation{{/if}}.{{endpointParam.name}} {{{endpointParamDescription endpointParam}}}
-{{/each}}{{/if}} * @param {{#if (isQuery endpoint)}}{ AppQueryOptions } 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-keys.hbs

@@ -4,7 +4,7 @@ export const keys = {
     {{endpointName endpoint}}: ({{{genEndpointParams endpoint}}}) => [...keys.all, "{{endpoint.path}}", {{{endpointArgs endpoint}}}] as const,
     {{#if ../generateInfiniteQueries}}
     {{#if (isInfiniteQuery endpoint)}}
-    {{endpointName endpoint}}Infinite: ({{{genEndpointParams endpoint "removePageParam"}}}) => [...keys.all, "{{endpoint.path}}", "infinite", {{{endpointArgs endpoint "removePageParam"}}}] as const,
+    {{endpointName endpoint}}Infinite: ({{{genEndpointParams endpoint removePageParam=true}}}) => [...keys.all, "{{endpoint.path}}", "infinite", {{{endpointArgs endpoint removePageParam=true}}}] as const,
     {{/if}}
     {{/if}}
     {{/each}}

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

@@ -1,10 +1,10 @@
 {{! Js docs }}
-{{{genQueryJsDocs endpoint "infiniteQuery" }}}
+{{{genQueryJsDocs endpoint infiniteQuery=true}}}
 {{! Infinite query definition}}
-export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint "removePageParam"}}} }: { {{{genEndpointParams endpoint "removePageParam"}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
+export const {{infiniteQueryName endpoint}} = <TData>({{#if (endpointParams endpoint)}}{ {{{endpointArgs endpoint removePageParam=true}}} }: { {{{genEndpointParams endpoint removePageParam=true}}} }, {{/if}}options?: AppInfiniteQueryOptions<typeof {{importedEndpointName endpoint}}, TData>{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   return {{infiniteQueryHook}}({
-    queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint "removePageParam"}}}{{/if}}),
-    queryFn: ({ pageParam }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint "replacePageParam"}}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}{{/if}}),
+    queryKey: keys.{{endpointName endpoint}}Infinite({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint removePageParam=true}}}{{/if}}),
+    queryFn: ({ pageParam }) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint replacePageParam=true}}}{{#if hasAxiosRequestConfig}}, {{axiosRequestConfigName}}{{/if}}),
     initialPageParam: 1,
     getNextPageParam: ({ {{pageParamName}}, {{totalItemsName}}, {{limitParamName}}: limitParam }) => {
       const pageParam = {{pageParamName}} ?? 1;

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

@@ -1,11 +1,23 @@
 {{! Js docs }}
-{{{genQueryJsDocs endpoint}}}
+{{{genQueryJsDocs endpoint mutation=true}}}
 {{! Mutation definition}}
-export const {{queryName endpoint}} = (options?: AppMutationOptions<typeof {{importedEndpointName endpoint}}, { {{{genEndpointParams endpoint}}} }>{{#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 (endpointParams endpoint)}} { {{{endpointArgs endpoint}}} } {{/if}}) => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}),
+    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, {
+          headers: {
+            "Content-Type": file.type,
+          },
+        });
+      }
+
+      return uploadInstructions;
+    }{{/if}},
     ...options, {{#if hasInvalidateQueryOptions}}
     onSuccess: (...args) => {
       {{! Invalidation }}

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

@@ -1,10 +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 hasAxiosRequestConfig}}, {{axiosRequestConfigName}}?: {{axiosRequestConfigType}}{{/if}}) => {
   return {{queryHook}}({
     queryKey: keys.{{endpointName endpoint}}({{#if (endpointParams endpoint)}}{{{endpointArgs endpoint}}}{{/if}}),
-    queryFn: {{#if hasEndpointArgs}}() => {{importedEndpointName endpoint}}({{{endpointArgs endpoint}}}{{#if hasAxiosRequestConfig}}{{#if (endpointArgs endpoint)}}, {{/if}}{{axiosRequestConfigName}}{{/if}}){{else}}{{importedEndpointName endpoint}}{{/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

@@ -32,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/generators/templates/query-modules.hbs

@@ -15,7 +15,4 @@ export type QueriesModuleType = keyof typeof QueriesModuleKeysAll;
 export const QueriesModule = {
     {{#if includeNamespace}}{{#each modules as | module |}} {{module.tag}}: {{module.namespace}}.{{../queriesModuleName}}, {{/each}}
     {{else}}{{#each modules as | module |}} {{module.tag}}:  {{tagModuleName module.tag}}, {{/each}}{{/if}}
-} satisfies Record<string, QueriesModuleType>;
-
-
-
+} satisfies Record<string, QueriesModuleType>;