Skip to content

Commit 3007b3c

Browse files
nmokkenstormnmokkenstorm
committed
feat: add useQuery hooks and skipToken support for TanStack query plugins
1 parent 2e13802 commit 3007b3c

File tree

184 files changed

+31329
-2891
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

184 files changed

+31329
-2891
lines changed

‎.changeset/warm-rabbits-dance.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@hey-api/openapi-ts": minor
3+
---
4+
5+
**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‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// This file is auto-generated by @hey-api/openapi-ts
22

3-
import { type DefaultError, type MutationOptions, queryOptions } from '@tanstack/angular-query-experimental';
3+
import { type DefaultError, type MutationOptions, queryOptions, skipToken } from '@tanstack/angular-query-experimental';
44

55
import { client } from '../client.gen';
66
import { BarBazService, BarService, FooBazService, FooService, type Options } from '../sdk.gen';
@@ -39,19 +39,23 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
3939
return [params];
4040
};
4141

42+
const resolveOptions = <T>(options: T | typeof skipToken) => options === skipToken ? undefined : options;
43+
44+
const resolveQueryFn = <T>(options: T | typeof skipToken, queryFn: T) => options === skipToken ? skipToken : queryFn;
45+
4246
export const getFooQueryKey = (options?: Options<GetFooData>) => createQueryKey('getFoo', options);
4347

44-
export const getFooOptions = (options?: Options<GetFooData>) => queryOptions<GetFooResponse, DefaultError, GetFooResponse, ReturnType<typeof getFooQueryKey>>({
45-
queryFn: async ({ queryKey, signal }) => {
48+
export const getFooOptions = (options?: Options<GetFooData> | typeof skipToken) => queryOptions<GetFooResponse, DefaultError, GetFooResponse, ReturnType<typeof getFooQueryKey>>({
49+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
4650
const { data } = await FooBazService.getFoo({
4751
...options,
4852
...queryKey[0],
4953
signal,
5054
throwOnError: true
5155
});
5256
return data;
53-
},
54-
queryKey: getFooQueryKey(options)
57+
}),
58+
queryKey: getFooQueryKey(resolveOptions(options))
5559
});
5660

