@regulaforensics/ionic-native-document-reader 6.3.0 → 6.5.0

package/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,39 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: "[BR] "
+labels: bug
+assignees: ''
+
+---
+
+**Before Submitting, be sure to**
+- [ ] Update to the latest stable version.
+- [ ] Read and follow the guides described in the [documentation](https://docs.regulaforensics.com?utm_source=github).
+- [ ] Try to reproduce in our demo project.
+- [ ] Search for your issue in the existing GitHub issues.
+
+**Bug Description**
+<!--A clear and concise description of what the bug is.-->
+
+**Steps To Reproduce**
+<!--
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+-->
+
+**Expected behavior**
+<!--A clear and concise description of what you expected to happen.-->
+
+**Screenshots**
+<!--If applicable, add screenshots to help explain your issue.-->
+
+**Environment:**
+ - Device: <!--[e.g. iPhone 12]-->
+ - OS: <!--[e.g. iOS]-->
+ - OS version: <!--[e.g. 10.0]-->
+
+**Additional context**
+<!--Add any other context about the problem here.-->

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Regula Help Center
+    url: https://support.regulaforensics.com/hc/requests/new?utm_source=github
+    about: Please submit any requests here

package/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest an idea for this product
+title: "[FR] "
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+<!--A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]-->
+
+**Describe the solution you'd like**
+<!--A clear and concise description of what you want to happen.-->
+
+**Describe alternatives you've considered**
+<!--A clear and concise description of any alternative solutions or features you've considered.-->
+
+**Additional context**
+<!--Add any other context or screenshots about the feature request here.-->

package/example/README.md

@@ -11,18 +11,15 @@ $ ionic cordova prepare
 4. Copy the `regula.license` file to the `example/src/assets` folder.
 
 5. Android:
-  * Change the application ID to the one you have specified during the registration at [client.regulaforensics.com](https://client.regulaforensics.com).
   * Run `ionic cordova build android`, then`ionic cordova run android` inside `example` folder - this is just one way to run the app. You can also run it directly from within Android Studio.
 
 6. iOS:
-  * Change the Bundle Identifier to the one you have specified during the registration at [client.regulaforensics.com](https://client.regulaforensics.com).
   * Run `ionic cordova build ios`, then `ionic cordova run ios` inside `example` folder - this is just one way to run the app. You can also run it directly from within Xcode.
 
 
 # Troubleshooting license issues
 If you have issues with license verification when running the application, please verify that next is true:
 1. The OS, which you use, is specified in the license (e.g., Android and/or iOS).
-2. The application (Bundle) ID, which you use, is specified in the license.
 3. The license is valid (not expired).
 4. The date and time on the device, where you run the application, are valid.
 5. You use the latest release version of the Document Reader SDK.

package/example/package.json

@@ -19,18 +19,18 @@
     "@angular/platform-browser": "~13.3.2",
     "@angular/platform-browser-dynamic": "~13.3.2",
     "@angular/router": "~13.3.2",
-    "@ionic-native/android-permissions": "^5.28.0",
-    "@ionic-native/core": "^5.28.0",
-    "@ionic-native/file": "^5.28.0",
-    "@ionic-native/image-picker": "^5.28.0",
-    "@ionic-native/splash-screen": "^5.28.0",
-    "@ionic-native/status-bar": "^5.28.0",
+    "@awesome-cordova-plugins/android-permissions": "^5.28.0",
+    "@awesome-cordova-plugins/core": "^5.28.0",
+    "@awesome-cordova-plugins/file": "^5.28.0",
+    "@awesome-cordova-plugins/image-picker": "^5.28.0",
+    "@awesome-cordova-plugins/splash-screen": "^5.28.0",
+    "@awesome-cordova-plugins/status-bar": "^5.28.0",
     "@ionic/angular": "^6.0.15",
     "@ionic/cordova-builders": "^6.1.0",
     "cordova-ios": "^6.2.0",
-    "@regulaforensics/cordova-plugin-document-reader-api": "^6.3.0",
-    "@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "^6.3.0",
-    "@regulaforensics/ionic-native-document-reader": "^6.3.0",
+    "@regulaforensics/cordova-plugin-document-reader-api": "6.5.0",
+    "@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.5.0",
+    "@regulaforensics/ionic-native-document-reader": "6.5.0",
     "cordova-android": "^10.1.1",
     "cordova-plugin-add-swift-support": "^2.0.2",
     "cordova-plugin-android-permissions": "^1.1.0",
@@ -98,4 +98,4 @@
       "ios"
     ]
   }
