Skip to content

chore: drop Tanstack Query v3 compatibility (BREAKING CHANGE) #2487

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

Merged
melloware merged 1 commit into from
Oct 27, 2025
Merged

chore: drop Tanstack Query v3 compatibility (BREAKING CHANGE) #2487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions packages/core/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ export type NormalizedQueryOptions = {
shouldSplitQueryKey?: boolean;
useOperationIdAsQueryKey?: boolean;
signal?: boolean;
version?: 3 | 4 | 5;
version?: 4 | 5;
};

export type QueryOptions = {
Expand All @@ -606,7 +606,7 @@ export type QueryOptions = {
shouldSplitQueryKey?: boolean;
useOperationIdAsQueryKey?: boolean;
signal?: boolean;
version?: 3 | 4 | 5;
version?: 4 | 5;
};

export type AngularOptions = {
Expand Down
144 changes: 5 additions & 139 deletions packages/query/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,28 +79,6 @@ const PARAMS_SERIALIZER_DEPENDENCIES: GeneratorDependency[] = [
},
];

const SVELTE_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
{
exports: [
{ name: 'useQuery', values: true },
{ name: 'useInfiniteQuery', values: true },
{ name: 'useMutation', values: true },
{ name: 'UseQueryOptions' },
{
name: 'UseInfiniteQueryOptions',
},
{ name: 'UseMutationOptions' },
{ name: 'QueryFunction' },
{ name: 'MutationFunction' },
{ name: 'UseQueryStoreResult' },
{ name: 'UseInfiniteQueryStoreResult' },
{ name: 'QueryKey' },
{ name: 'CreateMutationResult' },
{ name: 'InvalidateOptions' },
],
dependency: '@sveltestack/svelte-query',
},
];
const SVELTE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
{
exports: [
Expand All @@ -127,19 +105,6 @@ const SVELTE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
},
];

const isSvelteQueryV3 = (packageJson: PackageJson | undefined) => {
const hasSvelteQuery =
packageJson?.dependencies?.['@sveltestack/svelte-query'] ??
packageJson?.devDependencies?.['@sveltestack/svelte-query'] ??
packageJson?.peerDependencies?.['@sveltestack/svelte-query'];
const hasSvelteQueryV4 =
packageJson?.dependencies?.['@tanstack/svelte-query'] ??
packageJson?.devDependencies?.['@tanstack/svelte-query'] ??
packageJson?.peerDependencies?.['@tanstack/svelte-query'];

return !!hasSvelteQuery && !hasSvelteQueryV4;
};

const isSvelteQueryV6 = (packageJson: PackageJson | undefined) => {
return isQueryV6(packageJson, 'svelte-query');
};
Expand All @@ -150,41 +115,15 @@ export const getSvelteQueryDependencies: ClientDependenciesBuilder = (
packageJson,
httpClient?: OutputHttpClient,
) => {
const hasSvelteQueryV3 = isSvelteQueryV3(packageJson);

return [
...(!hasGlobalMutator && httpClient === OutputHttpClient.AXIOS
? AXIOS_DEPENDENCIES
: []),
...(hasParamsSerializerOptions ? PARAMS_SERIALIZER_DEPENDENCIES : []),
...(hasSvelteQueryV3
? SVELTE_QUERY_DEPENDENCIES_V3
: SVELTE_QUERY_DEPENDENCIES),
...SVELTE_QUERY_DEPENDENCIES,
];
};

