@kubb/plugin-vue-query 5.0.0-beta.42 → 5.0.0-beta.64

package/src/components/QueryOptions.tsx

@@ -1,137 +0,0 @@
-import { ast } from '@kubb/core'
-import type { ResolverTs } from '@kubb/plugin-ts'
-import { functionPrinter } from '@kubb/plugin-ts'
-import { File, Function } from '@kubb/renderer-jsx'
-import type { KubbReactNode } from '@kubb/renderer-jsx/types'
-import { getEnabledParamNames, markParamsOptional } from '@internals/tanstack-query'
-import type { PluginVueQuery } from '../types.ts'
-import { resolveErrorNames, resolveSuccessNames, wrapWithMaybeRefOrGetter } from '../utils.ts'
-import { buildQueryKeyParamsNode } from './QueryKey.tsx'
-
-type Props = {
-  name: string
-  clientName: string
-  queryKeyName: string
-  node: ast.OperationNode
-  tsResolver: ResolverTs
-  paramsCasing: PluginVueQuery['resolvedOptions']['paramsCasing']
-  paramsType: PluginVueQuery['resolvedOptions']['paramsType']
-  pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
-  dataReturnType: PluginVueQuery['resolvedOptions']['client']['dataReturnType']
-}
-
-const declarationPrinter = functionPrinter({ mode: 'declaration' })
-const callPrinter = functionPrinter({ mode: 'call' })
-
-export function getQueryOptionsParams(
-  node: ast.OperationNode,
-  options: {
-    paramsType: PluginVueQuery['resolvedOptions']['paramsType']
-    paramsCasing: PluginVueQuery['resolvedOptions']['paramsCasing']
-    pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
-    resolver: ResolverTs
-  },
-): ast.FunctionParametersNode {
-  const { paramsType, paramsCasing, pathParamsType, resolver } = options
-  const requestName = node.requestBody?.content?.[0]?.schema ? resolver.resolveDataName(node) : null
-
-  const baseParams = ast.createOperationParams(node, {
-    paramsType,
-    pathParamsType: paramsType === 'object' ? 'object' : pathParamsType === 'object' ? 'object' : 'inline',
-    paramsCasing,
-    resolver,
-    extraParams: [
-      ast.createFunctionParameter({
-        name: 'config',
-        type: ast.createParamsType({
-          variant: 'reference',
-          name: requestName ? `Partial<RequestConfig<${requestName}>> & { client?: Client }` : 'Partial<RequestConfig> & { client?: Client }',
-        }),
-        default: '{}',
-      }),
-    ],
-  })
-
-  return wrapWithMaybeRefOrGetter(baseParams, (name) => name === 'config')
-}
-
-export function QueryOptions({
-  name,
-  clientName,
-  dataReturnType,
-  node,
-  tsResolver,
-  paramsCasing,
-  paramsType,
-  pathParamsType,
-  queryKeyName,
-}: Props): KubbReactNode {
-  const successNames = resolveSuccessNames(node, tsResolver)
-  const responseName = successNames.length > 0 ? successNames.join(' | ') : tsResolver.resolveResponseName(node)
-  const errorNames = resolveErrorNames(node, tsResolver)
-
-  const TData = dataReturnType === 'data' ? responseName : `ResponseConfig<${responseName}>`
-  const TError = `ResponseErrorConfig<${errorNames.length > 0 ? errorNames.join(' | ') : 'Error'}>`
-
-  const queryKeyParamsNode = buildQueryKeyParamsNode(node, { pathParamsType, paramsCasing, resolver: tsResolver })
-  const queryKeyParamsCall = callPrinter.print(queryKeyParamsNode) ?? ''
-
-  const enabledNames = getEnabledParamNames(queryKeyParamsNode)
-  const enabledText = enabledNames.length ? `enabled: () => ${enabledNames.map((n) => `!!toValue(${n})`).join(' && ')},` : ''
-
-  const paramsNode = markParamsOptional(getQueryOptionsParams(node, { paramsType, paramsCasing, pathParamsType, resolver: tsResolver }), enabledNames)
-  const paramsSignature = declarationPrinter.print(paramsNode) ?? ''
-  const rawParamsCall = callPrinter.print(paramsNode) ?? ''
-
-  // Transform: wrap non-config params with toValue(), add signal to config
-  const clientCallStr = rawParamsCall.replace(/\bconfig\b(?=[^,]*$)/, '{ ...config, signal: config.signal ?? signal }')
-
-  return (
-    <File.Source name={name} isExportable isIndexable>
-      <Function name={name} export params={paramsSignature}>
-        {`
-      const queryKey = ${queryKeyName}(${queryKeyParamsCall})
-      return queryOptions<${TData}, ${TError}, ${TData}>({
-       ${enabledText}
-       queryKey,
-       queryFn: async ({ signal }) => {
-          return ${clientName}(${addToValueCalls(clientCallStr, enabledNames)})
-       },
-      })
-`}
-      </Function>
-    </File.Source>
-  )
-}
-
-/**
- * Wraps parameter names with `toValue()` in the client call string,
- * except for 'config'-related params (which are already plain objects).
- *
- * Handles both inline params (`petId, config`) and object shorthand
- * params (`{ petId }, config`) by expanding to `{ petId: toValue(petId) }`.
- */
-function addToValueCalls(callStr: string, enabledNames: ReadonlyArray<string> = []): string {
-  const optional = new Set(enabledNames)
-  // Step 1: Transform shorthand object params like { petId } → { petId: toValue(petId) }
-  // Params that drive the `enabled` guard are optional, so assert non-null: toValue(petId!)
-  let result = callStr.replace(/\{\s*([\w,\s]+)\s*\}(?=\s*,)/g, (match, inner: string) => {
-    // Only transform simple shorthand (no colons, no spread)
-    if (inner.includes(':') || inner.includes('...')) return match
-    const keys = inner
-      .split(',')
-      .map((k: string) => k.trim())
-      .filter(Boolean)
-    const wrapped = keys.map((k: string) => `${k}: toValue(${optional.has(k) ? `${k}!` : k})`).join(', ')
-    return `{ ${wrapped} }`
-  })
-
-  // Step 2: Handle standalone identifiers like `data, params`
-  result = result.replace(/(?<![{.:?])\b(\w+)\b(?=\s*,)/g, (match, name: string) => {
-    if (name === 'config' || name === 'signal' || name === 'undefined') return match
-    if (match.includes('toValue(')) return match
-    return `toValue(${optional.has(name) ? `${name}!` : name})`
-  })
-
-  return result
-}

package/src/components/index.ts

@@ -1,7 +0,0 @@
-export { InfiniteQuery } from './InfiniteQuery.tsx'
-export { InfiniteQueryOptions } from './InfiniteQueryOptions.tsx'
-export { Mutation } from './Mutation.tsx'
-export { MutationKey } from './MutationKey.tsx'
-export { Query } from './Query.tsx'
-export { QueryKey } from './QueryKey.tsx'
-export { QueryOptions } from './QueryOptions.tsx'

package/src/generators/index.ts

@@ -1,3 +0,0 @@
-export { infiniteQueryGenerator } from './infiniteQueryGenerator.tsx'
-export { mutationGenerator } from './mutationGenerator.tsx'
-export { queryGenerator } from './queryGenerator.tsx'

package/src/generators/infiniteQueryGenerator.tsx

@@ -1,200 +0,0 @@
-import path from 'node:path'
-import { getOperationParameters, operationFileEntry, resolveOperationTypeNames } from '@internals/shared'
-import { resolveZodSchemaNames } from '@internals/tanstack-query'
-import { ast, defineGenerator } from '@kubb/core'
-import { Client, pluginClientName } from '@kubb/plugin-client'
-import { pluginTsName } from '@kubb/plugin-ts'
-import { pluginZodName } from '@kubb/plugin-zod'
-import { File, jsxRendererSync } from '@kubb/renderer-jsx'
-import { InfiniteQuery, InfiniteQueryOptions, QueryKey } from '../components'
-import type { PluginVueQuery } from '../types'
-
-/**
- * Built-in generator for `useInfiniteQuery` composables. Enabled when
- * `pluginVueQuery({ infinite: { ... } })`. Emits one `useFooInfiniteQuery`
- * composable per query operation, wiring the configured cursor path into
- * TanStack Query's cursor-based pagination.
- */
-export const infiniteQueryGenerator = defineGenerator<PluginVueQuery>({
-  name: 'vue-query-infinite',
-  renderer: jsxRendererSync,
-  operation(node, ctx) {
-    if (!ast.isHttpOperationNode(node)) return null
-    const { config, driver, resolver, root } = ctx
-    const { output, query, mutation, infinite, paramsCasing, paramsType, pathParamsType, parser, client: clientOptions, group } = ctx.options
-
-    const pluginTs = driver.getPlugin(pluginTsName)
-    if (!pluginTs) return null
-    const tsResolver = driver.getResolver(pluginTsName)
-
-    const isQuery = query === false || (!!query && query.methods.some((method) => node.method.toLowerCase() === method.toLowerCase()))
-    const queryMethods = new Set(query ? query.methods : [])
-    const isMutation =
-      mutation !== false &&
-      !isQuery &&
-      (mutation ? mutation.methods : []).some((method) => !queryMethods.has(method) && node.method.toLowerCase() === method.toLowerCase())
-    const infiniteOptions = infinite && typeof infinite === 'object' ? infinite : null
-
-    if (!isQuery || isMutation || !infiniteOptions) return null
-
-    // Validate queryParam exists in operation's query parameters
-    const normalizeKey = (key: string) => key.replace(/\?$/, '')
-    const queryParamKeys = getOperationParameters(node).query.map((p) => p.name)
-    const hasQueryParam = infiniteOptions.queryParam ? queryParamKeys.some((k) => normalizeKey(k) === infiniteOptions.queryParam) : false
-    // cursorParam validation against response schema keys is skipped in v5 (complex schema inspection)
-    const hasCursorParam = !infiniteOptions.cursorParam || true
-
-    if (!hasQueryParam || !hasCursorParam) return null
-
-    const importPath = query ? query.importPath : '@tanstack/vue-query'
-
-    const queryName = resolver.resolveInfiniteQueryName(node)
-    const queryOptionsName = resolver.resolveInfiniteQueryOptionsName(node)
-    const queryKeyName = resolver.resolveInfiniteQueryKeyName(node)
-    const queryKeyTypeName = resolver.resolveInfiniteQueryKeyTypeName(node)
-    const clientBaseName = resolver.resolveInfiniteClientName(node)
-
-    const meta = {
-      file: resolver.resolveFile(operationFileEntry(node, queryName), { root, output, group: group ?? undefined }),
-      fileTs: tsResolver.resolveFile(operationFileEntry(node, node.operationId), {
-        root,
-        output: pluginTs.options?.output ?? output,
-        group: pluginTs.options?.group ?? undefined,
-      }),
-    }
-
-    const importedTypeNames = resolveOperationTypeNames(node, tsResolver, {
-      paramsCasing,
-      exclude: [queryKeyTypeName],
-      order: 'body-response-first',
-    })
-
-    const pluginZod = parser === 'zod' ? driver.getPlugin(pluginZodName) : null
-    const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null
-    const fileZod = zodResolver
-      ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
-          root,
-          output: pluginZod?.options?.output ?? output,
-          group: pluginZod?.options?.group ?? undefined,
-        })
-      : null
-    const zodSchemaNames = resolveZodSchemaNames(node, zodResolver)
-
-    const clientPlugin = driver.getPlugin(pluginClientName)
-    const hasClientPlugin = clientPlugin?.name === pluginClientName
-    const shouldUseClientPlugin = hasClientPlugin && clientOptions.clientType !== 'class'
-    const clientResolver = shouldUseClientPlugin ? driver.getResolver(pluginClientName) : null
-
-    const clientFile = shouldUseClientPlugin
-      ? clientResolver?.resolveFile(operationFileEntry(node, node.operationId), {
-          root,
-          output: clientPlugin?.options?.output ?? output,
-          group: clientPlugin?.options?.group ?? undefined,
-        })
-      : null
-
-    const resolvedClientName = shouldUseClientPlugin ? (clientResolver?.resolveName(node.operationId) ?? clientBaseName) : clientBaseName
-
-    return (
-      <File
-        baseName={meta.file.baseName}
-        path={meta.file.path}
-        meta={meta.file.meta}
-        banner={resolver.resolveBanner(ctx.meta, { output, config, file: { path: meta.file.path, baseName: meta.file.baseName } })}
-        footer={resolver.resolveFooter(ctx.meta, { output, config, file: { path: meta.file.path, baseName: meta.file.baseName } })}
-      >
-        {fileZod && zodSchemaNames.length > 0 && <File.Import name={zodSchemaNames} root={meta.file.path} path={fileZod.path} />}
-        {clientOptions.importPath ? (
-          <>
-            {!shouldUseClientPlugin && <File.Import name={'client'} path={clientOptions.importPath} />}
-            <File.Import name={['Client', 'RequestConfig', 'ResponseErrorConfig']} path={clientOptions.importPath} isTypeOnly />
-            {clientOptions.dataReturnType === 'full' && <File.Import name={['ResponseConfig']} path={clientOptions.importPath} isTypeOnly />}
-          </>
-        ) : (
-          <>
-            {!shouldUseClientPlugin && <File.Import name={['client']} root={meta.file.path} path={path.resolve(root, '.kubb/client.ts')} />}
-            <File.Import
-              name={['Client', 'RequestConfig', 'ResponseErrorConfig']}
-              root={meta.file.path}
-              path={path.resolve(root, '.kubb/client.ts')}
-              isTypeOnly
-            />
-            {clientOptions.dataReturnType === 'full' && (
-              <File.Import name={['ResponseConfig']} root={meta.file.path} path={path.resolve(root, '.kubb/client.ts')} isTypeOnly />
-            )}
-          </>
-        )}
-        <File.Import name={['toValue']} path="vue" />
-        <File.Import name={['MaybeRefOrGetter']} path="vue" isTypeOnly />
-        {shouldUseClientPlugin && clientFile && <File.Import name={[resolvedClientName]} root={meta.file.path} path={clientFile.path} />}
-        {!shouldUseClientPlugin && <File.Import name={['buildFormData']} root={meta.file.path} path={path.resolve(root, '.kubb/config.ts')} />}
-        {meta.fileTs && importedTypeNames.length > 0 && (
-          <File.Import name={Array.from(new Set(importedTypeNames))} root={meta.file.path} path={meta.fileTs.path} isTypeOnly />
-        )}
-
-        <QueryKey
-          name={queryKeyName}
-          typeName={queryKeyTypeName}
-          node={node}
-          tsResolver={tsResolver}
-          pathParamsType={pathParamsType}
-          paramsCasing={paramsCasing}
-          transformer={ctx.options.queryKey}
-        />
-
-        {!shouldUseClientPlugin && (
-          <Client
-            name={resolvedClientName}
-            baseURL={clientOptions.baseURL}
-            dataReturnType={clientOptions.dataReturnType || 'data'}
-            paramsCasing={clientOptions.paramsCasing || paramsCasing}
-            paramsType={paramsType}
-            pathParamsType={pathParamsType}
-            parser={parser}
-            node={node}
-            tsResolver={tsResolver}
-            zodResolver={zodResolver}
-          />
-        )}
-
-        <File.Import name={['InfiniteData']} isTypeOnly path={importPath} />
-        <File.Import name={['infiniteQueryOptions']} path={importPath} />
-
-        <InfiniteQueryOptions
-          name={queryOptionsName}
-          clientName={resolvedClientName}
-          queryKeyName={queryKeyName}
-          node={node}
-          tsResolver={tsResolver}
-          paramsCasing={paramsCasing}
-          paramsType={paramsType}
-          pathParamsType={pathParamsType}
-          dataReturnType={clientOptions.dataReturnType || 'data'}
-          cursorParam={infiniteOptions.cursorParam}
-          nextParam={infiniteOptions.nextParam}
-          previousParam={infiniteOptions.previousParam}
-          initialPageParam={infiniteOptions.initialPageParam}
-          queryParam={infiniteOptions.queryParam}
-        />
-
-        <File.Import name={['useInfiniteQuery']} path={importPath} />
-        <File.Import name={['QueryKey', 'QueryClient', 'UseInfiniteQueryOptions', 'UseInfiniteQueryReturnType']} path={importPath} isTypeOnly />
-
-        <InfiniteQuery
-          name={queryName}
-          queryOptionsName={queryOptionsName}
-          queryKeyName={queryKeyName}
-          queryKeyTypeName={queryKeyTypeName}
-          node={node}
-          tsResolver={tsResolver}
-          paramsCasing={paramsCasing}
-          paramsType={paramsType}
-          pathParamsType={pathParamsType}
-          dataReturnType={clientOptions.dataReturnType || 'data'}
-          initialPageParam={infiniteOptions.initialPageParam}
-          queryParam={infiniteOptions.queryParam}
-        />
-      </File>
-    )
-  },
-})

