@regulaforensics/idv 3.10.230-beta → 3.10.239-rc

package/examples/capacitor/package.json

@@ -6,11 +6,11 @@
     "android": "scripts/android.sh"
   },
   "dependencies": {
-    "@regulaforensics/idv": "3.10.230-beta",
-    "@regulaforensics/idv-module-document-reader": "3.10.294-beta",
-    "@regulaforensics/idv-module-face": "3.10.295-beta",
-    "@regulaforensics/document-reader-core-fullauthrfid": "9.9.3183-beta",
-    "@regulaforensics/face-core-basic": "8.4.854-beta",
+    "@regulaforensics/idv": "3.10.239-rc",
+    "@regulaforensics/idv-module-document-reader": "3.10.288-rc",
+    "@regulaforensics/idv-module-face": "3.10.289-rc",
+    "@regulaforensics/document-reader-core-fullauthrfid": "9.9.3273-rc",
+    "@regulaforensics/face-core-basic": "8.4.877-rc",
     "@capacitor/cli": "^8.5.2",
     "@capacitor/core": "^8.5.2",
     "@capacitor/ios": "^8.5.2",

package/examples/capacitor/src/main.tsx

@@ -9,29 +9,65 @@ const password = "password_placeholder"
 const tokenUrl = "token_placeholder"
 const apiKey = "api_key_placeholder"
 
-var idv = IDV.instance
 var selectedWorkflow = ""
-var workflowIds: string[] = []
+
+var idv = IDV.instance
+var workflowFilter: string[] = []
 
 async function init() {
+    setStatus("Initializing...")
     var [_, iError] = await idv.initialize()
     if (handleException(iError, "initialize")) return
 
-    var success = ({
+    var login = ({
         [Configuration.credentials]: async () => await configureWithCredentials(),
         [Configuration.token]: async () => await configureWithToken(),
         [Configuration.apiKey]: async () => await configureApiKey(),
     })[loginType]!
-    if (!await success()) return
+    if (!await login()) return
+
+    if (selectedWorkflow.length > 0) {
+        workflowFilter = [] // Reset the filter in case both workflow and filter are specified.
+        // Show a list of 1 element just to show the workflow name.
+        var workflow = await prepareSelectedWorkflow()
+        if (workflow != null) setWorkflows([workflow])
+        return
+    }
+    if (workflowFilter.length > 0) {
+        showWorkflowList()
+        return
+    }
+    setStatus("No workflow selected!")
+    setDescription("Manually set `selectedWorkflow` to your workflow ID")
+}
 
-    var [wfs, error] = await idv.getWorkflows()
+async function showWorkflowList() {
+    setStatus("Fetching workflows...")
+    let [wfs, error] = await idv.getWorkflows()
     if (handleException(error, "getWorkflows")) return
-    if (loginType == Configuration.token) {
-        wfs = wfs!.filter((wf: any) => workflowIds.includes(wf.id))
+    wfs = workflowFilter.flatMap(id => wfs!.filter(wf => wf.id === id))
+    if (wfs.length > 0) {
+        setWorkflows(wfs)
+        return
     }
+    setStatus("Empty workflow list!")
+    setDescription("No workflows remain after filtration")
+}
 
-    setWorkflows(wfs!)
-    setStatus("Ready")
+async function prepareSelectedWorkflow() {
+    setStatus("Preparing Workflow...")
+    const [workflow, prepareError] = await idv.prepareWorkflow({ workflowId: selectedWorkflow })
+    handleException(prepareError, "prepareWorkflow")
+    return workflow
+}
+
+async function startWorkflow(): Promise<void> {
+    // If workflow is chosen from the list then it's not prepared yet.
+    if (workflowFilter.length > 0 && await prepareSelectedWorkflow() == null) return
+    var [result, error] = await idv.startWorkflow()
+    if (handleException(error, "startWorkflow")) return
+    setStatus("Success")
+    setDescription(`SessionID: ${result?.sessionId}`)
 }
 
 async function configureWithCredentials(): Promise<boolean> {
@@ -45,9 +81,10 @@ async function configureWithCredentials(): Promise<boolean> {
 }
 
 async function configureWithToken(): Promise<boolean> {
-    var [wfIds, error] = await idv.configureWithToken({ url: tokenUrl })
+    var [workflowIds, error] = await idv.configureWithToken({ url: tokenUrl })
     if (handleException(error, "configureWithToken")) return false
-    workflowIds = wfIds!
+    // Filter the IDs to the ones allowed by the token.
+    workflowFilter = workflowFilter.filter(wf => workflowIds!.includes(wf))
     return true
 }
 
@@ -57,20 +94,6 @@ async function configureApiKey(): Promise<boolean> {
     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}()`)
@@ -97,9 +120,8 @@ var workflows: Workflow[] = []
 function setWorkflows(data: Workflow[]) {
     var radioGroup = document.getElementById("radio-group")!
     workflows = data
-    if (workflows.length != 0) {
-        selectedWorkflow = workflows[0].id
-    }
+    selectedWorkflow = workflows[0].id
+    setStatus("Ready")
 
     data.forEach(item => {
         var checked = selectedWorkflow == item.id ? "checked" : ""

package/examples/ionic/README.md

@@ -7,11 +7,11 @@ Requires Node.js 22+, Xcode 26+, Android Studio with JDK 17 and Android SDK 36.
 2. Put `regula.license` file at `assets/` (you can get a trial license [here](https://client.regulaforensics.com)).
 3. Put `db.dat` file at `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`.
+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`. Then set your workflow ID(`selectedWorkflow` variable).
 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.
+7. After initialization click the **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.