@kubb/plugin-vue-query 5.0.0-beta.56 → 5.0.0-beta.73

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 { isParserEnabled, 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', barrel: { type: '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)
-
-  return {
-    name: pluginVueQueryName,
-    options,
-    dependencies: [pluginTsName, isParserEnabled(parser) ? 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, toFilePath } 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 type === 'file' ? toFilePath(name) : camelCase(name)
-  },
-  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`
-  },
-}))

package/src/types.ts

@@ -1,268 +0,0 @@
-import type { ast, Exclude, Generator, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver } from '@kubb/core'
-import type { ClientImportPath, PluginClient } from '@kubb/plugin-client'
-
-export type Transformer = (props: { node: ast.OperationNode; casing: 'camelcase' | undefined }) => Array<unknown>
-
-/**
- * Resolver for Vue Query that provides naming methods for hook functions.
- */
-export type ResolverVueQuery = Resolver & {
-  /**
-   * Resolves the base function name for an operation.
-   */
-  resolveName(this: ResolverVueQuery, name: string): string
-  /**
-   * Resolves the output file name for a hook module.
-   */
-  resolvePathName(this: ResolverVueQuery, name: string, type?: 'file' | 'function' | 'type' | 'const'): string
-  /**
-   * Resolves a query hook function name.
-   */
-  resolveQueryName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves an infinite query hook function name.
-   */
-  resolveInfiniteQueryName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves a mutation hook function name.
-   */
-  resolveMutationName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the query options helper name.
-   */
-  resolveQueryOptionsName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the infinite query options helper name.
-   */
-  resolveInfiniteQueryOptionsName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the query key helper name.
-   */
-  resolveQueryKeyName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the infinite query key helper name.
-   */
-  resolveInfiniteQueryKeyName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the mutation key helper name.
-   */
-  resolveMutationKeyName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the query key type name.
-   */
-  resolveQueryKeyTypeName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the infinite query key type name.
-   */
-  resolveInfiniteQueryKeyTypeName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the mutation type name.
-   */
-  resolveMutationTypeName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the client function name generated inline by query hooks.
-   */
-  resolveClientName(this: ResolverVueQuery, node: ast.OperationNode): string
-  /**
-   * Resolves the client function name generated inline by infinite query hooks.
-   */
-  resolveInfiniteClientName(this: ResolverVueQuery, node: ast.OperationNode): string
-}
-
-/**
- * Builds the `queryKey` used by each generated query composable.
- *
- * @note String values are inlined verbatim into generated code. Wrap literal
- * strings in `JSON.stringify(...)`.
- */
-type QueryKey = Transformer
-
-/**
- * Builds the `mutationKey` used by each generated mutation composable.
- *
- * @note String values are inlined verbatim into generated code. Wrap literal
- * strings in `JSON.stringify(...)`.
- */
-type MutationKey = Transformer
-
-type Query = {
-  /**
-   * HTTP methods treated as queries.
-   *
-   * @default ['get']
-   */
-  methods?: Array<string>
-  /**
-   * Module specifier used in the `import { useQuery } from '...'` statement at
-   * the top of every generated composable file.
-   *
-   * @default '@tanstack/vue-query'
-   */
-  importPath?: string
-}
-
-type Mutation = {
-  /**
-   * HTTP methods treated as mutations.
-   *
-   * @default ['post', 'put', 'delete']
-   */
-  methods?: Array<string>
-  /**
-   * Module specifier used in the `import { useMutation } from '...'` statement
-   * at the top of every generated composable file.
-   *
-   * @default '@tanstack/vue-query'
-   */
-  importPath?: string
-}
-
-export type Infinite = {
-  /**
-   * Name of the query parameter that holds the page cursor.
-   *
-   * @default 'id'
-   */
-  queryParam?: string
-  /**
-   * Path to the cursor field on the response. Leave undefined when the cursor
-   * is not known.
-   *
-   * @deprecated Use `nextParam` and `previousParam` for richer pagination control.
-   */
-  cursorParam?: string | null
-  /**
-   * Path to the next-page cursor on the response. Supports dot notation
-   * (`'pagination.next.id'`) or array form.
-   */
-  nextParam?: string | Array<string> | null
-  /**
-   * Path to the previous-page cursor on the response. Supports dot notation
-   * or array form.
-   */
-  previousParam?: string | Array<string> | null
-  /**
-   * Initial value for `pageParam` on the first fetch.
-   *
-   * @default 0
-   */
-  initialPageParam?: unknown
-}
-
-/**
- * Where the generated composables are written and how they are exported, plus the optional
- * `group` strategy. The `group` option organizes `output.mode: 'directory'` output into per-tag or per-path subdirectories.
- *
- * @default { path: 'hooks', barrel: { type: 'named' } }
- */
-export type Options = OutputOptions & {
-  /**
-   * HTTP client used inside every generated composable. Mirrors a subset of
-   * `pluginClient` options.
-   */
-  client?: ClientImportPath & Pick<PluginClient['options'], 'clientType' | 'dataReturnType' | 'baseURL' | 'bundle' | 'paramsCasing'>
-  /**
-   * Skip operations matching at least one entry in the list.
-   */
-  exclude?: Array<Exclude>
-  /**
-   * Restrict generation to operations matching at least one entry in the list.
-   */
-  include?: Array<Include>
-  /**
-   * Apply a different options object to operations matching a pattern.
-   */
-  override?: Array<Override<ResolvedOptions>>
-  /**
-   * Rename parameter properties in the generated composables.
-   *
-   * @note Must match the value of `paramsCasing` on `@kubb/plugin-ts`.
-   */
-  paramsCasing?: 'camelcase'
-  /**
-   * How operation parameters appear in the generated composable signature.
-   *
-   * @default 'inline'
-   */
-  paramsType?: 'object' | 'inline'
-  /**
-   * How URL path parameters are arranged inside the inline argument list.
-   *
-   * @default 'inline'
-   */
-  pathParamsType?: PluginClient['options']['pathParamsType']
-  /**
-   * Enables `useInfiniteQuery` composables for cursor- or page-based pagination.
-   * Pass an object to configure how the cursor is read; pass `false` to skip.
-   *
-   * @default false
-   */
-  infinite?: Partial<Infinite> | false
-  /**
-   * Custom `queryKey` builder.
-   */
-  queryKey?: QueryKey
-  /**
-   * Configures query composables. Set to `false` to skip composable generation
-   * and emit only `queryOptions(...)` helpers.
-   */
-  query?: Partial<Query> | false
-  /**
-   * Custom `mutationKey` builder.
-   */
-  mutationKey?: MutationKey
-  /**
-   * Configures mutation composables. Set to `false` to skip mutation generation.
-   */
-  mutation?: Partial<Mutation> | false
-  /**
-   * Validator applied to response bodies before they reach the caller.
-   * - `'client'` — no validation.
-   * - `'zod'` — pipes responses through schemas from `@kubb/plugin-zod`.
-   */
-  parser?: PluginClient['options']['parser']
-  /**
-   * Override how composable names and file paths are built.
-   */
-  resolver?: Partial<ResolverVueQuery> & ThisType<ResolverVueQuery>
-  /**
-   * AST visitor applied to each operation node before printing.
-   */
-  transformer?: ast.Visitor
-  /**
-   * Custom generators that run alongside the built-in Vue Query generators.
-   */
-  generators?: Array<Generator<PluginVueQuery>>
-}
-
-type ResolvedOptions = {
-  output: Output
-  group: Group | null
-  exclude: NonNullable<Options['exclude']>
-  include: Options['include']
-  override: NonNullable<Options['override']>
-  client: Pick<PluginClient['options'], 'client' | 'clientType' | 'dataReturnType' | 'importPath' | 'baseURL' | 'bundle' | 'paramsCasing'>
-  parser: NonNullable<Options['parser']>
-  pathParamsType: NonNullable<Options['pathParamsType']>
-  paramsCasing: Options['paramsCasing']
-  paramsType: NonNullable<Options['paramsType']>
-  /**
-   * Only used for infinite
-   */
-  infinite: NonNullable<Infinite> | false
-  queryKey: QueryKey | null
-  query: NonNullable<Required<Query>> | false
-  mutationKey: MutationKey | null
-  mutation: NonNullable<Required<Mutation>> | false
-  resolver: ResolverVueQuery
-}
-
-export type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, ResolverVueQuery>
-
-declare global {
-  namespace Kubb {
-    interface PluginRegistry {
-      'plugin-vue-query': PluginVueQuery
-    }
-  }
-}

package/src/utils.ts

@@ -1,57 +0,0 @@
-export {
-  buildGroupParam,
-  buildQueryKeyParams,
-  resolveHeaderGroupType,
-  resolveOperationOverrides,
-  resolvePathParamType,
-  resolveQueryGroupType,
-  resolveZodSchemaNames,
-} from '@internals/tanstack-query'
-export {
-  buildOperationComments as getComments,
-  buildRequestConfigType,
-  buildStatusUnionType,
-  getContentTypeInfo,
-  resolveErrorNames,
-  resolveStatusCodeNames,
-  resolveSuccessNames,
-} from '@internals/shared'
-
-import { ast } from '@kubb/core'
-
-export function printType(typeNode: ast.ParamsTypeNode | undefined): string {
-  if (!typeNode) return 'unknown'
-  if (typeNode.variant === 'reference') return typeNode.name
-  if (typeNode.variant === 'member') return `${typeNode.base}['${typeNode.key}']`
-  if (typeNode.variant === 'struct') {
-    const parts = typeNode.properties.map((p) => {
-      const typeStr = printType(p.type)
-      const key = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(p.name) ? p.name : JSON.stringify(p.name)
-      return p.optional ? `${key}?: ${typeStr}` : `${key}: ${typeStr}`
-    })
-    return `{ ${parts.join('; ')} }`
-  }
-  return 'unknown'
-}
-
-export function wrapWithMaybeRefOrGetter(paramsNode: ast.FunctionParametersNode, skip?: (name: string) => boolean): ast.FunctionParametersNode {
-  const wrappedParams = paramsNode.params.map((param) => {
-    if ('kind' in param && (param as ast.ParameterGroupNode).kind === 'ParameterGroup') {
-      const group = param as ast.ParameterGroupNode
-      return {
-        ...group,
-        properties: group.properties.map((p) => ({
-          ...p,
-          type: p.type ? ast.createParamsType({ variant: 'reference', name: `MaybeRefOrGetter<${printType(p.type)}>` }) : p.type,
-        })),
-      }
-    }
-    const fp = param as ast.FunctionParameterNode
-    if (skip?.(fp.name)) return fp
-    return {
-      ...fp,
-      type: fp.type ? ast.createParamsType({ variant: 'reference', name: `MaybeRefOrGetter<${printType(fp.type)}>` }) : fp.type,
-    }
-  })
-  return ast.createFunctionParameters({ params: wrappedParams })
-}