Release v9.19.2 (#1274)

auth0 · Nov 4, 2022 · de9c54a · de9c54a
1 parent 60563bc
commit de9c54a
Show file tree

Hide file tree

Showing 26 changed files with 128 additions and 57 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change Log
 
+## [v9.19.2](https://github.com/auth0/auth0.js/tree/v9.19.2) (2022-11-04)
+[Full Changelog](https://github.com/auth0/auth0.js/compare/v9.19.1...v9.19.2)
+
+**Changed**
+- Regenerate API docs using new readme [\#1271](https://github.com/auth0/auth0.js/pull/1271) ([frederikprijck](https://github.com/frederikprijck))
+- Update readme based on the internal redesign [\#1269](https://github.com/auth0/auth0.js/pull/1269) ([frederikprijck](https://github.com/frederikprijck))
+
+**Fixed**
+- support timeout option in Popup.loginWithCredentials [\#1273](https://github.com/auth0/auth0.js/pull/1273) ([stevehobbsdev](https://github.com/stevehobbsdev))
+
 ## [v9.19.1](https://github.com/auth0/auth0.js/tree/v9.19.1) (2022-09-09)
 [Full Changelog](https://github.com/auth0/auth0.js/compare/v9.19.0...v9.19.1)
 

diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ From CDN:
 
 ```html
 <!-- Latest patch release -->
-<script src="https://cdn.auth0.com/js/auth0/9.19.1/auth0.min.js"></script>
+<script src="https://cdn.auth0.com/js/auth0/9.19.2/auth0.min.js"></script>
 ```
 
 From [npm](https://npmjs.org):

diff --git a/dist/auth0.js b/dist/auth0.js
@@ -1,7 +1,7 @@
 /**
- * auth0-js v9.19.1
+ * auth0-js v9.19.2
  * Author: Auth0
- * Date: 2022-09-09
+ * Date: 2022-11-04
  * License: MIT
  */
 
@@ -4746,7 +4746,7 @@
 	  decode: decode$1
 	};
 
-	var version = { raw: '9.19.1' };
+	var version = { raw: '9.19.2' };
 
 	var toString = Object.prototype.toString;
 
@@ -7017,12 +7017,19 @@
 	 * @param {credentialsCallback} cb
 	 * @memberof Popup.prototype
 	 */
-	Popup.prototype.loginWithCredentials = function(options, cb) {
+	Popup.prototype.loginWithCredentials = function (options, cb) {
 	  options.realm = options.realm || options.connection;
 	  options.popup = true;
 	  options = objectHelper
-	    .merge(this.baseOptions, ['redirectUri', 'responseType', 'state', 'nonce'])
+	    .merge(this.baseOptions, [
+	      'redirectUri',
+	      'responseType',
+	      'state',
+	      'nonce',
+	      'timeout'
+	    ])
 	    .with(objectHelper.blacklist(options, ['popupHandler', 'connection']));
+
 	  options = this.transactionManager.process(options);
 	  this.crossOriginAuthentication.login(options, cb);
 	};
@@ -7789,6 +7796,22 @@
 	 * If the {@link userInfo} call fails, the {@link userInfo} error will be passed to the callback.
 	 * Tokens signed with other algorithms will not be accepted.
 	 *
+	 * @example
+	 * auth0.parseHash({ hash: window.location.hash }, function(err, authResult) {
+	 *   if (err) {
+	 *     return console.log(err);
+	 *   }
+
+	 *   // The contents of authResult depend on which authentication parameters were used.
+	 *   // It can include the following:
+	 *   // authResult.accessToken - access token for the API specified by `audience`
+	 *   // authResult.expiresIn - string with the access token's expiration time in seconds
+	 *   // authResult.idToken - ID token JWT containing user profile information
+
+	 *   auth0.client.userInfo(authResult.accessToken, function(err, user) {
+	 *     // Now you have the user's information
+	 *   });
+	 *});
 	 * @method parseHash
 	 * @param {Object} options
 	 * @param {String} options.hash the url hash. If not provided it will extract from window.location.hash
@@ -8180,6 +8203,30 @@
 	/**
 	 * Renews an existing session on Auth0's servers using `response_mode=web_message`
 	 *
+	 * Allows you to acquire a new token from Auth0 for a user who already
+	 * has an SSO session established against Auth0 for your domain. 
+	 * If the user is not authenticated, the authentication result will be empty 
+	 * and you'll receive an error like this: `{error: 'login_required'}`.
+	 * The method accepts any valid OAuth2 parameters that would normally be sent to `/authorize`.
+	 * 
+	 * Everything happens inside an iframe, so it will not reload your application or redirect away from it.
+	 * 
+	 * **Important:** If you're not using the hosted login page to do social logins, 
+	 * you have to use your own [social connection keys](https://manage.auth0.com/#/connections/social). 
+	 * If you use Auth0's dev keys, you'll always get `login_required` as an error when calling `checkSession`.
+	 *
+	 * **Important:** Because there is no redirect in this method, `responseType: 'code'` is not supported and will throw an error.
+
+	 * Remember to add the URL where the authorization request originates from to the Allowed Web Origins list of your Auth0 Application in the [Dashboard](https://manage.auth0.com/) under your Applications's **Settings**.
+	 * @example
+	 * auth0.checkSession({
+	 *   audience: 'https://mystore.com/api/v2',
+	 *   scope: 'read:order write:order'
+	 * },
+	 * function(err, authResult) {
+	 *   // Authentication tokens or error
+	 * });
+	 * 
 	 * @method checkSession
 	 * @param {Object} [options]
 	 * @param {String} [options.clientID] the Client ID found on your Application settings page
@@ -8317,6 +8364,13 @@
 	 * Redirects to the hosted login page (`/authorize`) in order to start a new authN/authZ transaction.
 	 * After that, you'll have to use the {@link parseHash} function at the specified `redirectUri`.
 	 *
+	 * @example
+	 * auth0.authorize({
+	 *   audience: 'https://mystore.com/api/v2',
+	 *   scope: 'read:order write:order',
+	 *   responseType: 'token',
+	 *   redirectUri: 'https://example.com/auth/callback'
+	 *});
 	 * @method authorize
 	 * @param {Object} [options]
 	 * @param {String} [options.clientID] the Client ID found on your Application settings page
@@ -8325,7 +8379,7 @@
 	 * @param {String} [options.responseMode] how the Auth response is encoded and redirected back to the client. Supported values are `query`, `fragment` and `form_post`. The `query` value is only supported when `responseType` is `code`. {@link https://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#ResponseModes}
 	 * @param {String} [options.state] value used to mitigate XSRF attacks. {@link https://auth0.com/docs/protocols/oauth2/oauth-state}
 	 * @param {String} [options.nonce] value used to mitigate replay attacks when using Implicit Grant. {@link https://auth0.com/docs/api-auth/tutorials/nonce}
-	 * @param {String} [options.scope] scopes to be requested during Auth. e.g. `openid email`
+	 * @param {String} [options.scope] scopes to be requested during Auth. e.g. `openid email`. Defaults to `openid profile email`.
 	 * @param {String} [options.audience] identifier of the resource server who will consume the access token issued after Auth
 	 * @param {String} [options.organization] the Id of an organization to log in to
 	 * @param {String} [options.invitation] the ID of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow

diff --git a/dist/auth0.min.esm.js b/dist/auth0.min.esm.js
diff --git a/dist/auth0.min.esm.js.map b/dist/auth0.min.esm.js.map
diff --git a/dist/auth0.min.js b/dist/auth0.min.js
diff --git a/dist/auth0.min.js.map b/dist/auth0.min.js.map
diff --git a/dist/cordova-auth0-plugin.js b/dist/cordova-auth0-plugin.js
@@ -1,7 +1,7 @@
 /**
- * auth0-js v9.19.1
+ * auth0-js v9.19.2
  * Author: Auth0
- * Date: 2022-09-09
+ * Date: 2022-11-04
  * License: MIT
  */
 
@@ -11,7 +11,7 @@
   (global = global || self, global.CordovaAuth0Plugin = factory());
 }(this, (function () { 'use strict';
 
-  var version = { raw: '9.19.1' };
+  var version = { raw: '9.19.2' };
 
   var toString = Object.prototype.toString;
 

diff --git a/dist/cordova-auth0-plugin.min.js b/dist/cordova-auth0-plugin.min.js
diff --git a/dist/cordova-auth0-plugin.min.js.map b/dist/cordova-auth0-plugin.min.js.map
diff --git a/docs/Authentication.html b/docs/Authentication.html
@@ -4169,7 +4169,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/Management.html b/docs/Management.html
@@ -1205,7 +1205,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/Popup.html b/docs/Popup.html
@@ -1549,7 +1549,7 @@ <h6>Properties</h6>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="web-auth_popup.js.html">web-auth/popup.js</a>, <a href="web-auth_popup.js.html#line265">line 265</a>
+        <a href="web-auth_popup.js.html">web-auth/popup.js</a>, <a href="web-auth_popup.js.html#line272">line 272</a>
     </li></ul></dd>
 
 
@@ -1943,7 +1943,7 @@ <h6>Properties</h6>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="web-auth_popup.js.html">web-auth/popup.js</a>, <a href="web-auth_popup.js.html#line300">line 300</a>
+        <a href="web-auth_popup.js.html">web-auth/popup.js</a>, <a href="web-auth_popup.js.html#line307">line 307</a>
     </li></ul></dd>
 
 
@@ -1995,7 +1995,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/Redirect.html b/docs/Redirect.html
@@ -732,7 +732,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/WebAuth.html b/docs/WebAuth.html
@@ -6443,7 +6443,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/authentication_index.js.html b/docs/authentication_index.js.html
@@ -695,7 +695,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/banner.png b/docs/banner.png
diff --git a/docs/global.html b/docs/global.html
@@ -842,7 +842,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -26,7 +26,7 @@ <h1 class="page-title">Home</h1>
 
 
 
-    <h3>auth0-js 9.19.1</h3>
+    <h3>auth0-js 9.19.2</h3>
 
 
 
@@ -61,7 +61,7 @@ <h2>Getting started</h2>
 <h3>Installation</h3>
 <p>From CDN:</p>
 <pre class="prettyprint source lang-html"><code>&lt;!-- Latest patch release -->
-&lt;script src=&quot;https://cdn.auth0.com/js/auth0/9.19.1/auth0.min.js&quot;>&lt;/script>
+&lt;script src=&quot;https://cdn.auth0.com/js/auth0/9.19.2/auth0.min.js&quot;>&lt;/script>
 </code></pre>
 <p>From <a href="https://npmjs.org">npm</a>:</p>
 <pre class="prettyprint source lang-sh"><code>npm install auth0-js
@@ -112,22 +112,22 @@ <h3>auth0.webAuth</h3>
 </ul>
 <h3>auth0.Authentication</h3>
 <ul>
-<li><a href="http://localhost:8080/Authentication.html#buildAuthorizeUrl">buildAuthorizeUrl(options)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#buildLogoutUrl">buildLogoutUrl(options)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#delegation">delegation(options, callback)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#getChallenge">getChallenge(callback)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#getSSOData">getSSOData(withActiveDirectories, callback)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#login">login(options, callback)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#loginWithDefaultDirectory">loginWithDefaultDirectory(options, callback)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#loginWithResourceOwner">loginWithResourceOwner(options, callback)</a></li>
-<li><a href="http://localhost:8080/Authentication.html#userInfo">userInfo(token, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#buildAuthorizeUrl">buildAuthorizeUrl(options)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#buildLogoutUrl">buildLogoutUrl(options)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#delegation">delegation(options, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#getChallenge">getChallenge(callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#getSSOData">getSSOData(withActiveDirectories, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#login">login(options, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#loginWithDefaultDirectory">loginWithDefaultDirectory(options, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#loginWithResourceOwner">loginWithResourceOwner(options, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Authentication.html#userInfo">userInfo(token, callback)</a></li>
 </ul>
 <h3>auth0.Management</h3>
 <ul>
-<li><a href="http://localhost:8080/Management.html#getUser">getUser(userId, callback)</a></li>
-<li><a href="http://localhost:8080/Management.html#linkUser">linkUser(userId, secondaryUserId, callback)</a></li>
-<li><a href="http://localhost:8080/Management.html#patchUserAttributes">patchUserAttributes(userId, user, callback)</a></li>
-<li><a href="http://localhost:8080/Management.html#patchUserMetadata">patchUserMetadata(userId, userMetadata, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Management.html#getUser">getUser(userId, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Management.html#linkUser">linkUser(userId, secondaryUserId, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Management.html#patchUserAttributes">patchUserAttributes(userId, user, callback)</a></li>
+<li><a href="https://auth0.github.io/auth0.js/Management.html#patchUserMetadata">patchUserMetadata(userId, userMetadata, callback)</a></li>
 </ul>
 <h2>Feedback</h2>
 <h3>Contributing</h3>
@@ -167,7 +167,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/management_index.js.html b/docs/management_index.js.html
@@ -217,7 +217,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/web-auth_index.js.html b/docs/web-auth_index.js.html
@@ -1168,7 +1168,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/web-auth_popup.js.html b/docs/web-auth_popup.js.html
@@ -280,12 +280,19 @@ <h1 class="page-title">Source: web-auth/popup.js</h1>
  * @param {credentialsCallback} cb
  * @memberof Popup.prototype
  */
-Popup.prototype.loginWithCredentials = function(options, cb) {
+Popup.prototype.loginWithCredentials = function (options, cb) {
   options.realm = options.realm || options.connection;
   options.popup = true;
   options = objectHelper
-    .merge(this.baseOptions, ['redirectUri', 'responseType', 'state', 'nonce'])
+    .merge(this.baseOptions, [
+      'redirectUri',
+      'responseType',
+      'state',
+      'nonce',
+      'timeout'
+    ])
     .with(objectHelper.blacklist(options, ['popupHandler', 'connection']));
+
   options = this.transactionManager.process(options);
   this.crossOriginAuthentication.login(options, cb);
 };
@@ -367,7 +374,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/web-auth_redirect.js.html b/docs/web-auth_redirect.js.html
@@ -112,7 +112,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Oct 20 2022 12:02:43 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 04 2022 09:43:17 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "auth0-js",
-  "version": "9.19.1",
+  "version": "9.19.2",
   "description": "Auth0 headless browser sdk",
   "author": "Auth0",
   "license": "MIT",

diff --git a/src/version.js b/src/version.js
@@ -1 +1 @@
-module.exports = { raw: '9.19.1' };
+module.exports = { raw: '9.19.2' };
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		module.exports = { raw: '9.19.1' };
		module.exports = { raw: '9.19.2' };