feat(@nestjs/core): Add RouterModule to the core

[shekohex]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes/features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[x] Refactoring (no functional changes, no API changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #255 , #389 and #1438

What is the new behavior?

For a long time ago (almost 2 years) I created and maintained the nest-router package as a 3rd party package.
Over that time, we gained a lot of feedback and fixed a lot of issues (especially integration with other packages like @nestjs/swagger for example).

And now, we think it's time to add this package as a module into the nestjs core, and Hopefully it would be useful in a lot of use cases, for example:

1. API Versioning.
2. Arrange Routes/Modules hierarchically.

...and the list goes on.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

[shekohex]

I think doing this would solve all integration issues with any other packages that depend on routes

[shekohex]

for example the swagger integration issues and also this issue nestjsx/nest-router#5

[kamilmysliwiec]

Very uncommon but still: what if I have the same controller used in 2 modules? In this case, I'd override the metadata twice.

[coveralls]

Pull Request Test Coverage Report for Build 16552

• 43 of 43 (100.0%) changed or added relevant lines in 5 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.04%) to 95.316%

---

Totals
Change from base Build 8083:	0.04%
Covered Lines:	4456
Relevant Lines:	4675

---

💛 - Coveralls

[tonivj5]

Any news? 👍

[kamilmysliwiec]

Let me know if there's anything we can do to help @shekohex!

[shekohex]

Hi @kamilmysliwiec
I'm sorry, I was so busy in the past few days, but as I got some time, I'll continue working on this PR again.

The issue here with Middlewares as stated here nestjsx/nest-router#5.
I made a Workaround here so far so good, but I think if we are gonna make this a Core Module, why do we need these workarounds.
So any suggestions to solve this issue? without doing this which I think it does not even work

[kamilmysliwiec]

Actually, this doesn't look that bad ;)

[tonivj5]

Is this PR going to be merged as part of 7.0.0 release? 🚀

[shekohex]

Hi @kamilmysliwiec
Any Help here with this Middleware error? I don't know how that happened

[tonivj5]

Hey, any progress on this? 👀

[UvealSnow]

Would love to have this feature!

[vahidvdn]

Any news?

[shekohex]

Hey all, anyone is interested to take over this PR?
As I don't have any free time to do it these days, things gone crazy this year!

[vahidvdn]

@shekohex @kamilmysliwiec In Angular, I used to pass the custom data object where I define the route (in router module). Then in guard, I can have access to that data. (e.g. isPublic = true)

But here (as described) we should define a custom decorator and decorate the controller's method with it, then in guard, we can have access to the decorator's value (to check whether the API is decorated with that decorator or not)
I think the Angular approach is much better from the maintainability point of view which can be possible with this RouterModule.

[kamilmysliwiec]

@shekohex I've cherry-picked your changes and created a new PR #6035 let's track this there

[vahidvdn]

@kamilmysliwiec Would you please consider this for versioning? (Actually the discussion started from here)