x-enumNames no longer works from v8.0.0

[nadavhalfon]

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

in PR #3123 there is a refactor of createEnumSchemaType function:

I'm not sure if that's the root cause

Minimum reproduction code

https://gist.github.com/nadavhalfon/f49db6fe0ea6eb49178ec84c9f338b0a

Steps to reproduce

@ApiProperty({
  enum: CreditCardDealType,
  enumName: 'CreditCardDealType',
  'x-enumNames': ['REGULAR', 'PAYMENTS'],
})
cardDealType?: CreditCardDealType;


export enum CreditCardDealType {
  REGULAR = 1,
  PAYMENTS = 2,
}

Outputs in swagger generator: 
export enum CreditCardDealType {
  Value1 = 1,
  Value2 = 2,
}

Expected behavior

Outputs in swagger generator:

export enum CreditCardDealType {
  REGULAR = 1,
  PAYMENTS = 2,
}

Package version

11.0.3

NestJS version

No response

Node.js version

No response

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

[kamilmysliwiec]

Please provide a minimum reproduction repository (Git repository/StackBlitz/CodeSandbox project).

[drewish]

Looks like the initial PR that added it didn't include any test cases, so easy to see how it could have gotten broken.

[nadavhalfon]

Looks like the initial PR that added it didn't include any test cases, so easy to see how it could have gotten broken.

You are absolutely right, moreover I am not sure why, but it doesn't work for me, and I couldn't solve it :(
I'll provide a minimum repo 🙏

[drewish]

I'm curious what you find the the min repo steps. I was testing it out on 8.x and it was working for me on a request body:

    @ApiProperty({
        description: 'The status of the approval',
        enum: ApprovalStatus,
        'x-enumNames': getKeys(ApprovalStatus),
    })

[nadavhalfon]

Hey sorry for the delay,
I've created a demo repo: https://github.com/nadavhalfon/nestjs-swagger-x-enumnames-bug

Notice that everything "works" but the output is wrong, if you run the project and access "http://localhost:3000/api-json" you will get the same output as in the "bad-api-json.json" file in the repo
While in order for the client codegens to work it should be the same as the "good-api-json.json"

In earlier versions we had an "hack" that doesnt work anymore, we used to put ts ignore on "x-enumNames" and then use this commit hack: nadavhalfon/nestjs-swagger-x-enumnames-bug@5447620

But it's not working anymore, so right we are using version 7.3.1 with package json overrides in order to still work with nest 11

Thanks! let me know if you have more questions

[mdotme]

Hey any updates on this. I have the same issue. If I add 'enumName' it's generating enum wihout 'x-enumNames'

[kamilmysliwiec]

Would you like to create a PR for this issue?

[mdotme]

Would you like to create a PR for this issue?

I'm exploring the code write some tests I think I'm close to solution

[mdotme]

Would you like to create a PR for this issue?

I'm exploring the code write some tests I think I'm close to solution

Sorry I did write tests but couldn't fix the the issue. I debugged schema-object-factory.ts and x-enumName is not in createEnumSchemaType metadata. I tried to assign x-enumName to schemas[enumName] alongside type and enum

[kamilmysliwiec]

Let's track this here #3307