@regulaforensics/document-reader 8.3.242-beta → 8.3.272-beta

package/README.md

@@ -1,10 +1,9 @@
 # Regula Document Reader plugin
-Document Reader allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely offline on your device. This plugin makes possible to use it with react-native, cordova and ionic applications.
+Document Reader allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely offline on your device. This plugin makes possible to use it with react-native, cordova and capacitor applications.
 
 ## Demo applications
-In the [examples](examples/) folder you can find 4 demo applications:
+In the [examples](examples/) folder you can find 3 demo applications:
 * [React-native](examples/react-native)
-* [Cordova](examples/cordova)
 * [Ionic(ionic app with cordova, angular)](examples/ionic)
 * [Capacitor(ionic app with capacitor, react)](examples/capacitor)
 

package/RNDocumentReader.podspec

@@ -5,7 +5,7 @@ source = File.join(__dir__, 'ios')
 
 Pod::Spec.new do |s|
   s.name         = 'RNDocumentReader'
-  s.version      = '8.3.242-beta'
+  s.version      = '8.3.272-beta'
   s.summary      = package['description']
   s.license      = package['license']
 

package/examples/capacitor/README.md

@@ -2,9 +2,7 @@
 
 ## 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`.
@@ -15,7 +13,7 @@
 
 ### Bluetooth device
 
-In order to connect to an external scanning device, change the `useBtDevice` constant to true in `src/extra/bt_device`, and set `btDeviceName` to the name of you device. After running the app, click `Connect`.
+In order to connect to an external scanning device, change the `useBtDevice` constant to true in `src/extra/bt_device`, and set `btDeviceName` to the name of your device. After running the app, click `Connect`.
 
 ### RFID self hosted UI
 

package/examples/capacitor/ios/App/App/App.entitlements

@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
-<dict/>
+<dict>
+	<key>com.apple.developer.nfc.readersession.formats</key>
+	<array>
+		<string>TAG</string>
+	</array>
+</dict>
 </plist>

package/examples/capacitor/ios/App/App/Info.plist

@@ -1,53 +1,67 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
-<dict>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>en</string>
-	<key>CFBundleDisplayName</key>
-	<string>DocumentReader</string>
-	<key>CFBundleExecutable</key>
-	<string>$(EXECUTABLE_NAME)</string>
-	<key>CFBundleIdentifier</key>
-	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>$(PRODUCT_NAME)</string>
-	<key>CFBundlePackageType</key>
-	<string>APPL</string>
-	<key>CFBundleShortVersionString</key>
-	<string>$(MARKETING_VERSION)</string>
-	<key>CFBundleVersion</key>
-	<string>$(CURRENT_PROJECT_VERSION)</string>
-	<key>LSRequiresIPhoneOS</key>
-	<true/>
-	<key>NSAppTransportSecurity</key>
 	<dict>
-		<key>NSAllowsArbitraryLoads</key>
+		<key>CFBundleDevelopmentRegion</key>
+		<string>en</string>
+		<key>CFBundleDisplayName</key>
+		<string>DocumentReader</string>
+		<key>CFBundleExecutable</key>
+		<string>$(EXECUTABLE_NAME)</string>
+		<key>CFBundleIdentifier</key>
+		<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+		<key>CFBundleInfoDictionaryVersion</key>
+		<string>6.0</string>
+		<key>CFBundleName</key>
+		<string>$(PRODUCT_NAME)</string>
+		<key>CFBundlePackageType</key>
+		<string>APPL</string>
+		<key>CFBundleShortVersionString</key>
+		<string>$(MARKETING_VERSION)</string>
+		<key>CFBundleVersion</key>
+		<string>$(CURRENT_PROJECT_VERSION)</string>
+		<key>LSRequiresIPhoneOS</key>
 		<true/>
