@kubb/plugin-client 5.0.0-alpha.9 → 5.0.0-beta.15

package/src/plugin.ts

@@ -1,189 +1,159 @@
 import path from 'node:path'
 import { camelCase } from '@internals/utils'
-import { createPlugin, type Group, getBarrelFiles, getMode } from '@kubb/core'
-import { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'
+
+import { ast, definePlugin, type Group } from '@kubb/core'
+import { pluginTsName } from '@kubb/plugin-ts'
 import { pluginZodName } from '@kubb/plugin-zod'
-import { classClientGenerator, operationsGenerator } from './generators'
+import { classClientGenerator } from './generators/classClientGenerator.tsx'
 import { clientGenerator } from './generators/clientGenerator.tsx'
 import { groupedClientGenerator } from './generators/groupedClientGenerator.tsx'
+import { operationsGenerator } from './generators/operationsGenerator.tsx'
 import { staticClassClientGenerator } from './generators/staticClassClientGenerator.tsx'
+import { resolverClient } from './resolvers/resolverClient.ts'
 import { source as axiosClientSource } from './templates/clients/axios.source.ts'
 import { source as fetchClientSource } from './templates/clients/fetch.source.ts'
 import { source as configSource } from './templates/config.source.ts'
 import type { PluginClient } from './types.ts'
 
+/**
+ * Canonical plugin name for `@kubb/plugin-client`, used in driver lookups and warnings.
+ */
 export const pluginClientName = 'plugin-client' satisfies PluginClient['name']
 
-export const pluginClient = createPlugin<PluginClient>((options) => {
+/**
+ * Generates type-safe HTTP client functions or classes from an OpenAPI specification.
+ * Creates client APIs by walking operations and delegating to generators.
+ * Writes barrel files based on the configured `barrelType`.
+ *
+ * @example Client generator
+ * ```ts
+ * import pluginClient from '@kubb/plugin-client'
+ * export default defineConfig({
+ *   plugins: [pluginClient({ output: { path: 'clients' } })]
+ * })
+ * ```
+ */
+export const pluginClient = definePlugin<PluginClient>((options) => {
   const {
     output = { path: 'clients', barrelType: 'named' },
     group,
-    urlType = false,
     exclude = [],
     include,
     override = [],
-    transformers = {},
+    urlType = false,
     dataReturnType = 'data',
     paramsType = 'inline',
     pathParamsType = paramsType === 'object' ? 'object' : options.pathParamsType || 'inline',
     operations = false,
-    baseURL,
     paramsCasing,
-    clientType = 'function',
+    clientType = options.sdk ? 'class' : 'function',
     parser = 'client',
     client = 'axios',
     importPath,
-    contentType,
     bundle = false,
-    wrapper,
+    sdk,
+    baseURL,
+    resolver: userResolver,
+    transformer: userTransformer,
   } = options
 
   const resolvedImportPath = importPath ?? (!bundle ? `@kubb/plugin-client/clients/${client}` : undefined)
 
-  const defaultGenerators = [
-    clientType === 'staticClass' ? staticClassClientGenerator : clientType === 'class' ? classClientGenerator : clientGenerator,
-    group && clientType === 'function' ? groupedClientGenerator : undefined,
-    operations ? operationsGenerator : undefined,
-  ].filter((x): x is NonNullable<typeof x> => Boolean(x))
-
-  const generators = options.generators ?? defaultGenerators
-
-  return {
-    name: pluginClientName,
-    options: {
-      client,
-      clientType,
-      bundle,
-      output,
-      group,
-      parser,
-      dataReturnType,
-      importPath: resolvedImportPath,
-      paramsType,
-      paramsCasing,
-      pathParamsType,
-      baseURL,
-      urlType,
-      wrapper,
-    },
-    pre: [pluginOasName, parser === 'zod' ? pluginZodName : undefined].filter(Boolean),
-    resolvePath(baseName, pathMode, options) {
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const mode = pathMode ?? getMode(path.resolve(root, output.path))
-
-      if (mode === 'single') {
-        /**
-         * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend
-         * Other plugins then need to call addOrAppend instead of just add from the fileManager class
-         */
-        return path.resolve(root, output.path)
-      }
-
-      if (group && (options?.group?.path || options?.group?.tag)) {
-        const groupName: Group['name'] = group?.name
+  const selectedGenerators =
+    options.generators ??
+    [
+      clientType === 'staticClass' ? staticClassClientGenerator : clientType === 'class' ? classClientGenerator : clientGenerator,
+      group && clientType === 'function' ? groupedClientGenerator : undefined,
+      operations ? operationsGenerator : undefined,
+    ].filter((x): x is NonNullable<typeof x> => Boolean(x))
+
+  const groupConfig = group
+    ? ({
+        ...group,
+        name: group.name
           ? group.name
-          : (ctx) => {
-              if (group?.type === 'path') {
+          : (ctx: { group: string }) => {
+              if (group.type === 'path') {
                 return `${ctx.group.split('/')[1]}`
               }
               return `${camelCase(ctx.group)}Controller`
-            }
-
-        return path.resolve(
-          root,
-          output.path,
-          groupName({
-            group: group.type === 'path' ? options.group.path! : options.group.tag!,
-          }),
-          baseName,
-        )
-      }
-
-      return path.resolve(root, output.path, baseName)
-    },
-    resolveName(name, type) {
-      const resolvedName = camelCase(name, { isFile: type === 'file' })
-
-      if (type) {
-        return transformers?.name?.(resolvedName, type) || resolvedName
-      }
-
-      return resolvedName
-    },
-    async install() {
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const mode = getMode(path.resolve(root, output.path))
-      const oas = await this.getOas()
-      const baseURL = await this.getBaseURL()
-
-      // pre add bundled fetch
-      if (bundle && !this.plugin.options.importPath) {
-        await this.addFile({
-          baseName: 'fetch.ts',
-          path: path.resolve(root, '.kubb/fetch.ts'),
-          sources: [
-            {
-              name: 'fetch',
-              value: this.plugin.options.client === 'fetch' ? fetchClientSource : axiosClientSource,
-              isExportable: true,
-              isIndexable: true,
             },
-          ],
-          imports: [],
-          exports: [],
-        })
-      }
+      } satisfies Group)
+    : undefined
 
-      await this.addFile({
-        baseName: 'config.ts',
-        path: path.resolve(root, '.kubb/config.ts'),
-        sources: [
-          {
-            name: 'config',
-            value: configSource,
-            isExportable: false,
-            isIndexable: false,
-          },
-        ],
-        imports: [],
-        exports: [],
-      })
-
-      const operationGenerator = new OperationGenerator(
-        baseURL
-          ? {
-              ...this.plugin.options,
-              baseURL,
-            }
-          : this.plugin.options,
-        {
-          fabric: this.fabric,
-          oas,
-          driver: this.driver,
-          events: this.events,
-          plugin: this.plugin,
-          contentType,
+  return {
+    name: pluginClientName,
+    options,
+    dependencies: [pluginTsName, parser === 'zod' ? pluginZodName : undefined].filter((dependency): dependency is string => Boolean(dependency)),
+    hooks: {
+      'kubb:plugin:setup'(ctx) {
+        const resolver = userResolver ? { ...resolverClient, ...userResolver } : resolverClient
+
+        ctx.setOptions({
+          client,
+          clientType,
+          bundle,
+          output,
           exclude,
           include,
           override,
-          mode,
-        },
-      )
-
-      const files = await operationGenerator.build(...generators)
-
-      await this.upsertFile(...files)
-
-      const barrelFiles = await getBarrelFiles(this.fabric.files, {
-        type: output.barrelType ?? 'named',
-        root,
-        output,
-        meta: {
-          pluginName: this.plugin.name,
-        },
-      })
-
-      await this.upsertFile(...barrelFiles)
+          group: groupConfig,
+          parser,
+          dataReturnType,
+          importPath: resolvedImportPath,
+          baseURL,
+          paramsType,
+          paramsCasing,
+          pathParamsType,
+          urlType,
+          sdk,
+          resolver,
+        })
+        ctx.setResolver(resolver)
+        if (userTransformer) {
+          ctx.setTransformer(userTransformer)
+        }
+        for (const gen of selectedGenerators) {
+          ctx.addGenerator(gen)
+        }
+
+        const root = path.resolve(ctx.config.root, ctx.config.output.path)
+
+        const isRelativePath = resolvedImportPath?.startsWith('.')
+
+        if (!isRelativePath) {
+          const isInlineSource = bundle && !resolvedImportPath
+
+          ctx.injectFile({
+            baseName: 'client.ts',
+            path: path.resolve(root, '.kubb/client.ts'),
+            sources: [
+              ast.createSource({
+                name: 'client',
+                nodes: isInlineSource ? [ast.createText(client === 'fetch' ? fetchClientSource : axiosClientSource)] : [],
+                isExportable: true,
+                isIndexable: true,
+              }),
+            ],
+            exports: !isInlineSource && resolvedImportPath ? [ast.createExport({ path: resolvedImportPath })] : [],
+          })
+        }
+
+        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 pluginClient

package/src/resolvers/resolverClient.ts

@@ -0,0 +1,38 @@
+import { camelCase, pascalCase } from '@internals/utils'
+import { defineResolver } from '@kubb/core'
+import type { PluginClient } from '../types.ts'
+
+/**
+ * Naming convention resolver for client plugin.
+ *
+ * Provides default naming helpers using camelCase for functions and file paths.
+ *
+ * @example
+ * `resolverClient.default('list pets', 'function')  // → 'listPets'`
+ */
+export const resolverClient = defineResolver<PluginClient>(() => ({
+  name: 'default',
+  pluginName: 'plugin-client',
+  default(name, type) {
+    return camelCase(name, { isFile: type === 'file' })
+  },
+  resolveName(name) {
+    return this.default(name, 'function')
+  },
+  resolvePathName(name, type) {
+    return this.default(name, type)
+  },
+  resolveClassName(name) {
+    return pascalCase(name)
+  },
+  resolveGroupName(name) {
+    return pascalCase(name)
+  },
+  resolveClientPropertyName(name) {
+    return camelCase(name)
+  },
+  resolveUrlName(node) {
+    const name = this.resolveName(node.operationId)
+    return `get${name.charAt(0).toUpperCase()}${name.slice(1)}Url`
+  },
+}))

package/src/types.ts

@@ -1,8 +1,41 @@
-import type { Group, Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+import type { ast, Exclude, Generator, Group, Include, Output, Override, PluginFactoryOptions, Resolver } from '@kubb/core'
 
-import type { contentType, Oas } from '@kubb/oas'
-import type { Exclude, Include, Override, ResolvePathOptions } from '@kubb/plugin-oas'
-import type { Generator } from '@kubb/plugin-oas/generators'
+/**
+ * The concrete resolver type for `@kubb/plugin-client`.
+ * Extends the base `Resolver` with a `resolveName` helper for client function names.
+ */
+export type ResolverClient = Resolver & {
+  /**
+   * Resolves the function name for a given raw operation name.
+   *
+   * @example Resolving operation names
+   * `resolver.resolveName('show pet by id') // -> 'showPetById'`
+   */
+  resolveName(this: ResolverClient, name: string): string
+  /**
+   * Resolves the output file name for a client module.
+   */
+  resolvePathName(this: ResolverClient, name: string, type?: 'file' | 'function' | 'type' | 'const'): string
+  /**
+   * Resolves the generated class name for class-based clients.
+   */
+  resolveClassName(this: ResolverClient, name: string): string
+  /**
+   * Resolves the generated class name for tag-based client groups.
+   */
+  resolveGroupName(this: ResolverClient, name: string): string
+  /**
+   * Resolves the generated SDK facade property name for a client class.
+   */
+  resolveClientPropertyName(this: ResolverClient, name: string): string
+  /**
+   * Resolves the URL helper function name for an operation.
+   *
+   * @example Resolving URL helper names
+   * `resolver.resolveUrlName(node) // -> 'getShowPetByIdUrl'`
+   */
+  resolveUrlName(this: ResolverClient, node: ast.OperationNode): string
+}
 
 /**
  * Use either a preset `client` type OR a custom `importPath`, not both.
@@ -36,17 +69,52 @@ export type ClientImportPath =
       bundle?: never
     }
 
+/**
+ * Discriminated union that ties `pathParamsType` to the `paramsType` values where it is meaningful.
+ *
+ * - `paramsType: 'object'` — all parameters (including path params) are merged into a single
+ *   destructured object. `pathParamsType` is never reached in this code path and has no effect.
+ * - `paramsType?: 'inline'` (or omitted) — each parameter group is a separate function argument.
+ *   `pathParamsType` controls whether the path-param group itself is destructured (`'object'`)
+ *   or spread as individual arguments (`'inline'`).
+ */
+type ParamsTypeOptions =
+  | {
+      /**
+       * All parameters — path, query, headers, and body — are merged into a single
+       * destructured object argument.
+       * - 'object' returns the params and pathParams as an object.
+       * @default 'inline'
+       */
+      paramsType: 'object'
+      /**
+       * `pathParamsType` has no effect when `paramsType` is `'object'`.
+       * Path params are already inside the single destructured object.
+       */
+      pathParamsType?: never
+    }
+  | {
+      /**
+       * Each parameter group is emitted as a separate function argument.
+       * - 'inline' returns the params as comma separated params.
+       * @default 'inline'
+       */
+      paramsType?: 'inline'
+      /**
+       * Controls how path parameters are arranged within the inline argument list.
+       * - 'object' groups path params into a destructured object: `{ petId }: PathParams`.
+       * - 'inline' emits each path param as its own argument: `petId: string`.
+       * @default 'inline'
+       */
+      pathParamsType?: 'object' | 'inline'
+    }
+
 export type Options = {
   /**
-   * Specify the export location for the files and define the behavior of the output
+   * Specify the export location for the files and define the behavior of the output.
    * @default { path: 'clients', barrelType: 'named' }
    */
-  output?: Output<Oas>
-  /**
-   * Define which contentType should be used.
-   * By default, the first JSON valid mediaType is used
-   */
-  contentType?: contentType
+  output?: Output
   /**
    * Group the clients based on the provided name.
    */
@@ -88,25 +156,11 @@ export type Options = {
    */
   dataReturnType?: 'data' | 'full'
   /**
-   * How to style your params, by default no casing is applied
+   * How to style your params, by default no casing is applied.
    * - 'camelcase' uses camelCase for pathParams, queryParams and headerParams names
    * @note response types (data/body) are not affected by this option
    */
   paramsCasing?: 'camelcase'
-  /**
-   * How to pass your params.
-   * - 'object' returns the params and pathParams as an object.
-   * - 'inline' returns the params as comma separated params.
-   * @default 'inline'
-   */
-  paramsType?: 'object' | 'inline'
-  /**
-   * How to pass your pathParams.
-   * - 'object' returns the pathParams as an object.
-   * - 'inline' returns the pathParams as comma separated params.
-   * @default 'inline'
-   */
-  pathParamsType?: 'object' | 'inline'
   /**
    * Which parser can be used before returning the data.
    * - 'client' returns the data as-is from the client.
@@ -130,41 +184,71 @@ export type Options = {
    */
   bundle?: boolean
   /**
-   * Generate a wrapper class that composes all tag-based client classes into a single entry point.
-   */
-  wrapper?: {
+   * Generate an SDK facade class that composes all tag-based client classes into a single entry point.
+   * Setting this option automatically enables `clientType: 'class'`.
+   * @example
+   * ```ts
+   * pluginClient({
+   *   sdk: { className: 'PetStoreSDK' },
+   * })
+   * // Generates a class with a shared constructor config and one property per tag:
+   * // class PetStoreSDK {
+   * //   readonly petController: petController
+   * //   readonly storeController: storeController
+   * //   constructor(config = {}) { ... }
+   * // }
+   * ```
+   */
+  sdk?: {
     /**
-     * Name of the wrapper class.
+     * Name of the generated SDK facade class.
      */
     className: string
   }
-  transformers?: {
-    /**
-     * Customize the names based on the type that is provided by the plugin.
-     */
-    name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
-  }
   /**
-   * Define some generators next to the client generators
+   * Override individual resolver methods. Any method you omit falls back to the
+   * preset resolver's implementation. Use `this.default(...)` to call it.
+   */
+  resolver?: Partial<ResolverClient> & ThisType<ResolverClient>
+  /**
+   * Single AST visitor applied to each node before printing.
+   * Return `null` or `undefined` from a method to leave the node unchanged.
+   */
+  transformer?: ast.Visitor
+  /**
+   * Define some generators next to the client generators.
    */
   generators?: Array<Generator<PluginClient>>
-} & ClientImportPath
+} & ClientImportPath &
+  ParamsTypeOptions
 
 type ResolvedOptions = {
-  output: Output<Oas>
-  group?: Options['group']
-  baseURL: string | undefined
+  output: Output
+  exclude: Array<Exclude>
+  include: Array<Include> | undefined
+  override: Array<Override<ResolvedOptions>>
+  group: Group | undefined
   client: Options['client']
   clientType: NonNullable<Options['clientType']>
   bundle: NonNullable<Options['bundle']>
   parser: NonNullable<Options['parser']>
   urlType: NonNullable<Options['urlType']>
   importPath: Options['importPath']
+  baseURL: Options['baseURL']
   dataReturnType: NonNullable<Options['dataReturnType']>
-  pathParamsType: NonNullable<Options['pathParamsType']>
+  pathParamsType: NonNullable<NonNullable<Options['pathParamsType']>>
   paramsType: NonNullable<Options['paramsType']>
   paramsCasing: Options['paramsCasing']
-  wrapper: Options['wrapper']
+  sdk: Options['sdk']
+  resolver: ResolverClient
 }
 
-export type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>
+export type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, ResolverClient>
+
+declare global {
+  namespace Kubb {
+    interface PluginRegistry {
+      'plugin-client': PluginClient
+    }
+  }
+}