Release v3.0.0 (#696)

auth0 · Aug 10, 2023 · 2d91f47 · 2d91f47
1 parent 9359f10
commit 2d91f47
Show file tree

Hide file tree

Showing 59 changed files with 14,866 additions and 15,463 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -24,7 +24,7 @@ workflows:
       - ship/node-publish:
           node-version: 18.16.0
           pkg-manager: yarn
-          publish-command: npm publish --tag v3-beta
+          publish-command: npm publish
           requires:
             - build
           context:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,49 @@
 # Change Log
 
+## [v3.0.0](https://github.com/auth0/react-native-auth0/tree/v3.0.0) (2023-08-10)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.17.4...v3.0.0)
+
+💡 Check the [Migration Guide](MIGRATION_GUIDE.md) to understand the changes required to migrate your application to v3.
+
+**Added**
+
+- Credentials are returned as part of authorize methods in hooks
+- Support for organizations name in login
+- Added sample app in the repository
+- Expo plugin is updated to latest version
+- Added 'openid profile email' as mandatory scopes
+- Option to `forceRefresh` is added in `getCredentials`
+- Added `hasValidCredentials` to hooks
+- More options to authorize using Hooks
+  - `authorizeWithSMS`
+  - `authorizeWithEmail`
+  - `authorizeWithOOB`
+  - `authorizeWithOTP`
+  - `authorizeWithRecoveryCode`
+
+**Changed**
+
+- Custom Scheme is now optional in Expo
+- Migrated the codebase to Typescript
+- Use Native SDKs ([Auth0.Android](https://github.com/auth0/Auth0.Android/) and [Auth0.Swift](https://github.com/auth0/Auth0.Swift)) for Web Authentication
+- `Credentials` object in Android will return `expiresIn` instead of `expiresAt`
+- `max_age` parameter is changed to `maxAge` in `WebAuth.authorize()`
+- `customScheme` is now part of `ClearSessionOptions` instead of `ClearSessionParameters` in `clearSession`
+- Minimum supported version for iOS is bumped to 13
+- Revoke Token and Change Password now return `void` instead of an empty object
+
+**Removed**
+
+- Removed the `type` property returned in the `Credentials` object in Android. Use `tokenType` instead.
+- `skipLegacyListener` has been removed in `authorize` and `clearSession`
+
+**Security**
+
+- chore(deps): bump word-wrap from 1.2.3 to 1.2.4 [\#682](https://github.com/auth0/react-native-auth0/pull/682) ([dependabot[bot]](https://github.com/apps/dependabot))
+- chore: Expand `.semgrepignore` exclusions to tests [\#679](https://github.com/auth0/react-native-auth0/pull/679) ([evansims](https://github.com/evansims))
+- chore(deps-dev): bump semver from 6.3.0 to 7.5.2 [\#657](https://github.com/auth0/react-native-auth0/pull/657) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v3.0.0-beta.3](https://github.com/auth0/react-native-auth0/tree/v3.0.0-beta.3) (2023-07-11)
 
 [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v3.0.0-beta.2...v3.0.0-beta.3)
@@ -16,7 +60,7 @@
 
 **Added**
 
-- \Credentials are returned as part of authorize methods in hooks
+- Credentials are returned as part of authorize methods in hooks
 - Added sample app in the repository
 - Expo plugin is updated to latest version
 - Added 'openid profile email' as mandatory scopes

diff --git a/README.md b/README.md
@@ -7,9 +7,6 @@
 [![Downloads][downloads-image]][downloads-url]
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Freact-native-auth0.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Freact-native-auth0?ref=badge_shield)
 
-| Exciting news! We have just released React Native Auth0 v3 BETA, packed with powerful features and improvements. [Check out the release for more details](https://github.com/auth0/react-native-auth0/releases/tag/v3.0.0-beta.2) |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-
 📚 [Documentation](#documentation) • 🚀 [Getting Started](#getting-started) • ⏭️ [Next Steps](#next-steps) • ❓ [FAQs](https://github.com/auth0/react-native-auth0/blob/master/FAQ.md) • ❓ [Feedback](#feedback)
 
 ## Documentation
@@ -43,11 +40,11 @@ First install the native library module:
 
 ### With [npm](https://www.npmjs.com)
 
-`$ npm install react-native-auth0@v3-beta --save`
+`$ npm install react-native-auth0 --save`
 
 ### With [Yarn](https://yarnpkg.com/en/)
 
-`$ yarn add react-native-auth0@v3-beta`
+`$ yarn add react-native-auth0`
 
 Then, you need to run the following command to install the ios app pods with Cocoapods. That will auto-link the iOS library:
 

diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html
@@ -100,8 +100,8 @@ <h4>Hierarchy</h4>
             <li>
               Defined in
               <a
-                href="https://github.com/auth0/react-native-auth0/blob/170164a/src/utils/fetchWithTimeout.ts#L3"
-                >src/utils/fetchWithTimeout.ts:3</a
+                href="https://github.com/auth0/react-native-auth0/blob/9b9ed243/src/utils/fetchWithTimeout.ts#L3"
+                >utils/fetchWithTimeout.ts:3</a
               >
             </li>
           </ul>
@@ -239,8 +239,8 @@ <h4 class="tsd-returns-title">
                     <li>
                       Defined in
                       <a
-                        href="https://github.com/auth0/react-native-auth0/blob/170164a/src/utils/fetchWithTimeout.ts#L4"
-                        >src/utils/fetchWithTimeout.ts:4</a
+                        href="https://github.com/auth0/react-native-auth0/blob/9b9ed243/src/utils/fetchWithTimeout.ts#L4"
+                        >utils/fetchWithTimeout.ts:4</a
                       >
                     </li>
                   </ul>
@@ -490,6 +490,255 @@ <h3>
                   ><span>default</span></a
                 >
               </li>
+              <li>
+                <a href="../interfaces/AuthorizeUrlOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <g id="icon-256">
+                      <rect
+                        fill="var(--color-icon-background)"
+                        stroke="var(--color-ts-interface)"
+                        stroke-width="1.5"
+                        x="1"
+                        y="1"
+                        width="22"
+                        height="22"
+                        rx="6"
+                      ></rect>
+                      <path
+                        d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z"
+                        fill="var(--color-text)"
+                      ></path>
+                    </g></svg
+                  ><span>Authorize<wbr />Url<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/ClearSessionOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Clear<wbr />Session<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/ClearSessionParameters.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Clear<wbr />Session<wbr />Parameters</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/CreateUserOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Create<wbr />User<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/ExchangeNativeSocialOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span
+                    >Exchange<wbr />Native<wbr />Social<wbr />Options</span
+                  ></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/ExchangeOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Exchange<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/GetUserOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Get<wbr />User<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/LoginWithEmailOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Login<wbr />With<wbr />Email<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/LoginWithOOBOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Login<wbr />WithOOBOptions</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/LoginWithOTPOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Login<wbr />WithOTPOptions</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/LoginWithRecoveryCodeOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span
+                    >Login<wbr />With<wbr />Recovery<wbr />Code<wbr />Options</span
+                  ></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/LoginWithSMSOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Login<wbr />WithSMSOptions</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/LogoutUrlOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Logout<wbr />Url<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/MultifactorChallengeOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Multifactor<wbr />Challenge<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/PasswordRealmOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Password<wbr />Realm<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/PasswordlessWithEmailOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span
+                    >Passwordless<wbr />With<wbr />Email<wbr />Options</span
+                  ></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/PasswordlessWithSMSOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Passwordless<wbr />WithSMSOptions</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/PatchUserOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Patch<wbr />User<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/RefreshTokenOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Refresh<wbr />Token<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/ResetPasswordOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Reset<wbr />Password<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/RevokeOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Revoke<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/UserInfoOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>User<wbr />Info<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/WebAuthorizeOptions.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Web<wbr />Authorize<wbr />Options</span></a
+                >
+              </li>
+              <li>
+                <a href="../interfaces/WebAuthorizeParameters.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-256"></use></svg
+                  ><span>Web<wbr />Authorize<wbr />Parameters</span></a
+                >
+              </li>
+              <li>
+                <a href="../types/Credentials.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <g id="icon-4194304">
+                      <rect
+                        fill="var(--color-icon-background)"
+                        stroke="var(--color-ts-type-alias)"
+                        stroke-width="1.5"
+                        x="1"
+                        y="1"
+                        width="22"
+                        height="22"
+                        rx="6"
+                      ></rect>
+                      <path
+                        d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z"
+                        fill="var(--color-text)"
+                      ></path>
+                    </g></svg
+                  ><span>Credentials</span></a
+                >
+              </li>
+              <li>
+                <a href="../types/MultifactorChallengeOOBResponse.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-4194304"></use></svg
+                  ><span>Multifactor<wbr />ChallengeOOBResponse</span></a
+                >
+              </li>
+              <li>
+                <a
+                  href="../types/MultifactorChallengeOOBWithBindingResponse.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-4194304"></use></svg
+                  ><span
+                    >Multifactor<wbr />ChallengeOOBWith<wbr />Binding<wbr />Response</span
+                  ></a
+                >
+              </li>
+              <li>
+                <a href="../types/MultifactorChallengeOTPResponse.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-4194304"></use></svg
+                  ><span>Multifactor<wbr />ChallengeOTPResponse</span></a
+                >
+              </li>
+              <li>
+                <a href="../types/MultifactorChallengeResponse.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-4194304"></use></svg
+                  ><span>Multifactor<wbr />Challenge<wbr />Response</span></a
+                >
+              </li>
+              <li>
+                <a href="../types/User.html"
+                  ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
+                    <use href="#icon-4194304"></use></svg
+                  ><span>User</span></a
+                >
+              </li>
               <li>
                 <a href="../functions/Auth0Provider-1.html"
                   ><svg class="tsd-kind-icon" viewBox="0 0 24 24">