Release v2.15.0 (#547)

auth0 · Nov 7, 2022 · 2fe55ea · 2fe55ea
1 parent 92540f9
commit 2fe55ea
Show file tree

Hide file tree

Showing 17 changed files with 179 additions and 455 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Change Log
 
+## [v2.15.0](https://github.com/auth0/react-native-auth0/tree/v2.15.0) (2022-11-07)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.14.1...v2.15.0)
+
+**Added**
+
+- [SDK-3738] Option to clear session only in Credentials Manager [\#543](https://github.com/auth0/react-native-auth0/pull/543) ([poovamraj](https://github.com/poovamraj))
+
+**Fixed**
+
+- [SDK-3736] Fix: Options Parameter not being passed in Hooks `authorize` method [\#542](https://github.com/auth0/react-native-auth0/pull/542) ([poovamraj](https://github.com/poovamraj))
+
 ## [v2.14.1](https://github.com/auth0/react-native-auth0/tree/v2.14.1) (2022-10-19)
 
 [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.14.0...v2.14.1)

diff --git a/docs/Auth.html b/docs/Auth.html
@@ -2729,8 +2729,8 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/Auth0.html b/docs/Auth0.html
@@ -446,8 +446,8 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/CredentialsManager.html b/docs/CredentialsManager.html
@@ -846,8 +846,8 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/Users.html b/docs/Users.html
@@ -535,8 +535,8 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/WebAuth.html b/docs/WebAuth.html
@@ -835,8 +835,8 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/auth0.js.html b/docs/auth0.js.html
@@ -305,8 +305,8 @@ <h1 class="page-title">auth0.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
@@ -886,8 +886,8 @@ <h1 class="page-title">auth/index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/credentials-manager_index.js.html b/docs/credentials-manager_index.js.html
@@ -414,8 +414,8 @@ <h1 class="page-title">credentials-manager/index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/global.html b/docs/global.html
@@ -370,7 +370,7 @@ <h4 class="name" id="useAuth0">
                 <ul class="dummy">
                   <li>
                     <a href="hooks_use-auth0.js.html">hooks/use-auth0.js</a>,
-                    <a href="hooks_use-auth0.js.html#line29">line 29</a>
+                    <a href="hooks_use-auth0.js.html#line31">line 31</a>
                   </li>
                 </ul>
               </dd>
@@ -410,6 +410,7 @@ <h5>Example</h5>
   authorize,
   clearSession,
   getCredentials,
+  clearCredentials,
   requireLocalAuthentication
 } = useAuth0();</code></pre>
             </div>
@@ -489,10 +490,11 @@ <h5 class="subsection-title">Properties:</h5>
 
                   <td class="description last">
                     <p>
-                      Clears the user's session and logs them out. See
+                      Clears the user's web session, credentials and logs them
+                      out. See
                       <a href="WebAuth.html#clearSession"
                         ><code>WebAuth#clearSession</code></a
-                      >
+                      >.
                     </p>
                   </td>
                 </tr>
@@ -515,6 +517,21 @@ <h5 class="subsection-title">Properties:</h5>
                   </td>
                 </tr>
 
+                <tr>
+                  <td class="name"><code>clearCredentials</code></td>
+
+                  <td class="type">
+                    <span class="param-type"><code>function</code></span>
+                  </td>
+
+                  <td class="description last">
+                    <p>
+                      Clears the user's credentials without clearing their web
+                      session and logs them out.
+                    </p>
+                  </td>
+                </tr>
+
                 <tr>
                   <td class="name"><code>requireLocalAuthentication</code></td>
 
@@ -565,8 +582,8 @@ <h5>Type:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/hooks_auth0-provider.js.html b/docs/hooks_auth0-provider.js.html
@@ -326,6 +326,7 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
     async (...options) => {
       try {
         const opts = options.length ? options[0] : {};
+        const params = options.length > 1 ? options[1] : {};
         const specifiedScopes =
           opts?.scope?.split(' ').map(s => s.trim()) || [];
         const scopeSet = new Set([
@@ -335,7 +336,7 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
 
         opts.scope = Array.from(scopeSet).join(' ');
 
-        const credentials = await client.webAuth.authorize(opts);
+        const credentials = await client.webAuth.authorize(opts, params);
         const user = getIdTokenProfileClaims(credentials.idToken);
 
         await client.credentialsManager.saveCredentials(credentials);
@@ -374,6 +375,16 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
     [client],
   );
 
+  const clearCredentials = useCallback(async () => {
+    try {
+      await client.credentialsManager.clearCredentials();
+      dispatch({type: 'LOGOUT_COMPLETE'});
+    } catch (error) {
+      dispatch({type: 'ERROR', error});
+      return;
+    }
+  }, [client]);
+
   const requireLocalAuthentication = useCallback(async (...options) => {
     try {
       await client.credentialsManager.requireLocalAuthentication(...options);
@@ -389,13 +400,15 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
       authorize,
       clearSession,
       getCredentials,
+      clearCredentials,
       requireLocalAuthentication,
     }),
     [
       state,
       authorize,
       clearSession,
       getCredentials,
+      clearCredentials,
       requireLocalAuthentication,
     ],
   );
@@ -423,8 +436,8 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>

diff --git a/docs/hooks_use-auth0.js.html b/docs/hooks_use-auth0.js.html
@@ -269,8 +269,9 @@ <h1 class="page-title">hooks/use-auth0.js</h1>
  * @property {Object} user The user profile as decoded from the ID token after authentication
  * @property {Object} error An object representing the last exception
  * @property {Function} authorize Authorize the user using Auth0 Universal Login. See {@link WebAuth#authorize}
- * @property {Function} clearSession Clears the user's session and logs them out. See {@link WebAuth#clearSession}
+ * @property {Function} clearSession Clears the user's web session, credentials and logs them out. See {@link WebAuth#clearSession}.
  * @property {Function} getCredentials Gets the user's credentials from the native credential store. See {@link CredentialsManager#getCredentials}
+ * @property {Function} clearCredentials Clears the user's credentials without clearing their web session and logs them out.
  * @property {Function} requireLocalAuthentication Enables Local Authentication (PIN, Biometric, Swipe etc) to get the credentials. See {@link CredentialsManager#requireLocalAuthentication}
  */
 
@@ -286,6 +287,7 @@ <h1 class="page-title">hooks/use-auth0.js</h1>
  *   authorize,
  *   clearSession,
  *   getCredentials,
+ *   clearCredentials,
  *   requireLocalAuthentication
  * } = useAuth0();
  */
@@ -301,8 +303,8 @@ <h1 class="page-title">hooks/use-auth0.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Oct 19 2022 11:20:50 GMT+0200 (Central European Summer Time) using the
-      Minami theme.
+      Mon Nov 07 2022 10:47:52 GMT+0100 (Central European Standard Time) using
+      the Minami theme.
     </footer>
 
     <script>