feat: improve generated hook signature and typing

Author: patrick-medusajs

dist/index.js

@@ -0,0 +1,23 @@
+{{>header}}
+
+import { UseQueryOptions, UseMutationOptions, QueryKey } from "react-query"
+
+export type UseQueryOptionsWrapper<
+  TQueryFnData = unknown,
+  TError = unknown,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey
+> = Omit<
+  UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
+  "queryKey" | "queryFn"
+>
+
+export type UseMutationOptionsWrapper<
+  TData = unknown,
+  TError = unknown,
+  TVariables = void,
+  TContext = unknown
+> = Omit<
+  UseMutationOptions<TData, TError, TVariables, TContext>,
+  'mutationKey' | 'mutationFn'
+>

src/templates/core/HookUtils.hbs

@@ -1,7 +1,7 @@
 {{>header}}
 
-import { useQuery, useMutation } from 'react-query';
-import { {{{clientName}}} } from '../{{{clientName}}}';
+import { useQuery, useMutation, useQueryClient } from 'react-query';
+import { UseQueryOptionsWrapper, UseMutationOptionsWrapper} from '../core/HookUtils';
 import { use{{{pascalCase clientName}}} } from '../use{{pascalCase clientName}}';
 {{#if imports}}
 	{{#each imports}}
@@ -10,25 +10,38 @@ import { use{{{pascalCase clientName}}} } from '../use{{pascalCase clientName}}'
 {{/if}}
 
 {{#each operations}}
-	export const use{{{pascalCase name}}} = ({{>parameters}}{{#if parameters}}, {{/if}}options = {}) => {
+	export const use{{{service}}}{{{pascalCase name}}} = (
+		{{~#if parameters}}{{~>parameters~}},{{/if}}
+		{{#equals method 'GET'}}
+			options: UseQueryOptionsWrapper<Awaited<ReturnType<typeof client.{{camelCase service}}.{{name}}>>> = {}
+		{{else}}
+			options: UseMutationOptionsWrapper<Awaited<ReturnType<typeof client.{{camelCase service}}.{{name}}>>, unknown,
+				{{~#if parametersBody}} {{parametersBody.type}}{{else}} void{{/if~}}
+			> = {}
+		{{/equals}}
+	) => {
 		const { client } = use{{{pascalCase ../clientName}}}()
 		{{#equals method 'GET'}}
-			const { data, ...rest } = useQuery(['{{ camelCase service}}', '{{ camelCase name }}', {{#each parameters}}{{name}}, {{/each}}], async () => {
-				return client.{{camelCase service}}.{{name}}({{#if parameters}}{
-					{{#each parameters}}
-					{{name}},
-					{{/each}}
-				}{{/if}});
-			});
+			const { data, ...rest } = useQuery<Awaited<ReturnType<typeof client.{{camelCase service}}.{{name}}>>>(
+				['{{camelCase service}}', '{{ camelCase name }}'{{#if parameters}}, {{>parametersUntyped}}{{/if}}],
+				() => client.{{camelCase service}}.{{name}}({{#if parameters}}{{>parametersUntyped}}{{/if}}),
+				options
+			);
 			return { ...data, ...rest } as const
 		{{else}}
-			return useMutation(async () => {
-				return client.{{camelCase service}}.{{name}}({{#if parameters}}{
-					{{#each parameters}}
-					{{name}},
-					{{/each}}
-				}{{/if}});
-			});
+			if (!options?.onSuccess) {
+				const queryClient = useQueryClient()
+				options.onSuccess = async () => {
+					await queryClient.invalidateQueries('{{camelCase service}}')
+				}
+			}
+			return useMutation<Awaited<ReturnType<typeof client.{{camelCase service}}.{{name}}>>, unknown,
+				{{~#if parametersBody}} {{parametersBody.type}}{{else}} void{{/if~}}
+			>(
+				['{{camelCase service}}', '{{ camelCase name }}'{{#if parameters}}, {{>parametersUntyped}}{{/if}}],
+				() => client.{{camelCase service}}.{{name}}({{#if parameters}}{{>parametersUntyped}}{{/if}}),
+				options
+			);
 		{{/equals}}
 	};
 

src/templates/exportHook.hbs

@@ -48,13 +48,13 @@ export class {{{name}}}{{{@root.postfix}}} {
 	 */
 	{{#if @root.exportClient}}
 	public {{{name}}}(
-		{{~>parameters~}},
+		{{~#if parameters}}{{~>parameters~}},{{/if}}
 		customHeaders: Record<string, any> = {}
 	): CancelablePromise<{{>result}}> {
 		return this.httpRequest.request({
 	{{else}}
 	public static {{{name}}}(
-		{{~>parameters~}},
+		{{#if parameters}}{{~>parameters~}},{{/if}}
 		customHeaders: Record<string, any> = {}
 	): CancelablePromise<{{>result}}> {
 		return __request(OpenAPI, {

src/templates/exportService.hbs

@@ -0,0 +1,18 @@
+{{~#if parameters}}
+	{{~#if parametersPath}}
+		{{~#each parametersPath}}
+  			{{~{name}}}{{#unless @last}},{{/unless}}
+		{{~/each}}
+	{{~/if}}
+	{{~#if parametersBody}}
+		{{~#if parametersPath}},{{/if}}
+		{{~#with parametersBody}}
+			{{~{name}}}
+		{{~/with}}
+		{{~#if parametersQuery}},{{/if}}
+	{{~/if}}
+	{{~#if parametersQuery}}
+		{{~#if parametersPath}}{{#unless parametersBody}},{{/unless}}{{/if~}}
+		queryParams
+	{{~/if}}
+{{~/if}}

src/templates/partials/parametersUntyped.hbs

@@ -6,6 +6,7 @@ import templateUseClient from '../templates/useClient.hbs';
 import templateCoreApiError from '../templates/core/ApiError.hbs';
 import templateCoreApiRequestOptions from '../templates/core/ApiRequestOptions.hbs';
 import templateCoreApiResult from '../templates/core/ApiResult.hbs';
+import templateCoreHookUtils from '../templates/core/HookUtils.hbs';
 import axiosGetHeaders from '../templates/core/axios/getHeaders.hbs';
 import axiosGetRequestBody from '../templates/core/axios/getRequestBody.hbs';
 import axiosGetResponseBody from '../templates/core/axios/getResponseBody.hbs';
@@ -62,6 +63,7 @@ import partialIsNullable from '../templates/partials/isNullable.hbs';
 import partialIsReadOnly from '../templates/partials/isReadOnly.hbs';
 import partialIsRequired from '../templates/partials/isRequired.hbs';
 import partialParameters from '../templates/partials/parameters.hbs';
+import partialParametersUntyped from '../templates/partials/parametersUntyped.hbs';
 import partialResult from '../templates/partials/result.hbs';
 import partialSchema from '../templates/partials/schema.hbs';
 import partialSchemaArray from '../templates/partials/schemaArray.hbs';
@@ -100,6 +102,7 @@ export interface Templates {
         request: Handlebars.TemplateDelegate;
         baseHttpRequest: Handlebars.TemplateDelegate;
         httpRequest: Handlebars.TemplateDelegate;
+        hookUtils: Handlebars.TemplateDelegate;
     };
 }
 
@@ -134,6 +137,7 @@ export const registerHandlebarTemplates = (root: {
             request: Handlebars.template(templateCoreRequest),
             baseHttpRequest: Handlebars.template(templateCoreBaseHttpRequest),
             httpRequest: Handlebars.template(templateCoreHttpRequest),
+            hookUtils: Handlebars.template(templateCoreHookUtils),
         },
     };
 
@@ -147,6 +151,7 @@ export const registerHandlebarTemplates = (root: {
     Handlebars.registerPartial('isReadOnly', Handlebars.template(partialIsReadOnly));
     Handlebars.registerPartial('isRequired', Handlebars.template(partialIsRequired));
     Handlebars.registerPartial('parameters', Handlebars.template(partialParameters));
+    Handlebars.registerPartial('parametersUntyped', Handlebars.template(partialParametersUntyped));
     Handlebars.registerPartial('result', Handlebars.template(partialResult));
     Handlebars.registerPartial('schema', Handlebars.template(partialSchema));
     Handlebars.registerPartial('schemaArray', Handlebars.template(partialSchemaArray));

src/utils/registerHandlebarTemplates.ts

@@ -35,6 +35,7 @@ describe('writeClient', () => {
                 request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
                 httpRequest: () => 'httpRequest',
+                hookUtils: () => 'hookUtils',
             },
         };
 

src/utils/writeClient.spec.ts

@@ -35,6 +35,7 @@ describe('writeClientClass', () => {
                 request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
                 httpRequest: () => 'httpRequest',
+                hookUtils: () => 'hookUtils',
             },
         };
 

src/utils/writeClientClass.spec.ts

@@ -37,6 +37,7 @@ describe('writeClientCore', () => {
                 request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
                 httpRequest: () => 'httpRequest',
+                hookUtils: () => 'hookUtils',
             },
         };
 

src/utils/writeClientCore.spec.ts

@@ -43,6 +43,7 @@ export const writeClientCore = async (
     await writeFile(resolve(outputPath, 'ApiResult.ts'), i(templates.core.apiResult(context), indent));
     await writeFile(resolve(outputPath, 'CancelablePromise.ts'), i(templates.core.cancelablePromise(context), indent));
     await writeFile(resolve(outputPath, 'request.ts'), i(templates.core.request(context), indent));
+    await writeFile(resolve(outputPath, 'HookUtils.ts'), i(templates.core.hookUtils(context), indent));
 
     if (isDefined(clientName)) {
         await writeFile(resolve(outputPath, 'BaseHttpRequest.ts'), i(templates.core.baseHttpRequest(context), indent));