feat(@tanstack/query)!: enable useQuery by default with queryOptions override

Author: nmokkenstorm

.changeset/tanstack-usequery-queryoptions-override.md

@@ -0,0 +1,9 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+**plugin(@tanstack/react-query, @tanstack/preact-query)**: feat: enable `useQuery` hook generation by default and add `queryOptions` override parameter
+
+`useQuery` hook generation now defaults to `true` for React Query and Preact Query plugins. Generated hooks accept an optional `queryOptions` property (typed as `Partial<Omit<ReturnType<typeof xOptions>, 'queryKey' | 'queryFn'>>`) that is spread over the computed query options, mirroring the existing `mutationOptions` override on `useMutation` hooks.
+
+Opt out of `useQuery` hook generation with `useQuery: false`.

packages/openapi-ts-tests/tanstack-query/v5/__snapshots__/2.0.x/plugins/asClass/@tanstack/preact-query.gen.ts

@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import { type DefaultError, queryOptions, type UseMutationOptions } from '@tanstack/preact-query';
+import { type DefaultError, queryOptions, type UseMutationOptions, useQuery } from '@tanstack/preact-query';
 
 import { client } from '../client.gen';
 import { BarBazService, BarService, FooBazService, FooService, type Options } from '../sdk.gen';
@@ -54,6 +54,13 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<Get
     queryKey: getFooQueryKey(options)
 });
 
