Release 1.13.4 (#660)

auth0 · Dec 2, 2020 · b6eb0d9 · b6eb0d9
1 parent 7a25483
commit b6eb0d9
Show file tree

Hide file tree

Showing 24 changed files with 3,345 additions and 129 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Change Log
 
+## [v1.13.4](https://github.com/auth0/auth0-spa-js/tree/v1.13.4) (2020-12-02)
+
+[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.13.3...v1.13.4)
+
+**Added**
+
+- [SDK-2172] Add SDK metrics to all API calls [\#659](https://github.com/auth0/auth0-spa-js/pull/659) ([frederikprijck](https://github.com/frederikprijck))
+
+**Changed**
+
+- [SDK-1159] Use generics for getUser [\#651](https://github.com/auth0/auth0-spa-js/pull/651) ([frederikprijck](https://github.com/frederikprijck))
+
 ## [v1.13.3](https://github.com/auth0/auth0-spa-js/tree/v1.13.3) (2020-11-13)
 
 [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v1.13.2...v1.13.3)

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
@@ -2747,7 +2747,7 @@
 				<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>
-				<li class=" tsd-kind-method tsd-parent-kind-class">
+				<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
 					<a href="auth0client.html#getuser" class="tsd-kind-icon">get<wbr>User</a>
 				</li>
 				<li class=" tsd-kind-method tsd-parent-kind-class">
@@ -2779,6 +2779,9 @@
 		<li class=" tsd-kind-class">
 			<a href="timeouterror.html" class="tsd-kind-icon">Timeout<wbr>Error</a>
 		</li>
+		<li class=" tsd-kind-class">
+			<a href="user.html" class="tsd-kind-icon">User</a>
+		</li>
 		<li class=" tsd-kind-interface">
 			<a href="../interfaces/advancedoptions.html" class="tsd-kind-icon">Advanced<wbr>Options</a>
 		</li>
@@ -2877,7 +2880,7 @@ <h3>Methods</h3>
 							<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>
-							<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#getuser" class="tsd-kind-icon">get<wbr>User</a></li>
+							<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="auth0client.html#getuser" class="tsd-kind-icon">get<wbr>User</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#handleredirectcallback" class="tsd-kind-icon">handle<wbr>Redirect<wbr>Callback</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#isauthenticated" class="tsd-kind-icon">is<wbr>Authenticated</a></li>
 							<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth0client.html#loginwithpopup" class="tsd-kind-icon">login<wbr>With<wbr>Popup</a></li>
@@ -2900,7 +2903,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/72d8d82/src/Auth0Client.ts#L144">src/Auth0Client.ts:144</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L144">src/Auth0Client.ts:144</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2922,7 +2925,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/72d8d82/src/Auth0Client.ts#L143">src/Auth0Client.ts:143</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L143">src/Auth0Client.ts:143</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2939,7 +2942,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/72d8d82/src/Auth0Client.ts#L285">src/Auth0Client.ts:285</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L278">src/Auth0Client.ts:278</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2972,7 +2975,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/72d8d82/src/Auth0Client.ts#L726">src/Auth0Client.ts:726</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L726">src/Auth0Client.ts:726</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3003,7 +3006,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/72d8d82/src/Auth0Client.ts#L567">src/Auth0Client.ts:567</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L565">src/Auth0Client.ts:565</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3039,7 +3042,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/72d8d82/src/Auth0Client.ts#L443">src/Auth0Client.ts:443</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L440">src/Auth0Client.ts:440</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3070,7 +3073,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/72d8d82/src/Auth0Client.ts#L607">src/Auth0Client.ts:607</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L605">src/Auth0Client.ts:605</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3114,7 +3117,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/72d8d82/src/Auth0Client.ts#L678">src/Auth0Client.ts:678</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L676">src/Auth0Client.ts:676</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3141,17 +3144,17 @@ <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">
+			<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
 				<a name="getuser" class="tsd-anchor"></a>
 				<h3>get<wbr>User</h3>
-				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-					<li class="tsd-signature tsd-kind-icon">get<wbr>User<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/getuseroptions.html" class="tsd-signature-type">GetUserOptions</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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
+				<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
+					<li class="tsd-signature tsd-kind-icon">get<wbr>User&lt;TUser&gt;<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/getuseroptions.html" class="tsd-signature-type">GetUserOptions</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">TUser</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/72d8d82/src/Auth0Client.ts#L421">src/Auth0Client.ts:421</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L416">src/Auth0Client.ts:416</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3161,6 +3164,15 @@ <h3>get<wbr>User</h3>
 							<p>Returns the user information if available (decoded
 							from the <code>id_token</code>).</p>
 						</div>
+						<h4 class="tsd-type-parameters-title">Type parameters</h4>
+						<ul class="tsd-type-parameters">
+							<li>
+								<h4>TUser<span class="tsd-signature-symbol">: </span><a href="user.html" class="tsd-signature-type">User</a></h4>
+								<div class="tsd-comment tsd-typography">
+									<p>The type to return, has to extend <a href="user.html">User</a>. Defaults to <a href="user.html">User</a> when omitted.</p>
+								</div>
+							</li>
+						</ul>
 						<h4 class="tsd-parameters-title">Parameters</h4>
 						<ul class="tsd-parameters">
 							<li>
@@ -3169,7 +3181,7 @@ <h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a
 								</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
+						<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">TUser</span><span class="tsd-signature-symbol">&gt;</span></h4>
 					</li>
 				</ul>
 			</section>
@@ -3183,7 +3195,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/72d8d82/src/Auth0Client.ts#L478">src/Auth0Client.ts:478</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L475">src/Auth0Client.ts:475</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3214,7 +3226,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/72d8d82/src/Auth0Client.ts#L713">src/Auth0Client.ts:713</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L713">src/Auth0Client.ts:713</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3238,7 +3250,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/72d8d82/src/Auth0Client.ts#L338">src/Auth0Client.ts:338</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L331">src/Auth0Client.ts:331</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3278,7 +3290,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/72d8d82/src/Auth0Client.ts#L467">src/Auth0Client.ts:467</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L464">src/Auth0Client.ts:464</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3311,7 +3323,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/72d8d82/src/Auth0Client.ts#L755">src/Auth0Client.ts:755</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/Auth0Client.ts#L755">src/Auth0Client.ts:755</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/authenticationerror.html b/docs/classes/authenticationerror.html
@@ -2764,6 +2764,9 @@
 		<li class=" tsd-kind-class">
 			<a href="timeouterror.html" class="tsd-kind-icon">Timeout<wbr>Error</a>
 		</li>
+		<li class=" tsd-kind-class">
+			<a href="user.html" class="tsd-kind-icon">User</a>
+		</li>
 		<li class=" tsd-kind-interface">
 			<a href="../interfaces/advancedoptions.html" class="tsd-kind-icon">Advanced<wbr>Options</a>
 		</li>
@@ -2879,7 +2882,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/72d8d82/src/errors.ts#L19">src/errors.ts:19</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L19">src/errors.ts:19</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2910,7 +2913,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/72d8d82/src/errors.ts#L24">src/errors.ts:24</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L24">src/errors.ts:24</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2921,7 +2924,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/72d8d82/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2932,7 +2935,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/72d8d82/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2975,7 +2978,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/72d8d82/src/errors.ts#L23">src/errors.ts:23</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L23">src/errors.ts:23</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2993,7 +2996,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/72d8d82/src/errors.ts#L8">src/errors.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L8">src/errors.ts:8</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/classes/genericerror.html b/docs/classes/genericerror.html
@@ -2761,6 +2761,9 @@
 		<li class=" tsd-kind-class">
 			<a href="timeouterror.html" class="tsd-kind-icon">Timeout<wbr>Error</a>
 		</li>
+		<li class=" tsd-kind-class">
+			<a href="user.html" class="tsd-kind-icon">User</a>
+		</li>
 		<li class=" tsd-kind-interface">
 			<a href="../interfaces/advancedoptions.html" class="tsd-kind-icon">Advanced<wbr>Options</a>
 		</li>
@@ -2882,7 +2885,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/72d8d82/src/errors.ts#L1">src/errors.ts:1</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L1">src/errors.ts:1</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2907,7 +2910,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/72d8d82/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2917,7 +2920,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/72d8d82/src/errors.ts#L2">src/errors.ts:2</a></li>
+						<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L2">src/errors.ts:2</a></li>
 					</ul>
 				</aside>
 			</section>
@@ -2978,7 +2981,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Payload</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/72d8d82/src/errors.ts#L8">src/errors.ts:8</a></li>
+								<li>Defined in <a href="https://github.com/auth0/auth0-spa-js/blob/7a25483/src/errors.ts#L8">src/errors.ts:8</a></li>
 							</ul>
 						</aside>
 						<h4 class="tsd-parameters-title">Parameters</h4>