const REACT_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
{
exports: [
{ name: 'useQuery', values: true },
{ name: 'useInfiniteQuery', values: true },
{ name: 'useMutation', values: true },
{ name: 'useQueryClient', values: true },
{ name: 'UseQueryOptions' },
{ name: 'UseInfiniteQueryOptions' },
{ name: 'UseMutationOptions' },
{ name: 'QueryFunction' },
{ name: 'MutationFunction' },
{ name: 'UseQueryResult' },
{ name: 'UseInfiniteQueryResult' },
{ name: 'QueryKey' },
{ name: 'QueryClient' },
{ name: 'UseMutationResult' },
{ name: 'InvalidateOptions' },
],
dependency: 'react-query',
},
];
const REACT_QUERY_DEPENDENCIES: GeneratorDependency[] = [
{
exports: [
Expand Down Expand Up @@ -226,71 +165,17 @@ export const getReactQueryDependencies: ClientDependenciesBuilder = (
packageJson,
httpClient,
hasTagsMutator,
override,
) => {
const hasReactQuery =
packageJson?.dependencies?.['react-query'] ??
packageJson?.devDependencies?.['react-query'] ??
packageJson?.peerDependencies?.['react-query'];
const hasReactQueryV4 =
packageJson?.dependencies?.['@tanstack/react-query'] ??
packageJson?.devDependencies?.['@tanstack/react-query'] ??
packageJson?.peerDependencies?.['@tanstack/react-query'];

const useReactQueryV3 =
override?.query.version === undefined
? hasReactQuery && !hasReactQueryV4
: override?.query.version <= 3;

return [
...(hasGlobalMutator || hasTagsMutator ? REACT_DEPENDENCIES : []),
...(!hasGlobalMutator && httpClient === OutputHttpClient.AXIOS
? AXIOS_DEPENDENCIES
: []),
...(hasParamsSerializerOptions ? PARAMS_SERIALIZER_DEPENDENCIES : []),
...(useReactQueryV3
? REACT_QUERY_DEPENDENCIES_V3
: REACT_QUERY_DEPENDENCIES),
...REACT_QUERY_DEPENDENCIES,
];
};

const VUE_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
{
exports: [
{ name: 'useQuery', values: true },
{ name: 'useInfiniteQuery', values: true },
{ name: 'useMutation', values: true },
],
dependency: 'vue-query',
},
{
exports: [
{ name: 'UseQueryOptions' },
{ name: 'UseInfiniteQueryOptions' },
{ name: 'UseMutationOptions' },
{ name: 'QueryFunction' },
{ name: 'MutationFunction' },
{ name: 'UseQueryResult' },
{ name: 'UseInfiniteQueryResult' },
{ name: 'QueryKey' },
{ name: 'UseMutationReturnType' },
{ name: 'InvalidateOptions' },
],
dependency: 'vue-query/types',
},
{
exports: [
{ name: 'unref', values: true },
{ name: 'computed', values: true },
],
dependency: 'vue',
},
{
exports: [{ name: 'UseQueryReturnType' }],
dependency: 'vue-query/lib/vue/useBaseQuery',
},
];

const VUE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
{
exports: [
Expand Down Expand Up @@ -323,33 +208,18 @@ const VUE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
},
];

const isVueQueryV3 = (packageJson: PackageJson | undefined) => {
const hasVueQuery =
packageJson?.dependencies?.['vue-query'] ??
packageJson?.devDependencies?.['vue-query'] ??
packageJson?.peerDependencies?.['vue-query'];
const hasVueQueryV4 =
packageJson?.dependencies?.['@tanstack/vue-query'] ??
packageJson?.devDependencies?.['@tanstack/vue-query'] ??
packageJson?.peerDependencies?.['@tanstack/vue-query'];

return !!hasVueQuery && !hasVueQueryV4;
};

export const getVueQueryDependencies: ClientDependenciesBuilder = (
hasGlobalMutator: boolean,
hasParamsSerializerOptions: boolean,
packageJson,
httpClient?: OutputHttpClient,
) => {
const hasVueQueryV3 = isVueQueryV3(packageJson);

return [
...(!hasGlobalMutator && httpClient === OutputHttpClient.AXIOS
? AXIOS_DEPENDENCIES
: []),
...(hasParamsSerializerOptions ? PARAMS_SERIALIZER_DEPENDENCIES : []),
...(hasVueQueryV3 ? VUE_QUERY_DEPENDENCIES_V3 : VUE_QUERY_DEPENDENCIES),
...VUE_QUERY_DEPENDENCIES,
];
};

Expand Down Expand Up @@ -1266,12 +1136,8 @@ const generateQueryHook = async (
!!context.output.tsconfig?.compilerOptions?.exactOptionalPropertyTypes;
const queryVersion = override.query.version ?? query?.version;

const hasVueQueryV4 =
OutputClient.VUE_QUERY === outputClient &&
(!isVueQueryV3(context.output.packageJson) || queryVersion === 4);
const hasSvelteQueryV4 =
OutputClient.SVELTE_QUERY === outputClient &&
(!isSvelteQueryV3(context.output.packageJson) || queryVersion === 4);
const hasVueQueryV4 = OutputClient.VUE_QUERY === outputClient;
const hasSvelteQueryV4 = OutputClient.SVELTE_QUERY === outputClient;
const hasSvelteQueryV6 =
OutputClient.SVELTE_QUERY === outputClient &&
isSvelteQueryV6(context.output.packageJson);
Expand Down