[BUG][typescript-node] invalid oneOff class or import

[quezak]

Bug Report Checklist

• Have you provided a full/minimal spec to reproduce the issue?
• Have you validated the input using an OpenAPI validator (example)?
• What's the version of OpenAPI Generator used?
• Have you search for related issues/PRs?
• What's the actual output vs expected output?
• [Optional] Bounty to sponsor the fix (example)

Description

I'm spec'ing a weird API that returns either { success: true, ... } or { success: false, error: ... }. I've defined these as TestSuccess and TestError. I wanted to use the oneOf schema to make the client return a union type. I've tried this two ways, both produce invalid code:

1. Add components/schemas/TestResponse as oneOf with referencing the two schemas. This:
   • generates both TestResponse and TestError classes correctly
   • generates a TestResponse class returned by the API class
   • the TestResponse class has all the properties of both TestSuccess and TestError as required -- not actually useful...
   • the TestResponse class imports both TestSuccess and TestError, but doesn't use them anywhere

// UNUSED
import { TestError } from './testError';
import { TestSuccess } from './testSuccess';

export class TestResponse {
    'success': boolean;
    'result': number;
    'error': string;

    static discriminator: string | undefined = undefined; // ???
// ...

2. Add the oneOf schema inline under .../responses/'200'/content/'application/json'/schema. This:
   • generates both TestResponse and TestError classes correctly
   • generates an API class returning correctly TestResponse | TestError
   • BUT: the import for these classes is utterly invalid 😆

import { TestSuccess | TestError } from '../model/testSuccess | TestError';

openapi-generator version

5.0 snapshot (5.0.0-20191104.022738-17)

OpenAPI declaration file content or url

Case 1:

openapi: '3.0.2'

info:
  version: 0.0.1
  title: test

paths:
  /test:
    get:
      summary: test
      operationId: test
      responses:
        '200':
          description: test result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResponse'

components:
  schemas:
    TestResponse:
      oneOf:
        - $ref: '#/components/schemas/TestSuccess'
        - $ref: '#/components/schemas/TestError'

    TestSuccess:
      type: object
      required:
        - success
        - result
      properties:
        success:
          type: boolean
        result:
          type: integer

    TestError:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
        error:
          type: string

Case 2: same, only TestResponse is pasted inline, not as a component:

...
        '200':
          description: test result
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/TestSuccess'
                  - $ref: '#/components/schemas/TestError'
...

Command line used for generation

java -DskipFormModel=true -jar $GENERATOR_JAR generate -i spec/test-api.2.yml -g typescript-node -p supportsES6=true -o .

Steps to reproduce

Generate the clients and inspect the code :)

Related issues/PRs

I've read #3092 and #2154, but it seems like this is a different case.

Suggest a fix

Case 1: the third generated schema should be just export type TestResponse = TestSuccess | TestError. Or make some use of the discriminator field? (and don't mark all the union fields as non-null)

Case 2: the two classes should be imported correctly.

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[quezak]

I've also tried defining the discriminator for the oneOf schema:

      oneOf:
        - $ref: '#/components/schemas/TestSuccess'
        - $ref: '#/components/schemas/TestError'
      discriminator:
        propertyName: success
        mapping:
          true: '#/components/schemas/TestSuccess'
          false: '#/components/schemas/TestError'

It doesn't change anything in the generated code, apart from setting the discriminator: string | undefined = "success" field in the TestResponse class in case 1. And it looks like that field is used only for serialization, while I'm looking for deserialization.

The workaround for now is to use case 1, and check the discriminator and manually cast to the proper type.

[macjohnny]

@quezak would you like to implement a fix?

[quezak]

@quezak would you like to implement a fix?

I've seen the typescript clients are under a major rewrite, does it make sense to fix the old ones?

[macjohnny]

if you want to have a fix included in the near future, I think it makes sense.

[uragun91]

2 years passed, the problem with import { type1 | type2 } from 'somewhere' still persist in ts client

[quezak]

@uragun91 unfortunately I don't have enough time to fix this, maybe you can? :)

[uragun91]

Sorry, I have no time right now to test it and to make pull request but after a quick code review it seems that I found where the problem may be:
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java#L234

I'm not really strong in java, but it seems that here it should join the map values with comma, not with pipe.

[uragun91]

Will test it on weekend