+		<key>NSAppTransportSecurity</key>
+		<dict>
+			<key>NSAllowsArbitraryLoads</key>
+			<true/>
+		</dict>
+		<key>NSCameraUsageDescription</key>
+		<string></string>
+		<key>NSPhotoLibraryUsageDescription</key>
+		<string></string>
+		<key>NSBluetoothAlwaysUsageDescription</key>
+		<string></string>
+		<key>UILaunchStoryboardName</key>
+		<string>LaunchScreen</string>
+		<key>UIMainStoryboardFile</key>
+		<string>Main</string>
+		<key>UIRequiredDeviceCapabilities</key>
+		<array>
+			<string>armv7</string>
+		</array>
+		<key>UISupportedInterfaceOrientations</key>
+		<array>
+			<string>UIInterfaceOrientationPortrait</string>
+		</array>
+		<key>UISupportedInterfaceOrientations~ipad</key>
+		<array>
+			<string>UIInterfaceOrientationPortrait</string>
+		</array>
+		<key>UIViewControllerBasedStatusBarAppearance</key>
+		<true/>
+		<key>NFCReaderUsageDescription</key>
+		<string>To use NFC</string>
+		<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
+		<array>
+			<string>A0000002471001</string>
+			<string>E80704007F00070302</string>
+			<string>A000000167455349474E</string>
+			<string>A0000002480100</string>
+			<string>A0000002480200</string>
+			<string>A0000002480300</string>
+			<string>A00000045645444C2D3031</string>
+		</array>
 	</dict>
-	<key>NSCameraUsageDescription</key>
-	<string></string>
-	<key>NSPhotoLibraryUsageDescription</key>
-	<string></string>
-	<key>UILaunchStoryboardName</key>
-	<string>LaunchScreen</string>
-	<key>UIMainStoryboardFile</key>
-	<string>Main</string>
-	<key>UIRequiredDeviceCapabilities</key>
-	<array>
-		<string>armv7</string>
-	</array>
-	<key>UISupportedInterfaceOrientations</key>
-	<array>
-		<string>UIInterfaceOrientationPortrait</string>
-	</array>
-	<key>UISupportedInterfaceOrientations~ipad</key>
-	<array>
-		<string>UIInterfaceOrientationPortrait</string>
-	</array>
-	<key>UIViewControllerBasedStatusBarAppearance</key>
-	<true/>
-</dict>
 </plist>

package/examples/capacitor/package.json

