Release v1.5.0 (#238)

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [v1.5.0](https://github.com/auth0/auth0-react/tree/v1.5.0) (2021-05-05)
+
+**Added**
+
+- Expose `handleRedirectCallback` [\#233](https://github.com/auth0/auth0-react/pull/233) ([stevehobbsdev](https://github.com/stevehobbsdev))
+- Add TUser type param to useAuth0 hook [\#230](https://github.com/auth0/auth0-react/pull/230) ([Jameskmonger](https://github.com/Jameskmonger))
+
+**Changed**
+
+- Update User type [\#236](https://github.com/auth0/auth0-react/pull/236) ([tkiryu](https://github.com/tkiryu))
+
+**Fixed**
+
+- Check for state along with error param [\#231](https://github.com/auth0/auth0-react/pull/231) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [v1.4.0](https://github.com/auth0/auth0-react/tree/v1.4.0) (2021-03-26)
 
 **Added**

docs/classes/errors.oautherror.html

@@ -134,7 +134,7 @@ <h3>constructor</h3>
 							<aside class="tsd-sources">
 								<p>Overrides Error.constructor</p>
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/errors.tsx#L7">src/errors.tsx:7</a></li>
+									<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/errors.tsx#L7">src/errors.tsx:7</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -343,6 +343,7 @@ <h2>Legend</h2>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 		</div>
 	</div>

docs/index.html

@@ -155,6 +155,11 @@ <h2>Getting Started</h2>
 <span style="color: #000000">}</span>
 
 <span style="color: #000000">export default App;</span>
+</code></pre>
+				<p>If you&#39;re using TypeScript, you can pass a type parameter to <code>useAuth0</code> to specify the type of <code>user</code>:</p>
+				<pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">user</span><span style="color: #000000"> } = </span><span style="color: #795E26">useAuth0</span><span style="color: #000000">&lt;{ </span><span style="color: #001080">name</span><span style="color: #000000">: </span><span style="color: #267F99">string</span><span style="color: #000000"> }&gt;();</span>
+
+<span style="color: #001080">user</span><span style="color: #000000">.</span><span style="color: #001080">name</span><span style="color: #000000">; </span><span style="color: #008000">// is a string</span>
 </code></pre>
 				<a href="#use-with-a-class-component" id="use-with-a-class-component" style="color: inherit; text-decoration: none;">
 					<h3>Use with a Class Component</h3>
@@ -326,6 +331,7 @@ <h2>Legend</h2>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>

docs/interfaces/auth0_context.redirectloginoptions.html

@@ -128,7 +128,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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-react/blob/3cd13e7/src/auth0-context.tsx#L28">src/auth0-context.tsx:28</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-context.tsx#L30">src/auth0-context.tsx:30</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> fragment</h3>
 					<div class="tsd-signature tsd-kind-icon">fragment<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/3cd13e7/src/auth0-context.tsx#L33">src/auth0-context.tsx:33</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-context.tsx#L35">src/auth0-context.tsx:35</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -288,7 +288,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> organization</h3>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>The Id of an organization to log in to (Organizations is currently a Closed Beta).</p>
+							<p>The Id of an organization to log in to.</p>
 						</div>
 						<p>This will specify an <code>organization</code> parameter in your user&#39;s login request and will add a step to validate
 						the <code>org_id</code> claim in your user&#39;s ID Token.</p>
@@ -321,7 +321,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> redirect<wbr>Uri</h3>
 					<div class="tsd-signature tsd-kind-icon">redirect<wbr>Uri<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/3cd13e7/src/auth0-context.tsx#L23">src/auth0-context.tsx:23</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-context.tsx#L25">src/auth0-context.tsx:25</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -420,7 +420,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ui_<wbr>locales</h3>
 			</nav>
 			<nav class="tsd-navigation secondary menu-sticky">
 				<ul class="before-current">
-					<li class=" tsd-kind-interface tsd-parent-kind-module">
+					<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
 						<a href="auth0_context.auth0contextinterface.html" class="tsd-kind-icon">Auth0<wbr>Context<wbr>Interface</a>
 					</li>
 				</ul>
@@ -440,6 +440,7 @@ <h2>Legend</h2>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
 			</ul>
 			<ul class="tsd-legend">

docs/interfaces/auth0_provider.auth0provideroptions.html

@@ -130,7 +130,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> advanced<wbr>Options<
 					<div class="tsd-signature tsd-kind-icon">advanced<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>defaultScope<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L107">src/auth0-provider.tsx:107</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L108">src/auth0-provider.tsx:108</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -160,7 +160,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> audience</h3>
 					<div class="tsd-signature tsd-kind-icon">audience<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/3cd13e7/src/auth0-provider.tsx#L131">src/auth0-provider.tsx:131</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L132">src/auth0-provider.tsx:132</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -175,7 +175,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> authorize<wbr>Timeout
 					<div class="tsd-signature tsd-kind-icon">authorize<wbr>Timeout<wbr>InSeconds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L103">src/auth0-provider.tsx:103</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L104">src/auth0-provider.tsx:104</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -191,7 +191,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cache<wbr>Location</h
 					<div class="tsd-signature tsd-kind-icon">cache<wbr>Location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;memory&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;localstorage&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L91">src/auth0-provider.tsx:91</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L92">src/auth0-provider.tsx:92</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -208,7 +208,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> children</h3>
 					<div class="tsd-signature tsd-kind-icon">children<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReactNode</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L36">src/auth0-provider.tsx:36</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L37">src/auth0-provider.tsx:37</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -223,7 +223,7 @@ <h3>client<wbr>Id</h3>
 					<div class="tsd-signature tsd-kind-icon">client<wbr>Id<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/3cd13e7/src/auth0-provider.tsx#L70">src/auth0-provider.tsx:70</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L71">src/auth0-provider.tsx:71</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@ <h3>domain</h3>
 					<div class="tsd-signature tsd-kind-icon">domain<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/3cd13e7/src/auth0-provider.tsx#L62">src/auth0-provider.tsx:62</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L63">src/auth0-provider.tsx:63</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -255,7 +255,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> invitation</h3>
 					<div class="tsd-signature tsd-kind-icon">invitation<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/3cd13e7/src/auth0-provider.tsx#L142">src/auth0-provider.tsx:142</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L143">src/auth0-provider.tsx:143</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -270,7 +270,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> issuer</h3>
 					<div class="tsd-signature tsd-kind-icon">issuer<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/3cd13e7/src/auth0-provider.tsx#L66">src/auth0-provider.tsx:66</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L67">src/auth0-provider.tsx:67</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -285,7 +285,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> leeway</h3>
 					<div class="tsd-signature tsd-kind-icon">leeway<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L84">src/auth0-provider.tsx:84</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L85">src/auth0-provider.tsx:85</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -302,7 +302,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Age</h3>
 					<div class="tsd-signature tsd-kind-icon">max<wbr>Age<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L121">src/auth0-provider.tsx:121</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L122">src/auth0-provider.tsx:122</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -319,7 +319,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Redirect<wbr>C
 					<div class="tsd-signature tsd-kind-icon">on<wbr>Redirect<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>appState<span class="tsd-signature-symbol">: </span><a href="../modules/auth0_provider.html#appstate" class="tsd-signature-type" data-tsd-kind="Type alias">AppState</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/3cd13e7/src/auth0-provider.tsx#L42">src/auth0-provider.tsx:42</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L43">src/auth0-provider.tsx:43</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -357,7 +357,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> organization</h3>
 					<div class="tsd-signature tsd-kind-icon">organization<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/3cd13e7/src/auth0-provider.tsx#L138">src/auth0-provider.tsx:138</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L139">src/auth0-provider.tsx:139</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -374,7 +374,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> redirect<wbr>Uri</h3>
 					<div class="tsd-signature tsd-kind-icon">redirect<wbr>Uri<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/3cd13e7/src/auth0-provider.tsx#L78">src/auth0-provider.tsx:78</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L79">src/auth0-provider.tsx:79</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -393,7 +393,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> scope</h3>
 					<div class="tsd-signature tsd-kind-icon">scope<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/3cd13e7/src/auth0-provider.tsx#L127">src/auth0-provider.tsx:127</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L128">src/auth0-provider.tsx:128</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -410,7 +410,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> skip<wbr>Redirect<wbr
 					<div class="tsd-signature tsd-kind-icon">skip<wbr>Redirect<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L56">src/auth0-provider.tsx:56</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L57">src/auth0-provider.tsx:57</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -433,7 +433,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Refresh<wbr>T
 					<div class="tsd-signature tsd-kind-icon">use<wbr>Refresh<wbr>Tokens<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/3cd13e7/src/auth0-provider.tsx#L98">src/auth0-provider.tsx:98</a></li>
+							<li>Defined in <a href="https://github.com/auth0/auth0-react/blob/9a15c54/src/auth0-provider.tsx#L99">src/auth0-provider.tsx:99</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -554,6 +554,7 @@ <h2>Legend</h2>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
 			</ul>
 			<ul class="tsd-legend">

docs/interfaces/index.getidtokenclaimsoptions.html

@@ -199,6 +199,7 @@ <h2>Legend</h2>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>

docs/interfaces/index.gettokensilentlyoptions.html

@@ -264,6 +264,7 @@ <h2>Legend</h2>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>