Release v2.4.0

auth0 · Jun 5, 2020 · 46cd8e1 · 46cd8e1
1 parent 06909eb
commit 46cd8e1
Show file tree

Hide file tree

Showing 14 changed files with 138 additions and 94 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Change Log
 
+## [v2.4.0](https://github.com/auth0/react-native-auth0/tree/v2.4.0) (2020-06-05)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.3.1...v2.4.0)
+
+**Added**
+
+- Added support for ephemeral sessions [SDK-1412][\#305](https://github.com/auth0/react-native-auth0/pull/305) ([Widcket](https://github.com/Widcket))
+
+**Security**
+
+- Bump dependencies in the lock file [\#313](https://github.com/auth0/react-native-auth0/pull/313) ([lbalmaceda](https://github.com/lbalmaceda))
+
 ## [v2.3.1](https://github.com/auth0/react-native-auth0/tree/v2.3.1) (2020-04-29)
 
 [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.3.0...v2.3.1)

diff --git a/docs/Auth.html b/docs/Auth.html
@@ -2067,8 +2067,8 @@ <h5>Returns:</h5>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Auth0.html b/docs/Auth0.html
@@ -229,8 +229,8 @@ <h3 class="subsection-title">Classes</h3>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Auth0.module.exports.html b/docs/Auth0.module.exports.html
@@ -294,8 +294,8 @@ <h5>Parameters:</h5>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Users.html b/docs/Users.html
@@ -462,8 +462,8 @@ <h5>Returns:</h5>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/WebAuth.html b/docs/WebAuth.html
@@ -266,7 +266,7 @@ <h4 class="name" id=".authorize">
                 <ul class="dummy">
                   <li>
                     <a href="src_webauth_index.js.html">src/webauth/index.js</a
-                    >, <a href="src_webauth_index.js.html#line58">line 58</a>
+                    >, <a href="src_webauth_index.js.html#line59">line 59</a>
                   </li>
                 </ul>
               </dd>
@@ -306,7 +306,7 @@ <h5>Parameters:</h5>
                   </td>
 
                   <td class="description last">
-                    <p>parameters to send on the AuthN/AuthZ request.</p>
+                    <p>Parameters to send on the AuthN/AuthZ request.</p>
 
                     <table class="params">
                       <thead>
@@ -333,7 +333,7 @@ <h5>Parameters:</h5>
 
                           <td class="description last">
                             <p>
-                              random string to prevent CSRF attacks and used to
+                              Random string to prevent CSRF attacks and used to
                               discard unexepcted results. By default its a
                               cryptographically secure random.
                             </p>
@@ -351,7 +351,7 @@ <h5>Parameters:</h5>
 
                           <td class="description last">
                             <p>
-                              random string to prevent replay attacks of
+                              Random string to prevent replay attacks of
                               id_tokens.
                             </p>
                           </td>
@@ -368,7 +368,7 @@ <h5>Parameters:</h5>
 
                           <td class="description last">
                             <p>
-                              identifier of Resource Server (RS) to be included
+                              Identifier of Resource Server (RS) to be included
                               as audience (aud claim) of the issued access token
                             </p>
                           </td>
@@ -385,7 +385,7 @@ <h5>Parameters:</h5>
 
                           <td class="description last">
                             <p>
-                              scopes requested for the issued tokens. e.g.
+                              Scopes requested for the issued tokens. e.g.
                               <code>openid profile</code>
                             </p>
                           </td>
@@ -439,7 +439,7 @@ <h5>Parameters:</h5>
                   </td>
 
                   <td class="description last">
-                    <p>options for ID token validation configuration.</p>
+                    <p>Other configuration options.</p>
 
                     <table class="params">
                       <thead>
@@ -472,6 +472,23 @@ <h5>Parameters:</h5>
                             </p>
                           </td>
                         </tr>
+
+                        <tr>
+                          <td class="name"><code>ephemeralSession</code></td>
+
+                          <td class="type">
+                            <span class="param-type"><code>Boolean</code></span>
+                          </td>
+
+                          <td class="attributes">&lt;optional><br /></td>
+
+                          <td class="description last">
+                            <p>
+                              Disable Single-Sign-On (SSO). It only affects iOS
+                              with versions 13 and above.
+                            </p>
+                          </td>
+                        </tr>
                       </tbody>
                     </table>
                   </td>
@@ -518,7 +535,7 @@ <h4 class="name" id=".clearSession">
                 <ul class="dummy">
                   <li>
                     <a href="src_webauth_index.js.html">src/webauth/index.js</a
-                    >, <a href="src_webauth_index.js.html#line125">line 125</a>
+                    >, <a href="src_webauth_index.js.html#line128">line 128</a>
                   </li>
                 </ul>
               </dd>
@@ -557,7 +574,7 @@ <h5>Parameters:</h5>
                   </td>
 
                   <td class="description last">
-                    <p>parameters to send</p>
+                    <p>Parameters to send</p>
 
                     <table class="params">
                       <thead>
@@ -613,8 +630,8 @@ <h5>Returns:</h5>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/global.html b/docs/global.html
@@ -268,8 +268,8 @@ <h5>Returns:</h5>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/index.html b/docs/index.html
@@ -298,13 +298,13 @@ <h3>Compatibility Matrix</h3>
           </p>
           <h2>Getting Started</h2>
           <p>First install the native library module:</p>
-          <p>Using <a href="https://www.npmjs.com">npm</a></p>
+          <h3>With <a href="https://www.npmjs.com">npm</a></h3>
           <p><code>$ npm install react-native-auth0 --save</code></p>
-          <p>or <a href="https://yarnpkg.com/en/">yarn</a></p>
+          <h3>With <a href="https://yarnpkg.com/en/">Yarn</a></h3>
           <p><code>$ yarn add react-native-auth0</code></p>
           <p>
             Then, you need to run the following command to install the ios app
-            pods with Cocoapods. That will auto-link the iOS library.
+            pods with Cocoapods. That will auto-link the iOS library:
           </p>
           <p><code>$ cd ios &amp;&amp; pod install</code></p>
           <h3>Configuration</h3>
@@ -372,17 +372,17 @@ <h4>Android</h4>
           </p>
           <blockquote>
             <p>
-              For more info please read
+              For more info please read the
               <a
                 href="https://facebook.github.io/react-native/docs/linking.html"
-                >react native docs</a
-              >
+                >React Native docs</a
+              >.
             </p>
           </blockquote>
           <h4>iOS</h4>
           <p>
             Inside the <code>ios</code> folder find the file
-            <code>AppDelegate.[swift|m]</code> add the following to it
+            <code>AppDelegate.[swift|m]</code> add the following to it:
           </p>
           <pre
             class="prettyprint source lang-objc"
@@ -408,7 +408,7 @@ <h4>iOS</h4>
           <p>
             and then below it register a URL type entry using the value of
             <code>CFBundleIdentifier</code> as the value for
-            <code>CFBundleURLSchemes</code>
+            <code>CFBundleURLSchemes</code>:
           </p>
           <pre
             class="prettyprint source lang-xml"
@@ -458,11 +458,11 @@ <h4>iOS</h4>
           </ul>
           <blockquote>
             <p>
-              For more info please read
+              For more info please read the
               <a
                 href="https://facebook.github.io/react-native/docs/linking.html"
-                >react native docs</a
-              >
+                >React Native docs</a
+              >.
             </p>
           </blockquote>
           <h3>Callback URL(s)</h3>
@@ -550,13 +550,25 @@ <h2>Usage</h2>
             </p>
           </blockquote>
           <h3>Web Authentication</h3>
-          <h4>Log in</h4>
+          <h4>Login</h4>
           <pre class="prettyprint source lang-js"><code>auth0.webAuth
   .authorize({scope: 'openid email profile'})
   .then(credentials => console.log(credentials))
   .catch(error => console.log(error));
 </code></pre>
-          <h4>Log out</h4>
+          <h5>Disable Single Sign On (iOS 13+ only)</h5>
+          <p>
+            Use the <code>ephemeralSession</code> parameter to disable SSO on
+            iOS 13+. This way iOS will not display the consent popup that
+            otherwise shows up when SSO is enabled. It has no effect on older
+            versions of iOS or Android.
+          </p>
+          <pre class="prettyprint source lang-js"><code>auth0.webAuth
+  .authorize({scope: 'openid email profile'}, {ephemeralSession: true})
+  .then(credentials => console.log(credentials))
+  .catch(error => console.log(error));
+</code></pre>
+          <h4>Logout</h4>
           <pre
             class="prettyprint source lang-js"
           ><code>auth0.webAuth.clearSession().catch(error => console.log(error));
@@ -772,8 +784,8 @@ <h2>License</h2>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -229,8 +229,8 @@ <h1 class="page-title">index.js</h1>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:53 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/src_auth_index.js.html b/docs/src_auth_index.js.html
@@ -697,8 +697,8 @@ <h1 class="page-title">src/auth/index.js</h1>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:53 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/src_management_users.js.html b/docs/src_management_users.js.html
@@ -297,8 +297,8 @@ <h1 class="page-title">src/management/users.js</h1>
     <br class="clear" />
 
     <footer>
-      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
+      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
+      Fri Jun 05 2020 13:51:53 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>