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

package/src/generators/queryGenerator.tsx

@@ -1,184 +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 { Query, QueryKey, QueryOptions } from '../components'
-import type { PluginVueQuery } from '../types'
-
-/**
- * Built-in generator for `useQuery` composables. Emits one `useFooQuery`
- * composable per GET operation (configurable via `query.methods`) plus the
- * matching `fooQueryKey` / `fooQueryOptions` helpers.
- */
-export const queryGenerator = defineGenerator<PluginVueQuery>({
-  name: 'vue-query',
-  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 (!isQuery || isMutation) return null
-
-    const importPath = query ? query.importPath : '@tanstack/vue-query'
-
-    const queryName = resolver.resolveQueryName(node)
-    const queryOptionsName = resolver.resolveQueryOptionsName(node)
-    const queryKeyName = resolver.resolveQueryKeyName(node)
-    const queryKeyTypeName = resolver.resolveQueryKeyTypeName(node)
-    const clientName = resolver.resolveClientName(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) ?? 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={['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={['queryOptions']} path={importPath} />
-
-        <QueryOptions
-          name={queryOptionsName}
-          clientName={resolvedClientName}
-          queryKeyName={queryKeyName}
-          node={node}
-          tsResolver={tsResolver}
-          paramsCasing={paramsCasing}
-          paramsType={paramsType}
-          pathParamsType={pathParamsType}
-          dataReturnType={clientOptions.dataReturnType || 'data'}
-        />
-
-        {query && (
-          <>
-            <File.Import name={['useQuery']} path={importPath} />
-            <File.Import name={['QueryKey', 'QueryClient', 'UseQueryOptions', 'UseQueryReturnType']} path={importPath} isTypeOnly />
-            <Query
-              name={queryName}
-              queryOptionsName={queryOptionsName}
-              queryKeyName={queryKeyName}
-              queryKeyTypeName={queryKeyTypeName}
-              node={node}
-              tsResolver={tsResolver}
-              paramsCasing={paramsCasing}
-              paramsType={paramsType}
-              pathParamsType={pathParamsType}
-              dataReturnType={clientOptions.dataReturnType || 'data'}
-            />
-          </>
-        )}
-      </File>
-    )
-  },
-})

package/src/index.ts

@@ -1,2 +0,0 @@
-export { default, pluginVueQuery, pluginVueQueryName } from './plugin.ts'
-export type { PluginVueQuery } from './types.ts'

package/src/plugin.ts

