Release 1.15.0 (#738)

auth0 · Apr 29, 2021 · 1da10cb · 1da10cb
1 parent ac8d8bb
commit 1da10cb
Show file tree

Hide file tree

Showing 26 changed files with 3,264 additions and 159 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Change Log
 
+## [v1.15.0](https://github.com/auth0/auth0-spa-js/tree/v1.15.0) (2021-04-29)
+[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.14.0...v1.15.0)
+
+**Added**
+- Add Popup cancelled event [\#724](https://github.com/auth0/auth0-spa-js/pull/724) ([degrammer](https://github.com/degrammer))
+
+**Fixed**
+- Fix popup blocker showing for loginWithPopup in Firefox & Safari [\#732](https://github.com/auth0/auth0-spa-js/pull/732) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
 ## [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)

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
@@ -2773,6 +2773,9 @@
 		<li class=" tsd-kind-class">
 			<a href="genericerror.html" class="tsd-kind-icon">Generic<wbr>Error</a>
 		</li>
+		<li class=" tsd-kind-class">
+			<a href="popupcancellederror.html" class="tsd-kind-icon">Popup<wbr>Cancelled<wbr>Error</a>
+		</li>
 		<li class=" tsd-kind-class">
 			<a href="popuptimeouterror.html" class="tsd-kind-icon">Popup<wbr>Timeout<wbr>Error</a>
 		</li>
@@ -2900,7 +2903,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/92c95c9/src/Auth0Client.ts#L149">src/Auth0Client.ts:149</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L150">src/Auth0Client.ts:150</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2922,7 +2925,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/92c95c9/src/Auth0Client.ts#L148">src/Auth0Client.ts:148</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L149">src/Auth0Client.ts:149</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2939,7 +2942,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/92c95c9/src/Auth0Client.ts#L284">src/Auth0Client.ts:284</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L285">src/Auth0Client.ts:285</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2972,7 +2975,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/92c95c9/src/Auth0Client.ts#L769">src/Auth0Client.ts:769</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L787">src/Auth0Client.ts:787</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3003,7 +3006,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/92c95c9/src/Auth0Client.ts#L587">src/Auth0Client.ts:587</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L605">src/Auth0Client.ts:605</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3042,7 +3045,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/92c95c9/src/Auth0Client.ts#L456">src/Auth0Client.ts:456</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L472">src/Auth0Client.ts:472</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3076,7 +3079,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/92c95c9/src/Auth0Client.ts#L627">src/Auth0Client.ts:627</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L645">src/Auth0Client.ts:645</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3120,7 +3123,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/92c95c9/src/Auth0Client.ts#L717">src/Auth0Client.ts:717</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L735">src/Auth0Client.ts:735</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3157,7 +3160,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/92c95c9/src/Auth0Client.ts#L426">src/Auth0Client.ts:426</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L442">src/Auth0Client.ts:442</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3201,7 +3204,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/92c95c9/src/Auth0Client.ts#L494">src/Auth0Client.ts:494</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L512">src/Auth0Client.ts:512</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3232,7 +3235,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/92c95c9/src/Auth0Client.ts#L756">src/Auth0Client.ts:756</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L774">src/Auth0Client.ts:774</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3256,12 +3259,18 @@ <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/92c95c9/src/Auth0Client.ts#L337">src/Auth0Client.ts:337</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L344">src/Auth0Client.ts:344</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js"><span class="hljs-keyword">await</span> auth0.loginWithPopup(options);</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">try</span> {
+ <span class="hljs-keyword">await</span> auth0.loginWithPopup(options);
+} <span class="hljs-keyword">catch</span>(e) {
+ <span class="hljs-keyword">if</span> (e <span class="hljs-keyword">instanceof</span> PopupCancelledError) {
+   <span class="hljs-comment">// Popup was closed before login completed</span>
+ }
+}</code></pre>
 							</div>
 							<p>Opens a popup with the <code>/authorize</code> URL using the parameters
 								provided as arguments. Random and secure <code>state</code> and <code>nonce</code>
@@ -3274,10 +3283,10 @@ <h3>login<wbr>With<wbr>Popup</h3>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
-								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/popuploginoptions.html" class="tsd-signature-type">PopupLoginOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
+								<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/popuploginoptions.html" class="tsd-signature-type">PopupLoginOptions</a></h5>
 							</li>
 							<li>
-								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> config: <a href="../interfaces/popupconfigoptions.html" class="tsd-signature-type">PopupConfigOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
+								<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <a href="../interfaces/popupconfigoptions.html" class="tsd-signature-type">PopupConfigOptions</a></h5>
 								<div class="tsd-comment tsd-typography">
 								</div>
 							</li>
@@ -3296,7 +3305,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/92c95c9/src/Auth0Client.ts#L482">src/Auth0Client.ts:482</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L500">src/Auth0Client.ts:500</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3329,7 +3338,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/92c95c9/src/Auth0Client.ts#L798">src/Auth0Client.ts:798</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/Auth0Client.ts#L816">src/Auth0Client.ts:816</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html
@@ -2758,6 +2758,9 @@
 		<li class=" tsd-kind-class">
 			<a href="genericerror.html" class="tsd-kind-icon">Generic<wbr>Error</a>
 		</li>
+		<li class=" tsd-kind-class">
+			<a href="popupcancellederror.html" class="tsd-kind-icon">Popup<wbr>Cancelled<wbr>Error</a>
+		</li>
 		<li class=" tsd-kind-class">
 			<a href="popuptimeouterror.html" class="tsd-kind-icon">Popup<wbr>Timeout<wbr>Error</a>
 		</li>
@@ -2887,7 +2890,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/92c95c9/src/errors.ts#L26">src/errors.ts:26</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L26">src/errors.ts:26</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2918,7 +2921,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/92c95c9/src/errors.ts#L31">src/errors.ts:31</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L31">src/errors.ts:31</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2929,7 +2932,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/92c95c9/src/errors.ts#L5">src/errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2940,7 +2943,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/92c95c9/src/errors.ts#L5">src/errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2983,7 +2986,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/92c95c9/src/errors.ts#L30">src/errors.ts:30</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L30">src/errors.ts:30</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -3001,7 +3004,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/92c95c9/src/errors.ts#L11">src/errors.ts:11</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/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
@@ -2755,6 +2755,9 @@
 				</li>
 			</ul>
 		</li>
+		<li class=" tsd-kind-class">
+			<a href="popupcancellederror.html" class="tsd-kind-icon">Popup<wbr>Cancelled<wbr>Error</a>
+		</li>
 		<li class=" tsd-kind-class">
 			<a href="popuptimeouterror.html" class="tsd-kind-icon">Popup<wbr>Timeout<wbr>Error</a>
 		</li>
@@ -2841,6 +2844,9 @@ <h3>Hierarchy</h3>
 								<li>
 									<a href="timeouterror.html" class="tsd-signature-type">TimeoutError</a>
 								</li>
+								<li>
+									<a href="popupcancellederror.html" class="tsd-signature-type">PopupCancelledError</a>
+								</li>
 							</ul>
 						</li>
 					</ul>
@@ -2889,7 +2895,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/92c95c9/src/errors.ts#L4">src/errors.ts:4</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L4">src/errors.ts:4</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2914,7 +2920,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/92c95c9/src/errors.ts#L5">src/errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2924,7 +2930,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/92c95c9/src/errors.ts#L5">src/errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2985,7 +2991,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/92c95c9/src/errors.ts#L11">src/errors.ts:11</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/ac8d8bb/src/errors.ts#L11">src/errors.ts:11</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>