fix: allow returning Route from defineNuxtRouteMiddleware

[wattanx]

🔗 Linked issue

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Returning navigateTo in defineNuxtRouteMiddleware causes a type error.
In the case of a bridge, Route may be returned.

Reproduction

Run npx nuxi typecheck in the following environment
https://stackblitz.com/edit/github-3fgb91-hijxwf

middleware/redirect.ts:3:42 - error TS2345: Argument of type '() => Route | RawLocation | Promise<void | Route | NavigationFailure>' is not assignable to parameter of type 'RouteMiddleware'.
  Type 'Route | RawLocation | Promise<void | Route | NavigationFailure>' is not assignable to type 'RouteMiddlewareReturn | Promise<RouteMiddlewareReturn>'.
    Type 'Route' is not assignable to type 'RouteMiddlewareReturn | Promise<RouteMiddlewareReturn>'.
      Type 'Route' is not assignable to type 'Location'.
        Types of property 'name' are incompatible.
          Type 'string | null | undefined' is not assignable to type 'string | undefined'.
            Type 'null' is not assignable to type 'string | undefined'.

3 export default defineNuxtRouteMiddleware(() => {
                                           ~~~~~~~


Found 1 error in middleware/redirect.ts:3

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[danielroe]

do we also need to accept undefined/null?

[wattanx]

Hmm, I investigated a bit and I don't think I have to accept it.