feat: always enable skipToken support across all TanStack query plugins

Author: nmokkenstorm

.changeset/warm-rabbits-dance.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+**tanstack-query**: add `useQuery` hooks, `skipToken` support, and `queryOptions` override parameter for TanStack React Query plugin

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/asClass/@tanstack/angular-query-experimental.gen.ts

@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import { type DefaultError, type MutationOptions, queryOptions } from '@tanstack/angular-query-experimental';
+import { type DefaultError, type MutationOptions, queryOptions, skipToken } from '@tanstack/angular-query-experimental';
 
 import { client } from '../client.gen';
 import { BarBazService, BarService, FooBazService, FooService, type Options } from '../sdk.gen';
@@ -41,8 +41,8 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
 
 export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);
 
-export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<GetFooResponse, DefaultError, GetFooResponse, ReturnType<typeof getFooQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<GetFooResponse, DefaultError, GetFooResponse, ReturnType<typeof getFooQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await FooBazService.getFoo({
             ...options,
             ...queryKey[0],
@@ -51,7 +51,7 @@ export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<Get
         });
         return data;
     },
-    queryKey: getFooQueryKey(options)
+    queryKey: getFooQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const fooPostMutation = (options?: Partial<Options<FooPostData>>): MutationOptions<FooPostResponse, DefaultError, Options<FooPostData>> => {
@@ -84,8 +84,8 @@ export const fooPutMutation = (options?: Partial<Options<FooPutData>>): Mutation
 
 export const getFooBarQueryKey = (options?: Options<GetFooBarData>) => createQueryKey('getFooBar', options);
 
-export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptions<GetFooBarResponse, DefaultError, GetFooBarResponse, ReturnType<typeof getFooBarQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const getFooBarOptions = (options?: Options<GetFooBarData> | typeof skipToken) => queryOptions<GetFooBarResponse, DefaultError, GetFooBarResponse, ReturnType<typeof getFooBarQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await BarBazService.getFooBar({
             ...options,
             ...queryKey[0],
@@ -94,7 +94,7 @@ export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptio
         });
         return data;
     },