@@ -6,9 +6,9 @@
     "android": "scripts/android.sh"
   },
   "dependencies": {
-    "@regulaforensics/document-reader": "8.3.242-beta",
-    "@regulaforensics/document-reader-core-fullauthrfid": "8.3.9-beta",
-    "@regulaforensics/document-reader-btdevice": "8.3.10-beta",
+    "@regulaforensics/document-reader": "8.3.272-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",

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

@@ -5,7 +5,7 @@ export const useBtDevice = false
 export const btDeviceName = "Regula 0000"
 
 export function setupBTDevice() {
-  var connectButton = document.getElementById("connect")
+  var connectButton = document.getElementById("connect")!
   connectButton.style.display = "flex"
   connectButton.onclick = () => connect()
   setStatus("Connect to a bluetooth device")
@@ -16,7 +16,7 @@ async function connect() {
   if (await DocumentReader.instance.connectBluetoothDevice(btDeviceName)) {
     await init()
     DocumentReader.instance.functionality.useAuthenticator = true
-    document.getElementById("bt-device").style.display = "none"
+    document.getElementById("connect")!.style.display = "none"
   } else
     setStatus("Failed to connect")
 }

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

@@ -28,7 +28,7 @@ function setup() {
     setProgress(-1)
     currentProgress = -1
     setShowing(true)
-    document.getElementById("cancel-rfid").onclick = () => stop()
+    document.getElementById("cancel-rfid")!.onclick = () => stop()
 }
 
 function stop() {
@@ -37,13 +37,13 @@ function stop() {
     setShowing(false)
 }
 
-function setDescription(data) {
-    document.getElementById("rfid-description").innerHTML = data
+function setDescription(data: string) {
+    document.getElementById("rfid-description")!.innerHTML = data
 }
 
 var currentProgress = -1
-function setProgress(next) {
-    var progress = document.getElementById("progress")
+function setProgress(next: number) {
+    var progress = document.getElementById("progress")!
     // make progress bar look better
     if (next == 0) return // ignore idle 0s, leave progress at 100 while its not moving
     if (next < currentProgress) next = 0 // move to 0 if progress finaly started moving
@@ -55,7 +55,7 @@ function setProgress(next) {
     currentProgress = next
 }
 
-function setShowing(data) {
-    document.getElementById("main").style.display = data ? "none" : "flex"
-    document.getElementById("custom-rfid").style.display = data ? "flex" : "none"
+function 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

@@ -8,6 +8,19 @@ body {
     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;
+}
+
+/* Prevent image dragging */
+img {
+    pointer-events: none;
+}
+
 .column {
     display: flex;
     flex-direction: column;
@@ -131,4 +144,4 @@ input[type="text"] {
     height: 20px;
     background-color: #4285F4;
     border-radius: 5px;
-}
+}

package/examples/capacitor/src/main.html

@@ -33,6 +33,6 @@
         <div class="progress-bar">
             <div id="progress"></div>
         </div>
-        <button id="cancel-rfid" class="text-button" style="margin-top: 50px;">X</button>
+        <button id="cancel-rfid" class="text-button" style="margin-top: 50px; padding-bottom: 100px;">X</button>
     </div>
 </div>

package/examples/capacitor/src/main.tsx

@@ -1,10 +1,10 @@
-import { DocumentReader, DocReaderAction, FieldType, GraphicFieldType, InitConfig, RecognizeConfig, ResultType, RFIDConfig, ScannerConfig, Scenario } from '@regulaforensics/document-reader'
+import { DocumentReader, DocReaderAction, FieldType, GraphicFieldType, InitConfig, RecognizeConfig, ResultType, RFIDConfig, ScannerConfig, Scenario, Results, DocReaderException, DocReaderScenario } from '@regulaforensics/document-reader'
 import { loadAsset, pickImage } from '../index'
 import { initializeWithBTDevice, setupBTDevice, useBtDevice } from './extra/bt_device'
 import { useRfidSelfHostedUI, rfidSelfHostedUI } from './extra/custom_rfid'
 
 var documentReader = DocumentReader.instance
-var selectedScenario
+var selectedScenario = Scenario.MRZ
 var doRfid = false
 var isReadingRfid = false
 
@@ -36,7 +36,7 @@ async function recognize() {
   )
 }
 
-export function handleCompletion(action, results, error) {
+export function handleCompletion(action: DocReaderAction, results: Results | null, error: DocReaderException | null) {
   handleException(error)
   if (DocReaderAction.stopped(action) && !shouldRfid(results)) {
     displayResults(results)
@@ -46,7 +46,7 @@ export function handleCompletion(action, results, error) {
   }
 }
 
-export async function displayResults(results) {
+export async function displayResults(results: Results | null) {
   isReadingRfid = false
   clearResults()
   if (results == null) return
@@ -65,7 +65,7 @@ var readRfid = () => {
   documentReader.rfid(new RFIDConfig(handleCompletion))
 }
 
-function shouldRfid(results) {
+function shouldRfid(results: Results | null) {
   return doRfid &&
     !isReadingRfid &&
     results != null && results.chipPage != 0
@@ -76,13 +76,14 @@ var initialize = async () => {
 
   var license = await loadAsset("regula.license")
   var initConfig = new InitConfig(license)
+  initConfig.delayedNNLoad = true
   var [success, error] = await documentReader.initialize(initConfig)
 
   handleException(error)
   return success
 }
 
-export function handleException(error) {
+export function handleException(error: DocReaderException | null) {
   if (error != null) {
     setStatus(error.message)
     console.log(error.code + ": " + error.message)
@@ -91,13 +92,13 @@ export function handleException(error) {
 
 // --------------------------------------------------------------------------------------------------------------------
 
-var documentUIImage
-var portraitUIImage
+var documentUIImage: HTMLImageElement
+var portraitUIImage: HTMLImageElement
 export function main() {
-  documentUIImage = document.getElementById("document-image")
-  portraitUIImage = document.getElementById("portrait-image")
-  document.getElementById("scan").onclick = () => scan()
-  document.getElementById("recognize").onclick = () => recognize()
+  documentUIImage = document.getElementById("document-image") as HTMLImageElement
+  portraitUIImage = document.getElementById("portrait-image") as HTMLImageElement
+  document.getElementById("scan")!.onclick = () => scan()
+  document.getElementById("recognize")!.onclick = () => recognize()
 
   // custom rfid
   if (useRfidSelfHostedUI) readRfid = () => rfidSelfHostedUI()
@@ -110,17 +111,17 @@ export function main() {
   }
 }
 
-export function setStatus(data) {
+export function setStatus(data: string | null) {
   if (data != null)
-    document.getElementById("status").innerHTML = data
+    document.getElementById("status")!.innerHTML = data
 }
 
-function setPortrait(data) {
+function setPortrait(data: string | null) {
   if (data != null)
     portraitUIImage.src = "data:image/png;base64," + data
 }
 
-function setDocImage(data) {
+function setDocImage(data: string | null) {
   if (data != null)
     documentUIImage.src = "data:image/png;base64," + data
 }
@@ -131,10 +132,9 @@ function clearResults() {
   documentUIImage.src = "images/document.png"
 }
 
-function setCanRfid(data) {
-  var checkbox // implicitly any, since cordova sample is pure js
-  checkbox = document.getElementById('rfid-checkbox')
-  var checkboxDescription = document.getElementById("rfid-checkbox-description")
+function setCanRfid(data: boolean) {
+  var checkbox = document.getElementById('rfid-checkbox') as HTMLInputElement
+  var checkboxDescription = document.getElementById("rfid-checkbox-description")!
   if (data) {
     checkbox.disabled = false
     checkboxDescription.innerHTML = "Process rfid reading"
@@ -147,9 +147,8 @@ function setCanRfid(data) {
   }
 }
 
-function setScenarios(data) {
-  selectedScenario = Scenario.MRZ
-  var scenariosContainer = document.getElementById("scenarios")
+function setScenarios(data: DocReaderScenario[]) {
+  var scenariosContainer = document.getElementById("scenarios")!
 
   data.forEach(scenario => {
     var checked = selectedScenario == scenario.name ? "checked" : ""
@@ -161,11 +160,10 @@ function setScenarios(data) {
   })
 
   data.forEach(scenario => {
-    var element
-    element = document.getElementById(scenario.name)
-    var elementCaption = document.getElementById(scenario.name + "-caption")
+    var element = document.getElementById(scenario.name) as HTMLInputElement
+    var elementCaption = document.getElementById(scenario.name + "-caption")!
     var onclick = () => {
-      selectedScenario = scenario.name
+      selectedScenario = scenario.name as Scenario
       element.checked = true
     }
     element.onclick = onclick

package/examples/ionic/README.md

@@ -2,9 +2,7 @@
 
 ## 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`.
@@ -15,7 +13,7 @@
 
 ### Bluetooth device
 
-In order to connect to an external scanning device, change the `useBtDevice` constant to true in `src/extra/bt_device`, and set `btDeviceName` to the name of you device. After running the app, click `Connect`.
+In order to connect to an external scanning device, change the `useBtDevice` constant to true in `src/extra/bt_device`, and set `btDeviceName` to the name of your device. After running the app, click `Connect`.
 
 ### RFID self hosted UI
 

package/examples/ionic/angular.json

@@ -11,17 +11,17 @@
           "options": {
             "outputPath": "www",
             "index": "index.html",
-            "main": "index.ts",
+            "main": "index.tsx",
             "tsConfig": "tsconfig.json",
             "assets": [
               {
                 "glob": "**/*",
-                "input": "src/assets",
+                "input": "assets",
                 "output": "assets"
               },
               {
                 "glob": "**/*",
-                "input": "src/images",
+                "input": "images",
                 "output": "images"
               }
             ]

package/examples/ionic/config.xml

@@ -2,9 +2,9 @@
 <widget android-packageName="com.regula.dr.fullauthrfid" ios-CFBundleIdentifier="regula.DocumentReader" version="1.0.0"
     xmlns:android="http://schemas.android.com/apk/res/android">
     <name>DocumentReader</name>
-    <icon src="src/images/icon.png" />
+    <icon src="images/icon.png" />
     <platform name="android">
-        <resource-file src="src/assets/db.dat" target="app/src/main/assets/Regula/db.dat"/>
+        <resource-file src="assets/db.dat" target="app/src/main/assets/Regula/db.dat" />
         <preference name="orientation" value="portrait" />
         <preference name="android-minSdkVersion" value="24" />
         <preference name="android-targetSdkVersion" value="35" />
@@ -18,7 +18,7 @@
         </edit-config>
     </platform>
     <platform name="ios">
-        <resource-file src="src/assets/db.dat" />
+        <resource-file src="assets/db.dat" />
         <preference name="orientation" value="portrait" />
         <allow-intent href="itms:*" />
         <allow-intent href="itms-apps:*" />
@@ -31,5 +31,29 @@
         <config-file parent="NSBluetoothAlwaysUsageDescription" target="*-Info.plist">
             <string>To use btdevice</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/package.json

@@ -6,9 +6,9 @@
     "android": "scripts/android.sh"
   },
   "dependencies": {
-    "@regulaforensics/document-reader": "8.3.242-beta",
-    "@regulaforensics/document-reader-core-fullauthrfid": "8.3.9-beta",
-    "@regulaforensics/document-reader-btdevice": "8.3.10-beta",
+    "@regulaforensics/document-reader": "8.3.272-beta",
+    "@regulaforensics/document-reader-core-fullauthrfid": "8.2.8-beta",
+    "@regulaforensics/document-reader-btdevice": "8.2.8-beta",
     "@awesome-cordova-plugins/file": "6.14.0",
     "@awesome-cordova-plugins/camera": "6.14.0",
     "cordova-ios": "7.1.1",

package/examples/ionic/src/extra/{bt_device.ts → bt_device.tsx}

@@ -5,7 +5,7 @@ export const useBtDevice = false
 export const btDeviceName = "Regula 0000"
 
 export function setupBTDevice() {
-  var connectButton = document.getElementById("connect")
+  var connectButton = document.getElementById("connect")!
   connectButton.style.display = "flex"
   connectButton.onclick = () => connect()
   setStatus("Connect to a bluetooth device")
@@ -16,7 +16,7 @@ async function connect() {
   if (await DocumentReader.instance.connectBluetoothDevice(btDeviceName)) {
     await init()
     DocumentReader.instance.functionality.useAuthenticator = true
-    document.getElementById("bt-device").style.display = "none"
+    document.getElementById("connect")!.style.display = "none"
   } else
     setStatus("Failed to connect")
 }

package/examples/ionic/src/extra/{custom_rfid.ts → custom_rfid.tsx}

@@ -28,7 +28,7 @@ function setup() {
     setProgress(-1)
     currentProgress = -1
     setShowing(true)
-    document.getElementById("cancel-rfid").onclick = () => stop()
+    document.getElementById("cancel-rfid")!.onclick = () => stop()
 }
 
 function stop() {
@@ -37,13 +37,13 @@ function stop() {
     setShowing(false)
 }
 
-function setDescription(data) {
-    document.getElementById("rfid-description").innerHTML = data
+function setDescription(data: string) {
+    document.getElementById("rfid-description")!.innerHTML = data
 }
 
 var currentProgress = -1
-function setProgress(next) {
-    var progress = document.getElementById("progress")
+function setProgress(next: number) {
+    var progress = document.getElementById("progress")!
     // make progress bar look better
     if (next == 0) return // ignore idle 0s, leave progress at 100 while its not moving
     if (next < currentProgress) next = 0 // move to 0 if progress finaly started moving
@@ -55,7 +55,7 @@ function setProgress(next) {
     currentProgress = next
 }
 
-function setShowing(data) {
-    document.getElementById("main").style.display = data ? "none" : "flex"
-    document.getElementById("custom-rfid").style.display = data ? "flex" : "none"
+function setShowing(data: boolean) {
+    document.getElementById("main")!.style.display = data ? "none" : "flex"
+    document.getElementById("custom-rfid")!.style.display = data ? "flex" : "none"
 }

package/examples/ionic/src/main.css

@@ -8,6 +8,19 @@ body {
     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;
+}
+
+/* Prevent image dragging */
+img {
+    pointer-events: none;
+}
+
 .column {
     display: flex;
     flex-direction: column;
@@ -131,4 +144,4 @@ input[type="text"] {
     height: 20px;
     background-color: #4285F4;
     border-radius: 5px;
-}
+}

package/examples/ionic/src/main.html

@@ -33,6 +33,6 @@
         <div class="progress-bar">
             <div id="progress"></div>
         </div>
-        <button id="cancel-rfid" class="text-button" style="margin-top: 50px;">X</button>
+        <button id="cancel-rfid" class="text-button" style="margin-top: 50px; padding-bottom: 100px;">X</button>
     </div>
 </div>