@regulaforensics/idv 3.2.23-beta

package/README.md

@@ -0,0 +1,36 @@
+# Regula IDV plugin
+IDV is a framework that unifies access to all Regula products. This plugin makes possible to use it with react-native, cordova and capacitor applications.
+
+## Android Integration
+
+
+TODO check this
+
+
+In order to use this plugin, in `android/app/build.gradle` add `kotlin-kapt` plugin and enable `dataBinding`:
+```
+plugins {
+    id "kotlin-kapt"
+}
+
+android {
+    buildFeatures {
+        dataBinding true
+    }
+}
+```
+
+## Demo applications
+In the [examples](examples/) folder you can find 3 demo applications:
+* [React-native](examples/react-native)
+* [Ionic(ionic app with cordova, angular)](examples/ionic)
+* [Capacitor(ionic app with capacitor, react)](examples/capacitor)
+
+Each demo app has its own readme file with instructions on building and installation.
+
+## Documentation
+* [Documentation](https://docs.regulaforensics.com/develop/idv-sdk/mobile)
+* [API Reference](https://dev.regulaforensics.com/npm-idv)
+
+## Support
+If you have any technical questions, feel free to [contact](mailto:support@regulaforensics.com) us or create issues [here](https://github.com/regulaforensics/npm-idv/issues).

package/RNIDV.podspec

@@ -0,0 +1,21 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+source = File.join(__dir__, 'ios')
+
+Pod::Spec.new do |s|
+  s.name         = 'RNIDV'
+  s.version      = '3.2.23-beta'
+  s.summary      = package['description']
+  s.license      = package['license']
+
+  s.authors      = { 'RegulaForensics' => 'support@regulaforensics.com' }
+  s.homepage     = 'https://regulaforensics.com'
+
+  s.source       = { http: "file:#{source}" }
+  s.ios.deployment_target = '14.0'
+  s.source_files = 'ios/**/*.{h,m}'
+  s.exclude_files = [ 'ios/CVDIDV.swift' ]
+  s.dependency 'IDVSDK', '3.1.1492'
+  s.dependency 'React'
+end

package/android/CVDIDV.kt

@@ -0,0 +1,48 @@
+package com.regula.plugin.idv
+
+import android.content.Context
+import android.util.Log
+import org.apache.cordova.CallbackContext
+import org.apache.cordova.CordovaPlugin
+import org.apache.cordova.PluginResult
+import org.json.JSONArray
+
+val eventCallbackIds = mutableMapOf<String, String>()
+
+lateinit var args: JSONArray
+lateinit var binding: CordovaPlugin
+val context: Context
+    get() = binding.cordova.context
+
+fun sendEvent(callbackId: String, data: Any? = "") {
+    val pluginResult = when (data) {
+        is Int -> PluginResult(PluginResult.Status.OK, data)
+        is Boolean -> PluginResult(PluginResult.Status.OK, data)
+        else -> PluginResult(PluginResult.Status.OK, data.toSendable() as String?)
+    }
+    pluginResult.keepCallback = true
+    binding.webView.sendPluginResult(pluginResult, eventCallbackIds[callbackId] ?: callbackId)
+}
+
+@Suppress("UNCHECKED_CAST")
+fun <T> argsNullable(index: Int): T? = if (args.get(index).toString() != "null") {
+    args.get(index) as T
+} else null
+
+class CVDIDV : CordovaPlugin() {
+    init {
+        binding = this
+    }
+
+    override fun execute(action: String, arguments: JSONArray, callbackContext: CallbackContext): Boolean {
+        args = arguments
+        val method = args.remove(0) as String
+        if (method == "setEvent") eventCallbackIds[args(0)] = callbackContext.callbackId
+        try {
+            methodCall(method) { data: Any? -> sendEvent(callbackContext.callbackId, data) }
+        } catch (error: Exception) {
+            Log.e("REGULA", "Caught exception in \"$method\" function:", error)
+        }
+        return true
+    }
+}

package/android/build.gradle

@@ -0,0 +1,41 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-kapt'
+
+android {
+    // Conditional for compatibility with AGP <4.2.
+    if (project.android.hasProperty("namespace")) {
+        namespace 'com.regula.plugin.idv'
+    }
+
+    compileSdk 36
+
+    defaultConfig {
+        minSdkVersion 24
+        targetSdk 36
+        versionCode 1
+        versionName "1.0"
+    }
+
+    buildFeatures {
+        dataBinding true
+    }
+}
+
+rootProject.allprojects {
+    repositories {
+        maven {
+            url "https://maven.regulaforensics.com/RegulaDocumentReader"
+        }
+    }
+}
+
+dependencies {
+    //noinspection GradleDynamicVersion
+    implementation 'com.facebook.react:react-native:+'
+    //noinspection GradleDependency
+    implementation('com.regula.idv:api:3.1.90') {
+        transitive = true
+    }
+}
+  

package/android/cordova.gradle

@@ -0,0 +1,20 @@
+apply plugin: 'kotlin-kapt'
+
+android {
+    buildFeatures {
+        dataBinding true
+    }
+}
+
+repositories {
+    maven {
+        url "https://maven.regulaforensics.com/RegulaDocumentReader"
+    }
+}
+
+dependencies {
+    //noinspection GradleDependency
+    implementation('com.regula.idv:api:3.1.90') {
+        transitive = true
+    }
+}

package/android/src/main/java/com/regula/plugin/idv/JSONConstructor.kt

@@ -0,0 +1,135 @@
+@file:Suppress("unused")
+
+package com.regula.plugin.idv
+
+import com.regula.idv.api.config.ApiKeyConnectionConfig
+import com.regula.idv.api.config.CredentialsConnectionConfig
+import com.regula.idv.api.config.PrepareWorkflowConfig
+import com.regula.idv.api.config.StartWorkflowConfig
+import com.regula.idv.api.config.TokenConnectionConfig
+import com.regula.idv.api.models.WorkflowResult
+import com.regula.idv.api.models.Workflow
+import com.regula.idv.api.models.WorkflowStep
+import com.regula.idv.module.BaseException
+import org.json.JSONObject
+
+fun generateCompletion(success: Any?, error: BaseException?) = mapOf(
+    "success" to success,
+    "error" to error?.message
+).toJson()
+
+// Config ------------------------------
+
+fun credentialsConnectionConfigFromJSON(it: JSONObject) = CredentialsConnectionConfig(
+    it.getString("baseUrl"),
+    it.getString("userName"),
+    it.getString("password")
+).let { self ->
+    self.httpTimeoutMs = it.getIntOrNull("httpTimeoutMs")
+    return@let self
+}
+
+fun generateCredentialsConnectionConfig(it: CredentialsConnectionConfig) = mapOf(
+    "baseUrl" to it.baseUrl,
+    "userName" to it.userName,
+    "password" to it.password,
+    "httpTimeoutMs" to it.httpTimeoutMs,
+).toJson()
+
+fun tokenConnectionConfigFromJSON(it: JSONObject) = TokenConnectionConfig(
+    it.getString("url")
+)
+
+fun generateTokenConnectionConfig(it: TokenConnectionConfig) = mapOf(
+    "url" to it.baseUrl,
+).toJson()
+
+fun apiKeyConnectionConfigFromJSON(it: JSONObject) = ApiKeyConnectionConfig(
+    it.getString("baseUrl"),
+    it.getString("apiKey"),
+    it.getIntOrNull("ttl"),
+).let { self ->
+    self.httpTimeoutMs = it.getIntOrNull("httpTimeoutMs")
+    return@let self
+}
+
+fun generateApiKeyConnectionConfig(it: ApiKeyConnectionConfig) = mapOf(
+    "baseUrl" to it.baseUrl,
+    "apiKey" to it.apiKey,
+    "ttl" to it.ttl,
+    "httpTimeoutMs" to it.httpTimeoutMs,
+).toJson()
+
+fun prepareWorkflowConfigFromJSON(it: JSONObject) = PrepareWorkflowConfig(
+    it.getString("workflowId"),
+)
+
+fun generatePrepareWorkflowConfig(it: PrepareWorkflowConfig) = mapOf(
+    "workflowId" to it.workflowId,
+).toJson()
+
+fun startWorkflowConfigFromJSON(input: JSONObject?) = input?.let { json ->
+    val builder = StartWorkflowConfig.Builder()
+
+    json.getStringOrNull("locale")?.let { builder.setLocale(it) }
+    json.getJSONObjectOrNull("metadata")?.let { builder.setMetadata(it) }
+
+    builder.build()
+}
+
+fun generateStartWorkflowConfig(input: StartWorkflowConfig?) = input?.let {
+    mapOf(
+        "locale" to it.locale,
+        "metadata" to it.metadata,
+    ).toJson()
+}
+
+// Model ------------------------------
+
+fun workflowFromJSON(input: JSONObject?) = input?.let {
+    Workflow(
+        it.getString("id"),
+        it.getString("name"),
+        it.getString("version"),
+        it.getString("description"),
+        it.getStringOrNull("defaultLocale"),
+    )
+}
+
+fun generateWorkflow(input: Workflow?) = input?.let {
+    mapOf(
+        "id" to it.id,
+        "name" to it.name,
+        "version" to it.version,
+        "description" to it.description,
+        "defaultLocale" to it.defaultLocale,
+    ).toJson()
+}
+
+fun workflowStepFromJSON(input: JSONObject?) = input?.let {
+    WorkflowStep(
+        it.getString("id"),
+        it.getString("name"),
+    )
+}
+
+fun generateWorkflowStep(input: WorkflowStep?) = input?.let {
+    mapOf(
+        "id" to it.id,
+        "name" to it.name,
+    ).toJson()
+}
+
+fun workflowResultFromJSON(input: JSONObject?): WorkflowResult? = input?.let {
+    WorkflowResult(
+        it.getString("sessionId"),
+        workflowStepFromJSON(it.getJSONObjectOrNull("finalStep"))!!
+    )
+}
+
+fun generateWorkflowResult(input: WorkflowResult?) = input?.let {
+    mapOf(
+        "sessionId" to it.sessionId,
+        "finalStep" to generateWorkflowStep(it.finalStep),
+    ).toJson()
+}

package/android/src/main/java/com/regula/plugin/idv/Main.kt

@@ -0,0 +1,124 @@
+package com.regula.plugin.idv
+
+import com.regula.idv.api.IdvSdk.Companion.instance
+import com.regula.idv.api.config.InitConfig
+import com.regula.idv.api.enums.SessionRestoreMode
+import com.regula.idv.api.listeners.IdvSdkListener
+import com.regula.idv.module.BaseException
+import com.regula.idv.module.IModule
+import org.json.JSONObject
+
+const val didStartSessionEvent = "didStartSessionEvent"
+const val didEndSessionEvent = "didEndSessionEvent"
+const val didStartRestoreSessionEvent = "didStartRestoreSessionEvent"
+const val didContinueRemoteSessionEvent = "didContinueRemoteSessionEvent"
+
+val allModules = listOf(
+    "com.regula.idv.docreader.DocReaderModule",
+    "com.regula.idv.face.FaceModule",
+)
+
+fun methodCall(method: String, callback: Callback): Any = when (method) {
+    "setSessionRestoreMode" -> instance().sessionRestoreMode = SessionRestoreMode.entries[args(0)]
+    "getCurrentSessionId" -> callback(instance().currentSessionId())
+    "initialize" -> initialize(callback)
+    "deinitialize" -> deinitialize(callback)
+    "configureWithToken" -> configureWithToken(callback, args(0))
+    "configureWithCredentials" -> configureWithCredentials(callback, args(0))
+    "configureWithApiKey" -> configureWithApiKey(callback, args(0))
+    "prepareWorkflow" -> prepareWorkflow(callback, args(0))
+    "startWorkflow" -> startWorkflow(callback, argsNullable(0))
+    "getWorkflows" -> getWorkflows(callback)
+    else -> Unit
+}
+
+fun initialize(callback: Callback) {
+    val includedModules = mutableListOf<IModule>()
+    for (className in allModules) try {
+        includedModules.add(Class.forName(className).getDeclaredConstructor().newInstance() as IModule)
+    } catch (_: Exception) {
+    }
+
+    instance().initialize(context, InitConfig(includedModules)) {
+        instance().listener = listener
+        generateCompletion(
+            it.isSuccess,
+            it.exceptionOrNull() as BaseException?
+        ).send(callback)
+    }
+}
+
+fun deinitialize(callback: Callback) {
+    instance().deinitialize(context) {
+        generateCompletion(
+            it.isSuccess,
+            it.exceptionOrNull() as BaseException?
+        ).send(callback)
+    }
+}
+
+
+fun configureWithToken(callback: Callback, data: JSONObject) = instance().configure(
+    context,
+    tokenConnectionConfigFromJSON(data)
+) {
+    generateCompletion(
+        it.getOrNull(),
+        it.exceptionOrNull() as BaseException?
+    ).send(callback)
+}
+
+fun configureWithCredentials(callback: Callback, data: JSONObject) = instance().configure(
+    context,
+    credentialsConnectionConfigFromJSON(data)
+) {
+    generateCompletion(
+        it.isSuccess,
+        it.exceptionOrNull() as BaseException?
+    ).send(callback)
+}
+
+fun configureWithApiKey(callback: Callback, data: JSONObject) = instance().configure(
+    context,
+    apiKeyConnectionConfigFromJSON(data)
+) {
+    generateCompletion(
+        it.isSuccess,
+        it.exceptionOrNull() as BaseException?
+    ).send(callback)
+}
+
+fun prepareWorkflow(callback: Callback, data: JSONObject) = instance().prepareWorkflow(
+    context,
+    prepareWorkflowConfigFromJSON(data)
+) {
+    generateCompletion(
+        generateWorkflow(it.getOrNull()),
+        it.exceptionOrNull() as BaseException?
+    ).send(callback)
+}
+
+fun startWorkflow(callback: Callback, data: JSONObject?) = instance().startWorkflow(
+    context,
+    startWorkflowConfigFromJSON(data)
+) {
+    generateCompletion(
+        generateWorkflowResult(it.getOrNull()),
+        it.exceptionOrNull() as BaseException?
+    ).send(callback)
+}
+
+fun getWorkflows(callback: Callback) = instance().getWorkflows {
+    generateCompletion(
+        it.getOrNull().toJsonNullable(::generateWorkflow),
+        it.exceptionOrNull() as BaseException?
+    ).send(callback)
+}
+
+// Weak references
+var listener = object : IdvSdkListener {
+    override fun didStartSession() = sendEvent(didStartSessionEvent)
+    override fun didEndSession() = sendEvent(didEndSessionEvent)
+    override fun didStartRestoreSession() = sendEvent(didStartRestoreSessionEvent)
+    override fun didContinueRemoteSession() = sendEvent(didContinueRemoteSessionEvent)
+}

package/android/src/main/java/com/regula/plugin/idv/RNIDVModule.kt

@@ -0,0 +1,71 @@
+@file:Suppress("unused", "UNUSED_PARAMETER")
+
+package com.regula.plugin.idv
+
+import android.content.Context
+import android.util.Log
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.ReadableArray
+import com.facebook.react.modules.core.DeviceEventManagerModule
+import com.facebook.react.uimanager.ViewManager
+import org.json.JSONArray
+import org.json.JSONObject
+
+var listenerCount = 0
+
+lateinit var args: JSONArray
+lateinit var binding: ReactContext
+val context: Context
+    get() = binding.applicationContext
+
+fun sendEvent(event: String, data: Any? = "") {
+    if (listenerCount <= 0) return
+    val result = if (data is JSONObject || data is JSONArray) data.toString() else data.toString() + ""
+    binding.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java).emit(event, result)
+}
+
+@Suppress("UNCHECKED_CAST")
+fun <T> argsNullable(index: Int): T? {
+    val value = args[index]
+    if (value is Double && value % 1 == 0.0) return value.toInt() as T
+    if (value.toString() == "null") return null
+    return value as T
+}
+
+class RNIDVPackage : ReactPackage {
+    override fun createNativeModules(reactContext: ReactApplicationContext) = listOf(RNIDVModule(reactContext))
+    override fun createViewManagers(reactContext: ReactApplicationContext) = emptyList<ViewManager<*, *>>()
+}
+
+class RNIDVModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaModule(reactContext) {
+    init {
+        binding = reactContext
+    }
+
+    @ReactMethod
+    fun addListener(eventName: String) {
+        listenerCount += 1
+    }
+
+    @ReactMethod
+    fun removeListeners(count: Int) {
+        listenerCount -= count
+    }
+
+    @ReactMethod
+    fun exec(method: String, arguments: ReadableArray, promise: Promise) {
+        args = JSONArray(arguments.toArrayList())
+        try {
+            methodCall(method) { data -> promise.resolve(data.toSendable()) }
+        } catch (error: Exception) {
+            Log.e("REGULA", "Caught exception in \"$method\" function:", error)
+        }
+    }
+
+    override fun getName() = "RNIDV"
+}

package/android/src/main/java/com/regula/plugin/idv/Utils.kt

@@ -0,0 +1,60 @@
+package com.regula.plugin.idv
+
+import org.json.JSONArray
+import org.json.JSONObject
+
+inline fun <reified T> args(index: Int) = argsNullable<T>(index)!!
+typealias Callback = (Any?) -> Unit
+
+fun List<*>.toJson(): JSONArray {
+    val result = JSONArray()
+    for (i in indices)
+        when (val v = this[i]) {
+            null -> result.put(null)
+            is Map<*, *> -> result.put(v.toJson())
+            is List<*> -> result.put(v.toJson())
+            else -> result.put(v)
+        }
+    return result
+}
+
+fun Map<*, *>.toJson(): JSONObject {
+    val result = JSONObject()
+    for ((k, v) in this) {
+        when (v) {
+            null -> result.put(k as String, null)
+            is Map<*, *> -> result.put(k as String, v.toJson())
+            is List<*> -> result.put(k as String, v.toJson())
+            else -> result.put(k as String, v)
+        }
+    }
+    return result
+}
+
+fun Any?.toSendable(): Any? = this?.let {
+    if (it is JSONObject || it is JSONArray) it.toString()
+    else it
+}
+
+fun JSONObject.send(callback: Callback) = callback(this)
+
+fun <T> List<T>?.toJsonNullable(toJson: (T?) -> Any?) = this?.let {
+    val result = JSONArray()
+    for (item in it) result.put(toJson(item))
+    result
+}
+
+fun JSONObject.getJSONObjectOrNull(name: String): JSONObject? {
+    if (has(name) && get(name).toString() != "null") return getJSONObject(name)
+    return null
+}
+
+fun JSONObject.getStringOrNull(name: String): String? {
+    if (has(name) && get(name).toString() != "null") return getString(name)
+    return null
+}
+
+fun JSONObject.getIntOrNull(name: String): Int? {
+    if (has(name) && get(name).toString() != "null") return getInt(name)
+    return null
+}

package/examples/capacitor/README.md

@@ -0,0 +1,15 @@
+# Regula IDV Capacitor demo application
+
+## How to build demo application
+1. Download or the clone current repository using the command `git clone https://github.com/regulaforensics/npm-idv.git`.
+2. Put `regula.license` file at `public/assets/` (you can get a trial license [here](https://client.regulaforensics.com)).
+3. Put `db.dat` file at `public/assets/` (you can get a trial database [here](https://client.regulaforensics.com/customer/databases))
+4. Execute `npm run setup` within this directory.
+5. In `src/main.tsx` choose prefered login configuration(`loginType` variable) and provide your login data according to it: username and password for `credentials`, tokenUrl for `token`, apiKey for `apiKey`.
+6. Run the app: 
+  * IOS: `npm run ios`.
+  * Android: `npm run android`.
+7. After initialization choose **General KYC - AP** from workflows list and click **Start Workflow** button.
+8. Complete workflow and get your session id.
+
+**Note**: `npm run ios`/`npm run android` is just one way of running the app. You can also pass `-o` or `--open` argument to the command, and this will open Xcode/Android Studio, then run the app directly from the IDE. Overall, this is a more consistent way, so if you're having troubles running the app from terminal, try running it from the IDE.

package/examples/capacitor/android/app/build.gradle

@@ -0,0 +1,50 @@
+apply plugin: 'com.android.application'
+
+android {
+    namespace "com.regula.example.idv.capacitor"
+    compileSdkVersion rootProject.ext.compileSdkVersion
+    defaultConfig {
+        applicationId "com.regula.example.idv.capacitor"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+        aaptOptions {
+             // Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.
+             // Default: https://android.googlesource.com/platform/frameworks/base/+/282e181b58cf72b6ca770dc7ca5f91f135444502/tools/aapt/AaptAssets.cpp#61
+            ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:!CVS:!thumbs.db:!picasa.ini:!*~'
+        }
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+}
+
+repositories {
+    flatDir{
+        dirs '../capacitor-cordova-android-plugins/src/main/libs', 'libs'
+    }
+}
+
+dependencies {
+    implementation fileTree(include: ['*.jar'], dir: 'libs')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "androidx.coordinatorlayout:coordinatorlayout:$androidxCoordinatorLayoutVersion"
+    implementation "androidx.core:core-splashscreen:$coreSplashScreenVersion"
+    implementation project(':capacitor-android')
+    implementation project(':capacitor-cordova-android-plugins')
+}
+
+apply from: 'capacitor.build.gradle'
+
+try {
+    def servicesJSON = file('google-services.json')
+    if (servicesJSON.text) {
+        apply plugin: 'com.google.gms.google-services'
+    }
+} catch(Exception e) {
+    logger.info("google-services.json not found, google-services plugin not applied. Push Notifications won't work")
+}

package/examples/capacitor/android/app/capacitor.build.gradle

@@ -0,0 +1,22 @@
+// DO NOT EDIT THIS FILE! IT IS GENERATED EACH TIME "capacitor update" IS RUN
+
+android {
+  compileOptions {
+      sourceCompatibility JavaVersion.VERSION_21
+      targetCompatibility JavaVersion.VERSION_21
+  }
+}
+
+apply from: "../capacitor-cordova-android-plugins/cordova.variables.gradle"
+dependencies {
+    implementation project(':capacitor-app')
+    implementation project(':capacitor-haptics')
+    implementation project(':capacitor-keyboard')
+    implementation project(':capacitor-status-bar')
+    implementation "androidx.core:core:1.6.+"
+    implementation "androidx.webkit:webkit:1.4.0"
+}
+
+if (hasProperty('postBuildExtras')) {
+  postBuildExtras()
+}

package/examples/capacitor/android/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile