Release 1.0.0 (#46)

auth0 · Jun 24, 2020 · def3bfb · def3bfb
1 parent 73a2b42
commit def3bfb
Show file tree

Hide file tree

Showing 23 changed files with 3,043 additions and 109 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## [v1.0.0](https://github.com/auth0/auth0-react/tree/v1.0.0) (2020-06-19)
+
+**Breaking Change**
+
+- Allow custom `returnTo` in `withAuthenticationRequired` [\#41](https://github.com/auth0/auth0-react/pull/41) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [v0.4.0](https://github.com/auth0/auth0-react/tree/v0.4.0) (2020-06-05)
 
 **Added**

diff --git a/README.md b/README.md
@@ -7,10 +7,6 @@ Auth0 SDK for React Single Page Applications (SPA).
 [![npm](https://img.shields.io/npm/v/@auth0/auth0-react.svg?style=flat)](https://www.npmjs.com/package/@auth0/auth0-react)
 [![codecov](https://img.shields.io/codecov/c/github/auth0/auth0-react/master.svg?style=flat)](https://codecov.io/gh/auth0/auth0-react)
 
-### Beta
-
-**@auth0/auth0-react** is in Beta in order to get feedback to shape its design. As we move towards general availability please be aware that releases may contain breaking changes, but we will do our best to communicate them.
-
 ## Table of Contents
 
 - [Documentation](#documentation)

diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/classes/oautherror.html b/docs/classes/oautherror.html
@@ -2729,6 +2729,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="../interfaces/withauth0props.html" class="tsd-kind-icon">With<wbr>Auth0<wbr>Props</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="../interfaces/withauthenticationrequiredoptions.html" class="tsd-kind-icon">With<wbr>Authentication<wbr>Required<wbr>Options</a>
+		</li>
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#auth0context" class="tsd-kind-icon">Auth0<wbr>Context</a>
 		</li>
@@ -2806,7 +2809,7 @@ <h3>constructor</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/errors.tsx#L7">src/errors.tsx:7</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/errors.tsx#L7">src/errors.tsx:7</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2831,7 +2834,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-react/blob/036ff10/src/errors.tsx#L8">src/errors.tsx:8</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/errors.tsx#L8">src/errors.tsx:8</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2841,7 +2844,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error_<wbr>descriptio
 				<div class="tsd-signature tsd-kind-icon">error_<wbr>description<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/auth0-react/blob/036ff10/src/errors.tsx#L8">src/errors.tsx:8</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/errors.tsx#L8">src/errors.tsx:8</a></li>
 					</ul>
 				</aside>
 			</section>

diff --git a/docs/globals.html b/docs/globals.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/advancedoptions.html b/docs/interfaces/advancedoptions.html
@@ -2729,6 +2729,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="withauth0props.html" class="tsd-kind-icon">With<wbr>Auth0<wbr>Props</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="withauthenticationrequiredoptions.html" class="tsd-kind-icon">With<wbr>Authentication<wbr>Required<wbr>Options</a>
+		</li>
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#auth0context" class="tsd-kind-icon">Auth0<wbr>Context</a>
 		</li>

diff --git a/docs/interfaces/auth0clientoptions.html b/docs/interfaces/auth0clientoptions.html
@@ -2729,6 +2729,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="withauth0props.html" class="tsd-kind-icon">With<wbr>Auth0<wbr>Props</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="withauthenticationrequiredoptions.html" class="tsd-kind-icon">With<wbr>Authentication<wbr>Required<wbr>Options</a>
+		</li>
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#auth0context" class="tsd-kind-icon">Auth0<wbr>Context</a>
 		</li>

diff --git a/docs/interfaces/auth0contextinterface.html b/docs/interfaces/auth0contextinterface.html
@@ -2761,6 +2761,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="withauth0props.html" class="tsd-kind-icon">With<wbr>Auth0<wbr>Props</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="withauthenticationrequiredoptions.html" class="tsd-kind-icon">With<wbr>Authentication<wbr>Required<wbr>Options</a>
+		</li>
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#auth0context" class="tsd-kind-icon">Auth0<wbr>Context</a>
 		</li>
@@ -2831,7 +2834,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="auth0contextinterface.html">Auth0ContextInterface</a>.<a href="auth0contextinterface.html#error">error</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth-state.tsx#L7">src/auth-state.tsx:7</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth-state.tsx#L7">src/auth-state.tsx:7</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2841,7 +2844,7 @@ <h3>get<wbr>Access<wbr>Token<wbr>Silently</h3>
 				<div class="tsd-signature tsd-kind-icon">get<wbr>Access<wbr>Token<wbr>Silently<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="gettokensilentlyoptions.html" class="tsd-signature-type">GetTokenSilentlyOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth0-context.tsx#L61">src/auth0-context.tsx:61</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth0-context.tsx#L61">src/auth0-context.tsx:61</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2891,7 +2894,7 @@ <h3>get<wbr>Access<wbr>Token<wbr>With<wbr>Popup</h3>
 				<div class="tsd-signature tsd-kind-icon">get<wbr>Access<wbr>Token<wbr>With<wbr>Popup<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="gettokenwithpopupoptions.html" class="tsd-signature-type">GetTokenWithPopupOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth0-context.tsx#L77">src/auth0-context.tsx:77</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth0-context.tsx#L77">src/auth0-context.tsx:77</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2932,7 +2935,7 @@ <h3>get<wbr>IdToken<wbr>Claims</h3>
 				<div class="tsd-signature tsd-kind-icon">get<wbr>IdToken<wbr>Claims<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="getidtokenclaimsoptions.html" class="tsd-signature-type">GetIdTokenClaimsOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IdToken</span><span class="tsd-signature-symbol">&gt;</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth0-context.tsx#L88">src/auth0-context.tsx:88</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth0-context.tsx#L88">src/auth0-context.tsx:88</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2970,7 +2973,7 @@ <h3>is<wbr>Authenticated</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="auth0contextinterface.html">Auth0ContextInterface</a>.<a href="auth0contextinterface.html#isauthenticated">isAuthenticated</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth-state.tsx#L8">src/auth-state.tsx:8</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth-state.tsx#L8">src/auth-state.tsx:8</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2981,7 +2984,7 @@ <h3>is<wbr>Loading</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="auth0contextinterface.html">Auth0ContextInterface</a>.<a href="auth0contextinterface.html#isloading">isLoading</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth-state.tsx#L9">src/auth-state.tsx:9</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth-state.tsx#L9">src/auth-state.tsx:9</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2991,7 +2994,7 @@ <h3>login<wbr>With<wbr>Popup</h3>
 				<div class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Popup<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="popuploginoptions.html" class="tsd-signature-type">PopupLoginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth0-context.tsx#L115">src/auth0-context.tsx:115</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth0-context.tsx#L115">src/auth0-context.tsx:115</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -3034,7 +3037,7 @@ <h3>login<wbr>With<wbr>Redirect</h3>
 				<div class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Redirect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="redirectloginoptions.html" class="tsd-signature-type">RedirectLoginOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth0-context.tsx#L99">src/auth0-context.tsx:99</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth0-context.tsx#L99">src/auth0-context.tsx:99</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -3073,16 +3076,16 @@ <h3>logout</h3>
 				<div class="tsd-signature tsd-kind-icon">logout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="logoutoptions.html" class="tsd-signature-type">LogoutOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth0-context.tsx#L130">src/auth0-context.tsx:130</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth0-context.tsx#L130">src/auth0-context.tsx:130</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({ <span class="hljs-attr">returnTo</span>: <span class="hljs-built_in">window</span>.location.origin });</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.
-						If the <code>federated</code> option is specified it also clears the Identity Provider session.
+						If the <code>federated</code> option is specified, it also clears the Identity Provider session.
 						If the <code>localOnly</code> option is specified, it only clears the application session.
 						It is invalid to set both the <code>federated</code> and <code>localOnly</code> options to <code>true</code>,
 						and an error will be thrown if you do.
@@ -3117,7 +3120,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> user</h3>
 				<aside class="tsd-sources">
 					<p>Inherited from <a href="auth0contextinterface.html">Auth0ContextInterface</a>.<a href="auth0contextinterface.html#user">user</a></p>
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/036ff10/src/auth-state.tsx#L10">src/auth-state.tsx:10</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/b147d44/src/auth-state.tsx#L10">src/auth-state.tsx:10</a></li>
 					</ul>
 				</aside>
 			</section>