-}
+}

package/example/src/app/app.component.spec.ts

@@ -2,8 +2,8 @@ import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
 import { TestBed, async } from '@angular/core/testing';
 
 import { Platform } from '@ionic/angular';
-import { SplashScreen } from '@ionic-native/splash-screen/ngx';
-import { StatusBar } from '@ionic-native/status-bar/ngx';
+import { SplashScreen } from '@awesome-cordova-plugins/splash-screen/ngx';
+import { StatusBar } from '@awesome-cordova-plugins/status-bar/ngx';
 
 import { AppComponent } from './app.component';
 

package/example/src/app/app.component.ts

@@ -1,8 +1,8 @@
 import { Component } from '@angular/core';
 
 import { Platform } from '@ionic/angular';
-import { SplashScreen } from '@ionic-native/splash-screen/ngx';
-import { StatusBar } from '@ionic-native/status-bar/ngx';
+import { SplashScreen } from '@awesome-cordova-plugins/splash-screen/ngx';
+import { StatusBar } from '@awesome-cordova-plugins/status-bar/ngx';
 
 @Component({
   selector: 'app-root',

package/example/src/app/app.module.ts

@@ -3,8 +3,8 @@ import { BrowserModule } from '@angular/platform-browser';
 import { RouteReuseStrategy } from '@angular/router';
 
 import { IonicModule, IonicRouteStrategy } from '@ionic/angular';
-import { SplashScreen } from '@ionic-native/splash-screen/ngx';
-import { StatusBar } from '@ionic-native/status-bar/ngx';
+import { SplashScreen } from '@awesome-cordova-plugins/splash-screen/ngx';
+import { StatusBar } from '@awesome-cordova-plugins/status-bar/ngx';
 
 import { AppComponent } from './app.component';
 import { AppRoutingModule } from './app-routing.module';

package/example/src/app/home/home.module.ts

@@ -3,8 +3,8 @@ import { CommonModule } from '@angular/common';
 import { IonicModule } from '@ionic/angular';
 import { FormsModule } from '@angular/forms';
 import { RouterModule } from '@angular/router';
-import { ImagePicker } from "@ionic-native/image-picker/ngx";
-import { AndroidPermissions } from '@ionic-native/android-permissions/ngx';
+import { ImagePicker } from "@awesome-cordova-plugins/image-picker/ngx";
+import { AndroidPermissions } from '@awesome-cordova-plugins/android-permissions/ngx';
 import { DocumentReader } from '@regulaforensics/ionic-native-document-reader/ngx';
 
 import { HomePage } from './home.page';

package/example/src/app/home/home.page.ts

@@ -1,11 +1,12 @@
 import { Component, ViewChild, ElementRef } from '@angular/core'
-import { File } from '@ionic-native/file'
-import { ImagePicker } from '@ionic-native/image-picker/ngx'
-import { AndroidPermissions } from '@ionic-native/android-permissions/ngx'
+import { File } from '@awesome-cordova-plugins/file'
+import { ImagePicker } from '@awesome-cordova-plugins/image-picker/ngx'
+import { AndroidPermissions } from '@awesome-cordova-plugins/android-permissions/ngx'
 import { Platform } from '@ionic/angular'
 import { DocumentReader, DocumentReaderScenario, Enum, DocumentReaderCompletion, DocumentReaderResults, DocumentReaderNotification } from '@regulaforensics/ionic-native-document-reader/ngx';
 
 var doRfid: boolean = false
+var isReadingRfidCustomUi: boolean = false
 var isReadingRfid: boolean = false
 var rfidUIHeader: string = "Reading RFID"
 var rfidUIHeaderColor: string = "black"
@@ -62,7 +63,10 @@ export class HomePage {
             app.status.nativeElement.innerHTML = "Downloading database: " + r + "%"
           else {
             app.status.nativeElement.innerHTML = "Loading......"
-            DocumentReader.initializeReader(license).then(m => onInitialized()).catch(error1)
+            DocumentReader.initializeReader({
+              license: license,
+              delayedNNLoad: true
+            }).then(m => onInitialized()).catch(error1)
           }
         })
       })
