@regulaforensics/idv 3.2.26-beta → 3.2.59-beta

package/www/react-native/index.js

@@ -1,6 +1,110 @@
-import { exec } from './internal/bridge'
+import { exec, setDidStartSessionCompletion, setDidEndSessionCompletion, setDidStartRestoreSessionCompletion, setDidContinueRemoteSessionCompletion } from './internal/bridge'
+
+import { TokenConnectionConfig } from './config/token_connection_config'
+import { CredentialsConnectionConfig } from './config/credentials_connection_config'
+import { ApiKeyConnectionConfig } from './config/api_key_connection_config'
+import { PrepareWorkflowConfig } from './config/prepare_workflow_config'
+import { StartWorkflowConfig } from './config/start_workflow_config'
+import { Workflow } from './model/workflow'
+import { WorkflowResult } from './model/workflow_result'
+
+export { TokenConnectionConfig }
+export { CredentialsConnectionConfig }
+export { ApiKeyConnectionConfig }
+export { PrepareWorkflowConfig }
+export { StartWorkflowConfig }
+export { Workflow }
+export { WorkflowResult }
+export { WorkflowStep } from './model/workflow_step'
 
 export class IDV {
     static get instance() { return IDV._instance }
     static _instance = new IDV()
+
+    setListener(options) {
+        const value = options ?? {}
+        setDidStartSessionCompletion(value.didStartSession)
+        setDidEndSessionCompletion(value.didEndSession)
+        setDidStartRestoreSessionCompletion(value.didStartRestoreSession)
+        setDidContinueRemoteSessionCompletion(value.didContinueRemoteSession)
+    }
+
+    set sessionRestoreMode(val) {
+        exec('setSessionRestoreMode', [val])
+    }
+
+    async getCurrentSessionId() {
+        return await exec('getCurrentSessionId', [])
+    }
+
+    async initialize() {
+        const response = await exec('initialize', [])
+        return completionFromResponse(response)
+    }
+
+    async deinitialize() {
+        const response = await exec('deinitialize', [])
+        return completionFromResponse(response)
+    }
+
+    async configureWithToken(config) {
+        config = ensureInstance(config, TokenConnectionConfig)
+        const response = await exec('configureWithToken', [config?.toJson()])
+        return completionFromResponse(response, success => success?.map(item => String(item)))
+    }
+
+    async configureWithCredentials(config) {
+        config = ensureInstance(config, CredentialsConnectionConfig)
+        const response = await exec('configureWithCredentials', [config?.toJson()])
+        return completionFromResponse(response)
+    }
+
+    async configureWithApiKey(config) {
+        config = ensureInstance(config, ApiKeyConnectionConfig)
+        const response = await exec('configureWithApiKey', [config?.toJson()])
+        return completionFromResponse(response)
+    }
+
+    async prepareWorkflow(config) {
+        config = ensureInstance(config, PrepareWorkflowConfig)
+        const response = await exec('prepareWorkflow', [config?.toJson()])
+        return completionFromResponse(response, json => Workflow.fromJson(json))
+    }
+
+    async startWorkflow(config) {
+        config = ensureInstance(config, StartWorkflowConfig)
+        const response = await exec('startWorkflow', [config?.toJson()])
+        return completionFromResponse(response, json => WorkflowResult.fromJson(json))
+    }
+
+    async getWorkflows() {
+        const response = await exec('getWorkflows', [])
+        return completionFromResponse(response, json => {
+            const result = []
+            if (json != null) for (const item of json) {
+                const workflow = Workflow.fromJson(item)
+                if (workflow != null) result.push(workflow)
+            }
+            return result
+        })
+    }
+}
+
+export const SessionRestoreMode = {
+    ENABLED: 0,
+    DISABLED: 1,
+}
+
+function completionFromResponse(response, transform) {
+    const jsonObject = JSON.parse(response)
+    let success = jsonObject['success']
+    const error = jsonObject['error']
+    if (transform != null && success != null) success = transform(success)
+    return [success, error]
+}
+
+function ensureInstance(value, ctor) {
+    if (value == null) return null
+    if (value instanceof ctor) return value
+    return new ctor(value)
 }

package/www/react-native/internal/bridge.js

@@ -7,13 +7,24 @@ export async function exec(name, params) {
     return RNIDV.exec(name, params)
 }
 
-function _setEvent(id, completion, fromJson) {
+function setEvent(id, completion, transform) {
     eventManager.removeAllListeners(id)
-    if (completion == null) return
-    if (fromJson == null) eventManager.addListener(id, completion)
-    else eventManager.addListener(id, data => {
-        data = fromJson(data)
-        if (data !== null && typeof data[Symbol.iterator] === 'function') completion(...data)
-        else completion(data)
-    })
+    if (transform === undefined) transform = func => func
+    if (completion !== undefined) eventManager.addListener(id, transform(completion))
+}
+
+export function setDidStartSessionCompletion(completion) {
+    setEvent('didStartSessionEvent', completion)
+}
+
+export function setDidEndSessionCompletion(completion) {
+    setEvent('didEndSessionEvent', completion)
+}
+
+export function setDidStartRestoreSessionCompletion(completion) {
+    setEvent('didStartRestoreSessionEvent', completion)
+}
+
+export function setDidContinueRemoteSessionCompletion(completion) {
+    setEvent('didContinueRemoteSessionEvent', completion)
 }

package/www/react-native/model/workflow.js

@@ -0,0 +1,28 @@
+export class Workflow {
+    id
+    name
+    description
+    version
+    defaultLocale
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new Workflow()
+        result.id = jsonObject["id"]
+        result.name = jsonObject["name"]
+        result.description = jsonObject["description"]
+        result.version = jsonObject["version"]
+        result.defaultLocale = jsonObject["defaultLocale"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "id": this.id,
+            "name": this.name,
+            "description": this.description,
+            "version": this.version,
+            "defaultLocale": this.defaultLocale,
+        }
+    }
+}

