@regulaforensics/ionic-native-document-reader 6.6.1 → 6.7.0

package/example/package.json

@@ -28,9 +28,9 @@
     "@ionic/angular": "^6.0.15",
     "@ionic/cordova-builders": "^6.1.0",
     "cordova-ios": "^6.2.0",
-    "@regulaforensics/cordova-plugin-document-reader-api": "6.6.1",
-    "@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.6.0",
-    "@regulaforensics/ionic-native-document-reader": "6.6.1",
+    "@regulaforensics/cordova-plugin-document-reader-api": "6.7.2",
+    "@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.7.0",
+    "@regulaforensics/ionic-native-document-reader": "6.7.0",
     "cordova-android": "^10.1.1",
     "cordova-plugin-add-swift-support": "^2.0.2",
     "cordova-plugin-android-permissions": "^1.1.0",

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

@@ -12,7 +12,7 @@
         </div>
     </div>
     <div #mainUI style="text-align: center;background-color: #F5FCFF;height: 100%;">
-        <div style="align-items: center; text-align: center; width: 100%">
+        <div style="align-items: center; text-align: center; width: 100%" class="status">
             <p #status>Ready</p>
         </div>
         <div style=" align-items:center; text-align: center;display: inline-block;">
@@ -25,7 +25,7 @@
             <img style="height: 133px;" src="assets/img/id.png" resizeMode="contain" #documentImage />
         </div>
         <br><br>
-        <div #scenariosRadioGroup
+        <div #scenariosRadioGroup class="scenarios"
             style="position: absolute; bottom: 100px; top: 230px; left: 75px; padding: 5px; text-align:left; overflow: auto">
         </div>
 

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

@@ -1 +1,9 @@
+.status {
+    margin-top: constant(safe-area-inset-top);
+    margin-top: env(safe-area-inset-top);
+}
 
+.scenarios {
+    margin-top: constant(safe-area-inset-top);
+    margin-top: env(safe-area-inset-top);
+}

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

