@regulaforensics/idv 3.2.1-nightly

package/examples/react_native/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "idv",
+  "main": "./index.tsx",
+  "scripts": {
+    "setup": "scripts/setup.sh",
+    "ios": "scripts/ios.sh",
+    "android": "scripts/android.sh",
+    "start": "expo start"
+  },
+  "dependencies": {
+    "@regulaforensics/idv": "3.2.1-nightly",
+    "@regulaforensics/document-reader": "8.4.2-nightly",
+    "@regulaforensics/face-sdk": "8.1.1-nightly",
+    "@regulaforensics/document-reader-core-fullauthrfid": "8.4.7-nightly",
+    "@regulaforensics/face-core-basic": "8.1.1-nightly",
+    "@regulaforensics/idv-module-document-reader": "file:../ftp_5",
+    "@regulaforensics/idv-module-face": "file:../ftp_6",
+    "react-native": "^0.81.4",
+    "react-native-webview": "^13.16.0",
+    "@react-native/metro-config": "^0.81.1",
+    "react": "^19.1.1",
+    "@types/react": "^19.1.13",
+    "expo": "^54.0.7",
+    "expo-dev-client": "^6.0.12",
+    "expo-custom-assets": "^1.5.0",
+    "expo-build-properties": "^1.0.8",
+    "typescript": "5.9.2"
+  }
+}

package/examples/react_native/scripts/android.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+adb reverse tcp:8081 tcp:8081 >/dev/null || :
+if [[ $npm_config_o || $npm_config_open ]]; then
+    studio android || open -a 'Android Studio' android
+    # check if metro is already running
+    if ! pgrep -f "expo start" >/dev/null; then
+        watchman shutdown-server # fix potential errors
+        npm start
+    fi
+else
+    expo run:android --device
+fi

package/examples/react_native/scripts/ios.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    open ios/IDV.xcworkspace
+    # check if metro is already running
+    if ! pgrep -f "expo start" > /dev/null; then
+        watchman shutdown-server # fix potential errors
+        npm start
+    fi
+else
+    npx expo run:ios  --device
+fi

package/examples/react_native/scripts/setup.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -e
+
+npm install
+expo prebuild
+
+mkdir -p android/app/src/main/assets/Regula
+mv android/app/src/main/res/raw/regula.license android/app/src/main/assets/Regula/
+mv android/app/src/main/res/raw/db.dat android/app/src/main/assets/Regula/
+
+sed -i '' '$a\
+android { buildFeatures { dataBinding true } }' android/app/build.gradle

package/examples/react_native/src/main.css

