openapi-ts icon indicating copy to clipboard operation
openapi-ts copied to clipboard

Fix build error from RawAxiosHeaders

Open jkalberer opened this issue 1 year ago • 6 comments

I'm getting the following error:

Exported variable 'runRules' has or is using name 'RawAxiosHeaders' from external module ".../axios/index" but cannot be named.

For code that looks like this:

export const runRules = <ThrowOnError extends boolean = true>(options: Options<RunRulesData, ThrowOnError>) => {
  return (options?.client ?? client).post<RunRulesResponse, RunRulesError, ThrowOnError>({
    ...options,
    url: '/fixer/run',
  });
};

The build error is happening for APIs where the body is a required parameter.


I think the main issue here is that RawAxiosHeaders is not exported from axios but you're using it as an exported type here.

Anyways, AxiosRequestHeaders + your Record type seems to cover most of what CreateAxiosDefaults['headers'] includes.

jkalberer avatar Aug 23 '24 18:08 jkalberer

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

⚠️ No Changeset found

Latest commit: c203898b16f46bc4dcb0e9bdd53e8eb86be4bf01

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Aug 23 '24 18:08 changeset-bot[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hey-api-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 11, 2024 1:42pm

vercel[bot] avatar Aug 23 '24 18:08 vercel[bot]

This is occurring for me too.

swelborn avatar Jan 15 '25 22:01 swelborn

I'm facing the same issue as well. @Mrlubos, could we go ahead with the fix?

rodrigopagnuzzi avatar May 12 '25 22:05 rodrigopagnuzzi

@rodrigopagnuzzi thanks for bumping this, I'll prioritise it soon

mrlubos avatar May 12 '25 23:05 mrlubos

Going to get this in the next release, thanks for your patience here!

mrlubos avatar Jul 20 '25 14:07 mrlubos