search

ojoanalogo / nestjs-redoc

📘 ReDoc frontend for you NestJS swagger API documentation
MIT License
146 stars 55 forks source link

"Patch" version bump should have been major #16

Closed kjs3 closed 3 years ago

kjs3 commented 3 years ago

The patch version bump from 1.3.0 to 1.3.1 contained some major dependency updates and probably should have been a 2.0.0.

Specifically the Nest version here changes the INestApplication type.

This broke my app with the following:

src/documentation/documentation.service.ts:44:39 - error TS2345: Argument of type 'import("/app/node_modules/@nestjs/common/interfaces/nest-application.interface").INestApplication' is not assignable to parameter of type 'import("/app/node_modules/nestjs-redoc/node_modules/@nestjs/common/interfaces/nest-application.interface").INestApplication'.
  Property 'registerRequestByContextId' is missing in type 'import("/app/node_modules/@nestjs/common/interfaces/nest-application.interface").INestApplication' but required in type 'import("/app/node_modules/nestjs-redoc/node_modules/@nestjs/common/interfaces/nest-application.interface").INestApplication'.

Can we revert this and do it again as a major version change? For the moment I pinned to 1.3.0.

ChrisWun commented 3 years ago

We got the same problem. Thanks for the issue :)

ojoanalogo commented 3 years ago

Oh, I'm sorry I didn't noticed this was a major problem, will update ASAP

ojoanalogo commented 3 years ago

Updated package to 1.3.2 as temporal mesure, reverted back changes made to dependencies, please update @kjs3 @ChrisWun

kjs3 commented 3 years ago

1.3.2 seems fine. I would bump master to 2.0.0 before and release that. I assume that's fine for people on a later Nest.js.