@regulaforensics/idv 4.0.169-nightly → 4.0.290-rc

package/examples/ionic/package.json

@@ -7,35 +7,38 @@
     "postinstall": "patch-package"
   },
   "dependencies": {
-    "@regulaforensics/idv": "4.0.169-nightly",
-    "@regulaforensics/idv-module-document-reader": "4.0.184-nightly",
-    "@regulaforensics/idv-module-face": "4.0.185-nightly",
-    "@regulaforensics/document-reader-core-fullauthrfid": "9.8.2742-nightly",
-    "@regulaforensics/face-core-basic": "8.3.689-nightly",
-    "@angular-devkit/build-angular": "^22.0.5",
-    "@angular/cli": "^22.0.5",
-    "@angular/common": "^22.0.5",
-    "@angular/compiler-cli": "^22.0.5",
-    "@angular/core": "^22.0.5",
-    "@angular/forms": "^22.0.5",
-    "@angular/platform-browser-dynamic": "^22.0.5",
-    "@angular/router": "^22.0.5",
-    "@ionic/angular": "^8.8.13",
-    "@ionic/cordova-builders": "^12.3.0",
-    "cordova-android": "^15.0.0",
+    "@regulaforensics/idv": "4.0.290-rc",
+    "@regulaforensics/idv-module-document-reader": "4.0.438-rc",
+    "@regulaforensics/idv-module-face": "4.0.439-rc",
+    "@regulaforensics/document-reader-core-fullauthrfid": "9.10.3518-rc",
+    "@regulaforensics/face-core-basic": "8.5.909-rc",
+    "@angular-devkit/build-angular": "^22.1.8",
+    "@angular/cli": "^22.1.8",
+    "@angular/common": "^22.1.7",
+    "@angular/compiler-cli": "^22.1.7",
+    "@angular/core": "^22.1.7",
+    "@angular/forms": "^22.1.7",
+    "@angular/platform-browser-dynamic": "^22.1.7",
+    "@angular/router": "^22.1.7",
+    "@ionic/cli": "^7.2.1",
+    "@ionic/angular": "^9.0.4",
+    "@ionic/cordova-builders": "^13.0.0",
+    "cordova": "^13.0.0",
+    "cordova-android": "^15.1.0",
     "cordova-ios": "^8.1.1",
     "cordova-plugin-ionic-webview": "^5.0.1",
-    "patch-package": "^8.0.1"
+    "native-run": "^2.0.3",
+    "patch-package": "^8.0.1",
+    "@angular/compiler": "^22.1.7",
+    "@angular/platform-browser": "^22.1.7",
+    "zone.js": "~0.16.3",
+    "typescript": "~6.0.3"
   },
   "overrides": {
-    "@babel/core": "^7.29.0",
-    "ajv": "^8.18.0",
-    "esbuild": "^0.28.1",
-    "http-proxy-middleware": "^3.0.7",
-    "picomatch": "^4.0.4",
-    "serialize-javascript": "^7.0.4",
-    "uuid": "^14.0.0",
-    "webpack-dev-server": "^5.2.4"
+    "serialize-javascript": "^7.1.2",
+    "uuid": "^11.1.1",
+    "source-map-js": "^1.2.2",
+    "shell-quote": "^1.11.0"
   },
   "cordova": {
     "plugins": {

package/examples/ionic/scripts/android.sh

@@ -2,10 +2,8 @@
 set -e
 
 if [[ " $* " == *" --open "* ]] || [[ " $* " == *" -o "* ]]; then
-    ionic cordova build android
+    ionic cordova prepare android
     open -a 'Android Studio' platforms/android
 else
     ionic cordova run android
 fi
-
-exit 0

package/examples/ionic/scripts/ios.sh

@@ -5,7 +5,7 @@ if [[ " $* " == *" --open "* ]] || [[ " $* " == *" -o "* ]]; then
     ionic cordova prepare ios
     open platforms/ios/App.xcworkspace
 else
-    ionic cordova run ios
+    ionic cordova build ios --device
+    # Use the .app directly to bypass Ionic's outdated IPA path and ZIP extraction.
+    native-run ios --app platforms/ios/App.xcarchive/Products/Applications/IDV.app --device
 fi
-
-exit 0

package/examples/ionic/scripts/setup.sh

@@ -6,5 +6,3 @@ ionic cordova prepare || {
     pod repo update
     ionic cordova prepare
 }
-
-exit 0

package/examples/ionic/src/main.tsx

@@ -3,35 +3,71 @@ import { IDV, Workflow } from '@regulaforensics/idv'
 enum Configuration { credentials, token, apiKey }
 
 const loginType: Configuration = Configuration.credentials
-const baseUrl = "https://idv.regula.app"
+const baseUrl = "https://app.idv-platform.com"
 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[] = []
+
+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/tsconfig.json

@@ -9,6 +9,5 @@
     "experimentalDecorators": true,
     "target": "es2022",
     "jsx": "react-jsx",
-    "skipLibCheck": true, // Temp fix for https://github.com/ionic-team/ionic-framework/issues/30650
   }
 }

