mirror of
https://github.com/SrIzan10/next-auth.git
synced 2026-05-01 10:55:20 +00:00
f6d6c4344c
* refactor: extend res.{end,send,json}, redirect
* refactor: chain res methods, remove unnecessary ones
* refactor: simplify oauth callback signature
* refactor: code simplifications
* refactor: re-export everything from routes in one
* refactor: split up main index.js to multiple files
* refactor: simplify passing of provider(s) around
* refactor: extend req with callbackUrl inline
* refactor: simplify page rendering
* refactor: move error page redirects to main file, simplify renderer
* refactor: inline req.options definition
* refactor: simplify error fallbacks
* refactor: remove else branches and unnecessary try..catch
* refactor: add docs, and simplify jwt functions
* refactor: prefer errors object over switch..case in signin page
* feat: log all params sent to logger instead of only first
* refactor: fewer lines input validation
* refactor: remove even more unnecessary else branches
65 lines
2.5 KiB
JavaScript
65 lines
2.5 KiB
JavaScript
/**
|
|
* Use the signIn callback to control if a user is allowed to sign in or not.
|
|
*
|
|
* This is triggered before sign in flow completes, so the user profile may be
|
|
* a user object (with an ID) or it may be just their name and email address,
|
|
* depending on the sign in flow and if they have an account already.
|
|
*
|
|
* When using email sign in, this method is triggered both when the user
|
|
* requests to sign in and again when they activate the link in the sign in
|
|
* email.
|
|
*
|
|
* @param {object} profile User profile (e.g. user id, name, email)
|
|
* @param {object} account Account used to sign in (e.g. OAuth account)
|
|
* @param {object} metadata Provider specific metadata (e.g. OAuth Profile)
|
|
* @return {Promise<boolean|never>} Return `true` (or a modified JWT) to allow sign in
|
|
* Return `false` to deny access
|
|
*/
|
|
export async function signIn () {
|
|
return true
|
|
}
|
|
|
|
/**
|
|
* Redirect is called anytime the user is redirected on signin or signout.
|
|
* By default, for security, only Callback URLs on the same URL as the site
|
|
* are allowed, you can use this callback to customise that behaviour.
|
|
*
|
|
* @param {string} url URL provided as callback URL by the client
|
|
* @param {string} baseUrl Default base URL of site (can be used as fallback)
|
|
* @return {Promise<string>} URL the client will be redirect to
|
|
*/
|
|
export async function redirect (url, baseUrl) {
|
|
if (url.startsWith(baseUrl)) {
|
|
return url
|
|
}
|
|
return baseUrl
|
|
}
|
|
|
|
/**
|
|
* The session callback is called whenever a session is checked.
|
|
* e.g. `getSession()`, `useSession()`, `/api/auth/session` (etc)
|
|
*
|
|
* @param {object} session Session object
|
|
* @param {object} token JSON Web Token (if enabled)
|
|
* @return {Promise<object>} Session that will be returned to the client
|
|
*/
|
|
export async function session (session) {
|
|
return session
|
|
}
|
|
|
|
/**
|
|
* This callback is called whenever a JSON Web Token is created / updated.
|
|
* e.g. On sign in, `getSession()`, `useSession()`, `/api/auth/session` (etc)
|
|
*
|
|
* On initial sign in, the raw OAuthProfile is passed if the user is signing in
|
|
* with an OAuth provider. It is not avalible on subsequent calls. You can
|
|
* take advantage of this to persist additional data you need to in the JWT.
|
|
*
|
|
* @param {object} token Decrypted JSON Web Token
|
|
* @param {object} oAuthProfile OAuth profile - only available on sign in
|
|
* @return {Promise<object>} JSON Web Token that will be saved
|
|
*/
|
|
export async function jwt (token) {
|
|
return token
|
|
}
|