@regulaforensics/idv 3.2.25-beta → 3.2.59-beta

package/examples/react_native/package.json

@@ -8,13 +8,13 @@
     "start": "expo start"
   },
   "dependencies": {
-    "@regulaforensics/idv": "3.2.25-beta",
-    "@regulaforensics/document-reader": "8.4.316-beta",
-    "@regulaforensics/face-sdk": "7.3.480-beta",
-    "@regulaforensics/document-reader-core-fullauthrfid": "8.4.271-beta",
-    "@regulaforensics/face-core-basic": "7.3.280-beta",
-    "@regulaforensics/idv-module-document-reader": "3.2.29-beta",
-    "@regulaforensics/idv-module-face": "3.2.28-beta",
+    "@regulaforensics/idv": "3.2.59-beta",
+    "@regulaforensics/document-reader": "8.4.341-beta",
+    "@regulaforensics/face-sdk": "8.1.506-beta",
+    "@regulaforensics/document-reader-core-fullauthrfid": "8.4.325-beta",
+    "@regulaforensics/face-core-basic": "7.3.282-beta",
+    "@regulaforensics/idv-module-document-reader": "3.2.30-beta",
+    "@regulaforensics/idv-module-face": "3.2.31-beta",
     "react-native": "^0.81.4",
     "react-native-webview": "^13.16.0",
     "@react-native/metro-config": "^0.81.1",

package/examples/react_native/scripts/setup.sh

@@ -7,3 +7,6 @@ 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.html

@@ -3,36 +3,15 @@
         <span id="status">Loading...</span>
         <div class="column divider"></div>
     </div>
-    <div id="main" class="column no-scroll">
-        <div class="row">
-            <div class="column" style="padding: 5px;">
-                <p>Portrait</p>
-                <img id="portrait-image" src="images/portrait.png" height="160px" width="120px">
-            </div>
-            <div class="column" style="padding: 5px;">
-                <p>Document image</p>
-                <img id="document-image" src="images/document.png" height="160px" width="200px">
-            </div>
-        </div>
-        <div id="scenario-container" class="column no-scroll" style="margin-top: 15px; background-color: rgba(0, 0, 0, 0.03);">
-            <div id="scenarios" class="scroll"></div>
-        </div>
-        <div class="row" style="width: 360px; padding-top: 15px;">
-            <span id="rfid-checkbox-description" style="font-size: 18px;width: 100%;">Process rfid reading(unavailable)</span>
-            <input id="rfid-checkbox" type="checkbox" style="margin-left: auto;" disabled />
-        </div>
-        <div class="row">
-            <button id="scan" class="button">Scan document</button>
-            <button id="recognize" class="button">Scan image</button>
-        </div>
-        <button id="connect" class="button" style="width: 360px; display: none;">Connect</button>
-        <div style="padding-top: 20px;"></div>
+    <div id="sub-header" class="column sub-header" style="display: none;">
+        <span id="description"></span>
+        <div class="column divider"></div>
     </div>
-    <div id="custom-rfid" class="column no-scroll" style="display: none;">
-        <span id="rfid-description" style="font-size: 22px">Place your phone on top of the NFC tag</span>
-        <div class="progress-bar">
-            <div id="progress"></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="cancel-rfid" class="text-button" style="margin-top: 50px; padding-bottom: 100px;">X</button>
+        <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

@@ -1,10 +1,124 @@
-import { IDV } from '@regulaforensics/idv'
+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, tag?: string): boolean {
+    if (error == null) return false
+    setStatus(`Error - IDV.${tag}()`)
+    setDescription(error)
+    console.error(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

@@ -1,64 +1,20 @@
-import Flutter
-import UIKit
-
-let channelID = "flutter_idv"
-var eventSinks: [String: FlutterEventSink] = [:]
-
-private var args: [Any?] = []
+var eventCallbackIds: [String: String] = [:]
 
 func sendEvent(_ event: String, _ data: Any? = nil) {
-    DispatchQueue.main.async {
-        if let sink = eventSinks[event] {
-            sink(data.toSendable())
-        }
-    }
+    
 }
 
 func args<T>(_ index: Int) -> T {
-    return args[index] as! T
+    return index as! T
 }
 
 func argsNullable<T>(_ index: Int) -> T? {
-    if (args[index] is NSNull) { return nil }
-    return args[index] as! T?
+    return nil
 }
 
-public class FlutterIDVPlugin: NSObject, FlutterPlugin {
-    public static func register(with registrar: FlutterPluginRegistrar) {
-        func setupEventChannel(_ eventId: String) {
-            let channel = FlutterEventChannel(name: "\(channelID)/event/\(eventId)", binaryMessenger: registrar.messenger())
-            channel.setStreamHandler(GenericStreamHandler(eventId))
-        }
-        setupEventChannel(didStartSessionEvent);
-        setupEventChannel(didEndSessionEvent);
-        setupEventChannel(didStartRestoreSessionEvent);
-        setupEventChannel(didContinueRemoteSessionEvent);
+class CVDIDV: CDVPlugin {
+    func exec(_ command: CDVInvokedUrlCommand) {
         
-        let channel = FlutterMethodChannel(name: "\(channelID)/method", binaryMessenger: registrar.messenger())
-        registrar.addMethodCallDelegate(FlutterIDVPlugin(), channel: channel)
-    }
-    
-    public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
-        args = call.arguments as! [Any?]
-        methodCall(call.method, { data in result(data.toSendable()) })
-    }
-}
-
-class GenericStreamHandler: NSObject, FlutterStreamHandler {
-    private let eventId: String
-    
-    public init(_ eventId: String) {
-        self.eventId = eventId
-    }
-    
-    public func onListen(withArguments arguments: Any?, eventSink: @escaping FlutterEventSink) -> FlutterError? {
-        eventSinks[eventId] = eventSink
-        return nil
-    }
-    
-    public func onCancel(withArguments arguments: Any?) -> FlutterError? {
-        eventSinks[eventId] = nil
-        return nil
     }
 }
 

package/ios/RNIDV.swift

@@ -1,65 +1,17 @@
-import Flutter
-import UIKit
-
-let channelID = "flutter_idv"
-var eventSinks: [String: FlutterEventSink] = [:]
-
-private var args: [Any?] = []
-
 func sendEvent(_ event: String, _ data: Any? = nil) {
-    DispatchQueue.main.async {
-        if let sink = eventSinks[event] {
-            sink(data.toSendable())
-        }
-    }
+
 }
 
 func args<T>(_ index: Int) -> T {
-    return args[index] as! T
+    return index as! T
 }
 
 func argsNullable<T>(_ index: Int) -> T? {
-    if (args[index] is NSNull) { return nil }
-    return args[index] as! T?
+    return nil
 }
 
-public class FlutterIDVPlugin: NSObject, FlutterPlugin {
-    public static func register(with registrar: FlutterPluginRegistrar) {
-        func setupEventChannel(_ eventId: String) {
-            let channel = FlutterEventChannel(name: "\(channelID)/event/\(eventId)", binaryMessenger: registrar.messenger())
-            channel.setStreamHandler(GenericStreamHandler(eventId))
-        }
-        setupEventChannel(didStartSessionEvent);
-        setupEventChannel(didEndSessionEvent);
-        setupEventChannel(didStartRestoreSessionEvent);
-        setupEventChannel(didContinueRemoteSessionEvent);
-        
-        let channel = FlutterMethodChannel(name: "\(channelID)/method", binaryMessenger: registrar.messenger())
-        registrar.addMethodCallDelegate(FlutterIDVPlugin(), channel: channel)
-    }
-    
-    public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
-        args = call.arguments as! [Any?]
-        methodCall(call.method, { data in result(data.toSendable()) })
-    }
-}
+public class RNIDVPlugin: NSObject {
 
-class GenericStreamHandler: NSObject, FlutterStreamHandler {
-    private let eventId: String
-    
-    public init(_ eventId: String) {
-        self.eventId = eventId
-    }
-    
-    public func onListen(withArguments arguments: Any?, eventSink: @escaping FlutterEventSink) -> FlutterError? {
-        eventSinks[eventId] = eventSink
-        return nil
-    }
-    
-    public func onCancel(withArguments arguments: Any?) -> FlutterError? {
-        eventSinks[eventId] = nil
-        return nil
-    }
 }
 
 let rootViewController: () -> UIViewController? = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/idv",
-  "version": "3.2.25-beta",
+  "version": "3.2.59-beta",
   "description": "This is an npm module for Regula IDV, which unifies access to all Regula products. This plugin makes possible to use it with react-native, cordova and capacitor applications. Supports Android and iOS.",
   "main": "www/react-native/index.js",
   "module": "www/capacitor/index.js",

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="@regulaforensics/idv" version="3.2.25-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="@regulaforensics/idv" version="3.2.59-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
   <name>IDV</name>
   <description>Cordova plugin for Regula IDV</description>
   <license>commercial</license>
@@ -15,11 +15,12 @@
         <param name="ios-package" value="CVDIDV" />
       </feature>
       <preference name="deployment-target" value="14.0" />
+      <preference name="SwiftVersion" value="5" />
     </config-file>
-    <header-file src="ios/CVDIDV.swift" />
+    <source-file src="ios/CVDIDV.swift" />
     <source-file src="ios/Main.swift" />
-    <header-file src="ios/JSONConstructor.swift" />
-    <header-file src="ios/Utils.swift" />
+    <source-file src="ios/JSONConstructor.swift" />
+    <source-file src="ios/Utils.swift" />
     <podspec>
       <config>
         <source url="https://github.com/CocoaPods/Specs.git" />

package/test/json.tsx

@@ -0,0 +1,40 @@
+export var credentialsConnectionConfig = {
+    "baseUrl": "test3",
+    "userName": "test1",
+    "password": "test2",
+    "httpTimeoutMs": 1,
+}
+export var tokenConnectionConfig = {
+    "url": "test1",
+}
+export var apiKeyConnectionConfig = {
+    "baseUrl": "test1",
+    "apiKey": "test2",
+    "ttl": 1,
+    "httpTimeoutMs": 2,
+}
+export var prepareWorkflowConfig = {
+    "workflowId": "test1",
+}
+export var startWorkflowConfig = {
+    "locale": "test1",
+    "metadata": {
+        "test2": "test3",
+    },
+}
+
+export var workflow = {
+    "id": "test1",
+    "name": "test2",
+    "version": "test3",
+    "description": "test4",
+    "defaultLocale": "test5",
+}
+export var workflowStep = {
+    "id": "test1",
+    "name": "test2",
+}
+export var workflowResult = {
+    "sessionId": "test1",
+    "finalStep": workflowStep,
+}

package/test/package-lock.json

@@ -13,7 +13,7 @@
     },
     "..": {
       "name": "@regulaforensics/idv",
-      "version": "3.2.25-beta",
+      "version": "3.2.59-beta",
       "dev": true,
       "license": "commercial"
     },

package/test/test.tsx

@@ -1,3 +1,13 @@
 import { compare } from './utils'
-import { } from '@regulaforensics/idv'
-import { } from './json'
+import { CredentialsConnectionConfig, TokenConnectionConfig, ApiKeyConnectionConfig, PrepareWorkflowConfig, StartWorkflowConfig, Workflow, WorkflowStep, WorkflowResult } from '@regulaforensics/idv/www/capacitor'
+import { apiKeyConnectionConfig, credentialsConnectionConfig, prepareWorkflowConfig, startWorkflowConfig, tokenConnectionConfig, workflow, workflowStep, workflowResult } from './json'
+
+compare('credentialsConnectionConfig', credentialsConnectionConfig, CredentialsConnectionConfig.fromJson)
+compare('tokenConnectionConfig', tokenConnectionConfig, TokenConnectionConfig.fromJson)
+compare('apiKeyConnectionConfig', apiKeyConnectionConfig, ApiKeyConnectionConfig.fromJson)
+compare('prepareWorkflowConfig', prepareWorkflowConfig, PrepareWorkflowConfig.fromJson)
+compare('startWorkflowConfig', startWorkflowConfig, StartWorkflowConfig.fromJson)
+
+compare('workflow', workflow, Workflow.fromJson);
+compare('workflowStep', workflowStep, WorkflowStep.fromJson);
+compare('workflowResult', workflowResult, WorkflowResult.fromJson);

package/www/capacitor/config/api_key_connection_config.js

@@ -0,0 +1,32 @@
+export class ApiKeyConnectionConfig {
+    baseUrl
+    apiKey
+    ttl
+    httpTimeoutMs
+
+    constructor(params) {
+        this.baseUrl = params?.baseUrl
+        this.apiKey = params?.apiKey
+        this.ttl = params?.ttl
+        this.httpTimeoutMs = params?.httpTimeoutMs
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new ApiKeyConnectionConfig()
+        result.baseUrl = jsonObject["baseUrl"]
+        result.apiKey = jsonObject["apiKey"]
+        result.ttl = jsonObject["ttl"]
+        result.httpTimeoutMs = jsonObject["httpTimeoutMs"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "baseUrl": this.baseUrl,
+            "apiKey": this.apiKey,
+            "ttl": this.ttl,
+            "httpTimeoutMs": this.httpTimeoutMs,
+        }
+    }
+}

package/www/capacitor/config/credentials_connection_config.js

@@ -0,0 +1,32 @@
+export class CredentialsConnectionConfig {
+    baseUrl
+    userName
+    password
+    httpTimeoutMs
+
+    constructor(params) {
+        this.baseUrl = params?.baseUrl
+        this.userName = params?.userName
+        this.password = params?.password
+        this.httpTimeoutMs = params?.httpTimeoutMs
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new CredentialsConnectionConfig()
+        result.baseUrl = jsonObject["baseUrl"]
+        result.userName = jsonObject["userName"]
+        result.password = jsonObject["password"]
+        result.httpTimeoutMs = jsonObject["httpTimeoutMs"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "baseUrl": this.baseUrl,
+            "userName": this.userName,
+            "password": this.password,
+            "httpTimeoutMs": this.httpTimeoutMs,
+        }
+    }
+}

package/www/capacitor/config/prepare_workflow_config.js

@@ -0,0 +1,20 @@
+export class PrepareWorkflowConfig {
+    workflowId
+
+    constructor(params) {
+        this.workflowId = params?.workflowId
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new PrepareWorkflowConfig()
+        result.workflowId = jsonObject["workflowId"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "workflowId": this.workflowId,
+        }
+    }
+}

package/www/capacitor/config/start_workflow_config.js

@@ -0,0 +1,24 @@
+export class StartWorkflowConfig {
+    locale
+    metadata
+
+    constructor(params) {
+        this.locale = params?.locale
+        this.metadata = params?.metadata
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new StartWorkflowConfig()
+        result.locale = jsonObject["locale"]
+        result.metadata = jsonObject["metadata"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "locale": this.locale,
+            "metadata": this.metadata,
+        }
+    }
+}

package/www/capacitor/config/token_connection_config.js

@@ -0,0 +1,20 @@
+export class TokenConnectionConfig {
+    url
+
+    constructor(params) {
+        this.url = params?.url
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new TokenConnectionConfig()
+        result.url = jsonObject["url"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "url": this.url,
+        }
+    }
+}