@@ -0,0 +1,148 @@
+html,
+body {
+    margin: 0;
+    width: 100%;
+    height: 99vh;
+    display: flex;
+    overflow: hidden;
+    flex-direction: column;
+}
+
+/* Prevent text selection */
+* {
+    user-select: none !important;
+    -webkit-user-select: none !important;
+    -webkit-user-drag: none !important;
+    -webkit-touch-callout: none !important;
+}
+
+.column {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    width: 100%;
+}
+
+.row {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+}
+
+.header {
+    text-align: center;
+    padding-top: 80px;
+    margin-top: -10px;
+    background-color: rgba(0, 0, 0, 0.03);
+    font-weight: 600;
+    font-size: 18px;
+    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+}
+
+.sub-header {
+    background-color: rgba(0, 0, 0, 0.03); 
+    width: 100%; 
+    padding-top: 13px; 
+    text-align: center; 
+    font-weight: 550; 
+    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+}
+
+.divider {
+    height: 1px;
+    background-color: rgba(0, 0, 0, 0.075);
+    margin-top: 13px;
+}
+
+.scroll {
+    flex-grow: 1;
+    overflow-y: auto;
+}
+
+.no-scroll {
+    flex-grow: 1;
+    overflow-y: hidden;
+}
+
+.button {
+    width: 175px;
+    height: 40px;
+    margin: 5px;
+    margin-top: 10px;
+    background-color: #4285F4;
+    color: white;
+    border: none;
+    padding: 10px 20px;
+    justify-content: center;
+    font-size: 16px;
+    border-radius: 100px;
+    cursor: pointer;
+    transition: all 0.3s ease;
+    user-select: none;
+    -webkit-user-select: none;
+    -moz-user-select: none;
+    -ms-user-select: none;
+}
+
+.button:active {
+    position: relative;
+    top: 1px;
+}
+
+.text-button {
+    background: none;
+    border: none;
+    color: #2196f3;
+    font-size: 20px;
+    font-weight: bold;
+    padding: 5px;
+}
+
+.text-button:active {
+    position: relative;
+    top: 1px;
+}
+
+.radio {
+    align-items: baseline;
+    padding: 15px;
+}
+
+input[type="checkbox"] {
+    width: 20px;
+    height: 20px;
+    border: 2px solid black;
+    background-color: white;
+    display: inline-block;
+    position: relative;
+    cursor: pointer;
+}
+
+input[type="text"] {
+    width: 173px;
+    height: 40px;
+    font-size: 15px;
+    margin: 5px;
+    border-radius: 100px;
+    padding-left: 10px;
+    padding-right: 10px;
+    margin-top: 10px;
+}
+
+.progress-bar {
+    width: 75%;
+    padding: 3px;
+    margin-top: 40px;
+    background-color: #eee;
+    border-radius: 8px;
+    box-shadow: inset 0 0 5px rgba(0, 0, 0, 0.2);
+}
+
+#progress {
+    width: 0%;
+    height: 20px;
+    background-color: #4285F4;
+    border-radius: 5px;
+}

package/examples/react_native/src/main.html

@@ -0,0 +1,17 @@
+<div class="column" style="height: 100%">
+    <div class="column header">
+        <span id="status">Initializing...</span>
+        <div class="column divider"></div>
+    </div>
+    <div id="sub-header" class="column sub-header" style="display: none;">
+        <span id="description"></span>
+        <div class="column divider"></div>
+    </div>
+    <div id="main" class="column no-scroll">
+        <div class="column no-scroll" style="padding-top: 15px; background-color: rgba(0, 0, 0, 0.03);">
+            <div id="radio-group" class="scroll"></div>
+        </div>
+        <button id="start-workflow" class="button" style="width: 360px">Start Workflow</button>
+        <div style="padding-top: 30px"></div>
+    </div>
+</div>

package/examples/react_native/src/main.tsx

