Skip to content

Latest commit

 

History

History
846 lines (497 loc) · 37.7 KB

CHANGELOG.md

File metadata and controls

846 lines (497 loc) · 37.7 KB
Raw

Change Log

v4.0.0 (2024-11-27)

Full Changelog

💡 Check the Migration Guide to understand the changes required to migrate your application to v4.

💡 Check the v4.0.0-beta.0 to understand other major changes .

⚠️ BREAKING CHANGES

  • BREAKING CHANGE: requireLocalAuthentication method is no longer available as part of the CredentialsManager class or the useAuth0 Hook from v4 of the SDK. Refer Migration Guide for more details.

Added

v4.0.0-beta.0 (2024-08-05)

Full Changelog

⚠️ BREAKING CHANGES

  • BREAKING CHANGE: Updated Android SDK to v3 beta & fixed issues with biometrics Authentication on Android. #940 (desusai7)

Added

v3.2.1 (2024-05-09)

Full Changelog

Fixed

  • chore: upgraded dependency on Auth0.swift to 2.7.2 #895 (desusai7)

Security

v3.2.0 (2024-04-26)

Full Changelog

Added

v3.1.0 (2023-12-05)

Full Changelog

Added

Fixed

v3.0.2 (2023-10-06)

Full Changelog

Fixed

Security

v3.0.1 (2023-08-16)

Full Changelog

Fixed

  • Make authorize and clearSession parameters optional #701 (poovamraj)

Security

v3.0.0 (2023-08-10)

Full Changelog

💡 Check the Migration Guide 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 and 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

v3.0.0-beta.3 (2023-07-11)

Full Changelog

Added

v3.0.0-beta.2 (2023-07-10)

Full Changelog

💡 Check the Migration Guide to understand the changes required to migrate your application to v3.

Added

  • 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
  • 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 and 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

v2.17.4 (2023-06-15)

Full Changelog

Fixed

v2.17.3 (2023-06-15)

Full Changelog

Fixed

v2.17.2 (2023-04-27)

Full Changelog

Added

Fixed

  • Added tokenType to credentials returned in Android #621 (poovamraj)
  • [ESD-27178] Fix browser not found issue not being surfaced #611 (poovamraj)

v2.17.1 (2023-02-09)

Full Changelog

Fixed

v2.17.0 (2023-02-01)

Full Changelog

Added

Fixed

Security

v2.16.0 (2022-11-16)

Full Changelog

Added

Fixed

v2.15.0 (2022-11-07)

Full Changelog

Added

  • [SDK-3738] Option to clear session only in Credentials Manager #543 (poovamraj)

Fixed

  • [SDK-3736] Fix: Options Parameter not being passed in Hooks authorize method #542 (poovamraj)

v2.14.1 (2022-10-19)

Full Changelog

Fixed

  • Avoid config changes to handle authentication #534 (poovamraj)
  • [SDK-3718] Allow passing extra parameters when logging in with passwordRealm #532 (ewanharris)
  • Removed Activity from Android library to avoid prompt #533 (poovamraj)

v2.14.0 (2022-10-07)

📣 Major improvements now generally available

This release brings the much requested features to the React Native Auth0 SDK:

Full Changelog

Added

Changed

v2.14.0-fa.0 (2022-09-09)

Full Changelog

Added

Changed

v2.13.3 (2022-07-06)

Full Changelog

Fixed

v2.13.2 (2022-06-28)

Full Changelog

Fixed

Security

v2.13.1 (2022-04-01)

Full Changelog

Changed

  • [Snyk] Security upgrade crypto-js from 3.3.0 to 4.0.0 #457 (snyk-bot)

Fixed

v2.13.0 (2022-01-27)

Full Changelog

Added

  • #409 Implement timeout support to networking Client #423 (mnylen)

Fixed

v2.12.0 (2022-01-07)

Full Changelog

Added

Fixed

  • Fix: Warning on RN65 while linking from agent.js #441 (poovamraj)

v2.11.0 (2021-11-30)

Full Changelog

Changed

v2.10.0 (2021-09-09)

Full Changelog

Added

Changed

Security

v2.9.0 (2021-06-22)

Full Changelog

Breaking changes

  • Fixed authentication restart when the app is minimized [SDK-2199]#350 (Widcket)

v2.8.3 (2021-05-05)

Full Changelog

Changed

  • Add React 17 to the package.json semver range #373 (Widcket)

v2.8.2 (2021-04-29)

Full Changelog

Fixed

v2.8.1 (2021-04-19)

Full Changelog

Fixed

  • Capture and surface error when browser app is not available [SDK-2224]#363 (lbalmaceda)

v2.8.0 (2021-03-26)

Full Changelog

Added

v2.7.0 (2021-01-05)

Full Changelog

Added

  • Added support for using a custom scheme in the callback URL [SDK-2223]#351 (Widcket)

v2.6.0 (2020-08-11)

Full Changelog

Added

Fixed

Security

v2.5.0 (2020-06-09)

This release requires at minimum React Native SDK version 0.62.2. If you need to run it on a different version, check the Compatibility Matrix on the README for reference.

Full Changelog

Added

  • Warn when bundle identifier contains uppercase characters #316 (lbalmaceda)

Security

v2.4.0 (2020-06-05)

Full Changelog

Added

  • Added support for ephemeral sessions [SDK-1412]#305 (Widcket)

Security

v2.3.1 (2020-04-29)

Full Changelog

Fixed

Security

v2.3.0 (2020-02-10)

Full Changelog

Added

  • Added token exchange for native social endpoint [SDK-1307]#273 (Widcket)

v2.2.0 (2020-01-30)

Full Changelog

Added

