v5: NextJS improvements

[nikosdouvlis]

Description

The auth().redirectToSignIn() helper no longer needs to be explicitly returned when called within the middleware. The following examples are now equivalent:

// Before
export default clerkMiddleware(auth => {
  if (protectedRoute && !auth.user) {
    return auth().redirectToSignIn()
  }
})

// After
export default clerkMiddleware(auth => {
  if (protectedRoute && !auth.user) {
    auth().redirectToSignIn()
  }
})

Calling auth().protect() from a page will now automatically redirect back to the same page by setting redirect_url to the request url before the redirect to the sign-in URL takes place.

Checklist

• npm test runs as expected.
• npm run build runs as expected.
• (If applicable) JSDoc comments have been added or updated for any package exports
• (If applicable) Documentation has been updated

Type of change

• 🐛 Bug fix
• 🌟 New feature
• 🔨 Breaking change
• 📖 Refactoring / dependency upgrade / documentation
• other:

Packages affected

• @clerk/backend
• @clerk/chrome-extension
• @clerk/clerk-js
• @clerk/clerk-expo
• @clerk/fastify
• gatsby-plugin-clerk
• @clerk/localizations
• @clerk/nextjs
• @clerk/clerk-react
• @clerk/remix
• @clerk/clerk-sdk-node
• @clerk/shared
• @clerk/themes
• @clerk/types
• build/tooling/chore

[changeset-bot]

🦋 Changeset detected

Latest commit: 4cf05ac

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@clerk/backend	Patch
@clerk/nextjs	Patch
@clerk/fastify	Patch
gatsby-plugin-clerk	Patch
@clerk/remix	Patch
@clerk/clerk-sdk-node	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[panteliselef]

This looks good to me, Is this still WIP ?

[panteliselef]

Are you referring to a possible helper named copyHeaders ?

[nikosdouvlis]

Yes, but also extracting this to clerk/backend

[nikosdouvlis]

This looks good to me, Is this still WIP ?

No :) please review it!

[dimkl]

❓ why did we prefix all the params with _? I thought we prefix a variable with an underscore to mark it as ignored which is not the case here. Should we rename the params in another PR?

[dimkl]

☁️ clerkUrl is of type AuthStatus ? Is this some kind of typo? Also getAuthKeyFromRequest returns string | null | undefined, so the clerkUrl many not have a .toString() method.

[nikosdouvlis]

Good catch @dimkl
TS did not complain as AuthStatus overlaps with string. Let me fix it!

[anagstef]

💯