+export const useGetFooQuery = (options?: Options<GetFooData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof getFooOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...getFooOptions(sdkOptions), ...queryOptions });
+};
+
 export const fooPostMutation = (options?: Partial<Options<FooPostData>>): UseMutationOptions<FooPostResponse, DefaultError, Options<FooPostData>> => {
     const mutationOptions: UseMutationOptions<FooPostResponse, DefaultError, Options<FooPostData>> = {
         mutationFn: async (fnOptions) => {
@@ -97,6 +104,13 @@ export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptio
     queryKey: getFooBarQueryKey(options)
 });
 
+export const useGetFooBarQuery = (options?: Options<GetFooBarData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof getFooBarOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...getFooBarOptions(sdkOptions), ...queryOptions });
+};
+
 export const fooBarPostMutation = (options?: Partial<Options<FooBarPostData>>): UseMutationOptions<FooBarPostResponse, DefaultError, Options<FooBarPostData>> => {
     const mutationOptions: UseMutationOptions<FooBarPostResponse, DefaultError, Options<FooBarPostData>> = {
         mutationFn: async (fnOptions) => {

packages/openapi-ts-tests/tanstack-query/v5/__snapshots__/2.0.x/plugins/asClass/@tanstack/react-query.gen.ts

@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import { type DefaultError, queryOptions, type UseMutationOptions } from '@tanstack/react-query';
+import { type DefaultError, queryOptions, type UseMutationOptions, useQuery } from '@tanstack/react-query';
 
 import { client } from '../client.gen';
 import { BarBazService, BarService, FooBazService, FooService, type Options } from '../sdk.gen';
@@ -54,6 +54,13 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<Get
     queryKey: getFooQueryKey(options)
 });
 
+export const useGetFooQuery = (options?: Options<GetFooData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof getFooOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...getFooOptions(sdkOptions), ...queryOptions });
+};
+
 export const fooPostMutation = (options?: Partial<Options<FooPostData>>): UseMutationOptions<FooPostResponse, DefaultError, Options<FooPostData>> => {
     const mutationOptions: UseMutationOptions<FooPostResponse, DefaultError, Options<FooPostData>> = {
         mutationFn: async (fnOptions) => {
@@ -97,6 +104,13 @@ export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptio
     queryKey: getFooBarQueryKey(options)
 });
 
+export const useGetFooBarQuery = (options?: Options<GetFooBarData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof getFooBarOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...getFooBarOptions(sdkOptions), ...queryOptions });
+};
+
 export const fooBarPostMutation = (options?: Partial<Options<FooBarPostData>>): UseMutationOptions<FooBarPostResponse, DefaultError, Options<FooBarPostData>> => {
     const mutationOptions: UseMutationOptions<FooBarPostResponse, DefaultError, Options<FooBarPostData>> = {
         mutationFn: async (fnOptions) => {

packages/openapi-ts-tests/tanstack-query/v5/__snapshots__/2.0.x/plugins/axios/@tanstack/preact-query.gen.ts

@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import { type DefaultError, queryOptions, type UseMutationOptions } from '@tanstack/preact-query';
+import { type DefaultError, queryOptions, type UseMutationOptions, useQuery } from '@tanstack/preact-query';
 import type { AxiosError } from 'axios';
 
 import { client } from '../client.gen';
@@ -55,6 +55,13 @@ export const serviceWithEmptyTagOptions = (options?: Options<ServiceWithEmptyTag
     queryKey: serviceWithEmptyTagQueryKey(options)
 });
 
+export const useServiceWithEmptyTagQuery = (options?: Options<ServiceWithEmptyTagData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof serviceWithEmptyTagOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...serviceWithEmptyTagOptions(sdkOptions), ...queryOptions });
+};
+
 export const patchApiVbyApiVersionNoTagMutation = (options?: Partial<Options<PatchApiVbyApiVersionNoTagData>>): UseMutationOptions<unknown, AxiosError<DefaultError>, Options<PatchApiVbyApiVersionNoTagData>> => {
     const mutationOptions: UseMutationOptions<unknown, AxiosError<DefaultError>, Options<PatchApiVbyApiVersionNoTagData>> = {
         mutationFn: async (fnOptions) => {
@@ -112,6 +119,13 @@ export const getCallWithoutParametersAndResponseOptions = (options?: Options<Get
     queryKey: getCallWithoutParametersAndResponseQueryKey(options)
 });
 
+export const useGetCallWithoutParametersAndResponseQuery = (options?: Options<GetCallWithoutParametersAndResponseData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof getCallWithoutParametersAndResponseOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...getCallWithoutParametersAndResponseOptions(sdkOptions), ...queryOptions });
+};
+
 export const patchCallWithoutParametersAndResponseMutation = (options?: Partial<Options<PatchCallWithoutParametersAndResponseData>>): UseMutationOptions<unknown, AxiosError<DefaultError>, Options<PatchCallWithoutParametersAndResponseData>> => {
     const mutationOptions: UseMutationOptions<unknown, AxiosError<DefaultError>, Options<PatchCallWithoutParametersAndResponseData>> = {
         mutationFn: async (fnOptions) => {
@@ -211,6 +225,13 @@ export const callWithDefaultParametersOptions = (options: Options<CallWithDefaul
     queryKey: callWithDefaultParametersQueryKey(options)
 });
 
+export const useCallWithDefaultParametersQuery = (options: Options<CallWithDefaultParametersData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof callWithDefaultParametersOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options;
+    return useQuery({ ...callWithDefaultParametersOptions(sdkOptions), ...queryOptions });
+};
+
 export const callWithDefaultOptionalParametersMutation = (options?: Partial<Options<CallWithDefaultOptionalParametersData>>): UseMutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithDefaultOptionalParametersData>> => {
     const mutationOptions: UseMutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithDefaultOptionalParametersData>> = {
         mutationFn: async (fnOptions) => {
@@ -268,6 +289,13 @@ export const duplicateName2Options = (options?: Options<DuplicateName2Data>) =>
     queryKey: duplicateName2QueryKey(options)
 });
 
+export const useDuplicateName2Query = (options?: Options<DuplicateName2Data> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof duplicateName2Options>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...duplicateName2Options(sdkOptions), ...queryOptions });
+};
+
 export const duplicateName3Mutation = (options?: Partial<Options<DuplicateName3Data>>): UseMutationOptions<unknown, AxiosError<DefaultError>, Options<DuplicateName3Data>> => {
     const mutationOptions: UseMutationOptions<unknown, AxiosError<DefaultError>, Options<DuplicateName3Data>> = {
         mutationFn: async (fnOptions) => {
@@ -311,6 +339,13 @@ export const callWithNoContentResponseOptions = (options?: Options<CallWithNoCon
     queryKey: callWithNoContentResponseQueryKey(options)
 });
 
+export const useCallWithNoContentResponseQuery = (options?: Options<CallWithNoContentResponseData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof callWithNoContentResponseOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...callWithNoContentResponseOptions(sdkOptions), ...queryOptions });
+};
+
 export const callWithResponseAndNoContentResponseQueryKey = (options?: Options<CallWithResponseAndNoContentResponseData>) => createQueryKey('callWithResponseAndNoContentResponse', options);
 
 export const callWithResponseAndNoContentResponseOptions = (options?: Options<CallWithResponseAndNoContentResponseData>) => queryOptions<CallWithResponseAndNoContentResponseResponse, AxiosError<DefaultError>, CallWithResponseAndNoContentResponseResponse, ReturnType<typeof callWithResponseAndNoContentResponseQueryKey>>({
@@ -326,6 +361,13 @@ export const callWithResponseAndNoContentResponseOptions = (options?: Options<Ca
     queryKey: callWithResponseAndNoContentResponseQueryKey(options)
 });
 
+export const useCallWithResponseAndNoContentResponseQuery = (options?: Options<CallWithResponseAndNoContentResponseData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof callWithResponseAndNoContentResponseOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...callWithResponseAndNoContentResponseOptions(sdkOptions), ...queryOptions });
+};
+
 export const dummyAQueryKey = (options?: Options<DummyAData>) => createQueryKey('dummyA', options);
 
 export const dummyAOptions = (options?: Options<DummyAData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyAQueryKey>>({
@@ -341,6 +383,13 @@ export const dummyAOptions = (options?: Options<DummyAData>) => queryOptions<unk
     queryKey: dummyAQueryKey(options)
 });
 
+export const useDummyAQuery = (options?: Options<DummyAData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof dummyAOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...dummyAOptions(sdkOptions), ...queryOptions });
+};
+
 export const dummyBQueryKey = (options?: Options<DummyBData>) => createQueryKey('dummyB', options);
 
 export const dummyBOptions = (options?: Options<DummyBData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyBQueryKey>>({
@@ -356,6 +405,13 @@ export const dummyBOptions = (options?: Options<DummyBData>) => queryOptions<unk
     queryKey: dummyBQueryKey(options)
 });
 
+export const useDummyBQuery = (options?: Options<DummyBData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof dummyBOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...dummyBOptions(sdkOptions), ...queryOptions });
+};
+
 export const callWithResponseQueryKey = (options?: Options<CallWithResponseData>) => createQueryKey('callWithResponse', options);
 
 export const callWithResponseOptions = (options?: Options<CallWithResponseData>) => queryOptions<CallWithResponseResponse, AxiosError<DefaultError>, CallWithResponseResponse, ReturnType<typeof callWithResponseQueryKey>>({
@@ -371,6 +427,13 @@ export const callWithResponseOptions = (options?: Options<CallWithResponseData>)
     queryKey: callWithResponseQueryKey(options)
 });
 
