@regulaforensics/ionic-native-document-reader 6.7.1 → 6.8.0

package/example/config.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<widget android-packageName="com.regula.documentreader" ios-CFBundleIdentifier="com.regula.dr.fullrfid" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:android="http://schemas.android.com/apk/res/android" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+<widget android-packageName="com.regula.documentreader" ios-CFBundleIdentifier="regula.DocumentReader" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:android="http://schemas.android.com/apk/res/android" xmlns:cdv="http://cordova.apache.org/ns/1.0">
     <name>DocumentReader</name>
     <description>A sample Regula Document Reader application for reading and validation of identification documents.</description>
     <author email="cordova.support@regulaforensics.com" href="https://mobile.regulaforensics.com">Regula Forensics Inc.</author>

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.7.3",
-    "@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.7.0",
-    "@regulaforensics/ionic-native-document-reader": "6.7.1",
+    "@regulaforensics/cordova-plugin-document-reader-api": "6.8.0",
+    "@regulaforensics/cordova-plugin-document-reader-core-fullrfid": "6.8.0",
+    "@regulaforensics/ionic-native-document-reader": "6.8.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.ts

@@ -166,8 +166,9 @@ export class HomePage {
     }
 
     function updateRfidUI(notification: DocumentReaderNotification) {
+      if (notification.value === undefined) return
       if (notification.code === Enum.eRFID_NotificationCodes.RFID_NOTIFICATION_PCSC_READING_DATAGROUP)
-        rfidDescription = Enum.eRFID_DataFile_Type.getTranslation(notification.dataFileType)
+        rfidDescription = notification.dataFileType.toString()
       rfidUIHeader = "Reading RFID"
       rfidUIHeaderColor = "black"
       rfidProgress = notification.value
@@ -178,32 +179,33 @@ export class HomePage {
 
     function customRFID() {
       showRfidUI()
-      DocumentReader.readRFID().subscribe(m =>
-        handleCompletion(DocumentReaderCompletion.fromJson(JSON.parse(m))))
+      DocumentReader.readRFID().subscribe(m => handleRfidCompletion(m))
     }
 
     function usualRFID() {
       isReadingRfid = true
+      DocumentReader.startRFIDReader().subscribe(m => handleRfidCompletion(m))
+    }
+
+    function handleRfidCompletion(raw: string) {
       var notification = "rfidNotificationCompletionEvent"
       var paCert = "paCertificateCompletionEvent"
       var taCert = "taCertificateCompletionEvent"
       var taSig = "taSignatureCompletionEvent"
-      DocumentReader.startRFIDReader().subscribe(m => {
-        if (m.substring(0, notification.length) === notification) {
-          m = m.substring(notification.length, m.length)
-          console.log(notification + ": " + m)
-        } else if (m.substring(0, paCert.length) === paCert) {
-          m = m.substring(paCert.length, m.length)
-          console.log(paCert + ": " + m)
-        } else if (m.substring(0, taCert.length) === taCert) {
-          m = m.substring(taCert.length, m.length)
-          console.log(taCert + ": " + m)
-        } else if (m.substring(0, taSig.length) === taSig) {
-          m = m.substring(taSig.length, m.length)
-          console.log(taSig + ": " + m)
-        } else
-          handleCompletion(DocumentReaderCompletion.fromJson(JSON.parse(m)))
-      })
+      if (raw.substring(0, notification.length) === notification) {
+        raw = raw.substring(notification.length, raw.length)
+        console.log(notification + ": " + raw)
+      } else if (raw.substring(0, paCert.length) === paCert) {
+        raw = raw.substring(paCert.length, raw.length)
+        console.log(paCert + ": " + raw)
+      } else if (raw.substring(0, taCert.length) === taCert) {
+        raw = raw.substring(taCert.length, raw.length)
+        console.log(taCert + ": " + raw)
+      } else if (raw.substring(0, taSig.length) === taSig) {
+        raw = raw.substring(taSig.length, raw.length)
+        console.log(taSig + ": " + raw)
+      } else
+        handleCompletion(DocumentReaderCompletion.fromJson(JSON.parse(raw)))
     }
 
     function onInitialized() {

package/index.d.ts

@@ -54,6 +54,7 @@ export declare class DocumentReaderGraphicField {
     fieldType?: number;
     lightType?: number;
     pageIndex?: number;
+    originalPageIndex?: number;
     fieldName?: string;
     lightName?: string;
     value?: string;
@@ -143,6 +144,7 @@ export declare class DocumentReaderDocumentType {
     dType?: number;
     dFormat?: number;
     dMRZ?: boolean;
+    isDeprecated?: boolean;
     name?: string;
     ICAOCode?: string;
     dDescription?: string;
@@ -368,6 +370,8 @@ export declare class ImageInputParam {
     width?: number;
     height?: number;
     type?: number;
+    disableFrameShiftIR?: boolean;
+    doFlipYAxis?: boolean;
     static fromJson(jsonObject?: any): ImageInputParam | undefined;
 }
 export declare class PAResourcesIssuer {
@@ -514,7 +518,6 @@ export declare class DocumentReaderResults {
     documentType?: DocumentReaderDocumentType[];
     status?: DocumentReaderResultsStatus;
     vdsncData?: VDSNCData;
-    static fromJson(jsonObject?: any): DocumentReaderResults | undefined;
     /**
      * @deprecated Use DocumentReader.textFieldValueBy...()
      */
@@ -561,6 +564,7 @@ export declare class DocumentReaderResults {
      * @deprecated Use DocumentReader.encryptedContainers()
      */
     getEncryptedContainers(): string | undefined;
+    static fromJson(jsonObject?: any): DocumentReaderResults | undefined;
 }
 export declare const FontStyle: {
     NORMAL: number;
@@ -586,6 +590,11 @@ export declare const eRPRM_Authenticity: {
     KINEGRAM: number;
     HOLOGRAMS_DETECTION: number;
     MRZ: number;
+    STATUS_ONLY: number;
+    OVI: number;
+    LIVENESS: number;
+    OCR: number;
+    UV: number;
 };
 export declare const eRFID_ErrorCodes: {
     RFID_ERROR_NO_ERROR: number;
@@ -702,7 +711,6 @@ export declare const eRFID_ErrorCodes: {
     RFID_ERROR_LAYER34_SAM_ERROR: number;
     RFID_ERROR_LAYER34_SAM_COLLISION: number;
     RFID_ERROR_LAYER34_SAM_ACKNOWLEDGE: number;
-    getTranslation(value: number): string;
 };
 export declare const eLDS_ParsingErrorCodes: {
     ERR_LDS_OK: number;
@@ -831,7 +839,6 @@ export declare const eLDS_ParsingErrorCodes: {
     ERR_LDS_VDS_NC_MISSING_OR_INCORRECT_SIG_ALGORITHM: number;
     ERR_LDS_VDS_NC_MISSING_OR_INCORRECT_CERTIFICATE: number;
     ERR_LDS_VDS_NC_MISSING_OR_INCORRECT_SIG_VALUE: number;
-    getTranslation(value: number): string;
 };
 export declare const eRFID_CertificateType: {
     CT_UNDEFINED: number;
@@ -977,6 +984,7 @@ export declare const ScenarioIdentifier: {
     SCENARIO_OCR_FREE: string;
     SCENARIO_CREDIT_CARD: string;
     SCENARIO_CAPTURE: string;
+    SCENARIO_BARCODE_AND_LOCATE: string;
 };
 export declare const eRFID_AccessControl_ProcedureType: {
     ACPT_UNDEFINED: number;
@@ -1173,9 +1181,18 @@ export declare const eCheckDiagnose: {
     FINISHED_BY_TIMEOUT: number;
     HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME: number;
     LIVENESS_DEPTH_CHECK_FAILED: number;
-    MRZ_QUALITY_WRONG_MRZ_DPI: number;
+    MRZ_QUALITY_WRONG_SYMBOL_POSITION: number;
     MRZ_QUALITY_WRONG_BACKGROUND: number;
+    MRZ_QUALITY_WRONG_MRZ_WIDTH: number;
+    MRZ_QUALITY_WRONG_MRZ_HEIGHT: number;
+    MRZ_QUALITY_WRONG_LINE_POSITION: number;
+    MRZ_QUALITY_WRONG_FONT_TYPE: number;
+    OCR_QUALITY_TEXT_POSITION: number;
+    OCR_QUALITY_INVALID_FONT: number;
+    OCR_QUALITY_INVALID_BACKGROUND: number;
+    LAS_INK_INVALID_LINES_FREQUENCY: number;
     LAST_DIAGNOSE_VALUE: number;
+    DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED: number;
 };
 export declare const RFIDDelegate: {
     NULL: number;
@@ -1430,7 +1447,6 @@ export declare const eLDS_ParsingNotificationCodes: {
     NTF_LDS_AUTH_ML_SIGNER_INFO_CERTIFICATE_CANT_FIND_CSCA: number;
     NTF_LDS_AUTH_ML_SIGNER_INFO_CERTIFICATE_REVOKED: number;
     NTF_LDS_AUTH_ML_SIGNER_INFO_CERTIFICATE_SIGNATURE_INVALID: number;
-    getTranslation(value: number): string;
 };
 export declare const eImageQualityCheckType: {
     IQC_IMAGE_GLARES: number;
@@ -1442,7 +1458,6 @@ 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;
@@ -1474,7 +1489,7 @@ export declare const BarcodeType: {
     CODE11: number;
 };
 export declare const eRPRM_SecurityFeatureType: {
-    NONE: number;
+    SECURITY_FEATURE_TYPE_NONE: number;
     SECURITY_FEATURE_TYPE_BLANK: number;
     SECURITY_FEATURE_TYPE_FILL: number;
     SECURITY_FEATURE_TYPE_PHOTO: number;
@@ -1503,7 +1518,22 @@ export declare const eRPRM_SecurityFeatureType: {
     SECURITY_FEATURE_TYPE_PHOTO_COLOR: number;
     SECURITY_FEATURE_TYPE_PHOTO_SHAPE: number;
     SECURITY_FEATURE_TYPE_PHOTO_CORNERS: number;
-    DOCUMENT_CANCELLING_DETECTOR: number;
+    SECURITY_FEATURE_TYPE_OCR: number;
+    SECURITY_FEATURE_TYPE_PORTRAIT_COMPARISON_EXTVS_VISUAL: number;
+    SECURITY_FEATURE_TYPE_PORTRAIT_COMPARISON_EXTVS_RFID: number;
+    SECURITY_FEATURE_TYPE_PORTRAIT_COMPARISON_EXTVS_LIVE: number;
+    SECURITY_FEATURE_TYPE_LIVENESS_DEPTH: number;
+    SECURITY_FEATURE_TYPE_MICROTEXT: number;
+    SECURITY_FEATURE_TYPE_FLUORESCENT_OBJECT: number;
+    SECURITY_FEATURE_TYPE_LANDMARKS_CHECK: number;
+    SECURITY_FEATURE_TYPE_FACE_PRESENCE: number;
+    SECURITY_FEATURE_TYPE_FACE_ABSENCE: number;
+    SECURITY_FEATURE_TYPE_LIVENESS_SCREEN_CAPTURE: number;
+    SECURITY_FEATURE_TYPE_LIVENESS_ELECTRONIC_DEVICE: number;
+    SECURITY_FEATURE_TYPE_LIVENESS_OVI: number;
+    SECURITY_FEATURE_TYPE_BARCODE_SIZE_CHECK: number;
+    SECURITY_FEATURE_TYPE_LAS_INK: number;
+    SECURITY_FEATURE_TYPE_LIVENESS_MLI: number;
 };
 export declare const OnlineMode: {
     MANUAL: number;
@@ -1788,7 +1818,6 @@ export declare const eGraphicFieldType: {
     GF_FINGER_RIGHT_MIDDLE: number;
     GF_FINGER_RIGHT_RING: number;
     GF_FINGER_RIGHT_LITTLE: number;
-    getTranslation(value: number): string;
 };
 export declare const RegDeviceConfigType: {
     DEVICE_7310: number;
@@ -1901,7 +1930,6 @@ export declare const eRFID_DataFile_Type: {
     DFT_VDS: number;
     DFT_VDSNC: number;
     DFT_USERDEFINED: number;
-    getTranslation(value: number): string;
 };
 export declare const eVisualFieldType: {
     FT_DOCUMENT_CLASS_CODE: number;
@@ -2510,7 +2538,16 @@ export declare const eVisualFieldType: {
     FT_DLCLASSCODE_PW_FROM: number;
     FT_DLCLASSCODE_PW_NOTES: number;
     FT_DLCLASSCODE_PW_TO: number;
-    getTranslation(value: number): string;
+    FT_DLCLASSCODE_EB_FROM: number;
+    FT_DLCLASSCODE_EB_NOTES: number;
+    FT_DLCLASSCODE_EB_TO: number;
+    FT_DLCLASSCODE_EC_FROM: number;
+    FT_DLCLASSCODE_EC_NOTES: number;
+    FT_DLCLASSCODE_EC_TO: number;
+    FT_DLCLASSCODE_EC1_FROM: number;
+    FT_DLCLASSCODE_EC1_NOTES: number;
+    FT_DLCLASSCODE_EC1_TO: number;
+    FT_PLACE_OF_BIRTH_CITY: number;
 };
 export declare const DocReaderOrientation: {
     ALL: number;
@@ -2676,7 +2713,6 @@ export declare const LCID: {
     VIETNAMESE: number;
     CTC_SIMPLIFIED: number;
     CTC_TRADITIONAL: number;
-    getTranslation(value: number): string;
 };
 export declare const DocReaderFrame: {
     MAX: string;
@@ -2693,7 +2729,7 @@ export declare const eRPRM_Lights: {
     RPRM_Light_IR_SIDE: number;
     RPRM_Light_IR_Full: number;
     RPRM_LIGHT_OVD: number;
-    getTranslation(value: number): string;
+    RPRM_LIGHT_WHITE_FULL_OVD: number;
 };
 export declare const LineCap: {
     Butt: number;
@@ -2770,6 +2806,11 @@ export declare const Enum: {
         KINEGRAM: number;
         HOLOGRAMS_DETECTION: number;
         MRZ: number;
+        STATUS_ONLY: number;
+        OVI: number;
+        LIVENESS: number;
+        OCR: number;
+        UV: number;
     };
     eRFID_ErrorCodes: {
         RFID_ERROR_NO_ERROR: number;
@@ -2886,7 +2927,6 @@ export declare const Enum: {
         RFID_ERROR_LAYER34_SAM_ERROR: number;
         RFID_ERROR_LAYER34_SAM_COLLISION: number;
         RFID_ERROR_LAYER34_SAM_ACKNOWLEDGE: number;
-        getTranslation(value: number): string;
     };
     eLDS_ParsingErrorCodes: {
         ERR_LDS_OK: number;
@@ -3015,7 +3055,6 @@ export declare const Enum: {
         ERR_LDS_VDS_NC_MISSING_OR_INCORRECT_SIG_ALGORITHM: number;
         ERR_LDS_VDS_NC_MISSING_OR_INCORRECT_CERTIFICATE: number;
         ERR_LDS_VDS_NC_MISSING_OR_INCORRECT_SIG_VALUE: number;
-        getTranslation(value: number): string;
     };
     eRFID_CertificateType: {
         CT_UNDEFINED: number;
@@ -3161,6 +3200,7 @@ export declare const Enum: {
         SCENARIO_OCR_FREE: string;
         SCENARIO_CREDIT_CARD: string;
         SCENARIO_CAPTURE: string;
+        SCENARIO_BARCODE_AND_LOCATE: string;
     };
     eRFID_AccessControl_ProcedureType: {
         ACPT_UNDEFINED: number;
@@ -3357,9 +3397,18 @@ export declare const Enum: {
         FINISHED_BY_TIMEOUT: number;
         HOLO_PHOTO_DOCUMENT_OUTSIDE_FRAME: number;
         LIVENESS_DEPTH_CHECK_FAILED: number;
-        MRZ_QUALITY_WRONG_MRZ_DPI: number;
+        MRZ_QUALITY_WRONG_SYMBOL_POSITION: number;
         MRZ_QUALITY_WRONG_BACKGROUND: number;
+        MRZ_QUALITY_WRONG_MRZ_WIDTH: number;
+        MRZ_QUALITY_WRONG_MRZ_HEIGHT: number;
+        MRZ_QUALITY_WRONG_LINE_POSITION: number;
+        MRZ_QUALITY_WRONG_FONT_TYPE: number;
+        OCR_QUALITY_TEXT_POSITION: number;
+        OCR_QUALITY_INVALID_FONT: number;
+        OCR_QUALITY_INVALID_BACKGROUND: number;
+        LAS_INK_INVALID_LINES_FREQUENCY: number;
         LAST_DIAGNOSE_VALUE: number;
+        DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED: number;
     };
     RFIDDelegate: {
         NULL: number;
@@ -3614,7 +3663,6 @@ export declare const Enum: {
         NTF_LDS_AUTH_ML_SIGNER_INFO_CERTIFICATE_CANT_FIND_CSCA: number;
         NTF_LDS_AUTH_ML_SIGNER_INFO_CERTIFICATE_REVOKED: number;
         NTF_LDS_AUTH_ML_SIGNER_INFO_CERTIFICATE_SIGNATURE_INVALID: number;
-        getTranslation(value: number): string;
     };
     eImageQualityCheckType: {
         IQC_IMAGE_GLARES: number;
@@ -3626,7 +3674,6 @@ export declare const Enum: {
         IQC_SCREEN_CAPTURE: number;
         IQC_PORTRAIT: number;
         IQC_HANDWRITTEN: number;
-        getTranslation(value: number): string;
     };
     MRZFormat: {
         FORMAT_1X30: string;
@@ -3658,7 +3705,7 @@ export declare const Enum: {
         CODE11: number;
     };
     eRPRM_SecurityFeatureType: {
-        NONE: number;
+        SECURITY_FEATURE_TYPE_NONE: number;
         SECURITY_FEATURE_TYPE_BLANK: number;
         SECURITY_FEATURE_TYPE_FILL: number;
         SECURITY_FEATURE_TYPE_PHOTO: number;
@@ -3687,7 +3734,22 @@ export declare const Enum: {
         SECURITY_FEATURE_TYPE_PHOTO_COLOR: number;
         SECURITY_FEATURE_TYPE_PHOTO_SHAPE: number;
         SECURITY_FEATURE_TYPE_PHOTO_CORNERS: number;
-        DOCUMENT_CANCELLING_DETECTOR: number;
+        SECURITY_FEATURE_TYPE_OCR: number;
+        SECURITY_FEATURE_TYPE_PORTRAIT_COMPARISON_EXTVS_VISUAL: number;
+        SECURITY_FEATURE_TYPE_PORTRAIT_COMPARISON_EXTVS_RFID: number;
+        SECURITY_FEATURE_TYPE_PORTRAIT_COMPARISON_EXTVS_LIVE: number;
+        SECURITY_FEATURE_TYPE_LIVENESS_DEPTH: number;
+        SECURITY_FEATURE_TYPE_MICROTEXT: number;
+        SECURITY_FEATURE_TYPE_FLUORESCENT_OBJECT: number;
+        SECURITY_FEATURE_TYPE_LANDMARKS_CHECK: number;
+        SECURITY_FEATURE_TYPE_FACE_PRESENCE: number;
+        SECURITY_FEATURE_TYPE_FACE_ABSENCE: number;
+        SECURITY_FEATURE_TYPE_LIVENESS_SCREEN_CAPTURE: number;
+        SECURITY_FEATURE_TYPE_LIVENESS_ELECTRONIC_DEVICE: number;
+        SECURITY_FEATURE_TYPE_LIVENESS_OVI: number;
+        SECURITY_FEATURE_TYPE_BARCODE_SIZE_CHECK: number;
+        SECURITY_FEATURE_TYPE_LAS_INK: number;
+        SECURITY_FEATURE_TYPE_LIVENESS_MLI: number;
     };
     OnlineMode: {
         MANUAL: number;
@@ -3972,7 +4034,6 @@ export declare const Enum: {
         GF_FINGER_RIGHT_MIDDLE: number;
         GF_FINGER_RIGHT_RING: number;
         GF_FINGER_RIGHT_LITTLE: number;
-        getTranslation(value: number): string;
     };
     RegDeviceConfigType: {
         DEVICE_7310: number;
@@ -4085,7 +4146,6 @@ export declare const Enum: {
         DFT_VDS: number;
         DFT_VDSNC: number;
         DFT_USERDEFINED: number;
-        getTranslation(value: number): string;
     };
     eVisualFieldType: {
         FT_DOCUMENT_CLASS_CODE: number;
@@ -4694,7 +4754,16 @@ export declare const Enum: {
         FT_DLCLASSCODE_PW_FROM: number;
         FT_DLCLASSCODE_PW_NOTES: number;
         FT_DLCLASSCODE_PW_TO: number;
-        getTranslation(value: number): string;
+        FT_DLCLASSCODE_EB_FROM: number;
+        FT_DLCLASSCODE_EB_NOTES: number;
+        FT_DLCLASSCODE_EB_TO: number;
+        FT_DLCLASSCODE_EC_FROM: number;
+        FT_DLCLASSCODE_EC_NOTES: number;
+        FT_DLCLASSCODE_EC_TO: number;
+        FT_DLCLASSCODE_EC1_FROM: number;
+        FT_DLCLASSCODE_EC1_NOTES: number;
+        FT_DLCLASSCODE_EC1_TO: number;
+        FT_PLACE_OF_BIRTH_CITY: number;
     };
     DocReaderOrientation: {
         ALL: number;
@@ -4860,7 +4929,6 @@ export declare const Enum: {
         VIETNAMESE: number;
         CTC_SIMPLIFIED: number;
         CTC_TRADITIONAL: number;
-        getTranslation(value: number): string;
     };
     DocReaderFrame: {
         MAX: string;
@@ -4877,7 +4945,7 @@ export declare const Enum: {
         RPRM_Light_IR_SIDE: number;
         RPRM_Light_IR_Full: number;
         RPRM_LIGHT_OVD: number;
-        getTranslation(value: number): string;
+        RPRM_LIGHT_WHITE_FULL_OVD: number;
     };
     LineCap: {
         Butt: number;
@@ -5439,6 +5507,20 @@ export declare class DocumentReaderOriginal extends AwesomeCordovaNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     recognizeImagesWithImageInputs(images: any): Promise<any>;
+    /**
+     *  Use this method to set OnClickListener
+     *  for buttons from UICustomizationLayer
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    setOnCustomButtonTappedListener(): Observable<any>;
+    /**
+     *  description
+     *
+     * @param {string} language description
+     * @return {Promise<any>} Returns a promise
+     */
+    setLanguage(language: any): Promise<any>;
     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>;