diff --git a/packages/openapi-ts-tests/main/test/plugins.test.ts b/packages/openapi-ts-tests/main/test/plugins.test.ts index 426e15a52..37666cbac 100644 --- a/packages/openapi-ts-tests/main/test/plugins.test.ts +++ b/packages/openapi-ts-tests/main/test/plugins.test.ts @@ -64,6 +64,20 @@ for (const version of versions) { }), description: 'generate Fetch API client with TanStack React Query plugin', }, + { + config: createConfig({ + output: 'useQuery-disabled', + plugins: [ + { + name: '@tanstack/react-query', + useQuery: false, + }, + '@hey-api/client-fetch', + ], + }), + description: + 'generate Fetch API client with TanStack React Query plugin with useQuery disabled', + }, { config: createConfig({ output: 'fetch', diff --git a/packages/openapi-ts/src/plugins/@tanstack/preact-query/config.ts b/packages/openapi-ts/src/plugins/@tanstack/preact-query/config.ts index d72a8963a..7d1046842 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/preact-query/config.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/preact-query/config.ts @@ -85,7 +85,7 @@ export const defaultConfig: TanStackPreactQueryPlugin['Config'] = { plugin.config.useQuery = context.valueToObject({ defaultValue: { case: plugin.config.case ?? 'camelCase', - enabled: false, + enabled: true, name: 'use{{name}}Query', }, mappers: { diff --git a/packages/openapi-ts/src/plugins/@tanstack/preact-query/types.ts b/packages/openapi-ts/src/plugins/@tanstack/preact-query/types.ts index bf48ffb24..60d54149d 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/preact-query/types.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/preact-query/types.ts @@ -339,7 +339,7 @@ export type UserConfig = Plugin.Name<'@tanstack/preact-query'> & * - `string` or `function`: Shorthand for `{ name: string | function }` * - `object`: Full configuration object * - * @default false + * @default true */ useQuery?: | boolean diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/infiniteQueryOptions.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/infiniteQueryOptions.ts index a00b45bb6..d8a38e494 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/infiniteQueryOptions.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/infiniteQueryOptions.ts @@ -139,6 +139,10 @@ export const createInfiniteQueryOptions = ({ const typeData = useTypeData({ operation, plugin }); const typeResponse = useTypeResponse({ operation, plugin }); + const symbolSkipToken = $(plugin.external(`${plugin.name}.skipToken`)); + + const optsName = 'opts'; + const symbolQueryKeyType = plugin.referenceSymbol({ category: 'type', resource: 'QueryKey', @@ -180,7 +184,7 @@ export const createInfiniteQueryOptions = ({ ) .call( $.object() - .spread('options') + .spread(optsName) .spread('params') .prop('signal', $('signal')) .prop('throwOnError', $.literal(true)), @@ -216,6 +220,13 @@ export const createInfiniteQueryOptions = ({ statements.push($.const().object('data').assign(awaitSdkFn), $.return('data')); } + const asyncQueryFn = $.func() + .async() + .param((p) => p.object('pageParam', 'queryKey', 'signal')) + .do(...statements); + + const paramType = $.type.or(typeData, $.type.query(symbolSkipToken)); + const symbolInfiniteQueryOptionsFn = plugin.symbol( applyNaming(operation.id, plugin.config.infiniteQueryOptions), ); @@ -224,26 +235,33 @@ export const createInfiniteQueryOptions = ({ .$if(plugin.config.comments && createOperationComment(operation), (c, v) => c.doc(v)) .assign( $.func() - .param('options', (p) => p.required(isRequiredOptions).type(typeData)) + .param('options', (p) => p.required(isRequiredOptions).type(paramType)) .do( + $.const(optsName).assign( + $.ternary($('options').neq(symbolSkipToken)).do($('options')).otherwise($('undefined')), + ), $.return( $(symbolInfiniteQueryOptions) .call( $.object() .pretty() - .hint('@ts-ignore') .prop( 'queryFn', - $.func() - .async() - .param((p) => p.object('pageParam', 'queryKey', 'signal')) - .do(...statements), + $.ternary($('options').eq(symbolSkipToken)) + .do(symbolSkipToken) + .otherwise(asyncQueryFn), + ) + .prop( + 'queryKey', + $(symbolInfiniteQueryKey).call( + isRequiredOptions ? $(optsName).as(typeData) : $(optsName), + ), ) - .prop('queryKey', $(symbolInfiniteQueryKey).call('options')) .$if(handleMeta(plugin, operation, 'infiniteQueryOptions'), (o, v) => o.prop('meta', v), ), ) + .hint('@ts-ignore') .generics( typeResponse, useTypeError({ operation, plugin }), diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/plugin.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/plugin.ts index 39a29e4b4..af3e317e0 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/plugin.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/plugin.ts @@ -1,10 +1,22 @@ -import type { PluginHandler } from '../types'; +import type { PluginHandler, PluginInstance } from '../types'; import { createInfiniteQueryOptions } from './infiniteQueryOptions'; import { createMutationOptions } from './mutationOptions'; import { createQueryOptions } from './queryOptions'; import { createUseMutation } from './useMutation'; import { createUseQuery } from './useQuery'; +const createQueryStyleNames = new Set([ + '@tanstack/angular-query-experimental', + '@tanstack/solid-query', + '@tanstack/svelte-query', +]); + +const getMutationOptionsType = (name: PluginInstance['name']) => + createQueryStyleNames.has(name) ? 'MutationOptions' : 'UseMutationOptions'; + +const getQueryOptionsType = (name: PluginInstance['name']) => + createQueryStyleNames.has(name) ? 'CreateQueryOptions' : 'UseQueryOptions'; + export const handlerV5: PluginHandler = ({ plugin }) => { plugin.symbol('DefaultError', { external: plugin.name, @@ -14,13 +26,7 @@ export const handlerV5: PluginHandler = ({ plugin }) => { external: plugin.name, kind: 'type', }); - const mutationsType = - plugin.name === '@tanstack/angular-query-experimental' || - plugin.name === '@tanstack/svelte-query' || - plugin.name === '@tanstack/solid-query' - ? 'MutationOptions' - : 'UseMutationOptions'; - plugin.symbol(mutationsType, { + plugin.symbol(getMutationOptionsType(plugin.name), { external: plugin.name, kind: 'type', meta: { @@ -39,6 +45,22 @@ export const handlerV5: PluginHandler = ({ plugin }) => { plugin.symbol('useQuery', { external: plugin.name, }); + plugin.symbol(getQueryOptionsType(plugin.name), { + external: plugin.name, + kind: 'type', + meta: { + category: 'external', + resource: `${plugin.name}.QueryObserverOptions`, + }, + }); + plugin.symbol('skipToken', { + external: plugin.name, + meta: { + category: 'external', + resource: `${plugin.name}.skipToken`, + }, + }); + plugin.symbol('AxiosError', { external: 'axios', kind: 'type', diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/queryOptions.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/queryOptions.ts index a630e9a6e..fec2f5b31 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/queryOptions.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/queryOptions.ts @@ -55,6 +55,10 @@ export const createQueryOptions = ({ const typeResponse = useTypeResponse({ operation, plugin }); + const symbolSkipToken = $(plugin.external(`${plugin.name}.skipToken`)); + + const optsName = 'opts'; + const awaitSdkFn = $.lazy((ctx) => ctx .access( @@ -66,7 +70,7 @@ export const createQueryOptions = ({ ) .call( $.object() - .spread(optionsParamName) + .spread(optsName) .spread($('queryKey').attr(0)) .prop('signal', $('signal')) .prop('throwOnError', $.literal(true)), @@ -81,17 +85,26 @@ export const createQueryOptions = ({ statements.push($.const().object('data').assign(awaitSdkFn), $.return('data')); } + const asyncQueryFn = $.func() + .async() + .param((p) => p.object('queryKey', 'signal')) + .do(...statements); + + const typeData = useTypeData({ operation, plugin }); + + const optsForQueryKey = isRequiredOptions ? $(optsName).as(typeData) : $(optsName); + const queryOptionsObj = $.object() .pretty() .prop( 'queryFn', - $.func() - .async() - .param((p) => p.object('queryKey', 'signal')) - .do(...statements), + $.ternary($(optionsParamName).eq(symbolSkipToken)) + .do(symbolSkipToken) + .otherwise(asyncQueryFn), ) - .prop('queryKey', $(symbolQueryKey).call(optionsParamName)) + .prop('queryKey', $(symbolQueryKey).call(optsForQueryKey)) .$if(handleMeta(plugin, operation, 'queryOptions'), (o, v) => o.prop('meta', v)); + const paramType = $.type.or(typeData, $.type.query(symbolSkipToken)); const symbolQueryOptionsFn = plugin.symbol( applyNaming(operation.id, plugin.config.queryOptions), @@ -112,10 +125,13 @@ export const createQueryOptions = ({ .$if(plugin.config.comments && createOperationComment(operation), (c, v) => c.doc(v)) .assign( $.func() - .param(optionsParamName, (p) => - p.required(isRequiredOptions).type(useTypeData({ operation, plugin })), - ) + .param(optionsParamName, (p) => p.required(isRequiredOptions).type(paramType)) .do( + $.const(optsName).assign( + $.ternary($(optionsParamName).neq(symbolSkipToken)) + .do($(optionsParamName)) + .otherwise($('undefined')), + ), $(symbolQueryOptions) .call(queryOptionsObj) .generics( diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/useQuery.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/useQuery.ts index 76b359ffd..47eb9d373 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/useQuery.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/query-core/v5/useQuery.ts @@ -11,6 +11,8 @@ import { useTypeData } from '../shared/useType'; import type { PluginInstance } from '../types'; const optionsParamName = 'options'; +const queryOptionsKey = 'queryOptions'; +const sdkOptionsName = 'sdkOptions'; export const createUseQuery = ({ operation, @@ -27,9 +29,8 @@ export const createUseQuery = ({ return; } - const symbolUseQueryFn = plugin.symbol(applyNaming(operation.id, plugin.config.useQuery)); - const symbolUseQuery = plugin.external(`${plugin.name}.useQuery`); + const symbolUseQueryFn = plugin.symbol(applyNaming(operation.id, plugin.config.useQuery)); const isRequiredOptions = isOperationOptionsRequired({ context: plugin.context, @@ -37,6 +38,9 @@ export const createUseQuery = ({ }); const typeData = useTypeData({ operation, plugin }); + const symbolSkipToken = $(plugin.external(`${plugin.name}.skipToken`)); + const sdkParamType = $.type.or(typeData, $.type.query(symbolSkipToken)); + const symbolQueryOptionsFn = plugin.referenceSymbol({ category: 'hook', resource: 'operation', @@ -44,13 +48,41 @@ export const createUseQuery = ({ role: 'queryOptions', tool: plugin.name, }); + + const queryOptionsType = $.type('Partial').generic( + $.type('Omit', (t) => + t.generics( + $(symbolQueryOptionsFn).returnType(), + $.type.or($.type.literal('queryKey'), $.type.literal('queryFn')), + ), + ), + ); + + const mergedParamType = $.type.and( + sdkParamType, + $.type.object().prop(queryOptionsKey, (p) => p.optional().type(queryOptionsType)), + ); + + const func = $.func().param(optionsParamName, (p) => + p.required(isRequiredOptions).type(mergedParamType), + ); + + func.do( + $.if($(optionsParamName).eq(symbolSkipToken)).do( + $(symbolUseQuery).call($(symbolQueryOptionsFn).call(optionsParamName)).return(), + ), + $.const() + .object(queryOptionsKey) + .spread(sdkOptionsName) + .assign(isRequiredOptions ? $(optionsParamName) : $(optionsParamName).coalesce($.object())), + $(symbolUseQuery) + .call($.object().spread($(symbolQueryOptionsFn).call(sdkOptionsName)).spread(queryOptionsKey)) + .return(), + ); + const statement = $.const(symbolUseQueryFn) .export() .$if(plugin.config.comments && createOperationComment(operation), (c, v) => c.doc(v)) - .assign( - $.func() - .param(optionsParamName, (p) => p.required(isRequiredOptions).type(typeData)) - .do($(symbolUseQuery).call($(symbolQueryOptionsFn).call(optionsParamName)).return()), - ); + .assign(func); plugin.node(statement); }; diff --git a/packages/openapi-ts/src/plugins/@tanstack/react-query/config.ts b/packages/openapi-ts/src/plugins/@tanstack/react-query/config.ts index 41ee1f1fa..17afd0bdf 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/react-query/config.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/react-query/config.ts @@ -85,7 +85,7 @@ export const defaultConfig: TanStackReactQueryPlugin['Config'] = { plugin.config.useQuery = context.valueToObject({ defaultValue: { case: plugin.config.case ?? 'camelCase', - enabled: false, + enabled: true, name: 'use{{name}}Query', }, mappers: { diff --git a/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts b/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts index 7022351dc..97d3959b1 100644 --- a/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts +++ b/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts @@ -339,7 +339,7 @@ export type UserConfig = Plugin.Name<'@tanstack/react-query'> & * - `string` or `function`: Shorthand for `{ name: string | function }` * - `object`: Full configuration object * - * @default false + * @default true */ useQuery?: | boolean diff --git a/packages/openapi-ts/src/ts-dsl/expr/call.ts b/packages/openapi-ts/src/ts-dsl/expr/call.ts index c1001024e..9bf2f02ae 100644 --- a/packages/openapi-ts/src/ts-dsl/expr/call.ts +++ b/packages/openapi-ts/src/ts-dsl/expr/call.ts @@ -7,6 +7,7 @@ import { TsDsl } from '../base'; import { ArgsMixin } from '../mixins/args'; import { AsMixin } from '../mixins/as'; import { ExprMixin } from '../mixins/expr'; +import { HintMixin } from '../mixins/hint'; import { SpreadMixin } from '../mixins/spread'; import { TypeArgsMixin } from '../mixins/type-args'; import { f } from '../utils/factories'; @@ -15,7 +16,9 @@ export type CallArgs = ReadonlyArray; export type CallCallee = NodeName | MaybeTsDsl; export type CallCtor = (callee: CallCallee, ...args: CallArgs) => CallTsDsl; -const Mixed = ArgsMixin(AsMixin(ExprMixin(SpreadMixin(TypeArgsMixin(TsDsl))))); +const Mixed = ArgsMixin( + AsMixin(ExprMixin(HintMixin(SpreadMixin(TypeArgsMixin(TsDsl))))), +); export class CallTsDsl extends Mixed { readonly '~dsl' = 'CallTsDsl'; @@ -34,11 +37,12 @@ export class CallTsDsl extends Mixed { } override toAst() { - return ts.factory.createCallExpression( + const node = ts.factory.createCallExpression( this.$node(this._callee), this.$generics(), this.$args(), ); + return this.$hint(node); } }