From e9fc85a51f8e48587eecf162a3117df105cd7cae Mon Sep 17 00:00:00 2001 From: Andrew Ovens Date: Thu, 16 Mar 2023 12:33:07 -0600 Subject: [PATCH] Update documentation --- .../classes/client_use_user.RequestError.html | 6 +-- docs/classes/session_session.default.html | 16 ++++---- .../utils_errors.AccessTokenError.html | 12 +++--- docs/classes/utils_errors.AuthError.html | 12 +++--- .../utils_errors.CallbackHandlerError.html | 14 +++---- docs/classes/utils_errors.HandlerError.html | 12 +++--- .../utils_errors.LoginHandlerError.html | 14 +++---- .../utils_errors.LogoutHandlerError.html | 14 +++---- .../utils_errors.ProfileHandlerError.html | 14 +++---- .../utils_errors.AccessTokenErrorCode.html | 14 +++---- docs/functions/client_use_user.default.html | 2 +- docs/functions/client_use_user.useUser.html | 2 +- docs/functions/edge.getSession-1.html | 12 ++++-- docs/functions/edge.initAuth0-1.html | 2 +- .../edge.withMiddlewareAuthRequired-1.html | 2 +- ...helpers_testing.generateSessionCookie.html | 2 +- docs/functions/index._initAuth.html | 2 +- docs/functions/index.getAccessToken-1.html | 2 +- docs/functions/index.getSession-1.html | 10 +++-- docs/functions/index.handleAuth-1.html | 2 +- docs/functions/index.handleCallback-1.html | 6 +-- docs/functions/index.handleLogin-1.html | 6 +-- docs/functions/index.handleLogout-1.html | 6 +-- docs/functions/index.handleProfile-1.html | 6 +-- docs/functions/index.initAuth0-1.html | 2 +- docs/functions/index.updateSession-1.html | 2 +- .../index.withApiAuthRequired-1.html | 2 +- .../index.withPageAuthRequired-1.html | 2 +- .../client_use_user.UserProfile.html | 18 ++++----- ...ent_with_page_auth_required.UserProps.html | 4 +- ..._required.WithPageAuthRequiredOptions.html | 8 ++-- .../config.AuthorizationParameters.html | 8 ++-- docs/interfaces/config.BaseConfig.html | 40 +++++++++---------- docs/interfaces/config.CookieConfig.html | 14 +++---- docs/interfaces/config.NextConfig.html | 10 ++--- docs/interfaces/config.SessionConfig.html | 18 ++++----- .../handlers_callback.CallbackOptions.html | 10 ++--- .../handlers_login.AuthorizationParams.html | 12 +++--- .../handlers_login.LoginOptions.html | 8 ++-- .../handlers_logout.LogoutOptions.html | 6 +-- docs/interfaces/index.Auth0Server.html | 22 +++++----- ...n_get_access_token.AccessTokenRequest.html | 10 ++--- ...get_access_token.GetAccessTokenResult.html | 4 +- docs/interfaces/session_session.Claims.html | 2 +- docs/modules/client.html | 2 +- docs/modules/client_use_user.html | 2 +- .../client_with_page_auth_required.html | 2 +- docs/modules/config.html | 2 +- docs/modules/edge.html | 15 ++++--- docs/modules/handlers.html | 2 +- docs/modules/handlers_auth.html | 2 +- docs/modules/handlers_callback.html | 2 +- docs/modules/handlers_login.html | 2 +- docs/modules/handlers_logout.html | 2 +- docs/modules/handlers_profile.html | 2 +- docs/modules/helpers.html | 2 +- docs/modules/helpers_testing.html | 2 +- .../helpers_with_api_auth_required.html | 2 +- ...helpers_with_middleware_auth_required.html | 2 +- .../helpers_with_page_auth_required.html | 2 +- docs/modules/index.html | 2 +- docs/modules/session.html | 2 +- docs/modules/session_get_access_token.html | 2 +- docs/modules/session_get_session.html | 2 +- docs/modules/session_session.html | 2 +- docs/modules/session_update_session.html | 2 +- docs/modules/utils_errors.html | 2 +- docs/modules/version.html | 2 +- docs/types/client_use_user.UserContext.html | 4 +- docs/types/client_use_user.UserProvider.html | 2 +- .../client_use_user.UserProviderProps.html | 2 +- ...ge_auth_required.WithPageAuthRequired.html | 2 +- docs/types/config.ConfigParameters.html | 2 +- docs/types/edge.Auth0Edge.html | 2 +- docs/types/edge.GetSession.html | 14 +++++-- docs/types/edge.InitAuth0.html | 2 +- docs/types/handlers_auth.HandleAuth.html | 2 +- docs/types/handlers_auth.Handlers.html | 2 +- docs/types/handlers_auth.OnError.html | 2 +- .../handlers_callback.AfterCallback.html | 2 +- .../handlers_callback.CallbackHandler.html | 2 +- ...lers_callback.CallbackOptionsProvider.html | 2 +- .../handlers_callback.HandleCallback.html | 2 +- docs/types/handlers_login.GetLoginState.html | 2 +- docs/types/handlers_login.HandleLogin.html | 2 +- docs/types/handlers_login.LoginHandler.html | 2 +- .../handlers_login.LoginOptionsProvider.html | 2 +- docs/types/handlers_logout.HandleLogout.html | 2 +- docs/types/handlers_logout.LogoutHandler.html | 2 +- ...handlers_logout.LogoutOptionsProvider.html | 2 +- docs/types/handlers_profile.AfterRefetch.html | 2 +- .../types/handlers_profile.HandleProfile.html | 2 +- .../handlers_profile.ProfileHandler.html | 2 +- .../handlers_profile.ProfileOptions.html | 2 +- ...ndlers_profile.ProfileOptionsProvider.html | 2 +- ...s_testing.GenerateSessionCookieConfig.html | 2 +- ...api_auth_required.WithApiAuthRequired.html | 2 +- ...h_required.WithMiddlewareAuthRequired.html | 2 +- ...d.GetServerSidePropsResultWithSession.html | 2 +- ...ers_with_page_auth_required.PageRoute.html | 2 +- ...ge_auth_required.WithPageAuthRequired.html | 2 +- ..._required.WithPageAuthRequiredOptions.html | 2 +- docs/types/index.InitAuth0.html | 2 +- docs/types/index.SessionStore.html | 2 +- docs/types/index.SessionStorePayload.html | 2 +- ...session_get_access_token.AfterRefresh.html | 2 +- ...ssion_get_access_token.GetAccessToken.html | 2 +- .../types/session_get_session.GetSession.html | 12 ++++-- .../session_update_session.UpdateSession.html | 2 +- docs/variables/version.default.html | 2 +- src/edge.ts | 14 ++++++- src/session/get-session.ts | 2 +- 112 files changed, 305 insertions(+), 272 deletions(-) diff --git a/docs/classes/client_use_user.RequestError.html b/docs/classes/client_use_user.RequestError.html index 5790c02d5..507ecc7e6 100644 --- a/docs/classes/client_use_user.RequestError.html +++ b/docs/classes/client_use_user.RequestError.html @@ -30,7 +30,7 @@

Hierarchy