5761
export const fooPostMutation = (options?: Partial<Options<FooPostData>>): MutationOptions<FooPostResponse, DefaultError, Options<FooPostData>> => {
@@ -84,17 +88,17 @@ export const fooPutMutation = (options?: Partial<Options<FooPutData>>): Mutation
8488

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

87-
export const getFooBarOptions = (options?: Options<GetFooBarData>) => queryOptions<GetFooBarResponse, DefaultError, GetFooBarResponse, ReturnType<typeof getFooBarQueryKey>>({
88-
queryFn: async ({ queryKey, signal }) => {
91+
export const getFooBarOptions = (options?: Options<GetFooBarData> | typeof skipToken) => queryOptions<GetFooBarResponse, DefaultError, GetFooBarResponse, ReturnType<typeof getFooBarQueryKey>>({
92+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
8993
const { data } = await BarBazService.getFooBar({
9094
...options,
9195
...queryKey[0],
9296
signal,
9397
throwOnError: true
9498
});
9599
return data;
96-
},
97-
queryKey: getFooBarQueryKey(options)
100+
}),
101+
queryKey: getFooBarQueryKey(resolveOptions(options))
98102
});
99103

100104
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‎

Lines changed: 53 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// This file is auto-generated by @hey-api/openapi-ts
22

3-
import { type DefaultError, type MutationOptions, queryOptions } from '@tanstack/angular-query-experimental';
3+
import { type DefaultError, type MutationOptions, queryOptions, skipToken } from '@tanstack/angular-query-experimental';
44
import type { AxiosError } from 'axios';
55

66
import { client } from '../client.gen';
@@ -40,19 +40,23 @@ const createQueryKey = <TOptions extends Options>(id: string, options?: TOptions
4040
return [params];
4141
};
4242

43+
const resolveOptions = <T>(options: T | typeof skipToken) => options === skipToken ? undefined : options;
44+
45+
const resolveQueryFn = <T>(options: T | typeof skipToken, queryFn: T) => options === skipToken ? skipToken : queryFn;
46+
4347
export const serviceWithEmptyTagQueryKey = (options?: Options<ServiceWithEmptyTagData>) => createQueryKey('serviceWithEmptyTag', options);
4448

45-
export const serviceWithEmptyTagOptions = (options?: Options<ServiceWithEmptyTagData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof serviceWithEmptyTagQueryKey>>({
46-
queryFn: async ({ queryKey, signal }) => {
49+
export const serviceWithEmptyTagOptions = (options?: Options<ServiceWithEmptyTagData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof serviceWithEmptyTagQueryKey>>({
50+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
4751
const { data } = await serviceWithEmptyTag({
4852
...options,
4953
...queryKey[0],
5054
signal,
5155
throwOnError: true
5256
});
5357
return data;
54-
},
55-
queryKey: serviceWithEmptyTagQueryKey(options)
58+
}),
59+
queryKey: serviceWithEmptyTagQueryKey(resolveOptions(options))
5660
});
5761

5862
export const patchApiVbyApiVersionNoTagMutation = (options?: Partial<Options<PatchApiVbyApiVersionNoTagData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<PatchApiVbyApiVersionNoTagData>> => {
@@ -99,17 +103,17 @@ export const deleteCallWithoutParametersAndResponseMutation = (options?: Partial
99103

100104
export const getCallWithoutParametersAndResponseQueryKey = (options?: Options<GetCallWithoutParametersAndResponseData>) => createQueryKey('getCallWithoutParametersAndResponse', options);
101105

102-
export const getCallWithoutParametersAndResponseOptions = (options?: Options<GetCallWithoutParametersAndResponseData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof getCallWithoutParametersAndResponseQueryKey>>({
103-
queryFn: async ({ queryKey, signal }) => {
106+
export const getCallWithoutParametersAndResponseOptions = (options?: Options<GetCallWithoutParametersAndResponseData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof getCallWithoutParametersAndResponseQueryKey>>({
107+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
104108
const { data } = await getCallWithoutParametersAndResponse({
105109
...options,
106110
...queryKey[0],
107111
signal,
108112
throwOnError: true
109113
});
110114
return data;
111-
},
112-
queryKey: getCallWithoutParametersAndResponseQueryKey(options)
115+
}),
116+
queryKey: getCallWithoutParametersAndResponseQueryKey(resolveOptions(options))
113117
});
114118

115119
export const patchCallWithoutParametersAndResponseMutation = (options?: Partial<Options<PatchCallWithoutParametersAndResponseData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<PatchCallWithoutParametersAndResponseData>> => {
@@ -198,17 +202,17 @@ export const callWithWeirdParameterNamesMutation = (options?: Partial<Options<Ca
198202

199203
export const callWithDefaultParametersQueryKey = (options: Options<CallWithDefaultParametersData>) => createQueryKey('callWithDefaultParameters', options);
200204

201-
export const callWithDefaultParametersOptions = (options: Options<CallWithDefaultParametersData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithDefaultParametersQueryKey>>({
202-
queryFn: async ({ queryKey, signal }) => {
205+
export const callWithDefaultParametersOptions = (options: Options<CallWithDefaultParametersData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithDefaultParametersQueryKey>>({
206+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
203207
const { data } = await callWithDefaultParameters({
204208
...options,
205209
...queryKey[0],
206210
signal,
207211
throwOnError: true
208212
});
209213
return data;
210-
},
211-
queryKey: callWithDefaultParametersQueryKey(options)
214+
}),
215+
queryKey: callWithDefaultParametersQueryKey(resolveOptions(options))
212216
});
213217

214218
export const callWithDefaultOptionalParametersMutation = (options?: Partial<Options<CallWithDefaultOptionalParametersData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithDefaultOptionalParametersData>> => {
@@ -255,17 +259,17 @@ export const duplicateNameMutation = (options?: Partial<Options<DuplicateNameDat
255259

256260
export const duplicateName2QueryKey = (options?: Options<DuplicateName2Data>) => createQueryKey('duplicateName2', options);
257261

258-
export const duplicateName2Options = (options?: Options<DuplicateName2Data>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof duplicateName2QueryKey>>({
259-
queryFn: async ({ queryKey, signal }) => {
262+
export const duplicateName2Options = (options?: Options<DuplicateName2Data> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof duplicateName2QueryKey>>({
263+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
260264
const { data } = await duplicateName2({
261265
...options,
262266
...queryKey[0],
263267
signal,
264268
throwOnError: true
265269
});
266270
return data;
267-
},
268-
queryKey: duplicateName2QueryKey(options)
271+
}),
272+
queryKey: duplicateName2QueryKey(resolveOptions(options))
269273
});
270274

271275
export const duplicateName3Mutation = (options?: Partial<Options<DuplicateName3Data>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<DuplicateName3Data>> => {
@@ -298,77 +302,77 @@ export const duplicateName4Mutation = (options?: Partial<Options<DuplicateName4D
298302

299303
export const callWithNoContentResponseQueryKey = (options?: Options<CallWithNoContentResponseData>) => createQueryKey('callWithNoContentResponse', options);
300304

301-
export const callWithNoContentResponseOptions = (options?: Options<CallWithNoContentResponseData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithNoContentResponseQueryKey>>({
302-
queryFn: async ({ queryKey, signal }) => {
305+
export const callWithNoContentResponseOptions = (options?: Options<CallWithNoContentResponseData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof callWithNoContentResponseQueryKey>>({
306+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
303307
const { data } = await callWithNoContentResponse({
304308
...options,
305309
...queryKey[0],
306310
signal,
307311
throwOnError: true
308312
});
309313
return data;
310-
},
311-
queryKey: callWithNoContentResponseQueryKey(options)
314+
}),
315+
queryKey: callWithNoContentResponseQueryKey(resolveOptions(options))
312316
});
313317

314318
export const callWithResponseAndNoContentResponseQueryKey = (options?: Options<CallWithResponseAndNoContentResponseData>) => createQueryKey('callWithResponseAndNoContentResponse', options);
315319

316-
export const callWithResponseAndNoContentResponseOptions = (options?: Options<CallWithResponseAndNoContentResponseData>) => queryOptions<CallWithResponseAndNoContentResponseResponse, AxiosError<DefaultError>, CallWithResponseAndNoContentResponseResponse, ReturnType<typeof callWithResponseAndNoContentResponseQueryKey>>({
317-
queryFn: async ({ queryKey, signal }) => {
320+
export const callWithResponseAndNoContentResponseOptions = (options?: Options<CallWithResponseAndNoContentResponseData> | typeof skipToken) => queryOptions<CallWithResponseAndNoContentResponseResponse, AxiosError<DefaultError>, CallWithResponseAndNoContentResponseResponse, ReturnType<typeof callWithResponseAndNoContentResponseQueryKey>>({
321+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
318322
const { data } = await callWithResponseAndNoContentResponse({
319323
...options,
320324
...queryKey[0],
321325
signal,
322326
throwOnError: true
323327
});
324328
return data;
325-
},
326-
queryKey: callWithResponseAndNoContentResponseQueryKey(options)
329+
}),
330+
queryKey: callWithResponseAndNoContentResponseQueryKey(resolveOptions(options))
327331
});
328332

329333
export const dummyAQueryKey = (options?: Options<DummyAData>) => createQueryKey('dummyA', options);
330334

331-
export const dummyAOptions = (options?: Options<DummyAData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyAQueryKey>>({
332-
queryFn: async ({ queryKey, signal }) => {
335+
export const dummyAOptions = (options?: Options<DummyAData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyAQueryKey>>({
336+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
333337
const { data } = await dummyA({
334338
...options,
335339
...queryKey[0],
336340
signal,
337341
throwOnError: true
338342
});
339343
return data;
340-
},
341-
queryKey: dummyAQueryKey(options)
344+
}),
345+
queryKey: dummyAQueryKey(resolveOptions(options))
342346
});
343347

344348
export const dummyBQueryKey = (options?: Options<DummyBData>) => createQueryKey('dummyB', options);
345349

346-
export const dummyBOptions = (options?: Options<DummyBData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyBQueryKey>>({
347-
queryFn: async ({ queryKey, signal }) => {
350+
export const dummyBOptions = (options?: Options<DummyBData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof dummyBQueryKey>>({
351+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
348352
const { data } = await dummyB({
349353
...options,
350354
...queryKey[0],
351355
signal,
352356
throwOnError: true
353357
});
354358
return data;
355-
},
356-
queryKey: dummyBQueryKey(options)
359+
}),
360+
queryKey: dummyBQueryKey(resolveOptions(options))
357361
});
358362

359363
export const callWithResponseQueryKey = (options?: Options<CallWithResponseData>) => createQueryKey('callWithResponse', options);
360364

361-
export const callWithResponseOptions = (options?: Options<CallWithResponseData>) => queryOptions<CallWithResponseResponse, AxiosError<DefaultError>, CallWithResponseResponse, ReturnType<typeof callWithResponseQueryKey>>({
362-
queryFn: async ({ queryKey, signal }) => {
365+
export const callWithResponseOptions = (options?: Options<CallWithResponseData> | typeof skipToken) => queryOptions<CallWithResponseResponse, AxiosError<DefaultError>, CallWithResponseResponse, ReturnType<typeof callWithResponseQueryKey>>({
366+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
363367
const { data } = await callWithResponse({
364368
...options,
365369
...queryKey[0],
366370
signal,
367371
throwOnError: true
368372
});
369373
return data;
370-
},
371-
queryKey: callWithResponseQueryKey(options)
374+
}),
375+
queryKey: callWithResponseQueryKey(resolveOptions(options))
372376
});
373377

374378
export const callWithDuplicateResponsesMutation = (options?: Partial<Options<CallWithDuplicateResponsesData>>): MutationOptions<CallWithDuplicateResponsesResponse, AxiosError<CallWithDuplicateResponsesError>, Options<CallWithDuplicateResponsesData>> => {
@@ -401,47 +405,47 @@ export const callWithResponsesMutation = (options?: Partial<Options<CallWithResp
401405

402406
export const collectionFormatQueryKey = (options: Options<CollectionFormatData>) => createQueryKey('collectionFormat', options);
403407

404-
export const collectionFormatOptions = (options: Options<CollectionFormatData>) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof collectionFormatQueryKey>>({
405-
queryFn: async ({ queryKey, signal }) => {
408+
export const collectionFormatOptions = (options: Options<CollectionFormatData> | typeof skipToken) => queryOptions<unknown, AxiosError<DefaultError>, unknown, ReturnType<typeof collectionFormatQueryKey>>({
409+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
406410
const { data } = await collectionFormat({
407411
...options,
408412
...queryKey[0],
409413
signal,
410414
throwOnError: true
411415
});
412416
return data;
413-
},
414-
queryKey: collectionFormatQueryKey(options)
417+
}),
418+
queryKey: collectionFormatQueryKey(resolveOptions(options))
415419
});
416420

417421
export const typesQueryKey = (options: Options<TypesData>) => createQueryKey('types', options);
418422

419-
export const typesOptions = (options: Options<TypesData>) => queryOptions<TypesResponse, AxiosError<DefaultError>, TypesResponse, ReturnType<typeof typesQueryKey>>({
420-
queryFn: async ({ queryKey, signal }) => {
423+
export const typesOptions = (options: Options<TypesData> | typeof skipToken) => queryOptions<TypesResponse, AxiosError<DefaultError>, TypesResponse, ReturnType<typeof typesQueryKey>>({
424+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
421425
const { data } = await types({
422426
...options,
423427
...queryKey[0],
424428
signal,
425429
throwOnError: true
426430
});
427431
return data;
428-
},
429-
queryKey: typesQueryKey(options)
432+
}),
433+
queryKey: typesQueryKey(resolveOptions(options))
430434
});
431435

432436
export const complexTypesQueryKey = (options: Options<ComplexTypesData>) => createQueryKey('complexTypes', options);
433437

434-
export const complexTypesOptions = (options: Options<ComplexTypesData>) => queryOptions<ComplexTypesResponse, AxiosError<DefaultError>, ComplexTypesResponse, ReturnType<typeof complexTypesQueryKey>>({
435-
queryFn: async ({ queryKey, signal }) => {
438+
export const complexTypesOptions = (options: Options<ComplexTypesData> | typeof skipToken) => queryOptions<ComplexTypesResponse, AxiosError<DefaultError>, ComplexTypesResponse, ReturnType<typeof complexTypesQueryKey>>({
439+
queryFn: resolveQueryFn(options, async ({ queryKey, signal }) => {
436440
const { data } = await complexTypes({
437441
...options,
438442
...queryKey[0],
439443
signal,
440444
throwOnError: true
441445
});
442446
return data;
443-
},
444-
queryKey: complexTypesQueryKey(options)
447+
}),
448+
queryKey: complexTypesQueryKey(resolveOptions(options))
445449
});
446450

447451
export const callWithResultFromHeaderMutation = (options?: Partial<Options<CallWithResultFromHeaderData>>): MutationOptions<unknown, AxiosError<DefaultError>, Options<CallWithResultFromHeaderData>> => {

0 commit comments

Comments
 (0)