@kubb/plugin-axios 5.5.11 → 5.5.13

package/dist/index.cjs

@@ -1487,7 +1487,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.5.11";
+var version = "5.5.13";
 //#endregion
 //#region src/templates.ts
 /** Absolute path to the axios client template, copied into `.kubb/client.ts`. */

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-C0LytTxp.js";
-import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactoryOptions, Resolver, ResolverPatch, ast } from "kubb/kit";
+import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, Resolver, ResolverPatch, ast } from "kubb/kit";
 import "kubb/jsx";
 import "@kubb/plugin-zod";
 //#region ../../internals/client/src/types.d.ts
@@ -188,7 +188,7 @@ type ResolvedOptions = {
  * resolved-options shape with the other client plugins; only the plugin name and transport
  * differ.
  */
-type PluginAxios = PluginFactoryOptions<'plugin-axios', Options, ResolvedOptions, ResolverClient>;
+type PluginAxios = PluginType<'plugin-axios', Options, ResolvedOptions, ResolverClient>;
 declare global {
   namespace Kubb {
     interface PluginRegistry {

package/dist/index.js

@@ -1461,7 +1461,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.5.11";
+var version = "5.5.13";
 //#endregion
 //#region src/templates.ts
 /** Absolute path to the axios client template, copied into `.kubb/client.ts`. */

package/docs/guides/authentication.md

@@ -70,8 +70,3 @@ const { data } = await getPetById({ path: { petId: 1 }, client: tenant })
 To override the client for one request, pass `auth` on that single call, which suits a one-off token refresh. An explicit `headers` value you set on a call always wins over the resolved token.
 
 For authentication outside OpenAPI security schemes, use an async request interceptor to sign requests or supply custom headers.
-
-## See also
-
-- [Add interceptors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/interceptors)
-- [Set the base URL](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/base-url)

package/docs/guides/base-url.md

@@ -56,8 +56,3 @@ const { data } = await getPetById({ path: { petId: 1 }, baseURL: 'https://localh
 ```
 
 A `baseURL` set on the call wins over `createClient`, which wins over `setConfig`, which wins over the build-time value.
-
-## See also
-
-- [Authenticate requests](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/authentication)
-- [Use a custom transport](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/transport)

package/docs/guides/calling-operations.md

@@ -138,10 +138,3 @@ const url = client.getUrl({
 })
 // https://api.example.com/v1/pets/1?fields=name
 ```
-
-## See also
-
-- [Handle errors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/error-handling)
-- [Configure serialization](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/serialization)
-- [Set the base URL](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/base-url)
-- [Server-sent events](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/server-sent-events)

package/docs/guides/error-handling.md

@@ -116,9 +116,3 @@ A `ParseError` reports schema validation issues. A `ResponseError` reports a non
 
 Calling `.unwrap()` on a `throwOnError: false` call turns that same `error` into a rejection, so a
 `try`/`catch` works there too.
-
-## See also
-
-- [Call operations](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/calling-operations)
-- [Configure serialization](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/serialization)
-- [Add interceptors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/interceptors)

package/docs/guides/interceptors.md

@@ -74,9 +74,3 @@ Interceptors registered through `client.interceptors` also follow a custom trans
 instance and attach to the new one, and their IDs stay valid for `eject` and `update`. Clearing the
 transport (`client.setConfig({ transport: undefined })`) moves them back to the client's base
 instance. A per-call `transport` still bypasses client interceptors.
-
-## See also
-
-- [Handle errors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/error-handling)
-- [Authenticate requests](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/authentication)
-- [Use a custom transport](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/transport)

package/docs/guides/serialization.md

@@ -112,9 +112,3 @@ pluginAxios({ validator: { request: 'zod', response: 'zod' } })
 With a validator set, Kubb passes the matching schema to each generated call, and the runtime
 parses the body through it. A body that does not match throws a `ParseError` with the schema's
 `issues`.
-
-## See also
-
-- [Call operations](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/calling-operations)
-- [Handle errors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/error-handling)
-- [Server-sent events](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/server-sent-events)

package/docs/guides/server-sent-events.md

@@ -92,8 +92,3 @@ try {
 > [!NOTE]
 > A drop mid-stream ends the `for await` loop. Track the last event's `id` if you need to reconnect
 > from where the stream stopped.
-
-## See also
-
-- [Call operations](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/calling-operations)
-- [Handle errors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/error-handling)

package/docs/guides/transport.md

@@ -42,9 +42,3 @@ Every generated function now sends through your instance, so its timeout, header
 ## Where to set it
 
 Use `client.setConfig({ transport })` for shared configuration, `createClient({ transport })` for an isolated instance, or pass `transport` on an operation to override it for one call.
-
-## See also
-
-- [Add interceptors](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/interceptors)
-- [Set the base URL](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/base-url)
-- [Call operations](https://kubb.dev/extensions/kubb-labs/plugin-axios/guides/calling-operations)

package/docs/options.md

@@ -11,7 +11,6 @@ Pass these options to `pluginAxios()`. Shared options link to [Shared plugin opt
 | [`baseURL`](#baseurl)                                                     | Base URL prepended to every request.                                   | None                                             |
 | [`throwOnErrorDefault`](#throwonerrordefault)                             | Default error behavior and return type for generated operations.       | `true`                                           |
 | [`validator`](#validator)                                                 | Validate request and response bodies with Zod.                         | `false`                                          |
-| [`comments`](#comments)                                                   | How much of each description reaches the JSDoc.                        | `'full'`                                         |
 | [`sdk`](#sdk)                                                             | Emit a class-based SDK instead of standalone functions.                | None                                             |
 | [`returnType`](#returntype)                                               | Shape of the value a generated call resolves to.                       | `'full'`                                         |
 | [`include`](https://kubb.dev/docs/5.x/reference/plugin-options#include)   | Keep only operations that match.                                       | None                                             |
@@ -90,32 +89,6 @@ export default defineConfig({
 })
 ```
 
-### comments
-
-Controls generated JSDoc.
-
-|          |                               |
-| -------- | ----------------------------- |
-| Type     | `'full' \| 'brief' \| 'none'` |
-| Required | `false`                       |
-| Default  | `'full'`                      |
-
-::field-group
-
-:::field{name="'full'"}
-Default value. Keeps complete descriptions and tags.
-:::
-
-:::field{name="'brief'"}
-Keeps the first sentence and other tags. Descriptions over 150 characters without a sentence ending are cut at the last word before 120.
-:::
-
-:::field{name="'none'"}
-Omits JSDoc but keeps the generated-by banner.
-:::
-
-::
-
 ### sdk
 
 Generates a class-based SDK. Each instance takes its own client config, so environments can use separate clients. Leave `sdk` unset to keep the standalone functions that query plugins call.

package/docs/overview.md

@@ -1,25 +1,29 @@
 # Axios
 
-Generates a type-safe HTTP client based on axios from your OpenAPI spec. Each operation becomes one async function with grouped `path`, `query`, `headers`, and `body` parameters and a result keyed by status code.
+The Axios plugin turns each operation in your OpenAPI spec into a typed async function that sends the request with axios. Each function takes grouped `path`, `query`, `headers`, and `body` parameters and returns a result keyed by status code.
 
-This plugin provides the client runtime. Query plugins such as `@kubb/plugin-react-query`, `@kubb/plugin-vue-query`, `@kubb/plugin-swr`, and `@kubb/plugin-mcp` call the functions it generates.
+The query plugins (`@kubb/plugin-react-query`, `@kubb/plugin-vue-query`, and `@kubb/plugin-swr`) and `@kubb/plugin-mcp` call these functions. The plugin also copies its runtime files (`client.ts`, `serializers.ts`, and `standardSchema.ts`) to `.kubb/` in the root output folder.
 
 ## Setup
 
-- Add `@kubb/plugin-ts` for the operation types. Without it, `@kubb/plugin-zod` with `inferred: true` supplies them.
-- Add `@kubb/plugin-zod` when you set `validator`.
-- Install axios v1 or higher in the app that uses the generated code.
+- Add `@kubb/plugin-ts` for the operation types, or `@kubb/plugin-zod` with `inferred: true`.
+- Add `@kubb/plugin-zod` when you set `validator`, and install `zod` v4. Without the plugin, `validator` does nothing.
+- Install `axios` 1.20 or a later v1 release in the app that uses the generated code.
 
 ## Options worth knowing
 
-- `baseURL` is prepended to every request.
-- `validator: 'zod'` validates request and response bodies with the schemas from `@kubb/plugin-zod`.
-- `sdk` generates a class-based SDK, grouped by tag or flat, instead of standalone functions. Query plugins need the standalone functions, so leave `sdk` unset when you use them.
-- `returnType: 'data'` makes a call resolve to the success body instead of the full result with status, data, and error.
-- `throwOnErrorDefault: false` returns documented error responses as values instead of throwing. A single call can still pass `throwOnError`.
+- `baseURL` is prepended to every request. The spec's `servers` URL is not used, so without `baseURL` you set one at runtime with `client.setConfig({ baseURL })`.
+- `validator: 'zod'` validates response bodies with the schemas from `@kubb/plugin-zod`. Use `{ request: 'zod', response: 'zod' }` to also validate request bodies.
+- `throwOnErrorDefault: false` returns non-2xx responses as values instead of throwing. A single call can still pass `throwOnError`.
+- `returnType: 'data'` makes a call resolve to the success body instead of the full result. With `throwOnError: false`, the call still returns the full result.
+- `sdk` generates a class-based SDK, grouped by tag or flat, instead of standalone functions. The query plugins and `@kubb/plugin-mcp` need the standalone functions, so leave `sdk` unset when you use them.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-axios/options) for every option and its default.
 
 ## Example
 
+The config below generates an axios client that sends every request to the Petstore API.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -34,8 +38,3 @@ export default defineConfig({
   ],
 })
 ```
-
-## See also
-
-- [axios](https://axios-http.com/)
-- [`@kubb/plugin-ts`](https://kubb.dev/extensions/kubb-labs/plugin-ts)

package/kubb-extension.json

@@ -18,6 +18,7 @@
     }
   ],
   "dependencies": ["plugin-ts"],
+  "optionalDependencies": ["plugin-zod"],
   "compatibility": {
     "kubb": ">=5.8.3",
     "node": ">=22"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-axios",
-  "version": "5.5.11",
+  "version": "5.5.13",
   "description": "Generate a slim, type-safe HTTP client with Kubb based on axios.",
   "keywords": [
     "api-client",
@@ -68,19 +68,19 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.9",
-    "@kubb/plugin-zod": "^5.4.7"
+    "@kubb/plugin-ts": "^5.0.11",
+    "@kubb/plugin-zod": "^5.4.9"
   },
   "devDependencies": {
     "@internals/client": "0.0.0",
     "@internals/shared": "0.0.0",
     "axios": "^1.20.0",
-    "kubb": "^5.8.3",
+    "kubb": "^5.9.2",
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
     "axios": "^1.20.0",
-    "kubb": "^5.8.3"
+    "kubb": "^5.9.2"
   },
   "peerDependenciesMeta": {
     "axios": {

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { PluginFactoryOptions } from 'kubb/kit'
+import type { PluginType } from 'kubb/kit'
 import type { Options, ResolvedOptions, ResolverClient } from '@internals/client'
 
 export type { Options, ResolvedOptions, ResolverClient } from '@internals/client'
@@ -8,7 +8,7 @@ export type { Options, ResolvedOptions, ResolverClient } from '@internals/client
  * resolved-options shape with the other client plugins; only the plugin name and transport
  * differ.
  */
-export type PluginAxios = PluginFactoryOptions<'plugin-axios', Options, ResolvedOptions, ResolverClient>
+export type PluginAxios = PluginType<'plugin-axios', Options, ResolvedOptions, ResolverClient>
 
 declare global {
   namespace Kubb {