-    queryKey: getFooBarQueryKey(options)
+    queryKey: getFooBarQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const fooBarPostMutation = (options?: Partial<Options<FooBarPostData>>): MutationOptions<FooBarPostResponse, DefaultError, Options<FooBarPostData>> => {

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/@tanstack/angular-query-experimental.gen.ts

@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import { type DefaultError, type MutationOptions, queryOptions } from '@tanstack/angular-query-experimental';
+import { type DefaultError, type MutationOptions, queryOptions, skipToken } from '@tanstack/angular-query-experimental';
 import type { AxiosError } from 'axios';
 
 import { client } from '../client.gen';
@@ -42,8 +42,8 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
 
 export const serviceWithEmptyTagQueryKey = (options?: Options<ServiceWithEmptyTagData>) => createQueryKey('serviceWithEmptyTag', options);
 
-export const serviceWithEmptyTagOptions = (options?: Options<ServiceWithEmptyTagData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof serviceWithEmptyTagQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const serviceWithEmptyTagOptions = (options?: Options<ServiceWithEmptyTagData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof serviceWithEmptyTagQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await serviceWithEmptyTag({
             ...options,
             ...queryKey[0],
@@ -52,7 +52,7 @@ export const serviceWithEmptyTagOptions = (options?: Options<ServiceWithEmptyTag
         });
         return data;
     },
-    queryKey: serviceWithEmptyTagQueryKey(options)
+    queryKey: serviceWithEmptyTagQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const patchApiVbyApiVersionNoTagMutation = (options?: Partial<Options<PatchApiVbyApiVersionNoTagData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<PatchApiVbyApiVersionNoTagData>> => {
@@ -99,8 +99,8 @@ export const deleteCallWithoutParametersAndResponseMutation = (options?: Partial
 
 export const getCallWithoutParametersAndResponseQueryKey = (options?: Options<GetCallWithoutParametersAndResponseData>) => createQueryKey('getCallWithoutParametersAndResponse', options);
 
-export const getCallWithoutParametersAndResponseOptions = (options?: Options<GetCallWithoutParametersAndResponseData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof getCallWithoutParametersAndResponseQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const getCallWithoutParametersAndResponseOptions = (options?: Options<GetCallWithoutParametersAndResponseData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof getCallWithoutParametersAndResponseQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await getCallWithoutParametersAndResponse({
             ...options,
             ...queryKey[0],
@@ -109,7 +109,7 @@ export const getCallWithoutParametersAndResponseOptions = (options?: Options<Get
         });
         return data;
     },
-    queryKey: getCallWithoutParametersAndResponseQueryKey(options)
+    queryKey: getCallWithoutParametersAndResponseQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const patchCallWithoutParametersAndResponseMutation = (options?: Partial<Options<PatchCallWithoutParametersAndResponseData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<PatchCallWithoutParametersAndResponseData>> => {
@@ -198,8 +198,8 @@ export const callWithWeirdParameterNamesMutation = (options?: Partial<Options<Ca
 
 export const callWithDefaultParametersQueryKey = (options: Options<CallWithDefaultParametersData>) => createQueryKey('callWithDefaultParameters', options);
 
-export const callWithDefaultParametersOptions = (options: Options<CallWithDefaultParametersData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithDefaultParametersQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const callWithDefaultParametersOptions = (options: Options<CallWithDefaultParametersData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithDefaultParametersQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await callWithDefaultParameters({
             ...options,
             ...queryKey[0],
@@ -208,7 +208,7 @@ export const callWithDefaultParametersOptions = (options: Options<CallWithDefaul
         });
         return data;
     },
-    queryKey: callWithDefaultParametersQueryKey(options)
+    queryKey: callWithDefaultParametersQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const callWithDefaultOptionalParametersMutation = (options?: Partial<Options<CallWithDefaultOptionalParametersData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithDefaultOptionalParametersData>> => {
@@ -255,8 +255,8 @@ export const duplicateNameMutation = (options?: Partial<Options<DuplicateNameDat
 
 export const duplicateName2QueryKey = (options?: Options<DuplicateName2Data>) => createQueryKey('duplicateName2', options);
 
-export const duplicateName2Options = (options?: Options<DuplicateName2Data>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof duplicateName2QueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const duplicateName2Options = (options?: Options<DuplicateName2Data> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof duplicateName2QueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await duplicateName2({
             ...options,
             ...queryKey[0],
@@ -265,7 +265,7 @@ export const duplicateName2Options = (options?: Options<DuplicateName2Data>) =>
         });
         return data;
     },
-    queryKey: duplicateName2QueryKey(options)
+    queryKey: duplicateName2QueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const duplicateName3Mutation = (options?: Partial<Options<DuplicateName3Data>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<DuplicateName3Data>> => {
@@ -298,8 +298,8 @@ export const duplicateName4Mutation = (options?: Partial<Options<DuplicateName4D
 
 export const callWithNoContentResponseQueryKey = (options?: Options<CallWithNoContentResponseData>) => createQueryKey('callWithNoContentResponse', options);
 
-export const callWithNoContentResponseOptions = (options?: Options<CallWithNoContentResponseData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithNoContentResponseQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const callWithNoContentResponseOptions = (options?: Options<CallWithNoContentResponseData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithNoContentResponseQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await callWithNoContentResponse({
             ...options,
             ...queryKey[0],
@@ -308,13 +308,13 @@ export const callWithNoContentResponseOptions = (options?: Options<CallWithNoCon
         });
         return data;
     },
-    queryKey: callWithNoContentResponseQueryKey(options)
+    queryKey: callWithNoContentResponseQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const callWithResponseAndNoContentResponseQueryKey = (options?: Options<CallWithResponseAndNoContentResponseData>) => createQueryKey('callWithResponseAndNoContentResponse', options);
 
-export const callWithResponseAndNoContentResponseOptions = (options?: Options<CallWithResponseAndNoContentResponseData>) => queryOptions<CallWithResponseAndNoContentResponseResponse, AxiosError<DefaultError>, CallWithResponseAndNoContentResponseResponse, ReturnType<typeof callWithResponseAndNoContentResponseQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const callWithResponseAndNoContentResponseOptions = (options?: Options<CallWithResponseAndNoContentResponseData> | typeof skipToken) => queryOptions<CallWithResponseAndNoContentResponseResponse, AxiosError<DefaultError>, CallWithResponseAndNoContentResponseResponse, ReturnType<typeof callWithResponseAndNoContentResponseQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await callWithResponseAndNoContentResponse({
             ...options,
             ...queryKey[0],
@@ -323,13 +323,13 @@ export const callWithResponseAndNoContentResponseOptions = (options?: Options<Ca
         });
         return data;
     },
-    queryKey: callWithResponseAndNoContentResponseQueryKey(options)
+    queryKey: callWithResponseAndNoContentResponseQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const dummyAQueryKey = (options?: Options<DummyAData>) => createQueryKey('dummyA', options);
 
-export const dummyAOptions = (options?: Options<DummyAData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyAQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const dummyAOptions = (options?: Options<DummyAData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyAQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await dummyA({
             ...options,
             ...queryKey[0],
@@ -338,13 +338,13 @@ export const dummyAOptions = (options?: Options<DummyAData>) => queryOptions<unk
         });
         return data;
     },
-    queryKey: dummyAQueryKey(options)
+    queryKey: dummyAQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const dummyBQueryKey = (options?: Options<DummyBData>) => createQueryKey('dummyB', options);
 
-export const dummyBOptions = (options?: Options<DummyBData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyBQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const dummyBOptions = (options?: Options<DummyBData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyBQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await dummyB({
             ...options,
             ...queryKey[0],
@@ -353,13 +353,13 @@ export const dummyBOptions = (options?: Options<DummyBData>) => queryOptions<unk
         });
         return data;
     },
-    queryKey: dummyBQueryKey(options)
+    queryKey: dummyBQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const callWithResponseQueryKey = (options?: Options<CallWithResponseData>) => createQueryKey('callWithResponse', options);
 
-export const callWithResponseOptions = (options?: Options<CallWithResponseData>) => queryOptions<CallWithResponseResponse, AxiosError<DefaultError>, CallWithResponseResponse, ReturnType<typeof callWithResponseQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const callWithResponseOptions = (options?: Options<CallWithResponseData> | typeof skipToken) => queryOptions<CallWithResponseResponse, AxiosError<DefaultError>, CallWithResponseResponse, ReturnType<typeof callWithResponseQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await callWithResponse({
             ...options,
             ...queryKey[0],
@@ -368,7 +368,7 @@ export const callWithResponseOptions = (options?: Options<CallWithResponseData>)
         });
         return data;
     },
-    queryKey: callWithResponseQueryKey(options)
+    queryKey: callWithResponseQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const callWithDuplicateResponsesMutation = (options?: Partial<Options<CallWithDuplicateResponsesData>>): MutationOptions<CallWithDuplicateResponsesResponse, AxiosError<CallWithDuplicateResponsesError>, Options<CallWithDuplicateResponsesData>> => {
@@ -401,8 +401,8 @@ export const callWithResponsesMutation = (options?: Partial<Options<CallWithResp
 
 export const collectionFormatQueryKey = (options: Options<CollectionFormatData>) => createQueryKey('collectionFormat', options);
 
-export const collectionFormatOptions = (options: Options<CollectionFormatData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof collectionFormatQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const collectionFormatOptions = (options: Options<CollectionFormatData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof collectionFormatQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await collectionFormat({
             ...options,
             ...queryKey[0],
@@ -411,13 +411,13 @@ export const collectionFormatOptions = (options: Options<CollectionFormatData>)
         });
         return data;
     },
-    queryKey: collectionFormatQueryKey(options)
+    queryKey: collectionFormatQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const typesQueryKey = (options: Options<TypesData>) => createQueryKey('types', options);
 
-export const typesOptions = (options: Options<TypesData>) => queryOptions<TypesResponse, AxiosError<DefaultError>, TypesResponse, ReturnType<typeof typesQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const typesOptions = (options: Options<TypesData> | typeof skipToken) => queryOptions<TypesResponse, AxiosError<DefaultError>, TypesResponse, ReturnType<typeof typesQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await types({
             ...options,
             ...queryKey[0],
@@ -426,13 +426,13 @@ export const typesOptions = (options: Options<TypesData>) => queryOptions<TypesR
         });
         return data;
     },
-    queryKey: typesQueryKey(options)
+    queryKey: typesQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const complexTypesQueryKey = (options: Options<ComplexTypesData>) => createQueryKey('complexTypes', options);
 
-export const complexTypesOptions = (options: Options<ComplexTypesData>) => queryOptions<ComplexTypesResponse, AxiosError<DefaultError>, ComplexTypesResponse, ReturnType<typeof complexTypesQueryKey>>({
-    queryFn: async ({ queryKey, signal }) => {
+export const complexTypesOptions = (options: Options<ComplexTypesData> | typeof skipToken) => queryOptions<ComplexTypesResponse, AxiosError<DefaultError>, ComplexTypesResponse, ReturnType<typeof complexTypesQueryKey>>({
+    queryFn: options === skipToken ? skipToken : async ({ queryKey, signal }) => {
         const { data } = await complexTypes({
             ...options,
             ...queryKey[0],
@@ -441,7 +441,7 @@ export const complexTypesOptions = (options: Options<ComplexTypesData>) => query
         });
         return data;
     },
-    queryKey: complexTypesQueryKey(options)
+    queryKey: complexTypesQueryKey(options === skipToken ? undefined as never : options)
 });
 
 export const callWithResultFromHeaderMutation = (options?: Partial<Options<CallWithResultFromHeaderData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithResultFromHeaderData>> => {