@kubb/plugin-client 5.12.0-canary.20261109T125041 → 5.12.0

package/docs/options.md

@@ -11,6 +11,7 @@ Pass these options to `pluginClient()`. Shared options link to [Shared plugin op
 | [`group`](https://kubb.dev/docs/5.x/reference/plugin-options#group)       | Split output by tag or path: `type`, `name`.                           | None                                             |
 | [`throwOnErrorDefault`](#throwonerrordefault)                             | Default `throwOnError` value passed to your client.                    | `true`                                           |
 | [`validator`](#validator)                                                 | Pass Zod schemas to your client.                                       | `false`                                          |
+| [`returnType`](#returntype)                                               | Shape of the value a generated operation resolves to.                  | `'plain'`                                        |
 | [`include`](https://kubb.dev/docs/5.x/reference/plugin-options#include)   | Keep only operations that match.                                       | None                                             |
 | [`exclude`](https://kubb.dev/docs/5.x/reference/plugin-options#exclude)   | Skip operations that match.                                            | `[]`                                             |
 | [`override`](https://kubb.dev/docs/5.x/reference/plugin-options#override) | Apply different options per pattern.                                   | `[]`                                             |
@@ -49,6 +50,29 @@ Default for the `throwOnError` field that every generated function passes to you
 
 The setting applies to the whole plugin, so you cannot set it in `override`.
 
+### returnType
+
+Shape of the value a generated operation resolves to.
+
+- `'plain'`: returns what your `client` returns.
+- `'full'`: wraps the call in `withUnwrap`, so the caller can `await` it or call `.unwrap()`. Your module must export `withUnwrap` and the `Unwrappable` type.
+- `'data'`: passes the call through `unwrapResult` and resolves to the body. Your module must export `unwrapResult` and the `UnwrappedResult` type.
+
+`@kubb/plugin-client/templates/core.ts` exports all of these, so your module can re-export them from there.
+
+|          |                               |
+| -------- | ----------------------------- |
+| Type     | `'plain' \| 'full' \| 'data'` |
+| Required | `false`                       |
+| Default  | `'plain'`                     |
+
+```typescript
+pluginClient({ importPath: '../../client', returnType: 'full' })
+// const pet = await getPetById({ path: { petId: 1 } }).unwrap()
+```
+
+The setting applies to the whole plugin, so you cannot set it in `override`.
+
 ### validator
 
 Passes Zod schemas from `@kubb/plugin-zod` to your client on `config.validator`. The plugin does not run the schemas. Your client reads `config.validator` and runs them. See [validate requests and responses](https://kubb.dev/extensions/kubb-labs/plugin-client/guides/validate-requests-and-responses).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-client",
-  "version": "5.12.0-canary.20261109T125041",
+  "version": "5.12.0",
   "description": "Generate typed API operations against your own client module.",
   "keywords": [
     "api-client",
@@ -62,13 +62,13 @@
   },
   "dependencies": {
     "@kubb/kit": "^5.16.0",
-    "@kubb/plugin-ts": "^5.5.0-canary.20261109T125041",
-    "@kubb/plugin-zod": "^5.9.0-canary.20261109T125041",
+    "@kubb/plugin-ts": "^5.4.2",
+    "@kubb/plugin-zod": "^5.8.3",
     "@kubb/renderer-jsx": "^5.16.0"
   },
   "devDependencies": {
-    "@internals/client": "0.1.0-canary.20261109T125041",
-    "@internals/shared": "0.1.0-canary.20261109T125041",
+    "@internals/client": "0.0.0",
+    "@internals/shared": "0.0.0",
     "typescript": "^7.0.2"
   },
   "peerDependencies": {},

package/src/plugin.ts

@@ -36,6 +36,7 @@ export const pluginClient = defineExtension<PluginClient>({
       importPath,
       throwOnErrorDefault = true,
       validator = false,
+      returnType = 'plain',
       group,
       resolver: userResolver,
     } = options
@@ -56,7 +57,7 @@ export const pluginClient = defineExtension<PluginClient>({
       baseURL: undefined,
       throwOnErrorDefault,
       validator,
-      returnType: 'plain',
+      returnType,
       sdk: undefined,
       resolver,
     }

package/src/types.ts

@@ -1,5 +1,5 @@
 import type { Override, PluginType } from '@kubb/kit'
-import type { Options as ClientOptions, ResolvedOptions as ClientResolvedOptions, ResolverClient } from '@internals/client'
+import type { Options as ClientOptions, ResolvedOptions as ClientResolvedOptions, ResolverClient, ReturnTypeOption } from '@internals/client'
 
 export type { ResolverClient } from '@internals/client'
 
@@ -18,6 +18,18 @@ type DistributiveOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K>
  * ```
  */
 export type Options = DistributiveOmit<ClientOptions, 'sdk' | 'returnType' | 'baseURL' | 'override'> & {
+  /**
+   * Shape of the value a generated operation resolves to. `'full'` and `'data'` import `withUnwrap` or `unwrapResult`
+   * and their types from your `importPath` module, so that module must export them.
+   *
+   * @default 'plain'
+   * @example
+   * ```ts
+   * pluginClient({ importPath: '../../client', returnType: 'full' })
+   * // await getPetById({ path: { petId: 1 } }).unwrap()
+   * ```
+   */
+  returnType?: ReturnTypeOption
   /**
    * Applies different options to operations that match a pattern.
    * `sdk`, `returnType`, and `baseURL` are not available, because this plugin generates standalone operations and your client module owns the base URL.