+
  • Defined in client/use-user.tsx:46
    • @@ -59,14 +59,14 @@
    status: number

    Returns RequestError

    +
  • Defined in client/use-user.tsx:49

    • Properties

    status

    status: number
    +
  • Defined in client/use-user.tsx:47
    • diff --git a/docs/classes/session_session.default.html b/docs/classes/session_session.default.html index ede1c5026..fa9dd0319 100644 --- a/docs/classes/session_session.default.html +++ b/docs/classes/session_session.default.html @@ -27,7 +27,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in session/session.ts:19
    • @@ -60,7 +60,7 @@

    Parameters

    user: Claims

    Returns default

    +
  • Defined in session/session.ts:55

    • Properties

    @@ -69,28 +69,28 @@

    Optional

    The access token.

    +
  • Defined in session/session.ts:33

    • Optional accessTokenExpiresAt

    accessTokenExpiresAt?: number

    The expiration of the access token.

    +
  • Defined in session/session.ts:43

    • Optional accessTokenScope

    accessTokenScope?: string

    The access token scopes.

    +
  • Defined in session/session.ts:38

    • Optional idToken

    idToken?: string

    The ID token.

    +
  • Defined in session/session.ts:28

    • Optional refreshToken

    refreshToken?: string
    @@ -99,14 +99,14 @@

    Optional

    +
  • Defined in session/session.ts:51

    • user

    user: Claims

    Any of the claims from the id_token.

    +
  • Defined in session/session.ts:23
    • diff --git a/docs/classes/utils_errors.AccessTokenError.html b/docs/classes/utils_errors.AccessTokenError.html index 2863b5cb6..dfcc3a80d 100644 --- a/docs/classes/utils_errors.AccessTokenError.html +++ b/docs/classes/utils_errors.AccessTokenError.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccessTokenError
    +
  • Defined in utils/errors.ts:99
    • @@ -70,7 +70,7 @@
    Optional cause: Returns AccessTokenError
    +
  • Defined in utils/errors.ts:100

    • Properties

    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -95,7 +95,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -103,7 +103,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in utils/errors.ts:62
    • diff --git a/docs/classes/utils_errors.AuthError.html b/docs/classes/utils_errors.AuthError.html index 9c2c85222..4c976dff1 100644 --- a/docs/classes/utils_errors.AuthError.html +++ b/docs/classes/utils_errors.AuthError.html @@ -35,7 +35,7 @@

    Hierarchy

  • AccessTokenError
  • HandlerError
    • +
  • Defined in utils/errors.ts:34
    • @@ -67,7 +67,7 @@
    options: AuthErrorOptions
    <

    Returns AuthError

    +
  • Defined in utils/errors.ts:64

    • Properties

    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -90,7 +90,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -98,14 +98,14 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number

    The HTTP status code, if any.

    +
  • Defined in utils/errors.ts:62
    • diff --git a/docs/classes/utils_errors.CallbackHandlerError.html b/docs/classes/utils_errors.CallbackHandlerError.html index fb94d77ba..f781ebf9e 100644 --- a/docs/classes/utils_errors.CallbackHandlerError.html +++ b/docs/classes/utils_errors.CallbackHandlerError.html @@ -40,7 +40,7 @@

    Hierarchy

    • CallbackHandlerError
    +
  • Defined in utils/errors.ts:171
    • @@ -73,7 +73,7 @@
    cause: HandlerErrorCause
    Returns CallbackHandlerError
    +
  • Defined in utils/errors.ts:174

    • Properties

    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -98,7 +98,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -106,7 +106,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -114,12 +114,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_CALLBACK_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:172
    • diff --git a/docs/classes/utils_errors.HandlerError.html b/docs/classes/utils_errors.HandlerError.html index 7e6d16030..104e4a14f 100644 --- a/docs/classes/utils_errors.HandlerError.html +++ b/docs/classes/utils_errors.HandlerError.html @@ -45,7 +45,7 @@

    Hierarchy

  • LogoutHandlerError
  • ProfileHandlerError
    • +
  • Defined in utils/errors.ts:142
    • @@ -77,7 +77,7 @@
    options: HandlerErrorOptions
    Returns HandlerError
    +
  • Defined in utils/errors.ts:143

    • Properties

    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -102,7 +102,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -110,7 +110,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in utils/errors.ts:62
    • diff --git a/docs/classes/utils_errors.LoginHandlerError.html b/docs/classes/utils_errors.LoginHandlerError.html index 35901f372..16089e0dd 100644 --- a/docs/classes/utils_errors.LoginHandlerError.html +++ b/docs/classes/utils_errors.LoginHandlerError.html @@ -28,7 +28,7 @@

    Hierarchy

    • LoginHandlerError
    +
  • Defined in utils/errors.ts:191
    • @@ -61,7 +61,7 @@
    cause: HandlerErrorCause
    Returns LoginHandlerError
    +
  • Defined in utils/errors.ts:194

    • Properties

    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -86,7 +86,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -102,12 +102,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_LOGIN_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:192
    • diff --git a/docs/classes/utils_errors.LogoutHandlerError.html b/docs/classes/utils_errors.LogoutHandlerError.html index f3b679ac7..54d8e9e76 100644 --- a/docs/classes/utils_errors.LogoutHandlerError.html +++ b/docs/classes/utils_errors.LogoutHandlerError.html @@ -28,7 +28,7 @@

    Hierarchy

    • LogoutHandlerError
    +
  • Defined in utils/errors.ts:211
    • @@ -61,7 +61,7 @@
    cause: HandlerErrorCause
    Returns LogoutHandlerError
    +
  • Defined in utils/errors.ts:214

    • Properties

    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -86,7 +86,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -102,12 +102,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_LOGOUT_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:212
    • diff --git a/docs/classes/utils_errors.ProfileHandlerError.html b/docs/classes/utils_errors.ProfileHandlerError.html index fc732035a..0f4a68c7f 100644 --- a/docs/classes/utils_errors.ProfileHandlerError.html +++ b/docs/classes/utils_errors.ProfileHandlerError.html @@ -28,7 +28,7 @@

    Hierarchy

    • ProfileHandlerError
    +
  • Defined in utils/errors.ts:231
    • @@ -61,7 +61,7 @@
    cause: HandlerErrorCause
    Returns ProfileHandlerError
    +
  • Defined in utils/errors.ts:234

    • Properties

    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -86,7 +86,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -102,12 +102,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_PROFILE_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:232
    • diff --git a/docs/enums/utils_errors.AccessTokenErrorCode.html b/docs/enums/utils_errors.AccessTokenErrorCode.html index 474758854..4461c3ed6 100644 --- a/docs/enums/utils_errors.AccessTokenErrorCode.html +++ b/docs/enums/utils_errors.AccessTokenErrorCode.html @@ -20,7 +20,7 @@

    Enumeration AccessTokenErrorCode

    Error codes for AccessTokenError.

    +
  • Defined in utils/errors.ts:79
    • @@ -41,32 +41,32 @@

    Enumeration Members

    EXPIRED_ACCESS_TOKEN

    EXPIRED_ACCESS_TOKEN: "ERR_EXPIRED_ACCESS_TOKEN"
    +
  • Defined in utils/errors.ts:83

    • FAILED_REFRESH_GRANT

    FAILED_REFRESH_GRANT: "ERR_FAILED_REFRESH_GRANT"
    +
  • Defined in utils/errors.ts:85

    • INSUFFICIENT_SCOPE

    INSUFFICIENT_SCOPE: "ERR_INSUFFICIENT_SCOPE"
    +
  • Defined in utils/errors.ts:84

    • MISSING_ACCESS_TOKEN

    MISSING_ACCESS_TOKEN: "ERR_MISSING_ACCESS_TOKEN"
    +
  • Defined in utils/errors.ts:81

    • MISSING_REFRESH_TOKEN

    MISSING_REFRESH_TOKEN: "ERR_MISSING_REFRESH_TOKEN"
    +
  • Defined in utils/errors.ts:82

    • MISSING_SESSION

    MISSING_SESSION: "ERR_MISSING_SESSION"
    +
  • Defined in utils/errors.ts:80
    • diff --git a/docs/functions/client_use_user.default.html b/docs/functions/client_use_user.default.html index 091b4adc6..20933ae3c 100644 --- a/docs/functions/client_use_user.default.html +++ b/docs/functions/client_use_user.default.html @@ -27,7 +27,7 @@

    Parameters

    __namedParameters: UserProviderProps

    Returns ReactElement<UserContext, string | JSXElementConstructor<any>>

    +
  • Defined in client/use-user.tsx:190
    • diff --git a/docs/functions/client_use_user.useUser.html b/docs/functions/client_use_user.useUser.html index 4dad08366..34e85f240 100644 --- a/docs/functions/client_use_user.useUser.html +++ b/docs/functions/client_use_user.useUser.html @@ -27,7 +27,7 @@

    Function useUser

    Returns UserContext

    +
  • Defined in client/use-user.tsx:134
    • diff --git a/docs/functions/edge.getSession-1.html b/docs/functions/edge.getSession-1.html index 0ee9c2b2c..bdc9e50a7 100644 --- a/docs/functions/edge.getSession-1.html +++ b/docs/functions/edge.getSession-1.html @@ -18,18 +18,24 @@

    Function getSession

      - +
    • +

      Get the user's session from the request.

      +

      Parameters

      • req: NextRequest
      • -
        res: NextResponse
      +
      res: NextResponse
      • +
    • +
      Optional touchSession: boolean
      +

      If false, the session will not be updated. Defaults to true.

      +

    Returns Promise<undefined | null | default>

    +
  • Defined in edge.ts:22
    • diff --git a/docs/functions/edge.initAuth0-1.html b/docs/functions/edge.initAuth0-1.html index ab88c3872..841abb57c 100644 --- a/docs/functions/edge.initAuth0-1.html +++ b/docs/functions/edge.initAuth0-1.html @@ -27,7 +27,7 @@

    Parameters

    Optional params: DeepPartial<BaseConfig & NextConfig>

    Returns Auth0Edge

    +
  • Defined in edge.ts:28
    • diff --git a/docs/functions/edge.withMiddlewareAuthRequired-1.html b/docs/functions/edge.withMiddlewareAuthRequired-1.html index 6127499e6..d14781a5c 100644 --- a/docs/functions/edge.withMiddlewareAuthRequired-1.html +++ b/docs/functions/edge.withMiddlewareAuthRequired-1.html @@ -39,7 +39,7 @@

    Parameters

    Optional middleware: NextMiddleware

    Returns NextMiddleware

    +
  • Defined in helpers/with-middleware-auth-required.ts:46
    • diff --git a/docs/functions/helpers_testing.generateSessionCookie.html b/docs/functions/helpers_testing.generateSessionCookie.html index 90947ce6a..5544daeb5 100644 --- a/docs/functions/helpers_testing.generateSessionCookie.html +++ b/docs/functions/helpers_testing.generateSessionCookie.html @@ -29,7 +29,7 @@
    session: PartialGenerateSessionCookieConfig

    Returns Promise<string>

    +
  • Defined in helpers/testing.ts:23
    • diff --git a/docs/functions/index._initAuth.html b/docs/functions/index._initAuth.html index bdc6277b7..1c0b839e6 100644 --- a/docs/functions/index._initAuth.html +++ b/docs/functions/index._initAuth.html @@ -27,7 +27,7 @@

    Parameters

    Optional params: DeepPartial<BaseConfig & NextConfig>

    Returns Auth0Server & {
        sessionCache: default<IncomingMessage | NextApiRequest, ServerResponse<IncomingMessage> | NextApiResponse<any>>;
    }

    +
  • Defined in index.ts:154
    • diff --git a/docs/functions/index.getAccessToken-1.html b/docs/functions/index.getAccessToken-1.html index 48d48d459..2e2e8f198 100644 --- a/docs/functions/index.getAccessToken-1.html +++ b/docs/functions/index.getAccessToken-1.html @@ -35,7 +35,7 @@
    res: ServerResponseOptional accessTokenRequest: AccessTokenRequest

    Returns Promise<GetAccessTokenResult>

    +
  • Defined in session/get-access-token.ts:86
    • diff --git a/docs/functions/index.getSession-1.html b/docs/functions/index.getSession-1.html index 17932b47c..0ccb4d8af 100644 --- a/docs/functions/index.getSession-1.html +++ b/docs/functions/index.getSession-1.html @@ -18,7 +18,7 @@

    Function getSession

      - +

    • Get the user's session from the request.

      @@ -28,10 +28,14 @@

      Parameters

    • req: IncomingMessage | NextApiRequest
    • -
      res: ServerResponse<IncomingMessage> | NextApiResponse<any>
    +
    res: ServerResponse<IncomingMessage> | NextApiResponse<any>
    +
  • +
    Optional touchSession: boolean
    +

    If false, the session will not be updated. Defaults to true.

    +

    • Returns Promise<undefined | null | default>

    +
  • Defined in session/get-session.ts:12
    • diff --git a/docs/functions/index.handleAuth-1.html b/docs/functions/index.handleAuth-1.html index 9d629c41e..b565f2d5f 100644 --- a/docs/functions/index.handleAuth-1.html +++ b/docs/functions/index.handleAuth-1.html @@ -41,7 +41,7 @@

    Parameters

    Optional userHandlers: Handlers

    Returns NextApiHandler<any>

    +
  • Defined in handlers/auth.ts:94
    • diff --git a/docs/functions/index.handleCallback-1.html b/docs/functions/index.handleCallback-1.html index e6b5ee7a6..115dbd74d 100644 --- a/docs/functions/index.handleCallback-1.html +++ b/docs/functions/index.handleCallback-1.html @@ -31,7 +31,7 @@
    res: NextApiResponseOptional options: CallbackOptions

    Returns Promise<void>

    +
  • Defined in handlers/callback.ts:185
  • @@ -41,7 +41,7 @@

    Parameters

    provider: CallbackOptionsProvider

    • Returns CallbackHandler

    +
  • Defined in handlers/callback.ts:186
  • @@ -51,7 +51,7 @@

    Parameters

    options: CallbackOptions

    • Returns CallbackHandler

    +
  • Defined in handlers/callback.ts:187
    • diff --git a/docs/functions/index.handleLogin-1.html b/docs/functions/index.handleLogin-1.html index dbab482c6..b632acd01 100644 --- a/docs/functions/index.handleLogin-1.html +++ b/docs/functions/index.handleLogin-1.html @@ -31,7 +31,7 @@
    res: NextApiResponseOptional options: LoginOptions

    Returns Promise<void>

    +
  • Defined in handlers/login.ts:224
  • @@ -41,7 +41,7 @@

    Parameters

    provider: LoginOptionsProvider

    • Returns LoginHandler

    +
  • Defined in handlers/login.ts:225
  • @@ -51,7 +51,7 @@

    Parameters

    options: LoginOptions

    • Returns LoginHandler

    +
  • Defined in handlers/login.ts:226
    • diff --git a/docs/functions/index.handleLogout-1.html b/docs/functions/index.handleLogout-1.html index 9c01e3632..1d1f108e7 100644 --- a/docs/functions/index.handleLogout-1.html +++ b/docs/functions/index.handleLogout-1.html @@ -31,7 +31,7 @@
    res: NextApiResponseOptional options: LogoutOptions

    Returns Promise<void>

    +
  • Defined in handlers/logout.ts:86
  • @@ -41,7 +41,7 @@

    Parameters

    provider: LogoutOptionsProvider

    • Returns LogoutHandler

    +
  • Defined in handlers/logout.ts:87
  • @@ -51,7 +51,7 @@

    Parameters

    options: LogoutOptions

    • Returns LogoutHandler

    +
  • Defined in handlers/logout.ts:88
    • diff --git a/docs/functions/index.handleProfile-1.html b/docs/functions/index.handleProfile-1.html index 4c4e1e660..388101768 100644 --- a/docs/functions/index.handleProfile-1.html +++ b/docs/functions/index.handleProfile-1.html @@ -31,7 +31,7 @@
    res: NextApiResponseOptional options: ProfileOptions

    Returns Promise<void>

    +
  • Defined in handlers/profile.ts:89
  • @@ -41,7 +41,7 @@

    Parameters

    provider: ProfileOptionsProvider

    • Returns ProfileHandler

    +
  • Defined in handlers/profile.ts:90
  • @@ -51,7 +51,7 @@

    Parameters

    options: ProfileOptions

    • Returns ProfileHandler

    +
  • Defined in handlers/profile.ts:91
    • diff --git a/docs/functions/index.initAuth0-1.html b/docs/functions/index.initAuth0-1.html index af270b2db..e03bcfb55 100644 --- a/docs/functions/index.initAuth0-1.html +++ b/docs/functions/index.initAuth0-1.html @@ -30,7 +30,7 @@

    Parameters

    Optional params: DeepPartial<BaseConfig & NextConfig>

    Returns Auth0Server

    +
  • Defined in index.ts:131
    • diff --git a/docs/functions/index.updateSession-1.html b/docs/functions/index.updateSession-1.html index a621bf7ae..66cd2acb5 100644 --- a/docs/functions/index.updateSession-1.html +++ b/docs/functions/index.updateSession-1.html @@ -37,7 +37,7 @@
    res: ServerResponsedefault

    Returns Promise<void>

    +
  • Defined in session/update-session.ts:27
    • diff --git a/docs/functions/index.withApiAuthRequired-1.html b/docs/functions/index.withApiAuthRequired-1.html index 6810fb297..fa245d061 100644 --- a/docs/functions/index.withApiAuthRequired-1.html +++ b/docs/functions/index.withApiAuthRequired-1.html @@ -33,7 +33,7 @@

    Parameters

    apiRoute: NextApiHandler<any>

    Returns NextApiHandler<any>

    +
  • Defined in helpers/with-api-auth-required.ts:23
    • diff --git a/docs/functions/index.withPageAuthRequired-1.html b/docs/functions/index.withPageAuthRequired-1.html index a74808b54..340fde34d 100644 --- a/docs/functions/index.withPageAuthRequired-1.html +++ b/docs/functions/index.withPageAuthRequired-1.html @@ -41,7 +41,7 @@

    Parameters

    Optional opts: WithPageAuthRequiredOptions<P, Q>

    Returns PageRoute<P, Q>

    +
  • Defined in helpers/with-page-auth-required.ts:93
    • diff --git a/docs/interfaces/client_use_user.UserProfile.html b/docs/interfaces/client_use_user.UserProfile.html index c49418142..5f665cd90 100644 --- a/docs/interfaces/client_use_user.UserProfile.html +++ b/docs/interfaces/client_use_user.UserProfile.html @@ -27,7 +27,7 @@

    Hierarchy

    Indexable

    [key: string]: unknown
    +
  • Defined in client/use-user.tsx:11
    • @@ -50,42 +50,42 @@

    Properties

    Optional email

    email?: null | string
    +
  • Defined in client/use-user.tsx:12

    • Optional email_verified

    email_verified?: null | boolean
    +
  • Defined in client/use-user.tsx:13

    • Optional name

    name?: null | string
    +
  • Defined in client/use-user.tsx:14

    • Optional nickname

    nickname?: null | string
    +
  • Defined in client/use-user.tsx:15

    • Optional org_id

    org_id?: null | string
    +
  • Defined in client/use-user.tsx:19

    • Optional picture

    picture?: null | string
    +
  • Defined in client/use-user.tsx:16

    • Optional sub

    sub?: null | string
    +
  • Defined in client/use-user.tsx:17

    • Optional updated_at

    updated_at?: null | string
    +
  • Defined in client/use-user.tsx:18
    • diff --git a/docs/interfaces/client_with_page_auth_required.UserProps.html b/docs/interfaces/client_with_page_auth_required.UserProps.html index 19a7594ce..21f6a396a 100644 --- a/docs/interfaces/client_with_page_auth_required.UserProps.html +++ b/docs/interfaces/client_with_page_auth_required.UserProps.html @@ -21,7 +21,7 @@

    Hierarchy

    • UserProps
    +
  • Defined in client/with-page-auth-required.tsx:62
    • @@ -37,7 +37,7 @@

    Properties

    user

    user: UserProfile
    +
  • Defined in client/with-page-auth-required.tsx:63
    • diff --git a/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html b/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html index 662f43683..e459c4fc8 100644 --- a/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html +++ b/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    • WithPageAuthRequiredOptions
    +
  • Defined in client/with-page-auth-required.tsx:22
    • @@ -59,7 +59,7 @@

    Parameters

    error: Error

    Returns Element

    +
  • Defined in client/with-page-auth-required.tsx:52

    • Optional onRedirecting

    onRedirecting?: (() => Element)
    @@ -76,7 +76,7 @@

    Type declaration

    Returns Element

    +
  • Defined in client/with-page-auth-required.tsx:42

    • Optional returnTo

    returnTo?: string
    @@ -85,7 +85,7 @@

    OptionalAdd a path to return the user to after login.

    +
  • Defined in client/with-page-auth-required.tsx:32
    • diff --git a/docs/interfaces/config.AuthorizationParameters.html b/docs/interfaces/config.AuthorizationParameters.html index 910ebc5c8..752d8f6dc 100644 --- a/docs/interfaces/config.AuthorizationParameters.html +++ b/docs/interfaces/config.AuthorizationParameters.html @@ -27,7 +27,7 @@

    Hierarchy

    • AuthorizationParameters
    +
  • Defined in config.ts:317
    • @@ -46,13 +46,13 @@

    response_moderesponse_mode: "query" | "form_post"

    +
  • Defined in config.ts:325

    • response_type

    response_type: "id_token" | "code id_token" | "code"
    +
  • Defined in config.ts:326

    • scope

    scope: string
    @@ -62,7 +62,7 @@

    scope

    Overrides OidcAuthorizationParameters.scope

    +
  • Defined in config.ts:323
    • diff --git a/docs/interfaces/config.BaseConfig.html b/docs/interfaces/config.BaseConfig.html index 9a1ab66d4..a54e06d93 100644 --- a/docs/interfaces/config.BaseConfig.html +++ b/docs/interfaces/config.BaseConfig.html @@ -21,7 +21,7 @@

    Hierarchy

    • BaseConfig
    +
  • Defined in config.ts:11
    • @@ -60,7 +60,7 @@

    OptionalAUTH0_LOGOUT environment variable.

    +
  • Defined in config.ts:32

    • authorizationParams

    authorizationParams: AuthorizationParameters
    @@ -75,7 +75,7 @@

    authorizationParams

    +
  • Defined in config.ts:62

    • baseURL

    baseURL: string
    @@ -85,7 +85,7 @@

    baseURL

    +
  • Defined in config.ts:70

    • Optional clientAssertionSigningAlg

    clientAssertionSigningAlg?: string
    @@ -96,7 +96,7 @@

    OptionalAUTH0_CLIENT_ASSERTION_SIGNING_ALG environment variable.

    +
  • Defined in config.ts:192

    • Optional clientAssertionSigningKey

    clientAssertionSigningKey?: string
    @@ -105,7 +105,7 @@

    OptionalAUTH0_CLIENT_ASSERTION_SIGNING_KEY environment variable.

    +
  • Defined in config.ts:183

    • clientID

    clientID: string
    @@ -113,7 +113,7 @@

    clientIDAUTH0_CLIENT_ID environment variable.

    +
  • Defined in config.ts:76

    • Optional clientSecret

    clientSecret?: string
    @@ -122,14 +122,14 @@

    OptionalAUTH0_CLIENT_SECRET environment variable.

    +
  • Defined in config.ts:83

    • clockTolerance

    clockTolerance: number

    Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.Defaults to60seconds. You can also use theAUTH0_CLOCK_TOLERANCE` environment variable.

    +
  • Defined in config.ts:90

    • enableTelemetry

    enableTelemetry: boolean
    @@ -138,7 +138,7 @@

    enableTelemetry

    +
  • Defined in config.ts:104

    • getLoginState

    getLoginState: ((req: IncomingMessage, options: LoginOptions) => Record<string, any>)
    @@ -164,7 +164,7 @@
    req: IncomingMessage
    options: LoginOptions

    Returns Record<string, any>

    +
  • Defined in config.ts:123

    • httpTimeout

    httpTimeout: number
    @@ -173,7 +173,7 @@

    httpTimeoutAUTH0_HTTP_TIMEOUT environment variable.

    +
  • Defined in config.ts:97

    • idTokenSigningAlg

    idTokenSigningAlg: string
    @@ -181,7 +181,7 @@

    idTokenSigningAlgAUTH0_ID_TOKEN_SIGNING_ALG environment variable.

    +
  • Defined in config.ts:142

    • identityClaimFilter

    identityClaimFilter: string[]
    @@ -190,7 +190,7 @@

    identityClaimFilterAUTH0_IDENTITY_CLAIM_FILTER environment variable.

    +
  • Defined in config.ts:130

    • idpLogout

    idpLogout: boolean
    @@ -198,7 +198,7 @@

    idpLogoutAUTH0_IDP_LOGOUT environment variable.

    +
  • Defined in config.ts:136

    • issuerBaseURL

    issuerBaseURL: string
    @@ -207,7 +207,7 @@

    issuerBaseURL

    +
  • Defined in config.ts:149

    • legacySameSiteCookie

    legacySameSiteCookie: boolean
    @@ -216,7 +216,7 @@

    legacySameSiteCookie< You can also use the AUTH0_LEGACY_SAME_SITE_COOKIE environment variable.

    +
  • Defined in config.ts:156

    • routes

    routes: {
        callback: string;
        postLogoutRedirect: string;
    }
    @@ -239,7 +239,7 @@
    postLogoutRedirect: AUTH0_POST_LOGOUT_REDIRECT environment variable.

    +
  • Defined in config.ts:161

    • secret

    secret: string | string[]
    @@ -250,14 +250,14 @@

    secret

    +
  • Defined in config.ts:19

    • session

    session: SessionConfig

    Object defining application session cookie attributes.

    +
  • Defined in config.ts:24
    • diff --git a/docs/interfaces/config.CookieConfig.html b/docs/interfaces/config.CookieConfig.html index 987896d54..8e08ca415 100644 --- a/docs/interfaces/config.CookieConfig.html +++ b/docs/interfaces/config.CookieConfig.html @@ -24,7 +24,7 @@

    Hierarchy

    • CookieConfig
    +
  • Defined in config.ts:266
    • @@ -48,7 +48,7 @@

    OptionalAUTH0_COOKIE_DOMAIN environment variable.

    +
  • Defined in config.ts:271

    • httpOnly

    httpOnly: boolean
    @@ -57,7 +57,7 @@

    httpOnlyAUTH0_COOKIE_HTTP_ONLY environment variable.

    +
  • Defined in config.ts:293

    • Optional path

    path?: string
    @@ -67,7 +67,7 @@

    OptionalAUTH0_COOKIE_PATH environment variable.

    +
  • Defined in config.ts:279

    • sameSite

    sameSite: "lax" | "strict" | "none"
    @@ -76,7 +76,7 @@

    sameSiteAUTH0_COOKIE_SAME_SITE environment variable.

    +
  • Defined in config.ts:307

    • Optional secure

    secure?: boolean
    @@ -85,7 +85,7 @@

    OptionalAUTH0_COOKIE_SECURE environment variable.

    +
  • Defined in config.ts:300

    • transient

    transient: boolean
    @@ -94,7 +94,7 @@

    transientAUTH0_COOKIE_TRANSIENT environment variable.

    +
  • Defined in config.ts:286
    • diff --git a/docs/interfaces/config.NextConfig.html b/docs/interfaces/config.NextConfig.html index 51a4e7ef1..020f601fb 100644 --- a/docs/interfaces/config.NextConfig.html +++ b/docs/interfaces/config.NextConfig.html @@ -23,7 +23,7 @@

    Hierarchy

    • NextConfig
    +
  • Defined in config.ts:332
    • @@ -47,7 +47,7 @@

    identityClaimFilter

    +
  • Defined in config.ts:130

    • Optional organization

    organization?: string
    @@ -57,7 +57,7 @@

    OptionalIf your app supports multiple organizations, you should take a look at AuthorizationParams.organization.

    +
  • Defined in config.ts:341

    • routes

    routes: {
        callback: string;
        login: string;
        unauthorized: string;
    }
    @@ -71,12 +71,12 @@
    login:
    unauthorized: string
    +
  • Defined in config.ts:342

    • session

    session: Pick<SessionConfig, "storeIDToken">
    +
  • Defined in config.ts:347
    • diff --git a/docs/interfaces/config.SessionConfig.html b/docs/interfaces/config.SessionConfig.html index 17633f813..ce542174e 100644 --- a/docs/interfaces/config.SessionConfig.html +++ b/docs/interfaces/config.SessionConfig.html @@ -24,7 +24,7 @@

    Hierarchy

    • SessionConfig
    +
  • Defined in config.ts:200
    • @@ -53,12 +53,12 @@

    absoluteDuration

    +
  • Defined in config.ts:249

    • cookie

    cookie: CookieConfig
    +
  • Defined in config.ts:258

    • Optional genId

    genId?: (<Req>(req: Req) => string | Promise<string>)
    @@ -85,7 +85,7 @@

    Parameters

    req: Req

    Returns string | Promise<string>

    +
  • Defined in config.ts:221

    • name

    name: string
    @@ -95,7 +95,7 @@

    name

    +
  • Defined in config.ts:207

    • rolling

    rolling: boolean
    @@ -107,7 +107,7 @@

    rolling

    +
  • Defined in config.ts:231

    • rollingDuration

    rollingDuration: number | false
    @@ -118,7 +118,7 @@

    rollingDuration

    +
  • Defined in config.ts:240

    • Optional store

    store?: SessionStore<default>
    @@ -126,7 +126,7 @@

    Optionalget, set and destroy methods to store the session on the server.

    +
  • Defined in config.ts:213

    • storeIDToken

    storeIDToken: boolean
    @@ -135,7 +135,7 @@

    storeIDTokentrue.

    +
  • Defined in config.ts:256
    • diff --git a/docs/interfaces/handlers_callback.CallbackOptions.html b/docs/interfaces/handlers_callback.CallbackOptions.html index 88588caed..2f4333deb 100644 --- a/docs/interfaces/handlers_callback.CallbackOptions.html +++ b/docs/interfaces/handlers_callback.CallbackOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • CallbackOptions
    +
  • Defined in handlers/callback.ts:104
    • @@ -45,7 +45,7 @@

    Properties

    Optional afterCallback

    afterCallback?: AfterCallback
    +
  • Defined in handlers/callback.ts:105

    • Optional authorizationParams

    authorizationParams?: Partial<AuthorizationParameters>
    @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in handlers/callback.ts:123

    • Optional organization

    organization?: string
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in handlers/callback.ts:117

    • Optional redirectUri

    redirectUri?: string
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in handlers/callback.ts:111
    • diff --git a/docs/interfaces/handlers_login.AuthorizationParams.html b/docs/interfaces/handlers_login.AuthorizationParams.html index f4667bcdc..2ae73d0d0 100644 --- a/docs/interfaces/handlers_login.AuthorizationParams.html +++ b/docs/interfaces/handlers_login.AuthorizationParams.html @@ -26,7 +26,7 @@

    Hierarchy

    • AuthorizationParams
    +
  • Defined in handlers/login.ts:40
    • @@ -52,7 +52,7 @@

    Optional

    +
  • Defined in handlers/login.ts:63

    • Optional connection_scope

    connection_scope?: string
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in handlers/login.ts:87

    • Optional invitation

    invitation?: string
    @@ -74,7 +74,7 @@

    Optionalhttps://example.com/api/invite?invitation=invitation_id&organization=org_id.

    +
  • Defined in handlers/login.ts:120

    • Optional organization

    organization?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in handlers/login.ts:126

    • Optional screen_hint

    screen_hint?: string
    @@ -91,7 +91,7 @@

    OptionalThis only affects the New Universal Login Experience.

    +
  • Defined in handlers/login.ts:134
    • diff --git a/docs/interfaces/handlers_login.LoginOptions.html b/docs/interfaces/handlers_login.LoginOptions.html index 77b98821a..5f1a1293f 100644 --- a/docs/interfaces/handlers_login.LoginOptions.html +++ b/docs/interfaces/handlers_login.LoginOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • LoginOptions
    +
  • Defined in handlers/login.ts:144
    • @@ -46,21 +46,21 @@

    Optional

    Override the default BaseConfig.authorizationParams authorizationParams.

    +
  • Defined in handlers/login.ts:148

    • Optional getLoginState

    getLoginState?: GetLoginState

    Generate a unique state value for use during login transactions.

    +
  • Defined in handlers/login.ts:158

    • Optional returnTo

    returnTo?: string

    URL to return to after login. Overrides the default in BaseConfig.baseURL.

    +
  • Defined in handlers/login.ts:153
    • diff --git a/docs/interfaces/handlers_logout.LogoutOptions.html b/docs/interfaces/handlers_logout.LogoutOptions.html index 85ae41d21..1739d993e 100644 --- a/docs/interfaces/handlers_logout.LogoutOptions.html +++ b/docs/interfaces/handlers_logout.LogoutOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • LogoutOptions
    +
  • Defined in handlers/logout.ts:14
    • @@ -50,7 +50,7 @@

    Type declaration

  • [key: string]: any
    • +
  • Defined in handlers/logout.ts:24

    • Optional returnTo

    returnTo?: string
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in handlers/logout.ts:19
    • diff --git a/docs/interfaces/index.Auth0Server.html b/docs/interfaces/index.Auth0Server.html index 72327d021..e4f9ab1cc 100644 --- a/docs/interfaces/index.Auth0Server.html +++ b/docs/interfaces/index.Auth0Server.html @@ -26,7 +26,7 @@

    Hierarchy

    • Auth0Server
    +
  • Defined in index.ts:72
    • @@ -53,70 +53,70 @@

    getAccessToken

    Access token getter.

    +
  • Defined in index.ts:86

    • getSession

    getSession: GetSession

    Session getter.

    +
  • Defined in index.ts:76

    • handleAuth

    handleAuth: HandleAuth

    Create the main handlers for your api routes.

    +
  • Defined in index.ts:121

    • handleCallback

    handleCallback: HandleCallback

    Callback handler which will complete the transaction and create a local session.

    +
  • Defined in index.ts:96

    • handleLogin

    handleLogin: HandleLogin

    Login handler which will redirect the user to Auth0.

    +
  • Defined in index.ts:91

    • handleLogout

    handleLogout: HandleLogout

    Logout handler which will clear the local session and the Auth0 session.

    +
  • Defined in index.ts:101

    • handleProfile

    handleProfile: HandleProfile

    Profile handler which return profile information about the user.

    +
  • Defined in index.ts:106

    • updateSession

    updateSession: UpdateSession

    Append properties to the user.

    +
  • Defined in index.ts:81

    • withApiAuthRequired

    withApiAuthRequired: WithApiAuthRequired

    Helper that adds auth to an API route.

    +
  • Defined in index.ts:111

    • withPageAuthRequired

    withPageAuthRequired: WithPageAuthRequired

    Helper that adds auth to a Page route.

    +
  • Defined in index.ts:116
    • diff --git a/docs/interfaces/session_get_access_token.AccessTokenRequest.html b/docs/interfaces/session_get_access_token.AccessTokenRequest.html index 4f91aa1a9..7c8101413 100644 --- a/docs/interfaces/session_get_access_token.AccessTokenRequest.html +++ b/docs/interfaces/session_get_access_token.AccessTokenRequest.html @@ -24,7 +24,7 @@

    Hierarchy

    • AccessTokenRequest
    +
  • Defined in session/get-access-token.ts:17
    • @@ -53,14 +53,14 @@

    Example

    Modify the session after refresh

    +
  • Defined in session/get-access-token.ts:59

    • Optional authorizationParams

    authorizationParams?: Partial<AuthorizationParameters>

    This is useful for sending custom query parameters in the body of the refresh grant request for use in rules.

    +
  • Defined in session/get-access-token.ts:64

    • Optional refresh

    refresh?: boolean
    @@ -70,14 +70,14 @@

    Optional

    +
  • Defined in session/get-access-token.ts:30

    • Optional scopes

    scopes?: string[]

    A list of desired scopes for your access token.

    +
  • Defined in session/get-access-token.ts:21
    • diff --git a/docs/interfaces/session_get_access_token.GetAccessTokenResult.html b/docs/interfaces/session_get_access_token.GetAccessTokenResult.html index 7cf947d6c..d24d5baeb 100644 --- a/docs/interfaces/session_get_access_token.GetAccessTokenResult.html +++ b/docs/interfaces/session_get_access_token.GetAccessTokenResult.html @@ -24,7 +24,7 @@

    Hierarchy

    • GetAccessTokenResult
    +
  • Defined in session/get-access-token.ts:72
    • @@ -42,7 +42,7 @@

    Optional

    Access token returned from the token cache.

    +
  • Defined in session/get-access-token.ts:76
    • diff --git a/docs/interfaces/session_session.Claims.html b/docs/interfaces/session_session.Claims.html index 304a18202..1e068039f 100644 --- a/docs/interfaces/session_session.Claims.html +++ b/docs/interfaces/session_session.Claims.html @@ -27,7 +27,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in session/session.ts:10
    • diff --git a/docs/modules/client.html b/docs/modules/client.html index a455aacbe..cf61e38d2 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -16,7 +16,7 @@
  • client

    • Module client

    +
  • Defined in client/index.ts:1
    • diff --git a/docs/modules/client_use_user.html b/docs/modules/client_use_user.html index 80ae10fd9..0348e4392 100644 --- a/docs/modules/client_use_user.html +++ b/docs/modules/client_use_user.html @@ -16,7 +16,7 @@
  • client/use-user

    • Module client/use-user

    +
  • Defined in client/use-user.tsx:1
    • diff --git a/docs/modules/client_with_page_auth_required.html b/docs/modules/client_with_page_auth_required.html index 2f598a279..27e45bb6f 100644 --- a/docs/modules/client_with_page_auth_required.html +++ b/docs/modules/client_with_page_auth_required.html @@ -16,7 +16,7 @@
  • client/with-page-auth-required

    • Module client/with-page-auth-required

    +
  • Defined in client/with-page-auth-required.tsx:1
    • diff --git a/docs/modules/config.html b/docs/modules/config.html index c1d890593..1abe72df3 100644 --- a/docs/modules/config.html +++ b/docs/modules/config.html @@ -16,7 +16,7 @@
  • config

    • Module config

    +
  • Defined in config.ts:1
    • diff --git a/docs/modules/edge.html b/docs/modules/edge.html index 05a289299..65ad61b52 100644 --- a/docs/modules/edge.html +++ b/docs/modules/edge.html @@ -16,7 +16,7 @@
  • edge

    • Module edge

    +
  • Defined in edge.ts:1
    • @@ -29,19 +29,22 @@

    References

    WithMiddlewareAuthRequired
    -

    Type Aliases

    +

    Type Aliases - Other

    Auth0Edge -GetSession InitAuth0
    +

    Type Aliases - Server

    +
    GetSession +
    +

    Functions - Other

    -
    getSession -initAuth0 +
    initAuth0

    Functions - Server

    -
    withMiddlewareAuthRequired +
    getSession +withMiddlewareAuthRequired

    References

    diff --git a/docs/modules/handlers.html b/docs/modules/handlers.html index 57fbe1540..ecd21e46f 100644 --- a/docs/modules/handlers.html +++ b/docs/modules/handlers.html @@ -16,7 +16,7 @@
  • handlers

    • Module handlers

    +
  • Defined in handlers/index.ts:1
    • diff --git a/docs/modules/handlers_auth.html b/docs/modules/handlers_auth.html index f2ec0ddba..89da8a21a 100644 --- a/docs/modules/handlers_auth.html +++ b/docs/modules/handlers_auth.html @@ -16,7 +16,7 @@
  • handlers/auth

    • Module handlers/auth

    +
  • Defined in handlers/auth.ts:1
    • diff --git a/docs/modules/handlers_callback.html b/docs/modules/handlers_callback.html index 7fa9b9af5..3169b6e0a 100644 --- a/docs/modules/handlers_callback.html +++ b/docs/modules/handlers_callback.html @@ -16,7 +16,7 @@
  • handlers/callback

    • Module handlers/callback

    +
  • Defined in handlers/callback.ts:1
    • diff --git a/docs/modules/handlers_login.html b/docs/modules/handlers_login.html index 1dbb74ca7..2769fc437 100644 --- a/docs/modules/handlers_login.html +++ b/docs/modules/handlers_login.html @@ -16,7 +16,7 @@
  • handlers/login

    • Module handlers/login

    +
  • Defined in handlers/login.ts:1
    • diff --git a/docs/modules/handlers_logout.html b/docs/modules/handlers_logout.html index 276838c3f..f89685a36 100644 --- a/docs/modules/handlers_logout.html +++ b/docs/modules/handlers_logout.html @@ -16,7 +16,7 @@
  • handlers/logout

    • Module handlers/logout

    +
  • Defined in handlers/logout.ts:1
    • diff --git a/docs/modules/handlers_profile.html b/docs/modules/handlers_profile.html index 6c96be0e8..9f59758b6 100644 --- a/docs/modules/handlers_profile.html +++ b/docs/modules/handlers_profile.html @@ -16,7 +16,7 @@
  • handlers/profile

    • Module handlers/profile

    +
  • Defined in handlers/profile.ts:1
    • diff --git a/docs/modules/helpers.html b/docs/modules/helpers.html index 26aabc00a..027c6b5e8 100644 --- a/docs/modules/helpers.html +++ b/docs/modules/helpers.html @@ -16,7 +16,7 @@
  • helpers

    • Module helpers

    +
  • Defined in helpers/index.ts:1
    • diff --git a/docs/modules/helpers_testing.html b/docs/modules/helpers_testing.html index d88fb3cbe..b0e3435bb 100644 --- a/docs/modules/helpers_testing.html +++ b/docs/modules/helpers_testing.html @@ -16,7 +16,7 @@
  • helpers/testing

    • Module helpers/testing

    +
  • Defined in helpers/testing.ts:1
    • diff --git a/docs/modules/helpers_with_api_auth_required.html b/docs/modules/helpers_with_api_auth_required.html index aecfb85a1..12663d2e6 100644 --- a/docs/modules/helpers_with_api_auth_required.html +++ b/docs/modules/helpers_with_api_auth_required.html @@ -16,7 +16,7 @@
  • helpers/with-api-auth-required

    • Module helpers/with-api-auth-required

    +
  • Defined in helpers/with-api-auth-required.ts:1
    • diff --git a/docs/modules/helpers_with_middleware_auth_required.html b/docs/modules/helpers_with_middleware_auth_required.html index 3050dccf7..23f5b37a2 100644 --- a/docs/modules/helpers_with_middleware_auth_required.html +++ b/docs/modules/helpers_with_middleware_auth_required.html @@ -16,7 +16,7 @@
  • helpers/with-middleware-auth-required

    • Module helpers/with-middleware-auth-required

    +
  • Defined in helpers/with-middleware-auth-required.ts:1
    • diff --git a/docs/modules/helpers_with_page_auth_required.html b/docs/modules/helpers_with_page_auth_required.html index 3566d76d2..6510da6e2 100644 --- a/docs/modules/helpers_with_page_auth_required.html +++ b/docs/modules/helpers_with_page_auth_required.html @@ -16,7 +16,7 @@
  • helpers/with-page-auth-required

    • Module helpers/with-page-auth-required

    +
  • Defined in helpers/with-page-auth-required.ts:1
    • diff --git a/docs/modules/index.html b/docs/modules/index.html index 946349b4f..512365d6e 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in index.ts:1
    • diff --git a/docs/modules/session.html b/docs/modules/session.html index b059ea18f..1a763cda4 100644 --- a/docs/modules/session.html +++ b/docs/modules/session.html @@ -16,7 +16,7 @@
  • session

    • Module session

    +
  • Defined in session/index.ts:1
    • diff --git a/docs/modules/session_get_access_token.html b/docs/modules/session_get_access_token.html index dcb567274..ea0f12e6e 100644 --- a/docs/modules/session_get_access_token.html +++ b/docs/modules/session_get_access_token.html @@ -16,7 +16,7 @@
  • session/get-access-token

    • Module session/get-access-token

    +
  • Defined in session/get-access-token.ts:1
    • diff --git a/docs/modules/session_get_session.html b/docs/modules/session_get_session.html index 1d20ede70..c94ad1e38 100644 --- a/docs/modules/session_get_session.html +++ b/docs/modules/session_get_session.html @@ -16,7 +16,7 @@
  • session/get-session

    • Module session/get-session

    +
  • Defined in session/get-session.ts:1
    • diff --git a/docs/modules/session_session.html b/docs/modules/session_session.html index a709bc668..2adeaf2d0 100644 --- a/docs/modules/session_session.html +++ b/docs/modules/session_session.html @@ -16,7 +16,7 @@
  • session/session

    • Module session/session

    +
  • Defined in session/session.ts:1
    • diff --git a/docs/modules/session_update_session.html b/docs/modules/session_update_session.html index b3cc35c7d..53d7db113 100644 --- a/docs/modules/session_update_session.html +++ b/docs/modules/session_update_session.html @@ -16,7 +16,7 @@
  • session/update-session

    • Module session/update-session

    +
  • Defined in session/update-session.ts:1
    • diff --git a/docs/modules/utils_errors.html b/docs/modules/utils_errors.html index c665c4b2d..a3f14ecc1 100644 --- a/docs/modules/utils_errors.html +++ b/docs/modules/utils_errors.html @@ -16,7 +16,7 @@
  • utils/errors

    • Module utils/errors

    +
  • Defined in utils/errors.ts:1
    • diff --git a/docs/modules/version.html b/docs/modules/version.html index d83626139..2613a50a2 100644 --- a/docs/modules/version.html +++ b/docs/modules/version.html @@ -16,7 +16,7 @@
  • version

    • Module version

    +
  • Defined in version.ts:1
    • diff --git a/docs/types/client_use_user.UserContext.html b/docs/types/client_use_user.UserContext.html index d79217398..3c0816565 100644 --- a/docs/types/client_use_user.UserContext.html +++ b/docs/types/client_use_user.UserContext.html @@ -37,8 +37,8 @@
    isLoading:
    Optional user?: UserProfile
    +
  • Defined in client/use-user.tsx:28
    • +
  • Defined in client/use-user.tsx:116
    • diff --git a/docs/types/client_use_user.UserProvider.html b/docs/types/client_use_user.UserProvider.html index 32dad7cca..3c1d68837 100644 --- a/docs/types/client_use_user.UserProvider.html +++ b/docs/types/client_use_user.UserProvider.html @@ -33,7 +33,7 @@

    Parameters

    props: UserProviderProps

    Returns ReactElement<UserContext>

    +
  • Defined in client/use-user.tsx:164
    • diff --git a/docs/types/client_use_user.UserProviderProps.html b/docs/types/client_use_user.UserProviderProps.html index b35610689..0391e2a18 100644 --- a/docs/types/client_use_user.UserProviderProps.html +++ b/docs/types/client_use_user.UserProviderProps.html @@ -31,7 +31,7 @@

    Type alias UserProviderProps

    (the default is /api/auth/me) then you need to specify it here in the profileUrl option.

    +
  • Defined in client/use-user.tsx:104
    • diff --git a/docs/types/client_with_page_auth_required.WithPageAuthRequired.html b/docs/types/client_with_page_auth_required.WithPageAuthRequired.html index 3f131f94c..4bc16fe37 100644 --- a/docs/types/client_with_page_auth_required.WithPageAuthRequired.html +++ b/docs/types/client_with_page_auth_required.WithPageAuthRequired.html @@ -43,7 +43,7 @@
    Component: ComponentTypeOptional options: WithPageAuthRequiredOptions

    Returns React.FC<P>

    +
  • Defined in client/with-page-auth-required.tsx:76
    • diff --git a/docs/types/config.ConfigParameters.html b/docs/types/config.ConfigParameters.html index 4722137a4..31f13e4b7 100644 --- a/docs/types/config.ConfigParameters.html +++ b/docs/types/config.ConfigParameters.html @@ -93,7 +93,7 @@

    2. Create your own instance using InitAuth0

    front end version of {@Link WithPageAuthRequired}

    +
  • Defined in config.ts:437
    • diff --git a/docs/types/edge.Auth0Edge.html b/docs/types/edge.Auth0Edge.html index 1ea234784..092b7028a 100644 --- a/docs/types/edge.Auth0Edge.html +++ b/docs/types/edge.Auth0Edge.html @@ -25,7 +25,7 @@
    getSession:
    withMiddlewareAuthRequired: WithMiddlewareAuthRequired
    +
  • Defined in edge.ts:14
    • diff --git a/docs/types/edge.GetSession.html b/docs/types/edge.GetSession.html index 687898324..134c3d77d 100644 --- a/docs/types/edge.GetSession.html +++ b/docs/types/edge.GetSession.html @@ -16,24 +16,30 @@
  • edge
  • GetSession

    • Type alias GetSession

    -
    GetSession: ((req: NextRequest, res: NextResponse) => Promise<default | null | undefined>)
    +
    GetSession: ((req: NextRequest, res: NextResponse, touchSession?: boolean) => Promise<default | null | undefined>)

    Type declaration

      • -
      • (req: NextRequest, res: NextResponse): Promise<default | null | undefined>
        • +
      • (req: NextRequest, res: NextResponse, touchSession?: boolean): Promise<default | null | undefined>
      • +

        Get the user's session from the request.

        +

        Parameters

        • req: NextRequest
        • -
          res: NextResponse
        +
        res: NextResponse
        • +
      • +
        Optional touchSession: boolean
        +

        If false, the session will not be updated. Defaults to true.

        +

    Returns Promise<default | null | undefined>

    +
  • Defined in edge.ts:22
    • diff --git a/docs/types/edge.InitAuth0.html b/docs/types/edge.InitAuth0.html index 6a9009ca4..c894d79d3 100644 --- a/docs/types/edge.InitAuth0.html +++ b/docs/types/edge.InitAuth0.html @@ -31,7 +31,7 @@

    Parameters

    Optional params: ConfigParameters

    Returns Auth0Edge

    +
  • Defined in edge.ts:28
    • diff --git a/docs/types/handlers_auth.HandleAuth.html b/docs/types/handlers_auth.HandleAuth.html index 979e5829e..5d1f748a0 100644 --- a/docs/types/handlers_auth.HandleAuth.html +++ b/docs/types/handlers_auth.HandleAuth.html @@ -45,7 +45,7 @@

    Parameters

    Optional userHandlers: Handlers

    Returns NextApiHandler

    +
  • Defined in handlers/auth.ts:94
    • diff --git a/docs/types/handlers_auth.Handlers.html b/docs/types/handlers_auth.Handlers.html index 31ecdf86f..3b19d1323 100644 --- a/docs/types/handlers_auth.Handlers.html +++ b/docs/types/handlers_auth.Handlers.html @@ -29,7 +29,7 @@

    Type alias Handlers

    +
  • Defined in handlers/auth.ts:61
    • diff --git a/docs/types/handlers_auth.OnError.html b/docs/types/handlers_auth.OnError.html index d48b584a7..faa0aa338 100644 --- a/docs/types/handlers_auth.OnError.html +++ b/docs/types/handlers_auth.OnError.html @@ -40,7 +40,7 @@
    res: NextApiResponse
    error: HandlerError

    Returns Promise<void> | void

    +
  • Defined in handlers/auth.ts:117
    • diff --git a/docs/types/handlers_callback.AfterCallback.html b/docs/types/handlers_callback.AfterCallback.html index 4db32bd53..c155c47e9 100644 --- a/docs/types/handlers_callback.AfterCallback.html +++ b/docs/types/handlers_callback.AfterCallback.html @@ -57,7 +57,7 @@
    Optional state: [key: string]: any

    Returns Promise<default | undefined> | default | undefined

    +
  • Defined in handlers/callback.ts:90
    • diff --git a/docs/types/handlers_callback.CallbackHandler.html b/docs/types/handlers_callback.CallbackHandler.html index 614b23e22..58163ab9e 100644 --- a/docs/types/handlers_callback.CallbackHandler.html +++ b/docs/types/handlers_callback.CallbackHandler.html @@ -39,7 +39,7 @@
    res: NextApiResponse
    Optional options: CallbackOptions

    Returns Promise<void>

    +
  • Defined in handlers/callback.ts:197
    • diff --git a/docs/types/handlers_callback.CallbackOptionsProvider.html b/docs/types/handlers_callback.CallbackOptionsProvider.html index 0aa9f7eaf..1a1753476 100644 --- a/docs/types/handlers_callback.CallbackOptionsProvider.html +++ b/docs/types/handlers_callback.CallbackOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns CallbackOptions

    +
  • Defined in handlers/callback.ts:132
    • diff --git a/docs/types/handlers_callback.HandleCallback.html b/docs/types/handlers_callback.HandleCallback.html index 0f05affda..d532649bc 100644 --- a/docs/types/handlers_callback.HandleCallback.html +++ b/docs/types/handlers_callback.HandleCallback.html @@ -99,7 +99,7 @@

    Parameters

    options: CallbackOptions

    Returns CallbackHandler

    +
  • Defined in handlers/callback.ts:184
    • diff --git a/docs/types/handlers_login.GetLoginState.html b/docs/types/handlers_login.GetLoginState.html index 5315e0baa..e3da4a731 100644 --- a/docs/types/handlers_login.GetLoginState.html +++ b/docs/types/handlers_login.GetLoginState.html @@ -40,7 +40,7 @@

    Returns {
    [key: string]: any

    +
  • Defined in handlers/login.ts:33
    • diff --git a/docs/types/handlers_login.HandleLogin.html b/docs/types/handlers_login.HandleLogin.html index 8b2c30521..0ef228386 100644 --- a/docs/types/handlers_login.HandleLogin.html +++ b/docs/types/handlers_login.HandleLogin.html @@ -99,7 +99,7 @@

    Parameters

    options: LoginOptions

    Returns LoginHandler

    +
  • Defined in handlers/login.ts:223
    • diff --git a/docs/types/handlers_login.LoginHandler.html b/docs/types/handlers_login.LoginHandler.html index d53749289..d612cbcae 100644 --- a/docs/types/handlers_login.LoginHandler.html +++ b/docs/types/handlers_login.LoginHandler.html @@ -39,7 +39,7 @@
    res: NextApiResponse
    Optional options: LoginOptions

    Returns Promise<void>

    +
  • Defined in handlers/login.ts:236
    • diff --git a/docs/types/handlers_login.LoginOptionsProvider.html b/docs/types/handlers_login.LoginOptionsProvider.html index da385e47c..49b123b1b 100644 --- a/docs/types/handlers_login.LoginOptionsProvider.html +++ b/docs/types/handlers_login.LoginOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns LoginOptions

    +
  • Defined in handlers/login.ts:167
    • diff --git a/docs/types/handlers_logout.HandleLogout.html b/docs/types/handlers_logout.HandleLogout.html index 1cdfbda2b..053e6ff81 100644 --- a/docs/types/handlers_logout.HandleLogout.html +++ b/docs/types/handlers_logout.HandleLogout.html @@ -99,7 +99,7 @@

    Parameters

    options: LogoutOptions

    Returns LogoutHandler

    +
  • Defined in handlers/logout.ts:85
    • diff --git a/docs/types/handlers_logout.LogoutHandler.html b/docs/types/handlers_logout.LogoutHandler.html index 8848fac60..12d8cb03a 100644 --- a/docs/types/handlers_logout.LogoutHandler.html +++ b/docs/types/handlers_logout.LogoutHandler.html @@ -39,7 +39,7 @@
    res: NextApiResponse
    Optional options: LogoutOptions

    Returns Promise<void>

    +
  • Defined in handlers/logout.ts:98
    • diff --git a/docs/types/handlers_logout.LogoutOptionsProvider.html b/docs/types/handlers_logout.LogoutOptionsProvider.html index 3ecff75dd..2d9dee131 100644 --- a/docs/types/handlers_logout.LogoutOptionsProvider.html +++ b/docs/types/handlers_logout.LogoutOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns LogoutOptions

    +
  • Defined in handlers/logout.ts:33
    • diff --git a/docs/types/handlers_profile.AfterRefetch.html b/docs/types/handlers_profile.AfterRefetch.html index c8d6ee6cb..fd82441c3 100644 --- a/docs/types/handlers_profile.AfterRefetch.html +++ b/docs/types/handlers_profile.AfterRefetch.html @@ -35,7 +35,7 @@
    res: NextApiResponse
    session: default

    Returns Promise<default> | default

    +
  • Defined in handlers/profile.ts:8
    • diff --git a/docs/types/handlers_profile.HandleProfile.html b/docs/types/handlers_profile.HandleProfile.html index baa82fc6a..04814d7b1 100644 --- a/docs/types/handlers_profile.HandleProfile.html +++ b/docs/types/handlers_profile.HandleProfile.html @@ -99,7 +99,7 @@

    Parameters

    options: ProfileOptions

    Returns ProfileHandler

    +
  • Defined in handlers/profile.ts:88
    • diff --git a/docs/types/handlers_profile.ProfileHandler.html b/docs/types/handlers_profile.ProfileHandler.html index 25afc2e28..9caa82949 100644 --- a/docs/types/handlers_profile.ProfileHandler.html +++ b/docs/types/handlers_profile.ProfileHandler.html @@ -39,7 +39,7 @@
    res: NextApiResponse
    Optional options: ProfileOptions

    Returns Promise<void>

    +
  • Defined in handlers/profile.ts:101
    • diff --git a/docs/types/handlers_profile.ProfileOptions.html b/docs/types/handlers_profile.ProfileOptions.html index e20818b62..7dc826bc4 100644 --- a/docs/types/handlers_profile.ProfileOptions.html +++ b/docs/types/handlers_profile.ProfileOptions.html @@ -36,7 +36,7 @@
    Optional refetch
    +
  • Defined in handlers/profile.ts:17
    • diff --git a/docs/types/handlers_profile.ProfileOptionsProvider.html b/docs/types/handlers_profile.ProfileOptionsProvider.html index e330439ad..b032b5f81 100644 --- a/docs/types/handlers_profile.ProfileOptionsProvider.html +++ b/docs/types/handlers_profile.ProfileOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns ProfileOptions

    +
  • Defined in handlers/profile.ts:38
    • diff --git a/docs/types/helpers_testing.GenerateSessionCookieConfig.html b/docs/types/helpers_testing.GenerateSessionCookieConfig.html index 1d64691ca..d794ed245 100644 --- a/docs/types/helpers_testing.GenerateSessionCookieConfig.html +++ b/docs/types/helpers_testing.GenerateSessionCookieConfig.html @@ -20,7 +20,7 @@

    Type alias GenerateSessionCookieConfig

    Configuration parameters used by generateSessionCookie.

    +
  • Defined in helpers/testing.ts:7
    • diff --git a/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html b/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html index 5f9a294b2..b7324d75d 100644 --- a/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html +++ b/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html @@ -37,7 +37,7 @@

    Parameters

    apiRoute: NextApiHandler

    Returns NextApiHandler

    +
  • Defined in helpers/with-api-auth-required.ts:23
    • diff --git a/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html b/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html index a0d01eca5..ea73452de 100644 --- a/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html +++ b/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html @@ -43,7 +43,7 @@

    Parameters

    Optional middleware: NextMiddleware

    Returns NextMiddleware

    +
  • Defined in helpers/with-middleware-auth-required.ts:46
    • diff --git a/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html b/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html index 9897dd1e1..3d3376839 100644 --- a/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html +++ b/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html @@ -28,7 +28,7 @@

    Type Parameters

  • P = any

    • +
  • Defined in helpers/with-page-auth-required.ts:23
    • diff --git a/docs/types/helpers_with_page_auth_required.PageRoute.html b/docs/types/helpers_with_page_auth_required.PageRoute.html index e3246c4d9..d010ac37b 100644 --- a/docs/types/helpers_with_page_auth_required.PageRoute.html +++ b/docs/types/helpers_with_page_auth_required.PageRoute.html @@ -40,7 +40,7 @@

    Parameters

    cts: GetServerSidePropsContext<Q>

    Returns Promise<GetServerSidePropsResultWithSession<P>>

    +
  • Defined in helpers/with-page-auth-required.ts:30
    • diff --git a/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html b/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html index 9b177ecdb..6c108c25e 100644 --- a/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html +++ b/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html @@ -45,7 +45,7 @@

    Parameters

    Optional opts: WithPageAuthRequiredOptions<P, Q>

    Returns PageRoute<P, Q>

    +
  • Defined in helpers/with-page-auth-required.ts:93
    • diff --git a/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html b/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html index 6532cc900..57228ab01 100644 --- a/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html +++ b/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html @@ -39,7 +39,7 @@
    Optional getServerS
  • Optional returnTo?: string
    • +
  • Defined in helpers/with-page-auth-required.ts:65
    • diff --git a/docs/types/index.InitAuth0.html b/docs/types/index.InitAuth0.html index 368ec75a1..27e8da153 100644 --- a/docs/types/index.InitAuth0.html +++ b/docs/types/index.InitAuth0.html @@ -34,7 +34,7 @@

    Parameters

    Optional params: ConfigParameters

    Returns Auth0Server

    +
  • Defined in index.ts:131
    • diff --git a/docs/types/index.SessionStore.html b/docs/types/index.SessionStore.html index 2738a679a..1c98c5477 100644 --- a/docs/types/index.SessionStore.html +++ b/docs/types/index.SessionStore.html @@ -18,7 +18,7 @@

    Type alias SessionStore

    SessionStore: GenericSessionStore<default>
    +
  • Defined in index.ts:268
    • diff --git a/docs/types/index.SessionStorePayload.html b/docs/types/index.SessionStorePayload.html index 47d6f4cf8..f1e22af9b 100644 --- a/docs/types/index.SessionStorePayload.html +++ b/docs/types/index.SessionStorePayload.html @@ -18,7 +18,7 @@

    Type alias SessionStorePayload

    SessionStorePayload: SessionPayload<default>
    +
  • Defined in index.ts:269
    • diff --git a/docs/types/session_get_access_token.AfterRefresh.html b/docs/types/session_get_access_token.AfterRefresh.html index 37e4c64de..926be3143 100644 --- a/docs/types/session_get_access_token.AfterRefresh.html +++ b/docs/types/session_get_access_token.AfterRefresh.html @@ -35,7 +35,7 @@
    res: NextApiResponse
    session: default

    Returns Promise<default> | default

    +
  • Defined in session/get-access-token.ts:10
    • diff --git a/docs/types/session_get_access_token.GetAccessToken.html b/docs/types/session_get_access_token.GetAccessToken.html index cb09ae6a4..0904c0668 100644 --- a/docs/types/session_get_access_token.GetAccessToken.html +++ b/docs/types/session_get_access_token.GetAccessToken.html @@ -39,7 +39,7 @@
    res: ServerResponseOptional accessTokenRequest: AccessTokenRequest

    Returns Promise<GetAccessTokenResult>

    +
  • Defined in session/get-access-token.ts:86
    • diff --git a/docs/types/session_get_session.GetSession.html b/docs/types/session_get_session.GetSession.html index f249606e0..075307837 100644 --- a/docs/types/session_get_session.GetSession.html +++ b/docs/types/session_get_session.GetSession.html @@ -16,13 +16,13 @@
  • session/get-session
  • GetSession

    • Type alias GetSession

    -
    GetSession: ((req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse) => Promise<default | null | undefined>)
    +
    GetSession: ((req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, touchSession?: boolean) => Promise<default | null | undefined>)

    Type declaration

      • -
      • (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse): Promise<default | null | undefined>
        • +
      • (req: IncomingMessage | NextApiRequest, res: ServerResponse | NextApiResponse, touchSession?: boolean): Promise<default | null | undefined>

      • Get the user's session from the request.

        @@ -32,10 +32,14 @@

        Parameters

      • req: IncomingMessage | NextApiRequest
      • -
        res: ServerResponse | NextApiResponse
    +
    res: ServerResponse | NextApiResponse
    +
  • +
    Optional touchSession: boolean
    +

    If false, the session will not be updated. Defaults to true.

    +

    • Returns Promise<default | null | undefined>

    +
  • Defined in session/get-session.ts:12
    • diff --git a/docs/types/session_update_session.UpdateSession.html b/docs/types/session_update_session.UpdateSession.html index 2ffa2a590..131e22c11 100644 --- a/docs/types/session_update_session.UpdateSession.html +++ b/docs/types/session_update_session.UpdateSession.html @@ -41,7 +41,7 @@
    res: ServerResponsedefault

    Returns Promise<void>

    +
  • Defined in session/update-session.ts:27
    • diff --git a/docs/variables/version.default.html b/docs/variables/version.default.html index 20d06c22d..3e23f63c2 100644 --- a/docs/variables/version.default.html +++ b/docs/variables/version.default.html @@ -18,7 +18,7 @@

    Variable default

    default: "2.3.0"
    +
  • Defined in version.ts:1
    • diff --git a/src/edge.ts b/src/edge.ts index 8b73b246c..7e628a65e 100644 --- a/src/edge.ts +++ b/src/edge.ts @@ -13,7 +13,17 @@ import { setIsUsingNamedExports, setIsUsingOwnInstance } from './utils/instance- export type Auth0Edge = { withMiddlewareAuthRequired: WithMiddlewareAuthRequired; getSession: GetSession }; -export type GetSession = (req: NextRequest, res: NextResponse) => Promise; +/** + * Get the user's session from the request. + * + * @category Server + * @param touchSession - If false, the session will not be updated. Defaults to true. + */ +export type GetSession = ( + req: NextRequest, + res: NextResponse, + touchSession?: boolean +) => Promise; export type InitAuth0 = (params?: ConfigParameters) => Auth0Edge; @@ -53,7 +63,7 @@ const _initAuth0: InitAuth0 = (params?) => { const sessionCache = new SessionCache(baseConfig, sessionStore); // Init Next layer (with next config) - const getSession: GetSession = (req, res) => sessionCache.get(req, res); + const getSession: GetSession = (req, res, touchSession = true) => sessionCache.get(req, res, touchSession); const withMiddlewareAuthRequired = withMiddlewareAuthRequiredFactory(nextConfig.routes, () => sessionCache); return { diff --git a/src/session/get-session.ts b/src/session/get-session.ts index cf3016191..2597d6a1f 100644 --- a/src/session/get-session.ts +++ b/src/session/get-session.ts @@ -7,7 +7,7 @@ import { assertReqRes } from '../utils/assert'; * Get the user's session from the request. * * @category Server - * @param touchSession - If true, a rolling session will be updated with the current time. Defaults to true. + * @param touchSession - If false, the session will not be updated. Defaults to true. */ export type GetSession = ( req: IncomingMessage | NextApiRequest,