Release 1.1.0 (#71)

auth0 · Jul 15, 2019 · 91a8383 · 91a8383
1 parent 1933b00
commit 91a8383
Show file tree

Hide file tree

Showing 17 changed files with 107 additions and 89 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## [v1.1.0](https://github.com/auth0/auth0-spa-js/tree/v1.1.0) (2019-07-15)
+
+**Changed**
+
+- Allow redirect_uri override in loginWithRedirect - https://github.com/auth0/auth0-spa-js/pull/66
+- Make options argument for popup and redirect optional - https://github.com/auth0/auth0-spa-js/pull/61
+- Mark redirect_uri optional in RedirectLoginOptions - https://github.com/auth0/auth0-spa-js/pull/53
+
 ## [v1.0.2](https://github.com/auth0/auth0-spa-js/tree/v1.0.2) (2019-07-02)
 
 **Changed**

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Make sure this is updated based on the sections included:
 From the CDN:
 
 ```html
-<script src="https://cdn.auth0.com/js/auth0-spa-js/1.0.2/auth0-spa-js.production.js"></script>
+<script src="https://cdn.auth0.com/js/auth0-spa-js/1.1.0/auth0-spa-js.production.js"></script>
 ```
 
 Using [npm](https://npmjs.org):

diff --git a/docs/classes/auth0client.html b/docs/classes/auth0client.html
@@ -1033,7 +1033,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/070505c/src/Auth0Client.ts#L29">Auth0Client.ts:29</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L29">Auth0Client.ts:29</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1059,7 +1059,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/070505c/src/Auth0Client.ts#L172">Auth0Client.ts:172</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L172">Auth0Client.ts:172</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1090,7 +1090,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/070505c/src/Auth0Client.ts#L283">Auth0Client.ts:283</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L283">Auth0Client.ts:283</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1125,7 +1125,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/070505c/src/Auth0Client.ts#L356">Auth0Client.ts:356</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L356">Auth0Client.ts:356</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1159,7 +1159,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/070505c/src/Auth0Client.ts#L152">Auth0Client.ts:152</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L152">Auth0Client.ts:152</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1191,7 +1191,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/070505c/src/Auth0Client.ts#L225">Auth0Client.ts:225</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L225">Auth0Client.ts:225</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1216,7 +1216,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/070505c/src/Auth0Client.ts#L384">Auth0Client.ts:384</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L384">Auth0Client.ts:384</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1234,13 +1234,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
 				<a name="loginwithpopup" class="tsd-anchor"></a>
 				<h3>login<wbr>With<wbr>Popup</h3>
 				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-					<li class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Popup<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/popuploginoptions.html" class="tsd-signature-type">PopupLoginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
+					<li class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Popup<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/popuploginoptions.html" class="tsd-signature-type">PopupLoginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/auth0-spa-js/blob/070505c/src/Auth0Client.ts#L101">Auth0Client.ts:101</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L101">Auth0Client.ts:101</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1258,7 +1258,7 @@ <h3>login<wbr>With<wbr>Popup</h3>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
-								<h5>options: <a href="../interfaces/popuploginoptions.html" class="tsd-signature-type">PopupLoginOptions</a></h5>
+								<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"> =&nbsp;{}</span></h5>
 								<div class="tsd-comment tsd-typography">
 								</div>
 							</li>
@@ -1271,13 +1271,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
 				<a name="loginwithredirect" class="tsd-anchor"></a>
 				<h3>login<wbr>With<wbr>Redirect</h3>
 				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-					<li class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Redirect<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/redirectloginoptions.html" class="tsd-signature-type">RedirectLoginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
+					<li class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Redirect<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/redirectloginoptions.html" class="tsd-signature-type">RedirectLoginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/auth0-spa-js/blob/070505c/src/Auth0Client.ts#L194">Auth0Client.ts:194</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L194">Auth0Client.ts:194</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -1291,7 +1291,7 @@ <h3>login<wbr>With<wbr>Redirect</h3>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
-								<h5>options: <a href="../interfaces/redirectloginoptions.html" class="tsd-signature-type">RedirectLoginOptions</a></h5>
+								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/redirectloginoptions.html" class="tsd-signature-type">RedirectLoginOptions</a><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
 								<div class="tsd-comment tsd-typography">
 								</div>
 							</li>
@@ -1310,7 +1310,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/070505c/src/Auth0Client.ts#L399">Auth0Client.ts:399</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/Auth0Client.ts#L399">Auth0Client.ts:399</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html
@@ -1023,7 +1023,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/070505c/src/errors.ts#L1">errors.ts:1</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/errors.ts#L1">errors.ts:1</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1051,7 +1051,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/070505c/src/errors.ts#L3">errors.ts:3</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/errors.ts#L3">errors.ts:3</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -1061,7 +1061,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/070505c/src/errors.ts#L4">errors.ts:4</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/errors.ts#L4">errors.ts:4</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -1105,7 +1105,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/070505c/src/errors.ts#L5">errors.ts:5</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/errors.ts#L5">errors.ts:5</a></li>
 					</ul>
 				</aside>
 			</section>

diff --git a/docs/globals.html b/docs/globals.html
@@ -960,6 +960,7 @@ <h2 id="table-of-contents">Table of Contents</h2>
 				<li><a href="#getting-started">Getting Started</a></li>
 				<li><a href="#contributing">Contributing</a></li>
 				<li><a href="#support--feedback">Support + Feedback</a></li>
+				<li><a href="#frequently-asked-questions">Frequently Asked Questions</a></li>
 				<li><a href="#vulnerability-reporting">Vulnerability Reporting</a></li>
 				<li><a href="#what-is-auth0">What is Auth0</a></li>
 				<li><a href="#license">License</a></li>
@@ -970,7 +971,7 @@ <h2 id="documentation">Documentation</h2>
 			</ul>
 			<h2 id="installation">Installation</h2>
 			<p>From the CDN:</p>
-			<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.0.2/auth0-spa-js.production.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
+			<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.1.0/auth0-spa-js.production.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
 			<p>Using <a href="https://npmjs.org">npm</a>:</p>
 			<pre><code class="language-sh">npm install @auth0/auth0-spa-js</code></pre>
 			<p>Using <a href="https://yarnpkg.com">yarn</a>:</p>
@@ -1057,11 +1058,13 @@ <h2 id="contributing">Contributing</h2>
 			<ul>
 				<li><a href="https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md">Auth0&#39;s general contribution guidelines</a></li>
 				<li><a href="https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md">Auth0&#39;s code of conduct guidelines</a></li>
-				<li><a href="CONTRIBUTING.md">This repo&#39;s contribution guide</a></li>
+				<li><a href="https://github.com/auth0/auth0-spa-js/blob/master/CONTRIBUTING.md">This repo&#39;s contribution guide</a></li>
 			</ul>
 			<h2 id="support-feedback">Support + Feedback</h2>
 			<p>This SDK is in Early Access with selected stakeholders.</p>
 			<p>We process feedback and provide support via private channels.</p>
+			<h2 id="frequently-asked-questions">Frequently Asked Questions</h2>
+			<p>For a rundown of common issues you might encounter when using the SDK, please check out <a href="FAQ.md">the FAQ</a>.</p>
 			<h2 id="vulnerability-reporting">Vulnerability Reporting</h2>
 			<p>Please do not report security vulnerabilities on the public GitHub issue tracker. The <a href="https://auth0.com/whitehat">Responsible Disclosure Program</a> details the procedure for disclosing security issues.</p>
 			<h2 id="what-is-auth0-">What is Auth0?</h2>
@@ -1124,7 +1127,7 @@ <h3>create<wbr>Auth0<wbr>Client</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/070505c/src/index.ts#L8">index.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/index.ts#L8">index.ts:8</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/index.html b/docs/index.html
@@ -960,6 +960,7 @@ <h2 id="table-of-contents">Table of Contents</h2>
 				<li><a href="#getting-started">Getting Started</a></li>
 				<li><a href="#contributing">Contributing</a></li>
 				<li><a href="#support--feedback">Support + Feedback</a></li>
+				<li><a href="#frequently-asked-questions">Frequently Asked Questions</a></li>
 				<li><a href="#vulnerability-reporting">Vulnerability Reporting</a></li>
 				<li><a href="#what-is-auth0">What is Auth0</a></li>
 				<li><a href="#license">License</a></li>
@@ -970,7 +971,7 @@ <h2 id="documentation">Documentation</h2>
 			</ul>
 			<h2 id="installation">Installation</h2>
 			<p>From the CDN:</p>
-			<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.0.2/auth0-spa-js.production.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
+			<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.auth0.com/js/auth0-spa-js/1.1.0/auth0-spa-js.production.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre>
 			<p>Using <a href="https://npmjs.org">npm</a>:</p>
 			<pre><code class="language-sh">npm install @auth0/auth0-spa-js</code></pre>
 			<p>Using <a href="https://yarnpkg.com">yarn</a>:</p>
@@ -1057,11 +1058,13 @@ <h2 id="contributing">Contributing</h2>
 			<ul>
 				<li><a href="https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md">Auth0&#39;s general contribution guidelines</a></li>
 				<li><a href="https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md">Auth0&#39;s code of conduct guidelines</a></li>
-				<li><a href="CONTRIBUTING.md">This repo&#39;s contribution guide</a></li>
+				<li><a href="https://github.com/auth0/auth0-spa-js/blob/master/CONTRIBUTING.md">This repo&#39;s contribution guide</a></li>
 			</ul>
 			<h2 id="support-feedback">Support + Feedback</h2>
 			<p>This SDK is in Early Access with selected stakeholders.</p>
 			<p>We process feedback and provide support via private channels.</p>
+			<h2 id="frequently-asked-questions">Frequently Asked Questions</h2>
+			<p>For a rundown of common issues you might encounter when using the SDK, please check out <a href="FAQ.md">the FAQ</a>.</p>
 			<h2 id="vulnerability-reporting">Vulnerability Reporting</h2>
 			<p>Please do not report security vulnerabilities on the public GitHub issue tracker. The <a href="https://auth0.com/whitehat">Responsible Disclosure Program</a> details the procedure for disclosing security issues.</p>
 			<h2 id="what-is-auth0-">What is Auth0?</h2>
@@ -1125,7 +1128,7 @@ <h3>create<wbr>Auth0<wbr>Client</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/070505c/src/index.ts#L8">index.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/1933b00/src/index.ts#L8">index.ts:8</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>