Release/v3.6.0 (#1877)

auth0 · Jan 31, 2025 · 51ae671 · 51ae671
2 parents 2199a20 + 6d31bb0
commit 51ae671
Show file tree

Hide file tree

Showing 175 changed files with 327 additions and 326 deletions.
diff --git a/.version b/.version
@@ -1 +1 @@
-v3.5.0
+v3.6.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Change Log
 
+## [v3.6.0](https://github.com/auth0/nextjs-auth0/tree/v3.6.0) (2025-01-31)
+This is a maintainance release for V3 of the SDK.  
+V4 supports Next.JS 15 and React 19 and is published on [npm](https://www.npmjs.com/package/@auth0/nextjs-auth0)!  
+We will continue to add features and security upgrades in V4 going further. Please migrate to V4 for a better experience.
+
+
+**Security**
+- [bump jshttp/cookie from 0.6.0 to 0.7.1](https://github.com/auth0/nextjs-auth0/pull/1778)
+
 ## [v3.5.0](https://github.com/auth0/nextjs-auth0/tree/v3.5.0) (2023-12-06)
 [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v3.4.0...v3.5.0)
 

diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -11,6 +11,7 @@
     --light-color-text-aside: #6e6e6e;
     --light-color-link: #1f70c2;
 
+    --light-color-ts-keyword: #056bd6;
     --light-color-ts-project: #b111c9;
     --light-color-ts-module: var(--light-color-ts-project);
     --light-color-ts-namespace: var(--light-color-ts-project);
@@ -50,6 +51,7 @@
     --dark-color-text-aside: #dddddd;
     --dark-color-link: #00aff4;
 
+    --dark-color-ts-keyword: #3399ff;
     --dark-color-ts-project: #e358ff;
     --dark-color-ts-module: var(--dark-color-ts-project);
     --dark-color-ts-namespace: var(--dark-color-ts-project);
@@ -91,6 +93,7 @@
         --color-text-aside: var(--light-color-text-aside);
         --color-link: var(--light-color-link);
 
+        --color-ts-keyword: var(--light-color-ts-keyword);
         --color-ts-module: var(--light-color-ts-module);
         --color-ts-namespace: var(--light-color-ts-namespace);
         --color-ts-enum: var(--light-color-ts-enum);
@@ -132,6 +135,7 @@
         --color-text-aside: var(--dark-color-text-aside);
         --color-link: var(--dark-color-link);
 
+        --color-ts-keyword: var(--dark-color-ts-keyword);
         --color-ts-module: var(--dark-color-ts-module);
         --color-ts-namespace: var(--dark-color-ts-namespace);
         --color-ts-enum: var(--dark-color-ts-enum);
@@ -180,6 +184,7 @@ body {
     --color-text-aside: var(--light-color-text-aside);
     --color-link: var(--light-color-link);
 
+    --color-ts-keyword: var(--light-color-ts-keyword);
     --color-ts-module: var(--light-color-ts-module);
     --color-ts-namespace: var(--light-color-ts-namespace);
     --color-ts-enum: var(--light-color-ts-enum);
@@ -219,6 +224,7 @@ body {
     --color-text-aside: var(--dark-color-text-aside);
     --color-link: var(--dark-color-link);
 
+    --color-ts-keyword: var(--dark-color-ts-keyword);
     --color-ts-module: var(--dark-color-ts-module);
     --color-ts-namespace: var(--dark-color-ts-namespace);
     --color-ts-enum: var(--dark-color-ts-enum);
@@ -984,6 +990,11 @@ a.tsd-index-link {
     overflow-x: auto;
 }
 
+.tsd-signature-keyword {
+    color: var(--color-ts-keyword);
+    font-weight: normal;
+}
+
 .tsd-signature-symbol {
     color: var(--color-text-aside);
     font-weight: normal;

diff --git a/docs/classes/client_use_user.RequestError.html b/docs/classes/client_use_user.RequestError.html
diff --git a/docs/classes/http_auth0_next_api_request.default.html b/docs/classes/http_auth0_next_api_request.default.html
diff --git a/docs/classes/http_auth0_next_api_response.default.html b/docs/classes/http_auth0_next_api_response.default.html
diff --git a/docs/classes/http_auth0_next_request.default.html b/docs/classes/http_auth0_next_request.default.html
diff --git a/docs/classes/http_auth0_next_request_cookies.default.html b/docs/classes/http_auth0_next_request_cookies.default.html
diff --git a/docs/classes/http_auth0_next_response.default.html b/docs/classes/http_auth0_next_response.default.html
diff --git a/docs/classes/http_auth0_next_response_cookies.default.html b/docs/classes/http_auth0_next_response_cookies.default.html
diff --git a/docs/classes/session_session.default.html b/docs/classes/session_session.default.html
diff --git a/docs/classes/utils_errors.AccessTokenError.html b/docs/classes/utils_errors.AccessTokenError.html
diff --git a/docs/classes/utils_errors.AuthError.html b/docs/classes/utils_errors.AuthError.html
diff --git a/docs/classes/utils_errors.CallbackHandlerError.html b/docs/classes/utils_errors.CallbackHandlerError.html
diff --git a/docs/classes/utils_errors.HandlerError.html b/docs/classes/utils_errors.HandlerError.html
diff --git a/docs/classes/utils_errors.LoginHandlerError.html b/docs/classes/utils_errors.LoginHandlerError.html
diff --git a/docs/classes/utils_errors.LogoutHandlerError.html b/docs/classes/utils_errors.LogoutHandlerError.html
diff --git a/docs/classes/utils_errors.ProfileHandlerError.html b/docs/classes/utils_errors.ProfileHandlerError.html
diff --git a/docs/enums/utils_errors.AccessTokenErrorCode.html b/docs/enums/utils_errors.AccessTokenErrorCode.html
diff --git a/docs/functions/client_use_user.default.html b/docs/functions/client_use_user.default.html
diff --git a/docs/functions/client_use_user.useUser.html b/docs/functions/client_use_user.useUser.html
diff --git a/docs/functions/config.configSingletonGetter.html b/docs/functions/config.configSingletonGetter.html
diff --git a/docs/functions/edge.getAccessToken-1.html b/docs/functions/edge.getAccessToken-1.html
diff --git a/docs/functions/edge.getSession-1.html b/docs/functions/edge.getSession-1.html
diff --git a/docs/functions/edge.handleAuth-1.html b/docs/functions/edge.handleAuth-1.html
diff --git a/docs/functions/edge.handleCallback-1.html b/docs/functions/edge.handleCallback-1.html
diff --git a/docs/functions/edge.handleLogin-1.html b/docs/functions/edge.handleLogin-1.html
diff --git a/docs/functions/edge.handleLogout-1.html b/docs/functions/edge.handleLogout-1.html
diff --git a/docs/functions/edge.handleProfile-1.html b/docs/functions/edge.handleProfile-1.html
diff --git a/docs/functions/edge.initAuth0-1.html b/docs/functions/edge.initAuth0-1.html
diff --git a/docs/functions/edge.touchSession-1.html b/docs/functions/edge.touchSession-1.html
diff --git a/docs/functions/edge.updateSession-1.html b/docs/functions/edge.updateSession-1.html
diff --git a/docs/functions/edge.withApiAuthRequired-1.html b/docs/functions/edge.withApiAuthRequired-1.html
diff --git a/docs/functions/edge.withMiddlewareAuthRequired.html b/docs/functions/edge.withMiddlewareAuthRequired.html
diff --git a/docs/functions/edge.withPageAuthRequired-1.html b/docs/functions/edge.withPageAuthRequired-1.html
diff --git a/docs/functions/handlers_router_helpers.getHandler.html b/docs/functions/handlers_router_helpers.getHandler.html
diff --git a/docs/functions/helpers_testing.generateSessionCookie.html b/docs/functions/helpers_testing.generateSessionCookie.html
diff --git a/docs/functions/index.getAccessToken-1.html b/docs/functions/index.getAccessToken-1.html
diff --git a/docs/functions/index.getSession-1.html b/docs/functions/index.getSession-1.html
diff --git a/docs/functions/index.handleAuth-1.html b/docs/functions/index.handleAuth-1.html
diff --git a/docs/functions/index.handleCallback-1.html b/docs/functions/index.handleCallback-1.html
diff --git a/docs/functions/index.handleLogin-1.html b/docs/functions/index.handleLogin-1.html
diff --git a/docs/functions/index.handleLogout-1.html b/docs/functions/index.handleLogout-1.html
diff --git a/docs/functions/index.handleProfile-1.html b/docs/functions/index.handleProfile-1.html
diff --git a/docs/functions/index.initAuth0-1.html b/docs/functions/index.initAuth0-1.html
diff --git a/docs/functions/index.touchSession-1.html b/docs/functions/index.touchSession-1.html
diff --git a/docs/functions/index.updateSession-1.html b/docs/functions/index.updateSession-1.html
diff --git a/docs/functions/index.withApiAuthRequired-1.html b/docs/functions/index.withApiAuthRequired-1.html
diff --git a/docs/functions/index.withPageAuthRequired-1.html b/docs/functions/index.withPageAuthRequired-1.html
diff --git a/docs/functions/init._initAuth.html b/docs/functions/init._initAuth.html
diff --git a/docs/interfaces/client_use_user.UserProfile.html b/docs/interfaces/client_use_user.UserProfile.html
diff --git a/docs/interfaces/client_with_page_auth_required.UserProps.html b/docs/interfaces/client_with_page_auth_required.UserProps.html
diff --git a/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html b/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html
diff --git a/docs/interfaces/config.NextConfig.html b/docs/interfaces/config.NextConfig.html
diff --git a/docs/interfaces/handlers_callback.CallbackOptions.html b/docs/interfaces/handlers_callback.CallbackOptions.html
diff --git a/docs/interfaces/handlers_login.AuthorizationParams.html b/docs/interfaces/handlers_login.AuthorizationParams.html
diff --git a/docs/interfaces/handlers_login.LoginOptions.html b/docs/interfaces/handlers_login.LoginOptions.html
diff --git a/docs/interfaces/handlers_logout.LogoutOptions.html b/docs/interfaces/handlers_logout.LogoutOptions.html
diff --git a/docs/interfaces/session_get_access_token.AccessTokenRequest.html b/docs/interfaces/session_get_access_token.AccessTokenRequest.html
diff --git a/docs/interfaces/session_get_access_token.GetAccessTokenResult.html b/docs/interfaces/session_get_access_token.GetAccessTokenResult.html
diff --git a/docs/interfaces/session_session.Claims.html b/docs/interfaces/session_session.Claims.html
diff --git a/docs/interfaces/shared.Auth0Server.html b/docs/interfaces/shared.Auth0Server.html
diff --git a/docs/modules/client.html b/docs/modules/client.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client | @auth0/nextjs-auth0</title><meta name="description" content="Documentation for @auth0/nextjs-auth0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@auth0/nextjs-auth0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@auth0/nextjs-auth0</a></li><li><a href="client.html">client</a></li></ul><h1>Module client</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/d06d352/src/client/index.ts#L1">client/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="client.html#RequestError" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Request<wbr/>Error</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client | @auth0/nextjs-auth0</title><meta name="description" content="Documentation for @auth0/nextjs-auth0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@auth0/nextjs-auth0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@auth0/nextjs-auth0</a></li><li><a href="client.html">client</a></li></ul><h1>Module client</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5bf3d47/src/client/index.ts#L1">client/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="client.html#RequestError" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Request<wbr/>Error</span></a>
 <a href="client.html#UserProfile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>User<wbr/>Profile</span></a>
 <a href="client.html#UserProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>User<wbr/>Provider</span></a>
 <a href="client.html#UserProviderProps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>User<wbr/>Provider<wbr/>Props</span></a>

diff --git a/docs/modules/client_use_user.html b/docs/modules/client_use_user.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/use-user | @auth0/nextjs-auth0</title><meta name="description" content="Documentation for @auth0/nextjs-auth0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@auth0/nextjs-auth0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@auth0/nextjs-auth0</a></li><li><a href="client_use_user.html">client/use-user</a></li></ul><h1>Module client/use-user</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/d06d352/src/client/use-user.tsx#L1">client/use-user.tsx:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Client</h3><div class="tsd-index-list"><a href="../classes/client_use_user.RequestError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Request<wbr/>Error</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>client/use-user | @auth0/nextjs-auth0</title><meta name="description" content="Documentation for @auth0/nextjs-auth0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@auth0/nextjs-auth0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@auth0/nextjs-auth0</a></li><li><a href="client_use_user.html">client/use-user</a></li></ul><h1>Module client/use-user</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5bf3d47/src/client/use-user.tsx#L1">client/use-user.tsx:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Client</h3><div class="tsd-index-list"><a href="../classes/client_use_user.RequestError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Request<wbr/>Error</span></a>
 <a href="../interfaces/client_use_user.UserProfile.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Profile</span></a>
 <a href="../types/client_use_user.UserContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>User<wbr/>Context</span></a>
 <a href="../types/client_use_user.UserProvider.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>User<wbr/>Provider</span></a>