@regulaforensics/idv 3.2.1-nightly

package/examples/capacitor/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "idv",
+  "scripts": {
+    "setup": "scripts/setup.sh",
+    "ios": "scripts/ios.sh",
+    "android": "scripts/android.sh"
+  },
+  "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",
+    "@capacitor/cli": "7.0.1",
+    "@capacitor/core": "7.0.1",
+    "@capacitor/app": "7.0.0",
+    "@capacitor/ios": "7.0.1",
+    "@capacitor/android": "7.0.1",
+    "@capacitor/status-bar": "7.0.0",
+    "@ionic/react": "8.4.3",
+    "@vitejs/plugin-react": "4.3.4",
+    "vite-plugin-static-copy": "3.1.2",
+    "@types/react-router-dom": "5.3.3"
+  }
+}

package/examples/capacitor/scripts/android.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    ionic cap sync android
+    studio android || open -a 'Android Studio' android
+else
+    ionic cap run android
+fi

package/examples/capacitor/scripts/ios.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    ionic cap run ios --open
+else
+    ionic cap run ios
+fi

package/examples/capacitor/scripts/setup.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -e
+
+npm install
+ionic cap sync ios || {
+    cd ios/App
+    pod update
+    cd ../../
+}
+
+cp public/assets/regula.license ios/App/App/
+cp public/assets/db.dat ios/App/App/
+cp public/assets/regula.license android/app/src/main/assets/Regula/
+cp public/assets/db.dat android/app/src/main/assets/Regula/

package/examples/capacitor/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/capacitor/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/capacitor/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/examples/capacitor/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx"
+  }
+}

package/examples/capacitor/vite.config.ts

@@ -0,0 +1,17 @@
+import react from '@vitejs/plugin-react'
+import { defineConfig } from 'vite'
+import { viteStaticCopy } from 'vite-plugin-static-copy';
+
+export default defineConfig({
+  plugins: [
+    react(),
+    viteStaticCopy({
+      targets: [
+        {
+          src: 'src/main.html',
+          dest: '.'
+        }
+      ]
+    })],
+  build: { outDir: 'www' }
+})

package/examples/ionic/README.md

@@ -0,0 +1,15 @@
+# Regula IDV Ionic demo application
+
+## 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`.
+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.
+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.

package/examples/ionic/angular.json

@@ -0,0 +1,39 @@
+{
+  "version": 1,
+  "projects": {
+    "app": {
+      "root": "",
+      "sourceRoot": "src",
+      "projectType": "application",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "www",
+            "index": "index.html",
+            "main": "index.tsx",
+            "tsConfig": "tsconfig.json",
+            "assets": [
+              {
+                "glob": "**/*",
+                "input": "assets",
+                "output": "assets"
+              },
+              {
+                "glob": "**/*",
+                "input": "images",
+                "output": "images"
+              }
+            ]
+          }
+        },
+        "ionic-cordova-build": {
+          "builder": "@ionic/cordova-builders:cordova-build",
+          "options": {
+            "browserTarget": "app:build"
+          }
+        }
+      }
+    }
+  }
+}

package/examples/ionic/config.xml

@@ -0,0 +1,60 @@
+<?xml version='1.0' encoding='utf-8'?>
+<widget android-packageName="com.regula.example.idv.ionic" ios-CFBundleIdentifier="com.regula.example.idv.ionic" version="1.0.0"
+    xmlns:android="http://schemas.android.com/apk/res/android">
+    <name>IDV</name>
+    <icon src="images/icon.png" />
+    <platform name="android">
+        <resource-file src="assets/regula.license" target="app/src/main/assets/Regula/regula.license" />
+        <resource-file src="assets/db.dat" target="app/src/main/assets/Regula/db.dat" />
+        <preference name="orientation" value="portrait" />
+        <preference name="AndroidEdgeToEdge" value="true" />
+        <preference name="android-minSdkVersion" value="24" />
+        <preference name="android-targetSdkVersion" value="36" />
+        <preference name="GradlePluginKotlinEnabled" value="true" />
+        <preference name="GradlePluginKotlinVersion" value="2.1.20" />
+        <config-file parent="/*" target="AndroidManifest.xml">
+            <uses-permission android:name="android.permission.NFC" />
+        </config-file>
+        <edit-config file="app/src/main/AndroidManifest.xml" mode="merge" target="/manifest/application">
+            <application android:usesCleartextTraffic="true" />
+        </edit-config>
+    </platform>
+    <platform name="ios">
+        <resource-file src="assets/regula.license" />
+        <resource-file src="assets/db.dat" />
+        <preference name="deployment-target" value="14.0" />
+        <preference name="orientation" value="portrait" />
+        <allow-intent href="itms:*" />
+        <allow-intent href="itms-apps:*" />
+        <config-file parent="NSCameraUsageDescription" target="*-Info.plist">
+            <string>To use camera</string>
+        </config-file>
+        <config-file parent="NSPhotoLibraryUsageDescription" target="*-Info.plist">
+            <string>To pick images</string>
+        </config-file>
+        <config-file parent="NFCReaderUsageDescription" target="*-Info.plist">
+            <string>To use NFC</string>
+        </config-file>
+        <config-file parent="com.apple.developer.nfc.readersession.iso7816.select-identifiers" target="*-Info.plist">
+            <array>
+                <string>A0000002471001</string>
+                <string>E80704007F00070302</string>
+                <string>A000000167455349474E</string>
+                <string>A0000002480100</string>
+                <string>A0000002480200</string>
+                <string>A0000002480300</string>
+                <string>A00000045645444C2D3031</string>
+            </array>
+        </config-file>
+        <config-file parent="com.apple.developer.nfc.readersession.formats" target="*-Debug.plist">
+            <array>
+                <string>TAG</string>
+            </array>
+        </config-file>
+        <config-file parent="com.apple.developer.nfc.readersession.formats" target="*-Release.plist">
+            <array>
+                <string>TAG</string>
+            </array>
+        </config-file>
+    </platform>
+</widget>

package/examples/ionic/index.html

@@ -0,0 +1,19 @@
+<head>
+  <meta name="viewport"
+    content="viewport-fit=cover, width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no" />
+  <base href="/" />
+</head>
+
+<body>
+  <ion-app>
+    <app-root></app-root>
+  </ion-app>
+</body>
+
+<style>
+  html,
+  body {
+    height: 100%;
+    margin: 0;
+  }
+</style>

package/examples/ionic/index.tsx

@@ -0,0 +1,32 @@
+import 'zone.js';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'
+import { BrowserModule } from '@angular/platform-browser'
+import { IonicModule, Platform } from '@ionic/angular'
+import { NgModule } from '@angular/core'
+import { Component } from '@angular/core'
+
+import { main } from './src/main'
+
+@Component({
+    selector: 'app-root',
+    templateUrl: 'src/main.html',
+    styleUrl: 'src/main.css'
+})
+class Main {
+    constructor(platform: Platform) {
+        (async () => {
+            await platform.ready()
+            await new Promise(resolve => requestAnimationFrame(() => requestAnimationFrame(resolve)))
+            main()
+        })()
+    }
+}
+
+@NgModule({
+    bootstrap: [Main],
+    providers: [Platform],
+    imports: [BrowserModule, IonicModule.forRoot()]
+})
+class MainModule { }
+
+platformBrowserDynamic().bootstrapModule(MainModule)

package/examples/ionic/ionic.config.json

@@ -0,0 +1,7 @@
+{
+  "name": "IDV",
+  "integrations": {
+    "cordova": {}
+  },
+  "type": "angular"
+}