@@ -140,8 +140,6 @@ export class HomePage {
           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() {
@@ -169,7 +167,7 @@ export class HomePage {
 
     function updateRfidUI(notification: DocumentReaderNotification) {
       if (notification.code === Enum.eRFID_NotificationCodes.RFID_NOTIFICATION_PCSC_READING_DATAGROUP)
-        rfidDescription = Enum.eRFID_DataFile_Type.getTranslation(notification.attachment)
+        rfidDescription = Enum.eRFID_DataFile_Type.getTranslation(notification.dataFileType)
       rfidUIHeader = "Reading RFID"
       rfidUIHeaderColor = "black"
       rfidProgress = notification.value
@@ -283,17 +281,17 @@ export class HomePage {
     function displayResults(results: DocumentReaderResults) {
       if (results == undefined) return
 
-      DocumentReader.getTextFieldValueByType(results, Enum.eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES).then(value => {
+      DocumentReader.textFieldValueByType(results, Enum.eVisualFieldType.FT_SURNAME_AND_GIVEN_NAMES).then(value => {
         app.status.nativeElement.style.backgroundColor = "green"
         app.status.nativeElement.innerHTML = value
       })
 
-      DocumentReader.getGraphicFieldImageByType(results, Enum.eGraphicFieldType.GF_DOCUMENT_IMAGE).then(value => {
+      DocumentReader.graphicFieldImageByType(results, Enum.eGraphicFieldType.GF_DOCUMENT_IMAGE).then(value => {
         if (value != undefined)
           app.documentImage.nativeElement.src = "data:image/png;base64," + value
       })
 
-      DocumentReader.getGraphicFieldImageByType(results, Enum.eGraphicFieldType.GF_PORTRAIT).then(value => {
+      DocumentReader.graphicFieldImageByType(results, Enum.eGraphicFieldType.GF_PORTRAIT).then(value => {
         if (value != undefined)
           app.portraitImage.nativeElement.src = "data:image/png;base64," + value
       })
@@ -320,7 +318,8 @@ export class HomePage {
         File.readAsDataURL((app.platform.is("ios") ? "file://" : "") + results[0].substring(0, (results[0] as string).lastIndexOf("/")), results[0].substring((results[0] as string).lastIndexOf("/") + 1)).then((file => {
           app.status.nativeElement.innerHTML = "processing image......"
           app.status.nativeElement.style.backgroundColor = "grey"
-          DocumentReader.recognizeImage((file as string).substring(23)).subscribe(m =>
+          let fileString = (file as string)
+          DocumentReader.recognizeImage(fileString.substring(fileString.indexOf(",") + 1)).subscribe(m =>
             handleCompletion(DocumentReaderCompletion.fromJson(JSON.parse(m))))
         })).catch(error2)
       }, error2)

package/index.d.ts

@@ -88,6 +88,8 @@ export declare class DocumentReaderTextField {
     values?: DocumentReaderValue[];
     comparisonList?: DocumentReaderComparison[];
     validityList?: DocumentReaderValidity[];
+    comparisonStatus?: number;
+    validityStatus?: number;
     static fromJson(jsonObject?: any): DocumentReaderTextField | undefined;
 }
 export declare class DocumentReaderTextResult {
@@ -151,8 +153,10 @@ export declare class DocumentReaderDocumentType {
 }
 export declare class DocumentReaderNotification {
     code?: number;
-    attachment?: number;
     value?: number;
+    notificationCode?: number;
+    dataFileType?: number;
+    progress?: number;
     static fromJson(jsonObject?: any): DocumentReaderNotification | undefined;
 }
 export declare class AccessControlProcedureType {
@@ -486,7 +490,9 @@ export declare class DocumentReaderValidity {
     static fromJson(jsonObject?: any): DocumentReaderValidity | undefined;
 }
 export declare class DocumentReaderResults {
+    videoCaptureSessionId?: string;
     chipPage?: number;
+    irElapsedTime?: number;
     processingFinishedStatus?: number;
     elapsedTime?: number;
     elapsedTimeRFID?: number;
@@ -504,10 +510,57 @@ export declare class DocumentReaderResults {
     rfidSessionData?: RFIDSessionData;
     authenticityResult?: DocumentReaderAuthenticityResult;
     barcodeResult?: DocumentReaderBarcodeResult;
+    ppmIn?: number;
     documentType?: DocumentReaderDocumentType[];
     status?: DocumentReaderResultsStatus;
     vdsncData?: VDSNCData;
     static fromJson(jsonObject?: any): DocumentReaderResults | undefined;
+    /**
+     * @deprecated Use DocumentReader.textFieldValueBy...()
+     */
+    getTextFieldValueByType({ fieldType, lcid, source, original }: {
+        fieldType: number;
+        lcid?: number;
+        source?: number;
+        original?: boolean;
+    }): string | undefined;
+    /**
+     * @deprecated
+     */
+    getTextFieldStatusByType(fieldType: number, lcid?: number): number;
+    /**
+     * @deprecated Use DocumentReader.graphicFieldImageBy...()
+     */
+    getGraphicFieldImageByType({ fieldType, source, light, pageIndex }: {
+        fieldType: number;
+        source?: number;
+        light?: number;
+        pageIndex?: number;
+    }): string | undefined;
+    /**
+     * @deprecated
+     */
+    getQualityResult({ imageQualityCheckType, securityFeature, pageIndex }: {
+        imageQualityCheckType: number;
+        securityFeature?: number;
+        pageIndex?: number;
+    }): number;
+    /**
+     * @deprecated
+     */
+    findByTypeAndLcid(type: number, lcid?: number): DocumentReaderTextField | undefined;
+    /**
+     * @deprecated
+     */
+    findBySource(field: DocumentReaderTextField, sourceType: number): DocumentReaderValue | undefined;
+    /**
+     * @deprecated Use DocumentReader.containers()
+     */
+    getContainers(resultTypes: number[]): string | undefined;
+    /**
+     * @deprecated Use DocumentReader.encryptedContainers()
+     */
+    getEncryptedContainers(): string | undefined;
 }
 export declare const FontStyle: {
     NORMAL: number;
@@ -826,6 +879,7 @@ export declare const eRPRM_ResultType: {
     RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION: number;
     RPRM_RESULT_TYPE_INTERNAL_ENCRYPTED_RCL: number;
     RPRM_RESULT_TYPE_INTERNAL_LICENSE: number;
+    RPRM_RESULT_TYPE_TEXT: number;
     RPRM_RESULT_TYPE_IMAGES: number;
     RPRM_RESULT_TYPE_HOLO_PARAMS: number;
     RPRM_RESULT_TYPE_DOCUMENT_POSITION: number;
@@ -863,15 +917,15 @@ export declare const eRPRM_FieldVerificationResult: {
 export declare const DocReaderAction: {
     COMPLETE: number;
     PROCESS: number;
+    MORE_PAGES_AVAILABLE: number;
     CANCEL: number;
     ERROR: number;
-    NOTIFICATION: number;
-    PROCESS_WHITE_UV_IMAGES: number;
     PROCESS_WHITE_FLASHLIGHT: number;
-    MORE_PAGES_AVAILABLE: number;
-    PROCESS_IR_FRAME: number;
     TIMEOUT: number;
     PROCESSING_ON_SERVICE: number;
+    NOTIFICATION: number;
+    PROCESS_WHITE_UV_IMAGES: number;
+    PROCESS_IR_FRAME: number;
 };
 export declare const eProcessGLCommands: {
     ePC_ProcMgr_SetLicense: number;
@@ -1128,6 +1182,12 @@ export declare const RFIDDelegate: {
     NO_PA: number;
     FULL: number;
 };
+export declare const TextProcessing: {
+    ocNoChange: number;
+    ocUppercase: number;
+    ocLowercase: number;
+    ocCapital: number;
+};
 export declare const ProcessingFinishedStatus: {
     NOT_READY: number;
     READY: number;
@@ -1382,6 +1442,7 @@ export declare const eImageQualityCheckType: {
     IQC_SCREEN_CAPTURE: number;
     IQC_PORTRAIT: number;
     IQC_HANDWRITTEN: number;
+    getTranslation(value: number): string;
 };
 export declare const MRZFormat: {
     FORMAT_1X30: string;
@@ -1729,6 +1790,9 @@ export declare const eGraphicFieldType: {
     GF_FINGER_RIGHT_LITTLE: number;
     getTranslation(value: number): string;
 };
+export declare const RegDeviceConfigType: {
+    DEVICE_7310: number;
+};
 export declare const CameraMode: {
     AUTO: number;
     CAMERA1: number;
@@ -2440,6 +2504,12 @@ export declare const eVisualFieldType: {
     FT_THIRD_NAME: number;
     FT_FOURTH_NAME: number;
     FT_LAST_NAME: number;
+    FT_DLCLASSCODE_RM_FROM: number;
+    FT_DLCLASSCODE_RM_NOTES: number;
+    FT_DLCLASSCODE_RM_TO: number;
+    FT_DLCLASSCODE_PW_FROM: number;
+    FT_DLCLASSCODE_PW_NOTES: number;
+    FT_DLCLASSCODE_PW_TO: number;
     getTranslation(value: number): string;
 };
 export declare const DocReaderOrientation: {
@@ -2993,6 +3063,7 @@ export declare const Enum: {
         RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION: number;
         RPRM_RESULT_TYPE_INTERNAL_ENCRYPTED_RCL: number;
         RPRM_RESULT_TYPE_INTERNAL_LICENSE: number;
+        RPRM_RESULT_TYPE_TEXT: number;
         RPRM_RESULT_TYPE_IMAGES: number;
         RPRM_RESULT_TYPE_HOLO_PARAMS: number;
         RPRM_RESULT_TYPE_DOCUMENT_POSITION: number;
@@ -3030,15 +3101,15 @@ export declare const Enum: {
     DocReaderAction: {
         COMPLETE: number;
         PROCESS: number;
+        MORE_PAGES_AVAILABLE: number;
         CANCEL: number;
         ERROR: number;
-        NOTIFICATION: number;
-        PROCESS_WHITE_UV_IMAGES: number;
         PROCESS_WHITE_FLASHLIGHT: number;
-        MORE_PAGES_AVAILABLE: number;
-        PROCESS_IR_FRAME: number;
         TIMEOUT: number;
         PROCESSING_ON_SERVICE: number;
+        NOTIFICATION: number;
+        PROCESS_WHITE_UV_IMAGES: number;
+        PROCESS_IR_FRAME: number;
     };
     eProcessGLCommands: {
         ePC_ProcMgr_SetLicense: number;
@@ -3295,6 +3366,12 @@ export declare const Enum: {
         NO_PA: number;
         FULL: number;
     };
+    TextProcessing: {
+        ocNoChange: number;
+        ocUppercase: number;
+        ocLowercase: number;
+        ocCapital: number;
+    };
     ProcessingFinishedStatus: {
         NOT_READY: number;
         READY: number;
@@ -3549,6 +3626,7 @@ export declare const Enum: {
         IQC_SCREEN_CAPTURE: number;
         IQC_PORTRAIT: number;
         IQC_HANDWRITTEN: number;
+        getTranslation(value: number): string;
     };
     MRZFormat: {
         FORMAT_1X30: string;
@@ -3896,6 +3974,9 @@ export declare const Enum: {
         GF_FINGER_RIGHT_LITTLE: number;
         getTranslation(value: number): string;
     };
+    RegDeviceConfigType: {
+        DEVICE_7310: number;
+    };
     CameraMode: {
         AUTO: number;
         CAMERA1: number;
@@ -4607,6 +4688,12 @@ export declare const Enum: {
         FT_THIRD_NAME: number;
         FT_FOURTH_NAME: number;
         FT_LAST_NAME: number;
+        FT_DLCLASSCODE_RM_FROM: number;
+        FT_DLCLASSCODE_RM_NOTES: number;
+        FT_DLCLASSCODE_RM_TO: number;
+        FT_DLCLASSCODE_PW_FROM: number;
+        FT_DLCLASSCODE_PW_NOTES: number;
+        FT_DLCLASSCODE_PW_TO: number;
         getTranslation(value: number): string;
     };
     DocReaderOrientation: {
@@ -5352,23 +5439,23 @@ export declare class DocumentReaderOriginal extends AwesomeCordovaNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     recognizeImagesWithImageInputs(images: any): Promise<any>;
-    getTextFieldValueByType(results: DocumentReaderResults, fieldType: number): Promise<string | undefined>;
-    getTextFieldValueByTypeLcid(results: DocumentReaderResults, fieldType: number, lcid: number): Promise<string | undefined>;
-    getTextFieldValueByTypeSource(results: DocumentReaderResults, fieldType: number, source: number): Promise<string | undefined>;
-    getTextFieldValueByTypeLcidSource(results: DocumentReaderResults, fieldType: number, lcid: number, source: number): Promise<string | undefined>;
-    getTextFieldValueByTypeSourceOriginal(results: DocumentReaderResults, fieldType: number, source: number, original: boolean): Promise<string | undefined>;
-    getTextFieldValueByTypeLcidSourceOriginal(results: DocumentReaderResults, fieldType: number, lcid: number, source: number, original: boolean): Promise<string | undefined>;
-    getTextFieldByType(results: DocumentReaderResults, fieldType: number): Promise<string | undefined>;
-    getTextFieldByTypeLcid(results: DocumentReaderResults, fieldType: number, lcid: number): Promise<string | undefined>;
-    getGraphicFieldByTypeSource(results: DocumentReaderResults, fieldType: number, source: number): Promise<string | undefined>;
-    getGraphicFieldByTypeSourcePageIndex(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number): Promise<string | undefined>;
-    getGraphicFieldByTypeSourcePageIndexLight(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number, light: number): Promise<string | undefined>;
-    getGraphicFieldImageByType(results: DocumentReaderResults, fieldType: number): Promise<string | undefined>;
-    getGraphicFieldImageByTypeSource(results: DocumentReaderResults, fieldType: number, source: number): Promise<string | undefined>;
-    getGraphicFieldImageByTypeSourcePageIndex(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number): Promise<string | undefined>;
-    getGraphicFieldImageByTypeSourcePageIndexLight(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number, light: number): Promise<string | undefined>;
-    getContainers(results: DocumentReaderResults, resultType: number[]): Promise<string | undefined>;
-    getEncryptedContainers(results: DocumentReaderResults): Promise<string | undefined>;
+    textFieldValueByType(results: DocumentReaderResults, fieldType: number): Promise<string | undefined>;
+    textFieldValueByTypeLcid(results: DocumentReaderResults, fieldType: number, lcid: number): Promise<string | undefined>;
+    textFieldValueByTypeSource(results: DocumentReaderResults, fieldType: number, source: number): Promise<string | undefined>;
+    textFieldValueByTypeLcidSource(results: DocumentReaderResults, fieldType: number, lcid: number, source: number): Promise<string | undefined>;
+    textFieldValueByTypeSourceOriginal(results: DocumentReaderResults, fieldType: number, source: number, original: boolean): Promise<string | undefined>;
+    textFieldValueByTypeLcidSourceOriginal(results: DocumentReaderResults, fieldType: number, lcid: number, source: number, original: boolean): Promise<string | undefined>;
+    textFieldByType(results: DocumentReaderResults, fieldType: number): Promise<string | undefined>;
+    textFieldByTypeLcid(results: DocumentReaderResults, fieldType: number, lcid: number): Promise<string | undefined>;
+    graphicFieldByTypeSource(results: DocumentReaderResults, fieldType: number, source: number): Promise<string | undefined>;
+    graphicFieldByTypeSourcePageIndex(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number): Promise<string | undefined>;
+    graphicFieldByTypeSourcePageIndexLight(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number, light: number): Promise<string | undefined>;
+    graphicFieldImageByType(results: DocumentReaderResults, fieldType: number): Promise<string | undefined>;
+    graphicFieldImageByTypeSource(results: DocumentReaderResults, fieldType: number, source: number): Promise<string | undefined>;
+    graphicFieldImageByTypeSourcePageIndex(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number): Promise<string | undefined>;
+    graphicFieldImageByTypeSourcePageIndexLight(results: DocumentReaderResults, fieldType: number, source: number, pageIndex: number, light: number): Promise<string | undefined>;
+    containers(results: DocumentReaderResults, resultType: number[]): Promise<string | undefined>;
+    encryptedContainers(results: DocumentReaderResults): Promise<string | undefined>;
 }
 
 export declare const DocumentReader: DocumentReaderOriginal;