Support custom Axios instances in setupOpenApiClient (#187)

* Support custom Axios instances in `setupOpenApiClient` and add corresponding tests

* Clarify default and custom axios options in `typedApiClient.setupOpenApiClient` usage docs

* Formatting

Author: srozen

vue/src/network/__tests__/typedApiClient.test.ts

@@ -31,6 +31,15 @@ describe('network/typedApiClient', () => {
     expect(setConfig).toHaveBeenCalledExactlyOnceWith({ axios: axiosInstance })
   })
 
+  it('setupOpenApiClient should attach custom axios instance when provided', () => {
+    const setConfig = vi.fn()
+    const client = { setConfig }
+    const customAxios = { custom: true } as any
+    typedApiClient.setupOpenApiClient(client, customAxios)
+    expect(setConfig).toHaveBeenCalledTimes(1)
+    expect(setConfig).toHaveBeenCalledExactlyOnceWith({ axios: customAxios })
+  })
+
   describe('query()', () => {
     it('configures useQuery with callable name and options ref; enabled guard; unwraps data', async () => {
       // Define a named callable to check queryKey uses callable.name

vue/src/network/network.mdx

@@ -40,7 +40,7 @@ The lib provide utils and helpers to handle communications with a backend (ReST
    1. Attach axios to the "client"
    2. Ensure TanStack wrappers are up and running
 4. Create your OpenAPI-based API Client, if applicable
-   1. Attach axios to the "client"
+   1. Attach axios to the "client" (defaults to the axios singleton)
    2. Ensure TanStack wrappers are up and running
 5. Initialize the backendStore
    1. Attach the reactive interceptors on the axios Instance, for authentication
@@ -100,11 +100,18 @@ If your backend exposes an OpenAPI schema, you can leverage it by auto-generatin
 
 - From your OpenAPI specs, generate a typed SDK : `npx @hey-api/openapi-ts --input ./path/to/openapi.yaml --output ./src/openapi --client @hey-api/client-axios`
 - Link the typedApiClient to the SDK, in main.ts :
+
   ```ts
   import { client } from '@/openapi/client.gen'
   import { typedApiClient } from '@nside/wefa/network'
+
+  // By default, it will use the axios singleton from @nside/wefa/network
   typedApiClient.setupOpenApiClient(client)
+
+  // Or you can provide a custom axios instance
+  typedApiClient.setupOpenApiClient(client, myCustomAxiosInstance)
   ```
+
 - Use the wrappers anywhere :
 
   ```ts

vue/src/network/typedApiClient.ts

@@ -10,11 +10,11 @@ import {
   type UseMutationReturnType,
   type UseMutationOptions,
 } from '@tanstack/vue-query'
-import type { AxiosError } from 'axios'
+import type { AxiosError, AxiosInstance } from 'axios'
 import type { Ref } from 'vue'
 
 /**
- * Attaches the axios singleton to an OpenAPI Client/SDK,
+ * Attaches an axios instance to an OpenAPI Client/SDK,
  * autogenerated by @hey-api/openapi-ts.
  * You need to call this during application startup to have a working OpenAPI Client
  * E.g., if you're running: npx @hey-api/openapi-ts --input .path/to/openapi.yaml --output ./src/openapi
@@ -23,11 +23,12 @@ import type { Ref } from 'vue'
  * import { typedApiClient } from '@nside/wefa/network'
  * typedApiClient.setupOpenApiClient(client)
  * @param client Auto-generated OpenAPI client
+ * @param axios Optional axios instance. If not provided, it defaults to the axios singleton.
  */
 // We can't really type the client arg because the type itself is codegen so it might not exist
-function setupOpenApiClient(client: any) {
+function setupOpenApiClient(client: any, axios?: AxiosInstance) {
   client.setConfig({
-    axios: axiosInstance,
+    axios: axios ?? axiosInstance,
   })
 }