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

Offen
  • Stimmt etwas nicht?
#25,598 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@atl3tico arbeitet bereits daran.

Seit 09.11.2026.

  • #25599 von @atl3tico — offen

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
25/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
typescript
Bereich
tooling

Rechercherichtung

A linked pull request (#25599) is already open, so check its changes before considering this issue. The report points to modules/openapi-generator/src/main/resources/typescript-axios/tsconfig.mustache and package.mustache, and to TypeScriptAxiosClientCodegenTest.testGeneratedPackageJsonSupportsTypeScript6. Start by reviewing those files and the test; done means a generated package builds with TypeScript 6 and the reported Node types and Object.entries errors are covered.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request
Description

Since 7.27.0 a typescript-axios client generated with npmName (so that package.json and tsconfig.json are emitted) no longer compiles when npm install runs its prepare script.

#25148 widened the generated devDependency range to "typescript": "^4.0 || ^5.0 || ^6.0", so npm install now resolves TypeScript 6.0.3. TypeScript 6 no longer includes every package under node_modules/@types automatically (types now defaults to an empty list), so the generated @types/node devDependency is never loaded. Two things break:

  • Object.entries emitted for style: form / explode: true object query parameters: the generated tsconfig.json targets ES6, and the ES2017 declaration of Object.entries only came in transitively through @types/node.
  • import { URL, URLSearchParams } from 'url' emitted by withNodeImports=true.

Actual output:

api.ts(55,51): error TS2550: Property 'entries' does not exist on type 'ObjectConstructor'. Do you need to change your target library? Try changing the 'lib' compiler option to 'es2017' or later.
common.ts(19,38): error TS2591: Cannot find name 'url'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
npm error command failed
npm error command sh -c npm run build

Expected output: npm install builds dist/ and dist/esm/ as it did with 7.26.0.

Adding "types": ["node"] to the generated tsconfig.json alone is not enough: the generated range "@types/node": "12.11.5 - 12.20.42" is incompatible with the TypeScript 6 standard library (lib.esnext.intl.d.ts: Cannot find name 'DateTimeRangeFormatPart'). With "types": ["node"] and "@types/node": "^24.0.0" the same client compiles on TypeScript 6.0.3.

The CI samples do not catch this because no sample combines npmName with withNodeImports or with an object query parameter, and the petstore spec never emits Object.entries.

openapi-generator version

7.27.0 (regression, 7.26.0 works). Still reproduces with latest (7.28.0-SNAPSHOT, image published 2026-11-09).

OpenAPI declaration file content or url
openapi: 3.0.3
info:
  title: repro
  version: 1.0.0
paths:
  /items:
    get:
      operationId: listItems
      parameters:
        - name: filter
          in: query
          style: form
          explode: true
          schema:
            type: object
            additionalProperties:
              type: string
      responses:
        '200':
          description: ok
Generation Details
openapi-generator-cli generate -i spec.yaml -g typescript-axios \
  --additional-properties=supportsES6=true,withNodeImports=true,npmName=repro,npmVersion=1.0.0 \
  -o out
Steps to reproduce
  1. Generate with the command above using 7.27.0 (for example docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli:v7.27.0 generate ...).
  2. cd out && npm install.
  3. npm install resolves [email protected] and @types/[email protected], runs prepare -> npm run build and fails with the errors above.
  4. Repeat with openapitools/openapi-generator-cli:v7.26.0: the build succeeds (TypeScript 5.x is resolved).
Related issues/PRs
  • #24830 (request to allow TypeScript 6)
  • #25148 (the change that added ^6.0 to the range and removed moduleResolution)
Suggest a fix

In modules/openapi-generator/src/main/resources/typescript-axios:

  • tsconfig.mustache: add "types": ["node"] next to typeRoots.
  • package.mustache: bump @types/node to a range that supports TypeScript 6, for example ^24.0.0.

I will open a PR with these changes, the regenerated samples and an extension of TypeScriptAxiosClientCodegenTest.testGeneratedPackageJsonSupportsTypeScript6.

Vorherrschende Sprache
Java
Sterne
26.9k
Forks
7.8k
Ø Merge
2 T. 10 Std.
Gemergte PRs (30 T.)
180

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus OpenAPITools/openapi-generator

Alle Issues in OpenAPITools/openapi-generator

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.