+5

.changeset/forty-jobs-sneeze.md

reviewed

··· 1 1 + --- 2 2 + "@hey-api/openapi-ts": patch 3 3 + --- 4 4 + 5 5 + **clients(axios)**: use `query` option when no `paramsSerializer` is provided

+1 -1

examples/openapi-ts-axios/src/client/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/solid-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/svelte-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/vue-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/content-types/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/parameter-explode-false-axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@tanstack/react-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@tanstack/solid-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@tanstack/svelte-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@tanstack/vue-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/base-url-false/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/base-url-number/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/base-url-strict/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/base-url-string/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/clean-false/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/default/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/import-file-extension-ts/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/sdk-client-optional/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/sdk-client-required/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-nodenext-sdk/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/content-types/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/parameter-explode-false-axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@tanstack/angular-query-experimental/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@tanstack/react-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@tanstack/solid-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@tanstack/svelte-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@tanstack/vue-query/axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+1 -1

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/sse-axios/client/client.gen.ts

reviewed

··· 84 84 data: getValidRequestBody(opts), 85 85 headers: opts.headers as RawAxiosRequestHeaders, 86 86 // let `paramsSerializer()` handle query params if it exists 87 87 - params: opts.paramsSerializer ? opts.query : undefined, 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 url, 89 89 }); 90 90

+52

packages/openapi-ts/src/plugins/@hey-api/client-axios/__tests__/client.test.ts

reviewed

··· 49 49 it.each(scenarios)('returns $url', ({ options, url }) => { 50 50 expect(client.buildUrl(options)).toBe(url); 51 51 }); 52 52 + 53 53 + it.each(scenarios)( 54 54 + 'correctly maps `query` parameter to `params` parameter for axios', 55 55 + async ({ options }) => { 56 56 + const mockAxios = vi.fn((config) => ({ config })); 57 57 + 58 58 + expect( 59 59 + ( 60 60 + await client.request({ 61 61 + ...options, 62 62 + axios: mockAxios as Partial<AxiosInstance> as AxiosInstance, 63 63 + method: 'GET', 64 64 + }) 65 65 + ).config?.params, 66 66 + ).toBe(options.query); 67 67 + }, 68 68 + ); 69 69 + 70 70 + it.each(scenarios)( 71 71 + 'uses a custom `paramsSerializer` method when given and do not map `params` for axios', 72 72 + async ({ options }) => { 73 73 + const mockAxios = vi.fn((config) => ({ config })); 74 74 + 75 75 + const paramsSerializer = (params: Record<string, string>) => 76 76 + new URLSearchParams(params).toString(); 77 77 + 78 78 + expect( 79 79 + ( 80 80 + await client.request({ 81 81 + ...options, 82 82 + axios: mockAxios as Partial<AxiosInstance> as AxiosInstance, 83 83 + method: 'GET', 84 84 + paramsSerializer, 85 85 + }) 86 86 + ).config, 87 87 + ).toEqual( 88 88 + expect.objectContaining({ 89 89 + params: undefined, 90 90 + paramsSerializer, 91 91 + }), 92 92 + ); 93 93 + }, 94 94 + ); 52 95 }); 53 96 54 97 describe('AxiosInstance', () => { ··· 350 393 351 394 const config = client.getUri({ baseURL: undefined, url: '/users' }); 352 395 expect(config).toBe('https://api.example.com/users'); 396 396 + }); 397 397 + it('does append `params` as searchParams to the URL', async () => { 398 398 + const client = axios.create({ 399 399 + baseURL: 'https://api.example.com', 400 400 + params: { foo: 'bar' }, 401 401 + }); 402 402 + 403 403 + const config = client.getUri({ baseURL: undefined, url: '/users' }); 404 404 + expect(config).toBe('https://api.example.com/users?foo=bar'); 353 405 }); 354 406 });

+1 -1

packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/client.ts

reviewed

··· 82 82 data: getValidRequestBody(opts), 83 83 headers: opts.headers as RawAxiosRequestHeaders, 84 84 // let `paramsSerializer()` handle query params if it exists 85 85 - params: opts.paramsSerializer ? opts.query : undefined, 85 85 + params: !opts.paramsSerializer ? opts.query : undefined, 86 86 url, 87 87 }); 88 88