@regulaforensics/document-reader 8.2.186-beta

package/examples/capacitor/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "document-reader",
+  "scripts": {
+    "setup": "scripts/setup.sh",
+    "ios": "scripts/ios.sh",
+    "android": "scripts/android.sh"
+  },
+  "dependencies": {
+    "@regulaforensics/document-reader": "8.2.186-beta",
+    "@regulaforensics/document-reader-core-fullauthrfid": "8.2.8-beta",
+    "@regulaforensics/document-reader-btdevice": "8.2.8-beta",
+    "@awesome-cordova-plugins/file": "6.6.0",
+    "@awesome-cordova-plugins/camera": "6.6.0",
+    "@awesome-cordova-plugins/dialogs": "6.6.0",
+    "cordova-plugin-file": "8.1.3",
+    "cordova-plugin-camera": "8.0.0",
+    "cordova-plugin-dialogs": "2.0.2",
+    "@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": "^2.3.1",
+    "@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,6 @@
+#!/usr/bin/env bash
+set -e
+
+npm install
+cd ios/App
+pod install || pod update

package/examples/capacitor/src/extra/bt_device.tsx

@@ -0,0 +1,32 @@
+import { DocumentReader, InitConfig } from "@regulaforensics/document-reader"
+import { handleException, setStatus } from "../main"
+
+export const useBtDevice = false
+const btDeviceName = "Regula 0000"
+
+export function setupBTDevice() {
+  document.getElementById("bt-device").style.display = "flex"
+  document.getElementById("connect").onclick = () => connect()
+  setStatus("Connect to a bluetooth device")
+}
+
+async function connect() {
+  setStatus("Searching for devices...")
+  if (await DocumentReader.instance.connectBluetoothDevice(btDeviceName)) {
+    await initializeBTDevice()
+    DocumentReader.instance.functionality.useAuthenticator = true
+    document.getElementById("bt-device").style.display = "none"
+  } else
+    setStatus("Failed to connect")
+}
+
+async function initializeBTDevice() {
+  setStatus("Initializing...")
+
+  var initConfig = InitConfig.withBleDevice()
+  initConfig.delayedNNLoad = true
+  var [success, error] = await DocumentReader.instance.initialize(initConfig)
+
+  handleException(error)
+  return success
+}

package/examples/capacitor/src/extra/custom_rfid.tsx

@@ -0,0 +1,74 @@
+import { DocReaderAction, DocumentReader, Results, RFIDConfig, RFIDDataFileType, RFIDErrorCodes, RFIDNotificationCodes } from "@regulaforensics/document-reader"
+import { displayResults, handleCompletion, setStatus } from "../main"
+
+export enum RfidOption {
+    Basic,
+    Advanced,
+    SelfHostedUI
+}
+
+export const rfidOption: RfidOption = RfidOption.Basic
+
+export function advancedRfid() {
+    var config = new RFIDConfig(handleCompletion)
+
+    config.onChipDetected = () => console.log("Chip detected, reading rfid.")
+    config.onRetryReadChip = async (error) => console.log(await RFIDErrorCodes.getTranslation(error.code) + ". Retrying...")
+
+    DocumentReader.instance.rfid(config)
+}
+
+export function selfHostedUIRfid() {
+    var config = RFIDConfig.withoutUI((action, results, error) => {
+        if (DocReaderAction.stopped(action)) finish(results)
+        if (error != null) {
+            setStatus("Try again")
+            setDescription("Error" + error.message)
+            console.log(error.code + ": " + error.message)
+        }
+    })
+
+    config.onProgress = async (notification) => {
+        if (notification.progress == 1) return
+        if (notification.notificationCode == RFIDNotificationCodes.PCSC_READING_DATAGROUP)
+            setDescription(await RFIDDataFileType.getTranslation(notification.dataFileType))
+        setStatus("Reading RFID")
+        setProgress(notification.progress)
+    }
+
+    setup()
+    DocumentReader.instance.rfid(config)
+}
+
+function finish(results: Results) {
+    DocumentReader.instance.stopRFIDReader()
+    setShowing(false)
+    displayResults(results)
+}
+
+function setup() {
+    document.getElementById("cancel-rfid").onclick = () => finish(null)
+
+    setStatus("Reading RFID")
+    setDescription("Place your phone on top of the NFC tag")
+    setProgress(0)
+    setShowing(true)
+}
+
+var setDescription = (data: string) => document.getElementById("rfid-description").innerHTML = data
+var setProgress = (next: number) => {
+    var progress = document.getElementById("progress")
+    var previous = parseInt(progress.style.width.substring(0, progress.style.width.length - 1))
+    // make progress bar look better
+    if (next <= 0) return // ignore idle 0s, leave progress at 100 while its not moving
+    if (next < previous) next = 0 // move to 0 if progress finaly started moving
+    if (next >= 95) next = 100 // rfid never returns 100 and it looks ugly, fix it
+    if (next < previous) progress.style.transition = 'none' // instantly reset progress
+    else progress.style.transition = 'width 0.5s' // smoothly increase progress
+
+    progress.style.width = next + "%"
+}
+var setShowing = (data: boolean) => {
+    document.getElementById("main").style.display = data ? "none" : "flex"
+    document.getElementById("custom-rfid").style.display = data ? "flex" : "none"
+}

package/examples/capacitor/src/main.css

@@ -0,0 +1,131 @@
+html,
+body {
+    width: 99%;
+    height: 99vh;
+    display: flex;
+    flex-direction: column;
+}
+
+.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);
+}
+
+.title {
+    font-weight: 600;
+    font-size: 18px;
+    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;
+    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,41 @@
+<div class="column" style="height: 100%">
+    <div class="column header">
+        <span id="status" class="title">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="bt-device" class="row" style="display: none;">
+            <input type="text" placeholder="Regula 0000" />
+            <button id="connect" class="button">Connect</button>
+        </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>
+        <div style="padding-top: 20px;"></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>
+        <button id="cancel-rfid" class="text-button" style="margin-top: 50px;">X</button>
+    </div>
+</div>

package/examples/capacitor/src/main.tsx

@@ -0,0 +1,175 @@
+import { setupIonicReact } from '@ionic/react'
+import '@ionic/react/css/core.css'
+import './main.css'
+import { File } from '@awesome-cordova-plugins/file'
+import { DocumentReader, DocReaderException, InitConfig, DocReaderAction, Results, FieldType, GraphicFieldType, ResultType, RFIDConfig, ScannerConfig, Scenario, DocReaderScenario, RecognizeConfig } from '@regulaforensics/document-reader'
+import { StatusBar, Style } from '@capacitor/status-bar'
+import { setupBTDevice, useBtDevice } from './extra/bt_device'
+import { advancedRfid, rfidOption, RfidOption, selfHostedUIRfid } from './extra/custom_rfid'
+import { Camera, DestinationType, MediaType, PictureSourceType } from '@awesome-cordova-plugins/camera'
+
+const documentReader = DocumentReader.instance
+var selectedScenario = Scenario.MRZ
+var doRfid = false
+var isReadingRfid = false
+
+async function init() {
+  if (!await initializeReader()) return
+  setScenarios(documentReader.availableScenarios)
+  setCanRfid(await documentReader.isRFIDAvailableForUse())
+  setStatus("Ready")
+}
+
+async function scan() {
+  if (!await documentReader.isReady()) return
+  clearResults()
+  documentReader.startScanner(
+    ScannerConfig.withScenario(selectedScenario),
+    handleCompletion,
+  )
+}
+
+async function recognize() {
+  if (!await documentReader.isReady()) return
+  var image = await Camera.getPicture({
+    destinationType: DestinationType.DATA_URL,
+    mediaType: MediaType.PICTURE,
+    sourceType: PictureSourceType.PHOTOLIBRARY
+  })
+  clearResults()
+  documentReader.recognize(
+    RecognizeConfig.withScenario(selectedScenario, { image: image }),
+    handleCompletion,
+  )
+}
+
+export function handleCompletion(action: DocReaderAction, results?: Results, error?: DocReaderException) {
+  handleException(error)
+  if (DocReaderAction.stopped(action) && !shouldRfid(results)) {
+    displayResults(results)
+  } else if (DocReaderAction.finished(action) && shouldRfid(results)) {
+    isReadingRfid = true
+    readRfid()
+  }
+}
+
+export async function displayResults(results?: Results) {
+  isReadingRfid = false
+  clearResults()
+  if (results == null) return
+
+  var name = await results.textFieldValueByType(FieldType.SURNAME_AND_GIVEN_NAMES)
+  var docImage = await results.graphicFieldImageByType(GraphicFieldType.DOCUMENT_IMAGE)
+  var portrait = await results.graphicFieldImageByType(GraphicFieldType.PORTRAIT)
+  portrait = await results.graphicFieldImageByTypeSource(GraphicFieldType.PORTRAIT, ResultType.RFID_IMAGE_DATA) ?? portrait
+
+  setStatus(name)
+  setPortrait(portrait)
+  setDocImage(docImage)
+}
+
+var readRfid = () => documentReader.rfid(new RFIDConfig(handleCompletion))
+
+var shouldRfid = (results?: Results) => doRfid && !isReadingRfid && results != null && results.chipPage != 0
+
+async function initializeReader() {
+  setStatus("Initializing...")
+
+  var license = await loadAsset("regula.license")
+  var initConfig = new InitConfig(license)
+  var [success, error] = await documentReader.initialize(initConfig)
+
+  handleException(error)
+  return success
+}
+
+export function handleException(error: DocReaderException) {
+  if (error != null) {
+    setStatus(error.message)
+    console.log(error.code + ": " + error.message)
+  }
+}
+
+// --------------------------------------------------------------------------------------------------------------------
+
+async function loadAsset(path: string): Promise<string> {
+  var dir = await File.resolveDirectoryUrl(File.applicationDirectory + "public/assets")
+  var fileEntry = await File.getFile(dir, path, {})
+  var result = await new Promise<string>((resolve, _) => {
+    fileEntry.file(file => {
+      var reader = new FileReader()
+      reader.onloadend = (_) => resolve(reader.result as string)
+      reader.readAsDataURL(file)
+    })
+  })
+  return result
+}
+
+var documentUIImage: HTMLImageElement
+var portraitUIImage: HTMLImageElement
+document.addEventListener('deviceready', () => {
+  documentUIImage = document.getElementById("document-image") as HTMLImageElement
+  portraitUIImage = document.getElementById("portrait-image") as HTMLImageElement
+  document.getElementById("scan").onclick = () => scan()
+  document.getElementById("recognize").onclick = () => recognize()
+
+  // btDevice
+  if (!useBtDevice) init()
+  else setupBTDevice()
+
+  // rfid
+  if (rfidOption == RfidOption.Advanced) readRfid = () => advancedRfid()
+  if (rfidOption == RfidOption.SelfHostedUI) readRfid = () => selfHostedUIRfid()
+})
+
+export var setStatus = (data: string) => { if (data != null) document.getElementById("status").innerHTML = data }
+var setPortrait = (data: string) => { if (data != null) portraitUIImage.src = "data:image/png;base64," + data }
+var setDocImage = (data: string) => { if (data != null) documentUIImage.src = "data:image/png;base64," + data }
+var clearResults = () => {
+  setStatus("Ready")
+  portraitUIImage.src = "images/portrait.png"
+  documentUIImage.src = "images/document.png"
+}
+var setScenarios = (data: DocReaderScenario[]) => {
+  const scenariosContainer = document.getElementById("scenarios")
+  data.forEach(scenario => scenariosContainer.appendChild(createScenarioElement(scenario)))
+}
+var createScenarioElement = (scenario: DocReaderScenario) => {
+  const div = document.createElement('div')
+  div.className = 'row radio'
+
+  const input = document.createElement('input')
+  input.type = 'radio'
+  input.name = 'scenario'
+  input.value = scenario.name
+  input.checked = scenario.name === selectedScenario
+
+  const span = document.createElement('span')
+  span.style.width = '200px'
+  span.style.paddingLeft = '5px'
+  span.textContent = scenario.caption
+
+  input.onclick = () => selectedScenario = scenario.name as Scenario
+  span.onclick = () => input.click()
+
+  div.appendChild(input)
+  div.appendChild(span)
+
+  return div
+}
+var setCanRfid = (data: boolean) => {
+  var checkbox = document.getElementById('rfid-checkbox') as HTMLInputElement
+  var checkboxDescription = document.getElementById("rfid-checkbox-description")
+  if (data) {
+    checkbox.disabled = false
+    checkbox.onclick = () => {
+      doRfid = !doRfid
+      checkbox.checked = doRfid
+    }
+    checkboxDescription.innerHTML = "Process rfid reading"
+    checkboxDescription.onclick = () => checkbox.click()
+  }
+}
+
+setupIonicReact()
+StatusBar.setStyle({ style: Style.Light })

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/cordova/.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Android on emulator",
+            "type": "cordova",
+            "request": "launch",
+            "platform": "android",
+            "target": "emulator",
+            "port": 9222,
+            "sourceMaps": true,
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "name": "Debug Android on device",
+            "type": "cordova",
+            "request": "launch",
+            "platform": "android",
+            "target": "device",
+            "port": 9222,
+            "sourceMaps": true,
+            "cwd": "${workspaceFolder}"
+        }
+    ]
+}

