@frontegg/react-native v1.2.14

@frontegg/react-native

Frontegg is a first-of-its-kind full-stack user management platform, empowering software teams with user infrastructure features for the product-led era.

Table of Contents

• Project Requirements
• Getting Started
  • Prepare Frontegg workspace
  • Setup Hosted Login
  • Add frontegg package to the project
• Setup iOS Project
  • Create Frontegg plist file
  • Handle Open App with URL
  • Config iOS associated domain
  • Multi-apps iOS Support
• Setup Android Project
  • Set minimum SDK version
  • Configure build config fields
  • Config Android AssetLinks
  • Enabling Chrome Custom Tabs for Social Login
  • Multi-apps Android Support
• Usages
  • Wrap your app with FronteggProvider
  • Login with frontegg
  • Check if user is authenticated

Project Requirements

• Minimum iOS deployment version => 14
• Min Android SDK => 26

Getting Started

Prepare Frontegg workspace

Navigate to Frontegg Portal Settings, If you don't have application follow integration steps after signing up. Copy FronteggDomain to future steps from Frontegg Portal Domain

• Navigate to Login Method Settings
• Toggle Hosted login method for iOS:
  • Add {{IOS_BUNDLE_IDENTIFIER}}://{{FRONTEGG_BASE_URL}}/ios/oauth/callback
• Toggle Hosted login method for Android:
  • Add {{ANDROID_PACKAGE_NAME}}://{{FRONTEGG_BASE_URL}}/android/oauth/callback
  • Add https://{{FRONTEGG_BASE_URL}}/oauth/account/redirect/android/{{ANDROID_PACKAGE_NAME}}
• Add {{FRONTEGG_BASE_URL}}/oauth/authorize
• Replace IOS_BUNDLE_IDENTIFIER with your application identifier
• Replace FRONTEGG_BASE_URL with your frontegg base url
• Replace ANDROID_PACKAGE_NAME with your android package name

Add frontegg package to the project

Use a package manager npm/yarn to install frontegg React Native library.

NPM:

npm install -s @frontegg/react-native

Yarn:

yarn add @frontegg/react-native

Setup iOS Project

Create Frontegg plist file

To setup your SwiftUI application to communicate with Frontegg, you have to create a new file named Frontegg.plist under your root project directory, this file will store values to be used variables by Frontegg SDK:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>baseUrl</key>
        <string>https://[DOMAIN_HOST_FROM_PREVIOUS_STEP]</string>
        <key>clientId</key>
        <string>[CLIENT_ID_FROM_PREVIOUS_STEP]</string>
    </dict>
</plist>

Handle Open App with URL

To handle Login with magic link and other authentication methods that require to open the app with a URL, you have to add the following code to.

For Objective-C:

1. Create FronteggSwiftAdapter.swift in your project and add the following code:

   //  FronteggSwiftAdapter.swift
   
   import Foundation
   import FronteggSwift
   
   @objc(FronteggSwiftAdapter)
   public class FronteggSwiftAdapter: NSObject {
       @objc public static let shared = FronteggSwiftAdapter()
   
       @objc public func handleOpenUrl(_ url: URL) -> Bool {
           return FronteggAuth.shared.handleOpenUrl(url)
       }
   }

2. Open AppDelegate.m file and import swift headers:

   #import <[YOUR_PROJECT_NAME]-Swift.h>

3. Add URL handlers to AppDelegate.m:

   #import <[YOUR_PROJECT_NAME]-Swift.h>
   
   // ...CODE...
   
   - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url
           options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options
   {
   
     if([[FronteggSwiftAdapter shared] handleOpenUrl:url] ){
       return TRUE;
     }
     return [RCTLinkingManager application:app openURL:url options:options];
   }
   
   - (BOOL)application:(UIApplication *)application continueUserActivity:(nonnull NSUserActivity *)userActivity
    restorationHandler:(nonnull void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler
   {
   
     if (userActivity.webpageURL != NULL){
       if([[FronteggSwiftAdapter shared] handleOpenUrl:userActivity.webpageURL] ){
         return TRUE;
       }
     }
    return [RCTLinkingManager application:application
                     continueUserActivity:userActivity
                       restorationHandler:restorationHandler];
   }

For Swift:

1. Open AppDelegate.m file and import swift headers:

   import FronteggSwift

2. Add URL handlers to AppDelegate.swift:

   import UIKit
   import FronteggSwift
   
   @UIApplicationMain
   class AppDelegate: UIResponder, UIApplicationDelegate {
   
       /*
        * Called when the app was launched with a url. Feel free to add additional processing here,
        * but if you want the App API to support tracking app url opens, make sure to keep this call
        */
       func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
   
           if(FronteggAuth.shared.handleOpenUrl(url)){
               return true
           }
   
           return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
       }
   
       /*
        * Called when the app was launched with an activity, including Universal Links.
        * Feel free to add additional processing here, but if you want the App API to support
        * tracking app url opens, make sure to keep this call
        */
       func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
   
           if let url = userActivity.webpageURL {
               if(FronteggAuth.shared.handleOpenUrl(url)){
                   return true
               }
           }
           return ApplicationDelegateProxy.shared.application(application, continue: userActivity, restorationHandler: restorationHandler)
       }
   }

