@socure-inc/docv-react-native 4.3.3 → 5.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Predictive DocV SDK v4 React Native
 
-The Predictive Document Verification (DocV) SDK v4 for React Native is a React Native wrapper that allows you to use the DocV SDK for Android and iOS in your React Native application. 
+The Predictive Document Verification (DocV) SDK v5 for React Native is a React Native wrapper that allows you to use the DocV SDK for Android and iOS in your React Native application. 
 
 >Note: Document verification services will be disabled for older SDK versions soon. All SDK integrations must be updated to version **3.1.0 or later** to meet compliance requirements.
 
@@ -20,7 +20,7 @@ Before getting started, check that your development environment meets the follow
 **Android**
 
 - Android SDK Version 22 (OS Version 5.1) and later
-- Android SDK is compiled with `compileSdkVersion 33` and Java 11
+- Android SDK is compiled with `compileSdkVersion 34` and Java 17
 
 ## Getting started
 
@@ -143,7 +143,7 @@ Using the command line, go to your root project folder and enter the following c
   
 ### Configure your Android app
 
-For the Android app, add your project dependencies by going to the module level `build.gradle` file and making sure the `minSdkVersion` is set to at least 22 and the `compileSdkVersion` is set to at least 33. 
+For the Android app, add your project dependencies by going to the module level `build.gradle` file and making sure the `minSdkVersion` is set to at least 22 and the `compileSdkVersion` is set to at least 34. 
 
 ```kotlin {5,6}
 buildscript {
@@ -151,7 +151,7 @@ buildscript {
             ext {
                  ....
                 minSdkVersion = 22 
-                compileSdkVersion = 33
+                compileSdkVersion = 34
                 .....
             }
 }
@@ -173,6 +173,10 @@ Ensure that your app manifest has been set up properly to request the following
 <uses-permission android:name="android.permission.CAMERA" />
 <uses-permission android:name="android.permission.INTERNET" />
 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+
+<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
+<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />
+<uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />
 ```
 
 ## Run the app

package/android/build.gradle

@@ -135,7 +135,17 @@ dependencies {
     //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation "com.socure.android:docv-capture:4.3.2"
+  implementation "com.socure.android:docv-capture:5.0.6"
+
+  def retrofit_version = "2.9.0"
+  implementation "com.squareup.retrofit2:retrofit:$retrofit_version"
+  implementation "com.squareup.retrofit2:converter-gson:$retrofit_version"
+
+  def lifecycle_version = "2.5.1"
+  implementation "androidx.lifecycle:lifecycle-runtime-ktx:$lifecycle_version"
+
+  def okhttp_version = "4.9.3"
+  implementation "com.squareup.okhttp3:logging-interceptor:$okhttp_version"
 // From node_modules
 }
 

package/android/gradle.properties

@@ -1,4 +1,4 @@
-SocureDocVReactNative_kotlinVersion=1.7.0
+SocureDocVReactNative_kotlinVersion=1.9.0
 SocureDocVReactNative_minSdkVersion=22
 SocureDocVReactNative_targetSdkVersion=32
 SocureDocVReactNative_compileSdkVersion=32

package/android/src/main/java/com/socure/docv/reactnative/Api.kt