package/examples/react_native/README.md

@@ -1,15 +1,17 @@
 # Regula IDV React Native demo application
 
+Requires Node.js 22+, Xcode 26+, CocoaPods, Android Studio with JDK 17 and Android SDK 37.
+
 ## 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 `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. Just don't forget to make sure that Metro Bundler is running(`npm start`).
+**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/react_native/app.config.ts

@@ -36,17 +36,19 @@ export default ({ config }: ConfigContext): ExpoConfig => ({
   },
   plugins: [
     '@regulaforensics/idv',
+    './scripts/withoutMetroServer',
     ['expo-custom-assets', { assetsPaths: ['./assets'] }],
     ['expo-build-properties', {
+      ios: { networkInspector: false },
       android: {
+        networkInspector: false,
         extraMavenRepos: [
           { url: 'https://maven.regulaforensics.com/RegulaDocumentReader' },
           { url: 'https://maven.regulaforensics.com/RegulaDocumentReader/Beta' },
           { url: 'https://maven.regulaforensics.com/RegulaDocumentReader/Nightly' },
           { url: 'https://maven.regulaforensics.com/RegulaDocumentReader/Stage' }
         ]
-      },
-      ios: { networkInspector: false }
+      }
     }]
   ]
 })

package/examples/react_native/index.tsx

@@ -1,6 +1,8 @@
 import { registerRootComponent } from 'expo'
 import WebView from 'react-native-webview'
 import React from 'react'
+import * as RNFS from 'react-native-fs'
+import { Platform } from 'react-native'
 import { main } from './src/main'
 
 var webViewRef: any
@@ -47,17 +49,45 @@ const document = {
 }
 
 function parseValue(value: any) {
-  if (value !== true && value !== false) return `"${value}"`
-  return value
+  const json = JSON.stringify(value)
+  return typeof value === 'string' ? `(window.webImages[${json}] ?? ${json})` : json
+}
+
+async function loadWebUI() {
+  const webRoot = Platform.OS === 'ios' ? RNFS.MainBundlePath + '/web/' : 'web/'
+  const readWebFile = Platform.OS === 'ios' ? RNFS.readFile : RNFS.readFileAssets
+  const readWebDir = Platform.OS === 'ios' ? RNFS.readDir : RNFS.readDirAssets
+  const webImages: Record<string, string> = {}
+  const [styles, content] = await Promise.all(['src/main.css', 'src/main.html'].map(path => readWebFile(webRoot + path, 'utf8')))
+
+  for (const file of (await readWebDir(webRoot + 'images')).filter(file => file.isFile())) {
+    const extension = file.name.split('.').pop()!.toLowerCase()
+    const type = ({ jpg: 'jpeg', svg: 'svg+xml' } as Record<string, string>)[extension] ?? extension
+    webImages['images/' + file.name] = `data:image/${type};base64,${await readWebFile(file.path, 'base64')}`
+  }
+
+  const html = content.replace(/src="([^"]+)"/g, (match, path) => webImages[path] ? `src="${webImages[path]}"` : match)
+  return `<meta name="viewport" content="initial-scale=1, user-scalable=no, viewport-fit=cover">
+<style>${styles}</style>
+<div id="content" style="height: 100%">${html}</div>
+<script>
+  window.webImages = ${JSON.stringify(webImages)};
+  requestAnimationFrame(() => requestAnimationFrame(() => {
+    window.ReactNativeWebView.postMessage(JSON.stringify({ id: "ready" }))
+  }))
+</script>`
 }
 
 (globalThis as any).document = document;
-registerRootComponent(() =>
-  <WebView
+registerRootComponent(() => {
+  const [html, setHtml] = React.useState('')
+  React.useEffect(() => { loadWebUI().then(setHtml).catch(console.error) }, [])
+  return html ? <WebView
     ref={ref => { webViewRef = ref }}
     onMessage={onMessage}
-    source={require("./index.html")}
+    originWhitelist={['*']}
+    source={{ html }}
     scrollEnabled={false}
     overScrollMode={'content'}
-  />
-)
+  /> : null
+})

package/examples/react_native/metro.config.js

@@ -1,7 +1,5 @@
 const config = require('expo/metro-config').getDefaultConfig(__dirname)
 config.watchFolders = [
-    __dirname + '/node_modules'
 ]
-config.resolver.nodeModulesPaths = config.watchFolders
-config.resolver.assetExts.push('css')
+config.resolver.nodeModulesPaths = [__dirname + '/node_modules']
 module.exports = config