Merge pull request #45 from getyoti/release/DEP-589-5.0.0

[Task] DEP-589: RN 5.0.0

Author: asklausen

README.md

@@ -10,14 +10,14 @@ A react native wrapper of Yoti IDV for [Android](https://github.com/getyoti/yoti
 To integrate with Yoti IDV, a working infrastructure is needed (see [developers.yoti.com](https://developers.yoti.com/identity-verification/overview) for more details or get in touch with us [here](https://developers.yoti.com/support)).
 
 ## Requirements
-- [Android SDK 3+](https://github.com/getyoti/yoti-doc-scan-android/releases)
-- [iOS SDK 6+](https://github.com/getyoti/yoti-doc-scan-ios/releases)
+- [Android SDK 4+](https://github.com/getyoti/yoti-doc-scan-android/releases)
+- [iOS SDK 7+](https://github.com/getyoti/yoti-doc-scan-ios/releases)
 
 ## Integration
 Start your integration by adding the following dependency to your `package.json` file:
 ```json
 "dependencies": {
-    "@getyoti/yoti-doc-scan-react-native": "^4.0.0"
+    "@getyoti/yoti-doc-scan-react-native": "^5.0.0"
 }
 ```
 
@@ -26,13 +26,13 @@ Continuing with your integration for Android, add the following property and rep
 ```groovy
 buildscript {
     ext {
-        yotiSdkVersion = "3.5.0"
+        yotiSdkVersion = "4.0.0"
     }
 }
 allprojects {
     repositories {
         maven {
-            url 'https://maven.microblink.com'
+            url 'https://maven.regulaforensics.com/RegulaDocumentReader'
         }
     }
 }
@@ -54,12 +54,14 @@ dependencies {
 ```
 If you're using Proguard or another obfuscation tool, you should also add the following configuration rules to your `proguard-rules.pro` file:
 ```groovy
+-keepclassmembers class kotlinx.** {
+    volatile <fields>;
+}
 -keep class com.yoti.** { *; }
--keep class com.microblink.** { *; }
--keep class com.microblink.**$* { *; }
--dontwarn com.microblink.**
--keep class com.facetec.zoom.** { *; }
+-dontwarn com.facetec.sdk.**
+-keep class com.facetec.sdk.** { *; }
 -dontwarn javax.annotation.Nullable
+-keepclassmembers class io.ktor.** { volatile <fields>; }
 ```
 
 ### iOS
@@ -68,7 +70,7 @@ To continue your integration with iOS, you should add the following to your [`Po
 require_relative '../node_modules/@react-native-community/cli-platform-ios/native_modules'
 require_relative '../node_modules/react-native/scripts/react_native_pods'
 
-platform :ios, '11.0'
+platform :ios, '13.0'
 
 target 'TargetName' do
   config = use_native_modules!
@@ -83,45 +85,50 @@ target 'TargetName' do
   pod 'YotiSDKFaceCapture'              // Optional
 end
 ```
-In addition, you should add [`NSCameraUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription) to your `Info.plist`.
-
-And if you have included `YotiNFC` in your target, make sure to also:
-- Add [`NFCReaderUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nfcreaderusagedescription) to your `Info.plist`
-- Add [`com.apple.developer.nfc.readersession.iso7816.select-identifiers`](https://developer.apple.com/documentation/bundleresources/information_property_list/select-identifiers) to your `Info.plist` and include [`A0000002471001`](https://www.icao.int/publications/Documents/9303_p10_cons_en.pdf) as an application identifier for your app to support
-- Turn on [`Near Field Communication Tag Reading`](https://developer.apple.com/documentation/corenfc/building_an_nfc_tag-reader_app) under the Signing & Capabilities tab for your project’s target
+In addition, you should [modify the properties and capabilities of your project's target](https://github.com/getyoti/yoti-doc-scan-ios?tab=readme-ov-file#5-modify-the-properties-and-capabilities-of-your-projects-target).
 
 ## Usage
 ### 1. Import module
 ```javascript
 import RNYotiDocScan from '@getyoti/yoti-doc-scan-react-native';
 ```
-### 2. Launch a session
-Launch a session with its required parameters using the `startSession` function.
+### 2. Optional configuration and customization
+For customization on Android, you can refer to the documentation outlined [here](https://github.com/getyoti/yoti-doc-scan-android?tab=readme-ov-file#customisation). In addition, you can choose to also set a request code:
 ```javascript
-const successCallback = (code, description) => {
-    ...
-}
-const errorCallback = (code, description) => {
-    ...
-}
-RNYotiDocScan.startSession(id, token, successCallback, errorCallback);
+RNYotiDocScan.setRequestCode(0); // default: 9001
 ```
 
-### 3. Customizations
-On iOS, you can set the primary colors using the following API:
+On iOS, the SDK expects launched sessions to contain multiple flows by default. To enable single-flow sessions, configure and include [yoti-doc-scan-react-native-configuration-ios.json](templates/yoti-doc-scan-react-native-configuration-ios.json) in your project’s target and then set the configuration as follows:
 ```javascript
-RNYotiDocScan.setLightPrimaryColorRGB(0, 0, 0); // default: (40, 117, 188)
-RNYotiDocScan.setDarkPrimaryColorRGB(0, 0, 0); // default: (145, 190, 255)
+RNYotiDocScan.setConfiguration({
+    bundle_identifier: "", // Optional: defaults to the main bundle identifier if not specified.
+    filename: "yoti-doc-scan-react-native-configuration-ios.json"
+});
 ```
-To customize the colors on Android, please refer to its separate [documentation](https://github.com/getyoti/yoti-doc-scan-android#colours).
+Ensure that only one module type property is set to `true` when `single_flow` is enabled.
 
-In addition, you can choose to also specify a request code on Android:
+To customize the appearance on iOS, you can configure the SDK using [yoti-doc-scan-react-native-configuration-with-theme-ios.json](templates/yoti-doc-scan-react-native-configuration-with-theme-ios.json) instead, which supports the following options for theming:
+
+- Light and dark mode color themes. We also support specifying only a primary color for each mode
+- Typography theme (system and custom fonts, font weight, size, line height multiple and kern)
+- Spacing mode (compact, regular and relaxed)
+- Shape theme (corner radius and border width)
+- Icon theme (custom vectors, system and custom SF Symbols, incl. localized ones)
+- Illustration theme (custom vectors)
+
+All customisation types are optional, and can be set independently from each other.
+
+### 3. Launch a session
+Launch a session with its required parameters using the `start` function.
 ```javascript
-RNYotiDocScan.setRequestCode(0); // default: 9001
+const completion = (code, description) => {
+    ...
+}
+RNYotiDocScan.start(sessionID, sessionToken, completion);
 ```
 
 ## Supported languages
-Yoti IDV supports the 9 languages listed in the table below, but their use is driven by the localization configuration of your target. If your target only supports a subset of our SDK's supported languages, our SDK will fall back to English on the ones your target doesn't support.
+Our SDK supports the 9 languages listed in the table below, but their use is driven by the localization configuration of your target. If your target only supports a subset of our SDK's supported languages, our SDK will fall back to English on the ones your target doesn't support.
 
 Language | Code
 :-- | :--
@@ -135,10 +142,11 @@ Russian | ru
 Spanish | es
 Turkish | tr
 
-## Error codes
+## Status codes
 Code | Description
 :-- | :--
-1000 | No error occurred. The user cancelled the session
+0 | The user completed the session
+1000 | The user cancelled the session
 2000 | Unauthorised request (wrong or expired session token)
 2001 | Session not found
 2002 | Session expired

RNYotiDocScan.js

@@ -1,3 +1,3 @@
-import { NativeModules } from 'react-native'
+import {NativeModules} from 'react-native'
 
 export default NativeModules.RNYotiDocScan;

android/build.gradle

@@ -10,8 +10,8 @@ android {
     defaultConfig {
         minSdkVersion safeExtGet('minSdkVersion', 21)
         targetSdkVersion safeExtGet('targetSdkVersion', 33)
-        versionCode 400
-        versionName "4.0.0"
+        versionCode 500
+        versionName "5.0.0"
         ndk {
             abiFilters "armeabi-v7a", "x86"
         }

android/src/main/java/com/yoti/reactnative/docscan/RNYotiDocScanModule.java

@@ -7,15 +7,15 @@
 import com.facebook.react.bridge.Callback;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.ReactMethod;
 import com.yoti.mobile.android.yotisdkcore.YotiSdk;
 import static com.yoti.mobile.android.yotisdkcore.YotiSdkKt.YOTI_SDK_REQUEST_CODE;
 
 public class RNYotiDocScanModule extends ReactContextBaseJavaModule {
     private final static int SESSION_SUCCESS_CODE = 0;
     private YotiSdk mYotiSdk;
-    private Callback mErrorCallback;
-    private Callback mSuccessCallback;
+    private Callback mCompletion;
     private int mRequestCode = YOTI_SDK_REQUEST_CODE;
 
     private final ActivityEventListener mActivityEventListener = new BaseActivityEventListener() {
@@ -27,10 +27,10 @@ public void onActivityResult(Activity activity, int requestCode, int resultCode,
             int code = mYotiSdk.getSessionStatusCode();
             String description = mYotiSdk.getSessionStatusDescription();
             if (resultCode == Activity.RESULT_OK && code == SESSION_SUCCESS_CODE) {
-                mSuccessCallback.invoke(code, description);
+                mCompletion.invoke(code, description);
                 return;
             }
-            mErrorCallback.invoke(code, description);
+            mCompletion.invoke(code, description);
         }
     };
 
@@ -46,17 +46,7 @@ public String getName() {
     }
 
     @ReactMethod
-    public void useCanadaService() {
-        mYotiSdk.useCanadaService();
-    }
-
-    @ReactMethod
-    public void setLightPrimaryColorRGB(double red, double green, double blue) {
-        // Required to maintain cross-platform API compatibility.
-    }
-
-    @ReactMethod
-    public void setDarkPrimaryColorRGB(double red, double green, double blue) {
+    public void setConfiguration(ReadableMap configuration) {
         // Required to maintain cross-platform API compatibility.
     }
 
@@ -66,19 +56,18 @@ public void setRequestCode(int requestCode) {
     }
 
     @ReactMethod
-    public void startSession(String sessionId, String clientSessionToken, Callback successCallback, Callback errorCallback) {
-        mErrorCallback = errorCallback;
-        mSuccessCallback = successCallback;
+    public void start(String sessionID, String sessionToken, Callback completion) {
+        mCompletion = completion;
         Activity currentActivity = getCurrentActivity();
         if (currentActivity == null) {
-            mErrorCallback.invoke("E_ACTIVITY_DOES_NOT_EXIST");
+            mCompletion.invoke("E_ACTIVITY_DOES_NOT_EXIST");
             return;
         }
-        boolean success = mYotiSdk.setSessionId(sessionId).setClientSessionToken(clientSessionToken).start(currentActivity, mRequestCode);
+        boolean success = mYotiSdk.setSessionId(sessionID).setClientSessionToken(sessionToken).start(currentActivity, mRequestCode);
         if (!success) {
             int code = mYotiSdk.getSessionStatusCode();
             String description = mYotiSdk.getSessionStatusDescription();
-            mErrorCallback.invoke(code, description);
+            mCompletion.invoke(code, description);
         }
     }
 }

example/android/app/build.gradle

@@ -76,7 +76,7 @@ android {
 
 dependencies {
     implementation fileTree(dir: "libs", include: ["*.jar"])
-    implementation "com.facebook.react:react-native:0.68.5"
+    implementation "com.facebook.react:react-native:0.70.0"
     implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:${rootProject.ext.yotiSdkVersion}"
     // implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-slim:${rootProject.ext.yotiSdkVersion}"
     //implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:${rootProject.ext.yotiSdkVersion}"

example/android/app/proguard-rules.pro

@@ -1,16 +1,8 @@
-# Add project specific ProGuard rules here.
-# By default, the flags in this file are appended to flags specified
-# in /usr/local/Cellar/android-sdk/24.3.3/tools/proguard/proguard-android.txt
-# You can edit the include path and order by changing the proguardFiles
-# directive in build.gradle.
-#
-# For more details, see
-#   http://developer.android.com/guide/developing/tools/proguard.html
-
-# Add any project specific keep options here:
+-keepclassmembers class kotlinx.** {
+    volatile <fields>;
+}
 -keep class com.yoti.** { *; }
--keep class com.microblink.** { *; }
--keep class com.microblink.**$* { *; }
--dontwarn com.microblink.**
--keep class com.facetec.zoom.** { *; }
--dontwarn javax.annotation.Nullable
+-dontwarn com.facetec.sdk.**
+-keep class com.facetec.sdk.** { *; }
+-dontwarn javax.annotation.Nullable
+-keepclassmembers class io.ktor.** { volatile <fields>; }

example/android/build.gradle

@@ -3,7 +3,7 @@ buildscript {
         minSdkVersion = 21
         compileSdkVersion = 33
         targetSdkVersion = 33
-        yotiSdkVersion = "3.5.0"
+        yotiSdkVersion = "4.0.0"
     }
     repositories {
         google()
@@ -30,7 +30,7 @@ allprojects {
         }
         mavenCentral()
         maven {
-            url 'https://maven.microblink.com'
+            url 'https://maven.regulaforensics.com/RegulaDocumentReader'
         }
     }
 }

example/android/gradle.properties

@@ -10,7 +10,7 @@
 # Specifies the JVM arguments used for the daemon process.
 # The setting is particularly useful for tweaking memory settings.
 # Default value: -Xmx10248m -XX:MaxPermSize=256m
-org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
+# org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
 
 # When configured, Gradle will run in incubating parallel mode.
 # This option should only be used with decoupled projects. More details, visit

example/app.json

@@ -1,5 +1,4 @@
-import { AppRegistry } from 'react-native';
+import {AppRegistry} from 'react-native';
 import App from './src/App';
-import { name as appName } from './app.json';
 
-AppRegistry.registerComponent(appName, () => App);
+AppRegistry.registerComponent('example', () => App);