@@ -0,0 +1,66 @@
+package com.socure.docv.reactnative
+
+import java.util.concurrent.TimeUnit
+import okhttp3.OkHttpClient
+import okhttp3.logging.HttpLoggingInterceptor
+import retrofit2.Retrofit
+import retrofit2.converter.gson.GsonConverterFactory
+import retrofit2.http.Body
+import retrofit2.http.HeaderMap
+import retrofit2.http.POST
+
+private const val BASE_URL = "https://service.socure.com/"
+
+fun transaction(): TransactionService {
+    return Retrofit.Builder()
+        .baseUrl(BASE_URL)
+        .addConverterFactory(GsonConverterFactory.create())
+        .client(OkHttpBuilder().getBuilder())
+        .build().create(TransactionService::class.java)
+}
+
+interface TransactionService {
+    @POST("api/5.0/documents/request")
+    suspend fun createTransaction(
+        @HeaderMap headers: Map<String, String>,
+        @Body request: TransactionRequest
+    ): TransactionResponse
+}
+
+data class TransactionResponse(
+    val data: Data
+) {
+
+    data class Data(
+        val eventId: String,
+        val authToken: String,
+        val docVTransactionToken: String,
+        val qrcode: String,
+        val url: String
+    )
+}
+
+data class TransactionRequest(
+    val config: TransactionConfig,
+    val previousReferenceId: String? = null
+) {
+
+    data class TransactionConfig(
+        val useCaseKey: String,
+        val language: String = "en"
+    )
+}
+
+class OkHttpBuilder {
+    fun getBuilder(): OkHttpClient {
+        with(OkHttpClient.Builder()) {
+            readTimeout(120L, TimeUnit.SECONDS)
+            connectTimeout(120L, TimeUnit.SECONDS)
+            writeTimeout(120L, TimeUnit.SECONDS)
+            val loggingInterceptor = HttpLoggingInterceptor()
+            loggingInterceptor.level = HttpLoggingInterceptor.Level.HEADERS
+            addInterceptor(loggingInterceptor)
+            return build()
+        }
+    }
+}

package/android/src/main/java/com/socure/docv/reactnative/SocureDocVReactNativeModule.kt

@@ -3,26 +3,23 @@ package com.socure.docv.reactnative
 import android.app.Activity
 import android.content.Intent
 import android.util.Log
-import android.util.Base64
+import androidx.appcompat.app.AppCompatActivity
 import com.facebook.react.bridge.*
 import com.socure.docv.capturesdk.api.Platform.REACT_NATIVE
-import com.socure.docv.capturesdk.api.SocureDocVHelper.getIntent
-import com.socure.docv.capturesdk.api.SocureDocVHelper.getResult
-import com.socure.docv.capturesdk.api.SocureDocVHelper.setSource
-import com.socure.docv.capturesdk.api.SocureDocVHelper.initSdk
+import com.socure.docv.capturesdk.api.SocureDocVContext
 import com.socure.docv.capturesdk.api.SocureExperimentalApi
