Skip to content

[typescript-fetch] Fix oneOf with mixed array types causing TypeScript compile error#23500

Open
jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
jasperpatterson:fix-oneof-array-never
Open

[typescript-fetch] Fix oneOf with mixed array types causing TypeScript compile error#23500
jasperpatterson wants to merge 1 commit intoOpenAPITools:masterfrom
jasperpatterson:fix-oneof-array-never

Conversation

@jasperpatterson
Copy link
Copy Markdown

@jasperpatterson jasperpatterson commented Apr 8, 2026

When a oneOf schema contains both complex array types (e.g. Array<SomeObject>) and primitive array types (e.g. Array<string>), the generated TypeScript code fails to compile:

error TS2339: Property 'every' does not exist on type 'never'.

The generated ToJSON/FromJSON functions handle complex array members inside an if (Array.isArray(value)) { ... return value; } block that always returns for arrays. TypeScript's control flow analysis then narrows the type to exclude arrays, making subsequent Array.isArray() checks for primitive array members unreachable — the type becomes never.

Example schema that triggers the bug:

ExampleType:
  oneOf:
    - type: array
      items:
        $ref: "#/components/schemas/SomeArrayType"
    - type: array
      items:
        type: string
    - type: boolean
    - type: number
    - type: string

Fix

  • Remove the early return from inside the oneOfArrays Array.isArray() block so TypeScript doesn't narrow the type after it
  • Add a separate array catch-all (if (Array.isArray()) { return value; }) after all primitive array checks, preserving the fallback behavior
  • Fix a syntax bug (missing closing paren) in the isDateType array ToJSON template

Before

// Always returns for arrays → TypeScript narrows to non-array after this
if (Array.isArray(value)) {
    if (value.every(item => typeof item === 'object')) { /* complex types */ }
    return value;
}
// Unreachable — type is 'never' here
if (Array.isArray(value)) {
    if (value.every(item => typeof item === 'string')) { return value; }
}

After

// Doesn't always return → no narrowing
if (Array.isArray(value)) {
    if (value.every(item => typeof item === 'object')) { /* complex types */ }
}
// Reachable
if (Array.isArray(value)) {
    if (value.every(item => typeof item === 'string')) { return value; }
}
// Catch-all for unrecognized arrays
if (Array.isArray(value)) {
    return value;
}

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • 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
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes a TypeScript compile error (TS2339: 'every' on 'never') in generated typescript-fetch clients when a oneOf mixes complex array types with primitive array types.

  • Bug Fixes
    • Remove early return from the Array.isArray() branch in FromJSON/ToJSON for oneOf arrays to prevent type narrowing; add a final array catch-all after primitive array checks.
    • Fix a missing closing parenthesis in the array isDateType ToJSON template.
    • Regenerated sample TestArrayResponse.ts to reflect the new control flow.

Written for commit 0faeea3. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

No issues found across 2 files

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.

1 participant