omnipay-reactnative-sdk 1.2.2-beta.4 → 1.2.2-beta.6

package/README.md

@@ -1,6 +1,17 @@
 # omnipay-reactnative-sdk
 
-Omnipay react native sdk
+Omnipay react native sdk with **Liveness Detection** support
+
+## Features
+
+- **Payment Processing** - Complete payment flow integration
+- **User Registration & BVN Verification** - User onboarding flows
+- **🆕 Liveness Detection** - Real-time face verification using ML Kit (Android) and Vision Framework (iOS)
+  - Smile detection
+  - Blink detection
+  - Head turn challenges
+  - Native camera integration
+  - Cross-platform support
 
 ## Installation
 
@@ -14,6 +25,8 @@ yarn add omnipay-reactnative-sdk
 yarn add react-native-select-contact react-native-webview react-native-share
 ```
 
+**Note:** Liveness detection requires no additional dependencies. Camera permissions and native modules are handled automatically - no permission management code needed in your app.
+
 Make sure your manifest files includes permission to read contacts
 
 ```sh
@@ -102,45 +115,48 @@ initiateWallet({
 ### Properties
 
 #### OmnipayProvider Props
-| Name            | Type     | Description                                              |
-| --------------- | -------- | -------------------------------------------------------- |
-| color           | String   | color of primary buttons and links                       |
-| env             | String   | dev or prod                                              |
-| publicKey       | String   | public key of the company on omnipay                     |
+
+| Name      | Type   | Description                          |
+| --------- | ------ | ------------------------------------ |
+| color     | String | color of primary buttons and links   |
+| env       | String | dev or prod                          |
+| publicKey | String | public key of the company on omnipay |
 
 #### initiateBills Props
-| Name            | Type     | Description                                              |
-| --------------- | -------- | -------------------------------------------------------- |
-| phoneNumber     | String   | phone number of the customer                             |
-| onClose         | Function | this is used to notify you when the sdk closes          |
+
+| Name        | Type     | Description                                    |
+| ----------- | -------- | ---------------------------------------------- |
+| phoneNumber | String   | phone number of the customer                   |
+| onClose     | Function | this is used to notify you when the sdk closes |
 
 #### initiateWallet Props
-| Name                    | Type     | Description                                                      |
-| ----------------------- | -------- | ---------------------------------------------------------------- |
-| phoneNumber             | String   | phone number of the customer                                     |
-| customerRef             | String   | unique reference for the customer                                |
-| userRef                 | String   | unique reference for the user                                    |
-| onClose                 | Function | this is used to notify you when the sdk closes                  |
-| usesPaylater            | Boolean  | whether to show paylater tab in wallet view                      |
-| usesPromo               | Boolean  | whether to show promo tab in wallet view                         |
-| usesAirtimeData         | Boolean  | whether to show airtime and data shortcut in wallet view         |
-| usesTransfer            | Boolean  | whether to show transfer shortcut in wallet view                 |
-| usesBills               | Boolean  | whether to show bills shortcut in wallet view                    |
-| usesPos                 | Boolean  | whether to show pos shortcut in wallet view                      |
-| promoBalanceOffset      | Number   | offset for promo balance display                                 |
-| deviceId                | String   | unique identifier for the device                                 |
-| deviceName              | String   | name of the device                                               |
-| hideWalletTransfer      | Boolean  | whether to hide wallet transfer functionality                    |
-| isBvnValidationRequired | Boolean  | whether BVN validation is required                               |
-| walletTab               | String   | initial wallet tab to display ('Paylater', 'Account', 'Omoni')  |
-| sessionId               | String   | unique session identifier                                        |
-| kycStatus               | String   | KYC status of the user ('verified', 'unverified')               |
-| launchPage              | String   | page to launch in the wallet                                     |
 
+| Name                    | Type     | Description                                                    |
+| ----------------------- | -------- | -------------------------------------------------------------- |
+| phoneNumber             | String   | phone number of the customer                                   |
+| customerRef             | String   | unique reference for the customer                              |
+| userRef                 | String   | unique reference for the user                                  |
+| onClose                 | Function | this is used to notify you when the sdk closes                 |
+| usesPaylater            | Boolean  | whether to show paylater tab in wallet view                    |
+| usesPromo               | Boolean  | whether to show promo tab in wallet view                       |
+| usesAirtimeData         | Boolean  | whether to show airtime and data shortcut in wallet view       |
+| usesTransfer            | Boolean  | whether to show transfer shortcut in wallet view               |
+| usesBills               | Boolean  | whether to show bills shortcut in wallet view                  |
+| usesPos                 | Boolean  | whether to show pos shortcut in wallet view                    |
+| promoBalanceOffset      | Number   | offset for promo balance display                               |
+| deviceId                | String   | unique identifier for the device                               |
+| deviceName              | String   | name of the device                                             |
+| hideWalletTransfer      | Boolean  | whether to hide wallet transfer functionality                  |
+| isBvnValidationRequired | Boolean  | whether BVN validation is required                             |
+| walletTab               | String   | initial wallet tab to display ('Paylater', 'Account', 'Omoni') |
+| sessionId               | String   | unique session identifier                                      |
+| kycStatus               | String   | KYC status of the user ('verified', 'unverified')              |
+| launchPage              | String   | page to launch in the wallet                                   |
 
 ## Registration Sdk
+
 ```js
-import { Omnipay } from "omnipay-reactnative-sdk";
+import { Omnipay } from 'omnipay-reactnative-sdk';
 
 //render it anywhere on your page where you want to display the registration sdk
 <Omnipay.Registration
@@ -150,9 +166,9 @@ import { Omnipay } from "omnipay-reactnative-sdk";
   phoneNumber="09031234571"
   onRegistrationSuccessful={({ customerRef, walletId }) => {
     /**
-     * the customer ref and walletid can be saved 
+     * the customer ref and walletid can be saved
      * to your database at this point
-     * 
+     *
      * we will also be sending a webhook notification
      * so, you can either save at this point or via the webhook
      */
@@ -163,17 +179,51 @@ import { Omnipay } from "omnipay-reactnative-sdk";
      * the user is done with registration.
      * you can navigate them else where at this point
      */
-   
   }}
-/>
+/>;
 ```
 
 ### Properties
 
-| Name            | Type     | Description                                              |
-| --------------- | -------- | -------------------------------------------------------- |
-| color           | String   | color of primary buttons and links                       |
-| env             | String   | dev or prod                                              |
-| phoneNumber     | String   | phone number of the customer                             |
-| publicKey       | String   | public key of the company on omnipay                     |
-| view            | String   | the view to render on the sdk                            |
+| Name        | Type   | Description                          |
+| ----------- | ------ | ------------------------------------ |
+| color       | String | color of primary buttons and links   |
+| env         | String | dev or prod                          |
+| phoneNumber | String | phone number of the customer         |
+| publicKey   | String | public key of the company on omnipay |
+| view        | String | the view to render on the sdk        |
+
+## Liveness Detection
+
+The SDK now includes advanced liveness detection capabilities for secure face verification.
+
+### Quick Start
+
+```typescript
+import React from 'react';
+import { OmnipayProvider } from 'omnipay-reactnative-sdk';
+
+function MyApp() {
+  return (
+    <OmnipayProvider publicKey="your-public-key" env="dev" color="#007AFF">
+      <YourAppContent />
+    </OmnipayProvider>
+  );
+}
+```
+
+Face verification with liveness detection is **automatically integrated** and will appear as part of the SDK flow when needed. No additional setup or modal management required!
+
+### Features
+
+- **Real-time face detection** using ML Kit (Android) and Vision Framework (iOS)
+- **Multiple challenge types**: Smile, Blink, Head Turn Left/Right
+- **Configurable timeouts** and challenge sequences
+- **Native camera integration** with optimal performance
+- **Automatic permission handling** - no additional setup required
+- **Event-driven callbacks** for complete control
+- **Base64 screenshot capture** after successful verification
+
+### Documentation
+
+For complete liveness detection documentation, see [LIVENESS_DETECTION.md](./LIVENESS_DETECTION.md)

package/android/build.gradle

@@ -7,7 +7,7 @@ buildscript {
             mavenCentral()
             google()
         }
-        def buildGradleVersion = ext.has('buildGradlePluginVersion') ? ext.get('buildGradlePluginVersion') : '4.2.0'
+        def buildGradleVersion = ext.has('buildGradlePluginVersion') ? ext.get('buildGradlePluginVersion') : '8.8.0'
 
         dependencies {
             classpath "com.android.tools.build:gradle:$buildGradleVersion"
@@ -22,14 +22,19 @@ def safeExtGet(prop, fallback) {
 }
 
 android {
-    compileSdkVersion safeExtGet('compileSdkVersion', 31)
+    compileSdkVersion safeExtGet('compileSdkVersion', 34)
 
     defaultConfig {
-        minSdkVersion safeExtGet('minSdkVersion', 21)
-        targetSdkVersion safeExtGet('targetSdkVersion', 31)
+        minSdkVersion safeExtGet('minSdkVersion', 24)
+        targetSdkVersion safeExtGet('targetSdkVersion', 34)
         versionCode 1
         versionName "1.1"
     }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_11
+        targetCompatibility JavaVersion.VERSION_11
+    }
 }
 
 repositories {
@@ -44,16 +49,12 @@ repositories {
 dependencies {
   implementation "com.facebook.react:react-native:${safeExtGet('reactNativeVersion', '+')}"
   
-  // CameraX dependencies for liveness detection
-  implementation 'androidx.camera:camera-core:1.3.1'
-  implementation 'androidx.camera:camera-camera2:1.3.1'
-  implementation 'androidx.camera:camera-lifecycle:1.3.1'
-  implementation 'androidx.camera:camera-view:1.3.1'
-  
-  // ML Kit for face detection
-  implementation 'com.google.mlkit:face-detection:16.1.5'
+  // ML Kit dependencies for liveness detection
+  implementation 'com.google.mlkit:face-detection:16.1.6'
   
-  // Additional required dependencies
-  implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.7.0'
-  implementation 'androidx.core:core-ktx:1.12.0'
+  // CameraX dependencies for camera handling
+  implementation "androidx.camera:camera-core:1.3.1"
+  implementation "androidx.camera:camera-camera2:1.3.1"
+  implementation "androidx.camera:camera-lifecycle:1.3.1"
+  implementation "androidx.camera:camera-view:1.3.1"
 }

package/android/src/main/AndroidManifest.xml

@@ -3,7 +3,7 @@
 
     <!-- Camera permissions for liveness detection -->
     <uses-permission android:name="android.permission.CAMERA" />
-    <uses-feature android:name="android.hardware.camera" android:required="true" />
+    <uses-feature android:name="android.hardware.camera" android:required="false" />
     <uses-feature android:name="android.hardware.camera.front" android:required="false" />
 
     <application>

package/android/src/main/java/com/omniretail/omnipay/OmnipayActivityPackage.java

@@ -16,14 +16,14 @@ public class OmnipayActivityPackage implements ReactPackage {
     public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
         List<NativeModule> modules = new ArrayList<>();
         modules.add(new OmnipayActivityModule(reactContext));
-        modules.add(new LivenessDetectionModule(reactContext));
+        modules.add(new OmnipayLivenessModule(reactContext));
         return modules;
     }
 
     @Override
     public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
         List<ViewManager> viewManagers = new ArrayList<>();
-        viewManagers.add(new LivenessCameraViewManager(reactContext));
+        viewManagers.add(new OmnipayLivenessCameraViewManager(reactContext));
         return viewManagers;
     }
 

package/android/src/main/java/com/omniretail/omnipay/OmnipayLivenessCameraView.java

@@ -0,0 +1,153 @@
+package com.omniretail.omnipay;
+
+import android.content.Context;
+import android.util.AttributeSet;
+import android.util.Log;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.widget.FrameLayout;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.camera.core.CameraSelector;
+import androidx.camera.core.Preview;
+import androidx.camera.lifecycle.ProcessCameraProvider;
+import androidx.camera.view.PreviewView;
+import androidx.core.content.ContextCompat;
+import androidx.lifecycle.LifecycleOwner;
+
+import com.facebook.react.bridge.Arguments;
+import com.facebook.react.bridge.ReactContext;
+import com.facebook.react.bridge.WritableMap;
+import com.facebook.react.uimanager.events.RCTEventEmitter;
+import com.google.common.util.concurrent.ListenableFuture;
+
+import java.util.concurrent.ExecutionException;
+
+public class OmnipayLivenessCameraView extends FrameLayout {
+    private static final String TAG = "OmnipayLivenessCameraView";
+    
+    private PreviewView previewView;
+    private ProcessCameraProvider cameraProvider;
+    private Preview preview;
+    private boolean isInitialized = false;
+    
+    public OmnipayLivenessCameraView(@NonNull Context context) {
+        super(context);
+        init();
+    }
+    
+    public OmnipayLivenessCameraView(@NonNull Context context, @Nullable AttributeSet attrs) {
+        super(context, attrs);
+        init();
+    }
+    
+    public OmnipayLivenessCameraView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
+        super(context, attrs, defStyleAttr);
+        init();
+    }
+    
+    private void init() {
+        // Create and add PreviewView
+        previewView = new PreviewView(getContext());
+        previewView.setLayoutParams(new FrameLayout.LayoutParams(
+                FrameLayout.LayoutParams.MATCH_PARENT,
+                FrameLayout.LayoutParams.MATCH_PARENT
+        ));
+        previewView.setScaleType(PreviewView.ScaleType.FILL_CENTER);
+        addView(previewView);
+        
+        // Initialize camera
+        initializeCamera();
+    }
+    
+    private void initializeCamera() {
+        ListenableFuture<ProcessCameraProvider> cameraProviderFuture = 
+            ProcessCameraProvider.getInstance(getContext());
+            
+        cameraProviderFuture.addListener(() -> {
+            try {
+                cameraProvider = cameraProviderFuture.get();
+                setupCamera();
+                isInitialized = true;
+                sendEvent("onCameraReady", Arguments.createMap());
+            } catch (ExecutionException | InterruptedException e) {
+                Log.e(TAG, "Error initializing camera", e);
+                WritableMap errorMap = Arguments.createMap();
+                errorMap.putString("error", "Failed to initialize camera: " + e.getMessage());
+                sendEvent("onCameraError", errorMap);
+            }
+        }, ContextCompat.getMainExecutor(getContext()));
+    }
+    
+    private void setupCamera() {
+        if (cameraProvider == null) {
+            return;
+        }
+        
+        // Create preview use case
+        preview = new Preview.Builder().build();
+        
+        // Connect preview to PreviewView
+        preview.setSurfaceProvider(previewView.getSurfaceProvider());
+        
+        // Select front camera
+        CameraSelector cameraSelector = CameraSelector.DEFAULT_FRONT_CAMERA;
+        
+        try {
+            // Unbind all use cases before rebinding
+            cameraProvider.unbindAll();
+            
+            // Bind preview to camera
+            if (getContext() instanceof LifecycleOwner) {
+                cameraProvider.bindToLifecycle(
+                    (LifecycleOwner) getContext(),
+                    cameraSelector,
+                    preview
+                );
+            } else {
+                Log.w(TAG, "Context is not a LifecycleOwner, camera preview may not work properly");
+            }
+        } catch (Exception e) {
+            Log.e(TAG, "Error binding camera", e);
+            WritableMap errorMap = Arguments.createMap();
+            errorMap.putString("error", "Failed to bind camera: " + e.getMessage());
+            sendEvent("onCameraError", errorMap);
+        }
+    }
+    
+    public void setupCameraPreview(ProcessCameraProvider cameraProvider) {
+        this.cameraProvider = cameraProvider;
+        if (isInitialized) {
+            setupCamera();
+        }
+    }
+    
+    public void startPreview() {
+        if (preview != null && cameraProvider != null) {
+            // Camera preview is automatically started when bound to lifecycle
+            Log.d(TAG, "Camera preview started");
+        }
+    }
+    
+    public void stopPreview() {
+        if (cameraProvider != null) {
+            cameraProvider.unbindAll();
+            Log.d(TAG, "Camera preview stopped");
+        }
+    }
+    
+    @Override
+    protected void onDetachedFromWindow() {
+        super.onDetachedFromWindow();
+        stopPreview();
+    }
+    
+    private void sendEvent(String eventName, WritableMap params) {
+        ReactContext reactContext = (ReactContext) getContext();
+        if (reactContext != null) {
+            reactContext.getJSModule(RCTEventEmitter.class)
+                .receiveEvent(getId(), eventName, params);
+        }
+    }
+} 

package/android/src/main/java/com/omniretail/omnipay/OmnipayLivenessCameraViewManager.java

@@ -0,0 +1,49 @@
+package com.omniretail.omnipay;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.common.MapBuilder;
+import com.facebook.react.uimanager.SimpleViewManager;
+import com.facebook.react.uimanager.ThemedReactContext;
+import com.facebook.react.uimanager.annotations.ReactProp;
+
+import java.util.Map;
+
+public class OmnipayLivenessCameraViewManager extends SimpleViewManager<OmnipayLivenessCameraView> {
+    public static final String REACT_CLASS = "OmnipayLivenessCameraView";
+    
+    private ReactApplicationContext reactContext;
+    
+    public OmnipayLivenessCameraViewManager(ReactApplicationContext reactContext) {
+        this.reactContext = reactContext;
+    }
+    
+    @NonNull
+    @Override
+    public String getName() {
+        return REACT_CLASS;
+    }
+    
+    @NonNull
+    @Override
+    protected OmnipayLivenessCameraView createViewInstance(@NonNull ThemedReactContext reactContext) {
+        return new OmnipayLivenessCameraView(reactContext);
+    }
+    
+    @Nullable
+    @Override
+    public Map<String, Object> getExportedCustomDirectEventTypeConstants() {
+        return MapBuilder.<String, Object>builder()
+                .put("onCameraReady", MapBuilder.of("registrationName", "onCameraReady"))
+                .put("onCameraError", MapBuilder.of("registrationName", "onCameraError"))
+                .build();
+    }
+    
+    @Override
+    public void onDropViewInstance(@NonNull OmnipayLivenessCameraView view) {
+        view.stopPreview();
+        super.onDropViewInstance(view);
+    }
+}