@kubb/plugin-axios 5.4.0 → 5.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-axios",
-  "version": "5.4.0",
+  "version": "5.4.2",
   "description": "Generate a slim, type-safe HTTP client with Kubb based on axios.",
   "keywords": [
     "api-client",
@@ -66,18 +66,18 @@
   },
   "dependencies": {
     "@kubb/plugin-ts": "^5.0.2",
-    "@kubb/plugin-zod": "^5.1.5"
+    "@kubb/plugin-zod": "^5.2.1"
   },
   "devDependencies": {
     "@internals/client": "0.0.0",
     "@internals/shared": "0.0.0",
     "axios": "^1.20.0",
-    "kubb": "^5.2.0",
+    "kubb": "^5.3.13",
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
     "axios": "^1.20.0",
-    "kubb": "^5.2.0"
+    "kubb": "^5.3.13"
   },
   "peerDependenciesMeta": {
     "axios": {

package/src/plugin.ts

@@ -1,7 +1,8 @@
+import { readFileSync } from 'node:fs'
 import path from 'node:path'
 import { createSdkGenerator, defaultMacros, resolverClient } from '@internals/client'
 import { createGroupConfig } from '@internals/shared'
-import { definePlugin, Resolver } from 'kubb/kit'
+import { ast, definePlugin, Resolver } from 'kubb/kit'
 import { pluginTsName } from '@kubb/plugin-ts'
 import { pluginZodName } from '@kubb/plugin-zod'
 import { clientGenerator } from './generators/clientGenerator.tsx'
@@ -90,10 +91,45 @@ export const pluginAxios = definePlugin<PluginAxios>((options) => {
           copy: axiosSerializersTemplatePath,
         })
 
+        const clientPath = path.resolve(root, '.kubb/client.ts')
+        const clientSource = readFileSync(axiosClientTemplatePath, 'utf8')
+        const clientBody = clientSource.slice(clientSource.indexOf('\n\n') + 2)
+        const runtimeRoot = path.dirname(clientPath)
+
         ctx.injectFile({
           baseName: 'client.ts',
-          path: path.resolve(root, '.kubb/client.ts'),
-          copy: axiosClientTemplatePath,
+          path: clientPath,
+          imports: [
+            ast.factory.createImport({ name: 'axios', path: 'axios' }),
+            ast.factory.createImport({
+              name: ['AxiosError', 'AxiosInstance', 'AxiosRequestConfig', 'AxiosResponse', 'InternalAxiosRequestConfig'],
+              path: 'axios',
+              isTypeOnly: true,
+            }),
+            ast.factory.createImport({
+              name: ['applyHeaderStyles', 'defaultBodySerializer', 'defaultPathSerializer', 'defaultQuerySerializer', 'isDefaultJsonBody', 'serializeCookies'],
+              path: path.resolve(root, '.kubb/serializers.ts'),
+              root: runtimeRoot,
+            }),
+            ast.factory.createImport({
+              name: ['HeadersInit', 'PathParamStyle', 'PathSerializer', 'Serializers', 'Styles'],
+              path: path.resolve(root, '.kubb/serializers.ts'),
+              root: runtimeRoot,
+              isTypeOnly: true,
+            }),
+            ast.factory.createImport({
+              name: ['ParseError', 'validateStandardSchema'],
+              path: path.resolve(root, '.kubb/standardSchema.ts'),
+              root: runtimeRoot,
+            }),
+            ast.factory.createImport({
+              name: ['StandardSchemaValidator'],
+              path: path.resolve(root, '.kubb/standardSchema.ts'),
+              root: runtimeRoot,
+              isTypeOnly: true,
+            }),
+          ],
+          sources: [ast.factory.createSource({ nodes: [ast.factory.createText(clientBody)] })],
           footer: baseURLExpression ? `client.setConfig({ baseURL: ${baseURLExpression} })` : undefined,
         })
 

package/templates/axios.ts

@@ -1,8 +1,8 @@
 import axios from 'axios'
 import type { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig } from 'axios'
-import { applyHeaderStyles, defaultBodySerializer, defaultPathSerializer, defaultQuerySerializer, isDefaultJsonBody, serializeCookies } from './serializers'
-import type { HeadersInit, PathParamStyle, PathSerializer, Serializers, Styles } from './serializers'
-import { ParseError, type StandardSchemaValidator, validateStandardSchema } from './standardSchema'
+import { applyHeaderStyles, defaultBodySerializer, defaultPathSerializer, defaultQuerySerializer, isDefaultJsonBody, serializeCookies } from './serializers.ts'
+import type { HeadersInit, PathParamStyle, PathSerializer, Serializers, Styles } from './serializers.ts'
+import { ParseError, type StandardSchemaValidator, validateStandardSchema } from './standardSchema.ts'
 
 /**
  * HTTP status codes treated as a success, everything else is an error.
@@ -225,12 +225,12 @@ export type RequestConfig<TBody = unknown, TRequest = AxiosRequestConfig, TRespo
   baseURL?: string
   url?: string
   method?: 'GET' | 'PUT' | 'PATCH' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD'
-  path?: Record<string, unknown>
+  path?: unknown
   query?: unknown
   params?: unknown
-  cookies?: Record<string, unknown>
+  cookies?: unknown
   body?: TBody
-  headers?: HeadersInit
+  headers?: unknown
   styles?: Styles
   signal?: AbortSignal
   options?: AxiosOptions
@@ -289,24 +289,27 @@ export type CallResult<TRequest = AxiosRequestConfig, TResponse = AxiosResponse>
   response: TResponse
 }
 
-export type InterceptorFn<T> = (value: T) => T | Promise<T>
+export type InterceptorFn<T, TRequest = AxiosRequestConfig, TResponse = AxiosResponse> = (
+  value: T,
+  requestConfig?: RequestConfig<unknown, TRequest, TResponse>,
+) => T | Promise<T>
 
 /**
  * A single interceptor channel with a transport-agnostic `use` / `eject` / `update` API, backed by axios's native interceptor managers.
  */
-export type InterceptorChannel<T> = {
-  use: (fn: InterceptorFn<T>) => number
+export type InterceptorChannel<T, TRequest = AxiosRequestConfig, TResponse = AxiosResponse> = {
+  use: (fn: InterceptorFn<T, TRequest, TResponse>) => number
   eject: (id: number) => void
-  update: (id: number, fn: InterceptorFn<T>) => void
+  update: (id: number, fn: InterceptorFn<T, TRequest, TResponse>) => void
 }
 
 /**
  * The three interceptor channels every client instance exposes, wrapping axios's native managers with `error` mapped onto the response rejection handler.
  */
-export type Interceptors = {
-  request: InterceptorChannel<InternalAxiosRequestConfig>
-  response: InterceptorChannel<AxiosResponse>
-  error: InterceptorChannel<AxiosError>
+export type Interceptors<TRequest = AxiosRequestConfig, TResponse = AxiosResponse> = {
+  request: InterceptorChannel<InternalAxiosRequestConfig, TRequest, TResponse>
+  response: InterceptorChannel<AxiosResponse, TRequest, TResponse>
+  error: InterceptorChannel<AxiosError, TRequest, TResponse>
 }
 
 /**
@@ -318,7 +321,7 @@ export type ClientInstance<TRequest = AxiosRequestConfig, TResponse = AxiosRespo
   getConfig: () => ClientConfig
   setConfig: (config: ClientConfig) => ClientConfig
   getUrl: <TBody = unknown>(config: RequestConfig<TBody, TRequest, TResponse>) => string
-  interceptors: Interceptors
+  interceptors: Interceptors<TRequest, TResponse>
   createClient: (config?: ClientConfig) => ClientInstance<TRequest, TResponse>
 }
 
@@ -397,13 +400,27 @@ function serializeUrl({
 /**
  * Wraps an axios interceptor registration behind the shared `use` / `eject` / `update` API, mapping a stable external id onto axios's own so `update` can swap a handler in place.
  */
-function createInterceptorChannel<T>(register: (fn: InterceptorFn<T>) => number, ejectNative: (id: number) => void): InterceptorChannel<T> {
+function createInterceptorChannel<T, TRequest, TResponse>(
+  register: (fn: InterceptorFn<T, TRequest, TResponse>) => number,
+  ejectNative: (id: number) => void,
+  getRequestConfig: (value: T) => RequestConfig<unknown, TRequest, TResponse> | undefined,
+  getContextId: (value: T) => number | undefined,
+  setContextId: (value: T, id: number | undefined) => void,
+): InterceptorChannel<T, TRequest, TResponse> {
   const ids = new Map<number, number>()
   let counter = 0
+  const registerWithContext = (fn: InterceptorFn<T, TRequest, TResponse>) =>
+    register(async (value) => {
+      const contextId = getContextId(value)
+      const result = await fn(value, getRequestConfig(value))
+      if (contextId !== undefined) setContextId(result, contextId)
+      return result
+    })
+
   return {
     use(fn) {
       const id = ++counter
-      ids.set(id, register(fn))
+      ids.set(id, registerWithContext(fn))
       return id
     },
     eject(id) {
@@ -415,7 +432,7 @@ function createInterceptorChannel<T>(register: (fn: InterceptorFn<T>) => number,
     update(id, fn) {
       const nativeId = ids.get(id)
       if (nativeId !== undefined) ejectNative(nativeId)
-      ids.set(id, register(fn))
+      ids.set(id, registerWithContext(fn))
     },
   }
 }
@@ -526,7 +543,7 @@ async function resolveRequest<TBody, TRequest, TResponse>({
   const { querySerializer, bodySerializer, pathSerializer } = resolveSerializers({ config, requestConfig })
   const codecs = { ...config.codecs, ...requestConfig.codecs }
 
-  const headers = mergeHeaders(config.headers, applyHeaderStyles(requestConfig.headers, requestConfig.styles?.header))
+  const headers = mergeHeaders(config.headers, applyHeaderStyles(requestConfig.headers as HeadersInit | undefined, requestConfig.styles?.header))
   const { request: requestContentTypeOption, response: responseContentType } = resolveContentType(requestConfig.contentType)
   const requestContentType = requestContentTypeOption ?? getHeader(headers, 'content-type')
   if (responseContentType && !hasHeader(headers, 'accept')) {
@@ -543,7 +560,7 @@ async function resolveRequest<TBody, TRequest, TResponse>({
   })
 
   if (requestConfig.cookies) {
-    const cookie = serializeCookies(requestConfig.cookies, requestConfig.styles?.cookie)
+    const cookie = serializeCookies(requestConfig.cookies as Record<string, unknown>, requestConfig.styles?.cookie)
     if (cookie) headers['Cookie'] = [headers['Cookie'], cookie].filter(Boolean).join('; ')
   }
 
@@ -570,7 +587,7 @@ async function resolveRequest<TBody, TRequest, TResponse>({
     headers['Content-Type'] = 'application/json'
   }
 
-  const pathParams = requestConfig.path ?? {}
+  const pathParams = (requestConfig.path ?? {}) as Record<string, unknown>
   const url = (requestConfig.url ?? '').replace(/\{([^{}]+)\}/g, (_, key: string) =>
     pathSerializer({ name: key, value: pathParams[key], options: requestConfig.styles?.path?.[key] }),
   )
@@ -665,53 +682,89 @@ async function settleResponse<TRequest, TResponse>({
 export function createClientCore<TRequest = AxiosRequestConfig, TResponse = AxiosResponse>(options: ClientConfig = {}): ClientInstance<TRequest, TResponse> {
   let config: ClientConfig = { ...options }
   const instance = config.transport ?? axios.create()
+  const requestContexts = new Map<number, RequestConfig<unknown, TRequest, TResponse>>()
+  let requestContextId = 0
+  const getContextId = (value: AxiosRequestConfig | AxiosResponse | AxiosError) => {
+    if (!value || typeof value !== 'object') return undefined
+    const axiosConfig = 'config' in value ? value.config : value
+    return (axiosConfig as (AxiosRequestConfig & { __kubbRequestContext?: number }) | undefined)?.__kubbRequestContext
+  }
+  const getRequestConfig = (value: AxiosRequestConfig | AxiosResponse | AxiosError) => {
+    const id = getContextId(value)
+    return id === undefined ? undefined : requestContexts.get(id)
+  }
+  const setContextId = (value: AxiosRequestConfig | AxiosResponse | AxiosError, id: number | undefined) => {
+    if (!value || typeof value !== 'object') return
+    const axiosConfig = 'config' in value ? value.config : value
+    if (!axiosConfig) return
+    const contextualConfig = axiosConfig as AxiosRequestConfig & { __kubbRequestContext?: number }
+    if (id === undefined) delete contextualConfig.__kubbRequestContext
+    else contextualConfig.__kubbRequestContext = id
+  }
 
   const requestManager = instance.interceptors.request
   const responseManager = instance.interceptors.response
-  const interceptors: Interceptors = {
-    request: createInterceptorChannel<InternalAxiosRequestConfig>(
+  const interceptors: Interceptors<TRequest, TResponse> = {
+    request: createInterceptorChannel<InternalAxiosRequestConfig, TRequest, TResponse>(
       (fn) => requestManager.use(fn),
       (id) => requestManager.eject(id),
+      getRequestConfig,
+      getContextId,
+      setContextId,
     ),
-    response: createInterceptorChannel<AxiosResponse>(
+    response: createInterceptorChannel<AxiosResponse, TRequest, TResponse>(
       (fn) => responseManager.use(fn),
       (id) => responseManager.eject(id),
+      getRequestConfig,
+      getContextId,
+      setContextId,
     ),
-    error: createInterceptorChannel<AxiosError>(
-      (fn) =>
-        responseManager.use(undefined, async (error: unknown) => {
-          await fn(error as AxiosError)
-          return Promise.reject(error)
-        }),
+    error: createInterceptorChannel<AxiosError, TRequest, TResponse>(
+      (fn) => responseManager.use(undefined, (error: unknown) => Promise.resolve(fn(error as AxiosError)).then(() => Promise.reject(error))),
       (id) => responseManager.eject(id),
+      getRequestConfig,
+      getContextId,
+      setContextId,
     ),
   }
 
   const client = (async <TBody = unknown>(requestConfig: RequestConfig<TBody, TRequest, TResponse>): Promise<CallResult<TRequest, TResponse>> => {
     const activeInstance = requestConfig.transport ?? config.transport ?? instance
     const { axiosConfig, codecs, throwOnError } = await resolveRequest({ config, requestConfig })
+    const contextId = ++requestContextId
+    requestContexts.set(contextId, requestConfig)
+    ;(axiosConfig as AxiosRequestConfig & { __kubbRequestContext: number }).__kubbRequestContext = contextId
 
     try {
-      const response = await activeInstance.request<unknown, AxiosResponse>(axiosConfig)
-      return await settleResponse({
-        response,
-        codecs,
-        validator: requestConfig.validator,
-        onValidationError: requestConfig.onValidationError ?? config.onValidationError,
-      })
-    } catch (error) {
-      const axiosError = error as AxiosError
-      if (throwOnError && axiosError.response) {
-        throw new ResponseError({
-          data: axiosError.response.data,
-          status: axiosError.response.status,
-          statusText: axiosError.response.statusText,
-          contentType: getResponseContentType(axiosError.response.headers as Record<string, unknown>),
-          request: axiosError.config as TRequest,
-          response: axiosError.response as TResponse,
+      try {
+        const response = await activeInstance.request<unknown, AxiosResponse>(axiosConfig)
+        const result = await settleResponse<TRequest, TResponse>({
+          response,
+          codecs,
+          validator: requestConfig.validator,
+          onValidationError: requestConfig.onValidationError ?? config.onValidationError,
         })
+        setContextId(response, undefined)
+        return result
+      } catch (error) {
+        const axiosError = error as AxiosError
+        setContextId(axiosError, undefined)
+        if (axiosError.response) setContextId(axiosError.response, undefined)
+        if (throwOnError && axiosError.response) {
+          throw new ResponseError({
+            data: axiosError.response.data,
+            status: axiosError.response.status,
+            statusText: axiosError.response.statusText,
+            contentType: getResponseContentType(axiosError.response.headers as Record<string, unknown>),
+            request: axiosError.config as TRequest,
+            response: axiosError.response as TResponse,
+          })
+        }
+        throw error
       }
-      throw error
+    } finally {
+      setContextId(axiosConfig, undefined)
+      requestContexts.delete(contextId)
     }
   }) as ClientInstance<TRequest, TResponse>
 
@@ -725,7 +778,7 @@ export function createClientCore<TRequest = AxiosRequestConfig, TResponse = Axio
     const query: Record<string, unknown> = { ...((requestConfig.query ?? requestConfig.params) as Record<string, unknown> | undefined) }
     return serializeUrl({
       parts: [requestConfig.baseURL ?? config.baseURL, requestConfig.url],
-      pathParams: requestConfig.path ?? {},
+      pathParams: (requestConfig.path ?? {}) as Record<string, unknown>,
       search: querySerializer(query, requestConfig.styles?.query),
       pathSerializer,
       pathStyles: requestConfig.styles?.path,