Release v1.14.0 (#723)

auth0 · Mar 22, 2021 · 041ce0a · 041ce0a
1 parent c2dd91e
commit 041ce0a
Show file tree

Hide file tree

Showing 25 changed files with 585 additions and 143 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,23 @@
 # Change Log
 
+## [v1.14.0](https://github.com/auth0/auth0-spa-js/tree/v1.14.0) (2021-03-22)
+
+[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.13.6...v1.14.0)
+
+**Added**
+
+- feat(loginWithRedirect): add redirectMethod option [\#717](https://github.com/auth0/auth0-spa-js/pull/717) ([slaywell](https://github.com/slaywell))
+- Export errors for type checking [\#716](https://github.com/auth0/auth0-spa-js/pull/716) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
+**Changed**
+
+- Add screen_hint parameter to BaseLoginOptions [\#721](https://github.com/auth0/auth0-spa-js/pull/721) ([damieng](https://github.com/damieng))
+
+**Fixed**
+
+- Updated minor syntax, to allow for TypeScript compiler to be happier [\#714](https://github.com/auth0/auth0-spa-js/pull/714) ([kachihro](https://github.com/kachihro))
+- Revert [SDK-2183] Add warning when requested scopes differ from retrieved scopes [\#712](https://github.com/auth0/auth0-spa-js/pull/712) ([frederikprijck](https://github.com/frederikprijck))
+
 ## [v1.13.6](https://github.com/auth0/auth0-spa-js/tree/v1.13.6) (2021-01-07)
 
 [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.13.5...v1.13.6)

diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/classes/auth0client.html b/docs/classes/auth0client.html
@@ -2900,7 +2900,7 @@ <h3>constructor</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L148">src/Auth0Client.ts:148</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L149">src/Auth0Client.ts:149</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2922,7 +2922,7 @@ <h3>cache<wbr>Location</h3>
 				<div class="tsd-signature tsd-kind-icon">cache<wbr>Location<span class="tsd-signature-symbol">:</span> <a href="../globals.html#cachelocation" class="tsd-signature-type">CacheLocation</a></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L147">src/Auth0Client.ts:147</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L148">src/Auth0Client.ts:148</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2939,7 +2939,7 @@ <h3>build<wbr>Authorize<wbr>Url</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L283">src/Auth0Client.ts:283</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L284">src/Auth0Client.ts:284</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2972,7 +2972,7 @@ <h3>build<wbr>Logout<wbr>Url</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L767">src/Auth0Client.ts:767</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L769">src/Auth0Client.ts:769</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3003,7 +3003,7 @@ <h3>check<wbr>Session</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L585">src/Auth0Client.ts:585</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L587">src/Auth0Client.ts:587</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3042,7 +3042,7 @@ <h3>get<wbr>IdToken<wbr>Claims</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L455">src/Auth0Client.ts:455</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L456">src/Auth0Client.ts:456</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3076,7 +3076,7 @@ <h3>get<wbr>Token<wbr>Silently</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L625">src/Auth0Client.ts:625</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L627">src/Auth0Client.ts:627</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3120,7 +3120,7 @@ <h3>get<wbr>Token<wbr>With<wbr>Popup</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L715">src/Auth0Client.ts:715</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L717">src/Auth0Client.ts:717</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3157,7 +3157,7 @@ <h3>get<wbr>User</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L425">src/Auth0Client.ts:425</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L426">src/Auth0Client.ts:426</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3175,7 +3175,7 @@ <h4 class="tsd-type-parameters-title">Type parameters</h4>
 							<li>
 								<h4>TUser<span class="tsd-signature-symbol">: </span><a href="user.html" class="tsd-signature-type">User</a></h4>
 								<div class="tsd-comment tsd-typography">
-									<p>The type to return, has to extend <a href="user.html">User</a>. Defaults to <a href="user.html">User</a> when omitted.</p>
+									<p>The type to return, has to extend <a href="user.html">User</a>.</p>
 								</div>
 							</li>
 						</ul>
@@ -3201,7 +3201,7 @@ <h3>handle<wbr>Redirect<wbr>Callback</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L492">src/Auth0Client.ts:492</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L494">src/Auth0Client.ts:494</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3232,7 +3232,7 @@ <h3>is<wbr>Authenticated</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L754">src/Auth0Client.ts:754</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L756">src/Auth0Client.ts:756</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3256,7 +3256,7 @@ <h3>login<wbr>With<wbr>Popup</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L336">src/Auth0Client.ts:336</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L337">src/Auth0Client.ts:337</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3296,7 +3296,7 @@ <h3>login<wbr>With<wbr>Redirect</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L481">src/Auth0Client.ts:481</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L482">src/Auth0Client.ts:482</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3329,7 +3329,7 @@ <h3>logout</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/Auth0Client.ts#L796">src/Auth0Client.ts:796</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/Auth0Client.ts#L798">src/Auth0Client.ts:798</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html
@@ -2822,6 +2822,14 @@
 </nav>
 <div class="container container-main">
 	<div class="content-wrap">
+		<section class="tsd-panel tsd-comment">
+			<div class="tsd-comment tsd-typography">
+				<div class="lead">
+					<p>Thrown when handling the redirect callback fails, will be one of Auth0&#39;s
+					Authentication API&#39;s Standard Error Responses: <a href="https://auth0.com/docs/api/authentication?javascript#standard-error-responses">https://auth0.com/docs/api/authentication?javascript#standard-error-responses</a></p>
+				</div>
+			</div>
+		</section>
 		<section class="tsd-panel tsd-hierarchy">
 			<h3>Hierarchy</h3>
 			<ul class="tsd-hierarchy">
@@ -2879,7 +2887,7 @@ <h3>constructor</h3>
 						<aside class="tsd-sources">
 							<p>Overrides <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#constructor">constructor</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L19">src/errors.ts:19</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L26">src/errors.ts:26</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2910,7 +2918,7 @@ <h3>app<wbr>State</h3>
 				<div class="tsd-signature tsd-kind-icon">app<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L24">src/errors.ts:24</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L31">src/errors.ts:31</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2921,7 +2929,7 @@ <h3>error</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#error">error</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2932,7 +2940,7 @@ <h3>error_<wbr>description</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#error_description">error_description</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2975,7 +2983,7 @@ <h3>state</h3>
 				<div class="tsd-signature tsd-kind-icon">state<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/auth0-spa-js/blob/263b49f/src/errors.ts#L23">src/errors.ts:23</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L30">src/errors.ts:30</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2993,7 +3001,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Payload</h3>
 						<aside class="tsd-sources">
 							<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#frompayload">fromPayload</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L8">src/errors.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L11">src/errors.ts:11</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/classes/genericerror.html b/docs/classes/genericerror.html
@@ -2819,6 +2819,13 @@
 </nav>
 <div class="container container-main">
 	<div class="content-wrap">
+		<section class="tsd-panel tsd-comment">
+			<div class="tsd-comment tsd-typography">
+				<div class="lead">
+					<p>Thrown when network requests to the Auth server fail.</p>
+				</div>
+			</div>
+		</section>
 		<section class="tsd-panel tsd-hierarchy">
 			<h3>Hierarchy</h3>
 			<ul class="tsd-hierarchy">
@@ -2882,7 +2889,7 @@ <h3>constructor</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L1">src/errors.ts:1</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L4">src/errors.ts:4</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2907,7 +2914,7 @@ <h3>error</h3>
 				<div class="tsd-signature tsd-kind-icon">error<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/auth0-spa-js/blob/263b49f/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2917,7 +2924,7 @@ <h3>error_<wbr>description</h3>
 				<div class="tsd-signature tsd-kind-icon">error_<wbr>description<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/auth0-spa-js/blob/263b49f/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2978,7 +2985,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Payload</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L8">src/errors.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L11">src/errors.ts:11</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/classes/popuptimeouterror.html b/docs/classes/popuptimeouterror.html
@@ -2819,6 +2819,13 @@
 </nav>
 <div class="container container-main">
 	<div class="content-wrap">
+		<section class="tsd-panel tsd-comment">
+			<div class="tsd-comment tsd-typography">
+				<div class="lead">
+					<p>Error thrown when the login popup times out (if the user does not complete auth)</p>
+				</div>
+			</div>
+		</section>
 		<section class="tsd-panel tsd-hierarchy">
 			<h3>Hierarchy</h3>
 			<ul class="tsd-hierarchy">
@@ -2875,7 +2882,7 @@ <h3>constructor</h3>
 						<aside class="tsd-sources">
 							<p>Overrides <a href="timeouterror.html">TimeoutError</a>.<a href="timeouterror.html#constructor">constructor</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L40">src/errors.ts:40</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L54">src/errors.ts:54</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2898,7 +2905,7 @@ <h3>error</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#error">error</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2909,7 +2916,7 @@ <h3>error_<wbr>description</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#error_description">error_description</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2941,7 +2948,7 @@ <h3>popup</h3>
 				<div class="tsd-signature tsd-kind-icon">popup<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Window</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L41">src/errors.ts:41</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L55">src/errors.ts:55</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2970,7 +2977,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Payload</h3>
 						<aside class="tsd-sources">
 							<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#frompayload">fromPayload</a></p>
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/263b49f/src/errors.ts#L8">src/errors.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/c2dd91e/src/errors.ts#L11">src/errors.ts:11</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>