Merge pull request #669 from auth0/release/v1.9.0

Release v1.9.0

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [v1.9.0](https://github.com/auth0/nextjs-auth0/tree/v1.9.0) (2022-05-20)
+[Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v1.8.0...v1.9.0)
+
+**Added**
+- [SDK-3332] Constrain session lifecycle to `withPageAuthrequired` to avoid Next warning [\#664](https://github.com/auth0/nextjs-auth0/pull/664) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [v1.8.0](https://github.com/auth0/nextjs-auth0/tree/v1.8.0) (2022-05-04)
 [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v1.7.0...v1.8.0)
 

docs/classes/frontend_use_user.requesterror.html

@@ -121,7 +121,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/frontend/use-user.tsx#L46">src/frontend/use-user.tsx:46</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/frontend/use-user.tsx#L46">src/frontend/use-user.tsx:46</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -143,7 +143,7 @@ <h3>status</h3>
 					<div class="tsd-signature tsd-kind-icon">status<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/8511943/src/frontend/use-user.tsx#L46">src/frontend/use-user.tsx:46</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/frontend/use-user.tsx#L46">src/frontend/use-user.tsx:46</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -188,6 +188,9 @@ <h3>status</h3>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers.html">helpers</a>
 					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/helpers_get_server_side_props_wrapper.html">helpers/get-<wbr>server-<wbr>side-<wbr>props-<wbr>wrapper</a>
+					</li>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers_with_api_auth_required.html">helpers/with-<wbr>api-<wbr>auth-<wbr>required</a>
 					</li>

docs/classes/session.sessioncache.html

@@ -100,6 +100,7 @@ <h3>Methods</h3>
 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.sessioncache.html#getidtoken" class="tsd-kind-icon">get<wbr>IdToken</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.sessioncache.html#init" class="tsd-kind-icon">init</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.sessioncache.html#isauthenticated" class="tsd-kind-icon">is<wbr>Authenticated</a></li>
+								<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.sessioncache.html#save" class="tsd-kind-icon">save</a></li>
 								<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.sessioncache.html#set" class="tsd-kind-icon">set</a></li>
 							</ul>
 						</section>
@@ -118,7 +119,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L12">src/session/cache.ts:12</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L13">src/session/cache.ts:13</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -147,7 +148,7 @@ <h3>create</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L26">src/session/cache.ts:26</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L35">src/session/cache.ts:35</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -176,7 +177,7 @@ <h3>delete</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L31">src/session/cache.ts:31</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L40">src/session/cache.ts:40</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -202,7 +203,7 @@ <h3>from<wbr>Token<wbr>Set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L58">src/session/cache.ts:58</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L67">src/session/cache.ts:67</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -225,7 +226,7 @@ <h3>get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L53">src/session/cache.ts:53</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L62">src/session/cache.ts:62</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -251,7 +252,7 @@ <h3>get<wbr>IdToken</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L42">src/session/cache.ts:42</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L51">src/session/cache.ts:51</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -271,13 +272,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined
 					<a name="init" class="tsd-anchor"></a>
 					<h3>init</h3>
 					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-						<li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NextApiOrPageRequest</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NextApiOrPageResponse</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
+						<li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NextApiOrPageRequest</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NextApiOrPageResponse</span>, autoSave<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
 					</ul>
 					<ul class="tsd-descriptions">
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L18">src/session/cache.ts:18</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L20">src/session/cache.ts:20</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -288,6 +289,9 @@ <h5>req: <span class="tsd-signature-type">NextApiOrPageRequest</span></h5>
 								<li>
 									<h5>res: <span class="tsd-signature-type">NextApiOrPageResponse</span></h5>
 								</li>
+								<li>
+									<h5>autoSave: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
+								</li>
 							</ul>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 						</li>
@@ -303,7 +307,7 @@ <h3>is<wbr>Authenticated</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L36">src/session/cache.ts:36</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L45">src/session/cache.ts:45</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -319,6 +323,32 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
 						</li>
 					</ul>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
+					<a name="save" class="tsd-anchor"></a>
+					<h3>save</h3>
+					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+						<li class="tsd-signature tsd-kind-icon">save<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NextApiOrPageRequest</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NextApiOrPageResponse</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
+					</ul>
+					<ul class="tsd-descriptions">
+						<li class="tsd-description">
+							<aside class="tsd-sources">
+								<ul>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L31">src/session/cache.ts:31</a></li>
+								</ul>
+							</aside>
+							<h4 class="tsd-parameters-title">Parameters</h4>
+							<ul class="tsd-parameters">
+								<li>
+									<h5>req: <span class="tsd-signature-type">NextApiOrPageRequest</span></h5>
+								</li>
+								<li>
+									<h5>res: <span class="tsd-signature-type">NextApiOrPageResponse</span></h5>
+								</li>
+							</ul>
+							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
+						</li>
+					</ul>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
 					<a name="set" class="tsd-anchor"></a>
 					<h3>set</h3>
@@ -329,7 +359,7 @@ <h3>set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/cache.ts#L48">src/session/cache.ts:48</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/cache.ts#L57">src/session/cache.ts:57</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -389,6 +419,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers.html">helpers</a>
 					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/helpers_get_server_side_props_wrapper.html">helpers/get-<wbr>server-<wbr>side-<wbr>props-<wbr>wrapper</a>
+					</li>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers_with_api_auth_required.html">helpers/with-<wbr>api-<wbr>auth-<wbr>required</a>
 					</li>
@@ -467,6 +500,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
 							<li class=" tsd-kind-method tsd-parent-kind-class">
 								<a href="session.sessioncache.html#isauthenticated" class="tsd-kind-icon">is<wbr>Authenticated</a>
 							</li>
+							<li class=" tsd-kind-method tsd-parent-kind-class">
+								<a href="session.sessioncache.html#save" class="tsd-kind-icon">save</a>
+							</li>
 							<li class=" tsd-kind-method tsd-parent-kind-class">
 								<a href="session.sessioncache.html#set" class="tsd-kind-icon">set</a>
 							</li>

docs/classes/session_session.default.html

@@ -126,7 +126,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/session.ts#L50">src/session/session.ts:50</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L50">src/session/session.ts:50</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token</h3>
 					<div class="tsd-signature tsd-kind-icon">access<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/session.ts#L33">src/session/session.ts:33</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L33">src/session/session.ts:33</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token<wbr>
 					<div class="tsd-signature tsd-kind-icon">access<wbr>Token<wbr>Expires<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</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/8511943/src/session/session.ts#L43">src/session/session.ts:43</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L43">src/session/session.ts:43</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token<wbr>
 					<div class="tsd-signature tsd-kind-icon">access<wbr>Token<wbr>Scope<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/session.ts#L38">src/session/session.ts:38</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L38">src/session/session.ts:38</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id<wbr>Token</h3>
 					<div class="tsd-signature tsd-kind-icon">id<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/session.ts#L28">src/session/session.ts:28</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L28">src/session/session.ts:28</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -208,7 +208,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> refresh<wbr>Token</h3
 					<div class="tsd-signature tsd-kind-icon">refresh<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/session.ts#L48">src/session/session.ts:48</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L48">src/session/session.ts:48</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -223,7 +223,7 @@ <h3>user</h3>
 					<div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <a href="../interfaces/session_session.claims.html" class="tsd-signature-type" data-tsd-kind="Interface">Claims</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/session/session.ts#L23">src/session/session.ts:23</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/session/session.ts#L23">src/session/session.ts:23</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -273,6 +273,9 @@ <h3>user</h3>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers.html">helpers</a>
 					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/helpers_get_server_side_props_wrapper.html">helpers/get-<wbr>server-<wbr>side-<wbr>props-<wbr>wrapper</a>
+					</li>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers_with_api_auth_required.html">helpers/with-<wbr>api-<wbr>auth-<wbr>required</a>
 					</li>

docs/classes/utils_errors.accesstokenerror.html

@@ -117,7 +117,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/utils/errors.ts#L9">src/utils/errors.ts:9</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/utils/errors.ts#L9">src/utils/errors.ts:9</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -142,7 +142,7 @@ <h3>code</h3>
 					<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/8511943/src/utils/errors.ts#L9">src/utils/errors.ts:9</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/4589269/src/utils/errors.ts#L9">src/utils/errors.ts:9</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -187,6 +187,9 @@ <h3>code</h3>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers.html">helpers</a>
 					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/helpers_get_server_side_props_wrapper.html">helpers/get-<wbr>server-<wbr>side-<wbr>props-<wbr>wrapper</a>
+					</li>
 					<li class=" tsd-kind-module">
 						<a href="../modules/helpers_with_api_auth_required.html">helpers/with-<wbr>api-<wbr>auth-<wbr>required</a>
 					</li>