+export const useCallWithResponseQuery = (options?: Options<CallWithResponseData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof callWithResponseOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options ?? {};
+    return useQuery({ ...callWithResponseOptions(sdkOptions), ...queryOptions });
+};
+
 export const callWithDuplicateResponsesMutation = (options?: Partial<Options<CallWithDuplicateResponsesData>>): UseMutationOptions<CallWithDuplicateResponsesResponse, AxiosError<CallWithDuplicateResponsesError>, Options<CallWithDuplicateResponsesData>> => {
     const mutationOptions: UseMutationOptions<CallWithDuplicateResponsesResponse, AxiosError<CallWithDuplicateResponsesError>, Options<CallWithDuplicateResponsesData>> = {
         mutationFn: async (fnOptions) => {
@@ -414,6 +477,13 @@ export const collectionFormatOptions = (options: Options<CollectionFormatData>)
     queryKey: collectionFormatQueryKey(options)
 });
 
+export const useCollectionFormatQuery = (options: Options<CollectionFormatData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof collectionFormatOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options;
+    return useQuery({ ...collectionFormatOptions(sdkOptions), ...queryOptions });
+};
+
 export const typesQueryKey = (options: Options<TypesData>) => createQueryKey('types', options);
 
 export const typesOptions = (options: Options<TypesData>) => queryOptions<TypesResponse, AxiosError<DefaultError>, TypesResponse, ReturnType<typeof typesQueryKey>>({
@@ -429,6 +499,13 @@ export const typesOptions = (options: Options<TypesData>) => queryOptions<TypesR
     queryKey: typesQueryKey(options)
 });
 
+export const useTypesQuery = (options: Options<TypesData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof typesOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options;
+    return useQuery({ ...typesOptions(sdkOptions), ...queryOptions });
+};
+
 export const complexTypesQueryKey = (options: Options<ComplexTypesData>) => createQueryKey('complexTypes', options);
 
 export const complexTypesOptions = (options: Options<ComplexTypesData>) => queryOptions<ComplexTypesResponse, AxiosError<DefaultError>, ComplexTypesResponse, ReturnType<typeof complexTypesQueryKey>>({
@@ -444,6 +521,13 @@ export const complexTypesOptions = (options: Options<ComplexTypesData>) => query
     queryKey: complexTypesQueryKey(options)
 });
 
+export const useComplexTypesQuery = (options: Options<ComplexTypesData> & {
+    queryOptions?: Partial<Omit<ReturnType<typeof complexTypesOptions>, 'queryKey' | 'queryFn'>>;
+}) => {
+    const { queryOptions, ...sdkOptions } = options;
+    return useQuery({ ...complexTypesOptions(sdkOptions), ...queryOptions });
+};
+
 export const callWithResultFromHeaderMutation = (options?: Partial<Options<CallWithResultFromHeaderData>>): UseMutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithResultFromHeaderData>> => {
     const mutationOptions: UseMutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithResultFromHeaderData>> = {
         mutationFn: async (fnOptions) => {