Skip to content

Commit

Permalink
Release 1.9.0 (#492)
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamjmcgrath
adamjmcgrath committed Jun 2, 2020
1 parent 0602674 commit 5f9609a
Show file tree
Hide file tree
Showing 21 changed files with 168 additions and 113 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Change Log

## [v1.9.0](https://github.com/auth0/auth0-spa-js/tree/v1.9.0) (2020-06-02)

[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.8.2...v1.9.0)

**Added**

- [SDK-1695] Add `auth0Client` option so wrapper libraries can send their own client info [\#490](https://github.com/auth0/auth0-spa-js/pull/490) ([adamjmcgrath](https://github.com/adamjmcgrath))
- Add `checkSession` and ignore recoverable errors [\#482](https://github.com/auth0/auth0-spa-js/pull/482) ([adamjmcgrath](https://github.com/adamjmcgrath))

**Fixed**

- Update docs for returnTo and client_id params on logout [\#484](https://github.com/auth0/auth0-spa-js/pull/484) ([stevehobbsdev](https://github.com/stevehobbsdev))

## [v1.8.2](https://github.com/auth0/auth0-spa-js/tree/v1.8.2) (2020-05-26)

[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.8.1...v1.8.2)
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

64 changes: 52 additions & 12 deletions docs/classes/auth0client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2732,6 +2732,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="auth0client.html#buildauthorizeurl" class="tsd-kind-icon">build<wbr>Authorize<wbr>Url</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="auth0client.html#checksession" class="tsd-kind-icon">check<wbr>Session</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="auth0client.html#getidtokenclaims" class="tsd-kind-icon">get<wbr>IdToken<wbr>Claims</a>
</li>
Expand Down Expand Up @@ -2857,6 +2860,7 @@ <h3>Properties</h3>
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#buildauthorizeurl" class="tsd-kind-icon">build<wbr>Authorize<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#checksession" class="tsd-kind-icon">check<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#getidtokenclaims" class="tsd-kind-icon">get<wbr>IdToken<wbr>Claims</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#gettokensilently" class="tsd-kind-icon">get<wbr>Token<wbr>Silently</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#gettokenwithpopup" class="tsd-kind-icon">get<wbr>Token<wbr>With<wbr>Popup</a></li>
Expand All @@ -2883,7 +2887,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/91b7683/src/Auth0Client.ts#L96">src/Auth0Client.ts:96</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L97">src/Auth0Client.ts:97</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -2905,7 +2909,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/91b7683/src/Auth0Client.ts#L95">src/Auth0Client.ts:95</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L96">src/Auth0Client.ts:96</a></li>
</ul>
</aside>
</section>
Expand All @@ -2922,7 +2926,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/91b7683/src/Auth0Client.ts#L218">src/Auth0Client.ts:218</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L222">src/Auth0Client.ts:222</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -2945,6 +2949,42 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="checksession" class="tsd-anchor"></a>
<h3>check<wbr>Session</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">check<wbr>Session<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/gettokensilentlyoptions.html" class="tsd-signature-type">GetTokenSilentlyOptions</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/0602674/src/Auth0Client.ts#L495">src/Auth0Client.ts:495</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>
</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
pre-fill the token cache.</p>
<p>It should be used for silently logging in the user when you instantiate the
<code>Auth0Client</code> constructor. You should not need this if you are using the
<code>createAuth0Client</code> factory.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/gettokensilentlyoptions.html" class="tsd-signature-type">GetTokenSilentlyOptions</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <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></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getidtokenclaims" class="tsd-anchor"></a>
<h3>get<wbr>IdToken<wbr>Claims</h3>
Expand All @@ -2955,7 +2995,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/91b7683/src/Auth0Client.ts#L366">src/Auth0Client.ts:366</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L370">src/Auth0Client.ts:370</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2986,7 +3026,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/91b7683/src/Auth0Client.ts#L502">src/Auth0Client.ts:502</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L538">src/Auth0Client.ts:538</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3030,7 +3070,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/91b7683/src/Auth0Client.ts#L558">src/Auth0Client.ts:558</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L594">src/Auth0Client.ts:594</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3067,7 +3107,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/91b7683/src/Auth0Client.ts#L341">src/Auth0Client.ts:341</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L345">src/Auth0Client.ts:345</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3099,7 +3139,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/91b7683/src/Auth0Client.ts#L408">src/Auth0Client.ts:408</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L412">src/Auth0Client.ts:412</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3130,7 +3170,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/91b7683/src/Auth0Client.ts#L591">src/Auth0Client.ts:591</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L627">src/Auth0Client.ts:627</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3154,7 +3194,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/91b7683/src/Auth0Client.ts#L268">src/Auth0Client.ts:268</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L272">src/Auth0Client.ts:272</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3194,7 +3234,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/91b7683/src/Auth0Client.ts#L397">src/Auth0Client.ts:397</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L401">src/Auth0Client.ts:401</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3227,7 +3267,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/91b7683/src/Auth0Client.ts#L611">src/Auth0Client.ts:611</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/Auth0Client.ts#L647">src/Auth0Client.ts:647</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/authenticationerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2861,7 +2861,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/91b7683/src/errors.ts#L8">src/errors.ts:8</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L8">src/errors.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -2892,7 +2892,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/91b7683/src/errors.ts#L13">src/errors.ts:13</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
Expand All @@ -2903,7 +2903,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/91b7683/src/errors.ts#L2">src/errors.ts:2</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L2">src/errors.ts:2</a></li>
</ul>
</aside>
</section>
Expand All @@ -2914,7 +2914,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/91b7683/src/errors.ts#L2">src/errors.ts:2</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L2">src/errors.ts:2</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -2957,7 +2957,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/91b7683/src/errors.ts#L12">src/errors.ts:12</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L12">src/errors.ts:12</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/genericerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2861,7 +2861,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/91b7683/src/errors.ts#L1">src/errors.ts:1</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L1">src/errors.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -2886,7 +2886,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/91b7683/src/errors.ts#L2">src/errors.ts:2</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L2">src/errors.ts:2</a></li>
</ul>
</aside>
</section>
Expand All @@ -2896,7 +2896,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/91b7683/src/errors.ts#L2">src/errors.ts:2</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/errors.ts#L2">src/errors.ts:2</a></li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3085,7 +3085,7 @@ <h3>Cache<wbr>Location</h3>
<div class="tsd-signature tsd-kind-icon">Cache<wbr>Location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"memory"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"localstorage"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/91b7683/src/global.ts#L136">src/global.ts:136</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/global.ts#L142">src/global.ts:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3100,7 +3100,7 @@ <h3>get<wbr>IdToken<wbr>Claims<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>IdToken<wbr>Claims<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="interfaces/getidtokenclaimsoptions.html" class="tsd-signature-type">GetIdTokenClaimsOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/91b7683/src/global.ts#L219">src/global.ts:219</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/global.ts#L225">src/global.ts:225</a></li>
</ul>
</aside>
</section>
Expand All @@ -3113,7 +3113,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> CACHE_<wbr>LOCATION_<wbr>LO
<div class="tsd-signature tsd-kind-icon">CACHE_<wbr>LOCATION_<wbr>LOCAL_<wbr>STORAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"localstorage"</span><span class="tsd-signature-symbol"> = &quot;localstorage&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/91b7683/src/constants.ts#L31">src/constants.ts:31</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/constants.ts#L31">src/constants.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -3123,7 +3123,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> CACHE_<wbr>LOCATION_<wbr>ME
<div class="tsd-signature tsd-kind-icon">CACHE_<wbr>LOCATION_<wbr>MEMORY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"memory"</span><span class="tsd-signature-symbol"> = &quot;memory&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/91b7683/src/constants.ts#L30">src/constants.ts:30</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/constants.ts#L30">src/constants.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -3133,7 +3133,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> MISSING_<wbr>REFRESH_<wbr>T
<div class="tsd-signature tsd-kind-icon">MISSING_<wbr>REFRESH_<wbr>TOKEN_<wbr>ERROR_<wbr>MESSAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"The web worker is missing the refresh token"</span><span class="tsd-signature-symbol"> = &quot;The web worker is missing the refresh token&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/91b7683/src/constants.ts#L32">src/constants.ts:32</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/constants.ts#L32">src/constants.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -3150,7 +3150,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/91b7683/src/index.ts#L20">src/index.ts:20</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/0602674/src/index.ts#L18">src/index.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
Loading

0 comments on commit 5f9609a

Please sign in to comment.