@kubb/plugin-fetch 5.14.0-canary.20261109T125041 → 6.0.0

package/dist/index.d.cts

@@ -1,240 +1,11 @@
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "@kubb/kit";
-import "@kubb/plugin-zod";
-import { ResolverTs } from "@kubb/plugin-ts";
-/**
- * Validator applied to the request and response using schemas from `@kubb/plugin-zod`.
- * - `false`: no validation.
- * - `'zod'`: validates the success (2xx) response body, and the error body when a non-2xx call does
- *   not throw (`throwOnError: false`).
- * - `{ request?: 'zod'; params?: 'zod'; response?: 'zod' }`: opt in per slot. `request` encodes the
- *   request body before the call; `params` validate the path, query, and header params;
- *   `response` validates the success response body and, on the non-throw path, the error body.
- */
-type ValidatorOptions = false | 'zod' | {
-  request?: 'zod';
-  params?: 'zod';
-  response?: 'zod';
-};
-/**
- * How the class-based SDK groups operations.
- * - `'tag'`: one class per tag, optionally composed into a root client.
- * - `'flat'`: one class with every operation as a direct method.
- */
-type Mode = 'tag' | 'flat';
-/**
- * Shape of the value a generated operation function resolves to.
- * - `'full'`: the complete `{ status, data, error, contentType, request, response }` result.
- * - `'data'`: the bare success body when `throwOnError` is true, or the full result when it is false
- *   so callers can inspect `error`.
- * - `'plain'`: the client's own promise typed as `RequestResult`, with no `withUnwrap` / `unwrapResult`
- *   helper. Backs `@kubb/plugin-client`.
- */
-type ReturnTypeOption = 'full' | 'data' | 'plain';
-/**
- * The resolver shared by the client plugins. Inherits the built-in camelCase `name` and `file`;
- * classes and tag groups use PascalCase (with a `Client` suffix for groups).
- */
-type ResolverClient = Resolver & {
-  /**
-   * Resolves the generated class name for class-based clients.
-   */
-  className(this: ResolverClient, name: string): string;
-  /**
-   * Resolves the generated class name for a tag-based client group. The default appends a
-   * `Client` suffix (tag `pet` becomes `PetClient`) so the class never collides with the schema
-   * model of the same name in the barrel.
-   *
-   * @example
-   * `resolver.groupName('pet') // -> 'PetClient'`
-   */
-  groupName(this: ResolverClient, name: string): string;
-  /**
-   * Resolves the property name a tag client is exposed under on the composed root SDK
-   * (`new PetStore(config).pet`).
-   */
-  propertyName(this: ResolverClient, name: string): string;
-};
-/**
- * The shared options surface for the client plugins. Deliberately small: there is one
- * response contract and one grouped options object. Each plugin extends this with its own
- * `transport` field.
- */
-type Options = OutputOptions & {
-  /**
-   * 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<Omit<ResolvedOptions, 'throwOnErrorDefault'>>>;
-  /**
-   * Base URL prepended to every request. When omitted, the generated client sets no base URL, so
-   * set one at runtime with `client.setConfig({ baseURL })`. The adapter's server URL is not used.
-   * Values containing a `${...}` interpolation are emitted as template literals in the generated
-   * client config, which keeps runtime environment reads dynamic.
-   */
-  baseURL?: string;
-  /**
-   * Default error behavior for generated operations and their client. Per-call `throwOnError`
-   * takes precedence.
-   *
-   * @default true
-   */
-  throwOnErrorDefault?: boolean;
-  /**
-   * Validate the request body, the request params, and the response with schemas from `@kubb/plugin-zod`.
-   *
-   * @default false
-   */
-  validator?: ValidatorOptions;
-  /**
-   * Shape of the value a generated operation function resolves to. Applies to the standalone
-   * functions and the class-based SDK; not to the query-hook plugins (`@kubb/plugin-react-query`,
-   * `@kubb/plugin-vue-query`, `@kubb/plugin-swr`), which keep calling the client directly and
-   * expect the full result.
-   *
-   * @default 'full'
-   * @example
-   * ```ts
-   * pluginAxios({ returnType: 'data' })
-   * // const pet = await getPetById({ path: { petId: 1 } }) // Pet, not { status, data, ... }
-   * ```
-   */
-  returnType?: ReturnTypeOption;
-  /**
-   * Generates a class-based SDK instead of the standalone functions. Each tag client is an instance
-   * class whose constructor takes a client config and builds its own client, so every environment is
-   * a separate instance. Leave `sdk` unset to keep the standalone per-operation functions (the
-   * default), which is also what query plugins consume.
-   *
-   * @example Instance class per tag
-   * ```ts
-   * pluginFetch({ sdk: {} })
-   * // const api = new PetClient({ baseURL: 'https://api.example.com' })
-   * // await api.getPetById({ path: { petId: 1 } })
-   * ```
-   * @example Composed root that instantiates every tag client from one config
-   * ```ts
-   * pluginFetch({ sdk: { name: 'petStore' } })
-   * // class PetStore {
-   * //   readonly pet: PetClient
-   * //   readonly store: StoreClient
-   * //   constructor(config = {}) { ... }
-   * // }
-   * // const api = new PetStore({ baseURL })
-   * // await api.pet.getPetById({ path: { petId: 1 } })
-   * ```
-   * @example Flat class with every operation as a direct method
-   * ```ts
-   * pluginFetch({ sdk: { name: 'petStore', mode: 'flat' } })
-   * // const api = new PetStore({ baseURL })
-   * // await api.getPetById({ path: { petId: 1 } })
-   * ```
-   */
-  sdk?: {
-    /**
-     * How the SDK groups operations.
-     * - `'tag'`: one class per tag. With `name`, a composed root instantiates every tag client.
-     * - `'flat'`: one class named by `name`, with every operation as a direct method.
-     *
-     * @default 'tag'
-     */
-    mode?: Mode;
-    /**
-     * Name of the generated entry point, also the file name. With `mode: 'tag'` it emits a
-     * composed root class that instantiates every tag client from one shared config. With
-     * `mode: 'flat'` it names the single class.
-     */
-    name?: string;
-  };
-  /**
-   * Override how names and file paths are built. Methods you omit fall back to the default resolver.
-   */
-  resolver?: ResolverPatch<ResolverClient>;
-  /**
-   * Macros applied to each operation node before code is printed.
-   */
-  macros?: Array<ast.Macro>;
-};
-/**
- * The resolved options after defaults are applied.
- */
-type ResolvedOptions = {
-  output: Output;
-  exclude: Array<Exclude>;
-  include: Array<Include> | undefined;
-  override: Array<Override<Omit<ResolvedOptions, 'throwOnErrorDefault'>>>;
-  group: Group | null;
-  baseURL: Options['baseURL'];
-  /**
-   * Module the generated operations import the client runtime from, used verbatim. Unset, they import the bundled `.kubb/client.ts`.
-   */
-  importPath?: string;
-  throwOnErrorDefault: boolean;
-  validator: NonNullable<Options['validator']>;
-  returnType: ReturnTypeOption;
-  sdk: {
-    mode: Mode;
-    name: string | undefined;
-  } | undefined;
-  resolver: ResolverClient;
-};
-/**
- * The two per-operation type names a generated client references: the grouped input and the
- * per-status responses record its `RequestResult` is keyed on.
- */
-type OperationTypeNames = {
-  response: {
-    /**
-     * Resolves the name of the operation's grouped `{ body, path, query, headers }` input type.
-     */
-    options(node: ast.OperationNode): string;
-    /**
-     * Resolves the name of the operation's per-status responses record type.
-     */
-    responses(node: ast.OperationNode): string;
-  };
-};
-/**
- * Where a generated client sources its operation types, plus the resolver and output the file
- * declaring them is resolved with.
- */
-type OperationTypeSource = OperationTypeNames & {
-  /**
-   * `plugin-ts` shaped resolver of the plugin supplying the names, also used to resolve the file they are exported from.
-   */
-  resolver: ResolverTs;
-  /**
-   * The supplying plugin's own `output`, when it configured one.
-   */
-  output: Output | undefined;
-  /**
-   * The supplying plugin's own `group`, when it configured one.
-   */
-  group: Group | undefined;
-};
-declare global {
-  namespace Kubb {
-    interface MemoRegistry {
-      operationTypes: OperationTypeSource;
-      /**
-       * Nests every key the zod-backed `ResolverTs` memoizes, so it holds each of their value types.
-       */
-      zodTypes: unknown;
-    }
-  }
-}
+import { PluginType } from "@kubb/kit";
+import { ClientOptions, ClientOptions as Options, ClientResolvedOptions, ClientResolvedOptions as ResolvedOptions, ResolverClient, ResolverClient as ResolverClient$1 } from "@kubb/plugin-client";
 /**
  * The plugin factory type for `@kubb/plugin-fetch`. Shares the options surface, resolver, and
  * resolved-options shape with the other client plugins; only the plugin name and transport
  * differ.
  */
