Bring back the export of the type "Client" (from the now deprecated @hey-api/client-axios)

[alexedme]

Description

Hi!

First and foremost, thank you for maintaining this library.

Since applying this PR #2382 for this issue #2374 (Pass AxiosInstance to createClient instead of AxiosStatic) into version 0.80.2, we're unable to obtain the type of hey-api Axios client.

With version 0.9.1 of @hey-api/client-axios, our team would obtain hey-api Axios client type the following way:

import {type Client as AxiosClient} from '@hey-api/client-axios'; // refers to line 197 of index.d.ts file

interface AxiosClientConfig {
  client: AxiosClient;
  baseUrl: string;
}

export type ApiClients = Partial<Record<ApiKey, AxiosClientConfig>>;

This would be in a common lib in our company used by several teams. After each team generate the typings and client from their respective api, each team do a few config overrides at runtime and we need to make sure the generated client is based on hey-api/client-axios plugin.

Each team would use the interface in their own application in the following way;

import {client as apiWhateverClient} from 'src/generated-api-clients/api-whatever/client.gen'; // refers to the following code snippet below from the generated client.gen.ts

...

const apiClients: AplClients = {
 apiWhatever: {
   client: apiWhateverClient,
   baseURL: 'value obtained at runtime from a database'
 }
}

...
// override some apiClient config and other stuff in a QueryProvider (react) from a common lib

hey-api generated client.gen.ts

// This file is auto-generated by @hey-api/openapi-ts

...

export const client = createClient(
 createConfig<ClientOptions>({
    baseURL: 'baseURL used in the initial config to generate stuff from the api swagger.json'    
 })
);

Since 0.80.2, we got an error since the type signature of Client got changed but not in @hey-api/client-axios (which is normal since that package is deprecated and now live directly inside @hey-api/client-axios)

We tried to remove the use of the package @hey-api/client-axios since it's deprecated but looking at the index.d.ts of @hey-api/open-api-ts (node_modules/@hey-api/openapi-ts/dist/index.d.ts), we don't see the type we're looking for. The type we need to be exported is located at node_modules/@hey-api/openapi-ts/dist/clients/axios/types.ts line 134

Which points to the new type Config where the property axios can be either AxiosStatic | AxiosInstance

We have two options if you agree to go forward with this.

OPTION # 1

Apply PR #2382 to @hey-api/client-axios. But I'll understand if you don't want to go that route since you would probably don't want to spend time on a package that's deprecated.

OPTION # 2

Export the type Client from node_modules/@hey-api/openapi-ts/dist/clients/axios/types.ts line 134 so we can have an equivalent of what we're going with the type Client from @hey-api/client-axios.

Maybe I miss something and there's already a way to achieve this with the package @hey-api/openapi-ts. If that's the case, could you point me to the direction?

Thank you for taking the time to read this and considering this change.

[dosubot]

Hi @alexedme! I'm Dosu and I’m helping the openapi-ts team.

There isn't currently an exported Client type for the Axios client in @hey-api/openapi-ts, and the documentation doesn't mention a supported way to import or use such a type for external typing purposes. The migration away from @hey-api/client-axios and the changes introduced in PR #2382 mean the previous approach is no longer supported, and the new package doesn't provide an equivalent export for the Client type you referenced. If you need this type, you would need to either reconstruct it locally based on the source or request its export as a feature in the main package. For now, there is no officially documented workaround or alternative for this use case in @hey-api/openapi-ts see docs see migration guide.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[alexedme]

Hi @dosu

Thank you for responding rapidly.

I thought this thread was considered as a feature request having the label: feature 🚀

Is my request should be in a particular format? Isn't @hey-api/openapi-ts the main package?

My bad if I didn't follow the procedure to request a feature.

Thank you for considering this change.

Have a great day!

[dosubot]

Your request is correctly submitted as a feature request—there’s no strict format required beyond opening an issue and communicating with maintainers, which you’ve already done. The @hey-api/openapi-ts package is the main package for this context. If maintainers need more details, they’ll let you know here. Thanks for your engagement! See contributing guidelines.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[mrlubos]

@alexedme hey, yeah option 2 is the way to go. I am surprised you're still successfully using the unmaintained package. Do you want to open a pull request for that change? I assume we'd want to re-export the same type for every client

[alexedme]

Hey @mrlubos!

I can take a crack at it! TBH, it will be my first time contributing to an open source library. I'll read your contributing guidelines and If I have any questions, I'll ask them here.

NOTE: I'll do the change for every client.

Thank you for agreeing to move forward with this adjustment.

[mrlubos]

it will be my first time contributing to an open source library

Congratulations! 🎉

I'll read your contributing guidelines

haha, these are far from completed. I'm here if you need any clarification

[alexedme]

it will be my first time contributing to an open source library

Congratulations! 🎉

Thanks! 👊🏾

I'll read your contributing guidelines

haha, these are far from completed. I'm here if you need any clarification

Duly noted. Thank you for your availability.

[alexedme]

Hey @mrlubos,

PR #2535 created.

Let me know if I missed something.

[mrlubos]

Your fix will be released this week, I just need to finish the Pinia Colada work to avoid releasing something unfinished. Thank you again!

[alexedme]

Your fix will be released this week, I just need to finish the Pinia Colada work to avoid releasing something unfinished. Thank you again!

No worries! Thank you for your swift response!