Release v2.17.2 (#622)

auth0 · Apr 27, 2023 · 4ff2b6e · 4ff2b6e
1 parent c6a428f
commit 4ff2b6e
Show file tree

Hide file tree

Showing 17 changed files with 58 additions and 34 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Change Log
 
+## [v2.17.2](https://github.com/auth0/react-native-auth0/tree/v2.17.2) (2023-04-27)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.17.1...v2.17.2)
+
+**Added**
+
+- getCredentials hook now updates user state [\#584](https://github.com/auth0/react-native-auth0/pull/584) ([KMathisGit](https://github.com/KMathisGit))
+
+**Fixed**
+
+- Added tokenType to credentials returned in Android [\#621](https://github.com/auth0/react-native-auth0/pull/621) ([poovamraj](https://github.com/poovamraj))
+- [ESD-27178] Fix browser not found issue not being surfaced [\#611](https://github.com/auth0/react-native-auth0/pull/611) ([poovamraj](https://github.com/poovamraj))
+
 ## [v2.17.1](https://github.com/auth0/react-native-auth0/tree/v2.17.1) (2023-02-09)
 
 [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.17.0...v2.17.1)

diff --git a/docs/Auth.html b/docs/Auth.html
@@ -2729,7 +2729,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/Auth0.html b/docs/Auth0.html
@@ -446,7 +446,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/CredentialsManager.html b/docs/CredentialsManager.html
@@ -666,7 +666,7 @@ <h5>Parameters:</h5>
                   <td class="name"><code>strategy</code></td>
 
                   <td class="type">
-                    <span class="param-type"><code>String</code></span>
+                    <span class="param-type"><code>Number</code></span>
                   </td>
 
                   <td class="description last">
@@ -863,7 +863,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/Users.html b/docs/Users.html
@@ -535,7 +535,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/WebAuth.html b/docs/WebAuth.html
@@ -835,7 +835,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/auth0.js.html b/docs/auth0.js.html
@@ -305,7 +305,7 @@ <h1 class="page-title">auth0.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
@@ -893,7 +893,7 @@ <h1 class="page-title">auth/index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/credentials-manager_index.js.html b/docs/credentials-manager_index.js.html
@@ -261,7 +261,7 @@ <h1 class="page-title">credentials-manager/index.js</h1>
         <article>
           <pre
             class="prettyprint source linenums"
-          ><code>import {Platform, NativeModules} from 'react-native';
+          ><code>import { NativeModules, Platform } from 'react-native';
 import CredentialsManagerError from './credentialsManagerError';
 import LocalAuthenticationStrategy from './localAuthenticationStrategy';
 
@@ -418,7 +418,7 @@ <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
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/global.html b/docs/global.html
@@ -598,7 +598,7 @@ <h5>Type:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/hooks_auth0-provider.js.html b/docs/hooks_auth0-provider.js.html
@@ -370,7 +370,12 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
   const getCredentials = useCallback(
     async (...options) => {
       try {
-        return await client.credentialsManager.getCredentials(...options);
+        const credentials = await client.credentialsManager.getCredentials(...options);
+        if(credentials.idToken) {
+          const user = getIdTokenProfileClaims(credentials.idToken);
+          dispatch({type: 'SET_USER', user});
+        }
+        return credentials;
       } catch (error) {
         dispatch({type: 'ERROR', error});
         return;
@@ -440,7 +445,7 @@ <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
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/hooks_use-auth0.js.html b/docs/hooks_use-auth0.js.html
@@ -305,7 +305,7 @@ <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
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/index.html b/docs/index.html
@@ -633,7 +633,7 @@ <h4>Expo</h4>
           </blockquote>
           <p>
             To use the SDK with Expo, configure the app at build time by
-            providing the <code>domain</code> and (optionally) the
+            providing the <code>domain</code> and the
             <code>customScheme</code> values through the
             <a href="https://docs.expo.dev/guides/config-plugins/"
               >Config Plugin</a
@@ -648,7 +648,7 @@ <h4>Expo</h4>
         &quot;react-native-auth0&quot;,
         {
           &quot;domain&quot;: &quot;YOUR_AUTH0_DOMAIN&quot;,
-          &quot;customScheme&quot;: &quot;YOUR_CUSTOM_SCHEME&quot;,
+          &quot;customScheme&quot;: &quot;YOUR_CUSTOM_SCHEME&quot;
         }
       ]
     ]
@@ -675,11 +675,13 @@ <h4>Expo</h4>
               <tr>
                 <td>customScheme</td>
                 <td>
-                  Optional: Custom scheme to build the callback URL with. If not
-                  provided, uses Application ID for Android and Bundle
-                  Identifier for iOS. The value provided here should be passed
-                  to the <code>customScheme</code> option parameter of the
-                  <code>authorize</code> and <code>clearSession</code> methods
+                  Mandatory: Custom scheme to build the callback URL with. The
+                  value provided here should be passed to the
+                  <code>customScheme</code> option parameter of the
+                  <code>authorize</code> and <code>clearSession</code> methods.
+                  The custom scheme should be a unique, all lowercase value with
+                  no special characters (For example:
+                  auth0.YOUR_APP_PACKAGE_NAME_OR_BUNDLE_IDENTIFIER).
                 </td>
               </tr>
             </tbody>
@@ -722,23 +724,27 @@ <h3>Callback URL(s)</h3>
           <h4>Android</h4>
           <pre
             class="prettyprint source lang-text"
-          ><code>{YOUR_APP_PACKAGE_NAME_OR_CUSTOM_SCHEME}://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+          ><code>{APP_PACKAGE_NAME_OR_CUSTOM_SCHEME}://{AUTH0_DOMAIN}/android/{APP_PACKAGE_NAME}/callback
 </code></pre>
           <blockquote>
             <p>
-              Make sure to replace {YOUR_APP_PACKAGE_NAME_OR_CUSTOM_SCHEME} and
-              {YOUR_AUTH0_DOMAIN} with the actual values for your application.
+              Make sure to replace {APP_PACKAGE_NAME_OR_CUSTOM_SCHEME} and
+              {AUTH0_DOMAIN} with the actual values for your application. The
+              {APP_PACKAGE_NAME_OR_CUSTOM_SCHEME} value provided should be all
+              lower case.
             </p>
           </blockquote>
           <h4>iOS</h4>
           <pre
             class="prettyprint source lang-text"
-          ><code>{YOUR_BUNDLE_IDENTIFIER_OR_CUSTOM_SCHEME}://{YOUR_AUTH0_DOMAIN}/ios/{YOUR_BUNDLE_IDENTIFIER}/callback
+          ><code>{BUNDLE_IDENTIFIER_OR_CUSTOM_SCHEME}://{AUTH0_DOMAIN}/ios/{BUNDLE_IDENTIFIER}/callback
 </code></pre>
           <blockquote>
             <p>
-              Make sure to replace {YOUR_BUNDLE_IDENTIFIER_OR_CUSTOM_SCHEME} and
-              {YOUR_AUTH0_DOMAIN} with the actual values for your application.
+              Make sure to replace {BUNDLE_IDENTIFIER_OR_CUSTOM_SCHEME} and
+              {AUTH0_DOMAIN} with the actual values for your application. The
+              {BUNDLE_IDENTIFIER_OR_CUSTOM_SCHEME} value provided should be all
+              lower case.
             </p>
           </blockquote>
           <h2>Next Steps</h2>
@@ -851,7 +857,7 @@ <h4>Login</h4>
   const {authorize, user, isLoading, error} = useAuth0();
 
   const login = async () => {
-    await authorize();
+    await clearSession(); // clearSession({customScheme: 'CUSTOM_SCHEME') when using Expo or a custom scheme
   };
 
   if(isLoading) {
@@ -914,7 +920,7 @@ <h4>Logout</h4>
   const {clearSession, user} = useAuth0();
 
   const logout = async () => {
-    await clearSession();
+    await clearSession(); // clearSession({customScheme: 'CUSTOM_SCHEME') when using Expo or a custom scheme
   };
 
   return &lt;View>{user && &lt;Button onPress={logout} title=&quot;Log out&quot; />}&lt;/View>;
@@ -1116,7 +1122,7 @@ <h3>Vulnerability Reporting</h3>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/management_users.js.html b/docs/management_users.js.html
@@ -374,7 +374,7 @@ <h1 class="page-title">management/users.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/docs/webauth_index.js.html b/docs/webauth_index.js.html
@@ -444,7 +444,7 @@ <h1 class="page-title">webauth/index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Thu Feb 09 2023 09:45:58 GMT+0530 (India Standard Time) using the Minami
+      Thu Apr 27 2023 12:14:31 GMT+0530 (India Standard Time) using the Minami
       theme.
     </footer>
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "react-native-auth0",
   "title": "React Native Auth0",
-  "version": "2.17.1",
+  "version": "2.17.2",
   "description": "React Native toolkit for Auth0 API",
   "main": "index.js",
   "scripts": {

diff --git a/src/networking/telemetry.js b/src/networking/telemetry.js
@@ -1 +1 @@
-module.exports = {name: 'react-native-auth0', version: '2.17.1'};
+module.exports = {name: 'react-native-auth0', version: '2.17.2'};