Release v2.6.0 (#1210)

auth0 · May 12, 2023 · ab50f4c · ab50f4c
2 parents 5989b32 + a43a2c1
commit ab50f4c
Show file tree

Hide file tree

Showing 118 changed files with 428 additions and 442 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## [v2.6.0](https://github.com/auth0/nextjs-auth0/tree/v2.6.0) (2023-05-12)
+[Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v2.5.0...v2.6.0)
+
+**Added**
+- Add prefixed url env for preview deploys on middleware [\#1198](https://github.com/auth0/nextjs-auth0/pull/1198) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [v2.5.0](https://github.com/auth0/nextjs-auth0/tree/v2.5.0) (2023-04-18)
 [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v2.4.0...v2.5.0)
 

diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -51,13 +51,13 @@
     --dark-color-text-aside: #dddddd;
     --dark-color-link: #00aff4;
 
-    --dark-color-ts-project: #e14dff;
+    --dark-color-ts-project: #e358ff;
     --dark-color-ts-module: var(--dark-color-ts-project);
     --dark-color-ts-namespace: var(--dark-color-ts-project);
     --dark-color-ts-enum: #f4d93e;
     --dark-color-ts-enum-member: var(--dark-color-ts-enum);
     --dark-color-ts-variable: #798dff;
-    --dark-color-ts-function: #9772ff;
+    --dark-color-ts-function: #a280ff;
     --dark-color-ts-class: #8ac4ff;
     --dark-color-ts-interface: #6cff87;
     --dark-color-ts-constructor: var(--dark-color-ts-class);
@@ -262,6 +262,16 @@ h6 {
     line-height: 1.2;
 }
 
+h1 > a,
+h2 > a,
+h3 > a,
+h4 > a,
+h5 > a,
+h6 > a {
+    text-decoration: none;
+    color: var(--color-text);
+}
+
 h1 {
     font-size: 1.875rem;
     margin: 0.67rem 0;
@@ -296,12 +306,6 @@ h6 {
     text-transform: uppercase;
 }
 
-pre {
-    white-space: pre;
-    white-space: pre-wrap;
-    word-wrap: break-word;
-}
-
 dl,
 menu,
 ol,
@@ -426,13 +430,29 @@ pre {
 }
 
 pre {
+    position: relative;
+    white-space: pre;
+    white-space: pre-wrap;
+    word-wrap: break-word;
     padding: 10px;
-    border: 0.1em solid var(--color-accent);
+    border: 1px solid var(--color-accent);
 }
 pre code {
     padding: 0;
     font-size: 100%;
 }
+pre > button {
+    position: absolute;
+    top: 10px;
+    right: 10px;
+    opacity: 0;
+    transition: opacity 0.1s;
+    box-sizing: border-box;
+}
+pre:hover > button,
+pre > button.visible {
+    opacity: 1;
+}
 
 blockquote {
     margin: 1em 0;
@@ -676,7 +696,12 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 .tsd-navigation.settings {
     margin: 1rem 0;
 }
+.tsd-navigation > a,
+.tsd-navigation .tsd-accordion-summary {
+    width: calc(100% - 0.5rem);
+}
 .tsd-navigation a,
+.tsd-navigation summary > span,
 .tsd-page-navigation a {
     display: inline-flex;
     align-items: center;
@@ -685,14 +710,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     text-decoration: none;
     box-sizing: border-box;
 }
-.tsd-navigation a {
-    /* why 3rem? No idea, but it seems to work. */
-    width: calc(100% - 3rem);
-}
-.tsd-page-navigation a {
-    /* why is this different? */
-    width: 100%;
-}
 .tsd-navigation a.current,
 .tsd-page-navigation a.current {
     background: var(--color-active-menu-item);
@@ -703,7 +720,8 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 }
 .tsd-navigation ul,
 .tsd-page-navigation ul {
-    margin: 0;
+    margin-top: 0;
+    margin-bottom: 0;
     padding: 0;
     list-style: none;
 }
@@ -712,18 +730,24 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     padding: 0;
     max-width: 100%;
 }
-.tsd-nested-navigation > li > a {
+.tsd-nested-navigation {
     margin-left: 3rem;
 }
 .tsd-nested-navigation > li > details {
-    margin-left: 1.5rem;
+    margin-left: -1.5rem;
 }
-.tsd-small-nested-navigation > li > a {
+.tsd-small-nested-navigation {
     margin-left: 1.5rem;
 }
 .tsd-small-nested-navigation > li > details {
-    margin-left: 0;
+    margin-left: -1.5rem;
+}
+
+.tsd-nested-navigation > li > a,
+.tsd-nested-navigation > li > span {
+    width: calc(100% - 1.75rem - 0.5rem);
 }
+
 .tsd-page-navigation ul {
     padding-left: 1.75rem;
 }
@@ -745,28 +769,33 @@ a.tsd-index-link {
     align-items: center;
     color: var(--color-text);
 }
+.tsd-accordion-summary {
+    list-style-type: none; /* hide marker on non-safari */
+    outline: none; /* broken on safari, so just hide it */
+}
+.tsd-accordion-summary::-webkit-details-marker {
+    display: none; /* hide marker on safari */
+}
 .tsd-accordion-summary,
 .tsd-accordion-summary a {
     user-select: none;
     -moz-user-select: none;
     -webkit-user-select: none;
     -ms-user-select: none;
 
-    display: flex;
-    align-items: center;
     cursor: pointer;
 }
+.tsd-accordion-summary a {
+    width: calc(100% - 1.5rem);
+}
 .tsd-accordion-summary > * {
     margin-top: 0;
     margin-bottom: 0;
     padding-top: 0;
     padding-bottom: 0;
 }
-.tsd-accordion-summary::-webkit-details-marker {
-    display: none;
-}
-.tsd-index-accordion .tsd-accordion-summary svg {
-    margin-right: 0.25rem;
+.tsd-index-accordion .tsd-accordion-summary > svg {
+    margin-left: 0.25rem;
 }
 .tsd-index-content > :not(:first-child) {
     margin-top: 0.75rem;

diff --git a/docs/classes/client_use_user.RequestError.html b/docs/classes/client_use_user.RequestError.html
@@ -30,7 +30,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">RequestError</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/client/use-user.tsx#L46">client/use-user.tsx:46</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/client/use-user.tsx#L46">client/use-user.tsx:46</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">
@@ -59,14 +59,14 @@ <h5><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-t
 <h4 class="tsd-returns-title">Returns <a href="client_use_user.RequestError.html" class="tsd-signature-type tsd-kind-class">RequestError</a></h4><aside class="tsd-sources">
 <p>Overrides Error.constructor</p>
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/client/use-user.tsx#L49">client/use-user.tsx:49</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/client/use-user.tsx#L49">client/use-user.tsx:49</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/client/use-user.tsx#L47">client/use-user.tsx:47</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/client/use-user.tsx#L47">client/use-user.tsx:47</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/docs/classes/session_session.default.html b/docs/classes/session_session.default.html
@@ -27,7 +27,7 @@ <h4>Hierarchy</h4>
 <h4 class="tsd-before-signature">Indexable</h4>
 <div class="tsd-signature"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L19">session/session.ts:19</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L19">session/session.ts:19</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">
@@ -60,7 +60,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/session_session.Claims.html" class="tsd-signature-type tsd-kind-interface">Claims</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="session_session.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L55">session/session.ts:55</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L55">session/session.ts:55</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="accessToken" class="tsd-anchor"></a>
@@ -69,28 +69,28 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <div class="tsd-comment tsd-typography"><p>The access token.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L33">session/session.ts:33</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L33">session/session.ts:33</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="accessTokenExpiresAt" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>access<wbr/>Token<wbr/>Expires<wbr/>At</span><a href="#accessTokenExpiresAt" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">access<wbr/>Token<wbr/>Expires<wbr/>At</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>The expiration of the access token.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L43">session/session.ts:43</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L43">session/session.ts:43</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="accessTokenScope" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>access<wbr/>Token<wbr/>Scope</span><a href="#accessTokenScope" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">access<wbr/>Token<wbr/>Scope</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>The access token scopes.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L38">session/session.ts:38</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L38">session/session.ts:38</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="idToken" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id<wbr/>Token</span><a href="#idToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">id<wbr/>Token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>The ID token.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L28">session/session.ts:28</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L28">session/session.ts:28</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="refreshToken" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>refresh<wbr/>Token</span><a href="#refreshToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">refresh<wbr/>Token</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -99,14 +99,14 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 from Auth0.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L51">session/session.ts:51</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L51">session/session.ts:51</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="user" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">user</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/session_session.Claims.html" class="tsd-signature-type tsd-kind-interface">Claims</a></div>
 <div class="tsd-comment tsd-typography"><p>Any of the claims from the <code>id_token</code>.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8112efe/src/session/session.ts#L23">session/session.ts:23</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/5989b32/src/session/session.ts#L23">session/session.ts:23</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">