@@ -1,183 +0,0 @@
-import path from 'node:path'
-import { createGroupConfig } from '@internals/shared'
-import { ast, definePlugin } from '@kubb/core'
-import { pluginClientName } from '@kubb/plugin-client'
-import { source as axiosClientSource } from '@kubb/plugin-client/templates/clients/axios.source'
-import { source as fetchClientSource } from '@kubb/plugin-client/templates/clients/fetch.source'
-import { source as configSource } from '@kubb/plugin-client/templates/config.source'
-import { pluginTsName } from '@kubb/plugin-ts'
-import { pluginZodName } from '@kubb/plugin-zod'
-import { mutationKeyTransformer } from '@internals/tanstack-query'
-import { queryKeyTransformer } from '@internals/tanstack-query'
-import { infiniteQueryGenerator, mutationGenerator, queryGenerator } from './generators'
-import { resolverVueQuery } from './resolvers/resolverVueQuery.ts'
-import type { PluginVueQuery } from './types.ts'
-
-/**
- * Canonical plugin name for `@kubb/plugin-vue-query`. Used for driver lookups
- * and cross-plugin dependency references.
- */
-export const pluginVueQueryName = 'plugin-vue-query' satisfies PluginVueQuery['name']
-
-/**
- * Generates one TanStack Query composable per OpenAPI operation for Vue's
- * Composition API. Queries become `useFooQuery` (and optionally
- * `useFooInfiniteQuery`); mutations become `useFooMutation`. Each composable
- * is fully typed end to end.
- *
- * @example
- * ```ts
- * import { defineConfig } from 'kubb'
- * import { pluginTs } from '@kubb/plugin-ts'
- * import { pluginVueQuery } from '@kubb/plugin-vue-query'
- *
- * export default defineConfig({
- *   input: { path: './petStore.yaml' },
- *   output: { path: './src/gen' },
- *   plugins: [
- *     pluginTs(),
- *     pluginVueQuery({
- *       output: { path: './hooks' },
- *     }),
- *   ],
- * })
- * ```
- */
-export const pluginVueQuery = definePlugin<PluginVueQuery>((options) => {
-  const {
-    output = { path: 'hooks', barrelType: 'named' },
-    group,
-    exclude = [],
-    include,
-    override = [],
-    parser = false,
-    infinite = false,
-    paramsType = 'inline',
-    pathParamsType = paramsType === 'object' ? 'object' : options.pathParamsType || 'inline',
-    mutation = {},
-    query = {},
-    mutationKey = mutationKeyTransformer,
-    queryKey = queryKeyTransformer,
-    paramsCasing,
-    client,
-    resolver: userResolver,
-    transformer: userTransformer,
-    generators: userGenerators = [],
-  } = options
-
-  const clientName = client?.client ?? 'axios'
-  const clientImportPath = client?.importPath ?? (!client?.bundle ? `@kubb/plugin-client/clients/${clientName}` : undefined)
-
-  const selectedGenerators =
-    options.generators ??
-    [queryGenerator, infiniteQueryGenerator, mutationGenerator].filter((generator): generator is NonNullable<typeof generator> => Boolean(generator))
-
-  const groupConfig = createGroupConfig(group, { suffix: 'Controller' })
-
-  return {
-    name: pluginVueQueryName,
-    options,
-    dependencies: [pluginTsName, parser === 'zod' ? pluginZodName : undefined].filter((dependency): dependency is string => Boolean(dependency)),
-    hooks: {
-      'kubb:plugin:setup'(ctx) {
-        const resolver = userResolver ? { ...resolverVueQuery, ...userResolver } : resolverVueQuery
-
-        ctx.setOptions({
-          output,
-          client: {
-            bundle: client?.bundle,
-            baseURL: client?.baseURL,
-            client: clientName,
-            clientType: client?.clientType ?? 'function',
-            importPath: clientImportPath,
-            dataReturnType: client?.dataReturnType ?? 'data',
-            paramsCasing,
-          },
-          queryKey,
-          query:
-            query === false
-              ? false
-              : {
-                  importPath: '@tanstack/vue-query',
-                  methods: ['get'],
-                  ...query,
-                },
-          mutationKey,
-          mutation:
-            mutation === false
-              ? false
-              : {
-                  importPath: '@tanstack/vue-query',
-                  methods: ['post', 'put', 'patch', 'delete'],
-                  ...mutation,
-                },
-          infinite: infinite
-            ? {
-                queryParam: 'id',
-                initialPageParam: 0,
-                cursorParam: null,
-                nextParam: null,
-                previousParam: null,
-                ...infinite,
-              }
-            : false,
-          parser,
-          paramsType,
-          pathParamsType,
-          paramsCasing,
-          group: groupConfig,
-          exclude,
-          include,
-          override,
-          resolver,
-        })
-        ctx.setResolver(resolver)
-        if (userTransformer) {
-          ctx.setTransformer(userTransformer)
-        }
-
-        for (const gen of selectedGenerators) {
-          ctx.addGenerator(gen)
-        }
-        for (const gen of userGenerators) {
-          ctx.addGenerator(gen)
-        }
-
-        const root = path.resolve(ctx.config.root, ctx.config.output.path)
-        const hasClientPlugin = !!ctx.config.plugins?.some((p) => (p as { name?: string }).name === pluginClientName)
-
-        if (client?.bundle && !hasClientPlugin && !clientImportPath) {
-          ctx.injectFile({
-            baseName: 'client.ts',
-            path: path.resolve(root, '.kubb/client.ts'),
-            sources: [
-              ast.createSource({
-                name: 'client',
-                nodes: [ast.createText(clientName === 'fetch' ? fetchClientSource : axiosClientSource)],
-                isExportable: true,
-                isIndexable: true,
-              }),
-            ],
-          })
-        }
-
-        if (!hasClientPlugin) {
-          ctx.injectFile({
-            baseName: 'config.ts',
-            path: path.resolve(root, '.kubb/config.ts'),
-            sources: [
-              ast.createSource({
-                name: 'config',
-                nodes: [ast.createText(configSource)],
-                isExportable: false,
-                isIndexable: false,
-              }),
-            ],
-          })
-        }
-      },
-    },
-  }
-})
-
-export default pluginVueQuery