@@ -0,0 +1,124 @@
+import { IDV, Workflow } from '@regulaforensics/idv'
+
+enum Configuration { credentials, token, apiKey }
+
+const loginType: Configuration = Configuration.credentials
+const baseUrl = "https://idv.regula.app"
+const username = "username_placeholder"
+const password = "password_placeholder"
+const tokenUrl = "token_placeholder"
+const apiKey = "api_key_placeholder"
+
+var idv = IDV.instance
+var selectedWorkflow = ""
+var workflowIds: string[] = []
+
+async function init() {
+    var [_, iError] = await idv.initialize()
+    if (handleException(iError, "initialize")) return
+
+    var success = ({
+        [Configuration.credentials]: async () => await configureWithCredentials(),
+        [Configuration.token]: async () => await configureWithToken(),
+        [Configuration.apiKey]: async () => await configureApiKey(),
+    })[loginType]!
+    if (!await success()) return
+
+    var [wfs, error] = await idv.getWorkflows()
+    if (handleException(error, "getWorkflows")) return
+    if (loginType == Configuration.token) {
+        wfs = wfs!.filter((wf: any) => workflowIds.includes(wf.id))
+    }
+
+    setWorkflows(wfs!)
+    setStatus("Ready")
+}
+
+async function configureWithCredentials(): Promise<boolean> {
+    var [success, error] = await idv.configureWithCredentials({
+        baseUrl: baseUrl,
+        userName: username,
+        password: password
+    })
+    handleException(error, "configureWithCredentials")
+    return success
+}
+
+async function configureWithToken(): Promise<boolean> {
+    var [wfIds, error] = await idv.configureWithToken({ url: tokenUrl })
+    if (handleException(error, "configureWithToken")) return false
+    workflowIds = wfIds!
+    return true
+}
+
+async function configureApiKey(): Promise<boolean> {
+    var [success, error] = await idv.configureWithApiKey({ baseUrl, apiKey })
+    handleException(error, "configureWithApiKey")
+    return success
+}
+
+async function startWorkflow(): Promise<void> {
+    if (selectedWorkflow.length == 0) return
+    setStatus("Preparing Workflow...")
+
+    var [_, prepareError] = await idv.prepareWorkflow({ workflowId: selectedWorkflow })
+    if (handleException(prepareError, "prepareWorkflow")) return
+
+    var [result, error] = await idv.startWorkflow()
+    if (handleException(error, "startWorkflow")) return
+
+    setStatus("Success")
+    setDescription(`SessionID: ${result?.sessionId}`)
+}
+
+function handleException(error?: string | null, tag?: string): boolean {
+    if (error == null) return false
+    setStatus(`Error - IDV.${tag}()`)
+    setDescription(error)
+    console.log(error)
+    return true
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+
+export function main() {
+    document.getElementById("start-workflow")!.onclick = () => startWorkflow()
+
+    init()
+}
+
+var setStatus = (data: string) => document.getElementById("status")!.innerHTML = data
+var setDescription = (data: string) => {
+    document.getElementById("description")!.innerHTML = data
+    document.getElementById("sub-header")!.style.display = data.length > 0 ? "block" : "none"
+}
+
+var workflows: Workflow[] = []
+function setWorkflows(data: Workflow[]) {
+    var radioGroup = document.getElementById("radio-group")!
+    workflows = data
+    if (workflows.length != 0) {
+        selectedWorkflow = workflows[0].id
+    }
+
+    data.forEach(item => {
+        var checked = selectedWorkflow == item.id ? "checked" : ""
+        var radioElement = `
+        <div class="row radio">
+            <input type="radio" name="radio" id="${item.id}" value="${item.id}" ${checked}>
+            <span id="${item.id}-caption" style="width: 200px; padding-left: 5px;">${item.name}</span>
+        </div>`
+        radioGroup.insertAdjacentHTML("beforeend", radioElement)
+    })
+
+    data.forEach(item => {
+        var element = document.getElementById(item.id) as HTMLInputElement
+        var elementCaption = document.getElementById(item.id + "-caption")!
+        var onclick = () => {
+            selectedWorkflow = item.id
+            element.checked = true
+        }
+        element.onclick = onclick
+        elementCaption.onclick = onclick
+    })
+}

package/ios/CVDIDV.swift

@@ -0,0 +1,51 @@
+var eventCallbackIds: [String: String] = [:]
+private var args: [Any?] = []
+private var this: CVDIDV?
+
+func sendEvent(_ event: String, _ data: Any? = nil) {
+    var callbackId = event
+    let eventId = eventCallbackIds[event]
+    if eventId != nil { callbackId = eventId! }
+
+    var sendable = data.toSendable() as Any?
+    if sendable is NSNull { sendable = nil }
+    let result = CDVPluginResult(status: CDVCommandStatus_OK, messageAs: sendable as! String?)!
+    result.setKeepCallbackAs(true)
+    
+    this!.commandDelegate.send(result, callbackId: callbackId)
+}
+
+func args<T>(_ index: Int) -> T {
+    return args[index] as! T
+}
+
+func argsNullable<T>(_ index: Int) -> T? {
+    if (args[index] is NSNull) { return nil }
+    return args[index] as! T?
+}
+
+@objc(CVDIDV)
+class CVDIDV: CDVPlugin {
+    @objc(exec:)
+    func exec(_ command: CDVInvokedUrlCommand) {
+        this = self
+        let method = command.arguments.first as! String
+        args = Array(command.arguments.dropFirst())
+
+        if method == "setEvent" {
+            eventCallbackIds[args.first as! String] = command.callbackId
+            return
+        }
+
+        methodCall(method, { data in sendEvent(command.callbackId, data) })
+    }
+}
+
+let rootViewController: () -> UIViewController? = {
+    for window in UIApplication.shared.windows {
+        if window.isKeyWindow {
+            return window.rootViewController
+        }
+    }
+    return nil
+}

package/ios/JSONConstructor.swift

@@ -0,0 +1,132 @@
+import IDVSDK
+import IDVModule
+
+public func generateCompletion(_ value: Any?, _ error: IDVModule.BaseError?) -> [String: Any?] {
+    return [
+        "success": value,
+        "error": error?.fullChain
+    ]
+}
+
+// MARK: - Config
+
+public func credentialsConnectionConfigFromJSON(_ data: [String: Any?]) -> CredentialsConnectionConfig {
+    let result = CredentialsConnectionConfig (userName: data["userName"] as! String,
+                                              password: data["password"] as! String,
+                                              baseURL: data["baseUrl"] as! String)
+    if let httpTimeoutMs = data["httpTimeoutMs"] as? NSNumber { result.httpTimeoutMs = httpTimeoutMs }
+    return result
+}
+
+public func generateCredentialsConnectionConfig(_ data: CredentialsConnectionConfig) -> [String: Any?] {
+    return [
+        "baseUrl": data.baseURL,
+        "userName": data.userName,
+        "password": data.password,
+        "httpTimeoutMs": data.httpTimeoutMs,
+    ]
+}
+
+public func tokenConnectionConfigFromJSON(_ data: [String: Any?]) -> TokenConnectionConfig {
+    return TokenConnectionConfig(url: data["url"] as! String)
+}
+
+public func generateTokenConnectionConfig(_ data: TokenConnectionConfig) -> [String: Any?] {
+    return [
+        "url": data.url
+    ]
+}
+
+public func apiKeyConnectionConfigFromJSON(_ data: [String: Any?]) -> ApiKeyConnectionConfig {
+    let result = ApiKeyConnectionConfig(apiKey: data["apiKey"] as! String,
+                                        baseURL: data["baseUrl"] as! String,
+                                        ttl: data["ttl"] as? NSNumber)
+    if let httpTimeoutMs = data["httpTimeoutMs"] as? NSNumber { result.httpTimeoutMs = httpTimeoutMs }
+    return result
+}
+
+public func generateApiKeyConnectionConfig(_ data: ApiKeyConnectionConfig) -> [String: Any?] {
+    return [
+        "baseUrl": data.baseURL,
+        "apiKey": data.apiKey,
+        "ttl": data.ttl,
+        "httpTimeoutMs": data.httpTimeoutMs,
+    ]
+}
+
+public func prepareWorkflowConfigFromJSON(_ data: [String: Any?]) -> PrepareWorkflowConfig {
+    return PrepareWorkflowConfig(workflowId: data["workflowId"] as! String)
+}
+
+public func generatePrepareWorkflowConfig(_ data: PrepareWorkflowConfig) -> [String: Any?] {
+    return [
+        "workflowId": data.workflowId
+    ]
+}
+
+public func startWorkflowConfigFromJSON(input: [String: Any?]?) -> StartWorkflowConfig {
+    let result = StartWorkflowConfig.default()
+    guard let data = input else { return result }
+    
+    if let locale = data["locale"] as? String { result.locale = locale }
+    if let metadata = data["metadata"] as? [String: Any] { result.metadata = metadata }
+    
+    return result
+}
+
+public func generateStartWorkflowConfig(_ data: StartWorkflowConfig) -> [String: Any?] {
+    return [
+        "locale": data.locale,
+        "metadata": data.metadata
+    ]
+}
+
+// MARK: - Model
+
+public func workflowFromJSON(_ input: [String: Any?]?) -> Workflow? {
+    guard var it = input else { return nil }
+    it["client"] = [String: Any]()
+    it["steps"] = [WorkflowStep]()
+    it["_description"] = it["description"]
+    return try! Workflow(from: it.toDecoder())
+}
+
+public func generateWorkflow(_ input: Workflow?) -> [String: Any?]? {
+    guard let it = input else { return nil }
+    return [
+        "id": it.id,
+        "name": it.name,
+        "version": it.version,
+        "description": it._description,
+        "defaultLocale": it.defaultLocale
+    ]
+}
+
+public func workflowStepFromJSON(_ input: [String: Any?]?) -> WorkflowStep? {
+    guard var it = input else { return nil }
+    it["type"] = ""
+    it["final"] = false
+    it["client"] = [String: Any]()
+    return try! WorkflowStep(from: it.toDecoder())
+}
+
+public func generateWorkflowStep(_ input: WorkflowStep?) -> [String: Any?]? {
+    guard let it = input else { return nil }
+    return [
+        "id": it.id,
+        "name": it.name
+    ]
+}
+
+public func workflowResultFromJSON(_ input: [String: Any?]?) -> WorkflowResult? {
+    guard let it = input else { return nil }
+    return try! WorkflowResult(from: it.toDecoder())
+}
+
+public func generateWorkflowResult(_ input: WorkflowResult?) -> [String: Any?]? {
+    guard let it = input else { return nil }
+    return [
+        "sessionId": it.sessionId,
+        "finalStep": generateWorkflowStep(it.finalStep)
+    ]
+}

package/ios/Main.swift

@@ -0,0 +1,91 @@
+import IDVSDK
+
+let didStartSessionEvent = "didStartSessionEvent"
+let didEndSessionEvent = "didEndSessionEvent"
+let didStartRestoreSessionEvent = "didStartRestoreSessionEvent"
+let didContinueRemoteSessionEvent = "didContinueRemoteSessionEvent"
+
+func methodCall(_ method: String, _ callback: @escaping Callback) {
+    switch (method) {
+    case("setSessionRestoreMode"): IDV.shared.sessionRestoreMode = SessionRestoreMode(rawValue: args(0))!
+    case("getCurrentSessionId"): callback(IDV.shared.currentSessionId)
+    case ("initialize"): initialize(callback)
+    case("deinitialize"): deinitialize(callback)
+    case("configureWithToken"): configureWithToken(callback, args(0))
+    case("configureWithCredentials"): configureWithCredentials(callback, args(0))
+    case("configureWithApiKey"): configureWithApiKey(callback, args(0))
+    case("prepareWorkflow"): prepareWorkflow(callback, args(0))
+    case("startWorkflow"): startWorkflow(callback, argsNullable(0))
+    case("getWorkflows"): getWorkflows(callback)
+    default: break
+    }
+}
+
+// MARK: - Implementation
+
+func initialize(_ callback: @escaping Callback) {
+    DispatchQueue.main.async {
+        IDV.shared.initialize(config: IDVInitConfig(), completion: { result in
+            IDV.shared.delegate = delegate
+            callback(generateCompletion(result.isSuccess, result.failureOrNil))
+        })
+    }
+}
+
+func deinitialize(_ callback: @escaping Callback) {
+    IDV.shared.deinitialize(completion: { result in
+        callback(generateCompletion(result.isSuccess, result.failureOrNil))
+    })
+}
+
+func configureWithToken(_ callback: @escaping Callback, _ data: [String: Any?]) {
+    IDV.shared.configure(with: tokenConnectionConfigFromJSON(data), completion: { result in
+        callback(generateCompletion(result.successOrNil, result.failureOrNil))
+    })
+}
+
+func configureWithCredentials(_ callback: @escaping Callback, _ data: [String: Any?]) {
+    IDV.shared.configure(with: credentialsConnectionConfigFromJSON(data), completion: { result in
+        callback(generateCompletion(result.isSuccess, result.failureOrNil))
+    })
+}
+
+func configureWithApiKey(_ callback: @escaping Callback, _ data: [String: Any?]) {
+    IDV.shared.configure(with: apiKeyConnectionConfigFromJSON(data), completion: { result in
+        callback(generateCompletion(result.isSuccess, result.failureOrNil))
+    })
+}
+
+func prepareWorkflow(_ callback: @escaping Callback, _ data: [String: Any?]) {
+    IDV.shared.prepareWorkflow(by: prepareWorkflowConfigFromJSON(data), completion: { result in
+        callback(generateCompletion(generateWorkflow(result.successOrNil), result.failureOrNil))
+    })
+}
+
+func startWorkflow(_ callback: @escaping Callback, _ data: [String: Any?]?) {
+    DispatchQueue.main.async {
+        IDV.shared.startWorkflow(presenter: rootViewController()!,
+                                 config: startWorkflowConfigFromJSON(input: data),
+                                 completion: { result in
+            callback(generateCompletion(generateWorkflowResult(result.successOrNil), result.failureOrNil))
+        })
+    }
+}
+
+func getWorkflows(_ callback: @escaping Callback) {
+    IDV.shared.getWorkflows(completion: { result in
+        callback(generateCompletion(result.successOrNil?.compactMap { generateWorkflow($0) },
+                                    result.failureOrNil))
+    })
+}
+
+
+// MARK: - WeakReference
+
+class IDVDelegate: IDVSDK.IDVDelegate {
+    func didStartNewSession(idv: IDV) { sendEvent(didStartSessionEvent) }
+    func didEndSession(idv: IDV) { sendEvent(didEndSessionEvent) }
+    func didStartRestoreSession(idv: IDV) { sendEvent(didStartRestoreSessionEvent) }
+    func didContinueRemoteSession(idv: IDV) { sendEvent(didContinueRemoteSessionEvent) }
+}
+let delegate = IDVDelegate()

package/ios/RNIDV.m

@@ -0,0 +1,11 @@
+#import <React/RCTEventEmitter.h>
+#import <React/RCTBridgeModule.h>
+
+@interface RCT_EXTERN_MODULE(RNIDV, RCTEventEmitter)
+
+RCT_EXTERN_METHOD(exec: (NSString*)method
+                  args:(NSArray*)args
+                  resolve:(RCTPromiseResolveBlock)resolve
+                  reject:(RCTPromiseRejectBlock)reject)
+
+@end

package/ios/RNIDV.swift

@@ -0,0 +1,47 @@
+import React
+
+func sendEvent(_ event: String, _ data: Any? = nil) {
+    guard let plugin = this, hasListeners else { return }
+    DispatchQueue.main.async {
+        plugin.sendEvent(withName: event, body: data.toSendable())
+    }
+}
+
+func args<T>(_ index: Int) -> T {
+    return mArgs[index] as! T
+}
+
+func argsNullable<T>(_ index: Int) -> T? {
+    if (mArgs[index] is NSNull) { return nil }
+    return mArgs[index] as! T?
+}
+
+private var firedCallbacks: [RCTResponseSenderBlock] = []
+private var hasListeners: Bool = false
+private var this: RNIDV?
+private var mArgs: [Any?] = []
+
+@objc(RNIDV)
+public class RNIDV: RCTEventEmitter {
+    override public func startObserving() { hasListeners = true }
+    override public func stopObserving() { hasListeners = false }
+    override public func supportedEvents()->[String] {
+        return [didStartSessionEvent,
+                didEndSessionEvent,
+                didStartRestoreSessionEvent,
+                didContinueRemoteSessionEvent];
+    }
+    
+    @objc
+    func exec(_ method: String, args: [Any], resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+        this = self
+        mArgs = args
+        methodCall(method, { data in
+            if firedCallbacks.contains(where: { ($0 as AnyObject) === (resolve as AnyObject) }) { return }
+            firedCallbacks.append(resolve)
+            resolve(data.toSendable())
+        })
+    }
+}
+
+let rootViewController: () -> UIViewController? = { return RCTPresentedViewController() }