@kubb/plugin-client 5.11.0-canary.20261106T171559 → 5.11.0

package/dist/templates/core.d.ts

@@ -1,3 +1,3 @@
 import { a as ValidateOption, o as ValidationErrorContext, s as ValidationErrorHandler } from "../standardSchema-BShJWz2i.js";
-import { A as SuccessResultUnion, B as createClientCore, C as ResolvedRequest, D as ResultByStatus, E as ResponseType, F as TransportResult, G as unwrapResult, H as getResponseContentType, I as Unwrappable, K as withUnwrap, L as UnwrappedResult, M as SuccessVariant, N as ToStatusNumber, O as ResultUnion, P as Transport, R as UrlConfig, S as RequestResult, T as ResponseErrorConfig, U as isStreamed, V as createInterceptorStack, W as resolveAuth, _ as InterceptorStack, a as AuthToken, b as RequestConfig, c as ClientInstance, d as ContentType, f as DataOf, g as InterceptorFn, h as ErrorOf, i as AuthResolver, j as SuccessStatusCode, k as SuccessOf, l as Codec, m as Deserializer, o as CallResult, p as DataShape, r as Auth, s as ClientConfig, u as ContentBodySerializer, v as Interceptors, w as ResponseError, x as RequestCredentials, y as Options, z as Validator } from "../client-CiHb_Cfg.js";
-export { Auth, AuthResolver, AuthToken, CallResult, ClientConfig, ClientInstance, Codec, ContentBodySerializer, ContentType, DataOf, DataShape, Deserializer, ErrorOf, InterceptorFn, InterceptorStack, Interceptors, Options, RequestConfig, RequestCredentials, RequestResult, ResolvedRequest, ResponseError, ResponseErrorConfig, ResponseType, ResultByStatus, ResultUnion, SuccessOf, SuccessResultUnion, SuccessStatusCode, SuccessVariant, ToStatusNumber, Transport, TransportResult, Unwrappable, UnwrappedResult, UrlConfig, type ValidateOption, type ValidationErrorContext, type ValidationErrorHandler, Validator, createClientCore, createInterceptorStack, getResponseContentType, isStreamed, resolveAuth, unwrapResult, withUnwrap };
+import { A as SuccessOf, B as Validator, C as ResolvedRequest, D as ResponseTypeMap, E as ResponseType, F as Transport, G as resolveAuth, H as createInterceptorStack, I as TransportResult, J as withUnwrap, K as resolveResponseType, L as Unwrappable, M as SuccessStatusCode, N as SuccessVariant, O as ResultByStatus, P as ToStatusNumber, R as UnwrappedResult, S as RequestResult, T as ResponseErrorConfig, U as getResponseContentType, V as createClientCore, W as isStreamed, _ as InterceptorStack, a as AuthToken, b as RequestConfig, c as ClientInstance, d as ContentType, f as DataOf, g as InterceptorFn, h as ErrorOf, i as AuthResolver, j as SuccessResultUnion, k as ResultUnion, l as Codec, m as Deserializer, o as CallResult, p as DataShape, q as unwrapResult, r as Auth, s as ClientConfig, u as ContentBodySerializer, v as Interceptors, w as ResponseError, x as RequestCredentials, y as Options, z as UrlConfig } from "../client-BxO6Dygu.js";
+export { Auth, AuthResolver, AuthToken, CallResult, ClientConfig, ClientInstance, Codec, ContentBodySerializer, ContentType, DataOf, DataShape, Deserializer, ErrorOf, InterceptorFn, InterceptorStack, Interceptors, Options, RequestConfig, RequestCredentials, RequestResult, ResolvedRequest, ResponseError, ResponseErrorConfig, ResponseType, ResponseTypeMap, ResultByStatus, ResultUnion, SuccessOf, SuccessResultUnion, SuccessStatusCode, SuccessVariant, ToStatusNumber, Transport, TransportResult, Unwrappable, UnwrappedResult, UrlConfig, type ValidateOption, type ValidationErrorContext, type ValidationErrorHandler, Validator, createClientCore, createInterceptorStack, getResponseContentType, isStreamed, resolveAuth, resolveResponseType, unwrapResult, withUnwrap };

package/dist/templates/sse.d.ts

@@ -1,5 +1,5 @@
 import { a as ValidateOption, i as StandardSchemaValidator, s as ValidationErrorHandler } from "../standardSchema-BShJWz2i.js";
-import { S as RequestResult, k as SuccessOf, n as NativeResponse, p as DataShape, t as NativeRequest, y as Options } from "../client-CiHb_Cfg.js";
+import { A as SuccessOf, S as RequestResult, n as NativeResponse, p as DataShape, t as NativeRequest, y as Options } from "../client-BxO6Dygu.js";
 /**
  * One decoded Server-Sent Event. `data` is parsed as JSON when valid and kept as the raw string otherwise,
  * `event` is `message` when the server sent no `event` field, and `id` is the last event ID the stream has set.

package/docs/guides/write-your-client.md

@@ -45,6 +45,8 @@ export function getPetById<ThrowOnError extends boolean = true>(
 
 Your `client` receives `method`, the `url` template with `{param}` placeholders, `security`, the grouped `path`, `query`, `headers`, and `body`, and `throwOnError`. It returns a promise.
 
+A non-JSON response also passes `responseType`. It is a string such as `'blob'` when every response content type uses one parser, or a map from content type to parser when they differ, for example `{ 'audio/mpeg': 'blob', 'text/event-stream': 'stream' }`. Read the response `Content-Type`, look it up in the map (exact type, then `type/*`, then `*/*`), and parse the body with that parser.
+
 ## A minimal client
 
 The client below uses `fetch`. Replace the transport with the HTTP library you use.
@@ -59,6 +61,7 @@ export type RequestConfig = {
   query?: object
   body?: unknown
   signal?: AbortSignal
+  responseType?: string | Record<string, string>
   throwOnError?: boolean
   security?: Array<{ type: string; name?: string; in?: string; scopes?: Array<string> }>
   client?: typeof client

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-client",
-  "version": "5.11.0-canary.20261106T171559",
+  "version": "5.11.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.20261106T171558",
-    "@kubb/plugin-zod": "^5.9.0-canary.20261106T171558",
+    "@kubb/plugin-ts": "^5.4.1",
+    "@kubb/plugin-zod": "^5.8.2",
     "@kubb/renderer-jsx": "^5.16.0"
   },
   "devDependencies": {
-    "@internals/client": "0.1.0-canary.20261106T171558",
-    "@internals/shared": "0.1.0-canary.20261106T171558",
+    "@internals/client": "0.0.0",
+    "@internals/shared": "0.0.0",
     "typescript": "^7.0.2"
   },
   "peerDependencies": {},

package/templates/core.ts

@@ -6,6 +6,7 @@ import {
   defaultPathSerializer,
   defaultQuerySerializer,
   isDefaultJsonBody,
+  isJsonMediaType,
   serializeCookies,
 } from './serializers.ts'
 import type { HeadersInit, HttpMethod, PathParamStyle, PathSerializer, RequestBody, Serializers, Styles } from './serializers.ts'
@@ -133,6 +134,12 @@ export type DataShape = { body?: unknown; cookies?: unknown; headers?: unknown;
 export type RequestCredentials = 'omit' | 'same-origin' | 'include'
 export type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream' | 'formdata'
 
+/**
+ * Parser per response content type. Generated when one success response declares several content
+ * types that do not share a single parser. Keys are base media types, such as `audio/mpeg` or `audio/*`.
+ */
+export type ResponseTypeMap = Record<string, ResponseType>
+
 /**
  * Decodes a response body for a codec's media type.
  */
@@ -200,7 +207,7 @@ export type RequestConfig<TBody = unknown, TRequest = NativeRequest, TResponse =
   credentials?: RequestCredentials
   options?: Record<string, unknown>
   contentType?: ContentType
-  responseType?: ResponseType
+  responseType?: ResponseType | ResponseTypeMap
   throwOnError?: boolean
   client?: ClientInstance<TRequest, TResponse>
   transport?: Transport<TRequest, TResponse>
@@ -253,7 +260,7 @@ export type ResolvedRequest = {
   signal?: AbortSignal
   credentials?: RequestCredentials
   options?: Record<string, unknown>
-  responseType?: ResponseType
+  responseType?: ResponseType | ResponseTypeMap
 }
 
 /**
@@ -493,6 +500,26 @@ export function isStreamed(data: unknown): data is ReadableStream<Uint8Array> |
   return data instanceof ReadableStream || (!!data && typeof data === 'object' && Symbol.asyncIterator in data)
 }
 
+/**
+ * Picks the parser for a response. A string `responseType` wins. A map is matched against the media type: the exact
+ * type, then a wildcard such as `audio/*`, then a catch-all entry. Otherwise the parser is guessed from the media type.
+ */
+export function resolveResponseType(
+  responseType: ResponseType | ResponseTypeMap | undefined,
+  contentType: string | null | undefined,
+): ResponseType | undefined {
+  if (typeof responseType === 'string') return responseType
+  const base = baseContentType(contentType)
+  if (!base) return undefined
+  const mapped = responseType?.[base] ?? responseType?.[`${base.split('/')[0]}/*`] ?? responseType?.['*/*']
+  if (mapped) return mapped
+  if (base === 'text/event-stream') return 'stream'
+  if (isJsonMediaType(base)) return 'json'
+  if (base.startsWith('text/')) return 'text'
+  if (base === 'application/octet-stream' || base === 'application/pdf' || /^(image|audio|video)\//.test(base)) return 'blob'
+  return undefined
+}
+
 /** The media type of the `Content-Type` response header, without its parameters. */
 export function getResponseContentType(headers: Headers | Record<string, string> | undefined): string | undefined {
   if (!headers) return undefined
@@ -640,7 +667,7 @@ export function createClientCore<TRequest = NativeRequest, TResponse = NativeRes
     const codec = contentType ? codecs[contentType] : undefined
     const decoded = contentType && codec?.deserialize ? await codec.deserialize(result.data, contentType) : result.data
     // A streamed success body is validated event by event in `toEventStream`, not as a whole. A JSON answer to a streamed call is a whole body.
-    const streaming = isSuccess && resolvedRequest.responseType === 'stream' && isStreamed(decoded)
+    const streaming = isSuccess && resolveResponseType(resolvedRequest.responseType, contentType) === 'stream' && isStreamed(decoded)
     const data = await runValidator({
       validator: isValidationEnabled(validate, direction) && !streaming ? validator?.[direction] : undefined,
       value: decoded,

package/templates/sse.ts

@@ -235,7 +235,8 @@ export async function toEventStream<TData = unknown, TResponse = NativeResponse>
   const { data: body, error, status, contentType, request, response } = await call
   const ok = status === undefined || (status >= 200 && status < 300)
   // A transport decodes a JSON answer, so a success that is not a stream would otherwise end as an empty stream.
-  if (ok && body !== undefined && !isStreamBody(body)) {
+  // A 204 or empty answer has no body, `undefined` or `null`, and still ends as an empty stream.
+  if (ok && body != null && !isStreamBody(body)) {
     // `cause` is assigned, since the constructor option needs the ES2022 library a generated client cannot assume.
     throw Object.assign(new TypeError(`Expected a text/event-stream body, got ${contentType ?? 'a body without a content type'}`), { cause: body })
   }