fix: added missing request params in to the queryKeyFn (#169)

Author: yusufbkr

src/common.mts

@@ -237,9 +237,13 @@ export function createQueryKeyFnExport(
   queryKey: string,
   method: VariableDeclaration,
   type: "query" | "mutation" = "query",
+  modelNames: string[] = [],
 ) {
   // Mutation keys don't require clientOptions
-  const params = type === "query" ? getRequestParamFromMethod(method) : null;
+  const params =
+    type === "query"
+      ? getRequestParamFromMethod(method, undefined, modelNames)
+      : null;
 
   // override key is used to allow the user to override the the queryKey values
   const overrideKey = ts.factory.createParameterDeclaration(

src/createUseQuery.mts

@@ -533,7 +533,12 @@ export const createUseQuery = ({
     queryKey,
   });
 
-  const queryKeyFn = createQueryKeyFnExport(queryKey, method);
+  const queryKeyFn = createQueryKeyFnExport(
+    queryKey,
+    method,
+    "query",
+    modelNames,
+  );
 
   return {
     apiResponse: defaultApiResponse,

tests/__snapshots__/createSource.test.ts.snap

@@ -19,19 +19,19 @@ import { AxiosError } from "axios";
 export type FindPetsDefaultResponse = Awaited<ReturnType<typeof findPets>>["data"];
 export type FindPetsQueryResult<TData = FindPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useFindPetsKey = "FindPets";
-export const UseFindPetsKeyFn = (clientOptions: Options<unknown, true> = {}, queryKey?: Array<unknown>) => [useFindPetsKey, ...(queryKey ?? [clientOptions])];
+export const UseFindPetsKeyFn = (clientOptions: Options<FindPetsData, true> = {}, queryKey?: Array<unknown>) => [useFindPetsKey, ...(queryKey ?? [clientOptions])];
 export type GetNotDefinedDefaultResponse = Awaited<ReturnType<typeof getNotDefined>>["data"];
 export type GetNotDefinedQueryResult<TData = GetNotDefinedDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useGetNotDefinedKey = "GetNotDefined";
 export const UseGetNotDefinedKeyFn = (clientOptions: Options<unknown, true> = {}, queryKey?: Array<unknown>) => [useGetNotDefinedKey, ...(queryKey ?? [clientOptions])];
 export type FindPetByIdDefaultResponse = Awaited<ReturnType<typeof findPetById>>["data"];
 export type FindPetByIdQueryResult<TData = FindPetByIdDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useFindPetByIdKey = "FindPetById";
-export const UseFindPetByIdKeyFn = (clientOptions: Options<unknown, true>, queryKey?: Array<unknown>) => [useFindPetByIdKey, ...(queryKey ?? [clientOptions])];
+export const UseFindPetByIdKeyFn = (clientOptions: Options<FindPetByIdData, true>, queryKey?: Array<unknown>) => [useFindPetByIdKey, ...(queryKey ?? [clientOptions])];
 export type FindPaginatedPetsDefaultResponse = Awaited<ReturnType<typeof findPaginatedPets>>["data"];
 export type FindPaginatedPetsQueryResult<TData = FindPaginatedPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useFindPaginatedPetsKey = "FindPaginatedPets";
-export const UseFindPaginatedPetsKeyFn = (clientOptions: Options<unknown, true> = {}, queryKey?: Array<unknown>) => [useFindPaginatedPetsKey, ...(queryKey ?? [clientOptions])];
+export const UseFindPaginatedPetsKeyFn = (clientOptions: Options<FindPaginatedPetsData, true> = {}, queryKey?: Array<unknown>) => [useFindPaginatedPetsKey, ...(queryKey ?? [clientOptions])];
 export type AddPetMutationResult = Awaited<ReturnType<typeof addPet>>;
 export const useAddPetKey = "AddPet";
 export const UseAddPetKeyFn = (mutationKey?: Array<unknown>) => [useAddPetKey, ...(mutationKey ?? [])];
@@ -113,19 +113,19 @@ import { Pet, NewPet, Error, FindPetsData, FindPetsResponse, FindPetsError, AddP
 export type FindPetsDefaultResponse = Awaited<ReturnType<typeof findPets>>["data"];
 export type FindPetsQueryResult<TData = FindPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useFindPetsKey = "FindPets";
-export const UseFindPetsKeyFn = (clientOptions: Options<unknown, true> = {}, queryKey?: Array<unknown>) => [useFindPetsKey, ...(queryKey ?? [clientOptions])];
+export const UseFindPetsKeyFn = (clientOptions: Options<FindPetsData, true> = {}, queryKey?: Array<unknown>) => [useFindPetsKey, ...(queryKey ?? [clientOptions])];
 export type GetNotDefinedDefaultResponse = Awaited<ReturnType<typeof getNotDefined>>["data"];
 export type GetNotDefinedQueryResult<TData = GetNotDefinedDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useGetNotDefinedKey = "GetNotDefined";
 export const UseGetNotDefinedKeyFn = (clientOptions: Options<unknown, true> = {}, queryKey?: Array<unknown>) => [useGetNotDefinedKey, ...(queryKey ?? [clientOptions])];
 export type FindPetByIdDefaultResponse = Awaited<ReturnType<typeof findPetById>>["data"];
 export type FindPetByIdQueryResult<TData = FindPetByIdDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useFindPetByIdKey = "FindPetById";
-export const UseFindPetByIdKeyFn = (clientOptions: Options<unknown, true>, queryKey?: Array<unknown>) => [useFindPetByIdKey, ...(queryKey ?? [clientOptions])];
+export const UseFindPetByIdKeyFn = (clientOptions: Options<FindPetByIdData, true>, queryKey?: Array<unknown>) => [useFindPetByIdKey, ...(queryKey ?? [clientOptions])];
 export type FindPaginatedPetsDefaultResponse = Awaited<ReturnType<typeof findPaginatedPets>>["data"];
 export type FindPaginatedPetsQueryResult<TData = FindPaginatedPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useFindPaginatedPetsKey = "FindPaginatedPets";
-export const UseFindPaginatedPetsKeyFn = (clientOptions: Options<unknown, true> = {}, queryKey?: Array<unknown>) => [useFindPaginatedPetsKey, ...(queryKey ?? [clientOptions])];
+export const UseFindPaginatedPetsKeyFn = (clientOptions: Options<FindPaginatedPetsData, true> = {}, queryKey?: Array<unknown>) => [useFindPaginatedPetsKey, ...(queryKey ?? [clientOptions])];
 export type AddPetMutationResult = Awaited<ReturnType<typeof addPet>>;
 export const useAddPetKey = "AddPet";
 export const UseAddPetKeyFn = (mutationKey?: Array<unknown>) => [useAddPetKey, ...(mutationKey ?? [])];

tests/__snapshots__/generate.test.ts.snap

@@ -14,6 +14,11 @@ import type {
   getNotDefined,
   postNotDefined,
 } from "../requests/services.gen";
+import type {
+  FindPaginatedPetsData,
+  FindPetByIdData,
+  FindPetsData,
+} from "../requests/types.gen";
 export type FindPetsDefaultResponse = Awaited<
   ReturnType<typeof findPets>
 >["data"];
@@ -23,7 +28,7 @@ export type FindPetsQueryResult<
 > = UseQueryResult<TData, TError>;
 export const useFindPetsKey = "FindPets";
 export const UseFindPetsKeyFn = (
-  clientOptions: Options<unknown, true> = {},
+  clientOptions: Options<FindPetsData, true> = {},
   queryKey?: Array<unknown>,
 ) => [useFindPetsKey, ...(queryKey ?? [clientOptions])];
 export type GetNotDefinedDefaultResponse = Awaited<
@@ -47,7 +52,7 @@ export type FindPetByIdQueryResult<
 > = UseQueryResult<TData, TError>;
 export const useFindPetByIdKey = "FindPetById";
 export const UseFindPetByIdKeyFn = (
-  clientOptions: Options<unknown, true>,
+  clientOptions: Options<FindPetByIdData, true>,
   queryKey?: Array<unknown>,
 ) => [useFindPetByIdKey, ...(queryKey ?? [clientOptions])];
 export type FindPaginatedPetsDefaultResponse = Awaited<
@@ -59,7 +64,7 @@ export type FindPaginatedPetsQueryResult<
 > = UseQueryResult<TData, TError>;
 export const useFindPaginatedPetsKey = "FindPaginatedPets";
 export const UseFindPaginatedPetsKeyFn = (
-  clientOptions: Options<unknown, true> = {},
+  clientOptions: Options<FindPaginatedPetsData, true> = {},
   queryKey?: Array<unknown>,
 ) => [useFindPaginatedPetsKey, ...(queryKey ?? [clientOptions])];
 export type AddPetMutationResult = Awaited<ReturnType<typeof addPet>>;