Add support for customizing returnTo in middleware

[adamjmcgrath]

📋 Changes

Adding support for customizing the returnTo in middleware:

import { withMiddlewareAuthRequired, getSession } from '@auth0/nextjs-auth0/edge';

// Existing
export default withMiddlewareAuthRequired(async function middleware(req) {
  return NextResponse.next();
});

// To provide a custom `returnTo` url to login:
export default withMiddlewareAuthRequired({
  returnTo: '/foo',
  async middleware(req) { return NextResponse.next(); } // Custom middleware can be here
});

// You can also provide a method for `returnTo` that takes the req as an argument.
// Useful for adding i18n or basePath
export default withMiddlewareAuthRequired({
  returnTo(req) { return `${req.nextURL.basePath}${req.nextURL.pathname}`};
});

📎 References

fixes #1322 #1329

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
nextjs-auth0	⬜️ Ignored (Inspect)	Visit Preview		Aug 3, 2023 0:16am

[Widcket]

Should we include the basePath here? As requested in #1329

[Widcket]

Or maybe in another PR.

[adamjmcgrath]

The reason I didn't add it was because I was worried it might be a breaking change.

If you were to work around this limitation currently, you might write something that prepended the base path to the returnTo in a custom login or callback handler and I didn't want to break that usage.

[vercel]

Deployment failed with the following error:

Please accept Vercel's request to update the GitHub App permissions. Otherwise GitHub will not permit Vercel to create or access a new Git repository for you.