Release 1.17.0 (#772)

* release 1.17.0 * Rerun docs
auth0 · Aug 4, 2021 · 2ebbe54 · 2ebbe54
1 parent 81755bc
commit 2ebbe54
Show file tree

Hide file tree

Showing 33 changed files with 336 additions and 252 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Change Log
 
+## [v1.17.0](https://github.com/auth0/auth0-spa-js/tree/v1.17.0) (2021-08-03)
+
+[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.16.1...v1.17.0)
+
+**Added**
+
+- Add `useFormData` to enable `application/x-www-form-urlencoded` requests [\#768](https://github.com/auth0/auth0-spa-js/pull/768) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
+**Changed**
+
+- Allow providing a `domain` that includes `http` or `https`. [\#768](https://github.com/auth0/auth0-spa-js/pull/768) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
 ## [v1.16.1](https://github.com/auth0/auth0-spa-js/tree/v1.16.1) (2021-07-07)
 
 [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.16.0...v1.16.1)

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
@@ -2948,7 +2948,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/e84aecb/src/Auth0Client.ts#L158">src/Auth0Client.ts:158</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L171">src/Auth0Client.ts:171</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2970,7 +2970,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/e84aecb/src/Auth0Client.ts#L157">src/Auth0Client.ts:157</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L170">src/Auth0Client.ts:170</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2987,12 +2987,13 @@ <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/e84aecb/src/Auth0Client.ts#L308">src/Auth0Client.ts:308</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L322">src/Auth0Client.ts:322</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.buildAuthorizeUrl(options);</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">await</span> auth0.buildAuthorizeUrl(options);
+</code></pre>
 							</div>
 							<p>Builds an <code>/authorize</code> URL for loginWithRedirect using the parameters
 								provided as arguments. Random and secure <code>state</code> and <code>nonce</code>
@@ -3020,12 +3021,13 @@ <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/e84aecb/src/Auth0Client.ts#L815">src/Auth0Client.ts:815</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L831">src/Auth0Client.ts:831</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.buildLogoutUrl(options);</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">await</span> auth0.buildLogoutUrl(options);
+</code></pre>
 							</div>
 							<p>Builds a URL to the logout endpoint using the parameters provided as arguments.</p>
 						</div>
@@ -3051,12 +3053,13 @@ <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/e84aecb/src/Auth0Client.ts#L628">src/Auth0Client.ts:628</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L644">src/Auth0Client.ts:644</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.checkSession();</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">await</span> auth0.checkSession();
+</code></pre>
 							</div>
 							<p>Check if the user is logged in using <code>getTokenSilently</code>. The difference
 								with <code>getTokenSilently</code> is that this doesn&#39;t return a token, but it will
@@ -3090,12 +3093,13 @@ <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/e84aecb/src/Auth0Client.ts#L495">src/Auth0Client.ts:495</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L510">src/Auth0Client.ts:510</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js"><span class="hljs-keyword">const</span> claims = <span class="hljs-keyword">await</span> auth0.getIdTokenClaims();</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">const</span> claims = <span class="hljs-keyword">await</span> auth0.getIdTokenClaims();
+</code></pre>
 							</div>
 							<p>Returns all claims from the id_token if available.</p>
 							<p>If you provide an audience or scope, they should match an existing Access Token
@@ -3124,12 +3128,13 @@ <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/e84aecb/src/Auth0Client.ts#L668">src/Auth0Client.ts:668</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L684">src/Auth0Client.ts:684</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js"><span class="hljs-keyword">const</span> token = <span class="hljs-keyword">await</span> auth0.getTokenSilently(options);</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">const</span> token = <span class="hljs-keyword">await</span> auth0.getTokenSilently(options);
+</code></pre>
 							</div>
 							<p>If there&#39;s a valid token stored, return it. Otherwise, opens an
 								iframe with the <code>/authorize</code> URL using the parameters provided
@@ -3168,12 +3173,13 @@ <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/e84aecb/src/Auth0Client.ts#L763">src/Auth0Client.ts:763</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L779">src/Auth0Client.ts:779</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js"><span class="hljs-keyword">const</span> token = <span class="hljs-keyword">await</span> auth0.getTokenWithPopup(options);</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">const</span> token = <span class="hljs-keyword">await</span> auth0.getTokenWithPopup(options);
+</code></pre>
 								<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>
 									parameters will be auto-generated. If the response is successful,
@@ -3205,12 +3211,13 @@ <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/e84aecb/src/Auth0Client.ts#L465">src/Auth0Client.ts:465</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L480">src/Auth0Client.ts:480</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js"><span class="hljs-keyword">const</span> user = <span class="hljs-keyword">await</span> auth0.getUser();</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">const</span> user = <span class="hljs-keyword">await</span> auth0.getUser();
+</code></pre>
 							</div>
 							<p>Returns the user information if available (decoded
 							from the <code>id_token</code>).</p>
@@ -3249,7 +3256,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/e84aecb/src/Auth0Client.ts#L535">src/Auth0Client.ts:535</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L550">src/Auth0Client.ts:550</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3280,12 +3287,13 @@ <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/e84aecb/src/Auth0Client.ts#L802">src/Auth0Client.ts:802</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L818">src/Auth0Client.ts:818</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js"><span class="hljs-keyword">const</span> isAuthenticated = <span class="hljs-keyword">await</span> auth0.isAuthenticated();</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">const</span> isAuthenticated = <span class="hljs-keyword">await</span> auth0.isAuthenticated();
+</code></pre>
 							</div>
 							<p>Returns <code>true</code> if there&#39;s valid information stored,
 							otherwise returns <code>false</code>.</p>
@@ -3304,7 +3312,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/e84aecb/src/Auth0Client.ts#L367">src/Auth0Client.ts:367</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L381">src/Auth0Client.ts:381</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3315,7 +3323,8 @@ <h3>login<wbr>With<wbr>Popup</h3>
  <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>
+}
+</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>
@@ -3350,12 +3359,13 @@ <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/e84aecb/src/Auth0Client.ts#L523">src/Auth0Client.ts:523</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L538">src/Auth0Client.ts:538</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.loginWithRedirect(options);</code></pre>
+								<pre><code class="language-js"><span class="hljs-keyword">await</span> auth0.loginWithRedirect(options);
+</code></pre>
 							</div>
 							<p>Performs a redirect to <code>/authorize</code> using the parameters
 								provided as arguments. Random and secure <code>state</code> and <code>nonce</code>
@@ -3383,12 +3393,13 @@ <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/e84aecb/src/Auth0Client.ts#L847">src/Auth0Client.ts:847</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/Auth0Client.ts#L863">src/Auth0Client.ts:863</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
 							<div class="lead">
-								<pre><code class="language-js">auth0.logout();</code></pre>
+								<pre><code class="language-js">auth0.logout();
+</code></pre>
 							</div>
 							<p>Clears the application session and performs a redirect to <code>/v2/logout</code>, using
 							the parameters provided as arguments, to clear the Auth0 session.</p>

diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html
@@ -2935,7 +2935,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/e84aecb/src/errors.ts#L26">src/errors.ts:26</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/errors.ts#L26">src/errors.ts:26</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2966,7 +2966,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/e84aecb/src/errors.ts#L31">src/errors.ts:31</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/errors.ts#L31">src/errors.ts:31</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2977,7 +2977,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/e84aecb/src/errors.ts#L5">src/errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2988,7 +2988,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/e84aecb/src/errors.ts#L5">src/errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/errors.ts#L5">src/errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -3031,7 +3031,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/e84aecb/src/errors.ts#L30">src/errors.ts:30</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/errors.ts#L30">src/errors.ts:30</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -3049,7 +3049,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/e84aecb/src/errors.ts#L11">src/errors.ts:11</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/b751744/src/errors.ts#L11">src/errors.ts:11</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>