Handle Open App with URL (Objective-C)

Config iOS associated domain

Configuring your iOS associated domain is required for Magic Link authentication / Reset Password / Activate Account.

In order to add your iOS associated domain to your Frontegg application, you will need to update in each of your integrated Frontegg Environments the iOS associated domain that you would like to use with that Environment. Send a POST request to https://api.frontegg.com/vendors/resources/associated-domains/v1/ios with the following payload:

{
    “appId”:[YOUR_ASSOCIATED_DOMAIN]
}

In order to use our API’s, follow this guide to generate a vendor token.

Multi-apps iOS Support

This guide outlines the steps to configure your iOS application to support multiple applications.

Step 1: Modify the Frontegg.plist File

Add applicationId to Frontegg.plist file:

<plist version="1.0">
  <dict>
    <key>applicationId</key>
    <string>your-application-id-uuid</string>
    <key>baseUrl</key>
    <string>https://your-domain.fronteg.com</string>
    <key>clientId</key>
    <string>your-client-id-uuid</string>
  </dict>
</plist>

Setup Android Project

Set minimum sdk version

To set up your Android minimum sdk version, open root gradle file atandroid/build.gradle, and add/edit the minSdkVersion under buildscript.ext:

buildscript {
    ext {
        minSdkVersion = 26
        // ...
    }
}

Configure build config fields

To set up your Android application on to communicate with Frontegg, you have to add buildConfigField property the gradle android/app/build.gradle. This property will store frontegg hostname (without https) and client id from previous step:

def fronteggDomain = "FRONTEGG_DOMAIN_HOST.com" // without protocol https://
def fronteggClientId = "FRONTEGG_CLIENT_ID"

android {
    defaultConfig {

        manifestPlaceholders = [
                "package_name" : applicationId,
                "frontegg_domain" : fronteggDomain,
                "frontegg_client_id": fronteggClientId
        ]

        buildConfigField "String", 'FRONTEGG_DOMAIN', "\"$fronteggDomain\""
        buildConfigField "String", 'FRONTEGG_CLIENT_ID', "\"$fronteggClientId\""
        buildConfigField "Boolean", 'FRONTEGG_USE_ASSETS_LINKS', "true" /** For using frontegg domain for deeplinks **/
        buildConfigField "Boolean", 'FRONTEGG_USE_CHROME_CUSTOM_TABS', "true"  /** For using custom chrome tab for social-logins **/
    }


}

Add bundleConfig=true if not exists inside the android section inside the app gradle android/app/build.gradle

android {
  buildFeatures {
    buildConfig = true
  }
}

Add permissions to AndroidManifest.xml

Add INTERNET permission to the app's manifest file.

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>

Config Android AssetLinks

Configuring your Android AssetLinks is required for Magic Link authentication / Reset Password / Activate Account / login with IdPs.

To add your AssetLinks to your Frontegg application, you will need to update in each of your integrated Frontegg Environments the AssetLinks that you would like to use with that Environment. Send a POST request to https://api.frontegg.com/vendors/resources/associated-domains/v1/android with the following payload:

{
    "packageName": "YOUR_APPLICATION_PACKAGE_NAME",
    "sha256CertFingerprints": ["YOUR_KEYSTORE_CERT_FINGERPRINTS"]
}

Each Android app has multiple certificate fingerprint, to get your DEBUG sha256CertFingerprint you have to run the following command:

For Debug mode, run the following command and copy the SHA-256 value

NOTE: make sure to choose the Variant and Config equals to debug

./gradlew signingReport

###################
#  Example Output:
###################

#  Variant: debug
#  Config: debug
#  Store: /Users/davidfrontegg/.android/debug.keystore
#  Alias: AndroidDebugKey
#  MD5: 25:F5:99:23:FC:12:CA:10:8C:43:F4:02:7D:AD:DC:B6
#  SHA1: FC:3C:88:D6:BF:4E:62:2E:F0:24:1D:DB:D7:15:36:D6:3E:14:84:50
#  SHA-256: D9:6B:4A:FD:62:45:81:65:98:4D:5C:8C:A0:68:7B:7B:A5:31:BD:2B:9B:48:D9:CF:20:AE:56:FD:90:C1:C5:EE
#  Valid until: Tuesday, 18 June 2052

For Release mode, Extract the SHA256 using keytool from your Release keystore file:

keytool -list -v -keystore /PATH/file.jks -alias YourAlias -storepass *** -keypass ***

