Skip to content

Commit

Permalink
Release v1.20.0 (#876)
Browse files Browse the repository at this point in the history
  • Loading branch information
@stevehobbsdev
stevehobbsdev authored Feb 14, 2022
1 parent 5015987 commit 451956f
Show file tree
Hide file tree
Showing 35 changed files with 303 additions and 259 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Change Log

## [v1.20.0](https://github.com/auth0/auth0-spa-js/tree/v1.20.0) (2022-02-14)
[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.19.4...v1.20.0)

**Added**
- [SDK-3105] Add httpTimeoutInSeconds to control fetch timeout [\#875](https://github.com/auth0/auth0-spa-js/pull/875) ([stevehobbsdev](https://github.com/stevehobbsdev))

**Changed**
- clarify documentation comment for getTokenSilently [\#874](https://github.com/auth0/auth0-spa-js/pull/874) ([jdugan1024](https://github.com/jdugan1024))

**Fixed**
- Fix getTokenSilently reference in example code [\#868](https://github.com/auth0/auth0-spa-js/pull/868) ([mdlavin](https://github.com/mdlavin))

**Security**
- [Snyk] Upgrade core-js from 3.20.2 to 3.20.3 [\#873](https://github.com/auth0/auth0-spa-js/pull/873) ([snyk-bot](https://github.com/snyk-bot))
- Bump node-fetch from 2.6.1 to 2.6.7 [\#870](https://github.com/auth0/auth0-spa-js/pull/870) ([dependabot[bot]](https://github.com/apps/dependabot))
- [Snyk] Upgrade core-js from 3.20.1 to 3.20.2 [\#869](https://github.com/auth0/auth0-spa-js/pull/869) ([snyk-bot](https://github.com/snyk-bot))
- [Snyk] Upgrade core-js from 3.20.0 to 3.20.1 [\#864](https://github.com/auth0/auth0-spa-js/pull/864) ([snyk-bot](https://github.com/snyk-bot))

## [v1.19.4](https://github.com/auth0/auth0-spa-js/tree/v1.19.4) (2022-01-14)
[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.19.3...v1.19.4)

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Auth0 SDK for Single Page Applications using [Authorization Code Grant Flow with
From the CDN:

```html
<script src="https://cdn.auth0.com/js/auth0-spa-js/1.19/auth0-spa-js.production.js"></script>
<script src="https://cdn.auth0.com/js/auth0-spa-js/1.20/auth0-spa-js.production.js"></script>
```

Using [npm](https://npmjs.org):
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

58 changes: 33 additions & 25 deletions docs/classes/auth0client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2834,7 +2834,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/d21736f/src/Auth0Client.ts#L205">src/Auth0Client.ts:205</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L207">src/Auth0Client.ts:207</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -2856,7 +2856,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/d21736f/src/Auth0Client.ts#L204">src/Auth0Client.ts:204</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L206">src/Auth0Client.ts:206</a></li>
</ul>
</aside>
</section>
Expand All @@ -2873,7 +2873,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/d21736f/src/Auth0Client.ts#L401">src/Auth0Client.ts:401</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L408">src/Auth0Client.ts:408</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2907,7 +2907,7 @@ <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/d21736f/src/Auth0Client.ts#L971">src/Auth0Client.ts:971</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L986">src/Auth0Client.ts:986</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2939,7 +2939,7 @@ <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/d21736f/src/Auth0Client.ts#L742">src/Auth0Client.ts:742</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L751">src/Auth0Client.ts:751</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -2984,7 +2984,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/d21736f/src/Auth0Client.ts#L592">src/Auth0Client.ts:592</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L600">src/Auth0Client.ts:600</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3020,7 +3020,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/d21736f/src/Auth0Client.ts#L770">src/Auth0Client.ts:770</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L779">src/Auth0Client.ts:779</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3029,11 +3029,15 @@ <h3>get<wbr>Token<wbr>Silently</h3>
</div>
<pre><code class="language-js"><span class="hljs-keyword">const</span> token = <span class="hljs-keyword">await</span> auth0.getTokenSilently(options);
</code></pre>
<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
as arguments. Random and secure <code>state</code> and <code>nonce</code> parameters
will be auto-generated. If the response is successful, results
will be valid according to their expiration times.</p>
<p>If there&#39;s a valid token stored and it has more than 60 seconds
remaining before expiration, return the token. Otherwise, attempt
to obtain a new token.</p>
<p>A new token will be obtained either by opening an iframe or a
refresh token (if <code>useRefreshTokens</code> is <code>true</code>)</p>
<p>If iframes are used, opens an iframe 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,
results will be validated according to their expiration times.</p>
<p>If refresh tokens are used, the token endpoint is called directly with the
&#39;refresh_token&#39; grant. If no refresh token is available to make this call,
the SDK falls back to using an iframe to the &#39;/authorize&#39; URL.</p>
Expand All @@ -3059,7 +3063,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/d21736f/src/Auth0Client.ts#L779">src/Auth0Client.ts:779</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L788">src/Auth0Client.ts:788</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3068,11 +3072,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</div>
<pre><code class="language-js"><span class="hljs-keyword">const</span> token = <span class="hljs-keyword">await</span> auth0.getTokenSilently(options);
</code></pre>
<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
as arguments. Random and secure <code>state</code> and <code>nonce</code> parameters
will be auto-generated. If the response is successful, results
will be valid according to their expiration times.</p>
<p>If there&#39;s a valid token stored and it has more than 60 seconds
remaining before expiration, return the token. Otherwise, attempt
to obtain a new token.</p>
<p>A new token will be obtained either by opening an iframe or a
refresh token (if <code>useRefreshTokens</code> is <code>true</code>)</p>
<p>If iframes are used, opens an iframe 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,
results will be validated according to their expiration times.</p>
<p>If refresh tokens are used, the token endpoint is called directly with the
&#39;refresh_token&#39; grant. If no refresh token is available to make this call,
the SDK falls back to using an iframe to the &#39;/authorize&#39; URL.</p>
Expand Down Expand Up @@ -3107,7 +3115,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/d21736f/src/Auth0Client.ts#L919">src/Auth0Client.ts:919</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L934">src/Auth0Client.ts:934</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3145,7 +3153,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/d21736f/src/Auth0Client.ts#L562">src/Auth0Client.ts:562</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L570">src/Auth0Client.ts:570</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3190,7 +3198,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/d21736f/src/Auth0Client.ts#L634">src/Auth0Client.ts:634</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L642">src/Auth0Client.ts:642</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3227,7 +3235,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/d21736f/src/Auth0Client.ts#L958">src/Auth0Client.ts:958</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L973">src/Auth0Client.ts:973</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -3252,7 +3260,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/d21736f/src/Auth0Client.ts#L461">src/Auth0Client.ts:461</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L468">src/Auth0Client.ts:468</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3299,7 +3307,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/d21736f/src/Auth0Client.ts#L620">src/Auth0Client.ts:620</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L628">src/Auth0Client.ts:628</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -3339,7 +3347,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/d21736f/src/Auth0Client.ts#L1003">src/Auth0Client.ts:1003</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/Auth0Client.ts#L1018">src/Auth0Client.ts:1018</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
18 changes: 9 additions & 9 deletions docs/classes/authenticationerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2821,7 +2821,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/d21736f/src/errors.ts#L31">src/errors.ts:31</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/errors.ts#L31">src/errors.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -2852,7 +2852,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/d21736f/src/errors.ts#L37">src/errors.ts:37</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/errors.ts#L37">src/errors.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -2863,7 +2863,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/d21736f/src/errors.ts#L11">src/errors.ts:11</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/errors.ts#L11">src/errors.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -2874,7 +2874,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/d21736f/src/errors.ts#L11">src/errors.ts:11</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/errors.ts#L11">src/errors.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -2885,7 +2885,7 @@ <h3>message</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#message">message</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:974</li>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1023</li>
</ul>
</aside>
</section>
Expand All @@ -2896,7 +2896,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#name">name</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:973</li>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1022</li>
</ul>
</aside>
</section>
Expand All @@ -2907,7 +2907,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="genericerror.html">GenericError</a>.<a href="genericerror.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:1024</li>
</ul>
</aside>
</section>
Expand All @@ -2917,7 +2917,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/d21736f/src/errors.ts#L36">src/errors.ts:36</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/errors.ts#L36">src/errors.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -2935,7 +2935,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/d21736f/src/errors.ts#L16">src/errors.ts:16</a></li>
<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/5015987/src/errors.ts#L16">src/errors.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
Loading

0 comments on commit 451956f

Please sign in to comment.