-type PluginFetch = PluginType<'plugin-fetch', Options, ResolvedOptions, ResolverClient>;
+type PluginFetch = PluginType<'plugin-fetch', ClientOptions, ClientResolvedOptions, ResolverClient$1>;
 declare global {
   namespace Kubb {
     interface PluginRegistry {
@@ -242,12 +13,6 @@ declare global {
     }
   }
 }
-/**
- * Built-in operation generator for `@kubb/plugin-fetch`. Emits one async function per OpenAPI
- * operation using the shared `Operation` component: a grouped `<Name>Request` type and a function
- * that forwards a single `options` object to the bundled `client` and returns the `RequestResult`.
- */
-export declare const clientGenerator: import("@kubb/kit").Generator<PluginFetch>;
 /**
  * Canonical plugin name for `@kubb/plugin-fetch`. Used for driver lookups and cross-plugin
  * dependency references.

package/dist/index.d.ts

@@ -1,240 +1,11 @@
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "@kubb/kit";
-import "@kubb/plugin-zod";
-import { ResolverTs } from "@kubb/plugin-ts";
-/**
- * Validator applied to the request and response using schemas from `@kubb/plugin-zod`.
- * - `false`: no validation.
- * - `'zod'`: validates the success (2xx) response body, and the error body when a non-2xx call does
- *   not throw (`throwOnError: false`).
- * - `{ request?: 'zod'; params?: 'zod'; response?: 'zod' }`: opt in per slot. `request` encodes the
- *   request body before the call; `params` validate the path, query, and header params;
- *   `response` validates the success response body and, on the non-throw path, the error body.
- */
-type ValidatorOptions = false | 'zod' | {
-  request?: 'zod';
-  params?: 'zod';
-  response?: 'zod';
-};
-/**
- * How the class-based SDK groups operations.
- * - `'tag'`: one class per tag, optionally composed into a root client.
- * - `'flat'`: one class with every operation as a direct method.
- */
-type Mode = 'tag' | 'flat';
-/**
- * Shape of the value a generated operation function resolves to.
- * - `'full'`: the complete `{ status, data, error, contentType, request, response }` result.
- * - `'data'`: the bare success body when `throwOnError` is true, or the full result when it is false
- *   so callers can inspect `error`.
- * - `'plain'`: the client's own promise typed as `RequestResult`, with no `withUnwrap` / `unwrapResult`
- *   helper. Backs `@kubb/plugin-client`.
- */
-type ReturnTypeOption = 'full' | 'data' | 'plain';
-/**
- * The resolver shared by the client plugins. Inherits the built-in camelCase `name` and `file`;
- * classes and tag groups use PascalCase (with a `Client` suffix for groups).
- */
-type ResolverClient = Resolver & {
-  /**
-   * Resolves the generated class name for class-based clients.
-   */
-  className(this: ResolverClient, name: string): string;
-  /**
-   * Resolves the generated class name for a tag-based client group. The default appends a
-   * `Client` suffix (tag `pet` becomes `PetClient`) so the class never collides with the schema
-   * model of the same name in the barrel.
-   *
-   * @example
-   * `resolver.groupName('pet') // -> 'PetClient'`
-   */
-  groupName(this: ResolverClient, name: string): string;
-  /**
-   * Resolves the property name a tag client is exposed under on the composed root SDK
-   * (`new PetStore(config).pet`).
-   */
-  propertyName(this: ResolverClient, name: string): string;
-};
-/**
- * The shared options surface for the client plugins. Deliberately small: there is one
- * response contract and one grouped options object. Each plugin extends this with its own
- * `transport` field.
- */
-type Options = OutputOptions & {
-  /**
-   * 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<Omit<ResolvedOptions, 'throwOnErrorDefault'>>>;
-  /**
-   * Base URL prepended to every request. When omitted, the generated client sets no base URL, so
-   * set one at runtime with `client.setConfig({ baseURL })`. The adapter's server URL is not used.
-   * Values containing a `${...}` interpolation are emitted as template literals in the generated
-   * client config, which keeps runtime environment reads dynamic.
-   */
-  baseURL?: string;
-  /**
-   * Default error behavior for generated operations and their client. Per-call `throwOnError`
-   * takes precedence.
-   *
-   * @default true
-   */
-  throwOnErrorDefault?: boolean;
-  /**
-   * Validate the request body, the request params, and the response with schemas from `@kubb/plugin-zod`.
-   *
-   * @default false
-   */
-  validator?: ValidatorOptions;
-  /**
-   * Shape of the value a generated operation function resolves to. Applies to the standalone
-   * functions and the class-based SDK; not to the query-hook plugins (`@kubb/plugin-react-query`,
-   * `@kubb/plugin-vue-query`, `@kubb/plugin-swr`), which keep calling the client directly and
-   * expect the full result.
-   *
-   * @default 'full'
-   * @example
-   * ```ts
-   * pluginAxios({ returnType: 'data' })
-   * // const pet = await getPetById({ path: { petId: 1 } }) // Pet, not { status, data, ... }
-   * ```
-   */
-  returnType?: ReturnTypeOption;
-  /**
-   * Generates a class-based SDK instead of the standalone functions. Each tag client is an instance
-   * class whose constructor takes a client config and builds its own client, so every environment is
-   * a separate instance. Leave `sdk` unset to keep the standalone per-operation functions (the
-   * default), which is also what query plugins consume.
-   *
-   * @example Instance class per tag
-   * ```ts
-   * pluginFetch({ sdk: {} })
-   * // const api = new PetClient({ baseURL: 'https://api.example.com' })
-   * // await api.getPetById({ path: { petId: 1 } })
-   * ```
-   * @example Composed root that instantiates every tag client from one config
-   * ```ts
-   * pluginFetch({ sdk: { name: 'petStore' } })
-   * // class PetStore {
-   * //   readonly pet: PetClient
-   * //   readonly store: StoreClient
-   * //   constructor(config = {}) { ... }
-   * // }
-   * // const api = new PetStore({ baseURL })
-   * // await api.pet.getPetById({ path: { petId: 1 } })
-   * ```
-   * @example Flat class with every operation as a direct method
-   * ```ts
-   * pluginFetch({ sdk: { name: 'petStore', mode: 'flat' } })
-   * // const api = new PetStore({ baseURL })
-   * // await api.getPetById({ path: { petId: 1 } })
-   * ```
-   */
-  sdk?: {
-    /**
-     * How the SDK groups operations.
-     * - `'tag'`: one class per tag. With `name`, a composed root instantiates every tag client.
-     * - `'flat'`: one class named by `name`, with every operation as a direct method.
-     *
-     * @default 'tag'
-     */
-    mode?: Mode;
-    /**
-     * Name of the generated entry point, also the file name. With `mode: 'tag'` it emits a
-     * composed root class that instantiates every tag client from one shared config. With
-     * `mode: 'flat'` it names the single class.
-     */
-    name?: string;
-  };
-  /**
-   * Override how names and file paths are built. Methods you omit fall back to the default resolver.
-   */
-  resolver?: ResolverPatch<ResolverClient>;
-  /**
-   * Macros applied to each operation node before code is printed.
-   */
-  macros?: Array<ast.Macro>;
-};
-/**
- * The resolved options after defaults are applied.
- */
-type ResolvedOptions = {
-  output: Output;
-  exclude: Array<Exclude>;
-  include: Array<Include> | undefined;
-  override: Array<Override<Omit<ResolvedOptions, 'throwOnErrorDefault'>>>;
-  group: Group | null;
-  baseURL: Options['baseURL'];
-  /**
-   * Module the generated operations import the client runtime from, used verbatim. Unset, they import the bundled `.kubb/client.ts`.
-   */
-  importPath?: string;
-  throwOnErrorDefault: boolean;
-  validator: NonNullable<Options['validator']>;
-  returnType: ReturnTypeOption;
-  sdk: {
-    mode: Mode;
-    name: string | undefined;
-  } | undefined;
-  resolver: ResolverClient;
-};
-/**
- * The two per-operation type names a generated client references: the grouped input and the
- * per-status responses record its `RequestResult` is keyed on.
- */
-type OperationTypeNames = {
-  response: {
-    /**
-     * Resolves the name of the operation's grouped `{ body, path, query, headers }` input type.
-     */
-    options(node: ast.OperationNode): string;
-    /**
-     * Resolves the name of the operation's per-status responses record type.
-     */
-    responses(node: ast.OperationNode): string;
-  };
-};
-/**
- * Where a generated client sources its operation types, plus the resolver and output the file
- * declaring them is resolved with.
- */
-type OperationTypeSource = OperationTypeNames & {
-  /**
-   * `plugin-ts` shaped resolver of the plugin supplying the names, also used to resolve the file they are exported from.
-   */
-  resolver: ResolverTs;
-  /**
-   * The supplying plugin's own `output`, when it configured one.
-   */
-  output: Output | undefined;
-  /**
-   * The supplying plugin's own `group`, when it configured one.
-   */
-  group: Group | undefined;
-};
-declare global {
-  namespace Kubb {
-    interface MemoRegistry {
-      operationTypes: OperationTypeSource;
-      /**
-       * Nests every key the zod-backed `ResolverTs` memoizes, so it holds each of their value types.
-       */
-      zodTypes: unknown;
-    }
-  }
-}
+import { PluginType } from "@kubb/kit";
+import { ClientOptions, ClientOptions as Options, ClientResolvedOptions, ClientResolvedOptions as ResolvedOptions, ResolverClient, ResolverClient as ResolverClient$1 } from "@kubb/plugin-client";
 /**
  * The plugin factory type for `@kubb/plugin-fetch`. Shares the options surface, resolver, and
  * resolved-options shape with the other client plugins; only the plugin name and transport
  * differ.
  */
-type PluginFetch = PluginType<'plugin-fetch', Options, ResolvedOptions, ResolverClient>;
+type PluginFetch = PluginType<'plugin-fetch', ClientOptions, ClientResolvedOptions, ResolverClient$1>;
 declare global {
   namespace Kubb {
     interface PluginRegistry {
@@ -242,12 +13,6 @@ declare global {
     }
   }
 }
-/**
- * Built-in operation generator for `@kubb/plugin-fetch`. Emits one async function per OpenAPI
- * operation using the shared `Operation` component: a grouped `<Name>Request` type and a function
- * that forwards a single `options` object to the bundled `client` and returns the `RequestResult`.
- */
-export declare const clientGenerator: import("@kubb/kit").Generator<PluginFetch>;
 /**
  * Canonical plugin name for `@kubb/plugin-fetch`. Used for driver lookups and cross-plugin
  * dependency references.