In order to use our API’s, follow this guide to generate a vendor token.

Enabling Chrome Custom Tabs for Social Login

To enable social login using Chrome Custom Tabs within your Android application, you need to modify the android/app/build.gradle file. Add a boolean buildConfigField for the FRONTEGG_USE_CHROME_CUSTOM_TABS flag and set it to true.

By default, the SDK defaults to using the Chrome browser for social login.

def fronteggDomain = "FRONTEGG_DOMAIN_HOST.com" // without protocol https://
def fronteggClientId = "FRONTEGG_CLIENT_ID"

android {
   defaultConfig {

       manifestPlaceholders = [
               "package_name" : applicationId,
               "frontegg_domain" : fronteggDomain,
               "frontegg_client_id": fronteggClientId
       ]

       buildConfigField "String", 'FRONTEGG_DOMAIN', "\"$fronteggDomain\""
       buildConfigField "String", 'FRONTEGG_CLIENT_ID', "\"$fronteggClientId\""

       buildConfigField "Boolean", 'FRONTEGG_USE_CHROME_CUSTOM_TABS', "true"
   }


}

Multi-apps Android Support

This guide outlines the steps to configure your Android application to support multiple applications.

Step 1: Modify the Build.gradle file

Add FRONTEGG_APPLICATION_ID buildConfigField into the build.gradle file:

def fronteggApplicationId = "your-application-id-uuid"
...
android {
    ...
    buildConfigField "String", 'FRONTEGG_APPLICATION_ID', "\"$fronteggApplicationId\""
}

Usages

Wrap your app with FronteggProvider

NOTE: we recommend to use FronteggWrapper component along with the NavigationContainer from @react-navigation/native: to install @react-navigation/native and @react-navigation/native-stack run the following command:

NPM:

npm install -s @react-navigation/native @react-navigation/native-stack react-native-screens react-native-safe-area-context

Yarn:

yarn add @react-navigation/native @react-navigation/native-stack react-native-screens react-native-safe-area-context

Modify your App.tsx file and wrap your app with FronteggProvider and pass your Frontegg configuration:

import * as React from 'react';
import { NavigationContainer } from '@react-navigation/native';
import { createNativeStackNavigator } from '@react-navigation/native-stack';
import HomeScreen from './HomeScreen';
import ProfileScreen from './ProfileScreen';
import { FronteggWrapper } from '@frontegg/react-native';

const Stack = createNativeStackNavigator();

export default () => {
  return (
    <FronteggWrapper>
      <NavigationContainer>
        <Stack.Navigator>
          <Stack.Screen name="Home" component={HomeScreen} />
          <Stack.Screen name="Profile" component={ProfileScreen} />
        </Stack.Navigator>
      </NavigationContainer>
    </FronteggWrapper>
  );
};

Login with frontegg

To log in with frontegg you can use the useAuth hook:

import { View, Button } from 'react-native';
import { useAuth, login, logout } from '@frontegg/react-native';


export function MyScreen() {
  const { isAuthenticated } = useAuth();

  return <View>
    <Button title={'Login'} onPress={login} />
  </View>
}

Switch tenant frontegg

To switch tenant, get switchTenant from the useAuth hook:

import { useCallback } from 'react';
import { View, Button } from 'react-native';
import { useAuth } from '@frontegg/react-native';


export function MyScreen() {
  const { switchTenant, user } = useAuth();

  // user avaiable tenants from user.tenants
  console.log("user tenants", user?.tenants)

  const handleSwitchTenant = useCallback(() => {
    const tenantId = 'TENANT_ID'; // get tenant id from your app state


    switchTenant(tenantId).then(() => {
      console.log('Tenant switched successfully');
    }).catch((error) => {
      console.log('Failed to switch tenant', error);
    });
  }, [ switchTenant ]);

  return <View>
    <Button title={'Switch Tenant'} onPress={handleSwitchTenant} />
  </View>;
}

Check if user is authenticated

To check if user is authenticated before display your app you can use the useAuth hook along with the isLoading property:

import { StyleSheet, View, Text, Button } from 'react-native';
import { useAuth } from '@frontegg/react-native';

export default function HomeScreen() {
  const {
    showLoader,
    isLoading,
    isAuthenticated,
    user,
  } = useAuth();

  // showLoader when the SDK is initializing the app / authenticate the user
  if (showLoader || isLoading) {
    return <View>
      <Text>Loading...</Text>
    </View>
  }


  return <View>
    <Text>{isAuthenticated ? 'Authenticated' : 'Not authenticated'}</Text>

    {isAuthenticated && <Text>{user?.email}</Text>}

    <Button
      color={isAuthenticated ? '#FF0000' : '#000000'}
      title={isAuthenticated ? 'Logout' : 'Login'}
      onPress={() => {
        isAuthenticated ? logout() : login();
      }}
    />
  </View>
}