Changed

  • Refactor RSA verification: Replace jsrsasign with crypto-js #268 (lbalmaceda)

v2.1.1 (2020-01-10)

Full Changelog

Removed

Fixed

Security

v2.1.0 (2019-10-23)

Full Changelog

Security

v2.0.0 (2019-10-08)

This is a major release that supports CocoaPods and Android X.

It requires at minimum React Native SDK version 0.60.5. If you need to run it on a different version, check the Compatibility Matrix on the README for reference.

Migration notes:

  • Install the SDK with yarn add react-native-auth0 or npm npm install react-native-auth0 --save.
  • Install the Pod for the iOS native module. Change into the ios directory of your application and run pod install.

Every iOS application after React Native SDK version 0.60.0 has a podfile file. If yours doesn't, please check the documentation on how to generate a valid one.

Full Changelog

v1.6.0 (2019-09-23)

Full Changelog

Added

v1.5.0 (2019-07-15)

Full Changelog

Changed

  • Enable WebAuth Logout for Android & Fix iOS Logout. #223 (lbalmaceda)

Fixed

  • Fix error handling by using authentication error class #228 (lbalmaceda)

v1.4.2 (2019-04-24)

Full Changelog

Changed

v1.4.1 (2019-04-18)

Full Changelog

Fixed

v1.4.0 (2019-02-07)

Full Changelog

Changed

  • Remove obsolete React dependency from podspec. #192 (rnevius)
  • Added iOS SF/ASWeb AuthenticationSession support #187 (cocojoe)
  • Allow authorize options to override default values #177 (kenzic)

v1.3.1 (2018-10-01)

Full Changelog

Changed

  • Update Minimum iOS Deployment Target, inline with React Libs #176 (coosamatt)

v1.3.0 (2018-07-17)

Full Changelog

Added

  • android: allow root project to specify dependency versions #149 (mlc)

Fixed

  • Add requiresMainQueueSetup to fix warning in RN 0.49+ #165 (frankrowe)
  • Fixed broken podspec for Cocoapods installations #136 (danieljvdm)

v1.2.2 (2018-01-31)

Full Changelog

Fixed

v1.2.1 (2017-10-11)

Full Changelog

Fixed

  • Fixed race condition in callback when using React Native Navigation #100 (cocojoe)

v1.2.0 (2017-09-11)

Full Changelog Closed issues

  • Browser tabs not closed upon webauth success/failure #87
  • WebAuth never opens safari on iOS #84

Added

  • Close Browser app tab after finishing Auth #90 (cocojoe)

Fixed

  • Fix Present SFSafariViewController from Top ViewController #89 (cocojoe)

v1.1.1 (2017-08-18)

Full Changelog

Fixed

v1.1.0 (2017-08-18)

Full Changelog Closed issues

  • Could not invoke A0Auth.showUrl #67

Added

  • Added clearSession iOS Safari Method #65 (cocojoe)

Fixed

  • Change customtabs version to the same as default build tools #78 (lukecwilliams)

v1.0.4 (2017-08-13)

Full Changelog

Changed

v1.0.3 (2017-06-26)

Full Changelog

Fixed

  • Add missing import to the WebAuth controller file #50 (lbalmaceda)

v1.0.2 (2017-06-16)

Full Changelog

Fixed

v1.0.1 (2017-06-15)

Full Changelog

Fixed

v1.0.0 (2017-06-14)

Full Changelog

Installation

Install react-native-auth0 using npm

npm install react-native-auth0 --save

Or via yarn

yarn add --dev react-native-auth0

then you need to link the native module in react-native-auth0

react-native link react-native-auth0

Configuration

This section is for those that want to use WebAuth, if you dont need it just ignore this section.

Android

In the file android/src/app/AndroidManifest.xml you must make sure the main activity of the app has launch mode value of singleTask and that it has the following intent filter

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data
        android:host="YOUR_AUTH0_DOMAIN"
        android:pathPrefix="/android/${applicationId}/callback"
        android:scheme="${applicationId}" />
</intent-filter>

So if you have samples.auth0.com as your Auth0 domain you would have the following activity configuration:

<activity
android:name=".MainActivity"
android:label="@string/app_name"
android:launchMode="singleTask"
android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
android:windowSoftInputMode="adjustResize">
<intent-filter>
    <action android:name="android.intent.action.MAIN" />
    <category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data
        android:host="samples.auth0.com"
        android:pathPrefix="/android/${applicationId}/callback"
        android:scheme="${applicationId}" />
</intent-filter>
</activity>

For more info please read react native docs

iOS

Inside the ios folder find the file AppDelegate.[swift|m] add the following to it

#import <React/RCTLinkingManager.h>

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
  return [RCTLinkingManager application:application openURL:url
                      sourceApplication:sourceApplication annotation:annotation];
}

Then in your Info.plist file, find the value of the entry of CFBundleIdentifier, e.g.

<key>CFBundleIdentifier</key>
<string>org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier)</string>

and then register a URL type entry using the value of CFBundleIdentifier as the value of CFBundleURLSchemes

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleTypeRole</key>
        <string>None</string>
        <key>CFBundleURLName</key>
        <string>auth0</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier)</string>
        </array>
    </dict>
</array>

The value org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier) is the default for apps created with RN cli, you will probably have a different value.

For more info please read react native docs

Usage

import Auth0 from 'react-native-auth0';

const auth0 = new Auth0({
  domain: '{YOUR_AUTH0_DOMAIN}',
  clientId: '{YOUR_CLIENT_ID}',
});

WebAuth

auth0.webAuth
  .authorize({ scope: 'openid email' })
  .then((credentials) => console.log(credentials))
  .catch((error) => console.log(error));