@kubb/plugin-client 5.0.0-beta.42 → 5.0.0-beta.64

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./chunk-C0LytTxp.js";
-import { Exclude, Generator, Group, Include, Output, Override, PluginFactoryOptions, Resolver, ast } from "@kubb/core";
+import { Exclude, Generator, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ast } from "@kubb/core";
 import { ResolverTs } from "@kubb/plugin-ts";
 import { ResolverZod } from "@kubb/plugin-zod";
 import { KubbReactNode } from "@kubb/renderer-jsx/types";
@@ -26,7 +26,12 @@ type ResolverClient = Resolver & {
    */
   resolveClassName(this: ResolverClient, name: string): string;
   /**
-   * Resolves the generated class name for tag-based client groups.
+   * Resolves the generated class name for tag-based client groups. 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 Resolving tag-group class names
+   * `resolver.resolveGroupName('pet') // -> 'PetClient'`
    */
   resolveGroupName(this: ResolverClient, name: string): string;
   /**
@@ -110,17 +115,13 @@ type ParamsTypeOptions = {
    */
   pathParamsType?: 'object' | 'inline';
 };
-type Options = {
-  /**
-   * Where the generated client files are written and how they are exported.
-   *
-   * @default { path: 'clients', barrel: { type: 'named' } }
-   */
-  output?: Output;
-  /**
-   * Split generated files into subfolders based on the operation's tag.
-   */
-  group?: Group;
+/**
+ * Where the generated client files 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: 'clients', barrel: { type: 'named' } }
+ */
+type Options = OutputOptions & {
   /**
    * Skip operations matching at least one entry in the list.
    */
@@ -155,7 +156,9 @@ type Options = {
   /**
    * Shape of the value returned by each generated client function.
    * - `'data'` — only the response body.
-   * - `'full'` — the full response config (body, status, headers, request).
+   * - `'full'` — the full response as a discriminated union keyed by HTTP status code.
+   *   Each member is `{ status: N; data: StatusNType; statusText: string }`,
+   *   so narrowing on `res.status` also narrows `res.data` to the matching response type.
    *
    * @default 'data'
    */
@@ -168,14 +171,22 @@ type Options = {
    */
   paramsCasing?: 'camelcase';
   /**
-   * Validator applied to response bodies before they are returned to the caller.
-   * - `false` (default) — no validation. The client has no runtime parser; the response is
-   *   returned as-is, cast to the generated TypeScript type.
-   * - `'zod'` — pipes responses through schemas from `@kubb/plugin-zod`.
+   * Validator applied to request and response bodies using schemas from `@kubb/plugin-zod`.
+   * - `false` (default): no validation. The response is returned as-is.
+   * - `'zod'`: validates response bodies only (backward-compatible shorthand).
+   * - `{ request?: 'zod'; response?: 'zod' }`: opt in per direction. `request` validates the
+   *   request body and query parameters before the call. `response` validates the response body.
    *
    * @default false
+   * @example Response only (shorthand)
+   * `parser: 'zod'`
+   * @example Both directions
+   * `parser: { request: 'zod', response: 'zod' }`
    */
-  parser?: false | 'zod';
+  parser?: false | 'zod' | {
+    request?: 'zod';
+    response?: 'zod';
+  };
   /**
    * Shape of the generated client.
    * - `'function'` — one standalone async function per operation.
@@ -204,8 +215,8 @@ type Options = {
    *   sdk: { className: 'PetStoreSDK' },
    * })
    * // class PetStoreSDK {
-   * //   readonly petController: petController
-   * //   readonly storeController: storeController
+   * //   readonly petClient: PetClient
+   * //   readonly storeClient: StoreClient
    * //   constructor(config = {}) { ... }
    * // }
    * ```
@@ -223,10 +234,10 @@ type Options = {
    */
   resolver?: Partial<ResolverClient> & ThisType<ResolverClient>;
   /**
-   * AST visitor applied to each operation node before code is printed.
-   * Return `null` or `undefined` to leave the node unchanged.
+   * Macros applied to each operation node before code is printed.
+   * Return `null` or `undefined` from a callback to leave the node unchanged.
    */
-  transformer?: ast.Visitor;
+  macros?: Array<ast.Macro>;
   /**
    * Custom generators that run alongside the built-in client generators.
    */
@@ -387,10 +398,34 @@ declare const pluginClient: (options?: Options | undefined) => import("@kubb/cor
  *
  * resolverClient.default('list pets', 'function') // 'listPets'
  * resolverClient.resolveClassName('pet')          // 'Pet'
+ * resolverClient.resolveGroupName('pet')          // 'PetClient'
  * resolverClient.resolveUrlName(operationNode)    // 'getShowPetByIdUrl'
  * ```
  */
 declare const resolverClient: ResolverClient;
 //#endregion
-export { Client, type ClientImportPath, type PluginClient, type ResolverClient, classClientGenerator, clientGenerator, pluginClient as default, pluginClient, groupedClientGenerator, operationsGenerator, pluginClientName, resolverClient, staticClassClientGenerator };
+//#region src/utils.d.ts
+type ParserOption = PluginClient['resolvedOptions']['parser'];
+/**
+ * Returns `true` when any direction of the parser uses Zod (used for dependency checks).
+ */
+declare function isParserEnabled(parser: ParserOption | undefined | false): boolean;
+/**
+ * Returns `'zod'` when request body parsing is enabled, `null` otherwise.
+ * The string shorthand `'zod'` also enables request body parsing (existing behavior).
+ */
+declare function resolveRequestParser(parser: ParserOption | undefined | false): 'zod' | null;
+/**
+ * Returns `'zod'` when query-parameters parsing is enabled, `null` otherwise.
+ * Only the object form `{ request: 'zod' }` enables query-params parsing.
+ * The string shorthand `'zod'` does not, preserving its existing behavior.
+ */
+declare function resolveQueryParamsParser(parser: ParserOption | undefined | false): 'zod' | null;
+/**
+ * Returns `'zod'` when response-direction parsing is enabled, `null` otherwise.
+ * `parser: 'zod'` (string shorthand) maps to response parsing and returns `'zod'`.
+ */
+declare function resolveResponseParser(parser: ParserOption | undefined | false): 'zod' | null;
+//#endregion
+export { Client, type ClientImportPath, type PluginClient, type ResolverClient, classClientGenerator, clientGenerator, pluginClient as default, pluginClient, groupedClientGenerator, isParserEnabled, operationsGenerator, pluginClientName, resolveQueryParamsParser, resolveRequestParser, resolveResponseParser, resolverClient, staticClassClientGenerator };
 //# sourceMappingURL=index.d.ts.map