@@ -105,8 +109,8 @@ export class HomePage {
     }
 
     function updateUI() {
-      app.mainUI.nativeElement.style.display = isReadingRfid ? "none" : ""
-      app.rfidUI.nativeElement.style.display = isReadingRfid ? "" : "none"
+      app.mainUI.nativeElement.style.display = isReadingRfidCustomUi ? "none" : ""
+      app.rfidUI.nativeElement.style.display = isReadingRfidCustomUi ? "" : "none"
       app.rfidUIHeader.nativeElement.innerHTML = rfidUIHeader
       app.rfidUIHeader.nativeElement.style.color = rfidUIHeaderColor
       app.rfidDescription.nativeElement.innerHTML = rfidDescription
@@ -119,12 +123,12 @@ export class HomePage {
     }
 
     function handleCompletion(completion: DocumentReaderCompletion) {
-      if (isReadingRfid && (completion.action === Enum.DocReaderAction.CANCEL || completion.action === Enum.DocReaderAction.ERROR))
+      if (isReadingRfidCustomUi && (completion.action === Enum.DocReaderAction.CANCEL || completion.action === Enum.DocReaderAction.ERROR))
         hideRfidUI()
-      if (isReadingRfid && completion.action === Enum.DocReaderAction.NOTIFICATION)
+      if (isReadingRfidCustomUi && completion.action === Enum.DocReaderAction.NOTIFICATION)
         updateRfidUI(completion.results.documentReaderNotification)
       if (completion.action === Enum.DocReaderAction.COMPLETE)
-        if (isReadingRfid) {
+        if (isReadingRfidCustomUi) {
           if (completion.results.rfidResult !== 1)
             restartRfidUI()
           else {
@@ -134,18 +138,22 @@ export class HomePage {
         }
         else
           handleResults(completion.results)
+      if (completion.action === Enum.DocReaderAction.TIMEOUT)
+        handleResults(completion.results)
+      if (completion.action === Enum.DocReaderAction.CANCEL || completion.action === Enum.DocReaderAction.ERROR)
+        isReadingRfid = false
     }
 
     function showRfidUI() {
       // show animation
-      isReadingRfid = true
+      isReadingRfidCustomUi = true
       updateUI()
     }
 
     function hideRfidUI() {
       // show animation
       restartRfidUI()
-      isReadingRfid = false
+      isReadingRfidCustomUi = false
       rfidUIHeader = "Reading RFID"
       rfidUIHeaderColor = "black"
       updateUI()
@@ -177,8 +185,7 @@ export class HomePage {
     }
 
     function usualRFID() {
-      doRfid = false
-      app.rfidCheckbox["el"].checked = false
+      isReadingRfid = true
       var notification = "rfidNotificationCompletionEvent"
       var paCert = "paCertificateCompletionEvent"
       var taCert = "taCertificateCompletionEvent"
@@ -264,20 +271,13 @@ export class HomePage {
 
     function handleResults(results: DocumentReaderResults) {
       clearResults()
-      if (doRfid && results != null && results.chipPage != 0) {
-        var accessKey = results.getTextFieldValueByType({ fieldType: 51 })
-        if (accessKey != null && accessKey != "") {
-          accessKey = accessKey.replace(/^/g, '').replace(/\n/g, '')
-          DocumentReader.setRfidScenario({ mMrz: accessKey, mPacePasswordType: 1, })
-        } else {
-          accessKey = results.getTextFieldValueByType({ fieldType: 159 })
-          if (accessKey != null && accessKey != "")
-            DocumentReader.setRfidScenario({ mMrz: accessKey, mPacePasswordType: 2, })
-        }
+      if (doRfid && !isReadingRfid && results != null && results.chipPage != 0) {
         // customRFID()
         usualRFID()
-      } else
+      } else {
+        isReadingRfid = false
         displayResults(results)
+      }
     }
 
     function displayResults(results: DocumentReaderResults) {