Release 1.7.0 (#421)

auth0 · Apr 15, 2020 · de3f3d0 · de3f3d0
1 parent 476caea
commit de3f3d0
Show file tree

Hide file tree

Showing 22 changed files with 302 additions and 140 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,36 @@
 # Change Log
 
+## [v1.7.0](https://github.com/auth0/auth0-spa-js/tree/v1.7.0) (2020-04-15)
+
+[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.7.0-beta.5...v1.7.0)
+
+**Added**
+
+- Support for rotating refresh tokens [\#315](https://github.com/auth0/auth0-spa-js/pull/315) ([stevehobbsdev](https://github.com/stevehobbsdev))
+- Export types from global TypeScript file. [\#310](https://github.com/auth0/auth0-spa-js/pull/310) ([maxswa](https://github.com/maxswa))
+- Local Storage caching mechanism [\#303](https://github.com/auth0/auth0-spa-js/pull/303) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
+**Changed**
+
+- Use Web Workers for token endpoint call for in-memory storage [\#409](https://github.com/auth0/auth0-spa-js/pull/409) ([adamjmcgrath](https://github.com/adamjmcgrath))
+- Export constructor [\#385](https://github.com/auth0/auth0-spa-js/pull/385) ([adamjmcgrath](https://github.com/adamjmcgrath))
+- Fall back to iframe method if no refresh token is available [\#364](https://github.com/auth0/auth0-spa-js/pull/364) ([stevehobbsdev](https://github.com/stevehobbsdev))
+- Removed setTimeout cache removal in favour of removal-on-read [\#354](https://github.com/auth0/auth0-spa-js/pull/354) ([stevehobbsdev](https://github.com/stevehobbsdev))
+- Stop checking `isAuthenticated` cookie on initialization when using local storage [\#352](https://github.com/auth0/auth0-spa-js/pull/352) ([stevehobbsdev](https://github.com/stevehobbsdev))
+- getTokenSilently retry logic [\#336](https://github.com/auth0/auth0-spa-js/pull/336) ([stevehobbsdev](https://github.com/stevehobbsdev))
+- Fixed issue with cache not retaining refresh token [\#333](https://github.com/auth0/auth0-spa-js/pull/333) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
+**Fixed**
+
+- Check if source of event exists before closing it [\#410](https://github.com/auth0/auth0-spa-js/pull/410) ([gerritdeperrit](https://github.com/gerritdeperrit))
+- Check if iframe is still in body before removing [\#399](https://github.com/auth0/auth0-spa-js/pull/399) ([paulfalgout](https://github.com/paulfalgout))
+- Fix typings to allow custom claims in ID token [\#386](https://github.com/auth0/auth0-spa-js/pull/386) ([picosam](https://github.com/picosam))
+- Fix error in library type definitions [\#367](https://github.com/auth0/auth0-spa-js/pull/367) ([devoto13](https://github.com/devoto13))
+
+**Security**
+
+- Dependency upgrade [\#405](https://github.com/auth0/auth0-spa-js/pull/405) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
 ## [v1.7.0-beta.5](https://github.com/auth0/auth0-spa-js/tree/v1.7.0-beta.5) (2020-03-26)
 
 [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.7.0-beta.4...v1.7.0-beta.5)

diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/classes/auth0client.html b/docs/classes/auth0client.html
@@ -2809,6 +2809,9 @@
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#cache_location_memory" class="tsd-kind-icon">CACHE_<wbr>LOCATION_<wbr>MEMORY</a>
 		</li>
+		<li class=" tsd-kind-variable">
+			<a href="../globals.html#missing_refresh_token_error_message" class="tsd-kind-icon">MISSING_<wbr>REFRESH_<wbr>TOKEN_<wbr>ERROR_<wbr>MESSAGE</a>
+		</li>
 		<li class=" tsd-kind-function">
 			<a href="../globals.html#createauth0client" class="tsd-kind-icon">create<wbr>Auth0<wbr>Client</a>
 		</li>
@@ -2877,7 +2880,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/dd0ed8a/src/Auth0Client.ts#L80">src/Auth0Client.ts:80</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L91">src/Auth0Client.ts:91</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2899,7 +2902,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/dd0ed8a/src/Auth0Client.ts#L80">src/Auth0Client.ts:80</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L90">src/Auth0Client.ts:90</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2916,7 +2919,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/dd0ed8a/src/Auth0Client.ts#L176">src/Auth0Client.ts:176</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L205">src/Auth0Client.ts:205</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2949,7 +2952,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/dd0ed8a/src/Auth0Client.ts#L321">src/Auth0Client.ts:321</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L353">src/Auth0Client.ts:353</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2961,7 +2964,7 @@ <h3>get<wbr>IdToken<wbr>Claims</h3>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
-								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/getidtokenclaimsoptions.html" class="tsd-signature-type">GetIdTokenClaimsOptions</a><span class="tsd-signature-symbol"> = {audience: this.options.audience || &#x27;default&#x27;,scope: this.options.scope || this.DEFAULT_SCOPE}</span></h5>
+								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/getidtokenclaimsoptions.html" class="tsd-signature-type">GetIdTokenClaimsOptions</a><span class="tsd-signature-symbol"> = {audience: this.options.audience || &#x27;default&#x27;,scope: this.options.scope || this.DEFAULT_SCOPE,}</span></h5>
 								<div class="tsd-comment tsd-typography">
 								</div>
 							</li>
@@ -2980,7 +2983,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/dd0ed8a/src/Auth0Client.ts#L444">src/Auth0Client.ts:444</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L489">src/Auth0Client.ts:489</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2992,6 +2995,15 @@ <h3>get<wbr>Token<wbr>Silently</h3>
 								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 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>
+							<p>This method may use a web worker to perform the token call if the in-memory
+							cache is used.</p>
+							<p>If an <code>audience</code> value is given to this function, the SDK always falls
+							back to using an iframe to make the token exchange.</p>
+							<p>Note that in all cases, falling back to an iframe requires access to
+							the <code>auth0</code> cookie.</p>
 						</div>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
@@ -3015,7 +3027,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/dd0ed8a/src/Auth0Client.ts#L500">src/Auth0Client.ts:500</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L549">src/Auth0Client.ts:549</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3030,7 +3042,7 @@ <h3>get<wbr>Token<wbr>With<wbr>Popup</h3>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
-								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/gettokenwithpopupoptions.html" class="tsd-signature-type">GetTokenWithPopupOptions</a><span class="tsd-signature-symbol"> = {audience: this.options.audience,scope: this.options.scope || this.DEFAULT_SCOPE}</span></h5>
+								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/gettokenwithpopupoptions.html" class="tsd-signature-type">GetTokenWithPopupOptions</a><span class="tsd-signature-symbol"> = {audience: this.options.audience,scope: this.options.scope || this.DEFAULT_SCOPE,}</span></h5>
 								<div class="tsd-comment tsd-typography">
 								</div>
 							</li>
@@ -3052,7 +3064,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/dd0ed8a/src/Auth0Client.ts#L296">src/Auth0Client.ts:296</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L328">src/Auth0Client.ts:328</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3065,7 +3077,7 @@ <h3>get<wbr>User</h3>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
-								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/getuseroptions.html" class="tsd-signature-type">GetUserOptions</a><span class="tsd-signature-symbol"> = {audience: this.options.audience || &#x27;default&#x27;,scope: this.options.scope || this.DEFAULT_SCOPE}</span></h5>
+								<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/getuseroptions.html" class="tsd-signature-type">GetUserOptions</a><span class="tsd-signature-symbol"> = {audience: this.options.audience || &#x27;default&#x27;,scope: this.options.scope || this.DEFAULT_SCOPE,}</span></h5>
 								<div class="tsd-comment tsd-typography">
 								</div>
 							</li>
@@ -3084,7 +3096,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/dd0ed8a/src/Auth0Client.ts#L363">src/Auth0Client.ts:363</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L395">src/Auth0Client.ts:395</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3115,7 +3127,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/dd0ed8a/src/Auth0Client.ts#L533">src/Auth0Client.ts:533</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L582">src/Auth0Client.ts:582</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3139,7 +3151,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/dd0ed8a/src/Auth0Client.ts#L226">src/Auth0Client.ts:226</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L255">src/Auth0Client.ts:255</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3179,7 +3191,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/dd0ed8a/src/Auth0Client.ts#L352">src/Auth0Client.ts:352</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L384">src/Auth0Client.ts:384</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3212,7 +3224,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/dd0ed8a/src/Auth0Client.ts#L553">src/Auth0Client.ts:553</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/Auth0Client.ts#L602">src/Auth0Client.ts:602</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html
@@ -2797,6 +2797,9 @@
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#cache_location_memory" class="tsd-kind-icon">CACHE_<wbr>LOCATION_<wbr>MEMORY</a>
 		</li>
+		<li class=" tsd-kind-variable">
+			<a href="../globals.html#missing_refresh_token_error_message" class="tsd-kind-icon">MISSING_<wbr>REFRESH_<wbr>TOKEN_<wbr>ERROR_<wbr>MESSAGE</a>
+		</li>
 		<li class=" tsd-kind-function">
 			<a href="../globals.html#createauth0client" class="tsd-kind-icon">create<wbr>Auth0<wbr>Client</a>
 		</li>
@@ -2855,7 +2858,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/dd0ed8a/src/errors.ts#L8">src/errors.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L8">src/errors.ts:8</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2886,7 +2889,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/dd0ed8a/src/errors.ts#L13">src/errors.ts:13</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L13">src/errors.ts:13</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2897,7 +2900,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/dd0ed8a/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2908,7 +2911,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/dd0ed8a/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2951,7 +2954,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/dd0ed8a/src/errors.ts#L12">src/errors.ts:12</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L12">src/errors.ts:12</a></li>
 					</ul>
 				</aside>
 			</section>

diff --git a/docs/classes/genericerror.html b/docs/classes/genericerror.html
@@ -2794,6 +2794,9 @@
 		<li class=" tsd-kind-variable">
 			<a href="../globals.html#cache_location_memory" class="tsd-kind-icon">CACHE_<wbr>LOCATION_<wbr>MEMORY</a>
 		</li>
+		<li class=" tsd-kind-variable">
+			<a href="../globals.html#missing_refresh_token_error_message" class="tsd-kind-icon">MISSING_<wbr>REFRESH_<wbr>TOKEN_<wbr>ERROR_<wbr>MESSAGE</a>
+		</li>
 		<li class=" tsd-kind-function">
 			<a href="../globals.html#createauth0client" class="tsd-kind-icon">create<wbr>Auth0<wbr>Client</a>
 		</li>
@@ -2855,7 +2858,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/dd0ed8a/src/errors.ts#L1">src/errors.ts:1</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L1">src/errors.ts:1</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2880,7 +2883,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/dd0ed8a/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2890,7 +2893,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/dd0ed8a/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/476caea/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>