package/src/resolvers/resolverVueQuery.ts

@@ -1,76 +0,0 @@
-import { camelCase } from '@internals/utils'
-import { defineResolver } from '@kubb/core'
-import type { PluginVueQuery } from '../types.ts'
-
-function capitalize(name: string): string {
-  return `${name.charAt(0).toUpperCase()}${name.slice(1)}`
-}
-
-/**
- * Default resolver used by `@kubb/plugin-vue-query`. Decides the names and
- * file paths for every generated TanStack Query composable (`useFooQuery`,
- * `useFooMutation`, `useFooInfiniteQuery`) and its companion helpers.
- *
- * Functions and files use camelCase; composables get the `use` prefix.
- *
- * @example Resolve composable and helper names
- * ```ts
- * import { resolverVueQuery } from '@kubb/plugin-vue-query'
- *
- * resolverVueQuery.resolveQueryName(operationNode)       // 'useGetPetById'
- * resolverVueQuery.resolveQueryKeyName(operationNode)    // 'getPetByIdQueryKey'
- * resolverVueQuery.resolveQueryOptionsName(operationNode) // 'getPetByIdQueryOptions'
- * ```
- */
-export const resolverVueQuery = defineResolver<PluginVueQuery>(() => ({
-  name: 'default',
-  pluginName: 'plugin-vue-query',
-  default(name, type) {
-    return camelCase(name, { isFile: type === 'file' })
-  },
-  resolveName(name) {
-    return this.default(name, 'function')
-  },
-  resolvePathName(name, type) {
-    return this.default(name, type)
-  },
-  resolveQueryName(node) {
-    return `use${capitalize(this.resolveName(node.operationId))}`
-  },
-  resolveInfiniteQueryName(node) {
-    return `use${capitalize(this.resolveName(node.operationId))}Infinite`
-  },
-  resolveMutationName(node) {
-    return `use${capitalize(this.resolveName(node.operationId))}`
-  },
-  resolveQueryOptionsName(node) {
-    return `${this.resolveName(node.operationId)}QueryOptions`
-  },
-  resolveInfiniteQueryOptionsName(node) {
-    return `${this.resolveName(node.operationId)}InfiniteQueryOptions`
-  },
-  resolveQueryKeyName(node) {
-    return `${this.resolveName(node.operationId)}QueryKey`
-  },
-  resolveInfiniteQueryKeyName(node) {
-    return `${this.resolveName(node.operationId)}InfiniteQueryKey`
-  },
-  resolveMutationKeyName(node) {
-    return `${this.resolveName(node.operationId)}MutationKey`
-  },
-  resolveQueryKeyTypeName(node) {
-    return `${capitalize(this.resolveName(node.operationId))}QueryKey`
-  },
-  resolveInfiniteQueryKeyTypeName(node) {
-    return `${capitalize(this.resolveName(node.operationId))}InfiniteQueryKey`
-  },
-  resolveMutationTypeName(node) {
-    return capitalize(this.resolveName(node.operationId))
-  },
-  resolveClientName(node) {
-    return this.resolveName(node.operationId)
-  },
-  resolveInfiniteClientName(node) {
-    return `${this.resolveName(node.operationId)}Infinite`
-  },
-}))