package/examples/cordova/.vscode/typings/cordova/cordova.d.ts

@@ -0,0 +1,80 @@
+// Type definitions for Apache Cordova
+// Project: http://cordova.apache.org
+// Definitions by: Microsoft Open Technologies Inc. <http://msopentech.com>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+//
+// Copyright (c) Microsoft Open Technologies, Inc.
+// Licensed under the MIT license.
+
+interface Cordova {
+    /** Invokes native functionality by specifying corresponding service name, action and optional parameters.
+     * @param success A success callback function.
+     * @param fail An error callback function.
+     * @param service The service name to call on the native side (corresponds to a native class).
+     * @param action The action name to call on the native side (generally corresponds to the native class method).
+     * @param args An array of arguments to pass into the native environment.
+     */
+    exec(success: () => any, fail: () => any, service: string, action: string, args?: string[]): void;
+    /** Gets the operating system name. */
+    platformId: string;
+    /** Gets Cordova framework version */
+    version: string;
+    /** Defines custom logic as a Cordova module. Other modules can later access it using module name provided. */
+    define(moduleName: string, factory: (require: any, exports: any, module: any) => any): void;
+    /** Access a Cordova module by name. */
+    require(moduleName: string): any;
+    /** Namespace for Cordova plugin functionality */
+    plugins:CordovaPlugins;
+}
+
+interface CordovaPlugins {}
+
+interface Document {
+    addEventListener(type: "deviceready", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "pause", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "resume", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "backbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "menubutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "searchbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "startcallbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "endcallbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "volumedownbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    addEventListener(type: "volumeupbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+
+    removeEventListener(type: "deviceready", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "pause", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "resume", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "backbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "menubutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "searchbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "startcallbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "endcallbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "volumedownbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: "volumeupbutton", listener: (ev: Event) => any, useCapture?: boolean): void;
+
+    addEventListener(type: string, listener: (ev: Event) => any, useCapture?: boolean): void;
+    removeEventListener(type: string, listener: (ev: Event) => any, useCapture?: boolean): void;
+}
+
+interface Window {
+  cordova:Cordova;
+}
+
+// cordova/argscheck module
+interface ArgsCheck {
+    checkArgs(argsSpec: string, functionName: string, args: any[], callee?: any): void;
+    getValue(value?: any, defaultValue?: any): any;
+    enableChecks: boolean;
+}
+
+// cordova/urlutil module
+interface UrlUtil {
+    makeAbsolute(url: string): string
+}
+
+/** Apache Cordova instance */
+declare var cordova: Cordova;
+
+declare module 'cordova' {
+    export = cordova;
+}

package/examples/cordova/README.md

@@ -0,0 +1,12 @@
+# Regula Document Reader Cordova demo application
+
+## How to build demo application
+1. Download or the clone current repository using the command `git clone https://github.com/regulaforensics/npm-document-reader.git`.
+
+2. Execute `npm run setup` within this directory.
+
+3. Run the app: 
+  * IOS: `npm run ios`.
+  * Android: `npm run android`.
+
+**Note**: this 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.