From 5675760def31dc60ffc90332edd5b4d11dff4ce2 Mon Sep 17 00:00:00 2001 From: Piyush Kumar Date: Thu, 16 Apr 2026 17:18:02 +0530 Subject: [PATCH] chore: release v4.18.0 --- .version | 2 +- CHANGELOG.md | 10 +++ docs/assets/hierarchy.js | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/errors.AccessTokenError.html | 4 +- .../errors.AccessTokenForConnectionError.html | 8 +-- .../errors.AuthorizationCodeGrantError.html | 4 +- ...rs.AuthorizationCodeGrantRequestError.html | 4 +- docs/classes/errors.AuthorizationError.html | 4 +- ...errors.BackchannelAuthenticationError.html | 4 +- ...hannelAuthenticationNotSupportedError.html | 4 +- .../errors.BackchannelLogoutError.html | 6 +- docs/classes/errors.ConnectAccountError.html | 8 +-- .../errors.CustomTokenExchangeError.html | 10 +-- docs/classes/errors.DPoPError.html | 10 +-- docs/classes/errors.DiscoveryError.html | 4 +- .../errors.InvalidConfigurationError.html | 4 +- docs/classes/errors.InvalidRequestError.html | 6 +- docs/classes/errors.InvalidStateError.html | 4 +- docs/classes/errors.MfaChallengeError.html | 8 +-- docs/classes/errors.MfaEnrollmentError.html | 8 +-- .../errors.MfaGetAuthenticatorsError.html | 8 +-- .../errors.MfaNoAvailableFactorsError.html | 6 +- docs/classes/errors.MfaVerifyError.html | 8 +-- docs/classes/errors.MissingStateError.html | 4 +- docs/classes/errors.MyAccountApiError.html | 8 +-- docs/classes/errors.OAuth2Error.html | 6 +- docs/classes/errors.SdkError.html | 4 +- docs/classes/server.AbstractSessionStore.html | 12 ++-- docs/classes/server.Auth0Client.html | 32 +++++----- .../classes/server.DomainResolutionError.html | 8 +-- .../classes/server.DomainValidationError.html | 6 +- .../classes/server.IssuerValidationError.html | 10 +-- docs/classes/server.MfaRequiredError.html | 16 ++--- docs/classes/server.MfaTokenExpiredError.html | 6 +- docs/classes/server.MfaTokenInvalidError.html | 6 +- .../server.SessionDomainMismatchError.html | 6 +- docs/classes/server.TransactionStore.html | 12 ++-- docs/enums/errors.AccessTokenErrorCode.html | 4 +- ...ors.AccessTokenForConnectionErrorCode.html | 10 +-- .../errors.ConnectAccountErrorCodes.html | 10 +-- .../errors.CustomTokenExchangeErrorCode.html | 12 ++-- docs/enums/errors.DPoPErrorCode.html | 10 +-- docs/enums/types.RESPONSE_TYPES.html | 6 +- docs/enums/types.SUBJECT_TOKEN_TYPES.html | 6 +- docs/functions/client.Auth0Provider.html | 2 +- docs/functions/client.getAccessToken.html | 6 +- docs/functions/client.useUser.html | 2 +- .../server.filterDefaultIdTokenClaims.html | 4 +- .../functions/server.generateDpopKeyPair.html | 10 +++ .../testing.generateSessionCookie.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 4 +- .../client.WithPageAuthRequiredOptions.html | 10 +-- .../errors.MfaApiErrorResponse.html | 6 +- docs/interfaces/server.MfaRequirements.html | 8 +-- ...types.AccessTokenForConnectionOptions.html | 10 +-- docs/interfaces/types.AccessTokenSet.html | 4 +- docs/interfaces/types.Auth0ClientOptions.html | 62 +++++++++---------- docs/interfaces/types.Authenticator.html | 22 +++---- .../types.AuthorizationDetails.html | 4 +- .../types.AuthorizationParameters.html | 14 ++--- ...ypes.BackchannelAuthenticationOptions.html | 12 ++-- ...pes.BackchannelAuthenticationResponse.html | 4 +- docs/interfaces/types.ChallengeResponse.html | 10 +-- .../types.ConnectAccountOptions.html | 12 ++-- docs/interfaces/types.ConnectionTokenSet.html | 4 +- docs/interfaces/types.CookieOptions.html | 4 +- .../types.CustomTokenExchangeOptions.html | 20 +++--- .../types.CustomTokenExchangeResponse.html | 16 ++--- .../types.DiscoveryCacheOptions.html | 8 +-- docs/interfaces/types.EnrollOobOptions.html | 14 ++--- docs/interfaces/types.EnrollOtpOptions.html | 8 +-- docs/interfaces/types.MCDMetadata.html | 8 +-- docs/interfaces/types.MfaClient.html | 12 ++-- docs/interfaces/types.MfaContext.html | 14 ++--- docs/interfaces/types.MfaVerifyResponse.html | 20 +++--- docs/interfaces/types.Routes.html | 4 +- .../types.SessionConfiguration.html | 10 +-- .../types.SessionCookieOptions.html | 14 ++--- docs/interfaces/types.SessionData.html | 4 +- docs/interfaces/types.SessionDataStore.html | 16 +++-- .../interfaces/types.SessionStoreOptions.html | 10 +-- .../types.StartInteractiveLoginOptions.html | 6 +- docs/interfaces/types.TokenSet.html | 4 +- .../types.TransactionCookieOptions.html | 14 ++--- docs/interfaces/types.TransactionState.html | 12 ++-- .../types.TransactionStoreOptions.html | 6 +- docs/interfaces/types.User.html | 6 +- .../types.VerifyMfaOptionsBase.html | 6 +- .../types.VerifyMfaWithOobOptions.html | 8 +-- .../types.VerifyMfaWithOtpOptions.html | 6 +- ...ypes.VerifyMfaWithRecoveryCodeOptions.html | 6 +- docs/modules.html | 2 +- docs/modules/client.html | 2 +- docs/modules/errors.html | 2 +- docs/modules/server.html | 2 +- docs/modules/testing.html | 2 +- docs/modules/types.html | 2 +- docs/types/client.WithPageAuthRequired.html | 4 +- docs/types/server.AppRouterPageRoute.html | 4 +- docs/types/server.AppRouterPageRouteOpts.html | 6 +- ...r.GetServerSidePropsResultWithSession.html | 4 +- docs/types/server.PageRoute.html | 4 +- docs/types/server.WithPageAuthRequired.html | 4 +- .../server.WithPageAuthRequiredAppRouter.html | 4 +- ....WithPageAuthRequiredAppRouterOptions.html | 6 +- ...server.WithPageAuthRequiredPageRouter.html | 4 +- ...WithPageAuthRequiredPageRouterOptions.html | 6 +- .../testing.GenerateSessionCookieConfig.html | 4 +- docs/types/types.BeforeSessionSavedHook.html | 2 +- docs/types/types.DomainResolver.html | 4 +- docs/types/types.EnrollOptions.html | 4 +- docs/types/types.EnrollmentResponse.html | 4 +- docs/types/types.GetAccessTokenOptions.html | 4 +- docs/types/types.LogoutStrategy.html | 4 +- docs/types/types.LogoutToken.html | 4 +- docs/types/types.OnCallbackContext.html | 10 +-- docs/types/types.OnCallbackHook.html | 2 +- docs/types/types.PagesRouterRequest.html | 2 +- docs/types/types.PagesRouterResponse.html | 2 +- docs/types/types.ProxyOptions.html | 4 +- docs/types/types.ReadonlyRequestCookies.html | 2 +- docs/types/types.RoutesOptions.html | 2 +- docs/types/types.VerifyMfaOptions.html | 4 +- docs/variables/client.mfa.html | 4 +- .../client.withPageAuthRequired.html | 2 +- .../server.DEFAULT_ID_TOKEN_CLAIMS.html | 4 +- ...ypes.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html | 4 +- docs/variables/types.GRANT_TYPE_MFA_OOB.html | 4 +- docs/variables/types.GRANT_TYPE_MFA_OTP.html | 4 +- .../types.GRANT_TYPE_MFA_RECOVERY_CODE.html | 4 +- package.json | 2 +- 134 files changed, 487 insertions(+), 461 deletions(-) create mode 100644 docs/functions/server.generateDpopKeyPair.html diff --git a/.version b/.version index 581a57bf5..5a74a2876 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v4.17.0 +v4.18.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index 904591501..00ae4b4b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [v4.18.0](https://github.com/auth0/nextjs-auth0/tree/v4.18.0) (2026-04-16) +[Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v4.17.0...v4.18.0) + +**Added** +- feat: add optional `update()` to `SessionDataStore` [\#2590](https://github.com/auth0/nextjs-auth0/pull/2590) ([Piyush-85](https://github.com/Piyush-85)) + +**Fixed** +- fix: defer `AuthClientProvider` construction when `AUTH0_DOMAIN` not set at build time [\#2604](https://github.com/auth0/nextjs-auth0/pull/2604) ([sleitor](https://github.com/sleitor)) +- fix: Next.js edge runtime build error for crypto module [\#2564](https://github.com/auth0/nextjs-auth0/pull/2564) ([Piyush-85](https://github.com/Piyush-85)) + ## [v4.17.0](https://github.com/auth0/nextjs-auth0/tree/v4.17.0) (2026-04-09) [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v4.16.2...v4.17.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 0841db38c..8329097cd 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyll11P2zAUhv+Lrw+QOh92escYTEgrIDqxC8SFl7rUIrU720FjiP8+pS3IaRLlhF1Vav2e57Hj+jivxBrjHZnes5QBpRRilj0AsXJZysIrox2ZvhJKaf2hxVqSKZlL55TRZ0Yv1WNlRT2MAHlSekGmNM2AVLYkU6K0l3YpCulO/MtGuuOu4PHKr0sCpCiFc2RKvFsc1ZWOPtL1jytVLqzUZHpP4+ThDQiNk7bR3Bsrrzc77RFCYQ7h8wYkZlmAv5NWLV9mS7Gv8UU4ieJ3BccuSMw4xHwCMU8ftma8y+yn8qtrvxmzOD1Z5ALxSa+G+fV5jY8sViPt07iVhXmW9uXMLEbtmaEiOLGMskBsthS38nelrFycW2vsh8iE8neRbT3pTpy0z9IeH0Z6sbsvamRygPxhnqQ+/7MZiW3FEOh00oG+1M+iVKPRYWwYzRpH11ezFkrfSmfKqn5aWHZnDgPPW/C7Wl6Mhx/kEPDGEXnpXCXteHhnDgFPOjrGbiIz5dbCFyusQX8YoZGGe36+eBqEynqAO34fOoBonMQZZZAlDLJ0AoxSYDQHFifAEgoso8BYBIylwHgEjKfA8ghYngOPEuCTGPiEA6cUeBwBTyjwNAGeMeAshzzKIOcJ5Pm2/bEsXN7r08qvKHZqwWjEArIo3MHK7c47LKsZwODC83qmnFP6ce6Fl1hiK4OA8nCO++NlFLSVwUDTNrRxMxoJb2cREnk483pfGKv+jqK3Qxhs3oetG+k3K7Svm5t0/lManUWGtXiUDGr9nw9WZBIHIl9E8VSshNay/G4eTYV26A5i8LwbX09Kaq+K7ayujJ9Xm42xHnF9aCsNFENoNjp7b+X/VsPqxI3/UlFI53ZXJeyWOYggkI0mG+QvjD0zWu/e4D7Bb+cRMmn47zmrnDfr/VWxXtZH9GHaF0UoZGG3/3pjbtB96n0sAsLCw2v2cloUptL+dKPQLeowMwzNo/B9c/9s9lXQ69pOIcA8ad7cr8zps1Cl+FXKC1F4Yx162r1hhEaetLvlyBbRkRoCv739A01u0q8=" \ No newline at end of file +window.hierarchyData = "eJyll0tP4zAURv+L1xdI7CZ2uuM5QhoeoiNmgViY1KUWqd2xHTQM4r+PQgtym1S5gUVVqfXnc+wk9zqvxFkbPBnf8ZwBpTkwkdwDcWpWqTJoazwZvxJK8+bLyIUiYzJR3mtrjq2Z6cfayWYYAfKkzZSMaZYDqV1FxkSboNxMlsofhJel8vtdwf15WFQESFlJ78mYBD/da2ba+0w3f851NXXKkPEdZeL+DQhlom00Cdapq+VKe4BQnEP4vAFhIonwt8rp2cvFTK7nOJJeofhdwaEbwgQFJjJgorh/N6NdZr91mF+F5ZDN2ZHFblC2U8M+fF3jM4vVKHZp3KjSPiv3cmyng+6ZvklwYjljkdjFTN6oP7V2anrqnHWfIikVHyLv8yl/4JV7Vm5/O7ITu/qhQWZbyF/2SZnTv8uB2FYMg+Yd6HPzLCs9GB3H+tGcxoXixC6kNjfK26purhaW3ZlDwFnWgt828nI4fCuHgI/iGnXufa3ccHhnDgPvqM+rhVxov5ChnGMNdocRGnl8z0+mT71Q1Qzw+x9DexAblThnDPKs+XDgVABnGfBRAnwkgOcCOM+BixS4yIEXKfAiB5FkINIERFqAoCMQVIBgOYiRAJEnIDgDITIoUgpFkUCaJMn9+8Li/b06rMOcYtcWjUbsII9b/4n2q4KHZW0GEDiRxpVCe6/N4yTIoLDEVgYDjde4ri+DoK0MAlqkbejG0WggvJ3FSMQrb+4L6/S/QfR2qB8rkmwXtumkP5w0oeluyocvaXROgtBKk16t7/mgReJjy5Esn8q5NEZVP+2jrdEO3UEEno668c2ilAm6fF/VpQ2Term0LiDOD22lnskwmgKj+W01rA7beJbKUnm/Oithb5mtCAK50WWj/Jl1x9aY1SvcF/jtPEImj5+e49oHu1ifFZttfUQX011RhAKP2/3Jtb1G96mPsQjIxqvNxcthWdrahMOlRreo7Uw/tEjj17r1tVnPgt7XdgoBLpLNo/ulPXyWupIPlTqTZbDOo5e9M9yv0Zx72u1yYI/oSPWR397+A0YH0wk=" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index d41513940..b644d27b8 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJylmltz2zYQhf+L8uppHcdJW7/Jkuy4tSyNKKfNZDIamFxJGFOECoBq3E7+e4cXkSABLFbOWyKf8x2QuHLJL/8NNHzTg6tBnHLI9OBssGd6O7ga7ESSp6B+rn7/aat36eBs8MyzZHB1cTaItzxNJGSDqy8N4k+ut3O2gWGutwv4O+cSktlec5GplsszDXLN4haN2Hqx7z98P0PT2hj9sscTeujz3355+/7CwO/WrKUdmOTsybgduzXrAt6Z3n/QplkwlxyhF7LzuRQHnoBsses8i8ubdsR2dF3eh0uDtwE9jGNQaimeIUOAXSFCzBU8KrRttcJifDUoIKWQyh6R1e+kEWk0d1K4RiKBFghZvmtwLmk341ezD1r1TaHNMigv8IQUt88fWYuHcSzyTDcG5UnyyZGAXGmxq+7At3jLsg2ELgez+IPGczEPkTsaUj+U6pYWp0wp8HZvF/n2gty5lATbhcbleisk/5cV6uJybyWre8wf5vecHlWsOaBelWhaycEnBAXB1yx+LgZeBmlhhEzzmBCC214V+CB0lO/3QmpIXhluIYgNuRcbkQf6zy3HAhwriJfu0KJoz7rh53sMWMiYq1gcQL7g6K4MBR7XJD/rqMAwd9mBpTwZiWzNN7kkjFavgxBDmtwOLQEdaaYD/WYpMex0zUZblqYQHA6WMoCdZFKk6Q5Cw9iWBsC3oI0pLKQK8t2OQMyDGB4YT4tT4w2LSTkeSyDoE0i+DkyYrgwFcqV4tiGME0uJYl/qdWa45wFsX4lhZ0W/XOBAQ4OhouQZ5xwFge44NnsBai8yZRyWjMeotlv6cuzxaSx2jGcLUCLNHSuQ47D9JiktsrFAbanwl29/u3x3fmlFfCoWANci5484NJZQxJ1SOciTInhpoUdM1+z4UEag79ZM1mo6uFht8Acdg3sUI9h6n9zT26wLB1QOQrvLgHptPyGg7tlQQARKcZFVw2fK1Y7peEuIUZWvGkO72ucOM58zFcgDONDV77TnzCelJYt13fJICwn23K+BLnHo7Hw+6pVn+sxWg55g8EnfgzrVYbx3NjrxPTV67MAnew/vVAfWW89E75H7wgAUmY022BJT4O6Z6IGbYnQPI8zCXoTfggUtJcsUK5+V8YnTF9I6s7e4Ghun1Z2lFNs0h/v9QuQaZFGuK//Vrzge56MlDNUbbcdsb7Y7gC/EoYhb0FHpj3gCcyn2agEqT3VRHq27zpNHcIbCQ3eMfKModd+a+Zq6r8vT3O4TchrPDwVa5XN6rruETopv+uKUC25NPxZ5+iVb3lADxpOb4eP9cnU3Xi1nf0weVqP74d00cpXoj3uV24FU6dc81SDHsGZ5qu+ScukdpYzvjCtry+J1jN+EVNubAsaIxVuwbp/jOPMmOVriwiIaC36SL08CoaOS+ZRQab3nyNF4CpolTDOcuIuTXSv0H+Q0KM2zjQ2r/0A6yt1CBpJpqJe1kRDPHKrKS39IHrGIJTQSNy6ra4Acs5wG9DVK2VbHPSl+Jt2RxSSazx6iyWr5eT4xJklVr684XY2/Xh89Xv8+GS3rSYQAHcLT38ZgLx+rmIATPQu01gg0LSOC/pvULrI9xROabolD6KbmFKA2uhCwKdOPQTOehlrbl5PxcybZDjRIckLrwEK8hfjw3Q9ZXxWLlnkCuZSaT1MzJQRZWhTcKf+H755TTwjgIiNMOFuMo4sllNJmQ4cC7XcVBLrXdGIUpWv9LrRiiJ8zrBinHguoSu8z8RRm96UErN6TsY0UwzqPLxbRUKGwNetXeGzUURMCiaz8D06qRAFUVecnDClLi4HLszrWDZUAQzTHH+ONGAJ0yUl42tLgkhPwY3zoGCoirFc+wYiOAooTW+rId8BUo3DNpL4rIEU55wD3YsMJmy5mw+IIewZlpzDqT9SR4bMQY8r3YTR8KSVjSZ3qcWAh3c++LKL9zVfXXq0h0zWro64Zuuq45CR8UUUg7TMeBz2Esut4HOSQBdT7rEgIvRqyoidXWAt5fPaM2AGSj0I8W8/F1UnVqQ2WZjyVBpPc1YSI7Qt9ex8zqbaORvbUqzoHClpZ6rbzfSXKdUpD/Oq7n0gX9YPNixvc1dCIve9GbZzje1GbNctGLE2fWPxsHWBMoiWjc/1jtauhlLJVVXCsv5hxU23dSWRssDqEQbYU317QQWUqQrQFsERk6Ut9YdXm5uG6tcGE8hCINrgjCfH6m4Ub2VcF5+xi+LAs61Or0WO0nE3ritXkr9HH4cPtxFVTrqdwwInUlg3r9Ga4ms2uSTG19gTwck4HL+d08GIymn2aLD6vRrMx7RZZLivs6/ev/wNNQyiS" \ No newline at end of file +window.navigationData = "eJylmltz2zYQhf+L8uppHcdJG7/Jkuy4sSyNKKfNZDIemFxJGFOECoCq3U7+e4cXkSABLFbOWyKf8x2QuHLJb/8NNDzrwcUgTjlkenAy2DG9GVwMtiLJU1C/Vr//stHbdHAyeOJZMrg4OxnEG54mErLBxbcG8SfXmzlbwzDXmwX8nXMJyWynuchUy+WZBrlicYtGbL3Y9x9+nKBpbYx+2eEJPfTpx9/evj8z8NsVa2l7Jjl7NG7HdsW6gHem9x+0aRbMJUfohex0LsWeJyBb7CrP4vKmHbAdXZf34dzgrUEP4xiUWoonyBBgV4gQcwX3Cm1brbAY3w0KSCmkskdk9TtpRBrNnRSukUigBUKWbxucS9rN+N3sg1Z9VWizDMoLPCLF7fNH1uJhHIs8041BeZJ8ciQgV1psqzvwHG9YtobQ5WAWf9B4LuYhckdD6odS3dLilCkF3u7tIt+ekTuXkmC70Lhcb4Tk/7JCXVzutWR1j/nD/J7jo4o1B9SrEk0rOfiIoCD4ksVPxcDLIC2MkGkeE0Jw26sC74SO8t1OSA3JK8MtBLEht2It8kD/ueVYgGMF8dIdWhTtWTf8fI8BCxlzFYs9yBcc3ZWhwMOa5GcdFBjmJtuzlCcjka34OpeE0ep1EGJIk9uhJaAjzXSg3ywlhp2u2GjD0hSCw8FSBrCTTIo03UJoGNvSAPgatDGFhVRBvtsRiLkTwz3jaXFqvGIxKcdjCQR9AclXgQnTlaFArhTP1oRxYilR7Eu9zgx3PIDtKzHsrOiXMxxoaDBUlDzhnIMg0B2HZi9A7USmjMOS8RjVdktfjj0+jcWW8WwBSqS5YwVyHLbfJKVFNhaoLRX+/O3H83en51bEl2IBcC1y/oh9YwlF3CiVgzwqgpcWesR0xQ4PZQT6dsVkraaDi9UGf9AxuAcxgq33yR29zbpwQOUgtLsMqNf2IwLqng0FRKAUF1k1fKZcbZmON4QYVfmqMbStfe4w8zlTgdyDA139TnvOfFRasljXLY+0kGDP/RroEofOzqejXnmmz2w16AkGn/Q9qFMdxntnoxPfU6PHDnyy9/BOdWC99Uz0HrkvDECR2WiDLTEF7p6JHrgpRvcwwizsRfgtWNBSskyx8lkZnzh9Ia0ze4ursXFa3VlKsU1zuNstRK5BFuW68l/9iuNhPlrCUL3Rdsx2ZrsD+EIcirgGHZX+iCcwl2KnFqDyVBfl0brrPHkEZyg8dMfIN4pS962Zr6n7ujzN7T4ip/H8VKBVPqfnukvopPimL4654Nb0c5HHX7LlDTVgPLka3t8uH27GD8vZ58ndw+h2eDONXCX6w17ldiBV+hVPNcgxrFie6pukXHpHKeNb48rasngd4zeh9fsMJNMw3ondZ3iZM+6svNcRDjXCboojIxZvwOoax1HpTXKwxIVFNBb8KaE8ZYSOYeYTSKX1nlFH4yloljDNcOI2Trat0H9I1KA0z9Y2rP4D6Zh4Xd/7eskcCfHEoarq9If7AYtYQqN87bK6RsYhy2lAX9GUbXXck+Jn0h1ZTKL57C6aPCy/zifGBKzeBVScrsb/LiC6v/xjMlrWExQBOoTHv+nBXmxWMQEnes5orRFoWkYE/be0XWT7hEBouiUOoZt6VoDa6ELA5hXAGDTjaai1fTkZP2eSbUGDJCe0DizEW+QP3/2Q9VWxaAkpkEupJzX1WEKQpUXBnVcL4bvn1BMCuMgIE84W4+hiCaW02dChQPs9CIHuNR0ZRelavwutRuLnDCvGqccCqrL+TDyG2X0pAat3ZGwjxbDO44tFNFQobMX61SMbddCEQCIr/4OTKlEAVb1DIAwpS4uBy+cArBsqAYZojj/G2zYE6JKT8LSlwSUn4Mf40DFURFivNIMRHcUZJ7bUke+AqUbhmkl9U0CKUtEebsWaEzZdzIbFEfYMyk5h1LaoI8NnIcaU79po+FJKxpI61ePAQrqflFlE+3uyrr1aQ6YrVkddMnTVcclJ+KJCQdpnPA56CGXX8TjIIQuo91mREHo1ZEVPrrAS8vDsGbE9JJ+EeLKei6uTqlMbLPt4Kg0muasJEduPBex9zKTaOhrZUwvrHChoJa/rzrebKNcpDfGrb4oiXdQP1i9ucFdDI/a+SbVxjm9RbdYsG7E0fWTxk3WAMYmWjM71j9WuhlImV1Uxs/4ax021dUeRscHqEAbZUjy/oIPKVIRoC2CJyNKX+sKqzc3DdWuDCeUhEG1wRxLi9TcLN7KvCs7ZxfBuWdanHkb30XI2rStWk79Gn4Z31xNXvbqewgEnUrc2rNOr4cNsdkmKqbVHgJdzOng5p4MXk9Hsy2Tx9WE0G9NukeWywr7/+P4/SRhJaA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 1abc79a1c..d58dfbc8a 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJzFnW2T2zaWtv9L+2tvHuGFesk3x3Yy3klsl+3M7pRrSkVL7G6O1aKWpBx7p+a/P0WAlICDG+Qhpc5+iTvdxMEhcQMEznUA/uumLP6obn789K+bL/l+e/OjvL3Zp4/ZzY83m12e7eub25tjubv58eax2B53WfX/7K9/eKgfdze3N5tdWlVZdfPjzc2/b082kvnJyn/l9cO79D57fqwf3mf/c8zLbPv2UOfFvjqZzvd1Vt6lm7P1nlKg5tubQ1o2vp6cPvsiZlKfnCn2r8qyKC+o+Fmxz1oTfQ702Yk79z7b5mW2qfP9/WUulp6haztaZvWx3H8sLvHR2qiL67gnZ6uFSGSv6E7e1t8P/Y6OVJg61/t4l56q+ZqWefrZ6TGPd+l0y3/03VFQFbp6ZN3zc3s3VmbvyuJrvs3OfefuuN+Ydugq9S6bXtt9Vj/fbLKq+lh8yfbx6vzrptd3rLLfq777ai8YWcO56cx4UQXjqP117zi6PDfB+U7NCPai2GYni9n++Hiyh67sd731z+ns59H75+evf331cv3x7fr9q5/fv/rwl/XHt3999WZk1c/u0nyXbdd1sS6zuzKrHtZ127h9LkGD2M/fXn/48PrNL5d5+ZhXVb6/f2ofP7z68OH128neVVlV5cWlfkFp/dxctt9nRv98neFi1xDdq/9+8Zfnb355dYkLjviyb5uHdH+fjXh2kUdyRRH2uX6pIqd4z5Unx+/xWh30+Czc9rrnm01x3Nenayvseezqa8j0xdvf3v366mNEpr01O+rcFI+HXVYPqjN63wNevn7z+uPr55d6me/zOk+v7SVLfP0ujtQcwz9HaseqLh7tYNqOIQPDY1+J6ZLrxsO1bdWJVT/rxsG1bdbBR9V399DP12/+9vzX1y/XH37/6T9fvfhoR8L1x7+/i4lv0OV8/zXd5dt1dfz8z2xT25Fw3Uzlr+99J8bnLz6+fX8F3ztlppu6KP8Uz73nfqnb3iO/ks/nrvXyXfFuoC95l0zvPC/fvX23fvH2zc+vf/n9/fOPr9++Wb96//7te26lz7aH4rDeFPu7/P5Yps0Lat0fC0Cmenz7z79+XL94/uuL33+13vV18ph7//xSrzfpbnPcWQd5PZzr4V9f/X396r/fvX3/cZJzX7Lv6+zboSjrS/2S8aXRyaXWcmxmPVJIiXAiY8W+qstj051H1fbMLzhq/h4LxmzSY5WN9KItcp363W7LfAjbi2rHbR9OHBlehYX+NFVEqp4oEXD3F+ol6t9I8YzwjKek+IMbJat+v1yNHeuHosz/14ynzTj0S5m2E8aot/EiT6yvgYpHqavnvidpa9A3lrImeNWnq+EHxlAVz6dBTTWR2qyaIi235P+FwoL6Lxea9zCu1rLI0akNHPMw1s78dv2z2/EK7XalceGi4eA6WrlEG31a+CndfGkWRPts15TJ9nW+GdZFf6mn1Qij7jF6GXgAU7TD8pCjo4m+9WiK9/CG9cX3jKO1N0X94XhoVmDZdpruAgv/RxrEflxFj+FDumb7Rx2/QAu9HmNd/FrcF8f+uQa++k9rb1rnxLZ1b/SydgQOjWqziCeyF2nE/AKXPm3LxCoc0yzo/qaM+3FfOIP9GC96lNHzQIZlMeCDHGYPUbci1z+xOvpqHSWR2O1O0km/VyyxjPWnTzEDD4khG4Y3jnZe5tWm+JqV33sV41/1tDoBdY1RB7mhCW2AHRh+8vGaJYAZ0dq7C574KXvVjHrApzuY0t9ovZwONlxjX2vSG2U0JKrPacPXljS+cDlPb5tGCzxtG/dXO6bN43c8oUUG3RpuIZY/YYtxwmfg0j+llS4KkKH7m94y00Jg/T7ImT43R1385wcnhYPrRV38sxpO2xh4FqEqPtRp3T9hCi78UxRBqpugB+fOpqshdIOtBVy/0wK/3aUvHtLdLhuasgYXPm0L4OrGtEB4Z1PeljE/OG9NtgfZ+Af/jJXVMM6D9TarNmVuMveneEPKT/ZMzqXQvB4SlQnpIXW1/Y+8+o98/5CVeW2SGkZ5xB87Ix6BkfNCn0gvfrUvi93uMRsISYRXPnk/RvWN7Mj05ib2ZOwJsyszfRjqy9AHbmce4wOzN8f9Gdmd476N688RuUzq0D0+jerR0KfJXbqnFf0+/UtWOzHkoqyGujYu8OQ9vKfakR09cscT+3uvX8xuP86jod7f5xF3EJjgEXMsGPRu5JAw6Om4kaFfZpMGiGEPR40TfR5OHi6G29sfNd4Uz7+m+a7ZbPizSWceHDYiJZ583Oird+TAEbvpCauuYceGl1/jPRoaOXpd4g4dU3xijh3D/o0cPBi++rr/W1bmd/1RdP+qJ9c3rWukpt0bmvgGDD1gvvYYdQ8pNqibq1Ju3UxlYj9GqhH7NO79BeQw6aUV8WXUmyrwZfLrKdJabt+0m1SGo3zBhU/cQ2F1ozppcGdT3jcxNxivmb763Rb43kLs54e8vwXohU/cArC6US0Q3NmUFoi5wWgBbv3brE7z3UgPToWu44P5Z5wHbZHr1F/VaX2sRnpwKnQdH+q83o19CF2ZK3lgtxWOcoCxE5FdvwEDZ2A3tj3OxbOu+HS/nDHqbbPIkb2jk3PJ045LtKIxI5J7HxPGIlD18CgUqdN5uh+2X3ofbff3sVs3ubfl2Wfd08ljZ4rjnFn1213aCep9Vh2KvTMPds46Os9T6NWX3Kk/9eVXx54CB7c2eh481qmR82Gug49ZVaX3U5rm2bnoBc5osdJqdvbnZfGY5vv3WVXsjmHWCDj359nWlChPJThNOOjA3/wxmOEAGXanO/C6qo5ZOcaB3JS4mgO/3aXdeVfDdT/epWV78dWqbSLvvWc9ObV2106vtE0EPLDv1+zhz2yBy+/ZVN9mA/Crb/V2YfUf7DEfVvK/5dVjWm8ehp1oTwexun9si4105fy6r7LyaxZWaH8NXgKRXWKfq7pMN3V7Sx/qogzfda1NdG3/26b1cfx8ZahG1sSlx0j8VV98yTOb/TXFqab0pit9Na8arOaey8h26FwwiH4cyqLONiT6McG3KtuUWT3etVO5qz2ltnu9MI3wBi0JGU6Z39h27F0iTvFvUt961hW7xA8Sz8ur91MVlVdIUxM8cqN63aEh2W/pt+f3E57RycBj+q1vajXBt23Wnos10qVTuat5kh2KzcN4R7piV/Pjfkp3v7+4r3s+VNOGnIvHG7K/evbCP6eYunK+5Infk6SiUa9H5z6iI4Z7uOxQ3fbaKXV6Y4K3SWnMjTfF0lOxi/0os7TOfs7MVI3vhil1dyp1sRfh3hu+L6ZsO/seOISS71HkqNwhZ+6zpm2yquo/0WuqH97JKhOduivKjWvjCh5+OJ0LyHZo6CjBUfWbZ/PTd7KHd4w75sl8/v75bCG1Fi717jHfbnfZH2nP1CgYYNwil9Zf1WlZv26iN+mmzr9mvxb3Ob+hTOn8XHrXlr7Uq+Nhm9bZWNnYUtdTTnOU9/NDDs/9HvKlKZse8kYl5bnsNTyKHkXOcemQ3meX++Ttu+uNvBGf4MVPOzeIVzlmloDvclT2BsOf3iSOSZ6g0D3nwfTE8bl+BBqJxSahX+TiP0MjqMrxGqF3ObllIu5wW6bHD3enVm/UmPgFL37alolXOaZl8F1GWibd1Md0Z4tMcMsWz7vi1/OrTzG9j2lYMaP8yL4dTOBs8hPqDFzpGfnZghhBEOfodU+rYVjbGPkGtzXlvRPxgvPKYdffo9DYQxgWJ7d2nLfYW30/fJhSf2/u4rAvLFo70q/Hu3RdIkLGcguUvppXdd/SOe4Oa+nc4wcno7LXiYHt0own4Y9ZcZQYuhNc++RjF65x5PgV3uK0MSTqDGsc6fUCtAnkqxGn3Gv/nDYJapzSJt4tXtAmyBl+m8S8cDOdhqEzcS1e4mnbZ6DeMa3Uc9MT2mrYseEW43nktNvHMt1XqQkm9tJ1et3TthGsbUzLBLc1iZ9hN3jsbJwHz3dhkjLDiXQ31AZsP3q4GfaAwcxG1G25+Lsyu8u/jfbDEvFDV/gqPlXp15G6aEtMrt1Ps4RZU04eXzCNMVeO7Jb+2NSdeTCyumduQeacy95WbKpudmqP9eJUaqIL9EuZzw+H98Wxzsomomt+Onlkv5PZxWCD60Y2wnDFbw+OBgYqb669RAWHtEwfx9f27FSuP2CN7y2aM5OWm4d3Ez2ypa/kF22kXxps1hT9kG+zd2VxqN5n1XFXN19NpWDE85hR8EL9DOj1WjJlfEm2rXH8l2QnVX5qQ74XpyJP6Q79pjPfK9Z3nfu7c/BF4mm1D3+VeITFkQ/yJNgRDXsu8wQtezY+ummDope07X0wlFzqiEX7TaEq32aH1uToBg8f0NXUGfH7Enn2eet8Z/rlq5+f//7rx/Xrl+2H7178+vz1bx9Orp8/Nd2BHlxgZIs732O+y3d1Vr7M7tLjrn69NUvzF7s0d16O5080t07Ey4z0I9hR0Z36+iLdPGS0I4B872fbrsSmKVGcSkx14Ew4BzLN3c0kXweRRl9i/4uXv2V1uk3rtLe+x8328Xwdd+Q5Bz2zyvvQfVdF+/ve7PlwnrLPynOyxguUQW47XWe9p0S/ZDq3eanY4yodSshm2MF96h4VAN2pqwBeP/a5OE3dPIWwoZvf9jbzeZ36/tWHd2/ffHhlvsN5Ho3sVwetIf+SAWeNQ04TnhelL96+pB/6jNrvD1ahYrE637xpPtc5sm6TH7e+xAcnshl8qRU/ZXDd5Ed9svX3d6/Wz1+8ePXhA/xiaX/Nz07fJ/1+yNY2h3AAz0QNMvzs+7j3GEd5n/TmeOqGVGJpmPTN5UQbbBUDBUe2sR8MDnJBJ9X+jJEQyrIWc9TkDa4fcifTeZqjnqEncBR+A/kSh0d8VHms4xFxfsh4D/lDNpC13yu9FCRHc2p7xkmPRqWjjhy3ebbf8Nrp7MW51OUu2E2f1fNxz/1ZWywdIeUeJ0p7bHe2/bApmKo9eXIqW7VlL3enGu/F9Sof2XtPHkzppL4bXp8859YOvyOCay/pm7td8cfrfZVtjmXWHuc+vu5nxkzeminPZnofTHjPMScPh5/SKvu9hHH6Ac8Oh89plR3LgQc0xh33W4MmYJzVWTnlqbmGDq6h6zj6Obsrym718CH96sRM2T5aG20ifdXauI57G3PR86rKSsOo8vt9vr9/vrsf76U1lXamKmsq3cX3Zl7H2b9m36/l7Bdj6prOvp7Q3LZkfu1G/uCvx0e6M7QeH+nS1osmjXfKjy1dzy0TOJrgTlfuSm4cisNfs+/v0hwefzPgy6E4fMm+H2zh6zk09aVoHBqK/o11KNs3oVfnvf5qvz0U/QuWiHvWlDPPzc6mruks+c7dhf76O0ufyOXmxbrbZTsni2FC+1tbh9ZW7du6prsfs132mNXlhPeBNVA7Bq7j2ENdHz7mj1lxnNDSTeH6VPg6DuX7ze64zVoy8Jd8X7/ev3398oX9Iuek6V1rMt+a3tMs9vN9kW83O2PymrM+a/FD3QRk7ye0si1fnctfx63HNm3yYz3h6XVnAdX19Z7TvnhRNINC/a4s7vJd1p3Y9V8P2f73fXo+5nzKbHRfbKzxgzVetsb/eMj2x8D4dW6o2L9Id7tmu+94f4v95lz2Ou4cjtVDtn3uLh2mr9usMW8dcvXVW9ngzgm+ncpdx41q4hT0ypPPiuTrjPCjfy/zREf8RNyx3vSfyDPapfx+/3r/vuX071JnXz7fMbOa6hD9Ie3ZmT/WPTNUvrfA4Kfj3V02YYJsbLTQ4XNn40runSc3hCzyvTub2HQmruPcscqaL36Od+lYZc0c/hJHaKDt9JmNfm9Ol10U+m6OQhhTz7NTkaH7Pd9GT5zqdNHH/ggn8MP9FSfOyXHJHgaz7Q1/h660pYaj3xwX8oFpB6mbFQoZrHSXVu4XXkY/gaa8N7u5zrMw/4zxoy1wccVF8fmFPTtlVPVF8XlzKnaxE4eHYp+9OT5+HhrIiRem3L4rd7EbA+whrP+CzkiHwtOs76U5hn5glkavvmBgHL5pWBn33oP7YjwCbiQfFLjkDTHMJHvqZMPJyI3GFpXpt3XkSGeGT+fSV3SpKO/TfXv1RL+IiSs6V2bbvGzQ/bHMJzpHTFzRuSG82ucVi7MOuuN2OXLwVjtIcXJjhkpe1AnHDIUsR3y4tz3Z7HuSg8+GDSSv6/3AtpbLnP+c77f5/v63+CnyY/xurQ0dLH+Zyyaz6C+9AXSet8YQI0NpqqOnZA2z0b0naMlz92Qu68xdyWnWANH3DYiBGnkfhPgzhgj/+wfXHCOGPtOQwxz+qZ63AfdNZ+1JXK4Hc9SY3hpDfWfejnfUlezpA97DEg0uvUCSp5Gzfih6FrW4yvNI2ZbuezDhDQ5t6+0PN0RcOpVmzPLZLjVLTfcgBK4zzVpzOKe7zw1PIh6AHZzrwMuvNXoNzRDilU+YFuAbvyBJucc7dmryKKeCfWNjXBrcKzbBITMpn9Z+p6KXOAN0nRf74YTi8NqnTiqO1DgisRjc3+XaDfwZK1yGO4xE45g33GRjvjMDS9CYI5zVZ68TvlIboMEYeZ3LLtDnUDZXWA8vkcu/jZ7Mj7f7Xc+EH1TfFCpsoYsdePS/XsGpfuB7FSMqP/SCQ1A1gxKyKq7Sx+xDXo+776ZQlfec8TPGAZN/Pa76rsjFlRt46H0DglO/W2qKC14XDz8NMNzfo2Uuw35FOfRu6q/4mbHBekXF73rQvYFpOttFzoR9vJvbbd5ckO44oflBZ0/W2Jn2E1wejOYPuskL6I93jRdAH3JvRAx9vItD04QB31jThfFO2V15F/bm1srT9GfXxct6tOvmtfr0wAjNiJnECz35AmKg6jEriZ5b75/Dv77EwdbG8LxyvHttRPEC59oo4vVdazOsLvWvNfNETo4f7nzvJo53rKjr6GEEBFynDSADgbT+o2ACT+HlF4waj+m3V/u6zPviL/E6m0VOdire92DwbcZarC/3u8eb4bTvITfclnllzkR8W3webBR65YWBTS/HbWy1YZ7bUNME9xkbvR/TvKddsDddoWs40G0NGOtDtyvgSm6cc71Gt8053+tajcLK+cLO8NO+epwBHaYe3t1Gr/xzO4xf7eQOc77PS/VKHBqnV+SGdxwuOHcrcMS56AljhLQWXoTQvYHYzM3/XstwxQPfZ+mrmBw1TD4TGlbdXTLuufqfiOw7XBhVwzhVmBSLVR0/ThjWO3COMLPS5sOPbqfs6dKk/uZzj7TkRa58zcr8rifuTOo/XT66UqKqZlfYtwFZ2WueNFeTVMON5jh3MD1xntbNzZofrvxx+IRw7MLjXcr6YMwIRwbeEMADzrthuOqBxRqtl7M2g5USYf/NdJDhGElw6cWREfJJHmaNz0ac/Bbe3iX9DjrD7n48R9pgyrr3pY1d8YpexZl8O7GJnIJXcaTM7BpxvenNs4l4Q0tfySX/WL+xLvEPBWS7NDyAIFeY4wjPBc5ZVxE/2Mdd9Tnjjm3vB3YF278/dXzXqWVEKLf1PZaWl26+tAtee7ABr3rne9K7rth0JzaDW9bdupmb1AeqxJ+p76+Y9416TvU772vVvbX2f5qaWRm7Ya/Qmo93KXeC79b8eJeOmt0POvFieGFF6ucurAarfjWwsCL1shZWg5X+bWA1QyplrWb6K23PteBVeb54VIXuMHw6Wro5tfpYDtBhdPUlQ/Rn88Xo7OX0ip91NrZnG30PA95vdEDr30Ufd4q1eX6MK/nebAvP6++XPKuzlSd4Wk1/cw+SH+HXuegFzkBVs1L+0NVPGNWLVscL78F7m7S/O+4IY5v3GDf6E/LibjDy8sa4MZyeF3eFmaU3yp2BZL0eZzg5e2NcYaTuxb3hZvANOAT678veGLxz0XWWCcNDxKkud7EwNKtyb2Ywd7xLYh7jy7l0t8/pCi6Zavdpz4wr8MMpcmHlwxu/gsqZW7wYlR+rPjQSVNxePr7SiOAHDmSiV16AScj3SHlVDX2RFBftd+Gn73ahPLBY7/Pn83e7zGJ9x4Hp3D1TgMzvlI6rvBpf+Sj1930RtDsxurmEO3tyL/4zlwRBvf0rgrra/kde/Ue+f8jK3J4SiJ+Rd/OXLRBCF8H64Akcm9x0rX+8c3NHuDVhFRP6NrCIuepz5K5pQi/Rkuaqrg0dZxj1jHWe4RhHWO8r4Afj6MB+N7whq07L+nVTuT0/7dcmxDfcAXpKXXW37cDehUE/Jn4qoPepTN7uOuwtc9cr0z23nYd3mf5Ze0un7ii9/CM1kz5Pc4X9otN2iQ5VPJhF7lfLSxkf/gIOJz+cfvmGnQx+rQ/wXPDpnQu35I7fiHuND+1M/MTOwM7fj/Rg1MH3QqzEE0YFe6vkRQaj9zlxk26/S6z9umNd6o8U9jvEiBaOdqfM7vJvkx3qSl/TpeEgZr9TzEDmaLcGgpkDTnECmgyXIr3+Q50yH5i58kkzBGFl7Jc4vaeeCeiHoYPGY57UD7yjxrnONHk9BqTmfXE17E1T9uu57DXcGTHqOY6MHe16XdgXEyTSFbqGA0WZ3+f7l/xXkuOHLTv2hcRw5/VAUnqfO6z8dK473Ucl+vfAYXe6spxZC9udoQVZzBXWIozrxtCEEfrAmjhyHZgwij/rCk10IPpC4URGIwUueL0w43p9FY+K7cVuObaGnPDhpl5fJ3+9aaTjQ8G0XidZAbVhh1yp/d6LoJq/XiCigX2JJ+usvYjG076K1u3ru+eAQlKjW2Jq1XfpY777vu7PfzjX618+tdL7/Gu2Z9fpXT21Sm5ll1aTb76wqzpfO7W6orxf932m4VzZ6cqpVR3yTd27cDnXdb50amXV8TOnInvZiErcocOmLP52l7YjTPPh3Hil6OpLdscP7s+JVsjdqQPvb+BR/FdeP3D2pUcKXPBA2kNW+w8g7au2O6aVsTkidruXtxXyCzbXMOEa6eTg4a29PvKOcB12KS4qxt7tSIE/p5eBOq/TcoObuYv6MNE/W5LfYkMbur2r37e7jRpVjWs6UPLPa8NY5VdpTPRMBrZ6jeiUUdc7W2O7aL+7crZaiESePP4p+Ab6X4rivC3G2G/dxpeOTbDyq7cxlvdZVey+OnN6t1r/ksuqs7skms22wZZRt8rwsmtUS/tTWOOkfkMr+yWrnW8v91UKr7xmdJdXGTe6i2+sn2COdeVc7Gqe+IEhph+cwNCQF1QYv+Iv9Loe+ZdcpkOUsxjWZf5+gebyCmubWn9mL+x7nq7DsbZ0ll29tVWDqy5Obc56qL+2wRURro022dvTp3zpgRFu9cFVlwwZh0OzQnG/bT1c1bP0cPicVtlx8PPV4Q31Z5hnW7o9k+HNqSxvmybbJxhnZ/gzIsY+whcSZGf5wQqw9/kQF2h0luJfctkQ9i69zyqzP7BsvyENqwwvu2K1PdMUcN2FFZfFt+99Mwb3gqeaKAR1cOcHnvfx/aPfvntfTu6v2lzPyJzg1B2fCIT1ct7/nDrrtLzP6r4hNqzbluENsBEfqLDeZ+m2OTu/7R42PwFLDF96ma7tFt8+YXtXXFYZjcDB+uhF46pUzmz//fM3H9cf//7u1frF7x8+vv1t/fHtX1+9Wb/67xd/ef7ml1en2r+mZd7QotPkc6DgNTz67efn67dvf+L40F56tVo/vmPX+vHdtWp9/+rF27+9ev/39Yu3L1lPPijE8uQftzf5fpt9u/nxX82BYiYX5ccb+YP6YXVze3OXZ7ttdfPjp45+bIrHR7v9cFtsjubHf7SX/S3bmHMPfvxkr/5/s5vbT7PbZPlDslr+4x+3n7rC5g/mF52N829MQXFz+0mggiIoKLyC8ub2k0QFZVBQegXVze0nhQqqoKDyCuqb20/6Vssfkpn2CuqgoPYKJje3n5JbvfhhLqRXMAkKJl7B+c3tp/lton7QK6/cPCg398otYhUugoILr+Dy5vbTAj2bZVBw6RVc3dx+WgJPV0G5ld/8jRpWsP1D5QgiHaMdqDoB1OPLRzSiEFh5oYKELyHRCENA9YlQRcKXkWjEIRR4WCIUkvCVJBp9CH2bzH4QMvELh2ISvppEIxKRQK9DRQlfUqIRipjDwqGqhC8rsYzecigs4StLrOK3HKpL+PKSjWIEVLQM9SV9fUmjryUsHOpLkuHJ6AsqW4IRyteXVNF7lqG+pK8v2UhGwm4hQ4FJX2CykYyE3UKGApO+wGQjGYkH5VBg0heYbCQj4cAsQ4FJX2Cy0YzUsHCoMOkrTDaakbBfyFBh0leYajQjYb9QocKUrzDVaEZCeapQYcpXmDJvQChPFSpMkZdgoxkJ5anAe9BXmGo0o2a3cvFDokjhUGHKV5hqNKPErUp+WJG3kwoVpnyFqUYzSjY1L7XwC4cKU77CVKMZhV/9ocKUrzC1jN9zqDDlK0yt4vccKkz5CtOz6D3rUGHaV5huNKNgx9ChwrSvMC2j96xDhWlfYVpF71mHCtNkqqXj9wxmW77CtFEY7M86VJj2Fabn8XsOFaZ9helF3O1QYdpXmDYKgyOJDhWmfYXpVdztUGHaV1gyizZVEios8RWWiOg9J6HCEl9hiVEYHACTUGGJr7BERe85CRWW+ApLdPyeQ4UlZEKfxO8ZzOl9hSVGYXDcTkKFJb7CkkX8nkOFJb7CkmXc7VBhia+wxCgMvjGSUGGJr7D5LOr2PFTY3FfYPK6weaiwua+weaMZDWdD81Bhc19h87jC5qHC5r7C5nGFzUOFzX2FzeMKm4cKm5NlY6MZDSdxc7B09BU2jytsHips7itsvozfc6iwua+w+Sp+z6HC5r7CFo1mNJx7LkKFLXyFLUT0nhehwha+whYy6vYiVNjCV9ii0YyGc5JFqLCFr7BFfB62CBW28BW2iM/DFqHCFr7CFvF52CJU2IJEJxrNaDgnWYAAha+wRXwetggVtvAVtogrbBEqbOErbGkUBqcVy1BhS19hy7jClqHClr7ClnGFLUOFLX2FLY3C5rda/bBS/lpyGSps6StsaWJeOCIUKmzpK2yZxO85VNjSV9gyrrBlqLClr7ClURh8xS5DhS1JDCyusCUIg/kKW8Zn+stQYUtfYSujsBUKMa5Cha18ha0azSQzWDhU2MpX2CqusFWosJWvsFVcYatQYStfYatGMwl8V61Cha18ha3iCluFClv5ClvNo021ChW28hW2WsSbKlTYylfYahlvqlBhKxJpjY9hKxBtpeHWWbSt7N/84s7v2vJGZTjyOQNB1xmJus7iS0r7N1qeBF5n8VWl/RstT2KvMx1tN/s3Wp7EX2dJtOns32h5EoKdxYc1+zdankRhZ4ue9gNx2BkJxM6M9OB8w/6NlifB2Fl8nWn/RssT/Yl4MEOgiH8Q8hfx9oNBf6I/E8iPtB+K+9PAv4nlJ3DuIlDon8b+RXzKJlD4n8b/RXzWJhABoAjARPVjzw/oj1IAE9iPPT+gPwoCRHwJKhALoDDAxPcj+kc4gPAAYUL8CWYggAgIggSEjM/jBIACglABIeMvWgG4gCBgQJhYf4IxDEADgrABIXv0B+iAIHhAyPi6VABAIAghECbon8AJpQCMQBBIIEzcP1kitikAJhCEEwgT+k8wcASkQBBUIEz0f46ZI4AFgtACYQDAXECaBXiBIMBAGAYwj5BHoD/CDITBAHM8/gNqIAg2ECoeEREAHAhCDoSKB3YFYAeCwANheMAcj78AHwjCD0QPQBCAIAiCEIShAnM8fgCIIAhFEAYMRMZfwBEEAQnCsIHI+AtQgiAsQRg8MMfjB6AJguAEYQjBfAHhNZAfAQrCMII5ShQQgCgIghSEoQTzFSwOxEeggjCcYDGDxRF6J9ozpGCB+y4AC4KQBWFgwULC6oH0CFsQBhcscN4AUB6hC8IAg4WGxYHwCF8QBhkssPABYRAEMQhDDRZYeAAyCEIZRNLz4gWcQRDQIAw7WOAXD0ANgrAGYfDBYokzL4D2CG4QhiAsVrc6+WE+m5PyQHyEOAgDEZb4xQOYgyDQQRiOsBSo+QF1EAQ7CEMSlvi9A8CDIORBGJiwxO8dwB4EgQ/C8IRlJPEFyI/wB2GQwjKS+wLkRxCEMFRhOYf1AwghCIUQBiws4bgJMIQgHEIYtLCEAS0BSIQgKELMe6Z9AEYIQiOEAQwoE00AGiEIjhCGMCzhsA14hCBAQhjGsMLSB0hCECYhDGZY4VQvQCUEwRJiHktuEwBLCMIlhEENK9xzAJkQBE0IQxtWuOcAOCEInRAGOKzwjAnwCUEAhTDMYYV7DkAUgjAKYbDDKpI4BqRHMIUw5GGFB24AKgQhFcLAhxXuOoBVCAIrxCKaTCkArRAEVwhDIPCECfAKQYCFWPTEWwCyEIRZiGUc7QtALQTBFmIZZ68CgAtByIVYxid8AF0Iwi7Esme5AeiFIPhCLHuWGwBgCEIwhIESeMIJEIYgDEMs48kkAlAMQTCGMGRihVerAGQIQjLEsifaAliGIDBDGD4hZnjoBTxDEKAhDKPAM25ANARBGmLVM+kDUEMQqiEs1sDqB1xDELAhDKuIPD+ANgRhG2LVE20GdEMQvCFWPdFmADgEIRzCQAsxw68+ADkEoRzCgAsxw28vADoEIR3CwItIvA6wDkFghzD8Aq+ZAO0QBHfIWTzvRALcIQnukLP48CcB7pAEd0iDL+CaTQLaIQntkLP48CcB7ZCEdshZfPiTgHZIQjukoRdwzSgB7JAEdshZfPiTAHZIAjvkLJ5OJwHskAR2SAMvxAznFAPaIQntkD20QwLaIQntkIZe4FWLBLRDEtoh2x0OOK8Z4A5JcIc0+AIvWyTAHZLgDmk3OsxwbjTgHZLwDmk3O8zg9E8C4CEJ8JAiHnSRAHhIAjyk3fQwQxMwCYCHJMBD2n0PMzSDkQB4SAI8pN36MMMbAQDxkIR4SLv/AW9zkQB5SLoFwu6BwFtdJNoFQbdB2H0QeLuLRDshgq0Qdq8N7odwNwSRod0PIXA/QDsi6JYIgzHgJF6iPRF0U4ShGAJvnZFoXwTdGGEwhsDbZyTaG0E3RxiOATefSbQ7gm6PMBhDRDbCoB0SdIuEtCrEm2HQLgkCPqSyKsT9AJAPSciHNCQDPwEAPiQBH9KADBHZFgPIhyTkQyq75wt3I4A+JEEf0qAMIdFcRgL0IQn6kAZlCAknEwB9SII+pEEZQsK3OUAfkqAPaVCGiOyTAexDEvYhDcsQeK+MBPBDEvghDczAMVQJ4Ick8EMamCHwfhsJ6Ick9EManCHwnhsJ+Ick/ENqq0LcCwABkYSASB1fkUiAQCRBIFLbzYeR3WFoexhRoYEaQuFuACiIJBREGqwhFH6bAA4iCQeRBmwIvI9HAhIiCQmR2u5GxG8TwEIkYSHSsA3R7DABkxIAQySBIdLADYH3ekhAQyShIdLQDYE3TkiAQyTBIdLgDYF3IUjAQyThIdLwDaFwZwRARBIgIg3gEHp2q2c/CDKgAyAiCRCRid0Ki2eGgIhIQkSkQRxCw/EYIBFJkIg0iENodauWP0hFygMZEiQiDeIQGq8OABORhInIxO6MxQMygCKSQBFpIIfQWIaAikhCRaShHELDyTWgIpJQEWkwh9CQqknARSThInJuN8ri8RSAEUnAiDSgQyR4PARkRBIyIg3rEDiBVQI4IgkckXO7KzuyaxZtmyU6NLhD4Jw+CfiIJHxEGt4hcFKbBIBEEkAiDfIQSQLHAsBIJGEk0jAPgdOaJIAkkkASaaCHwHlFElASSSiJNNRDJHg8BJhEEkwiDfYQOLNIAk4iCSeRhnuIOYqVSsBJJOEk0nAPMcdCBKBEElAiDfgQOLdIAlIiCSmRC3tEQGQLN9rDTYRo4IeYwxkqgCWSwBJp4IfA2TkS0BJJaIk09EPg9BgJcIkkuEQa/CHmWIeAl0jCS6QBIGKOdQiIiSTERBoCIiCykICYSEJM5DKepyABMZGEmEiDQMQCD6iAmUjCTKRhIGKBdQygiSTQRBoIIhZYx4CaSEJNpKEgYoF1DLCJJNhEWmyyiBxHAHRIsIlc2WMrIkcSAB0ScCINCBE43UYCciIJOZGGhAicLyMBOpEEnUiDQsQCCxmwE0nYiTQsRCygkAE7kYSdSMNCBM6YkQCeSAJPpIUnSyxEAE8kgSdyFc9VlYCdSMJOpGEhAifdSABPJIEn0tAQsYQRA0BPJKEnahZPVlWAnihCT9TMHqACZ7gK4BNF8IkyPCTmADjjgvATNVPx+aUCAEURgKJm8UWKAgBFEYCiZlaEsCMrgFAUQShqZkWIUm8UQCiKIBRlkIhY4iNGAENRhKEoy1DgKkcBhKIIQlEzq0F8TAlgKIowFGWYSExEAKIoAlGUhSgw/UgBhqIIQ1H2pCicf6QARFEEoigLUXACkgIQRRGIoixEwTlECkAURSCKssdG4SQiBSiKIhRFWYoSawSgQ4JRlMUoOA1JAY6iCEdRlqOsYMxFAY6iCEdRlqPgRCQFOIoiHEVZjoIzkRTgKIpwFGU5Ck5FUoCjKMJRVHumFFQywCiKYBRlqIjE6RwKYBRFMIoyXCTSlQBHUYSjKMtRcOBMAY6iCEdRBotACKAARVGEoih7xhTOh1CAoyjCUZQ9ZwrnQyjAURThKMpyFBw2U4CjKHrclOUokUeITpyiR04pEY+bKXTqFD12ypIU/EZAB08FJ09ZFSrsADp8iqjQghQcblDoACp6ApUhIxJjdYUOoaKnUBk0ImeRRgBCpCdRKStECOYVOoyKnkalrBAX2AAQIj2RyrAROcNTI3QoFYEpyrAROYNjAWApirAUZdCIxFxbAZaiCEtRBo1IzLUVYCmKsBRl2IjEXFsBmKIITFGGjUjMtRWAKYrAFGVhCp5eApaiCEtRumd2CFCKIihF6XgIWwGSoghJUQaMSMzlFSApipAUZcCIxGBdAZKiCElRBoxIDNYVICmKkBTVkhQ8IAOSoghJUYmVIZ4WAJKiCElRiZUhyjBRAKQoAlJUYlUIOyIAKYqAFNWCFCgCwFEU4Sgqsac+4o4MQIoiIEVZkALBuAIgRRGQogwXkZjMKwBSFAEpynARiQ+uVACkKAJSlOEiEh9eqQBIUQSkKANGJGTzCoAURUCKMlxENmwelAcaJBxFGSwi5RzOrABHUYSjKINFZOQoS8BRFOEoynIUGKtQAKMoglHU3KoQT64BRlEEoyhDRWJNAFRIKIqaL/seIVAhoSjKUpSIA0CEBKKoFqLgaRGAKIpAFLWwIsSHggKIoghEUYaJSJxcoABEUQSiKAtRYLKeAgxFEYaiLEOByXoKMBRFGIoySETi5AYFGIoiDEUZJCJxcoMCDEURhqIW9hTcyCGl6JRSIkPLUPCUAjAURRiKsgwFhl0VQCiKIBRliAjO11SAoChCUNRS9HQjQFAUIShq2bM8AQBFEYCiDBCRODtEAYKiCEFRhohIfP6oAghFEYSilj2zQkBQFCEoamlFiOdEgKAoQlDU0ooQD+aAoChCUJQBIhJnlyhAUBQhKMoAEYlPm1SAoChCUJQlKFgFAKAoAlCUBSg4OUMBgKIIQFEWoEAOpwA/UYSfqFVPfo0C/EQRfqIMD5H45EsFAIoiAEUZHiLxMZIKABRFAIpaRbd9KoBPFMEnyuAQiY90VICfKMJP1MoeCo7HUsBPFOEnyvAQiU8qVACgKAJQtAEiEmfoaEBQNCEo2gARiTN0NCAomhAUbYiIxCf4aYBQNEEo2hARic/S0wChaIJQ9MzqEHZlDRiKJgxFGyQiE5QYoQFC0QShaINEZIK2vmuAUDRBKNoQEZmg5YkGBEUTgqINEcEnB2hAUDQhKHpmj6eHMtaAoGhCULTomRhqQFA0ISjaEBEMMjUgKJoQFG2ASCTapQFB0YSgaKHi0S4NCIomBEULHY92aUBQNCEoWiTRaJcGAEUTgKKFFWHkIHagQgJQtLAqxEMJACiaABRteIjEOVYaABRNAIoWVod4KAEARROAoluAAqOmGgAUTQCKNjxEJmh6rwE/0YSfaMNDJM7R0gCgaAJQtOEhmIJpwE804SfafpoDHx+lAUDRBKBow0Pwfi4N+Ikm/EQbIAKPodCAn2jCT7TlJzjHTAN+ogk/0Zaf4LEc4BNN8IluP9UBx3JATzShJ9p+rQOzBw3oiSb0RNsvduCXAYAnmsATbWBI5GUA4Ikm8EQbFoLTszRgJ5qwE21QCDwGRgNyogk50Zac4BxBDciJJuRE200oOCNDA3KiCTnRKroRSgNuogk30aoHI2vATTThJlr1ADwNuImmX/Owm1Dg6k6j73nQD3roHn6n0Tc96Ec9Wm4CR1H0WQ/6XY8Wm8BXIfqyR/BpDx3Nu9fw4x5Egzoer9bo+x70Ax8WmuClnUbf+KAf+dB2FMQTMvSdD/qhD7sBJTIhQ9/6oB/7sNgE80eNvvdBsIm22CQyIwPYRBNsog0FkfggPg2wiSbYRFtsEpnSAWyiCTbRFptEpnSAm2jCTbTlJjhbWANwogk40Uk8TqMBONEEnGgLTnC2sQbgRBNwohMrRDwjA+REE3KiLTmJ6AiQE03IibbkBKcra0BONCEn2pKTOZ6SAXKiCTnRlpzgfGMN0Ikm6ERbdLKAr0SATjRBJ9qQEPxCAuBEE3Ci7QYUPJoBbqIJN9GGg0ic7awBONEEnGgLTnC2swbgRBNwoi04icypADnRhJxou/8E7nzQAJxoAk70PL4tVANwogk40YaDRJYVgJtowk10y00QfNMAm2iCTbTFJjhdXANsogk20QaDSJwurgE30YSbaMNBJE4X1wCcaAJOtOEgkQgB4CaacBNtuQlON9eAm2jCTbTlJjjdXANuogk30YaDyAUeiAA40QScaANC5BKqGIATTcCJNiBE4nRzDciJJuRE95ETDciJJuREGxIicb65BuhEE3SiLTrBpzxqgE40QSfaopPYLQAdEnSiLTqBGZIaoBNN0Im26GSJuyJAJ5qgE23RSewOgA4JOtEWneCMcQ3QiSboRFt0sox8Rw4IkaATvZr13AJgJ5qwE21QiMQ55xqwE03YiV5ZIeLODOCJJvBEW3gCj0rQgJ1owk60ZSdLPBgAdqIJO9GWneCccQ3YiSbsRBsYInHOuAb0RBN6ou3JXXhyCuCJJvBEW3iCc841gCeawBNtN5/giQ1gJ5qwk2Q2i24GTAA6SQg6SSw6wTnvCUAnCUEniUUnOGU9AegkIegksegEH52ZAHSSEHSSWHQCXykJICcJISeJJSc45T0B6CQh6CSxu0/g/u4EoJOEoJPEohOcMp8AdpIQdpLMltHJeQLYSULYSWJQCJycJ4CcJIScJAaESJyxnwBykhBykggrQvzVRIBOEoJOEmG/lwMHkgSgk4Sgk0TYI+TgQJIAdJIQdJKI+BaoBJCThJCTxH6xBKfMJwCdJASdJHbvCRxIEkBOEkJOEgNCFD4FLgHkJCHkJLHfLMHp4gkgJwkhJ4mwx8jhgQCQk4SQk0TaYwxxRwbkJCHkJGk/WxL50CrQIUEnif1uyQz3BIBOEoJOEml1iHsCYCcJYSeJ/XIJzhdPADvpfveP25t8/zUr62z7er/Nvt38+OnTTfq5KnbHOtsey7TOi/3N7b9u1rn9c4MnTJ03P/7rpqHJP/7r37c3DYr48V///vdtV6n9dVed+VtTf/q5qst0U1dZVeXFvqqLMnOtL+Zn480h9yybm01WVeu6+JL5nqrkbKxJI+IbC2w1Ie2TreawFlO62X5if0hE+8Oq/VMT2B5ZX1aWRendgFOnUpPMbYqt93yFcJ6vHGvyrjG432ebRhSBu0o57i4utx347jSnmF9kvzg0/638FtZOC2umnM/2K7+TOL42rHmssaz2fVu66uO2W51/9R/gYuGYWbHNFGXYt1whNVtHxpmqvx8y35x0zXG1Xh/TXV5Vx8zT4crpNs2Zzyxb223eSCLdHdIyfczqrPQbVLji1syxZLcr/sj3VbY5llmZ/c8xq2pfc9oZ7prjg1hWD4fPaZUdy51vym3beTscNVNOps2yONZZeUjvM/OTZ3vmDn6C2TUCk8WB3L2YuWaZ4+Vxm2f7je+fdg0luh2KZ90Pun1JNdm89odl99rSs/aHpPvNatE+OsFs5GP9MNvs8uZ3jk/LpTtYMQV9NoUGKJ24d8l9XPXD7FAWX/Ot30kctTDb81g/ZPs636S1P+wL953dnJQx2hodDZpzMRyL/IfnWfT7r3RGd9V1j2aXAtd2Ueb/ayZDzWvpvkz3dfgC1O6gf4HldqwIK3DfKsn4CrZZneY7X1VL98HMugcjZt0PzAHErSb021EI983qGsRjcpMn4Qx5suv2pxnYBNdNTeQBubMw0T0gyR8d2rmuJ8e5+0QSnqOf082XzUO632c7R+zweTu9mzlbiBrfF3V1PByKZoUQVuS0wKV3gYY8dxRtjr64qIIyqw7FvvKHmpX7Xhe8PuXUsCvui6M38Ev3ZdRkjU+yGD5pR4XMsf9zdleUWbfSSr9mW7/3uC915hsqNPlQFF+823ebTDPnmJ/z/Tbf39MJf8NKnHGD6aK19ZhVVXpP2tptGebq52Sufij857dyOllzmAXH2ibdbY67tM4e02/EO/dem+97Mc3tGun4+nNn5iueojfp0e8XyjXSTZ9W3cDaTS7bf9t51rz7t51lLdpyy7bcam7/Fd0ILUR7RfNdHfsDUzCbh3S3y/akfWfuFFjMu0kfTzcnk3iYmLvS4fW/k8VgfrNyhzXJmymEU0xHzUz1GRNpVWWlGWrz+32+v0939/4q251Mz3njF7b8JfvuWxauZaYyjeXc73qJdA3x3jvWUJVtSrK2TpRrjDchpCOVcpevrfBOS4u2W+jTwqL9txV/0naXblI6b38/b7vNop3YLFq7i/b3y/b3y/b3q/b/V6uum3X9rZvMCdFW1Xw3uf2h64FKdz90pZai+6H707Ir3gW5ZDdflN1aq/nIiP2BuYhvnuTXrMzvcn990uRtOTMkbrOYAM86iBwpV9PM1XtrLN1siiNZ27kBhnk3zqyYOvTMBu95d/YwZw6GocXmAfgzKXdoZI4WnlkwO2uOSnKGMW57G6vZFjxX6b5Sk9moNicTbOEulZoDxttZe/cqU6OeQV7sUViuOenIeQDMd3ZgkkQO3ZUBM9ayaSLp5XFDVuau6rv+rdo+rNsRQHejVfuIutB20vbjeTt2zNvfz9vfL9qev2jtdqGVbtToIizdmLHqBppZN/TMunFKdOOL7EYceRqMuplCN2iKbpIhumFQLLtruoFQrE6j0qz74TRgzbsfmO/woviS+5NS9y2mO3tajrG3KfZ3uffWdSOzgrlks7Zgx3QXNeq0Hu5eSNyXXJmlTUf1X5cLd9mw6lS1YN6+MXmX1ZsHErOduUMq079jVRePlnV8a1ZP/nRw5aKOObMjhSbDEdqxy517RMwGCx7vNTXVNFKE8IYC5owzNI3mxs3xQs5agTewbrO79Lir1/nWcrv1ZpfmJPDiPQ3F6xPbbJf5wWs3viWSdtCQ3ZRIM19b1m6682PuMxcZCd5TtZY+f7fr/BCszF28yhSBjeu5ZhJ3PJE8lW7zalN8zcrvm3TzQMibe6PMvuSbQ9Ed6U7jTy8o5lzvZD7soI7ZBVOOxWOa+xMIl+DJbi6uTl4uOgGdlMQMbNqqyswQdhS8cye+QnfvvcVo61/9EbbJ93Oe9gl3MPVv7H5Nd/kWhxznLu/oJhdiyey1h+Kwti/FNuNgHcJwd5Rhtmpj9p9f6nUXdmkM36X5zo+ESTeQw+zEjeUv2fd19q2JjCKj3hKfbTQUs9NqzEjGyU7wenElzXthN7a+ZN8Pae6LyZ2lSm4nOxQHNAy4Y5Vc8BogeyQDnnRvTnUwQI8xt27XoUQcLtRZ8Foy26efd5mbi7HfHop8TwIPLr4YZZms+KBxd5rGFI413iCQ3S7b1WW6r9JN2F7uG0p283/NfCvYOupslz1mdenHh+ZufGjBiw9l+7Kgb2X3uYpFN2DzXqXWXvMrONdxl/6aGdy3JoviM5qYuaOyYmYAtAaBNXcarZmx39Zajfqm9IYx5mw3OxSbB28K5iXuMO8xGAidJ79q37kdqxdd+El0fE504V+hTkErZms1Fa+3WbUp8wMNK7ix0W6Vueoq6HLhhOhef534RBc6F9w2aZzwe527QGIOau2kHb2d3J7GdOnbwcRtwnwb4caBxJL3Ysm+HfIyq9Y5Sdlz3/JLpt6sKbJO1d4tnuI+oputcZ+hsU28dKNpirlat42wrov1png80FWK8MaskQbR6tddlDHzz84G831e5ynx0H2hjL3lMrsrs+ohzNF0874E7y11lz7mu+9rU8p7UbvJEcw33l2+q7OyXYzmW+MeWom6WmJmYt43GZhp3cHSMJAk3Hmn1LxhEVoNw0nCnS1LxXs13/vRzaWroA5OyG5s08xh4z6rIym1juK70XHOGzt8m15ipxcAcrXFnKP6puEr1g3/MWP+jVU3Pcm36LFW5rTnPqtt2x/K7C7/5g/H7jSf2anus7rKyq9ZWeXb7FAWB5Kp53Z+5uorNFlm1XFX/5HDlBjhZlhK5ghj6ghMuTkdgrkCuM9sLObzd5I/4hl2Y0nMGft9/jXbg9HKDfMz56YmN2zd0OS1jc21sTM0/quZlwPEfAjnCh7v0nVRfPZNutk+3BYiJuuDb9JNa2HG4ojJMrNxoID6KXfOlDBDaQ91fSj2O29hIt04n1K8HtoYqvPHjKQHNV8QdBY5vPGD4O+luwBjzii7QKs/8rjzGGamdPuW9OdD7iqhI0iamRUef+263U0xJzH53uS95/V3vHnFefq6Y9WaGfXJ95vdcZu1Dj/k+zrfF/l2Y0O5NCF77o5nC673dVbuUz+y4cZHNDP3pI3Vravj5382RNwOFEHavZdHMcawF6wL12pOw7Hv3NiNZb66uc9L3vuntVjVaQ0gjpv/zBsZ8qpZJ+d7b6K1dOcYzMh1XpEZhfO0khmz0wSrMOntFmK+9ayZvrCum+qgT6SVN+bs0sqd9wQocelOq5lTqV1xTxZjbrhfrXhNYKysH2jQzF19SibJMqYCS+4sUTHnYCiX1I0OrXjTeGum2WZXZ/ckwOZinI7YJzP2jUJg5c62khlPd4/ptzXNznSjRGrGU1iYRind2a865WJ16Q2amVn5mH5rQoA53UXgpUUyTW22j1mdbtM69ZdobmN0jirmEgikt7op5YK5nHy883xyLHThM2aanp2I/c8xL7Pm9yR05ZJ4Zj9vDIbRAjfhRjD7+uNdmh5yM7KhkO7cDU4yty02JuPrOfftp1bM9rxLYU6rdF98mtlTXWPhm8+ZqzGnfI29IPtUetlFzMVQY6nY19k3YsrbOcp2Koz9S3dDneYORp2l5rfB83LTfZgh5Me7NFjxh3ZdKfM93Rfp1zTfNRDlzuynBJbd5e+MOUjdpW33DTd5LNzwbpfNKlZsLcbGhYU7LHR79GSXE66Y07zHuzR8J3mwuEtdU/PT9r8uCnz+ocNYy25NwL+/NkPmgB+e28z6lKHGHhWM8XYqGxp3W7rLL5bMKWRnvK7JusUNHzHzuh7vUgNP/WWzO8nWfK+spVDWbvCFOaU6WYMwz92vp5jbSx7z7XaX/ZH6xxas3JcIM/b8mFdVvr9fm14cW6B5a8hRZuMhd0803Yx+lG0UvvPSrDqZt4oc90C8NasvKOdpjPIYLwLdFB/BzIp+/N5S925O4Rl0p2DMu6aRQTcrQMiuT3ekU3eAUzMDxft88yUMProdkxmD2hfmzb2vD2Vxl+9OqYB/PGT7495b5vnDibumYo7p+4Ls8JZuepFm7n8rGqdkuKR19c9MzSn2aKuVcFO15JL3Dj+bQjMhd59RwlwEnS0Gm/HcjUaJ4D18EAVww0RMG2W2zcuGyfjxEneix7NUfG6D8f5i0XWJuTA+myKLOjcKytzw1Niim0zccydUt8NGM2MlRXm/zknmkat55qy4KO/TfbuX2X9gXvpct9rUvL5flPl9vg+TJKUbHtLMzA5rDASw3HmmnjN7k88TpBtE0EueLvCZF+4LTTLH8sZSZU+9aAOZfm90YQczicMzGc5hlJt7kTD3tIJN7u5xLpL5KjykPh1rDkx3Qi+nN1bXE5gBtcNDsc/2x8fPJMvE3SAru01uihmfOOSb+liSt6ArXmZ+bYhbpRtU0wmzVe071J/cuN19xhRcWXz7Dii1ckMuCXOybIzRRlVuyCVhbpA/HKuHbOsdrACPv3Hf6pKZK1xm6bYBdK1BS8HJzbsBdebUNkoRpXvGgWIOKZ21cEe7O/NinpXSvUrXxzL3e4T74mJul2uXBf645EIx5ss0uryQ7kkFipkN1loDZNE11m0018y9pR1M2prFuR8Kd+9ZMY/6OdmrNgXZ0e1CCJmcos5cu3ZgXwfH1ggX6kgmUO3MBYtJN+CiuxTphBkhKrP6WO7rwoslOvZsMXlasXSZdkp2T+P0RugCMglzEx7gbu7cSJyI86zb3Mic1pv3KhmS3AfebS1UzGMJrD04HifukMS77Sp9zKq8JnjD7fOnzZyiewLMZMTm6A4/sO6u0pjdAfQC9xXd7SBVXaso1R3R04Wq1Ckvs9vMrlan7TTdDpVux6fu3vkJ80wi4x/ZGOnyG2ZApdp+CdeQbrSDmRBSZWm5eUBzL3fsYGbqhOcYuLMZ0Y2Usks8lqcA52k7KJM02dPr/KfovhFPp4J0sSSd8EZnmxzm3YIbj9Fc98JQlLuQkMz11ymh0slr8Kdn7mxxxuwhbpYmjcK4WTwiGellbOevG/vXzOG1NUoBpUy848yYfe5sKzjbVbp7UjQzf6wzaNaej3n1mJq9wzQQ7vZH3Y43khk/iZ1FK9z3pWQmo7vGUAO5e1w0dwQiibnuBsHTTidm/k5Fggxu5Dphrjrs8S7dhICuGISLPCQTMVZ1WtYm+8keWxqkeay8fHZm90NGYaO4E2DucF6TBHnp3rdmrksbK0fPGbeTCGaUO5Cum1kjTtNRxXxsRy/tU7oDle6OXUi4Q2BvAppwMxAlc/EcmiQH+brdlnlM4slmk1UaO1BauMf8SGbszLPcA2XcqZNmdhprGqyaXLDF3JfsGguP53WTaphv5jot77MaHFWr3OMpEmZeZ51VNJYsvP2szNSNOq/9uIu7m1Ewd8XWxT8rf3rg5h10q4bulCTRHUMiuoRTIU77wXiNE+k9bqaJ7M6RUqvTHieeQo3xVpmfj3d3JO7mQmbJjH/AQ6zdV43qjqLSspvwM3epYIG6Z0Uo5kmUzgZXsDtn4cFGpi6oRfiycadozJ7u7sUN3jtz71RY3rDsGaTzHrd/SmZ4gBpEd+4qSTM3kxq7Qe6Ru21AnQ5aY0YnScKDdLOgFZMtUgG60zrRHbSjZqcfeJNdEP9xI6TMPYvHw/a8Q8ybQ7kTRyY/PlZZs2/f7xreOQK8qP6xIrTH5dxanqg22xo16E6beEZI2rP34OfevkTecwcZMN65gEzQbs083qUwjuTyYSanoQabV7I/wXPXJExEfzLabOeK7G13Ia1mhvd9u3hTunukj2auyzy7bngeVuCdV80bERq76SFvoEeXSefJ0w1YMpXQmGz4X8ymu3SzJrr5xaKLwjJ3PaGaTgf4+8Eqt+8z94D2WkcngriblyVzYYsqQbadZphs90SMybNxFzPMpVu/efhw3FcCZ8L6j9ubQ37Idvk+u/nx0z/+/e//Dw2XrlI="; \ No newline at end of file +window.searchData = "eJzFnVuT2ziStv9L+ba2P+FAHfrObbt7vNNtO2z37E44JhS0xKriWCVqScpt78T89y8IkBKQeEEmKVXvTbu6ishMEolTPgngXzdl8Ud18+Onf918yffbmx/l7c0+fcxufrzZ7PJsX9/c3hzL3c2PN4/F9rjLqv9nf/3DQ/24u7m92ezSqsqqmx9vbv59e5KRzE9S/iuvH96l99nzY/3wPvufY15m27eHOi/21Ul0vq+z8i7dnKX3lAKab28OadnYejL6bIuYSX0ypti/KsuivEDxs2KftSL6DOiTEzfufbbNy2xT5/v7y0wsPUHXNrTM6mO5/1hcYqOVURfXMU/OVguRyF6nO1lbfz/0GzrSw9RZ7+NdelLzNS3z9LPTYh7v0umS/+h7o0AVenqk7vm5vhsps3dl8TXfZue2c3fcb0w9dEq9x6Zru8/q55tNVlUfiy/ZPq7Of266vmOV/V71vVf7wEgN56oz/UUV9KP217396PJcBec3NT3Yi2KbnSRm++PjSR56st/01j6nsZ9775+fv/711cv1x7fr969+fv/qw1/WH9/+9dWbkaqf3aX5Ltuu62JdZndlVj2s67Zy+0yCArGdv73+8OH1m18us/Ixr6p8f//UNn549eHD67eTrauyqsqLS+2CrvVz89h+nxn/5/sZLnYNp3v13y/+8vzNL68uMcFxvuzb5iHd32cjvl3kk1zRCftMv9Qjp1jPdU+O3eN9ddDis+O2zz3fbIrjvj49W2HLY09fw01fvP3t3a+vPkbctFez452b4vGwy+pB74y+94CVr9+8/vj6+aVW5vu8ztNrW8lyvn4TR/ocwz7H1Y5VXTzazrTtQwa6x74S012u6w/XtlYnqn7W9YNrW62Dn6rv7aGdr9/87fmvr1+uP/z+03++evHR9oTrj39/F3O+QZPz/dd0l2/X1fHzP7NNbXvCdTOVv771nTM+f/Hx7fsr2N55Zrqpi/JPsdz77pea7X3yK9l8blov3xXvBtqS98j0xvPy3dt36xdv3/z8+pff3z//+Prtm/Wr9+/fvucqfbY9FIf1ptjf5ffHMm0GqHV/LACJ6rHtP//6cf3i+a8vfv/VWtfXyGPm/fNLvd6ku81xZw3ktXCuhX999ff1q/9+9/b9x0nGfcm+r7Nvh6KsL7VLxpdGJ5NaybGZ9UhHSoQTGSv2VV0em+Y8Stszv+Co+XssGLNJj1U20oq2yHX0u82W+RG2F2nHdR9OHBlWhYX+NK+IqJ7oIuDtL/SXqH0jnWeEZTxPin+4UW7Vb5frY8f6oSjz/zX9adMP/VKm7YQxam28yBP714DiUd7V896TfGvQNpZnTbCqz6+GPxjDq3g2DfpUE6nNqimu5Zb8v/CwQP/ljuZ9jKvVLDJ0agXHLIzVM79e/+x6vEK9XalfuKg7uI6vXOIbfb7wU7r50iyI9tmuKZPt63wz7Bf9pZ7WRxi6x/jLwAeY4jssCzl+NNG2Hp/ifbxh/+JbxvG1N0X94XhoVmDZdprfBRL+j3wQ23EVfww/0jXrP2r4Bb7QazH2i1+L++LYP9fAT/9p9U11Tqxb90Uvq0dg0Kg6i1gie5FGzC7w6NPWTEzhmGpB7zel34/bwunsx1jR4xk9H2TYLQZskMPsIWpW5Pkn9o4+raNcJPa6k/yk3yqWs4y1p89jBj4Sw20Y1ji+8zKvNsXXrPze6zH+U0/rJ0DXGO8gLzShDrABw18+rlkCmBHV3j3wxF/ZUzPqA5/eYEp7o3o5DWxYY19t0hdlVCTS59Tha0saX7icp7dOowWeto771Y6p8/gbT6iRQbOGa4hlT1hjnPAZePRPqaWLAmTo/abXzLQQWL8NcqbP1VEX//nBSeHgWlEX/6yG0zYGvkXoFR/qtO6fMAUP/ikeQdRN8AfnzaZ7Q2gG2xewfqcGfrtLXzyku102NGUNHnzaGsDqxtRA+GZTRsuYHZxRk21BNv7DP2NlNYyzYL3Nqk2Zm8z9KdaQ8pMtk3MpNK+FRN2EtJC62v5HXv1Hvn/Iyrw2SQ2jLOL3nRGLQM95oU2kFb/al8Vu95gNhCTCJ5+8HSN9IxsyfbmJLRlbwmzKTBuG2jK0gduYx9jAbM1xe0Y257ht49pzxF0mNegem0a1aGjT5CbdU4t+m/4lq50YclFWQ00bF3jyFt6jdmRDj7zxxPbeaxez2Y+zaKj191nE7QQmWMTsCwatG9klDFo6rmfod7NJHcSwhaP6iT4LJ3cXw/Xt9xpviudf03zXbDb82aQzD3YbkRJP3m/06R3ZccReesKqa9iw4eXXeIuGeo5ek7hdxxSbmH3HsH0jOw+Grb7f/y0r87v+KLr/1JP7N9U10qfdF5o4AoYWMIc9hu4hjw10c72Uq5vpmdiOkd6IbRo3fgF3mDRoRWwZNVIFtkweniK15bZNu0llOMoXPPjELRSqG9VIgzebMt7EzGAMM3363Rr43kLs54e8vwbog09cA1DdqBoI3mxKDcTMYNQAV/82q9N8N9KCU6Hr2GD+GWdBW+Q6+qs6rY/VSAtOha5jQ53Xu7EfoStzJQvstsJRBjB2IrL1GzBwBnZj6+NcPOuKT7fL6aPeNosc2ds7OY88bb9EFY3pkdz3mNAXAdXDvVBEp/N1P2y/9H7a7u9jt25yX8uTz3qnk8XOFMc5s+q3u7RzqPdZdSj2zjzYOevoPE+hT1/ypv7Ul6+OPQUOXm30PHisUSPnw1wDH7OqSu+nVM2zc9ELjNFipdXsbM/L4jHN9++zqtgdw6wRcO7Ps60pUZ5KcKpw0IC/+X0wwwDS7U434HVVHbNyjAG5KXE1A367S7vzroZ1P96lZfvw1dQ2kffes54crd2z05W2iYAH9vuaPfyZLXD5Oxv1bTYAX33rbxeq/2CP+bAu/1tePab15mHYiPZ0EOv3j22xkaach/sqK79moUL7azAIRHaJfa7qMt3U7St9qIsyHOtamejZ/tGmtXH8fGVII2vi0iMkPtQXX/LMZn9NMaopvelKX82qBqu55zKyDToXDKIfh7Kosw2Jfkywrco2ZVaPN+1U7mpfqW1eL0wlvEFLQoZR5je2HnuXiFPsm9S2nnXFLrGDxPPy6v1Uj8or5FMTLHKjet2hIdlv6bfn9xO+0UnAY/qtb2o1wbZt1p6LNdKkU7mrWZIdis3DeEO6Ylez435Kc7+/uK17NlTTupyL+xuyv3r2wj+nmJpyfuSJx0miaNTw6LxHtMdwD5cd0m2fnaLT6xO8TUpjXrwplp6KXWxHmaV19nNmpmp8M0ypu1Opi60I997wbTFl29n3wCGUfIsiR+UOGXOfNXWTVVX/iV5T7fBOVplo1F1RblwZV7Dww+lcQLZBQ0cJjtJvvs1P38ke3jHmmC/z+fvns4TUSrjUusd8u91lf6Q9U6Ogg3GLXKq/qtOyft1Eb9JNnX/Nfi3uc35FmdL5ufSuLX2pVcfDNq2zsW5jS13Pc5qjvJ8fcnju95AtTdn0kDdeUp7LXsOi6FHkHJMO6X12uU3evrveyBuxCT78tHODuMoxswT8lqOyNxj29CZxTLIEhe45H6Ynjs+1I/CRWGwS2kUe/jN8BKkc7yP0LSfXTMQcbs302OHu1OqNGhO74MNPWzNxlWNqBr9lpGbSTX1Md7bIBLNs8bwrfj27+jym9zMNe8woO7JvBxM4m/yFOgFX+kZ+tiBGEMQ4+tzT+jDUNsZ9g9eaMu5ErOAMOWz9PR4a+wjDzsnVjvMWe9X3w4cp+ntzF4dtYdHakXY93qXrEhEyllmg9NWsqvuWznFzWEvnHjs4GZW9Rgxsl2Z8Cb/PiqPE0Jzg2Sfvu7DGkf1X+IrT+pCoMax+pNcKUCeQr0aMcp/9c+ok0DilTrxXvKBOkDH8OolZ4WY6DUNnYlq8xNPWz4DeMbXU89IT6mrYsOEa41nk1NvHMt1XqQkm9tJ1+tzT1hHUNqZmgteaxM+wGTx2Ns6C57swSZlhRLobqgO2HT3cDFvAYGYjdFsu/q7M7vJvo+2wRPzQFb6KTVX6daRftCUma/fTLGHWlJPHF0xjzJMjm6XfN3VnHoxU98wtyJxz2deKTdXNTu2xVpxKTTSB3pT5/HB4XxzrrGwiuuank0X2nswuBhs8N7IShhW/PTg+MKC8efYSLzikZfo4XtuzU7n+gDV+t2jOTFpuHt5NtMiWvpJdtJJ+abBZU/RDvs3elcWhep9Vx13d3JpKwYhnMaPghf4z4K/XclPGTbKtxvE3yU5SfqpDvhWnIk9pDr3TmW8V617n/uYc3Eg8TfvwrcQjJI78kCeHHVGx5zJPULNn4aOrNih6Sd3eB13JpYZYtN8UqvJtdmhFjq7w8ANdzTsjdl/inn3WOvdMv3z18/Pff/24fv2yvfjuxa/PX//24WT6+arpDvTgAiNr3LmP+S7f1Vn5MrtLj7v69dYszV/s0twZHM9XNLdGxMtMt+M+22dlWmcvD8Xhr9n3d2lexg0AD4/UHOzl6M6bfZFuHjLaBEGm+bNtV2LTlChOJaYacGarAznu7jaWr4MwpW9LwYuXv2V1uk3rtFff42b7eH6O2+edw61ZVbuJt52K9ve9efvhDMlW/Ac38Znkrtvm3knvKdHvMp3ZvCTwcUqHUsEZcvpbkVcAtKNOAXx+7Hdxqrr5CmFFN7/trebzCvn9qw/v3r758MrcAHruB+19h1aQ/8iAscYgpwrPy+EXb1/SK0aj8vvDZKhYTOebN81FoSN1m8y89SU2ODHV4I5Y/JXBc5M/9UnW39+9Wj9/8eLVhw/wrtR+zc9ON6N+P2Rrm704AIaiAhl29l0rPsZQ3mXiHEvdYE4sAZSOXE6cw6oYKDiyjv0wdJCFOkn7M0YqKktazFCTsbh+yJ0c62mGeoKewFB4+/IlBo+4znms4RHn/JDxPvKHbGC/QK/rpSAtm6PtGScxG5WOGnLc5tl+w6unsxXnUpebYLebVs/HffdnbbF0hCv3GFHaA8Oz7YdNwfTakyWnslVb9nJzqvFWXE/5yNZ7smBKI/XN8NrkOat3eIwInr2kbe52xR+v91W2OZZZe5D8eN3PjJi8FVOexfR+mPCdY0YeDj+lVfZ7CQnBgGWHw+e0yo7lwAcaY457y6EJVWd1Vk75aq6ggyvoOoZ+zu6Ksls9fEi/OtFato1WRpvCX7UyrmPexjz0vKqy0tCx/H6f7++f7+7HW2lFpZ2oyopKd/Fdodcx9q/Z92sZ+8WIuqaxrydUty2ZX7uSP/jr8ZHmDK3HR5q09aJJ443yY0vXM8sEjiaY05W7khkgxMe35VAcvmTfD7bw9QyaOigag4aif2MNyvZN0NcZ11/tt4eif8ESMc+Kcua52VnUNY0lN+xdaK+/p/WJTG4G1t0u2zn5ExPq38o6tLJqX9Y1zf2Y7bLHrC4njAdWQO0IuI5hD3V9+Jg/ZsVxQk03hetT4esYlO83u+M2a5nEX/J9/Xr/9vXLF/Yu0EnTu1ZkvjWtp1ns5/si3252RuQ1Z31W4oe6CcjeT6hlW746l7+OWY9twubHesLX604hquvrfad98aJoOoX6XVnc5busOyvsvx6y/e/79HzA+pTZ6L7YWOEHK7xshf/xkO2PgfDrvFCxf5Huds1G4/H2FvvNuex1zDkcq4ds+9xdOkxft1lh3jrk6qu3sgGtE2w7lbuOGdXEKeiVJ58VyRQaYUf/LuqJhvgpwGOt6T8LaLRJ+f3+9f59myHwLnVOBOAbZlZTXXLAIe05E2CseaarfG+BwU/Hu7tswgTZyGihw+dOxpXMO09uCFnkW3cWselEXMe4Y5U1d42ON+lYZc0c/hJDaKDtdMFHvzWnxy4KfTeHMIzR8+xUZOh9z6/RE6c6PfSxP8IJ7HB/xYlzckyyx9Bse8PfoSltqeHoN8eEfGDaQXSzQiGDSndp5d4tM/oLNOW92c11voX5Z4wdbYGLFRfF5xf21JZR6ovi8+ZU7GIjDg/FPntzfPw81JETK0y5fVfuYjMG2EOo/4LGSLvC06zvpTkAf2CWRp++oGMcfmmojPvuwXsxPgE3kg8KXDJCDDPJHp1sOBl50diiMv22jhwmzbDpXPqKJhXlfbpvn55oFxFxRePKbJuXDbo/lvlE44iIKxo3hFf7rGJx1kFz3CZHjvxqOylObsxQyYsa4ZiukGWID/e2J5l9X3Lw27CB5HWtH9hQc5nxn/P9Nt/f/xY/v36M3a20oSPtLzPZZBb9pTeAzrPWCGJkKE019JSsYbbY9wQteeaexGWduCsZzeog+m6fGNDIu4riz+gi/JsXrtlHDF0QkcPdA1MtbwPum07ak5hcD+aoMa01gvpO2x1vqOuyp6vDh100ePQClzz1nPVD0bOoxSrPPWVbuu/DhC84tKG4P9wQMelUmjHLZ5vULDXdIxi4xjRrzeGc7j4zPBfxAOzgXAc+fq3ea2iGEFc+YVqAX/yCJOUe69ipyaOMCnasjTFpcJfaBIPMpHxa/Z2KXmIM8Ou82A8nFIfPPnVScUTjiMRi8H6X+25gz1jHZZjDSDSOWcNNNuYbM7AEjRnCWX32GuF7agM0GD2v89gF/jmUzRXq4SVy+a/Rk/nxdr/rmfAD9U2hwha62IBH/94MjvqBmzJGKD/0gkOgmkEJWYqr9DH7kNfj3rspVOU9pwuNMcDkX49T3xW5WLmBh97tExz9bqkpJnhNPLyUYLi9R8tchv2Kcmhs6lf8zMhgDVHxtx40b2CazjaRM2Efb+Z2mzcPpDtOaH7Q2JM0dqb9BJMHo/mDZvIC+uNN4wXQh8wbEUMfb+LQNGHANtZ0YbxRdlfeha25lfI07dk18bIW7Zp5rTY90EMzYibxQk++gBhQPWYl0fPq/XP415cY2MoYnleON6+NKF5gXBtFvL5pbYbVpfa1Yp7IyPHdnW/dxP6OFXUd3Y2AgOu0DmQgkNZ/FExgKXz8gl7jMf32al+XeV/8Ja6zWeRkp+J9Hwa/ZqzG+nK/e6wZTvseMsOtmVfmNMa3xefBSqFPXhjY9HLcxqoN89yGqiZ4z1jv/ZjmPfWCrekKXcOAbmvAWBu6XQFXMuOc6zW6bs75XteqFFbOFzaGn/bVYwxoMPXw7jb65J/bYHy1kxvM+T0v9Vdi0Dh/RWZ4B/GCc7cCQ5yHnjBGSLXwIoTuC8Rmbv5NMcOKB26G6VNMDjkmF5SGqrtHxn1X/3LKvmONkRrGecakWEx1/CBjqHfgBGOm0ubKSbdR9jRpor+5aJKWvMiUr1mZ3/XEnYn+0+OjlRKvanaFfRtwK/vMk+ZqEjXcaI7zBtMT56lubtb8sPLH4bPJsQmPdynrqpoRhgyMEMACztgwrHpgsUb1ctZmUClx7L+ZBjIcIwkevTgyQi4DYmp8NuLkt/D1Lml30Bh28+MZ0gZT1r2DNjbFK3oVY/LtxCpyCl7FkDKza8T1pjfPJmINLX0lk/xj/caaxD8UkG3ScAeCTGH2IzwTOGddRexgH3fVZ4zbt70f2BVs//7U8V1Hy4hQbmt7LC0v3XxpF7z2YAOeeucm611XbLoRm8Et665u5ib1AZVe2hBTsXeSyEXqd9492b1a+y/FZipjV+wVavPxLuVO8F3Nj3fpqNn9oBEvhhdWRD93YTWo+tXAworoZS2sBpX+bWA1Q5SyVjP9SttzLXgqzw+PUuh2w6ejpZtTq4/lAB1GT1/SRX82d1VnL6crftbJ2J5l9H0M+L7RDq1/F33cKNbm+TGm5HuzLTyvv1/yrc5SnuBrNe3NPUh+hF3nohcYA72alfKHnn7CqF5UHS+8B99t0v7uuCGMbd5jzOhPyIubwcjLG2PGcHpe3BRmlt4ocwaS9XqM4eTsjTGFkboXt4abwTdgEGi/L3tj8M5D11kmDHcRJ13uYmFoVuW+zGDueJfEPMaWc+lun9MVTDJq92nPjCuwwylyofLhjV+BcuYWL4byY9WHRgLF7ePjlUYcfuBAJvrkBZiE3ITKUzV0Fyou2m/CT9/tQnlgsd5nz+fvdpnFuseBadw90wGZN6SOU16NVz7K+3uVHw/bdLxnnEpNNSFsEOYR7gTOffjPXJUEevsXJXW1/Y+8+o98/5CVuT2oEH8j7+UvW6OEJoIlyhMYNrnqWvt4R/eOMGvCQiq0bWAdddXvyF1WhVaiVdVVTRs6UTFqGetIxTGGsIZMYAfj9MJ+M7wuq07L+nWj3B7h9msTZRxuAD2lrrrhd2D7xKAdE28r6P0qk3fcDlvL3HjLNM+t5+GNrn/W9tapm1ovvydn0g05V9iyOm2j6pDiwUR2Xy0va334Eh5Oijq9fIedj36tO4AuuP3nwl3B4/cCX+Oun4m3/AxsPv5Iz2YdHBdiJZ4wMNmrkhecjL7nxH3C/SaxtgyPNak/WNlvECNgOdqcMrvLv002qCt9TZOG46j9RjFjqaPNGoinDhjFiakyTIq0+g9174KaPvmkSYpQGXsQp+/UMwH9MHTWecyS+oF32jnXmCa1yLDcvC+0h61pyn49l72GOSN6PceQsb1drwn7YoKLdIWuYUBR5vf5/iV/SHLssGXHDkgMc14P5MX3mcNKkeea091r0b8ND5vTleXMWtjmDC3IYqawFmFcM4YmjNAG1sSRa8CEXvxZV2iiAdEBhRMZjRS4YHhhxvX6FI+K7cVeObaGnHB3VK+tky+QGmn4UDCt10hWQG3YINfVfu+lYM1fL3Ciga2RJ+ms7ZDG0j5F63b47jkjkWh0S0xVfZc+5rvv6/4UjLNe//GpSu/zr9merdN7eqpKrrJL1eSbL2xV52enqivK+3XfTRFnZacnp6o65Ju6d+Fy1nV+dKqy6viZo8g+NkKJ23XYrMnf7tK2h2nu7o0rRU9fskF/cItQVCF3sxB8v4FP8V95/cDZGh8pcMEHac957T8DtU9td1IsY39G7HUvrytkF6yuYcI10sjB82N7beSdIjtsUtypGNvHIwX+nFYGdF6n5gb3kxf1YaJ9tiS/xob2lHtPv283PDVeNa7qQMk/rw5jyq9SmeibDOw2G9Eoo6Z3ssY20X5z5Wy1EIk8WfxTcA37X4rivDPHyG/Nxo+OzfHy1dsYy/usKnZfnTm9q9Z/5DJ1dqNGs9832LXqqgwfu4Za2p5CjZPaDVX2S1Y71z/3KYVPXjO6y1PGje7iF+snmGNNORe7miV+YIhpBycwNGQFdYxf8SXBrkX+I5f5IUqbDHWZv1/gc3mFfZtKf2Yf7PuersGxunSWXb3aqsFVF0ebsx7q1za4IsLaaJW9Pd0mTM+scNUHT13SZRwOzQrFvV57WNWz9HD4nFbZcfAG7fCF+pPcsy3dIcqw5lSWt1OUbROMszPsGRFjH2ELCbKz7GAF2PtsiDtodJbiP3JZF/Yuvc8qs0WxbK+xhirDx66otmeaAp67UHFZfPveN2NwH3iqiUKggzs/8KyPb2H99t27vLlftXmekTnB0R2fCIR6OeM/R2edlvdZ3dfFhrptGV4HG7GBOtb7LN02x/e3zcPmJ2AXw49e5td2l3GfY3tPXKaMRuCgPvrQOJXKme2/f/7m4/rj39+9Wr/4/cPHt7+tP77966s361f//eIvz9/88uqk/Wta5g0tOk0+Bwpew6Lffn6+fvv2J44N7aNX0/rxHVvrx3fX0vr+1Yu3f3v1/u/rF29fsr58UIhlyT9ub/L9Nvt28+O/mjPNTC7KjzfyB/XD6ub25i7Pdtvq5sdPHf3YFI+PdgfkttgczY//aB/7W7YxRy/8+Mk+/f9mN7efZrfJ8oe5mv/jH7efusLmD+YXnYzzb0xBcXP7SaCCIigovILy5vaTRAVlUFB6BdXN7SeFCqqgoPIK6pvbT/pWyx8SLb2COiiovYLJze2n5FYvfpgnXrkkKJd45eY3t5/mt4n6IZFLr+A8KDj3Ci4iChdBuYVXbnlz+2mBPs0yKLj0Cq5ubj8tkaWroODKr/7GG1aw/kPPEcR1jO9ArxPAe3z3EY1TCOx5oQcJ34VE4xgCep8IvUj4biQa5xAKfS0RepLwXUk0HiL0bTL7QcyVXzh0J+H7k2i8RCTQ7NClhO9TonEVMYeFQ78SvmOJZfydQ98SvnOJVfydQ/8SvoPJxmcEdGoZepj0PUwaD1vCwqGHSdJBGQ+Dvi1BH+V7mFTRd5ahh0nfw2TjMxI2DBl6mPQ9TDY+I2HDkKGHSd/DZOMzEnfLoYdJ38Nk4zMSds0y9DDpe5hsfEZqWDj0MOl7mGx8RsKGIUMPk76HqcZnJGwYKvQw5XuYanxGQvdUoYcp38OUGQOhe6rQwxQZBhufkdA9FRgJfQ9Tjc+o2a1c/JAsSOHQw5TvYarxGSVuVfLDSq/8wqGHKd/DVOMzSjaalwtSOPQw5XuYanxG4cE/9DDle5haxt859DDle5haxd859DDle5ieRd9Zhx6mfQ/Tjc8o2DB06GHa9zAto++sQw/TvodpFX1nHXqYJpMtHX9nMN/yPUwbD4PtWYcepn0P0/P4O4cepn0P04u42aGHad/DtPEw2JPo0MO072F6FTc79DDte1gyi1ZVEnpY4ntYIqLvnIQelvgelhgPgx1gEnpY4ntYoqLvnIQelvgeluj4O4celpApfRJ/ZzCt9z0sMR4G++0k9LDE97BkEX/n0MMS38OSZdzs0MMS38MS42FwxEhCD0t8D5vPombPQw+b+x42j3vYPPSwue9h88ZnNJwNzUMPm/seNo972Dz0sLnvYfO4h81DD5v7HjaPe9g89LA5WTk2PqPhJG4OFo++h83jHjYPPWzue9h8GX/n0MPmvofNV/F3Dj1s7nvYovEZDeeei9DDFr6HLUT0nRehhy18D1vIqNmL0MMWvoctGp/RcE6yCD1s4XvYIj4PW4QetvA9bBGfhy1CD1v4HraIz8MWoYctSHyi8RkN5yQLEKPwPWwRn4ctQg9b+B62iHvYIvSwhe9hS+NhcFqxDD1s6XvYMu5hy9DDlr6HLeMetgw9bOl72NJ42PxWqx9WC38tuQw9bOl72NJEvXBQKPSwpe9hyyT+zqGHLX0PW8Y9bBl62NL3sKXxMDjELkMPW5IwWNzDliAS5nvYMj7TX4YetvQ9bGU8bIWCjKvQw1a+h60an0lmsHDoYSvfw1ZxD1uFHrbyPWwV97BV6GEr38NWjc8kcKxahR628j1sFfewVehhK9/DVvNoVa1CD1v5HrZaxKsq9LCV72GrZbyqQg9bkWBrvA9bgXgrDbjOonVl/+YXd37XljdehmOfMxB2nZG46yy+pLR/o+VJ6HUWX1Xav9HyJPo609F6s3+j5UkAdpZEq87+jZYnMdhZvFuzf6PlSRh2tuipPxCInZFI7My4Hpxv2L/R8iQYO4uvM+3faHnifyIezBAo5h8E/UW8/mDYn/ifCeVH6g9F/mno30TzEzh3ESj4T6P/Ij5lEyj+TwGAiM/aBEIAlAGYsH7s+wH/oxjARPZj3w/4HyUBIr4EFYgFUBhg4vsR/0c4gPAAYUL8CYYggAgIggSEjM/jBIACglABIeMDrQBcQBAwIEysP8EcBqABQdiAkD3+B+iAIHhAyPi6VABAIAghECbon8AJpQCMQBBIIEzcP1kCuikAJRAEEwgT+U8wcQSgQBBSIEzwf46hI2AFgsACYeL/cwFhFsAFgvACYRDAPIIegfsRZCAMBZjj7h9AA0GogVDxgIgA3EAQcCBUPK4rADoQhB0IgwPmuPsF9EAQfCB6+IEAAEEQgiAMFJjj7gMwBEEggjBcINL9AowgCEcQBg1Eul9AEgRBCcLQgTnuPgBMEIQmCAMI5gtMr4H/EaAgDCOYw1wBAZCCIExBGEwwX+HywP8IVhCGFCxmuDzC78T/DCxY4PYL2IIgcEEYXrCQWD/wP8IXhEEGi0j2APA/ghiEoQYLjcsD/yOUQRhwsMD+DziDIKBBGHawwP4HUIMgrEEkPcMvoA2C4AZhCMICDz8AOAhCHISBCIslTsAA/keggzAcYbG61ckPc03LA/8j3EEYlLDE4w8gD4KgB2FowlLA+gfwQRD6IAxQWOLxB/AHQQCEMExhiccfgCAEYRDCYIVlJAEG+B/BEMKQhWUkBwb4HyERwsCF5RzqByxCEBghDF9Y4v4T4AhBeIQwiGEJA1sCEAlBkISY90z/AJQQhEoIAxpgUpoAWEIQLiEMalji7huQCUHQhDC0YYXdH8AJQeiEMMBhhdO+AJ8QBFCIeTTTTQBCIQiiEIY6rHDrAZBCEEohDHhY4dYDOIUgoEIY9rDCsyeAKgRhFcLghxVuPYBWCIIrhCEQq0gSGfA+QiyEgRAr3HsDZiEItBCGQ6xw6wHYQhBuIRaxzEoBuIUg4EIYFhGZOwF0IQi7EIue0AugF4LgC7GMU34BAIYgBEMs4xhWAIYhCMQQy565H8AYgnAMsexZewCSIQjKEMuetQeAGYLQDGEARWTuCXiGIEBDLOOZJQIgDUGYhjCYYoXXroBqCII1xLIn9ALAhiBkQxhYIWa49wVwQxC6IQywiEy+Ad8QBHCIVc/kDyAOQRiHsJADNwBAOQTBHMKQi8gHBKBDENIhVj2xZ8A6BIEdYtUTewa4QxDeIQzCEDM8/AHkIQjzEAZjiBkewAD2EIR7CIMyItE7QD4EQR/C0IzI8gnAD0Hoh5zF01AkoB+S0A85i3eBEtAPSeiHNDQDL98koB+S0A85i3eBEtAPSeiHnMW7QAnohyT0QxqagZePEtAPSeiHnMW7QAnohyT0Q87i+XUS0A9J6Ic0NEPMcJIxwB+S4A/Zgz8kwB+S4A9pcAZev0iAPyTBH7Ld9IATnQH/kIR/SMMz8AJGAv4hCf+Qdu/DDCdLAwAiCQCRdv/DDE4CJSAgkhAQKeIhGAkIiCQERNptEDM4D5MAgUiCQKTdCjGDExkJGIgkDETa7RAzvDcAQBBJIIi0WyLw3hcJKIikuyLstgi8/0WijRF0Z4TdGoH3wEi0OSLYHWE34OCWCDdIEEe0WyQEbglokwTdJWHIBprMS7RLgm6TMFxD4N00Eu2UoFslDNgQeEeNRLsl6HYJgzbghjSJ9kvQDROGbIjI1hi0Z4JumpDWCfH2GLRvgrAQqawT4mYAYIgkMEQauIG/AGAhkrAQadiGiGyUATBEEhgild0HhlsRoCGS0BBp6IaIbJgBOEQSHCIN3hASTygAD5GEh0jDN4TEIzoAIpIAEWkAh2g2zyABwA8JEZGGcAi8gUYCJCIJEpEGcQi8iUYCJiIJE5GGceCYrARMRBImIg3jEHgjjgRQRBIoIrV1RNwQABWRhIpIQzmEimz5Ao5IsIjs2W4hARaRBItIgzmEwi0BcBFJuIg0nEMo3BIAGJEEjEgDOgTe3CMBGZGEjEht9yji8QSgEUnQiDSoQ+BtJxKwEUnYiDSsQyg8NwNwRBI4Ig3sEHg3hQR0RBI6Ig3tEHhrggR4RBI8IhPriNiTAR+RhI9IwzuEnsHGCACJJIBEJnaHrLjVsx/EgvRHgJBIQkikIR6iSSRHtQA8kSASaZCH0LhPBoxEEkYiDfMQWt+q5Q9yviACgCcSSCITu2M2wa8APJFQEmmoh9C4TwaYRBJMIg32EDhvWAJOIgknkYZ7CI3n2ACUSAJK5NzuoF3BbwBIiSSkRBryIRLcpwJUIgkqkYZ9CJzZKgEskQSWyLndrx3ZTov20xJPNPRD4GQ/CXCJJLhEGvwhcLabBLxEEl4iDQARON1KAmIiCTGRhoCIZA77A4BMJEEm0iAQgROOJGAmkjATaRiISHCfCKCJJNBEGggicM6RBNREEmoiDQUROOlIAmwiCTaRBoOIOaS+EnATSbiJNBxE4LQjCcCJJOBELuzpAZHN3Wh3N/FEw0IETvyRAJ5IAk+kgSFijuepgJ5IQk+koSECp85IgE8kwSfS4BAxx54I+Ikk/EQaHiLm2BMBQJEEoEgDRMQceyIgKJIQFGmIiMARfAkQiiQIRRokEplqA4QiCUKRBomIBe5TAUORhKFIw0TEAnsygCiSQBRpoIhYYE8GFEUSiiItRVlEjioAjkgoilzZIy0ixxUARyQYRRosInASjgQcRRKOIg0XETiLRgKQIglIkQaMiAX2ZEBSJCEpcmUdEXsyQCmSoBRp0IhYYk8GLEUSliItS1liTwQsRRKWIi1Lwak0ErAUSViKtJtIUCasBChFEpQiDRoROBVHApYiCUtRho2IJQwdKABTFIEpysARnAurAExRBKYoA0fEEk5zFaApitAUZehIzABwCAahKWqm43NMBXCKIjhFzXoWKwrwFEV4ippZL4ycPgIOxCBARc2sF8JguAJERRGioixRwRlJChAVRYiKmq3iqx0FkIoiSEUJ64f4KBPAVBRhKsoylYgfAaaiCFNR9jCpFexMFIAqikAVZaEKzktSAKooAlWUhSo4s0gBqKIIVFH2YCmcWqQAVVGEqihLVXBukQJURRGqoixVidUC8ERCVZSlKjg7SQGqoghVUZaqrGD8RQGqoghVUZaq4PwkBaiKIlRFWaqCE5QUoCqKUBXVHjqF2wKgKopQFWUgiZxhVwZURRGqotrDp7ArA7CiCFhRFqxEGhMAK4qAFWXBCg6jKQBWFAErKg5WFAArioAVZY+iwkkSCoAVRcCKssdRYUitAFhR9EQqC1ZwEE2hQ6noqVRK9HxCdDAVPZnKohUcRFPocKrgdCrVMyrAA6qIHyrrh5C0K3RIFT2lyqIVHHlQ6KAqelKVISUSk3KFDquip1UZUiJnkVoAnkhPrFLWExdYAPBEemqVsp4I090VOriKoBVlUImc4RkSYCuKsBVlUIkUuDcAbEURtqIMKpGYdCvAVhRhK8qgEolJtwJsRRG2ogwrkZh0KwBXFIErStsj+fDQCuCKInBFWbgSmWYCuKIIXFG6b5YI4IoicEXpnpC2AnBFEbiiDCuRGLcrAFcUgSvKsBKJcbsCcEURuKIS64l4cAdwRRG4oixcifTKAK4oAldUYj0Rzw4AXFEErqjEeiLMYFUArigCV5RhJVLi1gjgiiJwRbVwBfsBgCuKwBVlWInEyF0BuKIIXFEWrmBirgBcUQSuKMNKJGb2CsAVReCKMqxE4oMuFYArisAVZViJxIddKgBXFIEryrASiZm9AnBFEbiiDCuREu4DUQCuKAJXlGElUi7gJAvAFUXgippbT8RtAcAVReCKsnAlEr0AcEURuKLm1hPxVBvAFUXgijKsJFoLwBMJXFHzVd9HBJ5I4IqycCViAYArisAV1cIVPEcCcEURuKIMK5E4cUEBuKIIXFGGlUiceKAAXFEErigLV3A2oAJwRRG4oixcwdmACsAVReCKMqxE4tQHBeCKInBFLezBuZFzTdHBpsQTDSuROPVBAbiiCFxRFq5EJhgArigCV5SFKzgcqwBcUQSuKMNKcFKoAmxFEbailrKnLQG2oghbUcu+BQtgK4qwFWVQicTpIwqwFUXYijKsROLzQxWAK4rAFbXsmyYCuKIIXFFL64h4igTgiiJwRS2tI+JeHcAVReCKMqxE4vwTBeCKInBFGVYi8XGRCsAVReCKsnAl4gcArigCV5SFKzh5QwG4oghcUS1cwW0JwBVF4Ipa9eTgKABXFIEryrASic+fVACuKAJXlGElEh/mqABcUQSuKMNK8D5TBdiKImxFrexx4rhLBXRFEbqiDCyR+IxDBeiKInRFz6wj4kOMAV3RhK5oQ0skzuHRAK9ogle0oSUS5/BogFc0wSva4BKJT+HTgK9owle0wSVSw9asAV/RhK9og0skzuHRgK9owle0wSUygZkTGvAVTfiKNrhEJnDHkgZ8RRO+og0ukQlcr2jAVzThK9rgEnxigQZ4RRO8og0tkTgHSAO8ogle0aJnkqgBXtEEr2h7ZBcCnRrAFU3gihYqHgXTAK5oAle00PEomAZwRRO4og0riUTBNIArmsAVbVhJJAqmAVzRBK5oYd0Q9yYArmgCV7Swboh7EwBXNIErWtg7FnBvAuCKJnBFS+uHuDcBcEUTuKJbuALDqRrAFU3gijasRCZwVNEArmgCV7SFKziRSwO4oglc0YaV4N1jGrAVTdiKtpd7zOHArAFb0YStaINK8O4xDdCKJmhFG1aC44gasBVN2Iq2bAUnomnAVjRhK9qyFZyIpgFb0YStaHvdR2REAGxFE7ai7ZUfkREBsBVN2Iq2135gsqEBW9GErWh79UdkSAFsRRO2og0qiQwpAK1ogla0imeBaUBWNCErWsUPsdEArGgCVrQFKziZUAOwoglY0XbPCk780ACsaAJWtOEk+DIxgFU0vRBEz3q6MnQnCL0UxG5ZwVN8je4FoReD2C0reK2o0d0g9HIQu2UFE0KN7gcJLgjpCWZreEcI8ULdE8zW6J4QelFIi1VwO0J3hdDLQixWwWtFje4LoReGtFgFrhU1ujOEXhpisQo+z06je0MIVtFJT362BlhFE6yiLVbBkFMDrKIJVtGJ7JneAayiCVbRFqvgxF4NsIomWEUnffNDgFU0wSo66ZsfAqyiCVbRhpJInFqsAVbRBKvods8Kbs4Aq2iCVXRiB2Y8OwNYRROsoi1WwbnJGmAVTbCKtlgl4kgAq2iCVbTFKgs8OwNYRROsoi1WwcnJGmAVTbCKtlgFJydrgFU0wSraYhV8voQGWEUTrKINJcHjEoAqmkAVPe/BexpAFU2girZQBSdHawBVNIEq2kIVnBytAVTRBKpoC1UisysAVTSBKtpCFbzZQgOooglU0YaRRGZHgKlowlT0om+ZApiKJkxFL3rongZMRROmohfWDXGPCpiKJkxFG0QicYK5BkxFE6aiLVPBCeYaMBVNmIpeRI8Z1oCoaEJUtCUqOD9dA6KiCVHRBpBIfNCjBkRFE6KiDSCROD9dA6KiCVHRhpDIJV6nAKSiCVLRFqngBHMNkIomSEUvVZzJaIBUNEEq2iKVJe5NAFLRBKloi1TwcZEaIBVNkIo2hCT6CsAPCVLRFqngfEwNkIomSEVbpIIzxDVAKpogFb3socwaIBVNkIq2SGWJGzNAKpogFb2ynogbM0AqmiAVveqBexogFU2QijaEROIUcw2QiiZIRRtCIvHBlRogFU2Qirb7VfA5DRogFU2QirZIBaeYa4BUNEEq2iASiVPMNWAqmjAVbZkKTjHXgKlowlT0qocya8BUNGEqiWUqOEc9AUwlIUwlmfXAvQQwlYQwlcRuWcG7EBPAVBLCVBLLVHCSewKYSkKYSmKZCj6DMwFMJSFMJbFMBSe5J4CpJISpJJap4IElAUwlIUwlsUwFZ8kngKkkhKkkds8K3lyeAKaSEKaSGEYicZp9AqBKQqBKYqEKnqgnAKokBKokInr0TQKQSkKQSiLsLTywP0oAVEkIVEmEPYgOdicJgCoJgSpJew8K7E4SAFUSAlUSexEKzpJPAFRJCFRJRE+6QwKgSkKgSmIYicJnsSUAqiQEqiSiJys2AVAlIVAlEfY0OtwbAKiSEKiSSHseIu4NAFRJCFRJ2utQIhe4Ak8kUCWx96HMcGMGUCUhUCWR1hNxWwRQJSFQJbE3ouDD1BJAVRJCVRJ7JQpOMU8AVUkIVUkMJVE4xTwBWKX73T9ub/L916yss+3r/Tb7dvPjp0836eeq2B3rbHss0zov9je3/7pZ5/bPDbcwOm9+/NdNw6p//Ne/b28aRPHjv/7979tOqf11p878rdGffq7qMt3UVVZVebGv6qLMXOmL+Vl4c3A/S+Zmk1XVui6+ZL6lyhHWZCrxhQWymjj3SVZzYIwprexb3940edb2h1X7pybaPVJfVpZF6b3AyrFfTRK3Kbbe9xVO5Qk5VuRdI3C/zzaNUwTmKuWYu7hcdmB74tg+v0h+cWj+W3nSlSO+OVdppPzKbySO6zUce6ywrPZtW7nex3WFOv/qf8DF0hGzYospyrBtCelUth4rqv5+yHxxru9ozRV3THd5VR0zzw9XzsdqDrBmydpu88Yl0t0hLdPHrM5Kv0KFdg1k9iW7XfFHvq+yzbHMyux/jllV+z6nF06FzJk9xuHwOa2yY7nzRbl1O2+7o2bWyZRZFsc6Kw/pfWZ+8mTPXPfjenMgsjiQtxdunyqYLe64zbP9xrdPC7d5JG1XPOt+0O0g1aQM2x+W3bCl2w/VwAj7w6p9JuF2Mcf6YbbZ5c3vHJuWS7ezYraPsyjUQem5W8PMsbEReSiLr/nWbySO4zHr81g/ZPs636S13+03h3g4vQpzUHGl0d6gOZTDkcjsDahEv/1Kp3dXXfNotkNwZRdl/r9mMtQMS/dluq/DAVC7nf4Fktu+IlTgvAS3D3IVbLM6zXe+Vy3dDzPrPowQ3Q/M/tNVE9rtjoYTPjnuk5vkCadBqK7ZdzMwNVWTr2Xl9FJKdB9I8j9/O9f13HG+dGuSZ+jndPNl85Du99nOcXb4vZ0WmfAaZFT4vqir4+FQNCuEUJHzGgmvv4wqQl3e0p0BC16XF1VQZtWh2Fd+V7Nyx3Vml+9o2BX3xdHr+KU7GDVZ6ZMkhl/a+RIJb6j8nN0VZdattNKv2dafTbuj75zXyYYiH4rii79mccRqZt/9Od9v8/09nfBLt2/SzAVcK+sxq6r0ntS1WzOCNyafxNUPhf/9Vo7vN4docKRt0t3muEvr7DH9RqxbOjNgwewRNulu17iO73/uzHzF8+hNevTbhXI/VTePWnUdaze5bP9tO9x59+/S/rtoyy3bcqt20tXcp21/EO0TzTVB9gfm9GHzkO522Z7U78ydiIjTpI/ngyeRuJtYuJXN64hOEoP5jbtCaY5PYUkLpphOQ2MaZESkVZWVpqvN7/f5/j7d3fv9gjuZnvMaHZb8JfvuS5auZKZnGsk56bqUK4g3Q7GCqmxTkrV1ol1hzIZHeirltrlubdH6tO7mI+0KI2mnVt06JWmby7z9/bz9/bxtNot2yrFo5XaLmGX7+24ts2r/v1vAiC42J0TXukSrSkjZ/dC1QKW7H7pSS9H90P1p2RVftQ24uZum/UF3P7RvKZmL+OZLfs3K/C731ydNGpczQ+KNeG2AZx1EjtzuTDJnzq2wdLMpjmRt5wYY5l0/s2L6oSc2GOfdOOOc2TOEEpsP4M+k3K6R2Vt4YsHsrDmhyenGuPVtpGZb8F2l2y82vGuEQDLBFu6SQ3YjVXNMUxu4ZY7XJ+EoLNecr+R8gLH2diJJ5NCpKc0MimyaSHp53JCVuXJXLl3Ium3Dp8BH11t1YY9ucG/b8bz9dN3yat7+ftG2/EUrd9HK7XqNZTf4t79fdR1Nt8QUs66fEl3/IrseR546o26m0HWaoptkiK4bbK7oa3/oeq7VqVeadT+cOqx59wP3yxZfcn9S6o5iuuvuNNuhGnmbYn+Xe6OuG0MRzCWblQUbpruoUaf18KnKme9eZmnTUP3hcukuG7paVUtmn2JE3mX15oHEbGdul8rsSY9VXTxa1vGtWT3500F3ti+443ooMuyhHbncSUxEbLDgcb8tsz8NRSOPcLmP0kz/CkWjubF0xxaV8NrBNrtLj7t6nW8tt1tvdmlOAi/e11A8m7fZLvOD10vttqy205DdlEgzP7OVm+78mLvbzqTgvnkj6fN3u84PwcrcxavMKJON67li3FFESJ6XbvNqU3zNyu+bdPNAyJvLxpjdhy8ORXekO40/rTKZa9+T+LCBOh30gtcvbYvHNPcnEC7Bk4tuAnGyshv/dBcp1UxabVWVmSHsKHg3d6tOd+PegvlVztK/+j1sk/jnfO3TsM/0MCP3a7rLtzjk6AY0RTe5EEtmqz0Uh7UdFNuMg3UIw12Yz/zUjdh/fqnXXdilEXyX5js/Eibd/ovZiBvJX7Lv6+xbExlFQr3oEFto6MxOG1nwQlYnOcHw4rZiZiM+FIcv2fdDmvvO5PYvcsH/aKgbSFxyueB9q+yRdHjS849utqqZn8yIW7frUOIcLrtgxpKyffp5l7m5GPvtocj3JPDg4guuoUYyWfEh4XN38BxldoNAdrtsV5fpvko3YX25I5Tsgnya2dNaHXW2yx6zuvTjQ3M3PrTgDVrZvizoqOz6k1h0HTavo7Pyml/BuY47qdTM4KoVWRSf0cTM7ZUVMwOgFQikrdy1CTMg0UqrUduUXgoSc16eHYrNgzcF8xJ3mH4SdISOJat2OF61lSu68JPoRmPRhX+FOgWtmI2gUbzeZtWmzA80rOAyk26VueoUdPkGooOEonM+0YXOBXO4NUb4rc5dIDHdpJ20o9HJS5hgSjuYuE2Yb9Nc5+4k3PAGluzbIS+zap2TlD13LGbm7rSiyDrVnQXK5BT36dbAzJSlVjaxUriDOzMdy1bCui7Wm+LxQFcpwuuzRgpEq1/hJlLyvuNZYL7P6zwlFrqjFW+QPgsss7syqx7CHE03jYxJ5O7Sx3z3fW1KeQO1Gzhj9vZ3+a7OynYxmm+NeWgl6jYXZibmfZOB2cRPIjMo6fqn4vVNncwWwIbBKeFOOyUzBwVKDUNUwp0nS8Vr5vd+xHTpemUHPGTXX2rmQvU+qyNpus7bdz0uc7Xqy/SSRb2gkuuvzCmPLxoO28odtnkrvUaqm/LkS/SAFHMqdZ/Vtu4PZXaXf/O7eHfpwGyo91ldZeXXrKzybXYoiwPJ/nM7FOaKLhRZZtVxV/+RwzQb4aaVSmavZXQEotwqEswFz31m4zufv5OcFE+wG59irn7u86/ZHvSAblIRt9KbfLN1Q6jXNt7XxuPQmKLcPNBmD8RIBY936booPvt5BjNXJLMbJCLrgy9SuCJ5AwERWWY2thSQROUOWAmzv3qo60Ox33mLHem2KKX4gur8MSMpR82liM7CiTfaE6S+dIc45sKmC976PY87N1ry+rJ25PXnWO7KIzntquB5SHwoX7mfnZnKnO9NLn1ef8cbYtzee9bxNeY0Id9vdsdt1hr8kO/rfF/k240ND9Mk77kbw2OGBPOGCe9TP1rixlw0Ewi38b91dfz8z4ay244iSOX3kjzGCPYCgOH6z3l1rotbubFsWu24ApNftRKrOq0BGHJzqpl+WjVr73zvTbSW7hwjYb5qRWYUzkQrmXGNoSs76RFk5uBkxfSFit30CX2it7yOepdW7rwnxJOu+zEjILvinizw3KirYk7IjJT1Aw3EuStayaRjRlQgyZ17KsGrU5Sf6kacVrzZsRXTbN2rs3sStHNnhh2UT2Y8X4lBMLeXTma8nvQx/bamGZ9LDxrweqMwNbM5EcoZqzvk3+UkaGZI6zH91oQVc7ozwa1WZqLT42b7mNXpNq1Tf4nmVoY6hT6Z9oUps3N3vaaZYu48mxwJXUiOmVRoJ2L/c8zLrPk9CYe5dJ85X2kEhhGImdvdMnuMx7s0PeSmZ0NhYrdNCOZWyEZkfD3njlV6xq4ImCcr3Y1Eesbrklxh4cjnzCaYQbtGXpDRKr20YyYSaSQV+zr7RkS53RxzqvR4l4Y8QbrjumZ2bCdJzW+D7+Wm2DLD0o93abDiD+W6rsyv2H2Rfk3zXQNm7sweTSDZXf4yNxU+3qVt8w03jizckHGXIStWbMeO9QsLt1vQbUBeilOaEvubhGOSh4m7NDQ1P20p7IJYXT6aPm0y7BLgNTO7vVNvg8/g47nVrE9Zb8yhoxXeTmVD4W5NdznLku/2dn9vTdYtbjIFc679eJcaIOsvm92uRnNnBp2k0K3d4AszrHWSBgGhu0VPMVcBj/l2u8v+SP2jENw5kOD2hXlV5fv7tWnFsQWaFywYJTYexvecppvRj5KNwnde6lbn5q1Hjvsg3prVdyjXM8fIxItAN1NKMBfWj99bkt/NKTyB7hSM+dY0Muiu9oXs2nQHLvUp/s5cV+/zzZcw+Ojm6zPH231hRu59fSiLu3x3Si/84yHbH/feMs/vTtw1FbNP3xdk17h0xyDNRO9FY5QMl7Su/zPTfYo92r4l3EQqycyfOotCMyF3o1oy41XxWSLd4Kdc2pswzxABUQB3nc6UUWbbvGyYjB8vcdfqPEnF5zYY7y8W3Y6ROZqeRZFFnRsFZa53GllBQrAbgJGnmQWzEsv7dU6y0lyfXzDfsbxP9+3+aP+DuTOiLhNeaa5x+X2+DxMvpTuF08wtMFYYCGC5UyXNPIaB8ATpvqZmTlHxORrugCaZfXkjqbInabSBTL81urCDOYPxRIZzGOWuiBNmoAlsnHc5jGQOhYfUp2PS3dOpTptXRNcSmFslDg/FPtsfHz+TzBU3OVx1u0UUM6v/kG/qoz9nky5G0cyJbohbpTtf1swEk3YM9Sc37qDMDAMfyuLbd0CplbvbKRG8Ps0Io5Wq3Lz5hJmdcjhWD9nWO6wBHqnjRpflkvfpyizdNoCuFWgpOHl5N6DOdOYoRZTubn7FzJjqpIW75N1KZp7q1A2l62OZ+y3CHbiYC/12WeBPOtwqZgasossL6e6KVMwuuJUGFvKusG4XrmbuCu1g0tYszv1QuJsjoJgN5CSv2hRkl7gLIeTpfCLN65y6jn0dHIUjlLfLiOsvVlywmHTDBbqLiiTMozrKrD6W+7rwYomOPFtMnlYsqjuVRp623XWhlW7XdMJMjgTczU2fEN0+SN1tU9TMHC0zrpK9t+4H73ZTK25LNfJgf+yd8sJ77Sp9zKq8JpNMt82fvmi3jtcJ78Wb40D8wLob9GFOI0ArcOdM3V551dWK6naIKt396ZTr2QXiVJepq7twlu42bSfdBvaEGa0w9pHNli6/YYYQqu2XcA3pRjsUr/eosrTcPKC5l7u84vpGcDaCu6YXXQ6G7A42kN0eX61OmwDYmujEyU0tUqejE7qoj06436Mk254WbjyGeaojCkW5qxK55PXBp4RKJ6/Bz8JwV2Mz7is6WZo0CuMu7wT7mzkCUXZi4h1rxuvZW6EUUEo3PKaZMz9HVnBerHT3uWjmkqoTaNaej3n1mJr9yDQQ7rbHrneR42opsFe4C1LJXMe7wlAFudEnzdzYRY4ycNe4Yn7Kx2XaR4IM7mE5CfeDmSNjugkBXTEId5ohmVllVZ2Wtcl+skehBmkeKy9HnjlAIaGwUtxWw2TAJqTsT69cKcz9N42Uo2eMu9NMcIco6rru0lZ0g6xmZi5WRy/tU7ppOro7MyJhZmj0J6AJNwNRMgMEoUgyZ3abLXMKfpLZZJXGDqkW7qnJkhk78yT3QBl36sQ8d7EVDfIxXbDFHUgdYeGRv25SDXPzdJ2W91kNjr9Vbjptwjw2pc4qGksW7jZSyTxBss5rP+7iDkqC2SHXxT8rf3rgpml0c9nu5CXRBatEF3cV4rTHjGk1bj1uponszktQq9O+qRHCW8/8fLy7I3G3hUfduB8IHIztduGq+wJanib8TLeCDiq9M/B4LdPZNAt25yy8DdhM26hEONi40ypm43T39wbjjkvYNPNkT08gnfe4wUPJjCtRgejN3U+qmae8GLlB7pHwTks6He/AfPea7EZ3Q0HM/EDqgO4+a3G6aaBbsSpm8kM4lrl7eiXzLJjjYRu4iDuEMycVVgzaXuPOP5mb946V2VzntzC3+17xVqPHikAjd7qk5QmOM79UlVGB7uyL5woke9qrv7m3ZZL3iiCRxr+tgde7WTGPdykMR7mYmbnXigpsRnZ/nugubZg0/CS02RUW2Xbvgh/NTNPx5eL98kvvpGteo/DkulF+qMDNf2I6eCM3PeQNO+kS8jz3dOOezG1jjcgGI8ZkurMxK6Kbpiy6YC5zsxfSdLpbwI95uaMrc99Xr3R0WIk7a5XM/S1ICZLtVMNkuSfwTL6NmzHD7Kz7xcOP4668OPPef9zeHPJDtsv32c2Pn/7x73//f/szbV4="; \ No newline at end of file diff --git a/docs/classes/errors.AccessTokenError.html b/docs/classes/errors.AccessTokenError.html index a85fd5247..3702c50a1 100644 --- a/docs/classes/errors.AccessTokenError.html +++ b/docs/classes/errors.AccessTokenError.html @@ -1,4 +1,4 @@ -AccessTokenError | @auth0/nextjs-auth0 - v4.17.0
@auth0/nextjs-auth0 - v4.17.0
    Preparing search index...

    Class AccessTokenError

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +AccessTokenError | @auth0/nextjs-auth0 - v4.18.0
    @auth0/nextjs-auth0 - v4.18.0
      Preparing search index...

      Class AccessTokenError

      Hierarchy (View Summary)

      Index

      Constructors

      Properties

      Constructors

      Properties

      cause?: OAuth2Error
      code: string
      +

      Constructors

      Properties

      cause?: OAuth2Error
      code: string
      diff --git a/docs/classes/errors.AccessTokenForConnectionError.html b/docs/classes/errors.AccessTokenForConnectionError.html index 03a1de1f2..e3d9ca9eb 100644 --- a/docs/classes/errors.AccessTokenForConnectionError.html +++ b/docs/classes/errors.AccessTokenForConnectionError.html @@ -1,11 +1,11 @@ -AccessTokenForConnectionError | @auth0/nextjs-auth0 - v4.17.0
      @auth0/nextjs-auth0 - v4.17.0
        Preparing search index...

        Class AccessTokenForConnectionError

        Error class representing an access token for connection error. +AccessTokenForConnectionError | @auth0/nextjs-auth0 - v4.18.0

        @auth0/nextjs-auth0 - v4.18.0
          Preparing search index...

          Class AccessTokenForConnectionError

          Error class representing an access token for connection error. Extends the SdkError class.

          -

          Hierarchy (View Summary)

          Index

          Constructors

          Hierarchy (View Summary)

          Index

          Constructors

          Properties

          Constructors

          Properties

          cause?: OAuth2Error
          code: string

          The error code associated with the access token error.

          -
          +

          Returns AccessTokenForConnectionError

          Properties

          cause?: OAuth2Error
          code: string

          The error code associated with the access token error.

          +
          diff --git a/docs/classes/errors.AuthorizationCodeGrantError.html b/docs/classes/errors.AuthorizationCodeGrantError.html index 4c61b5184..827bf6776 100644 --- a/docs/classes/errors.AuthorizationCodeGrantError.html +++ b/docs/classes/errors.AuthorizationCodeGrantError.html @@ -1,4 +1,4 @@ -AuthorizationCodeGrantError | @auth0/nextjs-auth0 - v4.17.0
          @auth0/nextjs-auth0 - v4.17.0
            Preparing search index...

            Class AuthorizationCodeGrantError

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +AuthorizationCodeGrantError | @auth0/nextjs-auth0 - v4.18.0
            @auth0/nextjs-auth0 - v4.18.0
              Preparing search index...

              Class AuthorizationCodeGrantError

              Hierarchy (View Summary)

              Index

              Constructors

              Properties

              Constructors

              Properties

              code: string = "authorization_code_grant_error"
              +

              Constructors

              Properties

              code: string = "authorization_code_grant_error"
              diff --git a/docs/classes/errors.AuthorizationCodeGrantRequestError.html b/docs/classes/errors.AuthorizationCodeGrantRequestError.html index a4c82a16f..c9131b0de 100644 --- a/docs/classes/errors.AuthorizationCodeGrantRequestError.html +++ b/docs/classes/errors.AuthorizationCodeGrantRequestError.html @@ -1,3 +1,3 @@ -AuthorizationCodeGrantRequestError | @auth0/nextjs-auth0 - v4.17.0
              @auth0/nextjs-auth0 - v4.17.0
                Preparing search index...

                Class AuthorizationCodeGrantRequestError

                Hierarchy (View Summary)

                • SdkError
                  • AuthorizationCodeGrantRequestError
                Index

                Constructors

                constructor +AuthorizationCodeGrantRequestError | @auth0/nextjs-auth0 - v4.18.0
                @auth0/nextjs-auth0 - v4.18.0
                  Preparing search index...

                  Class AuthorizationCodeGrantRequestError

                  Hierarchy (View Summary)

                  • SdkError
                    • AuthorizationCodeGrantRequestError
                  Index

                  Constructors

                  Properties

                  Constructors

                  Properties

                  code: string = "authorization_code_grant_request_error"
                  +

                  Constructors

                  Properties

                  code: string = "authorization_code_grant_request_error"
                  diff --git a/docs/classes/errors.AuthorizationError.html b/docs/classes/errors.AuthorizationError.html index f5a5300cf..5c9879b57 100644 --- a/docs/classes/errors.AuthorizationError.html +++ b/docs/classes/errors.AuthorizationError.html @@ -1,4 +1,4 @@ -AuthorizationError | @auth0/nextjs-auth0 - v4.17.0
                  @auth0/nextjs-auth0 - v4.17.0
                    Preparing search index...

                    Class AuthorizationError

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +AuthorizationError | @auth0/nextjs-auth0 - v4.18.0
                    @auth0/nextjs-auth0 - v4.18.0
                      Preparing search index...

                      Class AuthorizationError

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      Properties

                      Constructors

                      Properties

                      code: string = "authorization_error"
                      +

                      Constructors

                      Properties

                      code: string = "authorization_error"
                      diff --git a/docs/classes/errors.BackchannelAuthenticationError.html b/docs/classes/errors.BackchannelAuthenticationError.html index 7184ec3e6..878253ddb 100644 --- a/docs/classes/errors.BackchannelAuthenticationError.html +++ b/docs/classes/errors.BackchannelAuthenticationError.html @@ -1,4 +1,4 @@ -BackchannelAuthenticationError | @auth0/nextjs-auth0 - v4.17.0
                      @auth0/nextjs-auth0 - v4.17.0
                        Preparing search index...

                        Class BackchannelAuthenticationError

                        Hierarchy (View Summary)

                        Index

                        Constructors

                        constructor +BackchannelAuthenticationError | @auth0/nextjs-auth0 - v4.18.0
                        @auth0/nextjs-auth0 - v4.18.0
                          Preparing search index...

                          Class BackchannelAuthenticationError

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          Properties

                          Constructors

                          Properties

                          cause?: OAuth2Error
                          code: string = "backchannel_authentication_error"
                          +

                          Constructors

                          Properties

                          cause?: OAuth2Error
                          code: string = "backchannel_authentication_error"
                          diff --git a/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html b/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html index 2d7b6d642..da58d70e1 100644 --- a/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html +++ b/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html @@ -1,3 +1,3 @@ -BackchannelAuthenticationNotSupportedError | @auth0/nextjs-auth0 - v4.17.0
                          @auth0/nextjs-auth0 - v4.17.0
                            Preparing search index...

                            Class BackchannelAuthenticationNotSupportedError

                            Hierarchy (View Summary)

                            • SdkError
                              • BackchannelAuthenticationNotSupportedError
                            Index

                            Constructors

                            constructor +BackchannelAuthenticationNotSupportedError | @auth0/nextjs-auth0 - v4.18.0
                            @auth0/nextjs-auth0 - v4.18.0
                              Preparing search index...

                              Class BackchannelAuthenticationNotSupportedError

                              Hierarchy (View Summary)

                              • SdkError
                                • BackchannelAuthenticationNotSupportedError
                              Index

                              Constructors

                              Properties

                              Constructors

                              Properties

                              code: string = "backchannel_authentication_not_supported_error"
                              +

                              Constructors

                              Properties

                              code: string = "backchannel_authentication_not_supported_error"
                              diff --git a/docs/classes/errors.BackchannelLogoutError.html b/docs/classes/errors.BackchannelLogoutError.html index d5be12c37..cd79ad5b2 100644 --- a/docs/classes/errors.BackchannelLogoutError.html +++ b/docs/classes/errors.BackchannelLogoutError.html @@ -1,4 +1,4 @@ -BackchannelLogoutError | @auth0/nextjs-auth0 - v4.17.0
                              @auth0/nextjs-auth0 - v4.17.0
                                Preparing search index...

                                Class BackchannelLogoutError

                                Error thrown when backchannel logout processing fails.

                                -

                                Hierarchy (View Summary)

                                Index

                                Constructors

                                constructor +BackchannelLogoutError | @auth0/nextjs-auth0 - v4.18.0
                                @auth0/nextjs-auth0 - v4.18.0
                                  Preparing search index...

                                  Class BackchannelLogoutError

                                  Error thrown when backchannel logout processing fails.

                                  +

                                  Hierarchy (View Summary)

                                  Index

                                  Constructors

                                  Properties

                                  Constructors

                                  Properties

                                  code: string = "backchannel_logout_error"
                                  +

                                  Constructors

                                  Properties

                                  code: string = "backchannel_logout_error"
                                  diff --git a/docs/classes/errors.ConnectAccountError.html b/docs/classes/errors.ConnectAccountError.html index a16b8dfaa..194f691ef 100644 --- a/docs/classes/errors.ConnectAccountError.html +++ b/docs/classes/errors.ConnectAccountError.html @@ -1,6 +1,6 @@ -ConnectAccountError | @auth0/nextjs-auth0 - v4.17.0
                                  @auth0/nextjs-auth0 - v4.17.0
                                    Preparing search index...

                                    Class ConnectAccountError

                                    Error class representing a connect account error.

                                    -

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor +ConnectAccountError | @auth0/nextjs-auth0 - v4.18.0
                                    @auth0/nextjs-auth0 - v4.18.0
                                      Preparing search index...

                                      Class ConnectAccountError

                                      Error class representing a connect account error.

                                      +

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      Properties

                                      Constructors

                                      Properties

                                      code: string

                                      The error code associated with the connect account error.

                                      -
                                      +

                                      Constructors

                                      Properties

                                      code: string

                                      The error code associated with the connect account error.

                                      +
                                      diff --git a/docs/classes/errors.CustomTokenExchangeError.html b/docs/classes/errors.CustomTokenExchangeError.html index 1b43d2a39..2b8a52554 100644 --- a/docs/classes/errors.CustomTokenExchangeError.html +++ b/docs/classes/errors.CustomTokenExchangeError.html @@ -1,15 +1,15 @@ -CustomTokenExchangeError | @auth0/nextjs-auth0 - v4.17.0
                                      @auth0/nextjs-auth0 - v4.17.0
                                        Preparing search index...

                                        Class CustomTokenExchangeError

                                        Error class representing a Custom Token Exchange error. +CustomTokenExchangeError | @auth0/nextjs-auth0 - v4.18.0

                                        @auth0/nextjs-auth0 - v4.18.0
                                          Preparing search index...

                                          Class CustomTokenExchangeError

                                          Error class representing a Custom Token Exchange error. Extends the SdkError class.

                                          This error is thrown when a Custom Token Exchange operation fails, such as validation errors or server-side token exchange failures.

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          Properties

                                          Constructors

                                          Properties

                                          cause?: OAuth2Error

                                          The underlying OAuth2 error that caused this error (if applicable).

                                          -
                                          code: string

                                          The error code associated with the custom token exchange error.

                                          -
                                          +

                                          Returns CustomTokenExchangeError

                                          Properties

                                          cause?: OAuth2Error

                                          The underlying OAuth2 error that caused this error (if applicable).

                                          +
                                          code: string

                                          The error code associated with the custom token exchange error.

                                          +
                                          diff --git a/docs/classes/errors.DPoPError.html b/docs/classes/errors.DPoPError.html index 8bec79bef..c2d4919e3 100644 --- a/docs/classes/errors.DPoPError.html +++ b/docs/classes/errors.DPoPError.html @@ -1,4 +1,4 @@ -DPoPError | @auth0/nextjs-auth0 - v4.17.0
                                          @auth0/nextjs-auth0 - v4.17.0
                                            Preparing search index...

                                            Class DPoPError

                                            Represents an error that occurred during DPoP (Demonstrating Proof-of-Possession) operations.

                                            +DPoPError | @auth0/nextjs-auth0 - v4.18.0
                                            @auth0/nextjs-auth0 - v4.18.0
                                              Preparing search index...

                                              Class DPoPError

                                              Represents an error that occurred during DPoP (Demonstrating Proof-of-Possession) operations.

                                              DPoP is an OAuth 2.0 extension that provides application-level proof-of-possession security by binding access tokens to cryptographic key pairs. This error is thrown when DPoP-related operations fail, such as key pair operations, proof generation, or configuration issues.

                                              @@ -16,7 +16,7 @@

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              Properties

                                              Constructors

                                              • Constructs a new DPoPError instance.

                                                @@ -26,6 +26,6 @@

                                              Returns DPoPError

                                              const dpopError = new DPoPError(
                                              DPoPErrorCode.DPOP_KEY_EXPORT_FAILED,
                                              "Unable to export public key to JWK format",
                                              keyExportError
                                              );
                                              -

                                              Properties

                                              cause?: Error

                                              The underlying error that caused this DPoP error (optional)

                                              -

                                              The specific DPoP error code indicating the type of failure

                                              -
                                              +

                                              Properties

                                              cause?: Error

                                              The underlying error that caused this DPoP error (optional)

                                              +

                                              The specific DPoP error code indicating the type of failure

                                              +
                                              diff --git a/docs/classes/errors.DiscoveryError.html b/docs/classes/errors.DiscoveryError.html index 6951f16cb..4d8b98cce 100644 --- a/docs/classes/errors.DiscoveryError.html +++ b/docs/classes/errors.DiscoveryError.html @@ -1,3 +1,3 @@ -DiscoveryError | @auth0/nextjs-auth0 - v4.17.0
                                              @auth0/nextjs-auth0 - v4.17.0
                                                Preparing search index...

                                                Class DiscoveryError

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor +DiscoveryError | @auth0/nextjs-auth0 - v4.18.0
                                                @auth0/nextjs-auth0 - v4.18.0
                                                  Preparing search index...

                                                  Class DiscoveryError

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  Properties

                                                  Constructors

                                                  Properties

                                                  code: string = "discovery_error"
                                                  +

                                                  Constructors

                                                  Properties

                                                  code: string = "discovery_error"
                                                  diff --git a/docs/classes/errors.InvalidConfigurationError.html b/docs/classes/errors.InvalidConfigurationError.html index 93d0f51af..049357e43 100644 --- a/docs/classes/errors.InvalidConfigurationError.html +++ b/docs/classes/errors.InvalidConfigurationError.html @@ -1,3 +1,3 @@ -InvalidConfigurationError | @auth0/nextjs-auth0 - v4.17.0
                                                  @auth0/nextjs-auth0 - v4.17.0
                                                    Preparing search index...

                                                    Class InvalidConfigurationError

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor +InvalidConfigurationError | @auth0/nextjs-auth0 - v4.18.0
                                                    @auth0/nextjs-auth0 - v4.18.0
                                                      Preparing search index...

                                                      Class InvalidConfigurationError

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      Properties

                                                      Constructors

                                                      Properties

                                                      code: string = "invalid_configuration"
                                                      +

                                                      Constructors

                                                      Properties

                                                      code: string = "invalid_configuration"
                                                      diff --git a/docs/classes/errors.InvalidRequestError.html b/docs/classes/errors.InvalidRequestError.html index 9aa858fe5..b4f1a327d 100644 --- a/docs/classes/errors.InvalidRequestError.html +++ b/docs/classes/errors.InvalidRequestError.html @@ -1,6 +1,6 @@ -InvalidRequestError | @auth0/nextjs-auth0 - v4.17.0
                                                      @auth0/nextjs-auth0 - v4.17.0
                                                        Preparing search index...

                                                        Class InvalidRequestError

                                                        Thrown when request validation fails (missing/invalid params). +InvalidRequestError | @auth0/nextjs-auth0 - v4.18.0

                                                        @auth0/nextjs-auth0 - v4.18.0
                                                          Preparing search index...

                                                          Class InvalidRequestError

                                                          Thrown when request validation fails (missing/invalid params). Mapped to 400 Bad Request.

                                                          -

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Constructors

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Constructors

                                                          Properties

                                                          Methods

                                                          Constructors

                                                          Properties

                                                          code: string = "invalid_request"

                                                          Methods

                                                          • Returns { error: string; error_description: string }

                                                          +

                                                          Constructors

                                                          Properties

                                                          code: string = "invalid_request"

                                                          Methods

                                                          • Returns { error: string; error_description: string }

                                                          diff --git a/docs/classes/errors.InvalidStateError.html b/docs/classes/errors.InvalidStateError.html index 265868c12..50238a765 100644 --- a/docs/classes/errors.InvalidStateError.html +++ b/docs/classes/errors.InvalidStateError.html @@ -1,3 +1,3 @@ -InvalidStateError | @auth0/nextjs-auth0 - v4.17.0
                                                          @auth0/nextjs-auth0 - v4.17.0
                                                            Preparing search index...

                                                            Class InvalidStateError

                                                            Hierarchy (View Summary)

                                                            Index

                                                            Constructors

                                                            constructor +InvalidStateError | @auth0/nextjs-auth0 - v4.18.0
                                                            @auth0/nextjs-auth0 - v4.18.0
                                                              Preparing search index...

                                                              Class InvalidStateError

                                                              Hierarchy (View Summary)

                                                              Index

                                                              Constructors

                                                              Properties

                                                              Constructors

                                                              Properties

                                                              code: string = "invalid_state"
                                                              +

                                                              Constructors

                                                              Properties

                                                              code: string = "invalid_state"
                                                              diff --git a/docs/classes/errors.MfaChallengeError.html b/docs/classes/errors.MfaChallengeError.html index 59516628c..d6a6aa5ac 100644 --- a/docs/classes/errors.MfaChallengeError.html +++ b/docs/classes/errors.MfaChallengeError.html @@ -1,14 +1,14 @@ -MfaChallengeError | @auth0/nextjs-auth0 - v4.17.0
                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                Preparing search index...

                                                                Class MfaChallengeError

                                                                Error thrown when initiating an MFA challenge fails.

                                                                +MfaChallengeError | @auth0/nextjs-auth0 - v4.18.0
                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                  Preparing search index...

                                                                  Class MfaChallengeError

                                                                  Error thrown when initiating an MFA challenge fails.

                                                                  try {
                                                                  await mfa.challenge({
                                                                  mfaToken,
                                                                  challengeType: 'oob',
                                                                  authenticatorId: 'sms|dev_abc123'
                                                                  });
                                                                  } catch (error) {
                                                                  if (error instanceof MfaChallengeError) {
                                                                  if (error.cause?.error === 'invalid_authenticator_id') {
                                                                  console.error('Authenticator not found or not active');
                                                                  }
                                                                  }
                                                                  }
                                                                  -

                                                                  Hierarchy

                                                                  • MfaError
                                                                    • MfaChallengeError
                                                                  Index

                                                                  Constructors

                                                                  Hierarchy

                                                                  • MfaError
                                                                    • MfaChallengeError
                                                                  Index

                                                                  Constructors

                                                                  Properties

                                                                  Accessors

                                                                  Methods

                                                                  Constructors

                                                                  Properties

                                                                  error: string
                                                                  error_description: string

                                                                  Accessors

                                                                  Methods

                                                                  • Serialize error for HTTP responses. +

                                                                  Constructors

                                                                  Properties

                                                                  error: string
                                                                  error_description: string

                                                                  Accessors

                                                                  Methods

                                                                  • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                    -

                                                                    Returns { error: string; error_description: string }

                                                                  +

                                                                  Returns { error: string; error_description: string }

                                                                  diff --git a/docs/classes/errors.MfaEnrollmentError.html b/docs/classes/errors.MfaEnrollmentError.html index 5179f69e7..2001420e1 100644 --- a/docs/classes/errors.MfaEnrollmentError.html +++ b/docs/classes/errors.MfaEnrollmentError.html @@ -1,14 +1,14 @@ -MfaEnrollmentError | @auth0/nextjs-auth0 - v4.17.0
                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                    Preparing search index...

                                                                    Class MfaEnrollmentError

                                                                    Error thrown when MFA enrollment fails.

                                                                    +MfaEnrollmentError | @auth0/nextjs-auth0 - v4.18.0
                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                      Preparing search index...

                                                                      Class MfaEnrollmentError

                                                                      Error thrown when MFA enrollment fails.

                                                                      try {
                                                                      await mfa.enroll({
                                                                      mfaToken,
                                                                      authenticatorTypes: ['otp']
                                                                      });
                                                                      } catch (error) {
                                                                      if (error instanceof MfaEnrollmentError) {
                                                                      if (error.cause?.error === 'unsupported_challenge_type') {
                                                                      console.error('Tenant does not support OTP enrollment');
                                                                      }
                                                                      }
                                                                      }
                                                                      -

                                                                      Hierarchy

                                                                      • MfaError
                                                                        • MfaEnrollmentError
                                                                      Index

                                                                      Constructors

                                                                      Hierarchy

                                                                      • MfaError
                                                                        • MfaEnrollmentError
                                                                      Index

                                                                      Constructors

                                                                      Properties

                                                                      Accessors

                                                                      Methods

                                                                      Constructors

                                                                      Properties

                                                                      error: string
                                                                      error_description: string

                                                                      Accessors

                                                                      Methods

                                                                      • Serialize error for HTTP responses. +

                                                                      Constructors

                                                                      Properties

                                                                      error: string
                                                                      error_description: string

                                                                      Accessors

                                                                      Methods

                                                                      • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                        -

                                                                        Returns { error: string; error_description: string }

                                                                      +

                                                                      Returns { error: string; error_description: string }

                                                                      diff --git a/docs/classes/errors.MfaGetAuthenticatorsError.html b/docs/classes/errors.MfaGetAuthenticatorsError.html index 97964f107..d2347f750 100644 --- a/docs/classes/errors.MfaGetAuthenticatorsError.html +++ b/docs/classes/errors.MfaGetAuthenticatorsError.html @@ -1,14 +1,14 @@ -MfaGetAuthenticatorsError | @auth0/nextjs-auth0 - v4.17.0
                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                        Preparing search index...

                                                                        Class MfaGetAuthenticatorsError

                                                                        Error thrown when listing MFA authenticators fails.

                                                                        +MfaGetAuthenticatorsError | @auth0/nextjs-auth0 - v4.18.0
                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                          Preparing search index...

                                                                          Class MfaGetAuthenticatorsError

                                                                          Error thrown when listing MFA authenticators fails.

                                                                          try {
                                                                          const authenticators = await mfa.getAuthenticators({ mfaToken });
                                                                          } catch (error) {
                                                                          if (error instanceof MfaGetAuthenticatorsError) {
                                                                          console.error(error.code); // 'invalid_token', 'expired_token', etc.
                                                                          console.error(error.cause?.error_description);
                                                                          }
                                                                          }
                                                                          -

                                                                          Hierarchy

                                                                          • MfaError
                                                                            • MfaGetAuthenticatorsError
                                                                          Index

                                                                          Constructors

                                                                          Hierarchy

                                                                          • MfaError
                                                                            • MfaGetAuthenticatorsError
                                                                          Index

                                                                          Constructors

                                                                          Properties

                                                                          Accessors

                                                                          Methods

                                                                          Constructors

                                                                          Properties

                                                                          error: string
                                                                          error_description: string

                                                                          Accessors

                                                                          Methods

                                                                          • Serialize error for HTTP responses. +

                                                                          Constructors

                                                                          Properties

                                                                          error: string
                                                                          error_description: string

                                                                          Accessors

                                                                          Methods

                                                                          • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                            -

                                                                            Returns { error: string; error_description: string }

                                                                          +

                                                                          Returns { error: string; error_description: string }

                                                                          diff --git a/docs/classes/errors.MfaNoAvailableFactorsError.html b/docs/classes/errors.MfaNoAvailableFactorsError.html index fcd5c4b42..fc361c9f4 100644 --- a/docs/classes/errors.MfaNoAvailableFactorsError.html +++ b/docs/classes/errors.MfaNoAvailableFactorsError.html @@ -1,7 +1,7 @@ -MfaNoAvailableFactorsError | @auth0/nextjs-auth0 - v4.17.0
                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                            Preparing search index...

                                                                            Class MfaNoAvailableFactorsError

                                                                            Error thrown when no MFA factors are available for challenge. +MfaNoAvailableFactorsError | @auth0/nextjs-auth0 - v4.18.0

                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                              Preparing search index...

                                                                              Class MfaNoAvailableFactorsError

                                                                              Error thrown when no MFA factors are available for challenge. SDK-generated error (no Auth0 API equivalent).

                                                                              -

                                                                              Hierarchy (View Summary)

                                                                              Index

                                                                              Constructors

                                                                              Hierarchy (View Summary)

                                                                              Index

                                                                              Constructors

                                                                              Properties

                                                                              Constructors

                                                                              Properties

                                                                              code: string = "mfa_no_available_factors"
                                                                              error: string = "mfa_no_available_factors"
                                                                              error_description: string
                                                                              +

                                                                              Constructors

                                                                              Properties

                                                                              code: string = "mfa_no_available_factors"
                                                                              error: string = "mfa_no_available_factors"
                                                                              error_description: string
                                                                              diff --git a/docs/classes/errors.MfaVerifyError.html b/docs/classes/errors.MfaVerifyError.html index af96ec08f..0d04f99ed 100644 --- a/docs/classes/errors.MfaVerifyError.html +++ b/docs/classes/errors.MfaVerifyError.html @@ -1,14 +1,14 @@ -MfaVerifyError | @auth0/nextjs-auth0 - v4.17.0
                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                Preparing search index...

                                                                                Class MfaVerifyError

                                                                                Error thrown when MFA verification fails.

                                                                                +MfaVerifyError | @auth0/nextjs-auth0 - v4.18.0
                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                  Preparing search index...

                                                                                  Class MfaVerifyError

                                                                                  Error thrown when MFA verification fails.

                                                                                  try {
                                                                                  await mfa.verify({
                                                                                  mfaToken,
                                                                                  otp: '123456'
                                                                                  });
                                                                                  } catch (error) {
                                                                                  if (error instanceof MfaVerifyError) {
                                                                                  if (error.cause?.error === 'invalid_grant') {
                                                                                  console.error('Invalid or expired verification code');
                                                                                  }
                                                                                  }
                                                                                  }
                                                                                  -

                                                                                  Hierarchy

                                                                                  • MfaError
                                                                                    • MfaVerifyError
                                                                                  Index

                                                                                  Constructors

                                                                                  Hierarchy

                                                                                  • MfaError
                                                                                    • MfaVerifyError
                                                                                  Index

                                                                                  Constructors

                                                                                  Properties

                                                                                  Accessors

                                                                                  Methods

                                                                                  Constructors

                                                                                  Properties

                                                                                  error: string
                                                                                  error_description: string

                                                                                  Accessors

                                                                                  Methods

                                                                                  • Serialize error for HTTP responses. +

                                                                                  Constructors

                                                                                  Properties

                                                                                  error: string
                                                                                  error_description: string

                                                                                  Accessors

                                                                                  Methods

                                                                                  • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                                    -

                                                                                    Returns { error: string; error_description: string }

                                                                                  +

                                                                                  Returns { error: string; error_description: string }

                                                                                  diff --git a/docs/classes/errors.MissingStateError.html b/docs/classes/errors.MissingStateError.html index 94fda3536..1d47d4cda 100644 --- a/docs/classes/errors.MissingStateError.html +++ b/docs/classes/errors.MissingStateError.html @@ -1,3 +1,3 @@ -MissingStateError | @auth0/nextjs-auth0 - v4.17.0
                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                    Preparing search index...

                                                                                    Class MissingStateError

                                                                                    Hierarchy (View Summary)

                                                                                    Index

                                                                                    Constructors

                                                                                    constructor +MissingStateError | @auth0/nextjs-auth0 - v4.18.0
                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                      Preparing search index...

                                                                                      Class MissingStateError

                                                                                      Hierarchy (View Summary)

                                                                                      Index

                                                                                      Constructors

                                                                                      Properties

                                                                                      Constructors

                                                                                      Properties

                                                                                      code: string = "missing_state"
                                                                                      +

                                                                                      Constructors

                                                                                      Properties

                                                                                      code: string = "missing_state"
                                                                                      diff --git a/docs/classes/errors.MyAccountApiError.html b/docs/classes/errors.MyAccountApiError.html index 9d3014c91..09c04e966 100644 --- a/docs/classes/errors.MyAccountApiError.html +++ b/docs/classes/errors.MyAccountApiError.html @@ -1,5 +1,5 @@ -MyAccountApiError | @auth0/nextjs-auth0 - v4.17.0
                                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                                        Preparing search index...

                                                                                        Class MyAccountApiError

                                                                                        Error class representing a connect account request error.

                                                                                        -

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Constructors

                                                                                        constructor +MyAccountApiError | @auth0/nextjs-auth0 - v4.18.0
                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                          Preparing search index...

                                                                                          Class MyAccountApiError

                                                                                          Error class representing a connect account request error.

                                                                                          +

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Constructors

                                                                                          Properties

                                                                                          Constructors

                                                                                          • Parameters

                                                                                            • __namedParameters: {
                                                                                                  detail: string;
                                                                                                  status: number;
                                                                                                  title: string;
                                                                                                  type: string;
                                                                                                  validationErrors?: {
                                                                                                      detail: string;
                                                                                                      field?: string;
                                                                                                      pointer?: string;
                                                                                                      source?: string;
                                                                                                  }[];
                                                                                              }

                                                                                            Returns MyAccountApiError

                                                                                          Properties

                                                                                          code: string = "my_account_api_error"
                                                                                          detail: string
                                                                                          name: string = "MyAccountApiError"
                                                                                          status: number
                                                                                          title: string
                                                                                          type: string
                                                                                          validationErrors?: {
                                                                                              detail: string;
                                                                                              field?: string;
                                                                                              pointer?: string;
                                                                                              source?: string;
                                                                                          }[]

                                                                                          Type Declaration

                                                                                          • detail: string

                                                                                            A human-readable description of the specific error. Required.

                                                                                            +

                                                                                          Constructors

                                                                                          • Parameters

                                                                                            • __namedParameters: {
                                                                                                  detail: string;
                                                                                                  status: number;
                                                                                                  title: string;
                                                                                                  type: string;
                                                                                                  validationErrors?: {
                                                                                                      detail: string;
                                                                                                      field?: string;
                                                                                                      pointer?: string;
                                                                                                      source?: string;
                                                                                                  }[];
                                                                                              }

                                                                                            Returns MyAccountApiError

                                                                                          Properties

                                                                                          code: string = "my_account_api_error"
                                                                                          detail: string
                                                                                          name: string = "MyAccountApiError"
                                                                                          status: number
                                                                                          title: string
                                                                                          type: string
                                                                                          validationErrors?: {
                                                                                              detail: string;
                                                                                              field?: string;
                                                                                              pointer?: string;
                                                                                              source?: string;
                                                                                          }[]

                                                                                          Type Declaration

                                                                                          • detail: string

                                                                                            A human-readable description of the specific error. Required.

                                                                                          • Optionalfield?: string

                                                                                            The name of the invalid parameter. Optional.

                                                                                          • Optionalpointer?: string

                                                                                            A JSON Pointer that points to the exact location of the error in a JSON document being validated. Optional.

                                                                                          • Optionalsource?: string

                                                                                            Specifies the source of the error (e.g., body, query, or header in an HTML message). Optional.

                                                                                            -
                                                                                          +
                                                                                          diff --git a/docs/classes/errors.OAuth2Error.html b/docs/classes/errors.OAuth2Error.html index 9e4a28e69..882b6566e 100644 --- a/docs/classes/errors.OAuth2Error.html +++ b/docs/classes/errors.OAuth2Error.html @@ -1,5 +1,5 @@ -OAuth2Error | @auth0/nextjs-auth0 - v4.17.0
                                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                                            Preparing search index...

                                                                                            Class OAuth2Error

                                                                                            Errors that come from Auth0 in the redirect_uri callback may contain reflected user input via the OpenID Connect error and error_description query parameter. +OAuth2Error | @auth0/nextjs-auth0 - v4.18.0

                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                              Preparing search index...

                                                                                              Class OAuth2Error

                                                                                              Errors that come from Auth0 in the redirect_uri callback may contain reflected user input via the OpenID Connect error and error_description query parameter. You should not render the error message, or error and error_description properties without properly escaping them first.

                                                                                              -

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Constructors

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Constructors

                                                                                              Properties

                                                                                              Constructors

                                                                                              Properties

                                                                                              code: string
                                                                                              +

                                                                                              Constructors

                                                                                              Properties

                                                                                              code: string
                                                                                              diff --git a/docs/classes/errors.SdkError.html b/docs/classes/errors.SdkError.html index 2233c4398..fee9e09a0 100644 --- a/docs/classes/errors.SdkError.html +++ b/docs/classes/errors.SdkError.html @@ -1,3 +1,3 @@ -SdkError | @auth0/nextjs-auth0 - v4.17.0
                                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                                Preparing search index...

                                                                                                Class SdkErrorAbstract

                                                                                                Hierarchy (View Summary)

                                                                                                Index

                                                                                                Constructors

                                                                                                constructor +SdkError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                  Preparing search index...
                                                                                                  +

                                                                                                  Constructors

                                                                                                  • Parameters

                                                                                                    • Optionalmessage: string

                                                                                                    Returns SdkError

                                                                                                  Properties

                                                                                                  code: string
                                                                                                  diff --git a/docs/classes/server.AbstractSessionStore.html b/docs/classes/server.AbstractSessionStore.html index 3ab0c0d5a..c7977be24 100644 --- a/docs/classes/server.AbstractSessionStore.html +++ b/docs/classes/server.AbstractSessionStore.html @@ -1,4 +1,4 @@ -AbstractSessionStore | @auth0/nextjs-auth0 - v4.17.0
                                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                                    Preparing search index...

                                                                                                    Class AbstractSessionStoreAbstract

                                                                                                    Index

                                                                                                    Constructors

                                                                                                    constructor +AbstractSessionStore | @auth0/nextjs-auth0 - v4.18.0
                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                      Preparing search index...

                                                                                                      Class AbstractSessionStoreAbstract

                                                                                                      Index

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      cookieConfig rolling secret @@ -10,9 +10,9 @@ epoch get set -

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      cookieConfig: CookieOptions
                                                                                                      rolling: boolean
                                                                                                      secret: string
                                                                                                      sessionCookieName: string

                                                                                                      Accessors

                                                                                                      Methods

                                                                                                      • calculateMaxAge calculates the max age of the session based on createdAt and the rolling and absolute durations.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • createdAt: number

                                                                                                        Returns number

                                                                                                      • save adds the encrypted session cookie as a Set-Cookie header. If the iat property +

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      cookieConfig: CookieOptions
                                                                                                      rolling: boolean
                                                                                                      secret: string
                                                                                                      sessionCookieName: string

                                                                                                      Accessors

                                                                                                      Methods

                                                                                                      • calculateMaxAge calculates the max age of the session based on createdAt and the rolling and absolute durations.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • createdAt: number

                                                                                                        Returns number

                                                                                                      • save adds the encrypted session cookie as a Set-Cookie header. If the iat property is present on the session, then it will be used to compute the maxAge cookie value.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        Returns Promise<void>

                                                                                                      +

                                                                                                      Parameters

                                                                                                      Returns Promise<void>

                                                                                                      diff --git a/docs/classes/server.Auth0Client.html b/docs/classes/server.Auth0Client.html index b7ecb3a38..66919b592 100644 --- a/docs/classes/server.Auth0Client.html +++ b/docs/classes/server.Auth0Client.html @@ -1,4 +1,4 @@ -Auth0Client | @auth0/nextjs-auth0 - v4.17.0
                                                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                                                        Preparing search index...

                                                                                                        Class Auth0Client

                                                                                                        Index

                                                                                                        Constructors

                                                                                                        constructor +Auth0Client | @auth0/nextjs-auth0 - v4.18.0
                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                          Preparing search index...

                                                                                                          Class Auth0Client

                                                                                                          Index

                                                                                                          Constructors

                                                                                                          Accessors

                                                                                                          • get mfa(): ServerMfaClient

                                                                                                            MFA API for server-side operations.

                                                                                                            +

                                                                                                          Constructors

                                                                                                          Accessors

                                                                                                          • get mfa(): ServerMfaClient

                                                                                                            MFA API for server-side operations.

                                                                                                            Provides access to MFA methods that require encrypted mfa_token from MfaRequiredError:

                                                                                                            • getAuthenticators: List enrolled MFA factors
                                                                                                            • @@ -22,13 +22,13 @@

                                                                                                            Returns ServerMfaClient

                                                                                                            try {
                                                                                                            const { token } = await auth0.getAccessToken({ audience: 'https://api.example.com' });
                                                                                                            } catch (error) {
                                                                                                            if (error instanceof MfaRequiredError) {
                                                                                                            // Get available authenticators
                                                                                                            const authenticators = await auth0.mfa.getAuthenticators({
                                                                                                            mfaToken: error.mfa_token
                                                                                                            });

                                                                                                            // Initiate challenge
                                                                                                            const challenge = await auth0.mfa.challenge({
                                                                                                            mfaToken: error.mfa_token,
                                                                                                            challengeType: 'otp',
                                                                                                            authenticatorId: authenticators[0].id
                                                                                                            });

                                                                                                            // Verify code
                                                                                                            const tokens = await auth0.mfa.verify({
                                                                                                            mfaToken: error.mfa_token,
                                                                                                            otp: '123456'
                                                                                                            });
                                                                                                            }
                                                                                                            }
                                                                                                            -

                                                                                                          Methods

                                                                                                          Methods

                                                                                                          • Initiates the Connect Account flow to connect a third-party account to the user's profile. If the user does not have an active session, a ConnectAccountError is thrown.

                                                                                                            This method first attempts to obtain an access token with the create:me:connected_accounts scope for the My Account API to create a connected account for the user.

                                                                                                            The user will then be redirected to authorize the connection with the third-party provider.

                                                                                                            You must enable Offline Access from the Connection Permissions settings to be able to use the connection with Connected Accounts.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            Returns Promise<NextResponse<unknown>>

                                                                                                          • Creates a configured Fetcher instance for making authenticated API requests.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            Returns Promise<NextResponse<unknown>>

                                                                                                          • Creates a configured Fetcher instance for making authenticated API requests.

                                                                                                            This method creates a specialized HTTP client that handles:

                                                                                                            • Automatic access token retrieval and injection
                                                                                                            • @@ -55,7 +55,7 @@
                                                                                                            • Fetcher for details on using the returned fetcher instance
                                                                                                            • FetcherMinimalConfig for available configuration options
                                                                                                            -

                                                                                                          Returns Promise<
                                                                                                              {
                                                                                                                  audience?: string;
                                                                                                                  expiresAt: number;
                                                                                                                  scope?: string;
                                                                                                                  token: string;
                                                                                                                  token_type?: string;
                                                                                                              },
                                                                                                          >

                                                                                                        • getAccessToken returns the access token.

                                                                                                          This method can be used in middleware and getServerSideProps, API routes in the Pages Router.

                                                                                                          Parameters

                                                                                                          • req: NextRequest | PagesRouterRequest

                                                                                                            The request object.

                                                                                                          • res: NextResponse<unknown> | PagesRouterResponse

                                                                                                            The response object.

                                                                                                            @@ -79,23 +79,23 @@
                                                                                                            • Optionalaudience?: string | null

                                                                                                              Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens

                                                                                                              -
                                                                                                            • Optionalrefresh?: boolean | null
                                                                                                            • Optionalscope?: string | null

                                                                                                          Returns Promise<
                                                                                                              {
                                                                                                                  audience?: string;
                                                                                                                  expiresAt: number;
                                                                                                                  scope?: string;
                                                                                                                  token: string;
                                                                                                                  token_type?: string;
                                                                                                              },
                                                                                                          >

                                                                                                        • Returns Promise<
                                                                                                              {
                                                                                                                  audience?: string;
                                                                                                                  expiresAt: number;
                                                                                                                  scope?: string;
                                                                                                                  token: string;
                                                                                                                  token_type?: string;
                                                                                                              },
                                                                                                          >

                                                                                                          +

                                                                                                          Parameters

                                                                                                          Returns Promise<void>

                                                                                                          diff --git a/docs/classes/server.DomainResolutionError.html b/docs/classes/server.DomainResolutionError.html index cf0baec9a..8fe2fd9b9 100644 --- a/docs/classes/server.DomainResolutionError.html +++ b/docs/classes/server.DomainResolutionError.html @@ -1,10 +1,10 @@ -DomainResolutionError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                                                            Preparing search index...

                                                                                                            Class DomainResolutionError

                                                                                                            Error thrown when domain resolution fails during MCD initialization or request handling.

                                                                                                            +DomainResolutionError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                              Preparing search index...

                                                                                                              Class DomainResolutionError

                                                                                                              Error thrown when domain resolution fails during MCD initialization or request handling.

                                                                                                              This error is public and may be caught by application code.

                                                                                                              -

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              cause?: Error

                                                                                                              The underlying error that caused the resolution failure (optional)

                                                                                                              -
                                                                                                              code: string = "domain_resolution_error"
                                                                                                              +

                                                                                                              Returns DomainResolutionError

                                                                                                              Properties

                                                                                                              cause?: Error

                                                                                                              The underlying error that caused the resolution failure (optional)

                                                                                                              +
                                                                                                              code: string = "domain_resolution_error"
                                                                                                              diff --git a/docs/classes/server.DomainValidationError.html b/docs/classes/server.DomainValidationError.html index f7e16fc8d..ab439c544 100644 --- a/docs/classes/server.DomainValidationError.html +++ b/docs/classes/server.DomainValidationError.html @@ -1,8 +1,8 @@ -DomainValidationError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                                                Preparing search index...

                                                                                                                Class DomainValidationError

                                                                                                                Error thrown when a domain hostname fails validation.

                                                                                                                +DomainValidationError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                  Preparing search index...

                                                                                                                  Class DomainValidationError

                                                                                                                  Error thrown when a domain hostname fails validation.

                                                                                                                  This includes rejection of IP addresses, localhost, .local domains, paths, and ports. This error is public and may be caught by application code.

                                                                                                                  -

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Constructors

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  code: string = "domain_validation_error"
                                                                                                                  +

                                                                                                                  Returns DomainValidationError

                                                                                                                  Properties

                                                                                                                  code: string = "domain_validation_error"
                                                                                                                  diff --git a/docs/classes/server.IssuerValidationError.html b/docs/classes/server.IssuerValidationError.html index b453abb3b..4b6335a14 100644 --- a/docs/classes/server.IssuerValidationError.html +++ b/docs/classes/server.IssuerValidationError.html @@ -1,12 +1,12 @@ -IssuerValidationError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                                                    Preparing search index...

                                                                                                                    Class IssuerValidationError

                                                                                                                    Error thrown when the issuer URL is invalid or cannot be resolved.

                                                                                                                    +IssuerValidationError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                      Preparing search index...

                                                                                                                      Class IssuerValidationError

                                                                                                                      Error thrown when the issuer URL is invalid or cannot be resolved.

                                                                                                                      This error is public and may be caught by application code.

                                                                                                                      -

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      Properties

                                                                                                                      actualIssuer: string

                                                                                                                      The actual issuer URL from the token

                                                                                                                      -
                                                                                                                      code: string = "issuer_validation_error"
                                                                                                                      expectedIssuer: string

                                                                                                                      The expected issuer URL

                                                                                                                      -
                                                                                                                      +

                                                                                                                      Returns IssuerValidationError

                                                                                                                      Properties

                                                                                                                      actualIssuer: string

                                                                                                                      The actual issuer URL from the token

                                                                                                                      +
                                                                                                                      code: string = "issuer_validation_error"
                                                                                                                      expectedIssuer: string

                                                                                                                      The expected issuer URL

                                                                                                                      +
                                                                                                                      diff --git a/docs/classes/server.MfaRequiredError.html b/docs/classes/server.MfaRequiredError.html index 7234c6931..84d82d34d 100644 --- a/docs/classes/server.MfaRequiredError.html +++ b/docs/classes/server.MfaRequiredError.html @@ -1,4 +1,4 @@ -MfaRequiredError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                                                                        Preparing search index...

                                                                                                                        Class MfaRequiredError

                                                                                                                        Thrown when getAccessToken requires MFA step-up authentication.

                                                                                                                        +MfaRequiredError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                          Preparing search index...

                                                                                                                          Class MfaRequiredError

                                                                                                                          Thrown when getAccessToken requires MFA step-up authentication.

                                                                                                                          This error is thrown during token refresh when Auth0 returns mfa_required. The mfa_token property contains an encrypted token that can be used with Auth0's MFA API to complete the authentication challenge.

                                                                                                                          @@ -13,7 +13,7 @@

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          Properties

                                                                                                                          cause? code error @@ -28,11 +28,11 @@

                                                                                                                          Returns MfaRequiredError

                                                                                                                          Constructor parameters use camelCase (mfaToken, mfaRequirements) for consistency with SDK conventions, but they are assigned to snake_case properties (mfa_token, mfa_requirements) to match Auth0 API response format.

                                                                                                                          -

                                                                                                                          Properties

                                                                                                                          cause?: Error
                                                                                                                          code: string = "mfa_required"
                                                                                                                          error: string = "mfa_required"

                                                                                                                          Original Auth0 error code

                                                                                                                          -
                                                                                                                          error_description: string

                                                                                                                          Original Auth0 error description

                                                                                                                          -
                                                                                                                          mfa_requirements?: MfaRequirements

                                                                                                                          MFA requirements indicating available challenge/enrollment methods

                                                                                                                          -
                                                                                                                          mfa_token: string

                                                                                                                          Encrypted MFA token to pass to MFA API methods.

                                                                                                                          -

                                                                                                                          Methods

                                                                                                                          Properties

                                                                                                                          cause?: Error
                                                                                                                          code: string = "mfa_required"
                                                                                                                          error: string = "mfa_required"

                                                                                                                          Original Auth0 error code

                                                                                                                          +
                                                                                                                          error_description: string

                                                                                                                          Original Auth0 error description

                                                                                                                          +
                                                                                                                          mfa_requirements?: MfaRequirements

                                                                                                                          MFA requirements indicating available challenge/enrollment methods

                                                                                                                          +
                                                                                                                          mfa_token: string

                                                                                                                          Encrypted MFA token to pass to MFA API methods.

                                                                                                                          +

                                                                                                                          Methods

                                                                                                                          • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                                                                            -

                                                                                                                            Returns {
                                                                                                                                error: string;
                                                                                                                                error_description: string;
                                                                                                                                mfa_requirements?: MfaRequirements;
                                                                                                                                mfa_token: string;
                                                                                                                            }

                                                                                                                          +

                                                                                                                          Returns {
                                                                                                                              error: string;
                                                                                                                              error_description: string;
                                                                                                                              mfa_requirements?: MfaRequirements;
                                                                                                                              mfa_token: string;
                                                                                                                          }

                                                                                                                          diff --git a/docs/classes/server.MfaTokenExpiredError.html b/docs/classes/server.MfaTokenExpiredError.html index e0c5fa800..346189006 100644 --- a/docs/classes/server.MfaTokenExpiredError.html +++ b/docs/classes/server.MfaTokenExpiredError.html @@ -1,4 +1,4 @@ -MfaTokenExpiredError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                                                                            Preparing search index...

                                                                                                                            Class MfaTokenExpiredError

                                                                                                                            Thrown when MFA API methods are called but no context exists in session +MfaTokenExpiredError | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                              Preparing search index...

                                                                                                                              Class MfaTokenExpiredError

                                                                                                                              Thrown when MFA API methods are called but no context exists in session for the provided encrypted mfa_token.

                                                                                                                              This typically occurs when:

                                                                                                                                @@ -9,6 +9,6 @@
                                                                                                                              try {
                                                                                                                              await auth0.completeMfaChallenge(mfaToken, code);
                                                                                                                              } catch (error) {
                                                                                                                              if (error instanceof MfaTokenNotFoundError) {
                                                                                                                              // Restart MFA flow - context was lost
                                                                                                                              redirect("/auth/login?prompt=mfa");
                                                                                                                              }
                                                                                                                              }
                                                                                                                              -

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              code: string = "mfa_token_expired"
                                                                                                                              +

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              code: string = "mfa_token_expired"
                                                                                                                              diff --git a/docs/classes/server.MfaTokenInvalidError.html b/docs/classes/server.MfaTokenInvalidError.html index e289d4fe4..5b021dbca 100644 --- a/docs/classes/server.MfaTokenInvalidError.html +++ b/docs/classes/server.MfaTokenInvalidError.html @@ -1,10 +1,10 @@ -MfaTokenInvalidError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                Preparing search index...

                                                                                                                                Class MfaTokenInvalidError

                                                                                                                                Thrown when the encrypted mfa_token is invalid.

                                                                                                                                +MfaTokenInvalidError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                  Preparing search index...

                                                                                                                                  Class MfaTokenInvalidError

                                                                                                                                  Thrown when the encrypted mfa_token is invalid.

                                                                                                                                  This occurs when:

                                                                                                                                  • The token was tampered with
                                                                                                                                  • The token is malformed (not valid JWE)
                                                                                                                                  • The token was encrypted with a different secret
                                                                                                                                  -

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  code: string = "mfa_token_invalid"
                                                                                                                                  +

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  code: string = "mfa_token_invalid"
                                                                                                                                  diff --git a/docs/classes/server.SessionDomainMismatchError.html b/docs/classes/server.SessionDomainMismatchError.html index dfc27380f..4274a08e6 100644 --- a/docs/classes/server.SessionDomainMismatchError.html +++ b/docs/classes/server.SessionDomainMismatchError.html @@ -1,8 +1,8 @@ -SessionDomainMismatchError | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                    Preparing search index...

                                                                                                                                    Class SessionDomainMismatchError

                                                                                                                                    Error thrown when a session's domain does not match the current request domain.

                                                                                                                                    +SessionDomainMismatchError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                      Preparing search index...

                                                                                                                                      Class SessionDomainMismatchError

                                                                                                                                      Error thrown when a session's domain does not match the current request domain.

                                                                                                                                      This indicates a potential security issue where a user is attempting to use a session created for a different domain.

                                                                                                                                      -

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      Properties

                                                                                                                                      Constructors

                                                                                                                                      Properties

                                                                                                                                      code: string = "session_domain_mismatch"
                                                                                                                                      +

                                                                                                                                      Returns SessionDomainMismatchError

                                                                                                                                      Properties

                                                                                                                                      code: string = "session_domain_mismatch"
                                                                                                                                      diff --git a/docs/classes/server.TransactionStore.html b/docs/classes/server.TransactionStore.html index 1fad7c017..2d1212591 100644 --- a/docs/classes/server.TransactionStore.html +++ b/docs/classes/server.TransactionStore.html @@ -1,15 +1,15 @@ -TransactionStore | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                        Preparing search index...

                                                                                                                                        Class TransactionStore

                                                                                                                                        TransactionStore is responsible for storing the state required to successfully complete +TransactionStore | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                          Preparing search index...

                                                                                                                                          Class TransactionStore

                                                                                                                                          TransactionStore is responsible for storing the state required to successfully complete an authentication transaction. The store relies on encrypted, stateless cookies to store the transaction state.

                                                                                                                                          -
                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          Methods

                                                                                                                                          • Parameters

                                                                                                                                            • resCookies: ResponseCookies
                                                                                                                                            • state: string

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Deletes all transaction cookies based on the configured prefix.

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • reqCookies: RequestCookies
                                                                                                                                            • resCookies: ResponseCookies

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Saves the transaction state to an encrypted cookie.

                                                                                                                                            +

                                                                                                                                          Constructors

                                                                                                                                          Methods

                                                                                                                                          • Parameters

                                                                                                                                            • resCookies: ResponseCookies
                                                                                                                                            • state: string

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Deletes all transaction cookies based on the configured prefix.

                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            • reqCookies: RequestCookies
                                                                                                                                            • resCookies: ResponseCookies

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Saves the transaction state to an encrypted cookie.

                                                                                                                                            Parameters

                                                                                                                                            • resCookies: ResponseCookies

                                                                                                                                              The response cookies object to set the transaction cookie on

                                                                                                                                            • transactionState: TransactionState

                                                                                                                                              The transaction state to save

                                                                                                                                            • OptionalreqCookies: RequestCookies

                                                                                                                                              Optional request cookies to check for existing transactions. @@ -17,4 +17,4 @@ will check for existing transaction cookies. When omitted, the existence check is skipped for performance optimization.

                                                                                                                                            Returns Promise<void>

                                                                                                                                            When transaction state is missing required state parameter

                                                                                                                                            -
                                                                                                                                          +
                                                                                                                                          diff --git a/docs/enums/errors.AccessTokenErrorCode.html b/docs/enums/errors.AccessTokenErrorCode.html index 3dcf31e89..62da47d52 100644 --- a/docs/enums/errors.AccessTokenErrorCode.html +++ b/docs/enums/errors.AccessTokenErrorCode.html @@ -1,4 +1,4 @@ -AccessTokenErrorCode | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                            Preparing search index...

                                                                                                                                            Enumeration AccessTokenErrorCode

                                                                                                                                            Index

                                                                                                                                            Enumeration Members

                                                                                                                                            FAILED_TO_REFRESH_TOKEN +AccessTokenErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                              Preparing search index...

                                                                                                                                              Enumeration AccessTokenErrorCode

                                                                                                                                              Index

                                                                                                                                              Enumeration Members

                                                                                                                                              FAILED_TO_REFRESH_TOKEN: "failed_to_refresh_token"
                                                                                                                                              MISSING_REFRESH_TOKEN: "missing_refresh_token"
                                                                                                                                              MISSING_SESSION: "missing_session"
                                                                                                                                              +

                                                                                                                                              Enumeration Members

                                                                                                                                              FAILED_TO_REFRESH_TOKEN: "failed_to_refresh_token"
                                                                                                                                              MISSING_REFRESH_TOKEN: "missing_refresh_token"
                                                                                                                                              MISSING_SESSION: "missing_session"
                                                                                                                                              diff --git a/docs/enums/errors.AccessTokenForConnectionErrorCode.html b/docs/enums/errors.AccessTokenForConnectionErrorCode.html index 5765d96b4..06972eddb 100644 --- a/docs/enums/errors.AccessTokenForConnectionErrorCode.html +++ b/docs/enums/errors.AccessTokenForConnectionErrorCode.html @@ -1,8 +1,8 @@ -AccessTokenForConnectionErrorCode | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                Preparing search index...

                                                                                                                                                Enumeration AccessTokenForConnectionErrorCode

                                                                                                                                                Enum representing error codes related to access tokens for connections.

                                                                                                                                                -
                                                                                                                                                Index

                                                                                                                                                Enumeration Members

                                                                                                                                                FAILED_TO_EXCHANGE +AccessTokenForConnectionErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Enumeration AccessTokenForConnectionErrorCode

                                                                                                                                                  Enum representing error codes related to access tokens for connections.

                                                                                                                                                  +
                                                                                                                                                  Index

                                                                                                                                                  Enumeration Members

                                                                                                                                                  FAILED_TO_EXCHANGE: "failed_to_exchange_refresh_token"

                                                                                                                                                  Failed to exchange the refresh token.

                                                                                                                                                  -
                                                                                                                                                  MISSING_REFRESH_TOKEN: "missing_refresh_token"

                                                                                                                                                  The refresh token is missing.

                                                                                                                                                  -
                                                                                                                                                  MISSING_SESSION: "missing_session"

                                                                                                                                                  The session is missing.

                                                                                                                                                  -
                                                                                                                                                  +
                                                                                                                                                  MISSING_REFRESH_TOKEN: "missing_refresh_token"

                                                                                                                                                  The refresh token is missing.

                                                                                                                                                  +
                                                                                                                                                  MISSING_SESSION: "missing_session"

                                                                                                                                                  The session is missing.

                                                                                                                                                  +
                                                                                                                                                  diff --git a/docs/enums/errors.ConnectAccountErrorCodes.html b/docs/enums/errors.ConnectAccountErrorCodes.html index 50d128981..3aa688eae 100644 --- a/docs/enums/errors.ConnectAccountErrorCodes.html +++ b/docs/enums/errors.ConnectAccountErrorCodes.html @@ -1,8 +1,8 @@ -ConnectAccountErrorCodes | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Enumeration ConnectAccountErrorCodes

                                                                                                                                                    Enum representing error codes related to the connect account flow.

                                                                                                                                                    -
                                                                                                                                                    Index

                                                                                                                                                    Enumeration Members

                                                                                                                                                    FAILED_TO_COMPLETE +ConnectAccountErrorCodes | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Enumeration ConnectAccountErrorCodes

                                                                                                                                                      Enum representing error codes related to the connect account flow.

                                                                                                                                                      +
                                                                                                                                                      Index

                                                                                                                                                      Enumeration Members

                                                                                                                                                      FAILED_TO_COMPLETE: "failed_to_complete"

                                                                                                                                                      Failed to complete the connect account flow.

                                                                                                                                                      -
                                                                                                                                                      FAILED_TO_INITIATE: "failed_to_initiate"

                                                                                                                                                      Failed to initiate the connect account flow.

                                                                                                                                                      -
                                                                                                                                                      MISSING_SESSION: "missing_session"

                                                                                                                                                      The session is missing.

                                                                                                                                                      -
                                                                                                                                                      +
                                                                                                                                                      FAILED_TO_INITIATE: "failed_to_initiate"

                                                                                                                                                      Failed to initiate the connect account flow.

                                                                                                                                                      +
                                                                                                                                                      MISSING_SESSION: "missing_session"

                                                                                                                                                      The session is missing.

                                                                                                                                                      +
                                                                                                                                                      diff --git a/docs/enums/errors.CustomTokenExchangeErrorCode.html b/docs/enums/errors.CustomTokenExchangeErrorCode.html index 5eb185ae4..80a9ba926 100644 --- a/docs/enums/errors.CustomTokenExchangeErrorCode.html +++ b/docs/enums/errors.CustomTokenExchangeErrorCode.html @@ -1,10 +1,10 @@ -CustomTokenExchangeErrorCode | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Enumeration CustomTokenExchangeErrorCode

                                                                                                                                                        Error codes for Custom Token Exchange errors.

                                                                                                                                                        -
                                                                                                                                                        Index

                                                                                                                                                        Enumeration Members

                                                                                                                                                        EXCHANGE_FAILED +CustomTokenExchangeErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Enumeration CustomTokenExchangeErrorCode

                                                                                                                                                          Error codes for Custom Token Exchange errors.

                                                                                                                                                          +
                                                                                                                                                          Index

                                                                                                                                                          Enumeration Members

                                                                                                                                                          EXCHANGE_FAILED: "exchange_failed"

                                                                                                                                                          The token exchange request failed.

                                                                                                                                                          -
                                                                                                                                                          INVALID_SUBJECT_TOKEN_TYPE: "invalid_subject_token_type"

                                                                                                                                                          The subject_token_type is not a valid URI, wrong length, or uses a reserved namespace.

                                                                                                                                                          -
                                                                                                                                                          MISSING_ACTOR_TOKEN_TYPE: "missing_actor_token_type"

                                                                                                                                                          The actor_token was provided without actor_token_type.

                                                                                                                                                          -
                                                                                                                                                          MISSING_SUBJECT_TOKEN: "missing_subject_token"

                                                                                                                                                          The subject_token is missing or empty.

                                                                                                                                                          -
                                                                                                                                                          +
                                                                                                                                                          INVALID_SUBJECT_TOKEN_TYPE: "invalid_subject_token_type"

                                                                                                                                                          The subject_token_type is not a valid URI, wrong length, or uses a reserved namespace.

                                                                                                                                                          +
                                                                                                                                                          MISSING_ACTOR_TOKEN_TYPE: "missing_actor_token_type"

                                                                                                                                                          The actor_token was provided without actor_token_type.

                                                                                                                                                          +
                                                                                                                                                          MISSING_SUBJECT_TOKEN: "missing_subject_token"

                                                                                                                                                          The subject_token is missing or empty.

                                                                                                                                                          +
                                                                                                                                                          diff --git a/docs/enums/errors.DPoPErrorCode.html b/docs/enums/errors.DPoPErrorCode.html index d2321c45f..2c433dd50 100644 --- a/docs/enums/errors.DPoPErrorCode.html +++ b/docs/enums/errors.DPoPErrorCode.html @@ -1,16 +1,16 @@ -DPoPErrorCode | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Enumeration DPoPErrorCode

                                                                                                                                                            Error codes for DPoP-related errors.

                                                                                                                                                            +DPoPErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Enumeration DPoPErrorCode

                                                                                                                                                              Error codes for DPoP-related errors.

                                                                                                                                                              These error codes categorize different types of failures that can occur during DPoP (Demonstrating Proof-of-Possession) operations.

                                                                                                                                                              -
                                                                                                                                                              Index

                                                                                                                                                              Enumeration Members

                                                                                                                                                              Index

                                                                                                                                                              Enumeration Members

                                                                                                                                                              DPOP_CONFIGURATION_ERROR: "dpop_configuration_error"

                                                                                                                                                              DPoP configuration is invalid or incomplete. This occurs when the provided DPoP configuration contains invalid values or missing required components.

                                                                                                                                                              -
                                                                                                                                                              DPOP_JKT_CALCULATION_FAILED: "dpop_jkt_calculation_failed"

                                                                                                                                                              Failed to calculate dpop_jkt (JWK thumbprint) parameter. +

                                                                                                                                                              DPOP_JKT_CALCULATION_FAILED: "dpop_jkt_calculation_failed"

                                                                                                                                                              Failed to calculate dpop_jkt (JWK thumbprint) parameter. This occurs when the SDK cannot generate the required thumbprint from the provided public key for the authorization request.

                                                                                                                                                              -
                                                                                                                                                              DPOP_KEY_EXPORT_FAILED: "dpop_key_export_failed"

                                                                                                                                                              Failed to export DPoP public key to JWK format. +

                                                                                                                                                              DPOP_KEY_EXPORT_FAILED: "dpop_key_export_failed"

                                                                                                                                                              Failed to export DPoP public key to JWK format. This occurs when the SDK cannot convert the CryptoKey to the JSON Web Key format required for DPoP proofs.

                                                                                                                                                              -
                                                                                                                                                              +
                                                                                                                                                              diff --git a/docs/enums/types.RESPONSE_TYPES.html b/docs/enums/types.RESPONSE_TYPES.html index 195c28901..84a38f736 100644 --- a/docs/enums/types.RESPONSE_TYPES.html +++ b/docs/enums/types.RESPONSE_TYPES.html @@ -1,5 +1,5 @@ -RESPONSE_TYPES | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Enumeration RESPONSE_TYPES

                                                                                                                                                                Index

                                                                                                                                                                Enumeration Members

                                                                                                                                                                CODE +RESPONSE_TYPES | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Enumeration RESPONSE_TYPES

                                                                                                                                                                  Index

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  CODE: "code"

                                                                                                                                                                  Authorization Code flow.

                                                                                                                                                                  -
                                                                                                                                                                  CONNECT_CODE: "connect_code"

                                                                                                                                                                  Connect Account flow.

                                                                                                                                                                  -
                                                                                                                                                                  +
                                                                                                                                                                  CONNECT_CODE: "connect_code"

                                                                                                                                                                  Connect Account flow.

                                                                                                                                                                  +
                                                                                                                                                                  diff --git a/docs/enums/types.SUBJECT_TOKEN_TYPES.html b/docs/enums/types.SUBJECT_TOKEN_TYPES.html index df02b0772..186bee053 100644 --- a/docs/enums/types.SUBJECT_TOKEN_TYPES.html +++ b/docs/enums/types.SUBJECT_TOKEN_TYPES.html @@ -1,7 +1,7 @@ -SUBJECT_TOKEN_TYPES | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Enumeration SUBJECT_TOKEN_TYPES

                                                                                                                                                                    Index

                                                                                                                                                                    Enumeration Members

                                                                                                                                                                    SUBJECT_TYPE_ACCESS_TOKEN +SUBJECT_TOKEN_TYPES | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Enumeration SUBJECT_TOKEN_TYPES

                                                                                                                                                                      Index

                                                                                                                                                                      Enumeration Members

                                                                                                                                                                      SUBJECT_TYPE_ACCESS_TOKEN: "urn:ietf:params:oauth:token-type:access_token"

                                                                                                                                                                      Indicates that the token is an OAuth 2.0 access token issued by the given authorization server.

                                                                                                                                                                      SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"

                                                                                                                                                                      Indicates that the token is an OAuth 2.0 refresh token issued by the given authorization server.

                                                                                                                                                                      +
                                                                                                                                                                      SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"

                                                                                                                                                                      Indicates that the token is an OAuth 2.0 refresh token issued by the given authorization server.

                                                                                                                                                                      +
                                                                                                                                                                      diff --git a/docs/functions/client.Auth0Provider.html b/docs/functions/client.Auth0Provider.html index 3608fb003..b73362378 100644 --- a/docs/functions/client.Auth0Provider.html +++ b/docs/functions/client.Auth0Provider.html @@ -1 +1 @@ -Auth0Provider | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Function Auth0Provider

                                                                                                                                                                        +Auth0Provider | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Function Auth0Provider

                                                                                                                                                                          diff --git a/docs/functions/client.getAccessToken.html b/docs/functions/client.getAccessToken.html index 82fe663be..f640d1d5a 100644 --- a/docs/functions/client.getAccessToken.html +++ b/docs/functions/client.getAccessToken.html @@ -1,11 +1,11 @@ -getAccessToken | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Function getAccessToken

                                                                                                                                                                            • Fetches an access token for the currently logged-in user.

                                                                                                                                                                              +getAccessToken | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function getAccessToken

                                                                                                                                                                              • Fetches an access token for the currently logged-in user.

                                                                                                                                                                                Parameters

                                                                                                                                                                                • Optionaloptions: AccessTokenOptions & { includeFullResponse?: false }

                                                                                                                                                                                  Options for fetching the access token, including optional audience and scope.

                                                                                                                                                                                Returns Promise<string>

                                                                                                                                                                                The access token as a string, or the full token response when includeFullResponse is true.

                                                                                                                                                                                Passing audience or scope relies on MRRT to be configured in your Auth0 Application.

                                                                                                                                                                              +
                                                                                                                                                                              diff --git a/docs/functions/client.useUser.html b/docs/functions/client.useUser.html index dc1918e6b..90bc1c8e1 100644 --- a/docs/functions/client.useUser.html +++ b/docs/functions/client.useUser.html @@ -1 +1 @@ -useUser | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function useUser

                                                                                                                                                                                • Returns
                                                                                                                                                                                      | {
                                                                                                                                                                                          error: Error;
                                                                                                                                                                                          invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                          isLoading: boolean;
                                                                                                                                                                                          user: null;
                                                                                                                                                                                      }
                                                                                                                                                                                      | {
                                                                                                                                                                                          error: null;
                                                                                                                                                                                          invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                          isLoading: boolean;
                                                                                                                                                                                          user: User;
                                                                                                                                                                                      }
                                                                                                                                                                                      | {
                                                                                                                                                                                          error: undefined;
                                                                                                                                                                                          invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                          isLoading: boolean;
                                                                                                                                                                                          user: undefined;
                                                                                                                                                                                      }

                                                                                                                                                                                +useUser | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Function useUser

                                                                                                                                                                                  • Returns
                                                                                                                                                                                        | {
                                                                                                                                                                                            error: Error;
                                                                                                                                                                                            invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                            isLoading: boolean;
                                                                                                                                                                                            user: null;
                                                                                                                                                                                        }
                                                                                                                                                                                        | {
                                                                                                                                                                                            error: null;
                                                                                                                                                                                            invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                            isLoading: boolean;
                                                                                                                                                                                            user: User;
                                                                                                                                                                                        }
                                                                                                                                                                                        | {
                                                                                                                                                                                            error: undefined;
                                                                                                                                                                                            invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                            isLoading: boolean;
                                                                                                                                                                                            user: undefined;
                                                                                                                                                                                        }

                                                                                                                                                                                  diff --git a/docs/functions/server.filterDefaultIdTokenClaims.html b/docs/functions/server.filterDefaultIdTokenClaims.html index 71919bd09..d4401bc07 100644 --- a/docs/functions/server.filterDefaultIdTokenClaims.html +++ b/docs/functions/server.filterDefaultIdTokenClaims.html @@ -1,4 +1,4 @@ -filterDefaultIdTokenClaims | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Function filterDefaultIdTokenClaims

                                                                                                                                                                                    • Filters the claims to only include those that are considered default.

                                                                                                                                                                                      +filterDefaultIdTokenClaims | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Function filterDefaultIdTokenClaims

                                                                                                                                                                                        • Filters the claims to only include those that are considered default.

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • claims: { [key: string]: any }

                                                                                                                                                                                            The claims to filter.

                                                                                                                                                                                          Returns User

                                                                                                                                                                                          The filtered claims containing only default ID token claims.

                                                                                                                                                                                          -
                                                                                                                                                                                        +
                                                                                                                                                                                      diff --git a/docs/functions/server.generateDpopKeyPair.html b/docs/functions/server.generateDpopKeyPair.html new file mode 100644 index 000000000..f7d986bc8 --- /dev/null +++ b/docs/functions/server.generateDpopKeyPair.html @@ -0,0 +1,10 @@ +generateDpopKeyPair | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Function generateDpopKeyPair

                                                                                                                                                                                        • Generates a new ES256 key pair for DPoP (Demonstrating Proof-of-Possession) operations.

                                                                                                                                                                                          +

                                                                                                                                                                                          This function creates a cryptographically secure ES256 key pair suitable for DPoP proof +generation. The generated keys use the P-256 elliptic curve with SHA-256 hashing, +which is the required algorithm for DPoP as specified in RFC 9449.

                                                                                                                                                                                          +

                                                                                                                                                                                          Returns Promise<DpopKeyPair>

                                                                                                                                                                                          Promise that resolves to a DpopKeyPair containing the private and public keys

                                                                                                                                                                                          +
                                                                                                                                                                                          import { generateDpopKeyPair } from "@auth0/nextjs-auth0/server";

                                                                                                                                                                                          const keyPair = await generateDpopKeyPair();

                                                                                                                                                                                          const auth0 = new Auth0Client({
                                                                                                                                                                                          useDPoP: true,
                                                                                                                                                                                          dpopKeyPair: keyPair
                                                                                                                                                                                          }); +
                                                                                                                                                                                          + +
                                                                                                                                                                                        diff --git a/docs/functions/testing.generateSessionCookie.html b/docs/functions/testing.generateSessionCookie.html index 8b5264788..82ca58bb0 100644 --- a/docs/functions/testing.generateSessionCookie.html +++ b/docs/functions/testing.generateSessionCookie.html @@ -1 +1 @@ -generateSessionCookie | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Function generateSessionCookie

                                                                                                                                                                                          +generateSessionCookie | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Function generateSessionCookie

                                                                                                                                                                                            diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 191bbd2eb..0fc887b5a 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              +@auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                diff --git a/docs/index.html b/docs/index.html index 4711ef7df..be037f3ad 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.0

                                                                                                                                                                                                  Auth0 Next.js SDK Banner

                                                                                                                                                                                                  +@auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                    +

                                                                                                                                                                                                    diff --git a/docs/interfaces/client.WithPageAuthRequiredOptions.html b/docs/interfaces/client.WithPageAuthRequiredOptions.html index 1bec0ccdd..c79c247c3 100644 --- a/docs/interfaces/client.WithPageAuthRequiredOptions.html +++ b/docs/interfaces/client.WithPageAuthRequiredOptions.html @@ -1,17 +1,17 @@ -WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface WithPageAuthRequiredOptions

                                                                                                                                                                                                      Options to customize the withPageAuthRequired higher order component.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      interface WithPageAuthRequiredOptions {
                                                                                                                                                                                                          onError?: (error: Error) => Element;
                                                                                                                                                                                                          onRedirecting?: () => Element;
                                                                                                                                                                                                          returnTo?: string;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      onError? +WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface WithPageAuthRequiredOptions

                                                                                                                                                                                                        Options to customize the withPageAuthRequired higher order component.

                                                                                                                                                                                                        +
                                                                                                                                                                                                        interface WithPageAuthRequiredOptions {
                                                                                                                                                                                                            onError?: (error: Error) => Element;
                                                                                                                                                                                                            onRedirecting?: () => Element;
                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        onError?: (error: Error) => Element
                                                                                                                                                                                                        withPageAuthRequired(Profile, {
                                                                                                                                                                                                        onError: error => <div>Error: {error.message}</div>
                                                                                                                                                                                                        });

                                                                                                                                                                                                        Render a fallback in case of error fetching the user from the profile API route.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        onRedirecting?: () => Element
                                                                                                                                                                                                        withPageAuthRequired(Profile, {
                                                                                                                                                                                                        onRedirecting: () => <div>Redirecting...</div>
                                                                                                                                                                                                        }); +
                                                                                                                                                                                                        onRedirecting?: () => Element
                                                                                                                                                                                                        withPageAuthRequired(Profile, {
                                                                                                                                                                                                        onRedirecting: () => <div>Redirecting...</div>
                                                                                                                                                                                                        });

                                                                                                                                                                                                        Render a message to show that the user is being redirected.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        returnTo?: string
                                                                                                                                                                                                        withPageAuthRequired(Profile, {
                                                                                                                                                                                                        returnTo: '/profile'
                                                                                                                                                                                                        }); +
                                                                                                                                                                                                        returnTo?: string
                                                                                                                                                                                                        withPageAuthRequired(Profile, {
                                                                                                                                                                                                        returnTo: '/profile'
                                                                                                                                                                                                        });

                                                                                                                                                                                                        Add a path to return the user to after login.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        +
                                                                                                                                                                                                        diff --git a/docs/interfaces/errors.MfaApiErrorResponse.html b/docs/interfaces/errors.MfaApiErrorResponse.html index 021219c49..08d02f21a 100644 --- a/docs/interfaces/errors.MfaApiErrorResponse.html +++ b/docs/interfaces/errors.MfaApiErrorResponse.html @@ -1,6 +1,6 @@ -MfaApiErrorResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface MfaApiErrorResponse

                                                                                                                                                                                                          Interface for Auth0 MFA API error responses. +MfaApiErrorResponse | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface MfaApiErrorResponse

                                                                                                                                                                                                            Interface for Auth0 MFA API error responses. All MFA errors from Auth0 follow this shape (snake_case).

                                                                                                                                                                                                            -
                                                                                                                                                                                                            interface MfaApiErrorResponse {
                                                                                                                                                                                                                error: string;
                                                                                                                                                                                                                error_description: string;
                                                                                                                                                                                                                message?: string;
                                                                                                                                                                                                            }
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            interface MfaApiErrorResponse {
                                                                                                                                                                                                                error: string;
                                                                                                                                                                                                                error_description: string;
                                                                                                                                                                                                                message?: string;
                                                                                                                                                                                                            }
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            error: string
                                                                                                                                                                                                            error_description: string
                                                                                                                                                                                                            message?: string
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            error: string
                                                                                                                                                                                                            error_description: string
                                                                                                                                                                                                            message?: string
                                                                                                                                                                                                            diff --git a/docs/interfaces/server.MfaRequirements.html b/docs/interfaces/server.MfaRequirements.html index f4bd8064a..25a928a21 100644 --- a/docs/interfaces/server.MfaRequirements.html +++ b/docs/interfaces/server.MfaRequirements.html @@ -1,8 +1,8 @@ -MfaRequirements | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface MfaRequirements

                                                                                                                                                                                                              MFA requirements from an mfa_required error response. +MfaRequirements | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface MfaRequirements

                                                                                                                                                                                                                MFA requirements from an mfa_required error response. Indicates which MFA methods are available for the user. Matches Auth0 API response shape and auth0-spa-js type.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                interface MfaRequirements {
                                                                                                                                                                                                                    challenge?: { type: string }[];
                                                                                                                                                                                                                    enroll?: { type: string }[];
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                interface MfaRequirements {
                                                                                                                                                                                                                    challenge?: { type: string }[];
                                                                                                                                                                                                                    enroll?: { type: string }[];
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                challenge?: { type: string }[]

                                                                                                                                                                                                                Available challenge types (existing authenticators)

                                                                                                                                                                                                                -
                                                                                                                                                                                                                enroll?: { type: string }[]

                                                                                                                                                                                                                Required enrollment types (user needs to enroll new authenticator)

                                                                                                                                                                                                                -
                                                                                                                                                                                                                +
                                                                                                                                                                                                                enroll?: { type: string }[]

                                                                                                                                                                                                                Required enrollment types (user needs to enroll new authenticator)

                                                                                                                                                                                                                +
                                                                                                                                                                                                                diff --git a/docs/interfaces/types.AccessTokenForConnectionOptions.html b/docs/interfaces/types.AccessTokenForConnectionOptions.html index 97e81e78c..d349a0e75 100644 --- a/docs/interfaces/types.AccessTokenForConnectionOptions.html +++ b/docs/interfaces/types.AccessTokenForConnectionOptions.html @@ -1,14 +1,14 @@ -AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface AccessTokenForConnectionOptions

                                                                                                                                                                                                                  Options for retrieving a connection access token.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  interface AccessTokenForConnectionOptions {
                                                                                                                                                                                                                      connection: string;
                                                                                                                                                                                                                      login_hint?: string;
                                                                                                                                                                                                                      subject_token_type?: SUBJECT_TOKEN_TYPES;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  connection +AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface AccessTokenForConnectionOptions

                                                                                                                                                                                                                    Options for retrieving a connection access token.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    interface AccessTokenForConnectionOptions {
                                                                                                                                                                                                                        connection: string;
                                                                                                                                                                                                                        login_hint?: string;
                                                                                                                                                                                                                        subject_token_type?: SUBJECT_TOKEN_TYPES;
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    connection: string

                                                                                                                                                                                                                    The connection name for while you want to retrieve the access token.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    login_hint?: string

                                                                                                                                                                                                                    An optional login hint to pass to the authorization server.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    subject_token_type?: SUBJECT_TOKEN_TYPES

                                                                                                                                                                                                                    The type of token that is being exchanged.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    login_hint?: string

                                                                                                                                                                                                                    An optional login hint to pass to the authorization server.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    subject_token_type?: SUBJECT_TOKEN_TYPES

                                                                                                                                                                                                                    The type of token that is being exchanged.

                                                                                                                                                                                                                    Uses the SUBJECT_TOKEN_TYPES enum with the following allowed values:

                                                                                                                                                                                                                    • SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"
                                                                                                                                                                                                                    • SUBJECT_TYPE_ACCESS_TOKEN: "urn:ietf:params:oauth:token-type:access_token"

                                                                                                                                                                                                                    Defaults to SUBJECT_TYPE_REFRESH_TOKEN.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.AccessTokenSet.html b/docs/interfaces/types.AccessTokenSet.html index a91198d7a..309e346cb 100644 --- a/docs/interfaces/types.AccessTokenSet.html +++ b/docs/interfaces/types.AccessTokenSet.html @@ -1,7 +1,7 @@ -AccessTokenSet | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface AccessTokenSet

                                                                                                                                                                                                                      interface AccessTokenSet {
                                                                                                                                                                                                                          accessToken: string;
                                                                                                                                                                                                                          audience: string;
                                                                                                                                                                                                                          expiresAt: number;
                                                                                                                                                                                                                          requestedScope?: string;
                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                          token_type?: string;
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      accessToken +AccessTokenSet | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface AccessTokenSet

                                                                                                                                                                                                                        interface AccessTokenSet {
                                                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                                                            audience: string;
                                                                                                                                                                                                                            expiresAt: number;
                                                                                                                                                                                                                            requestedScope?: string;
                                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                                            token_type?: string;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        accessToken: string
                                                                                                                                                                                                                        audience: string
                                                                                                                                                                                                                        expiresAt: number
                                                                                                                                                                                                                        requestedScope?: string
                                                                                                                                                                                                                        scope?: string
                                                                                                                                                                                                                        token_type?: string
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        accessToken: string
                                                                                                                                                                                                                        audience: string
                                                                                                                                                                                                                        expiresAt: number
                                                                                                                                                                                                                        requestedScope?: string
                                                                                                                                                                                                                        scope?: string
                                                                                                                                                                                                                        token_type?: string
                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.Auth0ClientOptions.html b/docs/interfaces/types.Auth0ClientOptions.html index a80c5825a..7d1a228c1 100644 --- a/docs/interfaces/types.Auth0ClientOptions.html +++ b/docs/interfaces/types.Auth0ClientOptions.html @@ -1,4 +1,4 @@ -Auth0ClientOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface Auth0ClientOptions

                                                                                                                                                                                                                          interface Auth0ClientOptions {
                                                                                                                                                                                                                              allowInsecureRequests?: boolean;
                                                                                                                                                                                                                              appBaseUrl?: string | string[];
                                                                                                                                                                                                                              authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                              beforeSessionSaved?: BeforeSessionSavedHook;
                                                                                                                                                                                                                              clientAssertionSigningAlg?: string;
                                                                                                                                                                                                                              clientAssertionSigningKey?: string | CryptoKey;
                                                                                                                                                                                                                              clientId?: string;
                                                                                                                                                                                                                              clientSecret?: string;
                                                                                                                                                                                                                              discoveryCache?: DiscoveryCacheOptions;
                                                                                                                                                                                                                              domain?: string | DomainResolver;
                                                                                                                                                                                                                              dpopKeyPair?: DpopKeyPair;
                                                                                                                                                                                                                              dpopOptions?: DpopOptions;
                                                                                                                                                                                                                              enableAccessTokenEndpoint?: boolean;
                                                                                                                                                                                                                              enableConnectAccountEndpoint?: boolean;
                                                                                                                                                                                                                              enableParallelTransactions?: boolean;
                                                                                                                                                                                                                              enableTelemetry?: boolean;
                                                                                                                                                                                                                              httpTimeout?: number;
                                                                                                                                                                                                                              includeIdTokenHintInOIDCLogoutUrl?: boolean;
                                                                                                                                                                                                                              logoutStrategy?: LogoutStrategy;
                                                                                                                                                                                                                              mfaTokenTtl?: number;
                                                                                                                                                                                                                              noContentProfileResponseWhenUnauthenticated?: boolean;
                                                                                                                                                                                                                              onCallback?: OnCallbackHook;
                                                                                                                                                                                                                              pushedAuthorizationRequests?: boolean;
                                                                                                                                                                                                                              routes?: Partial<
                                                                                                                                                                                                                                  Pick<
                                                                                                                                                                                                                                      Routes,
                                                                                                                                                                                                                                      "login"
                                                                                                                                                                                                                                      | "callback"
                                                                                                                                                                                                                                      | "logout"
                                                                                                                                                                                                                                      | "backChannelLogout"
                                                                                                                                                                                                                                      | "connectAccount",
                                                                                                                                                                                                                                  >,
                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                              secret?: string;
                                                                                                                                                                                                                              session?: SessionConfiguration;
                                                                                                                                                                                                                              sessionStore?: SessionDataStore;
                                                                                                                                                                                                                              signInReturnToPath?: string;
                                                                                                                                                                                                                              tokenRefreshBuffer?: number;
                                                                                                                                                                                                                              transactionCookie?: TransactionCookieOptions;
                                                                                                                                                                                                                              useDPoP?: boolean;
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          allowInsecureRequests? +Auth0ClientOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface Auth0ClientOptions

                                                                                                                                                                                                                            interface Auth0ClientOptions {
                                                                                                                                                                                                                                allowInsecureRequests?: boolean;
                                                                                                                                                                                                                                appBaseUrl?: string | string[];
                                                                                                                                                                                                                                authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                beforeSessionSaved?: BeforeSessionSavedHook;
                                                                                                                                                                                                                                clientAssertionSigningAlg?: string;
                                                                                                                                                                                                                                clientAssertionSigningKey?: string | CryptoKey;
                                                                                                                                                                                                                                clientId?: string;
                                                                                                                                                                                                                                clientSecret?: string;
                                                                                                                                                                                                                                discoveryCache?: DiscoveryCacheOptions;
                                                                                                                                                                                                                                domain?: string | DomainResolver;
                                                                                                                                                                                                                                dpopKeyPair?: DpopKeyPair;
                                                                                                                                                                                                                                dpopOptions?: DpopOptions;
                                                                                                                                                                                                                                enableAccessTokenEndpoint?: boolean;
                                                                                                                                                                                                                                enableConnectAccountEndpoint?: boolean;
                                                                                                                                                                                                                                enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                enableTelemetry?: boolean;
                                                                                                                                                                                                                                httpTimeout?: number;
                                                                                                                                                                                                                                includeIdTokenHintInOIDCLogoutUrl?: boolean;
                                                                                                                                                                                                                                logoutStrategy?: LogoutStrategy;
                                                                                                                                                                                                                                mfaTokenTtl?: number;
                                                                                                                                                                                                                                noContentProfileResponseWhenUnauthenticated?: boolean;
                                                                                                                                                                                                                                onCallback?: OnCallbackHook;
                                                                                                                                                                                                                                pushedAuthorizationRequests?: boolean;
                                                                                                                                                                                                                                routes?: Partial<
                                                                                                                                                                                                                                    Pick<
                                                                                                                                                                                                                                        Routes,
                                                                                                                                                                                                                                        "login"
                                                                                                                                                                                                                                        | "callback"
                                                                                                                                                                                                                                        | "logout"
                                                                                                                                                                                                                                        | "backChannelLogout"
                                                                                                                                                                                                                                        | "connectAccount",
                                                                                                                                                                                                                                    >,
                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                secret?: string;
                                                                                                                                                                                                                                session?: SessionConfiguration;
                                                                                                                                                                                                                                sessionStore?: SessionDataStore;
                                                                                                                                                                                                                                signInReturnToPath?: string;
                                                                                                                                                                                                                                tokenRefreshBuffer?: number;
                                                                                                                                                                                                                                transactionCookie?: TransactionCookieOptions;
                                                                                                                                                                                                                                useDPoP?: boolean;
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            allowInsecureRequests?: boolean

                                                                                                                                                                                                                            Allow insecure requests to be made to the authorization server. This can be useful when testing with a mock OIDC provider that does not support TLS, locally. This option can only be used when NODE_ENV is not set to production.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            appBaseUrl?: string | string[]

                                                                                                                                                                                                                            The URL of your application (e.g.: http://localhost:3000).

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            appBaseUrl?: string | string[]

                                                                                                                                                                                                                            The URL of your application (e.g.: http://localhost:3000).

                                                                                                                                                                                                                            Can be a single URL string, or an array of allowed base URLs. When an array is provided, the SDK validates the incoming request origin against the list and uses the matching entry (allow-list mode). This is useful for multi-domain or preview @@ -40,27 +40,27 @@

                                                                                                                                                                                                                            If it's not specified, it will be loaded from the APP_BASE_URL environment variable. Multiple origins can be provided as a comma-separated string (e.g. https://app.example.com,https://myapp.vercel.app). If neither is provided, the SDK will infer it from the request host at runtime.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            authorizationParameters?: AuthorizationParameters

                                                                                                                                                                                                                            Additional parameters to send to the /authorize endpoint.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            beforeSessionSaved?: BeforeSessionSavedHook

                                                                                                                                                                                                                            A method to manipulate the session before persisting it.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            authorizationParameters?: AuthorizationParameters

                                                                                                                                                                                                                            Additional parameters to send to the /authorize endpoint.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            beforeSessionSaved?: BeforeSessionSavedHook

                                                                                                                                                                                                                            A method to manipulate the session before persisting it.

                                                                                                                                                                                                                            See beforeSessionSaved for additional details

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            clientAssertionSigningAlg?: string

                                                                                                                                                                                                                            The algorithm used to sign the client assertion JWT. +

                                                                                                                                                                                                                            clientAssertionSigningAlg?: string

                                                                                                                                                                                                                            The algorithm used to sign the client assertion JWT. Uses one of token_endpoint_auth_signing_alg_values_supported if not specified. If the Authorization Server discovery document does not list token_endpoint_auth_signing_alg_values_supported this property will be required.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            clientAssertionSigningKey?: string | CryptoKey

                                                                                                                                                                                                                            Private key for use with private_key_jwt clients. +

                                                                                                                                                                                                                            clientAssertionSigningKey?: string | CryptoKey

                                                                                                                                                                                                                            Private key for use with private_key_jwt clients. This should be a string that is the contents of a PEM file or a CryptoKey.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            clientId?: string

                                                                                                                                                                                                                            The Auth0 client ID.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            clientId?: string

                                                                                                                                                                                                                            The Auth0 client ID.

                                                                                                                                                                                                                            If it's not specified, it will be loaded from the AUTH0_CLIENT_ID environment variable.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            clientSecret?: string

                                                                                                                                                                                                                            The Auth0 client secret.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            clientSecret?: string

                                                                                                                                                                                                                            The Auth0 client secret.

                                                                                                                                                                                                                            If it's not specified, it will be loaded from the AUTH0_CLIENT_SECRET environment variable.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            discoveryCache?: DiscoveryCacheOptions

                                                                                                                                                                                                                            Configuration for the OIDC discovery metadata cache. +

                                                                                                                                                                                                                            discoveryCache?: DiscoveryCacheOptions

                                                                                                                                                                                                                            Configuration for the OIDC discovery metadata cache. Controls TTL and maximum cached issuers for MCD resolver mode. Also applies in static mode (single cached entry).

                                                                                                                                                                                                                            domain?: string | DomainResolver

                                                                                                                                                                                                                            The Auth0 domain for the tenant.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            domain?: string | DomainResolver

                                                                                                                                                                                                                            The Auth0 domain for the tenant.

                                                                                                                                                                                                                            • string: Static domain (e.g., "example.us.auth0.com"). Existing behavior preserved.
                                                                                                                                                                                                                            • DomainResolver: Async function resolving domain per-request from headers. @@ -71,7 +71,7 @@
                                                                                                                                                                                                                            • DomainResolver for resolver signature and examples.
                                                                                                                                                                                                                            • MCD Examples
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            dpopKeyPair?: DpopKeyPair

                                                                                                                                                                                                                            ES256 key pair for DPoP proof generation.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            dpopKeyPair?: DpopKeyPair

                                                                                                                                                                                                                            ES256 key pair for DPoP proof generation.

                                                                                                                                                                                                                            If not provided when useDPoP is true, the SDK will attempt to load keys from environment variables AUTH0_DPOP_PUBLIC_KEY and AUTH0_DPOP_PRIVATE_KEY. Keys must be in PEM format and use the P-256 elliptic curve.

                                                                                                                                                                                                                            @@ -85,7 +85,7 @@
                                                                                                                                                                                                                          • DpopKeyPair for the key pair interface
                                                                                                                                                                                                                          • generateDpopKeyPair for generating new key pairs
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            dpopOptions?: DpopOptions

                                                                                                                                                                                                                            Configuration options for DPoP timing validation and retry behavior.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            dpopOptions?: DpopOptions

                                                                                                                                                                                                                            Configuration options for DPoP timing validation and retry behavior.

                                                                                                                                                                                                                            These options control how the SDK validates DPoP proof timing and handles nonce errors. Proper configuration is important for both security and reliability.

                                                                                                                                                                                                                            const auth0 = new Auth0Client({
                                                                                                                                                                                                                            useDPoP: true,
                                                                                                                                                                                                                            dpopOptions: {
                                                                                                                                                                                                                            clockTolerance: 60, // Allow 60 seconds clock difference
                                                                                                                                                                                                                            clockSkew: 0, // No clock adjustment needed
                                                                                                                                                                                                                            retry: {
                                                                                                                                                                                                                            delay: 200, // 200ms delay before retry
                                                                                                                                                                                                                            jitter: true // Add randomness to prevent thundering herd
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            }); @@ -95,17 +95,17 @@

                                                                                                                                                                                                                            DpopOptions for detailed option descriptions

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            enableAccessTokenEndpoint?: boolean

                                                                                                                                                                                                                            Boolean value to enable the /auth/access-token endpoint for use in the client app.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            enableAccessTokenEndpoint?: boolean

                                                                                                                                                                                                                            Boolean value to enable the /auth/access-token endpoint for use in the client app.

                                                                                                                                                                                                                            Defaults to true.

                                                                                                                                                                                                                            NOTE: Set this to false if your client does not need to directly interact with resource servers (Token Mediating Backend). This will be false for most apps.

                                                                                                                                                                                                                            A security best practice is to disable this to avoid exposing access tokens to the client app.

                                                                                                                                                                                                                            See: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-browser-based-apps#name-token-mediating-backend

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            enableConnectAccountEndpoint?: boolean

                                                                                                                                                                                                                            If true, the /auth/connect endpoint will be mounted to enable users to connect additional accounts.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            enableParallelTransactions?: boolean
                                                                                                                                                                                                                            enableTelemetry?: boolean

                                                                                                                                                                                                                            Boolean value to opt-out of sending the library name and version to your authorization server +

                                                                                                                                                                                                                            enableConnectAccountEndpoint?: boolean

                                                                                                                                                                                                                            If true, the /auth/connect endpoint will be mounted to enable users to connect additional accounts.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            enableParallelTransactions?: boolean
                                                                                                                                                                                                                            enableTelemetry?: boolean

                                                                                                                                                                                                                            Boolean value to opt-out of sending the library name and version to your authorization server via the Auth0-Client header. Defaults to true.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            httpTimeout?: number

                                                                                                                                                                                                                            Integer value for the HTTP timeout in milliseconds for authentication requests. +

                                                                                                                                                                                                                            httpTimeout?: number

                                                                                                                                                                                                                            Integer value for the HTTP timeout in milliseconds for authentication requests. Defaults to 5000 ms.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            includeIdTokenHintInOIDCLogoutUrl?: boolean

                                                                                                                                                                                                                            Configure whether to include id_token_hint in OIDC logout URLs.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            includeIdTokenHintInOIDCLogoutUrl?: boolean

                                                                                                                                                                                                                            Configure whether to include id_token_hint in OIDC logout URLs.

                                                                                                                                                                                                                            Recommended (default): Set to true to include id_token_hint parameter. Auth0 recommends using id_token_hint for secure logout as per the OIDC specification.

                                                                                                                                                                                                                            @@ -116,40 +116,40 @@
                                                                                                                                                                                                                            true (recommended and backwards compatible)
                                                                                                                                                                                                                             
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            logoutStrategy?: LogoutStrategy

                                                                                                                                                                                                                            Configure the logout strategy to use.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            logoutStrategy?: LogoutStrategy

                                                                                                                                                                                                                            Configure the logout strategy to use.

                                                                                                                                                                                                                            • 'auto' (default): Attempts OIDC RP-Initiated Logout first, falls back to /v2/logout if not supported
                                                                                                                                                                                                                            • 'oidc': Always uses OIDC RP-Initiated Logout (requires RP-Initiated Logout to be enabled)
                                                                                                                                                                                                                            • 'v2': Always uses the Auth0 /v2/logout endpoint (supports wildcards in allowed logout URLs)
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            mfaTokenTtl?: number

                                                                                                                                                                                                                            MFA context TTL in seconds. Controls how long encrypted mfa_token remains valid. +

                                                                                                                                                                                                                            mfaTokenTtl?: number

                                                                                                                                                                                                                            MFA context TTL in seconds. Controls how long encrypted mfa_token remains valid. Default: 300 (5 minutes, matching Auth0's mfa_token expiration)

                                                                                                                                                                                                                            Can also be set via AUTH0_MFA_TOKEN_TTL environment variable.

                                                                                                                                                                                                                            const auth0 = new Auth0Client({
                                                                                                                                                                                                                            mfaTokenTtl: 600 // 10 minutes
                                                                                                                                                                                                                            });
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            noContentProfileResponseWhenUnauthenticated?: boolean

                                                                                                                                                                                                                            If true, the profile endpoint will return a 204 No Content response when the user is not authenticated +

                                                                                                                                                                                                                            noContentProfileResponseWhenUnauthenticated?: boolean

                                                                                                                                                                                                                            If true, the profile endpoint will return a 204 No Content response when the user is not authenticated instead of returning a 401 Unauthorized response.

                                                                                                                                                                                                                            Defaults to false.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            onCallback?: OnCallbackHook

                                                                                                                                                                                                                            A method to handle errors or manage redirects after attempting to authenticate.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            onCallback?: OnCallbackHook

                                                                                                                                                                                                                            A method to handle errors or manage redirects after attempting to authenticate.

                                                                                                                                                                                                                            See onCallback for additional details

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            pushedAuthorizationRequests?: boolean

                                                                                                                                                                                                                            If enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            routes?: Partial<
                                                                                                                                                                                                                                Pick<
                                                                                                                                                                                                                                    Routes,
                                                                                                                                                                                                                                    "login"
                                                                                                                                                                                                                                    | "callback"
                                                                                                                                                                                                                                    | "logout"
                                                                                                                                                                                                                                    | "backChannelLogout"
                                                                                                                                                                                                                                    | "connectAccount",
                                                                                                                                                                                                                                >,
                                                                                                                                                                                                                            >

                                                                                                                                                                                                                            Configure the paths for the authentication routes.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            pushedAuthorizationRequests?: boolean

                                                                                                                                                                                                                            If enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            routes?: Partial<
                                                                                                                                                                                                                                Pick<
                                                                                                                                                                                                                                    Routes,
                                                                                                                                                                                                                                    "login"
                                                                                                                                                                                                                                    | "callback"
                                                                                                                                                                                                                                    | "logout"
                                                                                                                                                                                                                                    | "backChannelLogout"
                                                                                                                                                                                                                                    | "connectAccount",
                                                                                                                                                                                                                                >,
                                                                                                                                                                                                                            >

                                                                                                                                                                                                                            Configure the paths for the authentication routes.

                                                                                                                                                                                                                            See Custom routes for additional details.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            secret?: string

                                                                                                                                                                                                                            A 32-byte, hex-encoded secret used for encrypting cookies.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            secret?: string

                                                                                                                                                                                                                            A 32-byte, hex-encoded secret used for encrypting cookies.

                                                                                                                                                                                                                            If it's not specified, it will be loaded from the AUTH0_SECRET environment variable.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Configure the session timeouts and whether to use rolling sessions or not.

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Configure the session timeouts and whether to use rolling sessions or not.

                                                                                                                                                                                                                            See Session configuration for additional details.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            sessionStore?: SessionDataStore

                                                                                                                                                                                                                            A custom session store implementation used to persist sessions to a data store.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            sessionStore?: SessionDataStore

                                                                                                                                                                                                                            A custom session store implementation used to persist sessions to a data store.

                                                                                                                                                                                                                            See Database sessions for additional details.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            signInReturnToPath?: string

                                                                                                                                                                                                                            The path to redirect the user to after successfully authenticating. Defaults to /.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            tokenRefreshBuffer?: number

                                                                                                                                                                                                                            Number of seconds to refresh access tokens early when calling getAccessToken. +

                                                                                                                                                                                                                            signInReturnToPath?: string

                                                                                                                                                                                                                            The path to redirect the user to after successfully authenticating. Defaults to /.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            tokenRefreshBuffer?: number

                                                                                                                                                                                                                            Number of seconds to refresh access tokens early when calling getAccessToken. This is a server-side buffer applied to token expiration checks. For example, with a buffer of 60 seconds, tokens expiring within the next minute will be refreshed proactively when a refresh token is available.

                                                                                                                                                                                                                            Defaults to 0 (no early refresh).

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            transactionCookie?: TransactionCookieOptions

                                                                                                                                                                                                                            Configure the transaction cookie used to store the state of the authentication transaction.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            useDPoP?: boolean

                                                                                                                                                                                                                            Enable DPoP (Demonstrating Proof-of-Possession) for enhanced OAuth 2.0 security.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            transactionCookie?: TransactionCookieOptions

                                                                                                                                                                                                                            Configure the transaction cookie used to store the state of the authentication transaction.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            useDPoP?: boolean

                                                                                                                                                                                                                            Enable DPoP (Demonstrating Proof-of-Possession) for enhanced OAuth 2.0 security.

                                                                                                                                                                                                                            When enabled, the SDK will:

                                                                                                                                                                                                                            • Generate DPoP proofs for token requests and protected resource requests
                                                                                                                                                                                                                            • @@ -169,4 +169,4 @@
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.Authenticator.html b/docs/interfaces/types.Authenticator.html index c33596ab3..3c78bb665 100644 --- a/docs/interfaces/types.Authenticator.html +++ b/docs/interfaces/types.Authenticator.html @@ -1,9 +1,9 @@ -Authenticator | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface Authenticator

                                                                                                                                                                                                                              MFA authenticator (enrolled factor). +Authenticator | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface Authenticator

                                                                                                                                                                                                                                MFA authenticator (enrolled factor). Uses camelCase for SDK-facing interface.

                                                                                                                                                                                                                                const authenticators = await mfa.getAuthenticators({ mfaToken });

                                                                                                                                                                                                                                const otpAuth = authenticators.find(a => a.authenticatorType === 'otp');
                                                                                                                                                                                                                                const smsAuth = authenticators.find(a => a.oobChannel === 'sms');
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                interface Authenticator {
                                                                                                                                                                                                                                    active: boolean;
                                                                                                                                                                                                                                    authenticatorType: string;
                                                                                                                                                                                                                                    createdAt?: string;
                                                                                                                                                                                                                                    id: string;
                                                                                                                                                                                                                                    lastAuthenticatedAt?: string;
                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                    oobChannel?: string;
                                                                                                                                                                                                                                    phoneNumber?: string;
                                                                                                                                                                                                                                    type?: string;
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                interface Authenticator {
                                                                                                                                                                                                                                    active: boolean;
                                                                                                                                                                                                                                    authenticatorType: string;
                                                                                                                                                                                                                                    createdAt?: string;
                                                                                                                                                                                                                                    id: string;
                                                                                                                                                                                                                                    lastAuthenticatedAt?: string;
                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                    oobChannel?: string;
                                                                                                                                                                                                                                    phoneNumber?: string;
                                                                                                                                                                                                                                    type?: string;
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                active: boolean

                                                                                                                                                                                                                                Whether authenticator is active

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                authenticatorType: string

                                                                                                                                                                                                                                Authenticator type (primary field mapped from authenticator_type)

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                createdAt?: string

                                                                                                                                                                                                                                ISO 8601 timestamp of creation

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                id: string

                                                                                                                                                                                                                                Authenticator ID

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                lastAuthenticatedAt?: string

                                                                                                                                                                                                                                ISO 8601 timestamp of last authentication

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                name?: string

                                                                                                                                                                                                                                Authenticator name (user-defined or default)

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                oobChannel?: string

                                                                                                                                                                                                                                OOB channel (sms, voice)

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                phoneNumber?: string

                                                                                                                                                                                                                                Phone number for OOB (masked)

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                type?: string

                                                                                                                                                                                                                                Direct type value (optional, feature-flagged field from Auth0 API)

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                authenticatorType: string

                                                                                                                                                                                                                                Authenticator type (primary field mapped from authenticator_type)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                createdAt?: string

                                                                                                                                                                                                                                ISO 8601 timestamp of creation

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                id: string

                                                                                                                                                                                                                                Authenticator ID

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                lastAuthenticatedAt?: string

                                                                                                                                                                                                                                ISO 8601 timestamp of last authentication

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                name?: string

                                                                                                                                                                                                                                Authenticator name (user-defined or default)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                oobChannel?: string

                                                                                                                                                                                                                                OOB channel (sms, voice)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                phoneNumber?: string

                                                                                                                                                                                                                                Phone number for OOB (masked)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                type?: string

                                                                                                                                                                                                                                Direct type value (optional, feature-flagged field from Auth0 API)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.AuthorizationDetails.html b/docs/interfaces/types.AuthorizationDetails.html index a9c3651a4..9b6ebdccd 100644 --- a/docs/interfaces/types.AuthorizationDetails.html +++ b/docs/interfaces/types.AuthorizationDetails.html @@ -1,2 +1,2 @@ -AuthorizationDetails | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface AuthorizationDetails

                                                                                                                                                                                                                                  interface AuthorizationDetails {
                                                                                                                                                                                                                                      type: string;
                                                                                                                                                                                                                                      readonly [parameter: string]: unknown;
                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                  • readonly [parameter: string]: unknown
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  type: string
                                                                                                                                                                                                                                  +AuthorizationDetails | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface AuthorizationDetails

                                                                                                                                                                                                                                    interface AuthorizationDetails {
                                                                                                                                                                                                                                        type: string;
                                                                                                                                                                                                                                        readonly [parameter: string]: unknown;
                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                    • readonly [parameter: string]: unknown
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    type: string
                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.AuthorizationParameters.html b/docs/interfaces/types.AuthorizationParameters.html index 884f3bfdd..683fb7592 100644 --- a/docs/interfaces/types.AuthorizationParameters.html +++ b/docs/interfaces/types.AuthorizationParameters.html @@ -1,15 +1,15 @@ -AuthorizationParameters | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface AuthorizationParameters

                                                                                                                                                                                                                                      interface AuthorizationParameters {
                                                                                                                                                                                                                                          audience?: string | null;
                                                                                                                                                                                                                                          max_age?: number;
                                                                                                                                                                                                                                          organization?: string;
                                                                                                                                                                                                                                          redirect_uri?: string | null;
                                                                                                                                                                                                                                          scope?: string | { [key: string]: string } | null;
                                                                                                                                                                                                                                          [key: string]: unknown;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                      • [key: string]: unknown

                                                                                                                                                                                                                                        Additional authorization parameters.

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      audience? +AuthorizationParameters | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface AuthorizationParameters

                                                                                                                                                                                                                                        interface AuthorizationParameters {
                                                                                                                                                                                                                                            audience?: string | null;
                                                                                                                                                                                                                                            max_age?: number;
                                                                                                                                                                                                                                            organization?: string;
                                                                                                                                                                                                                                            redirect_uri?: string | null;
                                                                                                                                                                                                                                            scope?: string | { [key: string]: string } | null;
                                                                                                                                                                                                                                            [key: string]: unknown;
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                        • [key: string]: unknown

                                                                                                                                                                                                                                          Additional authorization parameters.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        audience?: string | null

                                                                                                                                                                                                                                        The unique identifier of the target API you want to access.

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        max_age?: number

                                                                                                                                                                                                                                        The maximum amount of time, in seconds, after which a user must reauthenticate.

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        organization?: string

                                                                                                                                                                                                                                        The unique identifier of the organization that the user should be logged into. +

                                                                                                                                                                                                                                        max_age?: number

                                                                                                                                                                                                                                        The maximum amount of time, in seconds, after which a user must reauthenticate.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        organization?: string

                                                                                                                                                                                                                                        The unique identifier of the organization that the user should be logged into. When specified, the user will be prompted to log in to this specific organization. The organization ID will be included in the user's session after successful authentication.

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        redirect_uri?: string | null

                                                                                                                                                                                                                                        The URL to which the authorization server will redirect the user after granting authorization.

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        scope?: string | { [key: string]: string } | null

                                                                                                                                                                                                                                        The scope of the access request, expressed as a list of space-delimited, case-sensitive strings. +

                                                                                                                                                                                                                                        redirect_uri?: string | null

                                                                                                                                                                                                                                        The URL to which the authorization server will redirect the user after granting authorization.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        scope?: string | { [key: string]: string } | null

                                                                                                                                                                                                                                        The scope of the access request, expressed as a list of space-delimited, case-sensitive strings. Defaults to "openid profile email offline_access".

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.BackchannelAuthenticationOptions.html b/docs/interfaces/types.BackchannelAuthenticationOptions.html index 4890202cf..574c77a96 100644 --- a/docs/interfaces/types.BackchannelAuthenticationOptions.html +++ b/docs/interfaces/types.BackchannelAuthenticationOptions.html @@ -1,14 +1,14 @@ -BackchannelAuthenticationOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface BackchannelAuthenticationOptions

                                                                                                                                                                                                                                          interface BackchannelAuthenticationOptions {
                                                                                                                                                                                                                                              authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                              bindingMessage: string;
                                                                                                                                                                                                                                              loginHint: { sub: string };
                                                                                                                                                                                                                                              requestedExpiry?: number;
                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          authorizationDetails? +BackchannelAuthenticationOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface BackchannelAuthenticationOptions

                                                                                                                                                                                                                                            interface BackchannelAuthenticationOptions {
                                                                                                                                                                                                                                                authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                bindingMessage: string;
                                                                                                                                                                                                                                                loginHint: { sub: string };
                                                                                                                                                                                                                                                requestedExpiry?: number;
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            authorizationDetails?: AuthorizationDetails[]

                                                                                                                                                                                                                                            Optional authorization details to use Rich Authorization Requests (RAR).

                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParameters

                                                                                                                                                                                                                                            Authorization Parameters to be sent with the authorization request.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            bindingMessage: string

                                                                                                                                                                                                                                            Human-readable message to be displayed at the consumption device and authentication device. +

                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParameters

                                                                                                                                                                                                                                            Authorization Parameters to be sent with the authorization request.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            bindingMessage: string

                                                                                                                                                                                                                                            Human-readable message to be displayed at the consumption device and authentication device. This allows the user to ensure the transaction initiated by the consumption device is the same that triggers the action on the authentication device.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            loginHint: { sub: string }

                                                                                                                                                                                                                                            The login hint to inform which user to use.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            loginHint: { sub: string }

                                                                                                                                                                                                                                            The login hint to inform which user to use.

                                                                                                                                                                                                                                            Type Declaration

                                                                                                                                                                                                                                            • sub: string

                                                                                                                                                                                                                                              The sub claim of the user that is trying to login using Client-Initiated Backchannel Authentication, and to which a push notification to authorize the login will be sent.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                            requestedExpiry?: number

                                                                                                                                                                                                                                            Set a custom expiry time for the CIBA flow in seconds. Defaults to 300 seconds (5 minutes) if not set.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            requestedExpiry?: number

                                                                                                                                                                                                                                            Set a custom expiry time for the CIBA flow in seconds. Defaults to 300 seconds (5 minutes) if not set.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.BackchannelAuthenticationResponse.html b/docs/interfaces/types.BackchannelAuthenticationResponse.html index 5b4fbb331..93da46931 100644 --- a/docs/interfaces/types.BackchannelAuthenticationResponse.html +++ b/docs/interfaces/types.BackchannelAuthenticationResponse.html @@ -1,4 +1,4 @@ -BackchannelAuthenticationResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface BackchannelAuthenticationResponse

                                                                                                                                                                                                                                              interface BackchannelAuthenticationResponse {
                                                                                                                                                                                                                                                  authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                  idTokenClaims?: { [key: string]: any };
                                                                                                                                                                                                                                                  tokenSet: TokenSet;
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              authorizationDetails? +BackchannelAuthenticationResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface BackchannelAuthenticationResponse

                                                                                                                                                                                                                                                interface BackchannelAuthenticationResponse {
                                                                                                                                                                                                                                                    authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                    idTokenClaims?: { [key: string]: any };
                                                                                                                                                                                                                                                    tokenSet: TokenSet;
                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                authorizationDetails?: AuthorizationDetails[]
                                                                                                                                                                                                                                                idTokenClaims?: { [key: string]: any }
                                                                                                                                                                                                                                                tokenSet: TokenSet
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                authorizationDetails?: AuthorizationDetails[]
                                                                                                                                                                                                                                                idTokenClaims?: { [key: string]: any }
                                                                                                                                                                                                                                                tokenSet: TokenSet
                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.ChallengeResponse.html b/docs/interfaces/types.ChallengeResponse.html index 7051f5701..8516b5ac8 100644 --- a/docs/interfaces/types.ChallengeResponse.html +++ b/docs/interfaces/types.ChallengeResponse.html @@ -1,12 +1,12 @@ -ChallengeResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Interface ChallengeResponse

                                                                                                                                                                                                                                                  MFA challenge response. +ChallengeResponse | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface ChallengeResponse

                                                                                                                                                                                                                                                    MFA challenge response. Uses camelCase for SDK-facing interface.

                                                                                                                                                                                                                                                    const response = await mfa.challenge({
                                                                                                                                                                                                                                                    mfaToken,
                                                                                                                                                                                                                                                    challengeType: 'oob',
                                                                                                                                                                                                                                                    authenticatorId: 'sms|dev_abc123'
                                                                                                                                                                                                                                                    });

                                                                                                                                                                                                                                                    console.log(`Challenge type: ${response.challengeType}`);
                                                                                                                                                                                                                                                    console.log(`OOB code: ${response.oobCode}`);
                                                                                                                                                                                                                                                    console.log(`Binding method: ${response.bindingMethod}`); // 'prompt'
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    interface ChallengeResponse {
                                                                                                                                                                                                                                                        bindingMethod?: string;
                                                                                                                                                                                                                                                        challengeType: string;
                                                                                                                                                                                                                                                        oobCode?: string;
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    interface ChallengeResponse {
                                                                                                                                                                                                                                                        bindingMethod?: string;
                                                                                                                                                                                                                                                        challengeType: string;
                                                                                                                                                                                                                                                        oobCode?: string;
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    bindingMethod?: string

                                                                                                                                                                                                                                                    Binding method (for oob challenges)

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    challengeType: string

                                                                                                                                                                                                                                                    Challenge type (otp, oob)

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    oobCode?: string

                                                                                                                                                                                                                                                    OOB code (for oob challenges)

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    challengeType: string

                                                                                                                                                                                                                                                    Challenge type (otp, oob)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    oobCode?: string

                                                                                                                                                                                                                                                    OOB code (for oob challenges)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.ConnectAccountOptions.html b/docs/interfaces/types.ConnectAccountOptions.html index 50e99e0cd..42f1a7d58 100644 --- a/docs/interfaces/types.ConnectAccountOptions.html +++ b/docs/interfaces/types.ConnectAccountOptions.html @@ -1,11 +1,11 @@ -ConnectAccountOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface ConnectAccountOptions

                                                                                                                                                                                                                                                      Options to initiate a connect account flow using the My Account API.

                                                                                                                                                                                                                                                      +ConnectAccountOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface ConnectAccountOptions

                                                                                                                                                                                                                                                        Options to initiate a connect account flow using the My Account API.

                                                                                                                                                                                                                                                        interface ConnectAccountOptions {
                                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                            connection: string;
                                                                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                                                                            scopes?: string[];
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                        interface ConnectAccountOptions {
                                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                            connection: string;
                                                                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                                                                            scopes?: string[];
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        authorizationParams?: AuthorizationParameters

                                                                                                                                                                                                                                                        Authorization parameters to be passed to the authorization server.

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        connection: string

                                                                                                                                                                                                                                                        The name of the connection to link the account with (e.g., 'google-oauth2', 'facebook').

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        returnTo?: string

                                                                                                                                                                                                                                                        The URL to redirect to after successfully connecting the account.

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        scopes?: string[]

                                                                                                                                                                                                                                                        Array of scopes to request from the Identity Provider during the connect account flow.

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        connection: string

                                                                                                                                                                                                                                                        The name of the connection to link the account with (e.g., 'google-oauth2', 'facebook').

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        returnTo?: string

                                                                                                                                                                                                                                                        The URL to redirect to after successfully connecting the account.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        scopes?: string[]

                                                                                                                                                                                                                                                        Array of scopes to request from the Identity Provider during the connect account flow.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.ConnectionTokenSet.html b/docs/interfaces/types.ConnectionTokenSet.html index b7a9e292e..2be7f67b3 100644 --- a/docs/interfaces/types.ConnectionTokenSet.html +++ b/docs/interfaces/types.ConnectionTokenSet.html @@ -1,5 +1,5 @@ -ConnectionTokenSet | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface ConnectionTokenSet

                                                                                                                                                                                                                                                          interface ConnectionTokenSet {
                                                                                                                                                                                                                                                              accessToken: string;
                                                                                                                                                                                                                                                              connection: string;
                                                                                                                                                                                                                                                              expiresAt: number;
                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                              [key: string]: unknown;
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                          • [key: string]: unknown
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          accessToken +ConnectionTokenSet | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface ConnectionTokenSet

                                                                                                                                                                                                                                                            interface ConnectionTokenSet {
                                                                                                                                                                                                                                                                accessToken: string;
                                                                                                                                                                                                                                                                connection: string;
                                                                                                                                                                                                                                                                expiresAt: number;
                                                                                                                                                                                                                                                                scope?: string;
                                                                                                                                                                                                                                                                [key: string]: unknown;
                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                            • [key: string]: unknown
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            accessToken: string
                                                                                                                                                                                                                                                            connection: string
                                                                                                                                                                                                                                                            expiresAt: number
                                                                                                                                                                                                                                                            scope?: string
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            accessToken: string
                                                                                                                                                                                                                                                            connection: string
                                                                                                                                                                                                                                                            expiresAt: number
                                                                                                                                                                                                                                                            scope?: string
                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.CookieOptions.html b/docs/interfaces/types.CookieOptions.html index f8edbb407..5846f8208 100644 --- a/docs/interfaces/types.CookieOptions.html +++ b/docs/interfaces/types.CookieOptions.html @@ -1,8 +1,8 @@ -CookieOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface CookieOptions

                                                                                                                                                                                                                                                              interface CookieOptions {
                                                                                                                                                                                                                                                                  domain?: string;
                                                                                                                                                                                                                                                                  httpOnly: boolean;
                                                                                                                                                                                                                                                                  maxAge?: number;
                                                                                                                                                                                                                                                                  path: string;
                                                                                                                                                                                                                                                                  sameSite: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                  secure: boolean;
                                                                                                                                                                                                                                                                  transient?: boolean;
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              domain? +CookieOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface CookieOptions

                                                                                                                                                                                                                                                                interface CookieOptions {
                                                                                                                                                                                                                                                                    domain?: string;
                                                                                                                                                                                                                                                                    httpOnly: boolean;
                                                                                                                                                                                                                                                                    maxAge?: number;
                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                    sameSite: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                    secure: boolean;
                                                                                                                                                                                                                                                                    transient?: boolean;
                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                domain?: string
                                                                                                                                                                                                                                                                httpOnly: boolean
                                                                                                                                                                                                                                                                maxAge?: number
                                                                                                                                                                                                                                                                path: string
                                                                                                                                                                                                                                                                sameSite: "lax" | "strict" | "none"
                                                                                                                                                                                                                                                                secure: boolean
                                                                                                                                                                                                                                                                transient?: boolean
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                domain?: string
                                                                                                                                                                                                                                                                httpOnly: boolean
                                                                                                                                                                                                                                                                maxAge?: number
                                                                                                                                                                                                                                                                path: string
                                                                                                                                                                                                                                                                sameSite: "lax" | "strict" | "none"
                                                                                                                                                                                                                                                                secure: boolean
                                                                                                                                                                                                                                                                transient?: boolean
                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.CustomTokenExchangeOptions.html b/docs/interfaces/types.CustomTokenExchangeOptions.html index 38032805e..4b7754725 100644 --- a/docs/interfaces/types.CustomTokenExchangeOptions.html +++ b/docs/interfaces/types.CustomTokenExchangeOptions.html @@ -1,9 +1,9 @@ -CustomTokenExchangeOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Interface CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                  Options for Custom Token Exchange.

                                                                                                                                                                                                                                                                  +CustomTokenExchangeOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                    Options for Custom Token Exchange.

                                                                                                                                                                                                                                                                    Custom Token Exchange allows exchanging external tokens for Auth0 tokens without a browser redirect. The external token is validated by an Auth0 Action with the Custom Token Exchange trigger.

                                                                                                                                                                                                                                                                    interface CustomTokenExchangeOptions {
                                                                                                                                                                                                                                                                        actorToken?: string;
                                                                                                                                                                                                                                                                        actorTokenType?: string;
                                                                                                                                                                                                                                                                        additionalParameters?: Record<string, unknown>;
                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                        organization?: string;
                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                        subjectToken: string;
                                                                                                                                                                                                                                                                        subjectTokenType: string;
                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    interface CustomTokenExchangeOptions {
                                                                                                                                                                                                                                                                        actorToken?: string;
                                                                                                                                                                                                                                                                        actorTokenType?: string;
                                                                                                                                                                                                                                                                        additionalParameters?: Record<string, unknown>;
                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                        organization?: string;
                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                        subjectToken: string;
                                                                                                                                                                                                                                                                        subjectTokenType: string;
                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    actorToken?: string

                                                                                                                                                                                                                                                                    Actor token for delegation/impersonation scenarios (RFC 8693). Represents the identity of the acting party.

                                                                                                                                                                                                                                                                    If provided, actorTokenType is required.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    actorTokenType?: string

                                                                                                                                                                                                                                                                    Actor token type URI (required if actorToken is provided).

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    additionalParameters?: Record<string, unknown>

                                                                                                                                                                                                                                                                    Additional custom parameters passed to the token endpoint. +

                                                                                                                                                                                                                                                                    actorTokenType?: string

                                                                                                                                                                                                                                                                    Actor token type URI (required if actorToken is provided).

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    additionalParameters?: Record<string, unknown>

                                                                                                                                                                                                                                                                    Additional custom parameters passed to the token endpoint. Accessible in Auth0 Action via event.request.body.

                                                                                                                                                                                                                                                                    Use this for custom parameters instead of index signature to avoid TypeScript issues.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    audience?: string

                                                                                                                                                                                                                                                                    The unique identifier of the target API.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    organization?: string

                                                                                                                                                                                                                                                                    Organization ID or name for multi-tenant scenarios. +

                                                                                                                                                                                                                                                                    audience?: string

                                                                                                                                                                                                                                                                    The unique identifier of the target API.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    organization?: string

                                                                                                                                                                                                                                                                    Organization ID or name for multi-tenant scenarios. The organization ID will be present in the resulting access token claims.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    scope?: string

                                                                                                                                                                                                                                                                    Space-delimited OAuth 2.0 scopes.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    scope?: string

                                                                                                                                                                                                                                                                    Space-delimited OAuth 2.0 scopes.

                                                                                                                                                                                                                                                                    Note: These scopes are merged with SDK default scopes (openid profile email offline_access). Duplicates are removed.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    subjectToken: string

                                                                                                                                                                                                                                                                    The external token being exchanged. +

                                                                                                                                                                                                                                                                    subjectToken: string

                                                                                                                                                                                                                                                                    The external token being exchanged. This will be validated by your Auth0 Action with the Custom Token Exchange trigger.

                                                                                                                                                                                                                                                                    Validation: Must be a non-empty string.

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    subjectTokenType: string

                                                                                                                                                                                                                                                                    Custom URI identifying the token type.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    subjectTokenType: string

                                                                                                                                                                                                                                                                    Custom URI identifying the token type.

                                                                                                                                                                                                                                                                    Validation Rules:

                                                                                                                                                                                                                                                                    • Must be 10-100 characters
                                                                                                                                                                                                                                                                    • @@ -40,4 +40,4 @@
                                                                                                                                                                                                                                                                    'https://mycompany.com/token-type/v1'
                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.CustomTokenExchangeResponse.html b/docs/interfaces/types.CustomTokenExchangeResponse.html index e9c33cfea..25a9ed894 100644 --- a/docs/interfaces/types.CustomTokenExchangeResponse.html +++ b/docs/interfaces/types.CustomTokenExchangeResponse.html @@ -1,14 +1,14 @@ -CustomTokenExchangeResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface CustomTokenExchangeResponse

                                                                                                                                                                                                                                                                      Response from Custom Token Exchange.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      interface CustomTokenExchangeResponse {
                                                                                                                                                                                                                                                                          accessToken: string;
                                                                                                                                                                                                                                                                          expiresIn: number;
                                                                                                                                                                                                                                                                          idToken?: string;
                                                                                                                                                                                                                                                                          refreshToken?: string;
                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                          tokenType: string;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      accessToken +CustomTokenExchangeResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface CustomTokenExchangeResponse

                                                                                                                                                                                                                                                                        Response from Custom Token Exchange.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        interface CustomTokenExchangeResponse {
                                                                                                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                                                                                                            expiresIn: number;
                                                                                                                                                                                                                                                                            idToken?: string;
                                                                                                                                                                                                                                                                            refreshToken?: string;
                                                                                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                                                                                            tokenType: string;
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        accessToken: string

                                                                                                                                                                                                                                                                        The access token issued by Auth0

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        expiresIn: number

                                                                                                                                                                                                                                                                        Token lifetime in seconds

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        idToken?: string

                                                                                                                                                                                                                                                                        The ID token, if openid scope was requested

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        refreshToken?: string

                                                                                                                                                                                                                                                                        The refresh token, if offline_access scope was requested

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        scope?: string

                                                                                                                                                                                                                                                                        Granted scopes

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        tokenType: string

                                                                                                                                                                                                                                                                        Token type, typically "Bearer" or "DPoP"

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        expiresIn: number

                                                                                                                                                                                                                                                                        Token lifetime in seconds

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        idToken?: string

                                                                                                                                                                                                                                                                        The ID token, if openid scope was requested

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        refreshToken?: string

                                                                                                                                                                                                                                                                        The refresh token, if offline_access scope was requested

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        scope?: string

                                                                                                                                                                                                                                                                        Granted scopes

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        tokenType: string

                                                                                                                                                                                                                                                                        Token type, typically "Bearer" or "DPoP"

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.DiscoveryCacheOptions.html b/docs/interfaces/types.DiscoveryCacheOptions.html index 13b615a25..85e8ba0e6 100644 --- a/docs/interfaces/types.DiscoveryCacheOptions.html +++ b/docs/interfaces/types.DiscoveryCacheOptions.html @@ -1,10 +1,10 @@ -DiscoveryCacheOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface DiscoveryCacheOptions

                                                                                                                                                                                                                                                                          Configuration for the OIDC discovery metadata cache. +DiscoveryCacheOptions | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface DiscoveryCacheOptions

                                                                                                                                                                                                                                                                            Configuration for the OIDC discovery metadata cache. Applies in both static and resolver modes.

                                                                                                                                                                                                                                                                            const auth0 = new Auth0Client({
                                                                                                                                                                                                                                                                            domain: myDomainResolver,
                                                                                                                                                                                                                                                                            discoveryCache: {
                                                                                                                                                                                                                                                                            ttl: 300, // 5-minute TTL
                                                                                                                                                                                                                                                                            maxEntries: 50, // Cache up to 50 issuers
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            interface DiscoveryCacheOptions {
                                                                                                                                                                                                                                                                                maxEntries?: number;
                                                                                                                                                                                                                                                                                ttl?: number;
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            interface DiscoveryCacheOptions {
                                                                                                                                                                                                                                                                                maxEntries?: number;
                                                                                                                                                                                                                                                                                ttl?: number;
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            maxEntries?: number

                                                                                                                                                                                                                                                                            Maximum number of cached issuers. Default: 100. LRU eviction.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            ttl?: number

                                                                                                                                                                                                                                                                            Time-to-live for cached discovery metadata in seconds. Default: 600 (10 minutes).

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            ttl?: number

                                                                                                                                                                                                                                                                            Time-to-live for cached discovery metadata in seconds. Default: 600 (10 minutes).

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.EnrollOobOptions.html b/docs/interfaces/types.EnrollOobOptions.html index eaac2916d..645451f6b 100644 --- a/docs/interfaces/types.EnrollOobOptions.html +++ b/docs/interfaces/types.EnrollOobOptions.html @@ -1,12 +1,12 @@ -EnrollOobOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface EnrollOobOptions

                                                                                                                                                                                                                                                                              Enroll OOB authenticator (SMS/Voice/Push/Email).

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              interface EnrollOobOptions {
                                                                                                                                                                                                                                                                                  authenticatorTypes: ["oob"];
                                                                                                                                                                                                                                                                                  email?: string;
                                                                                                                                                                                                                                                                                  mfaToken: string;
                                                                                                                                                                                                                                                                                  oobChannels: ("email" | "sms" | "voice" | "auth0")[];
                                                                                                                                                                                                                                                                                  phoneNumber?: string;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              authenticatorTypes +EnrollOobOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface EnrollOobOptions

                                                                                                                                                                                                                                                                                Enroll OOB authenticator (SMS/Voice/Push/Email).

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                interface EnrollOobOptions {
                                                                                                                                                                                                                                                                                    authenticatorTypes: ["oob"];
                                                                                                                                                                                                                                                                                    email?: string;
                                                                                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                                                                                    oobChannels: ("email" | "sms" | "voice" | "auth0")[];
                                                                                                                                                                                                                                                                                    phoneNumber?: string;
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                authenticatorTypes: ["oob"]

                                                                                                                                                                                                                                                                                Authenticator types to enroll

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                email?: string

                                                                                                                                                                                                                                                                                Email address (optional for email channel - uses user's email if not provided)

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                                                                                                Encrypted MFA token

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                oobChannels: ("email" | "sms" | "voice" | "auth0")[]

                                                                                                                                                                                                                                                                                OOB channels (sms, voice, auth0, email)

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                phoneNumber?: string

                                                                                                                                                                                                                                                                                Phone number in E.164 format (required for sms/voice)

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                email?: string

                                                                                                                                                                                                                                                                                Email address (optional for email channel - uses user's email if not provided)

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                                                                                                Encrypted MFA token

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                oobChannels: ("email" | "sms" | "voice" | "auth0")[]

                                                                                                                                                                                                                                                                                OOB channels (sms, voice, auth0, email)

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                phoneNumber?: string

                                                                                                                                                                                                                                                                                Phone number in E.164 format (required for sms/voice)

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.EnrollOtpOptions.html b/docs/interfaces/types.EnrollOtpOptions.html index a8db34fae..3556c5006 100644 --- a/docs/interfaces/types.EnrollOtpOptions.html +++ b/docs/interfaces/types.EnrollOtpOptions.html @@ -1,6 +1,6 @@ -EnrollOtpOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface EnrollOtpOptions

                                                                                                                                                                                                                                                                                  Enroll OTP authenticator (TOTP app like Authy/Google Authenticator).

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  interface EnrollOtpOptions {
                                                                                                                                                                                                                                                                                      authenticatorTypes: ["otp"];
                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  authenticatorTypes +EnrollOtpOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface EnrollOtpOptions

                                                                                                                                                                                                                                                                                    Enroll OTP authenticator (TOTP app like Authy/Google Authenticator).

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    interface EnrollOtpOptions {
                                                                                                                                                                                                                                                                                        authenticatorTypes: ["otp"];
                                                                                                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    authenticatorTypes: ["otp"]

                                                                                                                                                                                                                                                                                    Authenticator types to enroll

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    mfaToken: string

                                                                                                                                                                                                                                                                                    Encrypted MFA token

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    mfaToken: string

                                                                                                                                                                                                                                                                                    Encrypted MFA token

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.MCDMetadata.html b/docs/interfaces/types.MCDMetadata.html index b3ab86229..6c031fa55 100644 --- a/docs/interfaces/types.MCDMetadata.html +++ b/docs/interfaces/types.MCDMetadata.html @@ -1,7 +1,7 @@ -MCDMetadata | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface MCDMetadataInternal

                                                                                                                                                                                                                                                                                      Metadata for a specific domain and its associated issuer. +MCDMetadata | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface MCDMetadataInternal

                                                                                                                                                                                                                                                                                        Metadata for a specific domain and its associated issuer. Stored in session internal state to track which domain authenticated the user.

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        interface MCDMetadata {
                                                                                                                                                                                                                                                                                            domain: string;
                                                                                                                                                                                                                                                                                            issuer: string;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        interface MCDMetadata {
                                                                                                                                                                                                                                                                                            domain: string;
                                                                                                                                                                                                                                                                                            issuer: string;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        domain: string

                                                                                                                                                                                                                                                                                        The Auth0 domain that authenticated the user

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        issuer: string

                                                                                                                                                                                                                                                                                        The OIDC issuer URL for the domain

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        issuer: string

                                                                                                                                                                                                                                                                                        The OIDC issuer URL for the domain

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.MfaClient.html b/docs/interfaces/types.MfaClient.html index 05cc968ca..368588a8b 100644 --- a/docs/interfaces/types.MfaClient.html +++ b/docs/interfaces/types.MfaClient.html @@ -1,20 +1,20 @@ -MfaClient | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface MfaClient

                                                                                                                                                                                                                                                                                          MFA client interface available in both server and client contexts.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          interface MfaClient {
                                                                                                                                                                                                                                                                                              challenge(
                                                                                                                                                                                                                                                                                                  options: {
                                                                                                                                                                                                                                                                                                      authenticatorId?: string;
                                                                                                                                                                                                                                                                                                      challengeType: string;
                                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                                  },
                                                                                                                                                                                                                                                                                              ): Promise<ChallengeResponse>;
                                                                                                                                                                                                                                                                                              enroll(options: EnrollOptions): Promise<EnrollmentResponse>;
                                                                                                                                                                                                                                                                                              getAuthenticators(options: { mfaToken: string }): Promise<Authenticator[]>;
                                                                                                                                                                                                                                                                                              verify(options: VerifyMfaOptions): Promise<MfaVerifyResponse>;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                          challenge +MfaClient | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface MfaClient

                                                                                                                                                                                                                                                                                            MFA client interface available in both server and client contexts.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            interface MfaClient {
                                                                                                                                                                                                                                                                                                challenge(
                                                                                                                                                                                                                                                                                                    options: {
                                                                                                                                                                                                                                                                                                        authenticatorId?: string;
                                                                                                                                                                                                                                                                                                        challengeType: string;
                                                                                                                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                ): Promise<ChallengeResponse>;
                                                                                                                                                                                                                                                                                                enroll(options: EnrollOptions): Promise<EnrollmentResponse>;
                                                                                                                                                                                                                                                                                                getAuthenticators(options: { mfaToken: string }): Promise<Authenticator[]>;
                                                                                                                                                                                                                                                                                                verify(options: VerifyMfaOptions): Promise<MfaVerifyResponse>;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                            • Initiate an MFA challenge.

                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                              • options: { authenticatorId?: string; challengeType: string; mfaToken: string }

                                                                                                                                                                                                                                                                                                Challenge options

                                                                                                                                                                                                                                                                                              Returns Promise<ChallengeResponse>

                                                                                                                                                                                                                                                                                              Challenge response (oobCode, bindingMethod)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                            • List enrolled authenticators for the user. Filters by allowed challenge types from mfa_requirements.

                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                              • options: { mfaToken: string }

                                                                                                                                                                                                                                                                                                Options containing encrypted mfaToken

                                                                                                                                                                                                                                                                                              Returns Promise<Authenticator[]>

                                                                                                                                                                                                                                                                                              Array of authenticators

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.MfaContext.html b/docs/interfaces/types.MfaContext.html index 6ef7b5c4e..fc97e1139 100644 --- a/docs/interfaces/types.MfaContext.html +++ b/docs/interfaces/types.MfaContext.html @@ -1,13 +1,13 @@ -MfaContext | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface MfaContext

                                                                                                                                                                                                                                                                                              MFA context embedded in encrypted token. +MfaContext | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface MfaContext

                                                                                                                                                                                                                                                                                                MFA context embedded in encrypted token. Self-contained with all information needed for challenge completion.

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                interface MfaContext {
                                                                                                                                                                                                                                                                                                    audience: string;
                                                                                                                                                                                                                                                                                                    createdAt: number;
                                                                                                                                                                                                                                                                                                    mfaRequirements: MfaRequirements | undefined;
                                                                                                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                                                                                                    scope: string;
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                interface MfaContext {
                                                                                                                                                                                                                                                                                                    audience: string;
                                                                                                                                                                                                                                                                                                    createdAt: number;
                                                                                                                                                                                                                                                                                                    mfaRequirements: MfaRequirements | undefined;
                                                                                                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                                                                                                    scope: string;
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                audience: string

                                                                                                                                                                                                                                                                                                API identifier that required MFA

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                createdAt: number

                                                                                                                                                                                                                                                                                                Timestamp for TTL validation (milliseconds since epoch)

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                mfaRequirements: MfaRequirements | undefined

                                                                                                                                                                                                                                                                                                MFA requirements from Auth0

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                                                                                                                Raw mfa_token from Auth0

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                scope: string

                                                                                                                                                                                                                                                                                                Scopes requested

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                createdAt: number

                                                                                                                                                                                                                                                                                                Timestamp for TTL validation (milliseconds since epoch)

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                mfaRequirements: MfaRequirements | undefined

                                                                                                                                                                                                                                                                                                MFA requirements from Auth0

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                                                                                                                Raw mfa_token from Auth0

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                scope: string

                                                                                                                                                                                                                                                                                                Scopes requested

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.MfaVerifyResponse.html b/docs/interfaces/types.MfaVerifyResponse.html index c2af3204e..d4d9d6365 100644 --- a/docs/interfaces/types.MfaVerifyResponse.html +++ b/docs/interfaces/types.MfaVerifyResponse.html @@ -1,7 +1,7 @@ -MfaVerifyResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface MfaVerifyResponse

                                                                                                                                                                                                                                                                                                  MFA verify response from Auth0. +MfaVerifyResponse | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface MfaVerifyResponse

                                                                                                                                                                                                                                                                                                    MFA verify response from Auth0. Uses snake_case to match Auth0 API and SPA SDK conventions.

                                                                                                                                                                                                                                                                                                    interface MfaVerifyResponse {
                                                                                                                                                                                                                                                                                                        access_token: string;
                                                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                                                        expires_in: number;
                                                                                                                                                                                                                                                                                                        id_token?: string;
                                                                                                                                                                                                                                                                                                        recovery_code?: string;
                                                                                                                                                                                                                                                                                                        refresh_token?: string;
                                                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                                                        token_type: string;
                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    interface MfaVerifyResponse {
                                                                                                                                                                                                                                                                                                        access_token: string;
                                                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                                                        expires_in: number;
                                                                                                                                                                                                                                                                                                        id_token?: string;
                                                                                                                                                                                                                                                                                                        recovery_code?: string;
                                                                                                                                                                                                                                                                                                        refresh_token?: string;
                                                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                                                        token_type: string;
                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    access_token: string

                                                                                                                                                                                                                                                                                                    Access token

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    audience?: string

                                                                                                                                                                                                                                                                                                    API audience

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    expires_in: number

                                                                                                                                                                                                                                                                                                    Expires in seconds

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    id_token?: string

                                                                                                                                                                                                                                                                                                    ID token (if present)

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    recovery_code?: string

                                                                                                                                                                                                                                                                                                    Recovery code (if regenerated by tenant config)

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    refresh_token?: string

                                                                                                                                                                                                                                                                                                    Refresh token (if present)

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    scope?: string

                                                                                                                                                                                                                                                                                                    Token scope

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    token_type: string

                                                                                                                                                                                                                                                                                                    Token type (usually "Bearer")

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    audience?: string

                                                                                                                                                                                                                                                                                                    API audience

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    expires_in: number

                                                                                                                                                                                                                                                                                                    Expires in seconds

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    id_token?: string

                                                                                                                                                                                                                                                                                                    ID token (if present)

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    recovery_code?: string

                                                                                                                                                                                                                                                                                                    Recovery code (if regenerated by tenant config)

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    refresh_token?: string

                                                                                                                                                                                                                                                                                                    Refresh token (if present)

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    scope?: string

                                                                                                                                                                                                                                                                                                    Token scope

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    token_type: string

                                                                                                                                                                                                                                                                                                    Token type (usually "Bearer")

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.Routes.html b/docs/interfaces/types.Routes.html index e78d864d8..d116a5784 100644 --- a/docs/interfaces/types.Routes.html +++ b/docs/interfaces/types.Routes.html @@ -1,4 +1,4 @@ -Routes | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface Routes

                                                                                                                                                                                                                                                                                                      interface Routes {
                                                                                                                                                                                                                                                                                                          accessToken: string;
                                                                                                                                                                                                                                                                                                          backChannelLogout: string;
                                                                                                                                                                                                                                                                                                          callback: string;
                                                                                                                                                                                                                                                                                                          connectAccount: string;
                                                                                                                                                                                                                                                                                                          login: string;
                                                                                                                                                                                                                                                                                                          logout: string;
                                                                                                                                                                                                                                                                                                          mfaAuthenticators: string;
                                                                                                                                                                                                                                                                                                          mfaChallenge: string;
                                                                                                                                                                                                                                                                                                          mfaEnroll: string;
                                                                                                                                                                                                                                                                                                          mfaVerify: string;
                                                                                                                                                                                                                                                                                                          profile: string;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      accessToken +Routes | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface Routes

                                                                                                                                                                                                                                                                                                        interface Routes {
                                                                                                                                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                                                                                                                                            backChannelLogout: string;
                                                                                                                                                                                                                                                                                                            callback: string;
                                                                                                                                                                                                                                                                                                            connectAccount: string;
                                                                                                                                                                                                                                                                                                            login: string;
                                                                                                                                                                                                                                                                                                            logout: string;
                                                                                                                                                                                                                                                                                                            mfaAuthenticators: string;
                                                                                                                                                                                                                                                                                                            mfaChallenge: string;
                                                                                                                                                                                                                                                                                                            mfaEnroll: string;
                                                                                                                                                                                                                                                                                                            mfaVerify: string;
                                                                                                                                                                                                                                                                                                            profile: string;
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        accessToken: string
                                                                                                                                                                                                                                                                                                        backChannelLogout: string
                                                                                                                                                                                                                                                                                                        callback: string
                                                                                                                                                                                                                                                                                                        connectAccount: string
                                                                                                                                                                                                                                                                                                        login: string
                                                                                                                                                                                                                                                                                                        logout: string
                                                                                                                                                                                                                                                                                                        mfaAuthenticators: string
                                                                                                                                                                                                                                                                                                        mfaChallenge: string
                                                                                                                                                                                                                                                                                                        mfaEnroll: string
                                                                                                                                                                                                                                                                                                        mfaVerify: string
                                                                                                                                                                                                                                                                                                        profile: string
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        accessToken: string
                                                                                                                                                                                                                                                                                                        backChannelLogout: string
                                                                                                                                                                                                                                                                                                        callback: string
                                                                                                                                                                                                                                                                                                        connectAccount: string
                                                                                                                                                                                                                                                                                                        login: string
                                                                                                                                                                                                                                                                                                        logout: string
                                                                                                                                                                                                                                                                                                        mfaAuthenticators: string
                                                                                                                                                                                                                                                                                                        mfaChallenge: string
                                                                                                                                                                                                                                                                                                        mfaEnroll: string
                                                                                                                                                                                                                                                                                                        mfaVerify: string
                                                                                                                                                                                                                                                                                                        profile: string
                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.SessionConfiguration.html b/docs/interfaces/types.SessionConfiguration.html index d0285c57d..88b1d15f6 100644 --- a/docs/interfaces/types.SessionConfiguration.html +++ b/docs/interfaces/types.SessionConfiguration.html @@ -1,16 +1,16 @@ -SessionConfiguration | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface SessionConfiguration

                                                                                                                                                                                                                                                                                                          interface SessionConfiguration {
                                                                                                                                                                                                                                                                                                              absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                              cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                              inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                              rolling?: boolean;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          absoluteDuration? +SessionConfiguration | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface SessionConfiguration

                                                                                                                                                                                                                                                                                                            interface SessionConfiguration {
                                                                                                                                                                                                                                                                                                                absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                rolling?: boolean;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            absoluteDuration?: number

                                                                                                                                                                                                                                                                                                            The absolute duration after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                            Once the absolute duration has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                            Default: 3 days.

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            The options for the session cookie.

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            inactivityDuration?: number

                                                                                                                                                                                                                                                                                                            The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            The options for the session cookie.

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            inactivityDuration?: number

                                                                                                                                                                                                                                                                                                            The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                            The session will be extended as long as it was active before the inactivity duration has been reached.

                                                                                                                                                                                                                                                                                                            Default: 1 day.

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            rolling?: boolean

                                                                                                                                                                                                                                                                                                            A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            rolling?: boolean

                                                                                                                                                                                                                                                                                                            A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                            When enabled, the session will continue to be extended as long as it is used within the inactivity duration. Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                            Default: true.

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.SessionCookieOptions.html b/docs/interfaces/types.SessionCookieOptions.html index 80447d912..c5164fd47 100644 --- a/docs/interfaces/types.SessionCookieOptions.html +++ b/docs/interfaces/types.SessionCookieOptions.html @@ -1,4 +1,4 @@ -SessionCookieOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface SessionCookieOptions

                                                                                                                                                                                                                                                                                                              interface SessionCookieOptions {
                                                                                                                                                                                                                                                                                                                  domain?: string;
                                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                                  path?: string;
                                                                                                                                                                                                                                                                                                                  sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                  secure?: boolean;
                                                                                                                                                                                                                                                                                                                  transient?: boolean;
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              domain? +SessionCookieOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface SessionCookieOptions

                                                                                                                                                                                                                                                                                                                interface SessionCookieOptions {
                                                                                                                                                                                                                                                                                                                    domain?: string;
                                                                                                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                                                                                                    path?: string;
                                                                                                                                                                                                                                                                                                                    sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                    secure?: boolean;
                                                                                                                                                                                                                                                                                                                    transient?: boolean;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                domain? name? path? sameSite? @@ -7,12 +7,12 @@

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                domain?: string

                                                                                                                                                                                                                                                                                                                Specifies the value for the Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                name?: string

                                                                                                                                                                                                                                                                                                                The name of the session cookie.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                name?: string

                                                                                                                                                                                                                                                                                                                The name of the session cookie.

                                                                                                                                                                                                                                                                                                                Default: __session.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                path?: string

                                                                                                                                                                                                                                                                                                                The path attribute of the session cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                The sameSite attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                path?: string

                                                                                                                                                                                                                                                                                                                The path attribute of the session cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                The sameSite attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                Default: lax.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                secure?: boolean

                                                                                                                                                                                                                                                                                                                The secure attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                secure?: boolean

                                                                                                                                                                                                                                                                                                                The secure attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                transient?: boolean

                                                                                                                                                                                                                                                                                                                The transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                transient?: boolean

                                                                                                                                                                                                                                                                                                                The transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.SessionData.html b/docs/interfaces/types.SessionData.html index aec41d240..1964164fc 100644 --- a/docs/interfaces/types.SessionData.html +++ b/docs/interfaces/types.SessionData.html @@ -1,6 +1,6 @@ -SessionData | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface SessionData

                                                                                                                                                                                                                                                                                                                  interface SessionData {
                                                                                                                                                                                                                                                                                                                      accessTokens?: AccessTokenSet[];
                                                                                                                                                                                                                                                                                                                      connectionTokenSets?: ConnectionTokenSet[];
                                                                                                                                                                                                                                                                                                                      internal: { createdAt: number; mcd?: MCDMetadata; sid: string };
                                                                                                                                                                                                                                                                                                                      tokenSet: TokenSet;
                                                                                                                                                                                                                                                                                                                      user: User;
                                                                                                                                                                                                                                                                                                                      [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                  • [key: string]: unknown
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  accessTokens? +SessionData | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface SessionData

                                                                                                                                                                                                                                                                                                                    interface SessionData {
                                                                                                                                                                                                                                                                                                                        accessTokens?: AccessTokenSet[];
                                                                                                                                                                                                                                                                                                                        connectionTokenSets?: ConnectionTokenSet[];
                                                                                                                                                                                                                                                                                                                        internal: { createdAt: number; mcd?: MCDMetadata; sid: string };
                                                                                                                                                                                                                                                                                                                        tokenSet: TokenSet;
                                                                                                                                                                                                                                                                                                                        user: User;
                                                                                                                                                                                                                                                                                                                        [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                    • [key: string]: unknown
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    accessTokens?: AccessTokenSet[]
                                                                                                                                                                                                                                                                                                                    connectionTokenSets?: ConnectionTokenSet[]
                                                                                                                                                                                                                                                                                                                    internal: { createdAt: number; mcd?: MCDMetadata; sid: string }
                                                                                                                                                                                                                                                                                                                    tokenSet: TokenSet
                                                                                                                                                                                                                                                                                                                    user: User
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    accessTokens?: AccessTokenSet[]
                                                                                                                                                                                                                                                                                                                    connectionTokenSets?: ConnectionTokenSet[]
                                                                                                                                                                                                                                                                                                                    internal: { createdAt: number; mcd?: MCDMetadata; sid: string }
                                                                                                                                                                                                                                                                                                                    tokenSet: TokenSet
                                                                                                                                                                                                                                                                                                                    user: User
                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.SessionDataStore.html b/docs/interfaces/types.SessionDataStore.html index 64a51f151..881917092 100644 --- a/docs/interfaces/types.SessionDataStore.html +++ b/docs/interfaces/types.SessionDataStore.html @@ -1,14 +1,20 @@ -SessionDataStore | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface SessionDataStore

                                                                                                                                                                                                                                                                                                                      interface SessionDataStore {
                                                                                                                                                                                                                                                                                                                          delete(id: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                          deleteByLogoutToken?(logoutToken: LogoutToken): Promise<void>;
                                                                                                                                                                                                                                                                                                                          get(id: string): Promise<SessionData | null>;
                                                                                                                                                                                                                                                                                                                          set(id: string, session: SessionData): Promise<void>;
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                      delete +SessionDataStore | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface SessionDataStore

                                                                                                                                                                                                                                                                                                                        Interface for a custom session data store.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        TTL contract: every successful write method (set, update) must reset the session +TTL/expiry so that active sessions are not silently expired between requests.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        interface SessionDataStore {
                                                                                                                                                                                                                                                                                                                            delete(id: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                            deleteByLogoutToken?(logoutToken: LogoutToken): Promise<void>;
                                                                                                                                                                                                                                                                                                                            get(id: string): Promise<SessionData | null>;
                                                                                                                                                                                                                                                                                                                            set(id: string, session: SessionData): Promise<void>;
                                                                                                                                                                                                                                                                                                                            update?(id: string, session: SessionData): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        • Destroys the session with the given session ID.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          • id: string

                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                        • Deletes the session with the given logout token which may contain a session ID or a user ID, or both.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          • id: string

                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                        • Deletes the session with the given logout token which may contain a session ID or a user ID, or both.

                                                                                                                                                                                                                                                                                                                          MCD resolver mode: When using multiple custom domains with a domain resolver, implementations MUST filter on the iss field in addition to sub/sid to ensure sessions are only deleted for the matching issuer. Custom domains on the same tenant share signing keys, so failing to filter on iss allows a logout token from one domain to delete sessions created by a different domain.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                        • Optional: update the session by its ID only if it already exists. +Return true if updated, false if not found.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.SessionStoreOptions.html b/docs/interfaces/types.SessionStoreOptions.html index 63398df67..5603724e8 100644 --- a/docs/interfaces/types.SessionStoreOptions.html +++ b/docs/interfaces/types.SessionStoreOptions.html @@ -1,4 +1,4 @@ -SessionStoreOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface SessionStoreOptions

                                                                                                                                                                                                                                                                                                                          interface SessionStoreOptions {
                                                                                                                                                                                                                                                                                                                              absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                              cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                              cookieOptions?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                              inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                              rolling?: boolean;
                                                                                                                                                                                                                                                                                                                              secret: string;
                                                                                                                                                                                                                                                                                                                              store?: SessionDataStore;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          absoluteDuration? +SessionStoreOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface SessionStoreOptions

                                                                                                                                                                                                                                                                                                                            interface SessionStoreOptions {
                                                                                                                                                                                                                                                                                                                                absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                                cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                                cookieOptions?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                                inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                                rolling?: boolean;
                                                                                                                                                                                                                                                                                                                                secret: string;
                                                                                                                                                                                                                                                                                                                                store?: SessionDataStore;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            absoluteDuration?: number

                                                                                                                                                                                                                                                                                                                            The absolute duration after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                                            Once the absolute duration has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                                            Default: 3 days.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            The options for the session cookie.

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            cookieOptions?: SessionCookieOptions
                                                                                                                                                                                                                                                                                                                            inactivityDuration?: number

                                                                                                                                                                                                                                                                                                                            The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            The options for the session cookie.

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            cookieOptions?: SessionCookieOptions
                                                                                                                                                                                                                                                                                                                            inactivityDuration?: number

                                                                                                                                                                                                                                                                                                                            The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                                            The session will be extended as long as it was active before the inactivity duration has been reached.

                                                                                                                                                                                                                                                                                                                            Default: 1 day.

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            rolling?: boolean

                                                                                                                                                                                                                                                                                                                            A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            rolling?: boolean

                                                                                                                                                                                                                                                                                                                            A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                                            When enabled, the session will continue to be extended as long as it is used within the inactivity duration. Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                                            Default: true.

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            secret: string
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            secret: string
                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.StartInteractiveLoginOptions.html b/docs/interfaces/types.StartInteractiveLoginOptions.html index 13755a416..53a9430af 100644 --- a/docs/interfaces/types.StartInteractiveLoginOptions.html +++ b/docs/interfaces/types.StartInteractiveLoginOptions.html @@ -1,5 +1,5 @@ -StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface StartInteractiveLoginOptions

                                                                                                                                                                                                                                                                                                                              interface StartInteractiveLoginOptions {
                                                                                                                                                                                                                                                                                                                                  authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                                                                                                                  returnTo?: string;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              authorizationParameters? +StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface StartInteractiveLoginOptions

                                                                                                                                                                                                                                                                                                                                interface StartInteractiveLoginOptions {
                                                                                                                                                                                                                                                                                                                                    authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                                                                                                                    returnTo?: string;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                authorizationParameters?: AuthorizationParameters

                                                                                                                                                                                                                                                                                                                                Authorization parameters to be passed to the authorization server.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                returnTo?: string

                                                                                                                                                                                                                                                                                                                                The URL to redirect to after a successful login.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                returnTo?: string

                                                                                                                                                                                                                                                                                                                                The URL to redirect to after a successful login.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.TokenSet.html b/docs/interfaces/types.TokenSet.html index e6b809c4d..4939ce8ff 100644 --- a/docs/interfaces/types.TokenSet.html +++ b/docs/interfaces/types.TokenSet.html @@ -1,4 +1,4 @@ -TokenSet | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface TokenSet

                                                                                                                                                                                                                                                                                                                                  interface TokenSet {
                                                                                                                                                                                                                                                                                                                                      accessToken: string;
                                                                                                                                                                                                                                                                                                                                      audience?: string;
                                                                                                                                                                                                                                                                                                                                      expiresAt: number;
                                                                                                                                                                                                                                                                                                                                      idToken?: string;
                                                                                                                                                                                                                                                                                                                                      refreshToken?: string;
                                                                                                                                                                                                                                                                                                                                      requestedScope?: string;
                                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                                      token_type?: string;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  accessToken +TokenSet | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface TokenSet

                                                                                                                                                                                                                                                                                                                                    interface TokenSet {
                                                                                                                                                                                                                                                                                                                                        accessToken: string;
                                                                                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                                                                                        expiresAt: number;
                                                                                                                                                                                                                                                                                                                                        idToken?: string;
                                                                                                                                                                                                                                                                                                                                        refreshToken?: string;
                                                                                                                                                                                                                                                                                                                                        requestedScope?: string;
                                                                                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                                                                                        token_type?: string;
                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    accessToken: string
                                                                                                                                                                                                                                                                                                                                    audience?: string
                                                                                                                                                                                                                                                                                                                                    expiresAt: number
                                                                                                                                                                                                                                                                                                                                    idToken?: string
                                                                                                                                                                                                                                                                                                                                    refreshToken?: string
                                                                                                                                                                                                                                                                                                                                    requestedScope?: string
                                                                                                                                                                                                                                                                                                                                    scope?: string
                                                                                                                                                                                                                                                                                                                                    token_type?: string
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    accessToken: string
                                                                                                                                                                                                                                                                                                                                    audience?: string
                                                                                                                                                                                                                                                                                                                                    expiresAt: number
                                                                                                                                                                                                                                                                                                                                    idToken?: string
                                                                                                                                                                                                                                                                                                                                    refreshToken?: string
                                                                                                                                                                                                                                                                                                                                    requestedScope?: string
                                                                                                                                                                                                                                                                                                                                    scope?: string
                                                                                                                                                                                                                                                                                                                                    token_type?: string
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.TransactionCookieOptions.html b/docs/interfaces/types.TransactionCookieOptions.html index 2f53d5df7..7df1e3fe4 100644 --- a/docs/interfaces/types.TransactionCookieOptions.html +++ b/docs/interfaces/types.TransactionCookieOptions.html @@ -1,4 +1,4 @@ -TransactionCookieOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface TransactionCookieOptions

                                                                                                                                                                                                                                                                                                                                      interface TransactionCookieOptions {
                                                                                                                                                                                                                                                                                                                                          domain?: string;
                                                                                                                                                                                                                                                                                                                                          maxAge?: number;
                                                                                                                                                                                                                                                                                                                                          path?: string;
                                                                                                                                                                                                                                                                                                                                          prefix?: string;
                                                                                                                                                                                                                                                                                                                                          sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                                          secure?: boolean;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      domain? +TransactionCookieOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface TransactionCookieOptions

                                                                                                                                                                                                                                                                                                                                        interface TransactionCookieOptions {
                                                                                                                                                                                                                                                                                                                                            domain?: string;
                                                                                                                                                                                                                                                                                                                                            maxAge?: number;
                                                                                                                                                                                                                                                                                                                                            path?: string;
                                                                                                                                                                                                                                                                                                                                            prefix?: string;
                                                                                                                                                                                                                                                                                                                                            sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                                            secure?: boolean;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        domain? maxAge? path? prefix? @@ -7,16 +7,16 @@

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        domain?: string

                                                                                                                                                                                                                                                                                                                                        Specifies the value for the Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        maxAge?: number

                                                                                                                                                                                                                                                                                                                                        The expiration time for transaction cookies in seconds. +

                                                                                                                                                                                                                                                                                                                                        maxAge?: number

                                                                                                                                                                                                                                                                                                                                        The expiration time for transaction cookies in seconds. If not provided, defaults to 1 hour (3600 seconds).

                                                                                                                                                                                                                                                                                                                                        3600
                                                                                                                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        path?: string

                                                                                                                                                                                                                                                                                                                                        The path attribute of the transaction cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        prefix?: string

                                                                                                                                                                                                                                                                                                                                        The prefix of the cookie used to store the transaction state.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        path?: string

                                                                                                                                                                                                                                                                                                                                        The path attribute of the transaction cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        prefix?: string

                                                                                                                                                                                                                                                                                                                                        The prefix of the cookie used to store the transaction state.

                                                                                                                                                                                                                                                                                                                                        Default: __txn_{state}.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                                        The sameSite attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                                        The sameSite attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                        Default: lax.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        secure?: boolean

                                                                                                                                                                                                                                                                                                                                        The secure attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        secure?: boolean

                                                                                                                                                                                                                                                                                                                                        The secure attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                        Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.TransactionState.html b/docs/interfaces/types.TransactionState.html index 64eb29f8d..5cfca36e5 100644 --- a/docs/interfaces/types.TransactionState.html +++ b/docs/interfaces/types.TransactionState.html @@ -1,5 +1,5 @@ -TransactionState | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface TransactionState

                                                                                                                                                                                                                                                                                                                                          interface TransactionState {
                                                                                                                                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                                                                                                                                              authSession?: string;
                                                                                                                                                                                                                                                                                                                                              codeVerifier: string;
                                                                                                                                                                                                                                                                                                                                              maxAge?: number;
                                                                                                                                                                                                                                                                                                                                              nonce?: string;
                                                                                                                                                                                                                                                                                                                                              originDomain?: string;
                                                                                                                                                                                                                                                                                                                                              originIssuer?: string;
                                                                                                                                                                                                                                                                                                                                              responseType: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                              returnTo: string;
                                                                                                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                                                                                                              state: string;
                                                                                                                                                                                                                                                                                                                                              [propName: string]: unknown;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                          • JWTPayload
                                                                                                                                                                                                                                                                                                                                            • TransactionState

                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                          • [propName: string]: unknown

                                                                                                                                                                                                                                                                                                                                            Any other JWT Claim Set member.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          audience? +TransactionState | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Interface TransactionState

                                                                                                                                                                                                                                                                                                                                            interface TransactionState {
                                                                                                                                                                                                                                                                                                                                                audience?: string;
                                                                                                                                                                                                                                                                                                                                                authSession?: string;
                                                                                                                                                                                                                                                                                                                                                codeVerifier: string;
                                                                                                                                                                                                                                                                                                                                                maxAge?: number;
                                                                                                                                                                                                                                                                                                                                                nonce?: string;
                                                                                                                                                                                                                                                                                                                                                originDomain?: string;
                                                                                                                                                                                                                                                                                                                                                originIssuer?: string;
                                                                                                                                                                                                                                                                                                                                                responseType: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                returnTo: string;
                                                                                                                                                                                                                                                                                                                                                scope?: string;
                                                                                                                                                                                                                                                                                                                                                state: string;
                                                                                                                                                                                                                                                                                                                                                [propName: string]: unknown;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                            • JWTPayload
                                                                                                                                                                                                                                                                                                                                              • TransactionState

                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                            • [propName: string]: unknown

                                                                                                                                                                                                                                                                                                                                              Any other JWT Claim Set member.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            audience?: string

                                                                                                                                                                                                                                                                                                                                            The audience used for this transaction.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            authSession?: string
                                                                                                                                                                                                                                                                                                                                            codeVerifier: string
                                                                                                                                                                                                                                                                                                                                            maxAge?: number
                                                                                                                                                                                                                                                                                                                                            nonce?: string
                                                                                                                                                                                                                                                                                                                                            originDomain?: string

                                                                                                                                                                                                                                                                                                                                            The Auth0 domain used for this transaction (MCD mode). +

                                                                                                                                                                                                                                                                                                                                            authSession?: string
                                                                                                                                                                                                                                                                                                                                            codeVerifier: string
                                                                                                                                                                                                                                                                                                                                            maxAge?: number
                                                                                                                                                                                                                                                                                                                                            nonce?: string
                                                                                                                                                                                                                                                                                                                                            originDomain?: string

                                                                                                                                                                                                                                                                                                                                            The Auth0 domain used for this transaction (MCD mode). Stored to validate that the session is for the same domain.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            originIssuer?: string

                                                                                                                                                                                                                                                                                                                                            The OIDC issuer URL for this transaction (MCD mode). +

                                                                                                                                                                                                                                                                                                                                            originIssuer?: string

                                                                                                                                                                                                                                                                                                                                            The OIDC issuer URL for this transaction (MCD mode). Stored alongside originDomain for validation.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            responseType: RESPONSE_TYPES
                                                                                                                                                                                                                                                                                                                                            returnTo: string
                                                                                                                                                                                                                                                                                                                                            scope?: string

                                                                                                                                                                                                                                                                                                                                            The scope requested for this transaction.

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            state: string
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            responseType: RESPONSE_TYPES
                                                                                                                                                                                                                                                                                                                                            returnTo: string
                                                                                                                                                                                                                                                                                                                                            scope?: string

                                                                                                                                                                                                                                                                                                                                            The scope requested for this transaction.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            state: string
                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.TransactionStoreOptions.html b/docs/interfaces/types.TransactionStoreOptions.html index d553a537b..549b97bcd 100644 --- a/docs/interfaces/types.TransactionStoreOptions.html +++ b/docs/interfaces/types.TransactionStoreOptions.html @@ -1,10 +1,10 @@ -TransactionStoreOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface TransactionStoreOptions

                                                                                                                                                                                                                                                                                                                                              interface TransactionStoreOptions {
                                                                                                                                                                                                                                                                                                                                                  cookieOptions?: TransactionCookieOptions;
                                                                                                                                                                                                                                                                                                                                                  enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                                                                                                                                  secret: string;
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              cookieOptions? +TransactionStoreOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface TransactionStoreOptions

                                                                                                                                                                                                                                                                                                                                                interface TransactionStoreOptions {
                                                                                                                                                                                                                                                                                                                                                    cookieOptions?: TransactionCookieOptions;
                                                                                                                                                                                                                                                                                                                                                    enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                                                                                                                                    secret: string;
                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                cookieOptions?: TransactionCookieOptions
                                                                                                                                                                                                                                                                                                                                                enableParallelTransactions?: boolean

                                                                                                                                                                                                                                                                                                                                                Controls whether multiple parallel login transactions are allowed. +

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                cookieOptions?: TransactionCookieOptions
                                                                                                                                                                                                                                                                                                                                                enableParallelTransactions?: boolean

                                                                                                                                                                                                                                                                                                                                                Controls whether multiple parallel login transactions are allowed. When false, only one transaction cookie is maintained at a time. When true (default), multiple transaction cookies can coexist for multi-tab support.

                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                secret: string
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                secret: string
                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.User.html b/docs/interfaces/types.User.html index 92bd15969..c6ac3944d 100644 --- a/docs/interfaces/types.User.html +++ b/docs/interfaces/types.User.html @@ -1,4 +1,4 @@ -User | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface User

                                                                                                                                                                                                                                                                                                                                                  interface User {
                                                                                                                                                                                                                                                                                                                                                      email?: string;
                                                                                                                                                                                                                                                                                                                                                      email_verified?: boolean;
                                                                                                                                                                                                                                                                                                                                                      family_name?: string;
                                                                                                                                                                                                                                                                                                                                                      given_name?: string;
                                                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                                                      nickname?: string;
                                                                                                                                                                                                                                                                                                                                                      org_id?: string;
                                                                                                                                                                                                                                                                                                                                                      picture?: string;
                                                                                                                                                                                                                                                                                                                                                      sub: string;
                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  email? +User | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Interface User

                                                                                                                                                                                                                                                                                                                                                    interface User {
                                                                                                                                                                                                                                                                                                                                                        email?: string;
                                                                                                                                                                                                                                                                                                                                                        email_verified?: boolean;
                                                                                                                                                                                                                                                                                                                                                        family_name?: string;
                                                                                                                                                                                                                                                                                                                                                        given_name?: string;
                                                                                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                                                                                        nickname?: string;
                                                                                                                                                                                                                                                                                                                                                        org_id?: string;
                                                                                                                                                                                                                                                                                                                                                        picture?: string;
                                                                                                                                                                                                                                                                                                                                                        sub: string;
                                                                                                                                                                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                    • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    email?: string
                                                                                                                                                                                                                                                                                                                                                    email_verified?: boolean
                                                                                                                                                                                                                                                                                                                                                    family_name?: string
                                                                                                                                                                                                                                                                                                                                                    given_name?: string
                                                                                                                                                                                                                                                                                                                                                    name?: string
                                                                                                                                                                                                                                                                                                                                                    nickname?: string
                                                                                                                                                                                                                                                                                                                                                    org_id?: string

                                                                                                                                                                                                                                                                                                                                                    The organization ID that the user belongs to. +

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    email?: string
                                                                                                                                                                                                                                                                                                                                                    email_verified?: boolean
                                                                                                                                                                                                                                                                                                                                                    family_name?: string
                                                                                                                                                                                                                                                                                                                                                    given_name?: string
                                                                                                                                                                                                                                                                                                                                                    name?: string
                                                                                                                                                                                                                                                                                                                                                    nickname?: string
                                                                                                                                                                                                                                                                                                                                                    org_id?: string

                                                                                                                                                                                                                                                                                                                                                    The organization ID that the user belongs to. This field is populated when the user logs in through an organization.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    picture?: string
                                                                                                                                                                                                                                                                                                                                                    sub: string
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    picture?: string
                                                                                                                                                                                                                                                                                                                                                    sub: string
                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/types.VerifyMfaOptionsBase.html b/docs/interfaces/types.VerifyMfaOptionsBase.html index c9f6eb0a8..ce47c9ca5 100644 --- a/docs/interfaces/types.VerifyMfaOptionsBase.html +++ b/docs/interfaces/types.VerifyMfaOptionsBase.html @@ -1,4 +1,4 @@ -VerifyMfaOptionsBase | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface VerifyMfaOptionsBase

                                                                                                                                                                                                                                                                                                                                                      Base options for MFA verify.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      interface VerifyMfaOptionsBase {
                                                                                                                                                                                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      mfaToken +VerifyMfaOptionsBase | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface VerifyMfaOptionsBase

                                                                                                                                                                                                                                                                                                                                                        Base options for MFA verify.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        interface VerifyMfaOptionsBase {
                                                                                                                                                                                                                                                                                                                                                            mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        mfaToken: string

                                                                                                                                                                                                                                                                                                                                                        Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/types.VerifyMfaWithOobOptions.html b/docs/interfaces/types.VerifyMfaWithOobOptions.html index d4052991e..a0f3dc5c4 100644 --- a/docs/interfaces/types.VerifyMfaWithOobOptions.html +++ b/docs/interfaces/types.VerifyMfaWithOobOptions.html @@ -1,9 +1,9 @@ -VerifyMfaWithOobOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface VerifyMfaWithOobOptions

                                                                                                                                                                                                                                                                                                                                                          Verification with OOB code sent via SMS/Email/Push.

                                                                                                                                                                                                                                                                                                                                                          +VerifyMfaWithOobOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Interface VerifyMfaWithOobOptions

                                                                                                                                                                                                                                                                                                                                                            Verification with OOB code sent via SMS/Email/Push.

                                                                                                                                                                                                                                                                                                                                                            // After calling challenge()
                                                                                                                                                                                                                                                                                                                                                            const challengeResponse = await mfa.challenge({
                                                                                                                                                                                                                                                                                                                                                            mfaToken,
                                                                                                                                                                                                                                                                                                                                                            challengeType: 'oob',
                                                                                                                                                                                                                                                                                                                                                            authenticatorId: 'sms|dev_abc123'
                                                                                                                                                                                                                                                                                                                                                            });

                                                                                                                                                                                                                                                                                                                                                            // User receives code "543210"
                                                                                                                                                                                                                                                                                                                                                            await mfa.verify({
                                                                                                                                                                                                                                                                                                                                                            mfaToken,
                                                                                                                                                                                                                                                                                                                                                            oobCode: challengeResponse.oobCode,
                                                                                                                                                                                                                                                                                                                                                            bindingCode: '543210'
                                                                                                                                                                                                                                                                                                                                                            });
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            interface VerifyMfaWithOobOptions {
                                                                                                                                                                                                                                                                                                                                                                bindingCode: string;
                                                                                                                                                                                                                                                                                                                                                                mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                oobCode: string;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            interface VerifyMfaWithOobOptions {
                                                                                                                                                                                                                                                                                                                                                                bindingCode: string;
                                                                                                                                                                                                                                                                                                                                                                mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                oobCode: string;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            bindingCode: string
                                                                                                                                                                                                                                                                                                                                                            mfaToken: string

                                                                                                                                                                                                                                                                                                                                                            Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            oobCode: string
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            bindingCode: string
                                                                                                                                                                                                                                                                                                                                                            mfaToken: string

                                                                                                                                                                                                                                                                                                                                                            Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            oobCode: string
                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/types.VerifyMfaWithOtpOptions.html b/docs/interfaces/types.VerifyMfaWithOtpOptions.html index 4d66bab43..a1817aae5 100644 --- a/docs/interfaces/types.VerifyMfaWithOtpOptions.html +++ b/docs/interfaces/types.VerifyMfaWithOtpOptions.html @@ -1,8 +1,8 @@ -VerifyMfaWithOtpOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface VerifyMfaWithOtpOptions

                                                                                                                                                                                                                                                                                                                                                              Verification with OTP code from authenticator app.

                                                                                                                                                                                                                                                                                                                                                              +VerifyMfaWithOtpOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Interface VerifyMfaWithOtpOptions

                                                                                                                                                                                                                                                                                                                                                                Verification with OTP code from authenticator app.

                                                                                                                                                                                                                                                                                                                                                                import { mfa } from '@auth0/nextjs-auth0/client';

                                                                                                                                                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                                                                                                                                                await mfa.verify({
                                                                                                                                                                                                                                                                                                                                                                mfaToken: encryptedToken,
                                                                                                                                                                                                                                                                                                                                                                otp: '123456' // From Google Authenticator
                                                                                                                                                                                                                                                                                                                                                                });
                                                                                                                                                                                                                                                                                                                                                                // User authenticated, access token in session
                                                                                                                                                                                                                                                                                                                                                                } catch (error) {
                                                                                                                                                                                                                                                                                                                                                                if (error instanceof MfaVerifyError) {
                                                                                                                                                                                                                                                                                                                                                                console.error('Invalid OTP code');
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                interface VerifyMfaWithOtpOptions {
                                                                                                                                                                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                    otp: string;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                interface VerifyMfaWithOtpOptions {
                                                                                                                                                                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                    otp: string;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                                                                                                                                                                                Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                otp: string
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                otp: string
                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html b/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html index 85609b13b..190ca0aea 100644 --- a/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html +++ b/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html @@ -1,8 +1,8 @@ -VerifyMfaWithRecoveryCodeOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                  Verification with recovery code (backup).

                                                                                                                                                                                                                                                                                                                                                                  +VerifyMfaWithRecoveryCodeOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Interface VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                    Verification with recovery code (backup).

                                                                                                                                                                                                                                                                                                                                                                    // Using recovery code from enrollment
                                                                                                                                                                                                                                                                                                                                                                    await mfa.verify({
                                                                                                                                                                                                                                                                                                                                                                    mfaToken,
                                                                                                                                                                                                                                                                                                                                                                    recoveryCode: 'ABCD-EFGH-IJKL-MNOP'
                                                                                                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                                                                                                    // Recovery code is single-use and invalidated after verification
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    interface VerifyMfaWithRecoveryCodeOptions {
                                                                                                                                                                                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                        recoveryCode: string;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    interface VerifyMfaWithRecoveryCodeOptions {
                                                                                                                                                                                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                        recoveryCode: string;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    mfaToken: string

                                                                                                                                                                                                                                                                                                                                                                    Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    recoveryCode: string
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    recoveryCode: string
                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/modules.html b/docs/modules.html index 07905d8d5..56cdd0bb4 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -@auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0

                                                                                                                                                                                                                                                                                                                                                                        Modules

                                                                                                                                                                                                                                                                                                                                                                        client
                                                                                                                                                                                                                                                                                                                                                                        errors
                                                                                                                                                                                                                                                                                                                                                                        server
                                                                                                                                                                                                                                                                                                                                                                        testing
                                                                                                                                                                                                                                                                                                                                                                        types
                                                                                                                                                                                                                                                                                                                                                                        +@auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                            Modules

                                                                                                                                                                                                                                                                                                                                                                            client
                                                                                                                                                                                                                                                                                                                                                                            errors
                                                                                                                                                                                                                                                                                                                                                                            server
                                                                                                                                                                                                                                                                                                                                                                            testing
                                                                                                                                                                                                                                                                                                                                                                            types
                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/modules/client.html b/docs/modules/client.html index cd565828b..a80f9125c 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1 +1 @@ -client | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                              +client | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/modules/errors.html b/docs/modules/errors.html index 82e270646..22029a383 100644 --- a/docs/modules/errors.html +++ b/docs/modules/errors.html @@ -1 +1 @@ -errors | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                  +errors | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/modules/server.html b/docs/modules/server.html index b86fa602a..907f8897a 100644 --- a/docs/modules/server.html +++ b/docs/modules/server.html @@ -1 +1 @@ -server | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                      +server | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/modules/testing.html b/docs/modules/testing.html index 3ba9fd8fa..29be8dfe8 100644 --- a/docs/modules/testing.html +++ b/docs/modules/testing.html @@ -1 +1 @@ -testing | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                          +testing | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/modules/types.html b/docs/modules/types.html index f5fc15b6d..1dc0f05f1 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1 +1 @@ -types | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                              +types | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/client.WithPageAuthRequired.html b/docs/types/client.WithPageAuthRequired.html index 4ea288536..2c2354a54 100644 --- a/docs/types/client.WithPageAuthRequired.html +++ b/docs/types/client.WithPageAuthRequired.html @@ -1,6 +1,6 @@ -WithPageAuthRequired | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                                  WithPageAuthRequired: <P extends object>(
                                                                                                                                                                                                                                                                                                                                                                                                      Component: ComponentType<P & UserProps>,
                                                                                                                                                                                                                                                                                                                                                                                                      options?: WithPageAuthRequiredOptions,
                                                                                                                                                                                                                                                                                                                                                                                                  ) => React.FC<P>
                                                                                                                                                                                                                                                                                                                                                                                                  const MyProtectedPage = withPageAuthRequired(MyPage);
                                                                                                                                                                                                                                                                                                                                                                                                  +WithPageAuthRequired | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                                    WithPageAuthRequired: <P extends object>(
                                                                                                                                                                                                                                                                                                                                                                                                        Component: ComponentType<P & UserProps>,
                                                                                                                                                                                                                                                                                                                                                                                                        options?: WithPageAuthRequiredOptions,
                                                                                                                                                                                                                                                                                                                                                                                                    ) => React.FC<P>
                                                                                                                                                                                                                                                                                                                                                                                                    const MyProtectedPage = withPageAuthRequired(MyPage);
                                                                                                                                                                                                                                                                                                                                                                                                     

                                                                                                                                                                                                                                                                                                                                                                                                    When you wrap your pages in this higher order component and an anonymous user visits your page, they will be redirected to the login page and then returned to the page they were redirected from (after login).

                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/server.AppRouterPageRoute.html b/docs/types/server.AppRouterPageRoute.html index 1532c07ce..40214452a 100644 --- a/docs/types/server.AppRouterPageRoute.html +++ b/docs/types/server.AppRouterPageRoute.html @@ -1,8 +1,8 @@ -AppRouterPageRoute | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                      AppRouterPageRoute: (obj: P) => Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                      An app route that has been augmented with WithPageAuthRequired. +AppRouterPageRoute | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                        AppRouterPageRoute: (obj: P) => Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                        An app route that has been augmented with WithPageAuthRequired. Returns any to be compatible with React's return types while avoiding React dependency.

                                                                                                                                                                                                                                                                                                                                                                                                        The generic parameter P allows passing Next.js PageProps or LayoutProps types for strongly-typed route parameters:

                                                                                                                                                                                                                                                                                                                                                                                                        export default auth0.withPageAuthRequired(
                                                                                                                                                                                                                                                                                                                                                                                                        async function Page(props: PageProps<"/customers/[id]/details">) {
                                                                                                                                                                                                                                                                                                                                                                                                        const { id } = await props.params;
                                                                                                                                                                                                                                                                                                                                                                                                        return <div>{id}</div>;
                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                        );
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                          • (obj: P): Promise<any>
                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • obj: P

                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                          • (obj: P): Promise<any>
                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • obj: P

                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/server.AppRouterPageRouteOpts.html b/docs/types/server.AppRouterPageRouteOpts.html index b84d8cd30..873482772 100644 --- a/docs/types/server.AppRouterPageRouteOpts.html +++ b/docs/types/server.AppRouterPageRouteOpts.html @@ -1,4 +1,4 @@ -AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AppRouterPageRouteOpts

                                                                                                                                                                                                                                                                                                                                                                                                          Objects containing the route parameters and search parameters of the page.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          type AppRouterPageRouteOpts = {
                                                                                                                                                                                                                                                                                                                                                                                                              params?: Promise<Record<string, string | string[]>>;
                                                                                                                                                                                                                                                                                                                                                                                                              searchParams?: Promise<{ [key: string]: string | string[] | undefined }>;
                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          params? +AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AppRouterPageRouteOpts

                                                                                                                                                                                                                                                                                                                                                                                                            Objects containing the route parameters and search parameters of the page.

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            type AppRouterPageRouteOpts = {
                                                                                                                                                                                                                                                                                                                                                                                                                params?: Promise<Record<string, string | string[]>>;
                                                                                                                                                                                                                                                                                                                                                                                                                searchParams?: Promise<{ [key: string]: string | string[] | undefined }>;
                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            params?: Promise<Record<string, string | string[]>>
                                                                                                                                                                                                                                                                                                                                                                                                            searchParams?: Promise<{ [key: string]: string | string[] | undefined }>
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            params?: Promise<Record<string, string | string[]>>
                                                                                                                                                                                                                                                                                                                                                                                                            searchParams?: Promise<{ [key: string]: string | string[] | undefined }>
                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/server.GetServerSidePropsResultWithSession.html b/docs/types/server.GetServerSidePropsResultWithSession.html index 4ff0818c0..8d012f20f 100644 --- a/docs/types/server.GetServerSidePropsResultWithSession.html +++ b/docs/types/server.GetServerSidePropsResultWithSession.html @@ -1,6 +1,6 @@ -GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias GetServerSidePropsResultWithSession<P>

                                                                                                                                                                                                                                                                                                                                                                                                              GetServerSidePropsResultWithSession: GetServerSidePropsResult<
                                                                                                                                                                                                                                                                                                                                                                                                                  P & { user: User },
                                                                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                                                                              If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with +GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias GetServerSidePropsResultWithSession<P>

                                                                                                                                                                                                                                                                                                                                                                                                                GetServerSidePropsResultWithSession: GetServerSidePropsResult<
                                                                                                                                                                                                                                                                                                                                                                                                                    P & { user: User },
                                                                                                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                                                                                                If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with the user property, which will be the User object.

                                                                                                                                                                                                                                                                                                                                                                                                                // pages/profile.js
                                                                                                                                                                                                                                                                                                                                                                                                                import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                export default function Profile({ user }) {
                                                                                                                                                                                                                                                                                                                                                                                                                return <div>Hello {user.name}</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                export const getServerSideProps = auth0.withPageAuthRequired();
                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                • P = any
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                • P = any
                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/server.PageRoute.html b/docs/types/server.PageRoute.html index 67afb03de..d835362b0 100644 --- a/docs/types/server.PageRoute.html +++ b/docs/types/server.PageRoute.html @@ -1,2 +1,2 @@ -PageRoute | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                  PageRoute: (
                                                                                                                                                                                                                                                                                                                                                                                                                      ctx: GetServerSidePropsContext<Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                  ) => Promise<GetServerSidePropsResultWithSession<P>>

                                                                                                                                                                                                                                                                                                                                                                                                                  A page route that has been augmented with WithPageAuthRequired.

                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • P
                                                                                                                                                                                                                                                                                                                                                                                                                  • Q extends ParsedUrlQuery = ParsedUrlQuery

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                  +PageRoute | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                    PageRoute: (
                                                                                                                                                                                                                                                                                                                                                                                                                        ctx: GetServerSidePropsContext<Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                    ) => Promise<GetServerSidePropsResultWithSession<P>>

                                                                                                                                                                                                                                                                                                                                                                                                                    A page route that has been augmented with WithPageAuthRequired.

                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                    • P
                                                                                                                                                                                                                                                                                                                                                                                                                    • Q extends ParsedUrlQuery = ParsedUrlQuery

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/server.WithPageAuthRequired.html b/docs/types/server.WithPageAuthRequired.html index 03cf39eab..eb8b203f0 100644 --- a/docs/types/server.WithPageAuthRequired.html +++ b/docs/types/server.WithPageAuthRequired.html @@ -1,3 +1,3 @@ -WithPageAuthRequired | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                                                      Protects Page router pages WithPageAuthRequiredPageRouter or +WithPageAuthRequired | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/server.WithPageAuthRequiredAppRouter.html b/docs/types/server.WithPageAuthRequiredAppRouter.html index 7abc8dd0d..ea25b2598 100644 --- a/docs/types/server.WithPageAuthRequiredAppRouter.html +++ b/docs/types/server.WithPageAuthRequiredAppRouter.html @@ -1,4 +1,4 @@ -WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequiredAppRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                              P extends AppRouterPageRouteOpts = AppRouterPageRouteOpts,
                                                                                                                                                                                                                                                                                                                                                                                                                          >(
                                                                                                                                                                                                                                                                                                                                                                                                                              fn: AppRouterPageRoute<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                              opts?: WithPageAuthRequiredAppRouterOptions<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                          ) => AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                                          Wrap your Server Component with this method to make sure the user is authenticated before +WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                            WithPageAuthRequiredAppRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                P extends AppRouterPageRouteOpts = AppRouterPageRouteOpts,
                                                                                                                                                                                                                                                                                                                                                                                                                            >(
                                                                                                                                                                                                                                                                                                                                                                                                                                fn: AppRouterPageRoute<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                                opts?: WithPageAuthRequiredAppRouterOptions<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                            ) => AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                                            Wrap your Server Component with this method to make sure the user is authenticated before visiting the page.

                                                                                                                                                                                                                                                                                                                                                                                                                            // app/protected-page/page.js
                                                                                                                                                                                                                                                                                                                                                                                                                            import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                            const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage() {
                                                                                                                                                                                                                                                                                                                                                                                                                            return <div>Protected content</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                            }, { returnTo: '/protected-page' });

                                                                                                                                                                                                                                                                                                                                                                                                                            export default ProtectedPage;
                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -14,4 +14,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                            // app/protected-page/[slug]/page.js
                                                                                                                                                                                                                                                                                                                                                                                                                            import { AppRouterPageRouteOpts } from '@auth0/nextjs-auth0/server';
                                                                                                                                                                                                                                                                                                                                                                                                                            import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                            const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage({
                                                                                                                                                                                                                                                                                                                                                                                                                            params, searchParams
                                                                                                                                                                                                                                                                                                                                                                                                                            }: AppRouterPageRouteOpts) {
                                                                                                                                                                                                                                                                                                                                                                                                                            const slug = (await params)?.slug as string;
                                                                                                                                                                                                                                                                                                                                                                                                                            return <div>Protected content for {slug}</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                            }, {
                                                                                                                                                                                                                                                                                                                                                                                                                            returnTo({ params }) {
                                                                                                                                                                                                                                                                                                                                                                                                                            return `/protected-page/${(await params)?.slug}`;
                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                            });

                                                                                                                                                                                                                                                                                                                                                                                                                            export default ProtectedPage;
                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html index 3abdf9e7a..d43e79d96 100644 --- a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html +++ b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html @@ -1,13 +1,13 @@ -WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias WithPageAuthRequiredAppRouterOptions<P>

                                                                                                                                                                                                                                                                                                                                                                                                                              Specify the URL to returnTo - this is important in app router pages because the server component +WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias WithPageAuthRequiredAppRouterOptions<P>

                                                                                                                                                                                                                                                                                                                                                                                                                                Specify the URL to returnTo - this is important in app router pages because the server component won't know the URL of the page. *

                                                                                                                                                                                                                                                                                                                                                                                                                                type WithPageAuthRequiredAppRouterOptions<
                                                                                                                                                                                                                                                                                                                                                                                                                                    P extends AppRouterPageRouteOpts = AppRouterPageRouteOpts,
                                                                                                                                                                                                                                                                                                                                                                                                                                > = {
                                                                                                                                                                                                                                                                                                                                                                                                                                    returnTo?: string | ((obj: P) => Promise<string> | string);
                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                returnTo?: string | ((obj: P) => Promise<string> | string)

                                                                                                                                                                                                                                                                                                                                                                                                                                The URL to redirect the user to after a successful login.

                                                                                                                                                                                                                                                                                                                                                                                                                                • Can be a static string or a function that receives the page props. When used as a function, the generic P ensures that params and searchParams match the specific types of your route (e.g., from Next.js PageProps).
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/server.WithPageAuthRequiredPageRouter.html b/docs/types/server.WithPageAuthRequiredPageRouter.html index af833ec8d..642c4cc48 100644 --- a/docs/types/server.WithPageAuthRequiredPageRouter.html +++ b/docs/types/server.WithPageAuthRequiredPageRouter.html @@ -1,8 +1,8 @@ -WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias WithPageAuthRequiredPageRouter

                                                                                                                                                                                                                                                                                                                                                                                                                                  WithPageAuthRequiredPageRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                      P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                      Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                  >(
                                                                                                                                                                                                                                                                                                                                                                                                                                      opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                  Wrap your getServerSideProps with this method to make sure the user is authenticated before +WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias WithPageAuthRequiredPageRouter

                                                                                                                                                                                                                                                                                                                                                                                                                                    WithPageAuthRequiredPageRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                        P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                        Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                    >(
                                                                                                                                                                                                                                                                                                                                                                                                                                        opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                    Wrap your getServerSideProps with this method to make sure the user is authenticated before visiting the page.

                                                                                                                                                                                                                                                                                                                                                                                                                                    // pages/protected-page.js
                                                                                                                                                                                                                                                                                                                                                                                                                                    import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                                    export default function ProtectedPage() {
                                                                                                                                                                                                                                                                                                                                                                                                                                    return <div>Protected content</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                    export const getServerSideProps = auth0.withPageAuthRequired();

                                                                                                                                                                                                                                                                                                                                                                                                                                    If the user visits /protected-page without a valid session, it will redirect the user to the login page. Then they will be returned to /protected-page after login.

                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html index 1fcd7160f..61edd67a7 100644 --- a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html +++ b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html @@ -1,10 +1,10 @@ -WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                      If you have a custom returnTo url you should specify it in returnTo.

                                                                                                                                                                                                                                                                                                                                                                                                                                      +WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                        If you have a custom returnTo url you should specify it in returnTo.

                                                                                                                                                                                                                                                                                                                                                                                                                                        You can pass in your own getServerSideProps method, the props returned from this will be merged with the user props. You can also access the user session data by calling getSession inside of this method. For example:

                                                                                                                                                                                                                                                                                                                                                                                                                                        // pages/protected-page.js
                                                                                                                                                                                                                                                                                                                                                                                                                                        import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                                        export default function ProtectedPage({ user, customProp }) {
                                                                                                                                                                                                                                                                                                                                                                                                                                        return <div>Protected content</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                        export const getServerSideProps = auth0.withPageAuthRequired({
                                                                                                                                                                                                                                                                                                                                                                                                                                        // returnTo: '/unauthorized',
                                                                                                                                                                                                                                                                                                                                                                                                                                        async getServerSideProps(ctx) {
                                                                                                                                                                                                                                                                                                                                                                                                                                        // access the user session if needed
                                                                                                                                                                                                                                                                                                                                                                                                                                        // const session = await auth0.getSession(ctx.req);
                                                                                                                                                                                                                                                                                                                                                                                                                                        return {
                                                                                                                                                                                                                                                                                                                                                                                                                                        props: {
                                                                                                                                                                                                                                                                                                                                                                                                                                        // customProp: 'bar',
                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        type WithPageAuthRequiredPageRouterOptions<
                                                                                                                                                                                                                                                                                                                                                                                                                                            P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                            Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                        > = {
                                                                                                                                                                                                                                                                                                                                                                                                                                            getServerSideProps?: GetServerSideProps<P, Q>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • P extends { [key: string]: any } = { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Q extends ParsedUrlQuery = ParsedUrlQuery
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        type WithPageAuthRequiredPageRouterOptions<
                                                                                                                                                                                                                                                                                                                                                                                                                                            P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                            Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                        > = {
                                                                                                                                                                                                                                                                                                                                                                                                                                            getServerSideProps?: GetServerSideProps<P, Q>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • P extends { [key: string]: any } = { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Q extends ParsedUrlQuery = ParsedUrlQuery
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        getServerSideProps?: GetServerSideProps<P, Q>
                                                                                                                                                                                                                                                                                                                                                                                                                                        returnTo?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        getServerSideProps?: GetServerSideProps<P, Q>
                                                                                                                                                                                                                                                                                                                                                                                                                                        returnTo?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/testing.GenerateSessionCookieConfig.html b/docs/types/testing.GenerateSessionCookieConfig.html index b8d909735..0df346466 100644 --- a/docs/types/testing.GenerateSessionCookieConfig.html +++ b/docs/types/testing.GenerateSessionCookieConfig.html @@ -1,4 +1,4 @@ -GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias GenerateSessionCookieConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                          type GenerateSessionCookieConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                              secret: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          secret +GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias GenerateSessionCookieConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                            type GenerateSessionCookieConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                secret: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            secret: string

                                                                                                                                                                                                                                                                                                                                                                                                                                            The secret used to derive an encryption key for the session cookie.

                                                                                                                                                                                                                                                                                                                                                                                                                                            IMPORTANT: you must use the same value as in the SDK configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/types.BeforeSessionSavedHook.html b/docs/types/types.BeforeSessionSavedHook.html index 79ad3740c..994d873f6 100644 --- a/docs/types/types.BeforeSessionSavedHook.html +++ b/docs/types/types.BeforeSessionSavedHook.html @@ -1 +1 @@ -BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias BeforeSessionSavedHook

                                                                                                                                                                                                                                                                                                                                                                                                                                              BeforeSessionSavedHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                  session: SessionData,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  idToken: string | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<SessionData>

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                              +BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias BeforeSessionSavedHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                BeforeSessionSavedHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                    session: SessionData,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    idToken: string | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => Promise<SessionData>

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/types.DomainResolver.html b/docs/types/types.DomainResolver.html index b69593323..341e734d5 100644 --- a/docs/types/types.DomainResolver.html +++ b/docs/types/types.DomainResolver.html @@ -1,4 +1,4 @@ -DomainResolver | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias DomainResolver

                                                                                                                                                                                                                                                                                                                                                                                                                                                  DomainResolver: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                      config: { headers: Headers; url?: URL },
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => Promise<string> | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Resolves the Auth0 domain from request context. +DomainResolver | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias DomainResolver

                                                                                                                                                                                                                                                                                                                                                                                                                                                    DomainResolver: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                        config: { headers: Headers; url?: URL },
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => Promise<string> | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Resolves the Auth0 domain from request context. Called once per SDK operation in resolver mode.

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Supports both synchronous and asynchronous resolution patterns.

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • (config: { headers: Headers; url?: URL }): Promise<string> | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • config: { headers: Headers; url?: URL }
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • headers: Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Request headers from the current context. @@ -22,4 +22,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Database lookup (B2B SaaS)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            const auth0 = new Auth0Client({
                                                                                                                                                                                                                                                                                                                                                                                                                                                            domain: async ({ headers }) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                            const tenantId = headers.get("x-tenant-id");
                                                                                                                                                                                                                                                                                                                                                                                                                                                            const domain = await db.getAuth0Domain(tenantId);
                                                                                                                                                                                                                                                                                                                                                                                                                                                            if (!domain) throw new Error(`Unknown tenant: ${tenantId}`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                            return domain;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                            });

                                                                                                                                                                                                                                                                                                                                                                                                                                                            @public
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/types.EnrollOptions.html b/docs/types/types.EnrollOptions.html index b4768844a..5d5f79a81 100644 --- a/docs/types/types.EnrollOptions.html +++ b/docs/types/types.EnrollOptions.html @@ -1,2 +1,2 @@ -EnrollOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EnrollOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                      MFA enrollment options (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +EnrollOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EnrollOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        MFA enrollment options (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/types.EnrollmentResponse.html b/docs/types/types.EnrollmentResponse.html index 9cf83ad0e..359c8b818 100644 --- a/docs/types/types.EnrollmentResponse.html +++ b/docs/types/types.EnrollmentResponse.html @@ -1,2 +1,2 @@ -EnrollmentResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                          MFA enrollment response (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +EnrollmentResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                            EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                            MFA enrollment response (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/types.GetAccessTokenOptions.html b/docs/types/types.GetAccessTokenOptions.html index 77be8bbd6..0cc443172 100644 --- a/docs/types/types.GetAccessTokenOptions.html +++ b/docs/types/types.GetAccessTokenOptions.html @@ -1,7 +1,7 @@ -GetAccessTokenOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias GetAccessTokenOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                              type GetAccessTokenOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  audience?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  refresh?: boolean | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                              audience? +GetAccessTokenOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias GetAccessTokenOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                type GetAccessTokenOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    audience?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    refresh?: boolean | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scope?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                audience?: string | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                refresh?: boolean | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                scope?: string | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                refresh?: boolean | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                scope?: string | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/types.LogoutStrategy.html b/docs/types/types.LogoutStrategy.html index 0c7d72417..53cdbdd85 100644 --- a/docs/types/types.LogoutStrategy.html +++ b/docs/types/types.LogoutStrategy.html @@ -1,2 +1,2 @@ -LogoutStrategy | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias LogoutStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  LogoutStrategy: "auto" | "oidc" | "v2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Logout strategy options for controlling logout endpoint selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +LogoutStrategy | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias LogoutStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LogoutStrategy: "auto" | "oidc" | "v2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Logout strategy options for controlling logout endpoint selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/types.LogoutToken.html b/docs/types/types.LogoutToken.html index 136b60167..513205065 100644 --- a/docs/types/types.LogoutToken.html +++ b/docs/types/types.LogoutToken.html @@ -1,4 +1,4 @@ -LogoutToken | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias LogoutToken

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type LogoutToken = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iss?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sid?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sub?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      iss? +LogoutToken | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias LogoutToken

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type LogoutToken = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            iss?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sid?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sub?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        iss?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sid?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sub?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        iss?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sid?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sub?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/types.OnCallbackContext.html b/docs/types/types.OnCallbackContext.html index 144ffa06e..c385e8518 100644 --- a/docs/types/types.OnCallbackContext.html +++ b/docs/types/types.OnCallbackContext.html @@ -1,10 +1,10 @@ -OnCallbackContext | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OnCallbackContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type OnCallbackContext = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              appBaseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectedAccount?: CompleteConnectAccountResponse;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              responseType?: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          appBaseUrl? +OnCallbackContext | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias OnCallbackContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type OnCallbackContext = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                appBaseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connectedAccount?: CompleteConnectAccountResponse;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                responseType?: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            appBaseUrl?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The resolved base URL for the current request, used to build safe redirects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectedAccount?: CompleteConnectAccountResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The connected account information when the responseType is RESPONSE_TYPES.CONNECT_CODE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            responseType?: RESPONSE_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The type of response expected from the authorization server. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectedAccount?: CompleteConnectAccountResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The connected account information when the responseType is RESPONSE_TYPES.CONNECT_CODE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            responseType?: RESPONSE_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The type of response expected from the authorization server. One of RESPONSE_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            returnTo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The URL or path the user should be redirected to after completing the transaction.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            returnTo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The URL or path the user should be redirected to after completing the transaction.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/types.OnCallbackHook.html b/docs/types/types.OnCallbackHook.html index d2d1a518f..84588280a 100644 --- a/docs/types/types.OnCallbackHook.html +++ b/docs/types/types.OnCallbackHook.html @@ -1 +1 @@ -OnCallbackHook | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias OnCallbackHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              OnCallbackHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  error: SdkError | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx: OnCallbackContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  session: SessionData | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<NextResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +OnCallbackHook | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias OnCallbackHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OnCallbackHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error: SdkError | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ctx: OnCallbackContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    session: SessionData | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => Promise<NextResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/types.PagesRouterRequest.html b/docs/types/types.PagesRouterRequest.html index cebb83561..1e15a755d 100644 --- a/docs/types/types.PagesRouterRequest.html +++ b/docs/types/types.PagesRouterRequest.html @@ -1 +1 @@ -PagesRouterRequest | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PagesRouterRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PagesRouterRequest: IncomingMessage | NextApiRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +PagesRouterRequest | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PagesRouterRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PagesRouterRequest: IncomingMessage | NextApiRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/types.PagesRouterResponse.html b/docs/types/types.PagesRouterResponse.html index 66ac87d02..d9f219ebd 100644 --- a/docs/types/types.PagesRouterResponse.html +++ b/docs/types/types.PagesRouterResponse.html @@ -1 +1 @@ -PagesRouterResponse | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PagesRouterResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +PagesRouterResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PagesRouterResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/types.ProxyOptions.html b/docs/types/types.ProxyOptions.html index f72ff8567..988af68a3 100644 --- a/docs/types/types.ProxyOptions.html +++ b/docs/types/types.ProxyOptions.html @@ -1,5 +1,5 @@ -ProxyOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ProxyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type ProxyOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              audience: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              proxyPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scope: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              targetBaseUrl: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          audience +ProxyOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ProxyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type ProxyOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                audience: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                proxyPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scope: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                targetBaseUrl: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            audience: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            proxyPath: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scope: string | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            targetBaseUrl: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            audience: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            proxyPath: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scope: string | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            targetBaseUrl: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/types.ReadonlyRequestCookies.html b/docs/types/types.ReadonlyRequestCookies.html index af985984e..49a1521be 100644 --- a/docs/types/types.ReadonlyRequestCookies.html +++ b/docs/types/types.ReadonlyRequestCookies.html @@ -1 +1 @@ -ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ReadonlyRequestCookies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ResponseCookies,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "set"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "delete",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ReadonlyRequestCookies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponseCookies,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "set"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "delete",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/types.RoutesOptions.html b/docs/types/types.RoutesOptions.html index d37dc2df4..1a8cedd94 100644 --- a/docs/types/types.RoutesOptions.html +++ b/docs/types/types.RoutesOptions.html @@ -1 +1 @@ -RoutesOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias RoutesOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  RoutesOptions: Partial<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Routes,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "login"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "callback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "logout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "backChannelLogout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "connectAccount",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +RoutesOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RoutesOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RoutesOptions: Partial<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Routes,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "login"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "callback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "logout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "backChannelLogout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "connectAccount",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/types.VerifyMfaOptions.html b/docs/types/types.VerifyMfaOptions.html index 0a1239aee..9ca004d3d 100644 --- a/docs/types/types.VerifyMfaOptions.html +++ b/docs/types/types.VerifyMfaOptions.html @@ -1,2 +1,2 @@ -VerifyMfaOptions | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias VerifyMfaOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      VerifyMfaOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | VerifyMfaWithOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | VerifyMfaWithOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MFA verification options (union type).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +VerifyMfaOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias VerifyMfaOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        VerifyMfaOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | VerifyMfaWithOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | VerifyMfaWithOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        MFA verification options (union type).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/variables/client.mfa.html b/docs/variables/client.mfa.html index ad2f74e07..52f4927bb 100644 --- a/docs/variables/client.mfa.html +++ b/docs/variables/client.mfa.html @@ -1,5 +1,5 @@ -mfa | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable mfaConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mfa: MfaClient = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Client-side MFA API singleton.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +mfa | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable mfaConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mfa: MfaClient = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Client-side MFA API singleton.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import { mfa } from '@auth0/nextjs-auth0/client';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // List authenticators
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const authenticators = await mfa.getAuthenticators({ mfaToken });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Initiate challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const challenge = await mfa.challenge({ mfaToken, challengeType: 'oob' });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Verify and complete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const tokens = await mfa.verify({ mfaToken, otp: '123456' });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/variables/client.withPageAuthRequired.html b/docs/variables/client.withPageAuthRequired.html index d553a26b8..84ae163e6 100644 --- a/docs/variables/client.withPageAuthRequired.html +++ b/docs/variables/client.withPageAuthRequired.html @@ -1 +1 @@ -withPageAuthRequired | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable withPageAuthRequiredConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              withPageAuthRequired: WithPageAuthRequired = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +withPageAuthRequired | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable withPageAuthRequiredConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                withPageAuthRequired: WithPageAuthRequired = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html index 86d7a163f..09b9e15ea 100644 --- a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html +++ b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html @@ -1,2 +1,2 @@ -DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable DEFAULT_ID_TOKEN_CLAIMSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DEFAULT_ID_TOKEN_CLAIMS: string[] = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default claims for the ID token.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable DEFAULT_ID_TOKEN_CLAIMSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DEFAULT_ID_TOKEN_CLAIMS: string[] = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Default claims for the ID token.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html b/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html index 03fd1b4f0..c38a145dc 100644 --- a/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html +++ b/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html @@ -1,3 +1,3 @@ -GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable GRANT_TYPE_CUSTOM_TOKEN_EXCHANGEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE: "urn:ietf:params:oauth:grant-type:token-exchange"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Grant type for Custom Token Exchange as per RFC 8693.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable GRANT_TYPE_CUSTOM_TOKEN_EXCHANGEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE: "urn:ietf:params:oauth:grant-type:token-exchange"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Grant type for Custom Token Exchange as per RFC 8693.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/variables/types.GRANT_TYPE_MFA_OOB.html b/docs/variables/types.GRANT_TYPE_MFA_OOB.html index 75ae6f953..142c78511 100644 --- a/docs/variables/types.GRANT_TYPE_MFA_OOB.html +++ b/docs/variables/types.GRANT_TYPE_MFA_OOB.html @@ -1,3 +1,3 @@ -GRANT_TYPE_MFA_OOB | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable GRANT_TYPE_MFA_OOBConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GRANT_TYPE_MFA_OOB: "http://auth0.com/oauth/grant-type/mfa-oob"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Grant type for MFA OOB (SMS/Email/Push) verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +GRANT_TYPE_MFA_OOB | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable GRANT_TYPE_MFA_OOBConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GRANT_TYPE_MFA_OOB: "http://auth0.com/oauth/grant-type/mfa-oob"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Grant type for MFA OOB (SMS/Email/Push) verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/variables/types.GRANT_TYPE_MFA_OTP.html b/docs/variables/types.GRANT_TYPE_MFA_OTP.html index 2b71fb14e..c33cb70ec 100644 --- a/docs/variables/types.GRANT_TYPE_MFA_OTP.html +++ b/docs/variables/types.GRANT_TYPE_MFA_OTP.html @@ -1,4 +1,4 @@ -GRANT_TYPE_MFA_OTP | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable GRANT_TYPE_MFA_OTPConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GRANT_TYPE_MFA_OTP: "http://auth0.com/oauth/grant-type/mfa-otp"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Grant type for MFA token exchange. +GRANT_TYPE_MFA_OTP | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable GRANT_TYPE_MFA_OTPConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GRANT_TYPE_MFA_OTP: "http://auth0.com/oauth/grant-type/mfa-otp"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Grant type for MFA token exchange. Used in token endpoint requests to exchange an mfa_token for access/refresh tokens.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html b/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html index 1fb35a411..d39704606 100644 --- a/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html +++ b/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html @@ -1,3 +1,3 @@ -GRANT_TYPE_MFA_RECOVERY_CODE | @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable GRANT_TYPE_MFA_RECOVERY_CODEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GRANT_TYPE_MFA_RECOVERY_CODE: "http://auth0.com/oauth/grant-type/mfa-recovery-code"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Grant type for MFA recovery code verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +GRANT_TYPE_MFA_RECOVERY_CODE | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable GRANT_TYPE_MFA_RECOVERY_CODEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GRANT_TYPE_MFA_RECOVERY_CODE: "http://auth0.com/oauth/grant-type/mfa-recovery-code"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Grant type for MFA recovery code verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/package.json b/package.json index 88c484278..283b3912f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/nextjs-auth0", - "version": "4.17.0", + "version": "4.18.0", "description": "Auth0 Next.js SDK", "type": "module", "scripts": {