package/www/react-native/model/workflow_result.js

@@ -0,0 +1,21 @@
+import { WorkflowStep } from './workflow_step'
+
+export class WorkflowResult {
+    sessionId
+    finalStep
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new WorkflowResult()
+        result.sessionId = jsonObject["sessionId"]
+        result.finalStep = WorkflowStep.fromJson(jsonObject["finalStep"])
+        return result
+    }
+
+    toJson() {
+        return {
+            "sessionId": this.sessionId,
+            "finalStep": this.finalStep?.toJson(),
+        }
+    }
+}

package/www/react-native/model/workflow_step.js

@@ -0,0 +1,19 @@
+export class WorkflowStep {
+    id
+    name
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new WorkflowStep()
+        result.id = jsonObject["id"]
+        result.name = jsonObject["name"]
+        return result
+    }
+
+    toJson() {
+        return {
+            "id": this.id,
+            "name": this.name,
+        }
+    }
+}

package/www/types/config/api_key_connection_config.d.ts

@@ -0,0 +1,6 @@
+export interface ApiKeyConnectionConfig {
+    baseUrl: string
+    apiKey: string
+    ttl?: number
+    httpTimeoutMs?: number
+}

package/www/types/config/credentials_connection_config.d.ts

@@ -0,0 +1,6 @@
+export interface CredentialsConnectionConfig {
+    baseUrl: string
+    userName: string
+    password: string
+    httpTimeoutMs?: number
+}

package/www/types/config/prepare_workflow_config.d.ts

@@ -0,0 +1,3 @@
+export interface PrepareWorkflowConfig {
+    workflowId: string
+}

package/www/types/config/start_workflow_config.d.ts

@@ -0,0 +1,4 @@
+export interface StartWorkflowConfig {
+    locale?: string
+    metadata?: Record<string, any>
+}

package/www/types/config/token_connection_config.d.ts

@@ -0,0 +1,3 @@
+export interface TokenConnectionConfig {
+    url: string
+}

package/www/types/index.d.ts

@@ -1,4 +1,20 @@
+import { TokenConnectionConfig } from './config/token_connection_config'
+import { CredentialsConnectionConfig } from './config/credentials_connection_config'
+import { ApiKeyConnectionConfig } from './config/api_key_connection_config'
+import { PrepareWorkflowConfig } from './config/prepare_workflow_config'
+import { StartWorkflowConfig } from './config/start_workflow_config'
+import { Workflow } from './model/workflow'
+import { WorkflowResult } from './model/workflow_result'
+import { WorkflowStep } from './model/workflow_step'
 
+export { TokenConnectionConfig }
+export { CredentialsConnectionConfig }
+export { ApiKeyConnectionConfig }
+export { PrepareWorkflowConfig }
+export { StartWorkflowConfig }
+export { Workflow }
+export { WorkflowResult }
+export { WorkflowStep }
 
 /**
  * Entry point of the Regula IDV.
@@ -9,4 +25,38 @@ export class IDV {
      */
     static get instance(): IDV
     private constructor()
+
+    setListener(options?: IDVListenerOptions): void
+
+    set sessionRestoreMode(value: SessionRestoreMode)
+
+    getCurrentSessionId(): Promise<string | null>
+
+    initialize(): Promise<[boolean, string | null]>
+
+    deinitialize(): Promise<[boolean, string | null]>
+
+    configureWithToken(config: TokenConnectionConfig): Promise<[string[] | null, string | null]>
+
+    configureWithCredentials(config: CredentialsConnectionConfig): Promise<[boolean, string | null]>
+
+    configureWithApiKey(config: ApiKeyConnectionConfig): Promise<[boolean, string | null]>
+
+    prepareWorkflow(config: PrepareWorkflowConfig): Promise<[Workflow | null, string | null]>
+
+    startWorkflow(config?: StartWorkflowConfig): Promise<[WorkflowResult | null, string | null]>
+
+    getWorkflows(): Promise<[Workflow[] | null, string | null]>
+}
+
+export enum SessionRestoreMode {
+    ENABLED = 0,
+    DISABLED = 1,
+}
+
+export interface IDVListenerOptions {
+    didStartSession?: () => void
+    didEndSession?: () => void
+    didStartRestoreSession?: () => void
+    didContinueRemoteSession?: () => void
 }

package/www/types/model/workflow.d.ts

@@ -0,0 +1,9 @@
+export class Workflow {
+    readonly id: string
+    readonly name: string
+    readonly description: string
+    readonly version: string
+    readonly defaultLocale?: string
+
+    private constructor()
+}

package/www/types/model/workflow_result.d.ts

@@ -0,0 +1,8 @@
+import { WorkflowStep } from './workflow_step'
+
+export class WorkflowResult {
+    readonly sessionId: string
+    readonly finalStep: WorkflowStep
+
+    private constructor()
+}

package/www/types/model/workflow_step.d.ts

@@ -0,0 +1,6 @@
+export class WorkflowStep {
+    readonly id: string
+    readonly name: string
+
+    private constructor()
+}

package/ios/FlutterIDVPlugin.swift

@@ -1,72 +0,0 @@
-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
-}
-
-func argsNullable<T>(_ index: Int) -> T? {
-    if (args[index] is NSNull) { return nil }
-    return args[index] as! T?
-}
-
-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()) })
-    }
-}
-
-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? = {
-    for window in UIApplication.shared.windows {
-        if window.isKeyWindow {
-            return window.rootViewController
-        }
-    }
-    return nil
-}