Release v2.17.0 (#588)

auth0 · Feb 1, 2023 · a2330dd · a2330dd
1 parent da04cb0
commit a2330dd
Show file tree

Hide file tree

Showing 17 changed files with 136 additions and 56 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,24 @@
 # Change Log
 
+## [v2.17.0](https://github.com/auth0/react-native-auth0/tree/v2.17.0) (2023-02-01)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.16.0...v2.17.0)
+
+**Added**
+
+- Allow additional options for authorize and support custom LAPolicy [\#526](https://github.com/auth0/react-native-auth0/pull/526) ([chrismcleod](https://github.com/chrismcleod))
+- Initialized flag on useAuth0 hook [\#561](https://github.com/auth0/react-native-auth0/pull/561) ([cranberyxl](https://github.com/cranberyxl))
+
+**Fixed**
+
+- Fixing `.hide()` on iOS [\#570](https://github.com/auth0/react-native-auth0/pull/570) ([stigi](https://github.com/stigi))
+
+**Security**
+
+- chore: Bump `yarn.lock` dependencies [\#580](https://github.com/auth0/react-native-auth0/pull/580) ([evansims](https://github.com/evansims))
+- chore(deps): bump decode-uri-component from 0.2.0 to 0.2.2 [\#567](https://github.com/auth0/react-native-auth0/pull/567) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Security: Bump Dependencies [\#565](https://github.com/auth0/react-native-auth0/pull/565) ([evansims](https://github.com/evansims))
+
 ## [v2.16.0](https://github.com/auth0/react-native-auth0/tree/v2.16.0) (2022-11-16)
 
 [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.15.0...v2.16.0)

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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India 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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>

diff --git a/docs/CredentialsManager.html b/docs/CredentialsManager.html
@@ -286,8 +286,8 @@ <h4 class="name" id="CredentialsManager">
                       <a href="credentials-manager_index.js.html"
                         >credentials-manager/index.js</a
                       >,
-                      <a href="credentials-manager_index.js.html#line11"
-                        >line 11</a
+                      <a href="credentials-manager_index.js.html#line12"
+                        >line 12</a
                       >
                     </li>
                   </ul>
@@ -362,8 +362,8 @@ <h4 class="name" id="clearCredentials">
                     <a href="credentials-manager_index.js.html"
                       >credentials-manager/index.js</a
                     >,
-                    <a href="credentials-manager_index.js.html#line127"
-                      >line 127</a
+                    <a href="credentials-manager_index.js.html#line131"
+                      >line 131</a
                     >
                   </li>
                 </ul>
@@ -391,8 +391,8 @@ <h4 class="name" id="getCredentials">
                     <a href="credentials-manager_index.js.html"
                       >credentials-manager/index.js</a
                     >,
-                    <a href="credentials-manager_index.js.html#line61"
-                      >line 61</a
+                    <a href="credentials-manager_index.js.html#line62"
+                      >line 62</a
                     >
                   </li>
                 </ul>
@@ -506,8 +506,8 @@ <h4 class="name" id="hasValidCredentials">
                     <a href="credentials-manager_index.js.html"
                       >credentials-manager/index.js</a
                     >,
-                    <a href="credentials-manager_index.js.html#line119"
-                      >line 119</a
+                    <a href="credentials-manager_index.js.html#line123"
+                      >line 123</a
                     >
                   </li>
                 </ul>
@@ -556,7 +556,8 @@ <h5>Parameters:</h5>
             <h4 class="name" id="requireLocalAuthentication">
               <span class="type-signature">(async) </span
               >requireLocalAuthentication<span class="signature"
-                >(title, description, cancelTitle, fallbackTitle)</span
+                >(title, description, cancelTitle, fallbackTitle,
+                strategy)</span
               ><span class="type-signature"> &rarr; {Promise}</span>
             </h4>
 
@@ -575,8 +576,8 @@ <h4 class="name" id="requireLocalAuthentication">
                     <a href="credentials-manager_index.js.html"
                       >credentials-manager/index.js</a
                     >,
-                    <a href="credentials-manager_index.js.html#line88"
-                      >line 88</a
+                    <a href="credentials-manager_index.js.html#line90"
+                      >line 90</a
                     >
                   </li>
                 </ul>
@@ -660,6 +661,22 @@ <h5>Parameters:</h5>
                     </p>
                   </td>
                 </tr>
+
+                <tr>
+                  <td class="name"><code>strategy</code></td>
+
+                  <td class="type">
+                    <span class="param-type"><code>String</code></span>
+                  </td>
+
+                  <td class="description last">
+                    <p>
+                      iOS Only - optional - the evaluation policy to use when
+                      accessing the credentials. Defaults to
+                      LocalAuthenticationStrategy.deviceOwnerWithBiometrics.
+                    </p>
+                  </td>
+                </tr>
               </tbody>
             </table>
 
@@ -697,8 +714,8 @@ <h4 class="name" id="saveCredentials">
                     <a href="credentials-manager_index.js.html"
                       >credentials-manager/index.js</a
                     >,
-                    <a href="credentials-manager_index.js.html#line29"
-                      >line 29</a
+                    <a href="credentials-manager_index.js.html#line30"
+                      >line 30</a
                     >
                   </li>
                 </ul>
@@ -846,8 +863,8 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India 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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India 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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India 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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>

diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
@@ -893,8 +893,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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>

diff --git a/docs/credentials-manager_index.js.html b/docs/credentials-manager_index.js.html
@@ -263,6 +263,7 @@ <h1 class="page-title">credentials-manager/index.js</h1>
             class="prettyprint source linenums"
           ><code>import {Platform, NativeModules} from 'react-native';
 import CredentialsManagerError from './credentialsManagerError';
+import LocalAuthenticationStrategy from './localAuthenticationStrategy';
 
 class CredentialsManager {
   /**
@@ -346,13 +347,15 @@ <h1 class="page-title">credentials-manager/index.js</h1>
    * @param {String} description Android Only - optional - the text to use as description in the authentication screen. On some Android versions it might not be shown. Passing null will result in using the OS's default value.
    * @param {String} cancelTitle iOS Only - optional - the cancel message to display on the local authentication prompt.
    * @param {String} fallbackTitle iOS Only - optional - the fallback message to display on the local authentication prompt after a failed match.
+   * @param {String} strategy iOS Only - optional - the evaluation policy to use when accessing the credentials. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics.
    * @returns {Promise}
    */
   async requireLocalAuthentication(
     title,
     description,
     cancelTitle,
     fallbackTitle,
+    strategy = LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
   ) {
     try {
       await this._ensureCredentialManagerIsInitialized();
@@ -361,6 +364,7 @@ <h1 class="page-title">credentials-manager/index.js</h1>
           title,
           cancelTitle,
           fallbackTitle,
+          strategy
         );
       } else {
         await this.Auth0Module.enableLocalAuthentication(title, description);
@@ -414,8 +418,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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>

diff --git a/docs/global.html b/docs/global.html
@@ -288,7 +288,7 @@ <h4 class="name" id="Auth0Provider">
                   <li>
                     <a href="hooks_auth0-provider.js.html"
                       >hooks/auth0-provider.js</a
-                    >, <a href="hooks_auth0-provider.js.html#line42">line 42</a>
+                    >, <a href="hooks_auth0-provider.js.html#line43">line 43</a>
                   </li>
                 </ul>
               </dd>
@@ -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#line31">line 31</a>
+                    <a href="hooks_use-auth0.js.html#line33">line 33</a>
                   </li>
                 </ul>
               </dd>
@@ -406,6 +406,7 @@ <h5>Example</h5>
   // State
   error,
   user,
+  isLoading,
   // Methods
   authorize,
   clearSession,
@@ -464,6 +465,21 @@ <h5 class="subsection-title">Properties:</h5>
                   </td>
                 </tr>
 
+                <tr>
+                  <td class="name"><code>isLoading</code></td>
+
+                  <td class="type">
+                    <span class="param-type"><code>boolean</code></span>
+                  </td>
+
+                  <td class="description last">
+                    <p>
+                      A flag that is true until the state knows that a user is
+                      either logged in or not
+                    </p>
+                  </td>
+                </tr>
+
                 <tr>
                   <td class="name"><code>authorize</code></td>
 
@@ -582,8 +598,8 @@ <h5>Type:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on
-      Wed Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>

diff --git a/docs/hooks_auth0-provider.js.html b/docs/hooks_auth0-provider.js.html
@@ -273,6 +273,7 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
 const initialState = {
   user: null,
   error: null,
+  isLoading: true,
 };
 
 /**
@@ -311,10 +312,13 @@ <h1 class="page-title">hooks/auth0-provider.js</h1>
       let user = null;
 
       if (await client.credentialsManager.hasValidCredentials()) {
-        const credentials = await client.credentialsManager.getCredentials();
-
-        if (credentials) {
-          user = getIdTokenProfileClaims(credentials.idToken);
+        try {
+          const credentials = await client.credentialsManager.getCredentials();
+          if (credentials) {
+            user = getIdTokenProfileClaims(credentials.idToken);
+          }
+        } catch (error) {
+          dispatch({type: 'ERROR', error});
         }
       }
 
@@ -436,8 +440,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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>

diff --git a/docs/hooks_use-auth0.js.html b/docs/hooks_use-auth0.js.html
@@ -268,6 +268,7 @@ <h1 class="page-title">hooks/use-auth0.js</h1>
  * @typedef {Object} Auth0ContextInterface
  * @property {Object} user The user profile as decoded from the ID token after authentication
  * @property {Object} error An object representing the last exception
+ * @property {boolean} isLoading A flag that is true until the state knows that a user is either logged in or not
  * @property {Function} authorize Authorize the user using Auth0 Universal Login. See {@link WebAuth#authorize}
  * @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}
@@ -283,6 +284,7 @@ <h1 class="page-title">hooks/use-auth0.js</h1>
  *   // State
  *   error,
  *   user,
+ *   isLoading,
  *   // Methods
  *   authorize,
  *   clearSession,
@@ -303,8 +305,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 Nov 16 2022 17:11:26 GMT+0100 (Central European Standard Time) using
-      the Minami theme.
+      Wed Feb 01 2023 10:15:23 GMT+0530 (India Standard Time) using the Minami
+      theme.
     </footer>
 
     <script>