Skip to content

[typescript-axios] Fix generated package build on TypeScript 6 (types node, @types/node 20, ES5 range) - #25599

Open
atl3tico wants to merge 1 commit into
OpenAPITools:masterfrom
atl3tico:typescript-axios-ts6-types-node
Open

atl3tico wants to merge 1 commit into
OpenAPITools:masterfrom
atl3tico:typescript-axios-ts6-types-node

Conversation

@atl3tico

@atl3tico atl3tico commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #25598 (regression introduced by #25148, shipped in 7.27.0).

Since 7.27.0 a typescript-axios client generated with npmName fails its npm install, because the prepare script now compiles with TypeScript 6 and the generated @types/node is never loaded (TypeScript 6 defaults types to an empty list):

api.ts(55,51): error TS2550: Property 'entries' does not exist on type 'ObjectConstructor'.
common.ts(19,38): error TS2591: Cannot find name 'url'. Do you need to install type definitions for node?

Changes

  • tsconfig.mustache: list "node" in types explicitly.
  • package.mustache: bump @types/node from 12.11.5 - 12.20.42 to ^20.0.0. @types/node 12 is incompatible with the TypeScript 6 standard library (DateTimeRangeFormatPart), and @types/node >= 16 needs TypeScript >= 4.9, so the lower bound of the typescript range follows (^4.9).
  • package.mustache: only include ^6.0 in the typescript range when supportsES6 is set. TypeScript 6 rejects target: ES5 unless ignoreDeprecations is "6.0", and TypeScript 5 rejects that value, so one generated tsconfig.json cannot serve both compilers for the ES5 target.
  • Samples: removed the hand-written custom.d.ts (declare module 'url';) from the petstore builds. It dates from the 2018 scaffold ([TypeScript] add new generator for Axios  #892), is not generated, and turns url into a shorthand ambient module, which breaks the @types/node 20 url typings (Cannot use namespace '_URL' as a type). Refreshed the three tracked package-lock.json files for the new ranges.
  • TypeScriptAxiosClientCodegenTest: extended the TypeScript 6 test and added one for the ES5 range.

Verification

Compatibility matrix for the generated ES6 client with types: ["node"] (0 errors unless noted):

@types/node TS 4.9.5 TS 5.0.4 TS 5.9.3 TS 6.0.3
16 / 18 / 20 ok ok ok ok
22 fails fails ok ok
24 fails fails ok ok

@types/node 18 and 20 fail on TypeScript 4.0 and 4.6 (syntax errors in the typings), hence ^4.9.

  • npm install (which runs prepare -> tsc && tsc -p tsconfig.esm.json) succeeds in all regenerated samples with a package.json: es6-target (TypeScript 6.0.3 resolved, dist/ and dist/esm/), with-npm-version (5.9.3 from the refreshed lock), with-npm-version-and-separate-models-and-api (5.9.3), with-complex-headers (5.6.3), echo_api/build (5.6.3).
  • The minimal spec from [BUG][typescript-axios] 7.27.0 generated package fails to build: TypeScript 6 resolved but @types/node not loaded #25598 (object query parameter + withNodeImports=true) compiles with TypeScript 6.0.3 after this change.
  • ./bin/generate-samples.sh ./bin/configs/typescript-axios-*.yaml regenerated the samples; only package.json and tsconfig.json changed.
  • ./mvnw -pl modules/openapi-generator -am -Dtest=TypeScriptAxiosClientCodegenTest -Dsurefire.failIfNoSpecifiedTests=false test: 16 tests, 0 failures.

Note: this branch is based on 0a5b61b because current master fails to compile (CSharpClientCodegen.postProcessAllModels is defined twice since #25593).

PR checklist

  • Read the contribution guidelines.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    Only the typescript-axios configs were regenerated; the change touches no other generator.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha @KannaKim


Summary by cubic

Fixes generated typescript-axios clients failing npm install when the prepare script resolves TypeScript 6, which no longer loads @types/node by default.

Bug Fixes

  • Lists "node" explicitly in the generated tsconfig.json types so Object.entries and the url import compile under TypeScript 6.
  • Bumps @types/node from 12.11.5 - 12.20.42 to ^20.0.0 and raises the TypeScript range lower bound to ^4.9.
  • Excludes TypeScript 6 from the range for the ES5 target, since neither compiler accepts the other's ignoreDeprecations configuration for target: ES5.
  • Removes the hand-written declare module 'url' shim from petstore samples, which shadowed the @types/node 20 url typings.
  • Refreshes the affected sample package.json, tsconfig.json, and package-lock.json files and extends the codegen tests to cover both ranges.

Written for commit 185ede7. Summary will update on new commits.

View guided diff

Since OpenAPITools#25148 the generated devDependency range admits TypeScript 6, which
npm now resolves. TypeScript 6 no longer loads every package under
node_modules/@types by default, so the generated @types/node was never
loaded: Object.entries (ES2017, only available through @types/node with
target ES6) and the "url" import of withNodeImports failed to compile.

- tsconfig: list "node" in "types" explicitly.
- package.json: bump @types/node to ^20 (12.x is incompatible with the
  TypeScript 6 standard library). @types/node >= 16 requires TypeScript
  4.9, so the lower bound of the range follows.
- package.json: keep TypeScript 6 out of the range when the target is ES5.
  TypeScript 6 only accepts target ES5 with ignoreDeprecations "6.0", a
  value TypeScript 5 rejects, so a single tsconfig cannot serve both.
- samples: drop the manual custom.d.ts shim (declare module 'url'), which
  turns the module into a shorthand ambient module and breaks the
  @types/node 20 url typings; refresh the lockfiles for the new ranges.

Closes OpenAPITools#25598

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 22 files

View guided diff | Re-trigger cubic

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG][typescript-axios] 7.27.0 generated package fails to build: TypeScript 6 resolved but @types/node not loaded

2 participants