-import com.socure.docv.capturesdk.common.utils.ResultListener
-import com.socure.docv.capturesdk.common.utils.ScanError
-import com.socure.docv.capturesdk.common.utils.ScannedData
-import org.json.JSONException
-import org.json.JSONObject
+import com.socure.docv.capturesdk.api.SocureSdk
+import com.socure.docv.capturesdk.api.SocureSdk.getResult
+import com.socure.docv.capturesdk.api.SocureSdk.initSdk
+import com.socure.docv.capturesdk.common.utils.SocureDocVFailure
+import com.socure.docv.capturesdk.common.utils.SocureDocVSuccess
+import com.socure.docv.capturesdk.common.utils.SocureResult
 
 class SocureDocVReactNativeModule(reactContext: ReactApplicationContext) :
     ReactContextBaseJavaModule(reactContext), ActivityEventListener {
 
     private val TAG = "SDLT_RN"
-
-    private val SOCURE_SDK_REQUEST_CODE = 753    
+    private val SOCURE_SDK_REQUEST_CODE = 753
     private var onSuccessCallback: Callback? = null
     private var onErrorCallback: Callback? = null
 
@@ -32,35 +29,49 @@ class SocureDocVReactNativeModule(reactContext: ReactApplicationContext) :
 
     @OptIn(SocureExperimentalApi::class)
     @ReactMethod
-    fun initDocVSdk(socureApiKey: String, flow: String?) {
+    fun initDocVSdk(verificationToken: String, publicKey: String, useSocureGov: Boolean) {
         Log.d(TAG, "initDocVSdk - init native sdk")
-
-        initSdk(currentActivity!!, socureApiKey, flow)
+        initSdk(
+            SocureDocVContext(verificationToken, publicKey, useSocureGov, null, null)
+        )
     }
 
     @OptIn(SocureExperimentalApi::class)
     @ReactMethod
-    fun launchDocVSdk(onSuccess: Callback,onError: Callback) {
+    fun launchDocVSdk(onSuccess: Callback, onError: Callback) {
         Log.d(TAG, "launchDocVSdk - launch using experimental api")
-
         setupLaunch(onSuccess, onError)
-        currentActivity?.startActivityForResult(getIntent(currentActivity!!), SOCURE_SDK_REQUEST_CODE)
+        currentActivity?.run {
+            startActivityForResult(SocureSdk.getIntent(this), SOCURE_SDK_REQUEST_CODE)
+        }
     }
 
     @ReactMethod
     fun launchSocureDocV(
-        socureApiKey: String,
-        flow: String?,
+        verificationToken: String,
+        publicKey: String,
+        useSocureGov: Boolean,
         onSuccess: Callback,
         onError: Callback
     ) {
         Log.d(TAG, "launchSocureDocV - launch Socure SDK")
-
         setupLaunch(onSuccess, onError)
-        currentActivity?.startActivityForResult(
-            getIntent(currentActivity!!, socureApiKey, flow),
-            SOCURE_SDK_REQUEST_CODE
-        )
+
+        currentActivity?.run {
+            startActivityForResult(
+                SocureSdk.getIntent(
+                    this,
+                    SocureDocVContext(
+                        verificationToken,
+                        publicKey,
+                        useSocureGov,
+                        null,
+                        null
+                    )
+                ),
+                SOCURE_SDK_REQUEST_CODE
+            )
+        }
     }
 
     private fun setupLaunch(onSuccess: Callback, onError: Callback) {
@@ -68,10 +79,8 @@ class SocureDocVReactNativeModule(reactContext: ReactApplicationContext) :
         this.onErrorCallback = onError
 
         Log.d(TAG, "launchSocureDocV - registering activity event listener")
-
         reactApplicationContext.addActivityEventListener(this)
-
-        setSource(REACT_NATIVE)
+        SocureSdk.setSource(REACT_NATIVE)
     }
 
     override fun onActivityResult(
@@ -81,88 +90,36 @@ class SocureDocVReactNativeModule(reactContext: ReactApplicationContext) :
         data: Intent?
     ) {
         if (requestCode == SOCURE_SDK_REQUEST_CODE) {
-            Log.d(TAG, "onActivityResult - requestCode matched, removing activity event listener")
-            
             data?.let {
-                getResult(data, object : ResultListener {
-                    override fun onSuccess(scannedData: ScannedData) {  
-                        onSuccessCallback?.invoke(convertResultToReadbleMap(scannedData))
+                getResult(it) { result ->
+                    Log.d(TAG, "onResult called: $result")
+                    if (result is SocureDocVSuccess) {
+                        onSuccessCallback?.invoke(convertResultToReadbleMap(result))
+                    } else {
+                        onErrorCallback?.invoke(convertResultToReadbleMap(result))
                     }
-
-                    override fun onError(scanError: ScanError) {
-                        onErrorCallback?.invoke(convertErrorToReadableMap(scanError))
-                    }
-                })
+                }
             }
-
+            Log.d(TAG, "onActivityResult - requestCode matched, removing activity event listener")
             reactApplicationContext.removeActivityEventListener(this)
         } else {
-            Log.d(TAG, "onActivityResult - requestCode does not match: $requestCode, not removing activity event listener")
+            Log.d(
+                TAG,
+                "onActivityResult - requestCode does not match: $requestCode, not removing activity event listener"
+            )
         }
     }
 
     override fun onNewIntent(intent: Intent?) {}
 
-    private fun convertResultToReadbleMap(scannedData: ScannedData): ReadableMap {
+    private fun convertResultToReadbleMap(result: SocureResult): ReadableMap {
         val docVResponse: WritableMap = Arguments.createMap()
-        docVResponse.putString("docUUID", scannedData.docUUID)
-        docVResponse.putString("sessionId", scannedData.sessionId)
-
-        val captureData: WritableMap = Arguments.createMap()
-        scannedData.captureData?.forEach {
-            captureData.putString(it.key, it.value)
-        }
-        docVResponse.putMap("captureData", captureData)
-
-        val capturedImages: WritableMap = Arguments.createMap()
-        scannedData.capturedImages?.forEach {
-            capturedImages.putString(it.key, Base64.encodeToString(it.value, Base64.DEFAULT) ?: "")
-        }
-        docVResponse.putMap("capturedImages", capturedImages)
-
-        scannedData.extractedData?.let { jsonString ->
-            try {
-                docVResponse.putMap("extractedData", convertStringToMap(JSONObject(jsonString)))
-            } catch (ex: JSONException) {
-                docVResponse.putString("extractedData", jsonString)
-            }
+        if (result is SocureDocVSuccess) {
+            docVResponse.putString("deviceSessionToken", result.deviceSessionToken)
+        } else {
+            docVResponse.putString("deviceSessionToken", result.deviceSessionToken)
+            docVResponse.putString("error", (result as SocureDocVFailure).error.name)
         }
-
         return docVResponse
     }
-
-    private fun convertErrorToReadableMap(scanError: ScanError): ReadableMap {
-        val docVErrResponse: WritableMap = Arguments.createMap()
-        docVErrResponse.putString("statusCode", scanError.statusCode.toString())
-        docVErrResponse.putString("errorMessage", scanError.errorMessage)
-        scanError.sessionId?.let {
-            docVErrResponse.putString("sessionId", it)
-        }
-
-        val capturedImages: WritableMap = Arguments.createMap()
-        scanError.capturedImages?.forEach {
-            capturedImages.putString(it.key, Base64.encodeToString(it.value, Base64.DEFAULT) ?: "")
-        }
-        docVErrResponse.putMap("capturedImages", capturedImages)
-
-        return docVErrResponse
-    }
-
-    private fun convertStringToMap(jsonObject: JSONObject): ReadableMap {
-        val responseMap: WritableMap = Arguments.createMap()
-        val jsonIterator = jsonObject.keys()
-        while (jsonIterator.hasNext()) {
-            val key: String = jsonIterator.next()
-            when (val value = jsonObject[key]) {
-                is JSONObject -> {
-                    responseMap.putMap(key, convertStringToMap(value))
-                }
-                is String -> {
-                    responseMap.putString(key, value)
-                }
-            }
-        }
-        return responseMap
-    }
-
 }

package/dist/index.d.ts

@@ -1,41 +1 @@
-export declare function launchSocureDocV(socureApiKey: string, flow: string | null | undefined, onSuccess: Function, onError: Function): any;
-export declare function initDocVSdk(socureApiKey: string, flow: string | null | undefined): void;
-export declare function launchDocVSdk(onSuccess: Function, onError: Function): any;
-export interface ScannedData {
-    docUUID: string;
-    sessionId: string;
-    extractedData?: ExtractedInfo;
-    captureData: {
-        [doc_type: string]: [capture_type: string];
-    };
-    capturedImages: {
-        [doc_type: string]: [image_data: string];
-    };
-}
-export interface ScanError {
-    statusCode: string;
-    errorMessage: string;
-    sessionId?: string;
-    capturedImages?: {
-        [doc_type: string]: [image_data: string];
-    };
-}
-export interface ExtractedInfo {
-    type?: string;
-    expirationDate?: string;
-    dob?: string;
-    firstName?: string;
-    fullName?: string;
-    documentNumber?: string;
-    address?: string;
-    surName?: string;
-    issueDate?: string;
-    parsedAddress?: AddressInfo;
-}
-export interface AddressInfo {
-    state?: String;
-    postalCode?: String;
-    city?: String;
-    country?: String;
-    physicalAddress?: String;
-}
+export declare function launchSocureDocV(docVTransactionToken: string, publicKey: string, useSocureGov: boolean, onSuccess: Function, onError: Function): any;

package/ios/SocureDocVReactNative.m

@@ -2,12 +2,9 @@
 
 @interface RCT_EXTERN_MODULE(SocureDocVReactNative, NSObject)
 
-RCT_EXTERN_METHOD(launchSocureDocV:(NSString)socureApiKey flow:(NSString)flow
+RCT_EXTERN_METHOD(launchSocureDocV:(NSString)docVTransactionToken socureApiKey:(NSString)socureApiKey useSocureGov:(BOOL)useSocureGov
                   onSuccess:(RCTResponseSenderBlock)success
                   onError:(RCTResponseSenderBlock)error)
-RCT_EXTERN_METHOD(initDocVSdk:(NSString)socureApiKey flow:(NSString)flow)
-RCT_EXTERN_METHOD(launchDocVSdk:(RCTResponseSenderBlock)success
-                  onError:(RCTResponseSenderBlock)error)
 
 + (BOOL)requiresMainQueueSetup
 {

package/ios/SocureDocVReactNative.swift

@@ -2,51 +2,25 @@ import SocureDocV
 
 @objc(SocureDocVReactNative)
 class SocureDocVReactNative: NSObject {
-    lazy var objDocVHelper = SocureDocVHelper()
     
-    @objc(launchSocureDocV:flow:onSuccess:onError:)
-    func launchSocureDocV(socureApiKey: String, flow: String?, onSuccess: @escaping RCTResponseSenderBlock,onError: @escaping RCTResponseSenderBlock) -> Void {
-        var flowConfig: [String: Any]?
-        do {
-            flowConfig = try flow?.convertToDictionary()
-        } catch {
-            let errorDict = ["errorMessage": "Invalid config data", "statusCode": "7109"]
-            onError([errorDict])
-            return
-        }
-        objDocVHelper.setSource(.reactNative)
-        DispatchQueue.main.async {
-            let root = RCTPresentedViewController()
-            self.objDocVHelper.launch(socureApiKey, presentingViewController: root!, config: flowConfig, completionBlock: { result in
-                switch result {
-                case .success(let scan):
-                    onSuccess([scan.dictionary])
-                    break
-                case .failure(let error):
-                    onError([error.dictionary])
-                    break
-                }
-            })
-        }
-    }
-    
-    @objc(initDocVSdk:flow:)
-    func initDocVSdk(socureApiKey: String, flow: String?) -> Void {
-        SocureDocVSdk.initSdk(publicKey: socureApiKey, config: try? flow?.convertToDictionary())
-    }
-    
-    @objc(launchDocVSdk:onError:)
-    func launchDocVSdk(onSuccess: @escaping RCTResponseSenderBlock,onError: @escaping RCTResponseSenderBlock) -> Void {
-        SocureDocVSdk.setSource(.reactNative)
+    @objc(launchSocureDocV:socureApiKey:useSocureGov:onSuccess:onError:)
+    func launchSocureDocV(docVTransactionToken: String, socureApiKey: String, useSocureGov: Bool, onSuccess: @escaping RCTResponseSenderBlock, onError: @escaping RCTResponseSenderBlock) -> Void {
+
         DispatchQueue.main.async {
             let root = RCTPresentedViewController()
-            SocureDocVSdk.launch(presentingViewController: root!, completionBlock: { result in
+            let options = SocureDocVOptions(
+                publicKey: socureApiKey,
+                docVTransactionToken: docVTransactionToken,
+                presentingViewController: root!,
+                useSocureGov: useSocureGov
+            )
+            SocureDocVSDK.launch(options, completionBlock: { result in
                 switch result {
-                case .success(let scan):
-                    onSuccess([scan.dictionary])
+                case .success(let success):
+                    onSuccess([["deviceSessionToken": success.deviceSessionToken]])
                     break
-                case .failure(let error):
-                    onError([error.dictionary])
+                case .failure(let failure):
+                    onError([["deviceSessionToken": failure.deviceSessionToken, "error": String(describing: failure.error)]])
                     break
                 }
             })
@@ -69,4 +43,4 @@ extension String {
         }
         return nil
     }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socure-inc/docv-react-native",
-  "version": "4.3.3",
+  "version": "5.0.0",
   "description": "The Predictive Document Verification (DocV) SDK React Native bridge allows you to use the DocV SDK v4 for Android and iOS in your React Native application.",
   "main": "src/index",
   "types": "dist/index.d.ts",

package/socure-docv-react-native.podspec

@@ -18,6 +18,7 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React"
-  s.dependency "SocureDocV", "4.3.1"
+  s.dependency "SocureDocV"
+  s.dependency "SocureDeviceRisk"
 
 end

package/src/index.tsx

@@ -13,90 +13,6 @@ const SocureDocVReactNative = NativeModules.SocureDocVReactNative ? NativeModule
   }
 );
 
-export function launchSocureDocV(socureApiKey: string, flow: string | null | undefined, onSuccess: Function, onError: Function) {
-  if (typeof socureApiKey !== 'string') {
-    onConfigError("7011", "Invalid key", onError)
-  } else if (flow && typeof flow !== 'string') {
-    onConfigError("7109", "Invalid config data", onError)
-  } else {
-    return SocureDocVReactNative.launchSocureDocV(socureApiKey, flow, onSuccess, onError);
-  }
-}
-
-{/*
-  This API is experimental. 
-  Please contact Socure before starting to use this.
-*/}
-export function initDocVSdk(socureApiKey: string, flow: string | null | undefined) {
-  if (socureApiKey && typeof socureApiKey === "string") {
-    if ((!flow && flow !== "") || (typeof flow === "string" && isValidJSON(flow))) {
-      SocureDocVReactNative.initDocVSdk(socureApiKey, flow);
-    } else {
-      onConfigError("7109", "Invalid config data")
-    }
-  } else {
-    onConfigError("7011", "Invalid key")
-  }
-}
-
-{/*
-  This API is experimental. 
-  Please contact Socure before starting to use this.
-*/}
-export function launchDocVSdk(onSuccess: Function, onError: Function) {
-  return SocureDocVReactNative.launchDocVSdk(onSuccess, onError);
-}
-
-function isValidJSON(jsonString: string) {
-  try {
-    JSON.parse(jsonString);
-    return true;
-  } catch (e) {
-    return false;
-  }
-};
-
-function onConfigError(errorCode: string, errorMessage: string, onError?: Function) {
-  let error = { statusCode: errorCode, errorMessage: errorMessage } as ScanError
-  if (onError && typeof onError == 'function') {
-    onError(error)
-  } else {
-    throw Promise.reject(error)
-  }
+export function launchSocureDocV(docVTransactionToken: string, publicKey: string, useSocureGov: boolean, onSuccess: Function, onError: Function) {
+  return SocureDocVReactNative.launchSocureDocV(docVTransactionToken, publicKey, useSocureGov, onSuccess, onError);
 }
-
-export interface ScannedData {
-  docUUID: string
-  sessionId: string
-  extractedData?: ExtractedInfo
-  captureData: { [doc_type: string]: [capture_type: string] }
-  capturedImages: { [doc_type: string]: [image_data: string] }
-}
-
-export interface ScanError {
-  statusCode: string
-  errorMessage: string
-  sessionId?: string
-  capturedImages?: { [doc_type: string]: [image_data: string] }
-}
-
-export interface ExtractedInfo {
-  type?: string
-  expirationDate?: string
-  dob?: string
-  firstName?: string
-  fullName?: string
-  documentNumber?: string
-  address?: string
-  surName?: string
-  issueDate?: string
-  parsedAddress?: AddressInfo
-}
-
-export interface AddressInfo {
-  state?: String
-  postalCode?: String
-  city?: String
-  country?: String
-  physicalAddress?: String
-}