Add support for configuring the default handlers [SDK-3566]

[Widcket]

• All new/changed/fixed functionality is covered by tests (or N/A)
• I have added documentation for all new/changed functionality (or N/A)

📋 Changes

Previously it was not possible to configure the default handlers. For example, to pass a connection parameter to the login handler, it had to be overridden.

export default handleAuth({
  login: async (req, res) => {
    try {
      await handleLogin(req, res, {
        authorizationParams: { connection: 'github' },
      });
    } catch (error) {
      // ...
    }
  }
});

This PR allows to configure default handlers by passing an options object to them. This is the same options object that can be passed when overriding a handler.

export default handleAuth({
  // Works with all default handlers: login, logout, callback, profile
  login: handleLogin({
    authorizationParams: { connection: 'github' }
  })
});

Alternatively, it is possible to pass a function that receives the request and returns an options object.

export default handleAuth({
  login: handleLogin((req) => {
    return {
      authorizationParams: { connection: 'github' }
    };
  })
});

This PR also adds the ability to create new handlers by configuring the default ones, which is useful e.g. for easily creating a signup handler.

export default handleAuth({
  // Creates /api/auth/signup
  signup: handleLogin({
    authorizationParams: { screen_hint: 'signup' }
  })
});

📎 References

Fixes #379, #381, #400, #471, #701

🎯 Testing

Besides adding unit tests, the changes were tested manually using the kitchen sink example app.

[vercel]

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

1 Ignored Deployment

Name	Status	Preview	Updated
nextjs-auth0	⬜️ Ignored (Inspect)		Oct 6, 2022 at 2:45PM (UTC)

[adamjmcgrath]

Nice 👏

Can you update the examples, I'm thinking these ones:

• Customize handlers behavior
• Access an External API from an API Route
• Add a signup handler

[adamjmcgrath]

Added types to this in b02f9b4

Also noticed that the login, logout etc types weren't HandleLogin, HandleLogout but NextApiHandler.

[adamjmcgrath]

lgtm 👍 just the examples updates