package/src/generators/mutationGenerator.tsx

@@ -1,158 +0,0 @@
-import path from 'node:path'
-import { operationFileEntry, resolveOperationTypeNames } from '@internals/shared'
-import { resolveZodSchemaNames } from '@internals/tanstack-query'
-import { ast, defineGenerator } from '@kubb/core'
-import { Client, pluginClientName } from '@kubb/plugin-client'
-import { pluginTsName } from '@kubb/plugin-ts'
-import { pluginZodName } from '@kubb/plugin-zod'
-import { File, jsxRendererSync } from '@kubb/renderer-jsx'
-import { Mutation, MutationKey } from '../components'
-import type { PluginVueQuery } from '../types'
-
-/**
- * Built-in generator for `useMutation` composables. Emits one
- * `useFooMutation` composable per POST/PUT/DELETE operation (configurable
- * via `mutation.methods`) plus the matching `fooMutationKey` helper.
- */
-export const mutationGenerator = defineGenerator<PluginVueQuery>({
-  name: 'vue-query-mutation',
-  renderer: jsxRendererSync,
-  operation(node, ctx) {
-    if (!ast.isHttpOperationNode(node)) return null
-    const { config, driver, resolver, root } = ctx
-    const { output, query, mutation, paramsCasing, paramsType, pathParamsType, parser, client: clientOptions, group } = ctx.options
-
-    const pluginTs = driver.getPlugin(pluginTsName)
-    if (!pluginTs) return null
-    const tsResolver = driver.getResolver(pluginTsName)
-
-    const isQuery = query === false || (!!query && query.methods.some((method) => node.method.toLowerCase() === method.toLowerCase()))
-    const queryMethods = new Set(query ? query.methods : [])
-    const isMutation =
-      mutation !== false &&
-      !isQuery &&
-      (mutation ? mutation.methods : []).some((method) => !queryMethods.has(method) && node.method.toLowerCase() === method.toLowerCase())
-
-    if (!isMutation) return null
-
-    const importPath = mutation ? mutation.importPath : '@tanstack/vue-query'
-
-    const mutationHookName = resolver.resolveMutationName(node)
-    const mutationTypeName = resolver.resolveMutationTypeName(node)
-    const mutationKeyName = resolver.resolveMutationKeyName(node)
-    const clientName = resolver.resolveClientName(node)
-
-    const meta = {
-      file: resolver.resolveFile(operationFileEntry(node, mutationHookName), { root, output, group: group ?? undefined }),
-      fileTs: tsResolver.resolveFile(operationFileEntry(node, node.operationId), {
-        root,
-        output: pluginTs.options?.output ?? output,
-        group: pluginTs.options?.group ?? undefined,
-      }),
-    }
-
-    const importedTypeNames = resolveOperationTypeNames(node, tsResolver, { paramsCasing, order: 'body-response-first' })
-
-    const pluginZod = parser === 'zod' ? driver.getPlugin(pluginZodName) : null
-    const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : null
-    const fileZod = zodResolver
-      ? zodResolver.resolveFile(operationFileEntry(node, node.operationId), {
-          root,
-          output: pluginZod?.options?.output ?? output,
-          group: pluginZod?.options?.group ?? undefined,
-        })
-      : null
-    const zodSchemaNames = resolveZodSchemaNames(node, zodResolver)
-
-    const clientPlugin = driver.getPlugin(pluginClientName)
-    const hasClientPlugin = clientPlugin?.name === pluginClientName
-    const shouldUseClientPlugin = hasClientPlugin && clientOptions.clientType !== 'class'
-    const clientResolver = shouldUseClientPlugin ? driver.getResolver(pluginClientName) : null
-
-    const clientFile = shouldUseClientPlugin
-      ? clientResolver?.resolveFile(operationFileEntry(node, node.operationId), {
-          root,
-          output: clientPlugin?.options?.output ?? output,
-          group: clientPlugin?.options?.group ?? undefined,
-        })
-      : null
-
-    const resolvedClientName = shouldUseClientPlugin ? (clientResolver?.resolveName(node.operationId) ?? clientName) : clientName
-
-    return (
-      <File
-        baseName={meta.file.baseName}
-        path={meta.file.path}
-        meta={meta.file.meta}
-        banner={resolver.resolveBanner(ctx.meta, { output, config, file: { path: meta.file.path, baseName: meta.file.baseName } })}
-        footer={resolver.resolveFooter(ctx.meta, { output, config, file: { path: meta.file.path, baseName: meta.file.baseName } })}
-      >
-        {fileZod && zodSchemaNames.length > 0 && <File.Import name={zodSchemaNames} root={meta.file.path} path={fileZod.path} />}
-        {clientOptions.importPath ? (
-          <>
-            {!shouldUseClientPlugin && <File.Import name={'client'} path={clientOptions.importPath} />}
-            <File.Import name={['Client', 'RequestConfig', 'ResponseErrorConfig']} path={clientOptions.importPath} isTypeOnly />
-            {clientOptions.dataReturnType === 'full' && <File.Import name={['ResponseConfig']} path={clientOptions.importPath} isTypeOnly />}
-          </>
-        ) : (
-          <>
-            {!shouldUseClientPlugin && <File.Import name={['client']} root={meta.file.path} path={path.resolve(root, '.kubb/client.ts')} />}
-            <File.Import
-              name={['Client', 'RequestConfig', 'ResponseErrorConfig']}
-              root={meta.file.path}
-              path={path.resolve(root, '.kubb/client.ts')}
-              isTypeOnly
-            />
-            {clientOptions.dataReturnType === 'full' && (
-              <File.Import name={['ResponseConfig']} root={meta.file.path} path={path.resolve(root, '.kubb/client.ts')} isTypeOnly />
-            )}
-          </>
-        )}
-        <File.Import name={['MaybeRefOrGetter']} path="vue" isTypeOnly />
-        {shouldUseClientPlugin && clientFile && <File.Import name={[resolvedClientName]} root={meta.file.path} path={clientFile.path} />}
-        {!shouldUseClientPlugin && node.requestBody?.content?.some((e) => e.contentType === 'multipart/form-data') && (
-          <File.Import name={['buildFormData']} root={meta.file.path} path={path.resolve(root, '.kubb/config.ts')} />
-        )}
-        {meta.fileTs && importedTypeNames.length > 0 && (
-          <File.Import name={Array.from(new Set(importedTypeNames))} root={meta.file.path} path={meta.fileTs.path} isTypeOnly />
-        )}
-
-        <MutationKey name={mutationKeyName} node={node} pathParamsType={pathParamsType} paramsCasing={paramsCasing} transformer={ctx.options.mutationKey} />
-
-        {!shouldUseClientPlugin && (
-          <Client
-            name={resolvedClientName}
-            baseURL={clientOptions.baseURL}
-            dataReturnType={clientOptions.dataReturnType || 'data'}
-            paramsCasing={clientOptions.paramsCasing || paramsCasing}
-            paramsType={paramsType}
-            pathParamsType={pathParamsType}
-            parser={parser}
-            node={node}
-            tsResolver={tsResolver}
-            zodResolver={zodResolver}
-          />
-        )}
-
-        {mutation && (
-          <>
-            <File.Import name={['useMutation']} path={importPath} />
-            <File.Import name={['MutationObserverOptions', 'QueryClient']} path={importPath} isTypeOnly />
-            <Mutation
-              name={mutationHookName}
-              clientName={resolvedClientName}
-              typeName={mutationTypeName}
-              node={node}
-              tsResolver={tsResolver}
-              paramsCasing={paramsCasing}
-              dataReturnType={clientOptions.dataReturnType || 'data'}
-              paramsType={paramsType}
-              pathParamsType={pathParamsType}
-              mutationKeyName={mutationKeyName}
-            />
-          </>
-        )}
-      </File>
-    )
-  },
-})