Skip to content

feat(@tanstack/query-core): make query key functions accept optional … #3925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AustinRobinson wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat(@tanstack/query-core): make query key functions accept optional … #3925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e6e51e
feat(@tanstack/query-core): make query key functions accept optional …
AustinRobinson May 24, 2026
08535a7
fix: use $.type().generic() to create Partial type wrapper
AustinRobinson May 24, 2026
9c7c053
fix: update createQueryKey to accept Partial<TOptions> and update tes…
AustinRobinson May 24, 2026
98719fe
fix: update createQueryKey to accept Partial<TOptions> and update tes…
AustinRobinson May 24, 2026
17bd9da
chore: regenerate TanStack Query example code
AustinRobinson May 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/silver-donkeys-peel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@hey-api/openapi-ts": minor
---

make query key functions accept optional partial options for prefix matching
18 changes: 9 additions & 9 deletions ...anstack-angular-query-experimental/src/client/@tanstack/angular-query-experimental.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export type QueryKey<TOptions extends Options> = [

const createQueryKey = <TOptions extends Options>(
id: string,
options?: TOptions,
options?: Partial<TOptions>,
infinite?: boolean,
tags?: ReadonlyArray<string>,
): [QueryKey<TOptions>[0]] => {
Expand Down Expand Up @@ -150,7 +150,7 @@ const createQueryKey = <TOptions extends Options>(
return [params];
};

export const findPetsByStatusQueryKey = (options: Options<FindPetsByStatusData>) =>
export const findPetsByStatusQueryKey = (options?: Partial<Options<FindPetsByStatusData>>) =>
createQueryKey('findPetsByStatus', options);

/**
Expand All @@ -177,7 +177,7 @@ export const findPetsByStatusOptions = (options: Options<FindPetsByStatusData>)
queryKey: findPetsByStatusQueryKey(options),
});

export const findPetsByTagsQueryKey = (options: Options<FindPetsByTagsData>) =>
export const findPetsByTagsQueryKey = (options?: Partial<Options<FindPetsByTagsData>>) =>
createQueryKey('findPetsByTags', options);

/**
Expand Down Expand Up @@ -225,7 +225,7 @@ export const deletePetMutation = (
return mutationOptions;
};

export const getPetByIdQueryKey = (options: Options<GetPetByIdData>) =>
export const getPetByIdQueryKey = (options?: Partial<Options<GetPetByIdData>>) =>
createQueryKey('getPetById', options);

/**
Expand Down Expand Up @@ -302,7 +302,7 @@ export const uploadFileMutation = (
return mutationOptions;
};

export const getInventoryQueryKey = (options?: Options<GetInventoryData>) =>
export const getInventoryQueryKey = (options?: Partial<Options<GetInventoryData>>) =>
createQueryKey('getInventory', options);

/**
Expand Down Expand Up @@ -375,7 +375,7 @@ export const deleteOrderMutation = (
return mutationOptions;
};

export const getOrderByIdQueryKey = (options: Options<GetOrderByIdData>) =>
export const getOrderByIdQueryKey = (options?: Partial<Options<GetOrderByIdData>>) =>
createQueryKey('getOrderById', options);

/**
Expand Down Expand Up @@ -456,7 +456,7 @@ export const createUsersWithListInputMutation = (
return mutationOptions;
};

export const loginUserQueryKey = (options?: Options<LoginUserData>) =>
export const loginUserQueryKey = (options?: Partial<Options<LoginUserData>>) =>
createQueryKey('loginUser', options);

/**
Expand All @@ -483,7 +483,7 @@ export const loginUserOptions = (options?: Options<LoginUserData>) =>
queryKey: loginUserQueryKey(options),
});

export const logoutUserQueryKey = (options?: Options<LogoutUserData>) =>
export const logoutUserQueryKey = (options?: Partial<Options<LogoutUserData>>) =>
createQueryKey('logoutUser', options);

/**
Expand Down Expand Up @@ -526,7 +526,7 @@ export const deleteUserMutation = (
return mutationOptions;
};

export const getUserByNameQueryKey = (options: Options<GetUserByNameData>) =>
export const getUserByNameQueryKey = (options?: Partial<Options<GetUserByNameData>>) =>
createQueryKey('getUserByName', options);

/**
Expand Down
18 changes: 9 additions & 9 deletions examples/openapi-ts-tanstack-react-query/src/client/@tanstack/react-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export type QueryKey<TOptions extends Options> = [

const createQueryKey = <TOptions extends Options>(
id: string,
options?: TOptions,
options?: Partial<TOptions>,
infinite?: boolean,
tags?: ReadonlyArray<string>,
): [QueryKey<TOptions>[0]] => {
Expand Down Expand Up @@ -125,7 +125,7 @@ const createQueryKey = <TOptions extends Options>(
return [params];
};

export const findPetsByStatusQueryKey = (options: Options<FindPetsByStatusData>) =>
export const findPetsByStatusQueryKey = (options?: Partial<Options<FindPetsByStatusData>>) =>
createQueryKey('findPetsByStatus', options);

/**
Expand All @@ -152,7 +152,7 @@ export const findPetsByStatusOptions = (options: Options<FindPetsByStatusData>)
queryKey: findPetsByStatusQueryKey(options),
});

export const findPetsByTagsQueryKey = (options: Options<FindPetsByTagsData>) =>
export const findPetsByTagsQueryKey = (options?: Partial<Options<FindPetsByTagsData>>) =>
createQueryKey('findPetsByTags', options);

/**
Expand Down Expand Up @@ -200,7 +200,7 @@ export const deletePetMutation = (
return mutationOptions;
};

export const getPetByIdQueryKey = (options: Options<GetPetByIdData>) =>
export const getPetByIdQueryKey = (options?: Partial<Options<GetPetByIdData>>) =>
createQueryKey('getPetById', options);

/**
Expand Down Expand Up @@ -277,7 +277,7 @@ export const uploadFileMutation = (
return mutationOptions;
};

export const getInventoryQueryKey = (options?: Options<GetInventoryData>) =>
export const getInventoryQueryKey = (options?: Partial<Options<GetInventoryData>>) =>
createQueryKey('getInventory', options);

/**
Expand Down Expand Up @@ -350,7 +350,7 @@ export const deleteOrderMutation = (
return mutationOptions;
};

export const getOrderByIdQueryKey = (options: Options<GetOrderByIdData>) =>
export const getOrderByIdQueryKey = (options?: Partial<Options<GetOrderByIdData>>) =>
createQueryKey('getOrderById', options);

/**
Expand Down Expand Up @@ -431,7 +431,7 @@ export const createUsersWithListInputMutation = (
return mutationOptions;
};

export const loginUserQueryKey = (options?: Options<LoginUserData>) =>
export const loginUserQueryKey = (options?: Partial<Options<LoginUserData>>) =>
createQueryKey('loginUser', options);

/**
Expand All @@ -458,7 +458,7 @@ export const loginUserOptions = (options?: Options<LoginUserData>) =>
queryKey: loginUserQueryKey(options),
});

export const logoutUserQueryKey = (options?: Options<LogoutUserData>) =>
export const logoutUserQueryKey = (options?: Partial<Options<LogoutUserData>>) =>
createQueryKey('logoutUser', options);

/**
Expand Down Expand Up @@ -501,7 +501,7 @@ export const deleteUserMutation = (
return mutationOptions;
};

export const getUserByNameQueryKey = (options: Options<GetUserByNameData>) =>
export const getUserByNameQueryKey = (options?: Partial<Options<GetUserByNameData>>) =>
createQueryKey('getUserByName', options);

/**
Expand Down
18 changes: 9 additions & 9 deletions examples/openapi-ts-tanstack-svelte-query/src/client/@tanstack/svelte-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export type QueryKey<TOptions extends Options> = [

const createQueryKey = <TOptions extends Options>(
id: string,
options?: TOptions,
options?: Partial<TOptions>,
infinite?: boolean,
tags?: ReadonlyArray<string>,
): [QueryKey<TOptions>[0]] => {
Expand Down Expand Up @@ -146,7 +146,7 @@ const createQueryKey = <TOptions extends Options>(
return [params];
};

export const findPetsByStatusQueryKey = (options: Options<FindPetsByStatusData>) =>
export const findPetsByStatusQueryKey = (options?: Partial<Options<FindPetsByStatusData>>) =>
createQueryKey('findPetsByStatus', options);

/**
Expand All @@ -173,7 +173,7 @@ export const findPetsByStatusOptions = (options: Options<FindPetsByStatusData>)
queryKey: findPetsByStatusQueryKey(options),
});

export const findPetsByTagsQueryKey = (options: Options<FindPetsByTagsData>) =>
export const findPetsByTagsQueryKey = (options?: Partial<Options<FindPetsByTagsData>>) =>
createQueryKey('findPetsByTags', options);

/**
Expand Down Expand Up @@ -221,7 +221,7 @@ export const deletePetMutation = (
return mutationOptions;
};

export const getPetByIdQueryKey = (options: Options<GetPetByIdData>) =>
export const getPetByIdQueryKey = (options?: Partial<Options<GetPetByIdData>>) =>
createQueryKey('getPetById', options);

/**
Expand Down Expand Up @@ -298,7 +298,7 @@ export const uploadFileMutation = (
return mutationOptions;
};

export const getInventoryQueryKey = (options?: Options<GetInventoryData>) =>
export const getInventoryQueryKey = (options?: Partial<Options<GetInventoryData>>) =>
createQueryKey('getInventory', options);

/**
Expand Down Expand Up @@ -371,7 +371,7 @@ export const deleteOrderMutation = (
return mutationOptions;
};

export const getOrderByIdQueryKey = (options: Options<GetOrderByIdData>) =>
export const getOrderByIdQueryKey = (options?: Partial<Options<GetOrderByIdData>>) =>
createQueryKey('getOrderById', options);

/**
Expand Down Expand Up @@ -452,7 +452,7 @@ export const createUsersWithListInputMutation = (
return mutationOptions;
};

export const loginUserQueryKey = (options?: Options<LoginUserData>) =>
export const loginUserQueryKey = (options?: Partial<Options<LoginUserData>>) =>
createQueryKey('loginUser', options);

/**
Expand All @@ -479,7 +479,7 @@ export const loginUserOptions = (options?: Options<LoginUserData>) =>
queryKey: loginUserQueryKey(options),
});

export const logoutUserQueryKey = (options?: Options<LogoutUserData>) =>
export const logoutUserQueryKey = (options?: Partial<Options<LogoutUserData>>) =>
createQueryKey('logoutUser', options);

/**
Expand Down Expand Up @@ -522,7 +522,7 @@ export const deleteUserMutation = (
return mutationOptions;
};

export const getUserByNameQueryKey = (options: Options<GetUserByNameData>) =>
export const getUserByNameQueryKey = (options?: Partial<Options<GetUserByNameData>>) =>
createQueryKey('getUserByName', options);

/**
Expand Down
18 changes: 9 additions & 9 deletions examples/openapi-ts-tanstack-vue-query/src/client/@tanstack/vue-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export type QueryKey<TOptions extends Options> = [

const createQueryKey = <TOptions extends Options>(
id: string,
options?: TOptions,
options?: Partial<TOptions>,
infinite?: boolean,
tags?: ReadonlyArray<string>,
): [QueryKey<TOptions>[0]] => {
Expand Down Expand Up @@ -146,7 +146,7 @@ const createQueryKey = <TOptions extends Options>(
return [params];
};

export const findPetsByStatusQueryKey = (options: Options<FindPetsByStatusData>) =>
export const findPetsByStatusQueryKey = (options?: Partial<Options<FindPetsByStatusData>>) =>
createQueryKey('findPetsByStatus', options);

/**
Expand All @@ -173,7 +173,7 @@ export const findPetsByStatusOptions = (options: Options<FindPetsByStatusData>)
queryKey: findPetsByStatusQueryKey(options),
});

export const findPetsByTagsQueryKey = (options: Options<FindPetsByTagsData>) =>
export const findPetsByTagsQueryKey = (options?: Partial<Options<FindPetsByTagsData>>) =>
createQueryKey('findPetsByTags', options);

/**
Expand Down Expand Up @@ -221,7 +221,7 @@ export const deletePetMutation = (
return mutationOptions;
};

export const getPetByIdQueryKey = (options: Options<GetPetByIdData>) =>
export const getPetByIdQueryKey = (options?: Partial<Options<GetPetByIdData>>) =>
createQueryKey('getPetById', options);

/**
Expand Down Expand Up @@ -298,7 +298,7 @@ export const uploadFileMutation = (
return mutationOptions;
};

export const getInventoryQueryKey = (options?: Options<GetInventoryData>) =>
export const getInventoryQueryKey = (options?: Partial<Options<GetInventoryData>>) =>
createQueryKey('getInventory', options);

/**
Expand Down Expand Up @@ -371,7 +371,7 @@ export const deleteOrderMutation = (
return mutationOptions;
};

export const getOrderByIdQueryKey = (options: Options<GetOrderByIdData>) =>
export const getOrderByIdQueryKey = (options?: Partial<Options<GetOrderByIdData>>) =>
createQueryKey('getOrderById', options);

/**
Expand Down Expand Up @@ -452,7 +452,7 @@ export const createUsersWithListInputMutation = (
return mutationOptions;
};

export const loginUserQueryKey = (options?: Options<LoginUserData>) =>
export const loginUserQueryKey = (options?: Partial<Options<LoginUserData>>) =>
createQueryKey('loginUser', options);

/**
Expand All @@ -479,7 +479,7 @@ export const loginUserOptions = (options?: Options<LoginUserData>) =>
queryKey: loginUserQueryKey(options),
});

export const logoutUserQueryKey = (options?: Options<LogoutUserData>) =>
export const logoutUserQueryKey = (options?: Partial<Options<LogoutUserData>>) =>
createQueryKey('logoutUser', options);

/**
Expand Down Expand Up @@ -522,7 +522,7 @@ export const deleteUserMutation = (
return mutationOptions;
};

export const getUserByNameQueryKey = (options: Options<GetUserByNameData>) =>
export const getUserByNameQueryKey = (options?: Partial<Options<GetUserByNameData>>) =>
createQueryKey('getUserByName', options);

/**
Expand Down
6 changes: 3 additions & 3 deletions ...-query/v5/__snapshots__/2.0.x/plugins/asClass/@tanstack/angular-query-experimental.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export type QueryKey<TOptions extends Options> = [
}
];

const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions, infinite?: boolean, tags?: ReadonlyArray<string>): [
const createQueryKey = <TOptions extends Options>(id: string, options?: Partial<TOptions>, infinite?: boolean, tags?: ReadonlyArray<string>): [
QueryKey<TOptions>[0]
] => {
const params: QueryKey<TOptions>[0] = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl } as QueryKey<TOptions>[0];
Expand All @@ -39,7 +39,7 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);
export const getFooQueryKey = (options?: Partial<Options<GetFooData>>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<GetFooResponse, DefaultError, GetFooResponse, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
Expand Down Expand Up @@ -82,7 +82,7 @@ export const fooPutMutation = (options?: Partial<Options<FooPutData>>): Mutation
return mutationOptions;
};

export const getFooBarQueryKey = (options?: Options<GetFooBarData>) => createQueryKey('getFooBar', options);
export const getFooBarQueryKey = (options?: Partial<Options<GetFooBarData>>) => createQueryKey('getFooBar', options);

export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptions<GetFooBarResponse, DefaultError, GetFooBarResponse, ReturnType<typeof getFooBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
Expand Down
6 changes: 3 additions & 3 deletions ...tests/tanstack-query/v5/__snapshots__/2.0.x/plugins/asClass/@tanstack/preact-query.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export type QueryKey<TOptions extends Options> = [
}
];

const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions, infinite?: boolean, tags?: ReadonlyArray<string>): [
const createQueryKey = <TOptions extends Options>(id: string, options?: Partial<TOptions>, infinite?: boolean, tags?: ReadonlyArray<string>): [
QueryKey<TOptions>[0]
] => {
const params: QueryKey<TOptions>[0] = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl } as QueryKey<TOptions>[0];
Expand All @@ -39,7 +39,7 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
return [params];
};

export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);
export const getFooQueryKey = (options?: Partial<Options<GetFooData>>) => createQueryKey('getFoo', options);

export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<GetFooResponse, DefaultError, GetFooResponse, ReturnType<typeof getFooQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
Expand Down Expand Up @@ -82,7 +82,7 @@ export const fooPutMutation = (options?: Partial<Options<FooPutData>>): UseMutat
return mutationOptions;
};

export const getFooBarQueryKey = (options?: Options<GetFooBarData>) => createQueryKey('getFooBar', options);
export const getFooBarQueryKey = (options?: Partial<Options<GetFooBarData>>) => createQueryKey('getFooBar', options);

export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptions<GetFooBarResponse, DefaultError, GetFooBarResponse, ReturnType<typeof getFooBarQueryKey>>({
queryFn: async ({ queryKey, signal }) => {
Expand Down
Loading
Loading