@regulaforensics/ionic-native-document-reader 8.4.244-nightly → 8.4.246-nightly

package/README.md

@@ -1,3 +1,8 @@
+# Deprecated
+This plugin is deprecated and `8.6` will be the last release. We kindly recommend migrating to our new plugin `@regulaforensics/document-reader`:
+* [github](https://github.com/regulaforensics/npm-document-reader)
+* [npmjs](https://www.npmjs.com/package/@regulaforensics/document-reader)
+
 #  Regula Document Reader SDK for Ionic
 
 Regula Document Reader SDK allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely _**offline**_ on your device. No any data leaving your device.

package/example/package.json

@@ -13,9 +13,9 @@
   },
   "private": true,
   "dependencies": {
-    "@regulaforensics/ionic-native-document-reader": "8.4.244-nightly",
-    "@regulaforensics/cordova-plugin-document-reader-api": "8.4.270-nightly",
-    "@regulaforensics/cordova-plugin-document-reader-core-fullauthrfid": "8.4.960-nightly",
+    "@regulaforensics/ionic-native-document-reader": "8.4.246-nightly",
+    "@regulaforensics/cordova-plugin-document-reader-api": "8.4.272-nightly",
+    "@regulaforensics/cordova-plugin-document-reader-core-fullauthrfid": "8.4.962-nightly",
     "cordova-plugin-camera": "7.0.0",
     "@awesome-cordova-plugins/camera": "6.6.0",
     "@awesome-cordova-plugins/core": "6.6.0",

package/index.d.ts

@@ -495,6 +495,7 @@ export declare class DocReaderConfig {
     customDb?: string;
     databasePath?: string;
     licenseUpdate?: boolean;
+    licenseUpdateTimeout?: number;
     delayedNNLoad?: boolean;
     blackList?: Record<string, string>;
     static fromJson(jsonObject?: any): DocReaderConfig | undefined;
@@ -585,6 +586,7 @@ export declare class Functionality {
     manualMultipageMode?: boolean;
     singleResult?: boolean;
     torchTurnedOn?: boolean;
+    preventScreenRecording?: boolean;
     showCaptureButtonDelayFromDetect?: number;
     showCaptureButtonDelayFromStart?: number;
     rfidTimeout?: number;
@@ -774,16 +776,24 @@ export declare class CustomizationColors {
     rfidProcessingScreenProgressBarBackground?: number;
     rfidProcessingScreenResultLabelText?: number;
     rfidProcessingScreenLoadingBar?: number;
+    rfidEnableNfcTitleText?: number;
+    rfidEnableNfcDescriptionText?: number;
+    rfidEnableNfcButtonText?: number;
+    rfidEnableNfcButtonBackground?: number;
     static fromJson(jsonObject?: any): CustomizationColors | undefined;
 }
 export declare class CustomizationFonts {
     rfidProcessingScreenHintLabel?: Font;
     rfidProcessingScreenProgressLabel?: Font;
     rfidProcessingScreenResultLabel?: Font;
+    rfidEnableNfcTitleText?: Font;
+    rfidEnableNfcDescriptionText?: Font;
+    rfidEnableNfcButtonText?: Font;
     static fromJson(jsonObject?: any): CustomizationFonts | undefined;
 }
 export declare class CustomizationImages {
     rfidProcessingScreenFailureImage?: string;
+    rfidEnableNfcImage?: string;
     static fromJson(jsonObject?: any): CustomizationImages | undefined;
 }
 export declare class Customization {
@@ -999,6 +1009,18 @@ export declare class PrepareProgress {
     progress?: number;
     static fromJson(jsonObject?: any): PrepareProgress | undefined;
 }
+export declare class FilterObjectType {
+    list?: any[];
+    isInclude?: boolean;
+    static fromJson(jsonObject?: any): FilterObjectType | undefined;
+}
+export declare class FilterObject {
+    docIDsFilter?: FilterObjectType;
+    docFormatsFilter?: FilterObjectType;
+    docCategoriesFilter?: FilterObjectType;
+    docCountriesFilter?: FilterObjectType;
+    static fromJson(jsonObject?: any): FilterObject | undefined;
+}
 export declare const FontStyle: {
     NORMAL: number;
     BOLD: number;
@@ -1037,6 +1059,10 @@ export declare const CustomizationColor: {
     RFID_PROCESSING_SCREEN_PROGRESS_BAR_BACKGROUND: string;
     RFID_PROCESSING_SCREEN_RESULT_LABEL_TEXT: string;
     RFID_PROCESSING_SCREEN_LOADING_BAR: string;
+    RFID_ENABLE_NFC_TITLE_TEXT: string;
+    RFID_ENABLE_NFC_DESCRIPTION_TEXT: string;
+    RFID_ENABLE_NFC_BUTTON_TEXT: string;
+    RFID_ENABLE_NFC_BUTTON_BACKGROUND: string;
 };
 export declare const eRFID_ErrorCodes: {
     RFID_ERROR_NO_ERROR: number;
@@ -1154,6 +1180,15 @@ export declare const eRFID_ErrorCodes: {
     RFID_ERROR_LAYER34_SAM_COLLISION: number;
     RFID_ERROR_LAYER34_SAM_ACKNOWLEDGE: number;
 };
+export declare const LivenessCheckType: {
+    OVI: string;
+    MLI: string;
+    HOLO: string;
+    ED: string;
+    BLACK_AND_WHITE_COPY: string;
+    DYNAPRINT: string;
+    GEOMETRY: string;
+};
 export declare const eLDS_ParsingErrorCodes: {
     ERR_LDS_OK: number;
     ERR_LDS_ASN_INCORRECT_DATA: number;
@@ -1361,6 +1396,9 @@ export declare const LineCap: {
     ROUND: number;
     SQUARE: number;
 };
+export declare const FilterCheckType: {
+    CHECK_AUTH: string;
+};
 export declare const eRPRM_FieldVerificationResult: {
     RCF_DISABLED: number;
     RCF_VERIFIED: number;
@@ -1430,6 +1468,7 @@ export declare const DocumentReaderErrorCodes: {
     SAVE_DB: number;
     DOWNLOAD_DB_INCORRECT_CHECKSUM: number;
     DB_DOWNLOAD: number;
+    RFID_ERROR: number;
     LICENSE_ABSENT_OR_CORRUPTED: number;
     LICENSE_INVALID_DATE: number;
     LICENSE_INVALID_VERSION: number;
@@ -1452,6 +1491,8 @@ export declare const DocumentReaderErrorCodes: {
     NATIVE_JAVA_EXCEPTION: number;
     BACKEND_ONLINE_PROCESSING: number;
     WRONG_INPUT: number;
+    RESULT_UNAVAILABLE: number;
+    RESULT_WRONG_OUTPUT: number;
     STATE_EXCEPTION: number;
     BLE_EXCEPTION: number;
     FEATURE_BLUETOOTH_LE_NOT_SUPPORTED: number;
@@ -1664,6 +1705,8 @@ export declare const eCheckDiagnose: {
     FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR: number;
     FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR: number;
     CHD_FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION: number;
+    CHD_FIELD_POS_CORRECTOR_AGE_CHECK_ERROR: number;
+    CHD_FIELD_POS_CORRECTOR_SEX_CHECK_ERROR: number;
     OVI_IR_INVISIBLE: number;
     OVI_INSUFFICIENT_AREA: number;
     OVI_COLOR_INVARIABLE: number;
@@ -2121,6 +2164,8 @@ export declare const eRPRM_SecurityFeatureType: {
     SECURITY_FEATURE_TYPE_LIVENESS_BLACK_AND_WHITE_COPY_CHECK: number;
     SECURITY_FEATURE_TYPE_LIVENESS_DYNAPRINT_CHECK: number;
     SECURITY_FEATURE_TYPE_LIVENESS_GEOMETRY_CHECK: number;
+    SECURITY_FEATURE_TYPE_AGE_CHECK: number;
+    SECURITY_FEATURE_TYPE_SEX_CHECK: number;
 };
 export declare const OnlineMode: {
     MANUAL: number;
@@ -2130,6 +2175,23 @@ export declare const eRFID_SDK_ProfilerType: {
     SPT_DOC_9303_EDITION_2006: number;
     SPT_DOC_9303_LDS_PKI_MAINTENANCE: number;
 };
+export declare const AuthenticityCheckType: {
+    USE_LIVENESS: string;
+    UV_LUMINISCENCE: string;
+    IR_B900: string;
+    IMAGE_PATTERNS: string;
+    FIBERS: string;
+    EXT_MRZ: string;
+    EXT_OCR: string;
+    AXIAL: string;
+    BARCODE_FORMAT: string;
+    IR_VISIBILITY: string;
+    IPI: string;
+    PHOTO_EMBEDDING: string;
+    PHOTO_COMPARISON: string;
+    LETTER_SCREEN: string;
+    SECURITY_TEXT: string;
+};
 export declare const diDocType: {
     dtNotDefined: number;
     dtPassport: number;
@@ -2390,6 +2452,9 @@ export declare const CustomizationFont: {
     RFID_PROCESSING_SCREEN_HINT_LABEL: string;
     RFID_PROCESSING_SCREEN_PROGRESS_LABEL: string;
     RFID_PROCESSING_SCREEN_RESULT_LABEL: string;
+    RFID_ENABLE_NFC_TITLE_TEXT: string;
+    RFID_ENABLE_NFC_DESCRIPTION_TEXT: string;
+    RFID_ENABLE_NFC_BUTTON_TEXT: string;
 };
 export declare const ImageFormat: {
     PNG: number;
@@ -3383,6 +3448,7 @@ export declare const LCID: {
 };
 export declare const CustomizationImage: {
     RFID_PROCESSING_SCREEN_FAILURE_IMAGE: string;
+    RFID_ENABLE_NFC_IMAGE: string;
 };
 export declare const DocReaderFrame: {
     MAX: string;
@@ -3445,6 +3511,10 @@ export declare const Enum: {
         RFID_PROCESSING_SCREEN_PROGRESS_BAR_BACKGROUND: string;
         RFID_PROCESSING_SCREEN_RESULT_LABEL_TEXT: string;
         RFID_PROCESSING_SCREEN_LOADING_BAR: string;
+        RFID_ENABLE_NFC_TITLE_TEXT: string;
+        RFID_ENABLE_NFC_DESCRIPTION_TEXT: string;
+        RFID_ENABLE_NFC_BUTTON_TEXT: string;
+        RFID_ENABLE_NFC_BUTTON_BACKGROUND: string;
     };
     eRFID_ErrorCodes: {
         RFID_ERROR_NO_ERROR: number;
@@ -3562,6 +3632,15 @@ export declare const Enum: {
         RFID_ERROR_LAYER34_SAM_COLLISION: number;
         RFID_ERROR_LAYER34_SAM_ACKNOWLEDGE: number;
     };
+    LivenessCheckType: {
+        OVI: string;
+        MLI: string;
+        HOLO: string;
+        ED: string;
+        BLACK_AND_WHITE_COPY: string;
+        DYNAPRINT: string;
+        GEOMETRY: string;
+    };
     eLDS_ParsingErrorCodes: {
         ERR_LDS_OK: number;
         ERR_LDS_ASN_INCORRECT_DATA: number;
@@ -3769,6 +3848,9 @@ export declare const Enum: {
         ROUND: number;
         SQUARE: number;
     };
+    FilterCheckType: {
+        CHECK_AUTH: string;
+    };
     eRPRM_FieldVerificationResult: {
         RCF_DISABLED: number;
         RCF_VERIFIED: number;
@@ -3838,6 +3920,7 @@ export declare const Enum: {
         SAVE_DB: number;
         DOWNLOAD_DB_INCORRECT_CHECKSUM: number;
         DB_DOWNLOAD: number;
+        RFID_ERROR: number;
         LICENSE_ABSENT_OR_CORRUPTED: number;
         LICENSE_INVALID_DATE: number;
         LICENSE_INVALID_VERSION: number;
@@ -3860,6 +3943,8 @@ export declare const Enum: {
         NATIVE_JAVA_EXCEPTION: number;
         BACKEND_ONLINE_PROCESSING: number;
         WRONG_INPUT: number;
+        RESULT_UNAVAILABLE: number;
+        RESULT_WRONG_OUTPUT: number;
         STATE_EXCEPTION: number;
         BLE_EXCEPTION: number;
         FEATURE_BLUETOOTH_LE_NOT_SUPPORTED: number;
@@ -4072,6 +4157,8 @@ export declare const Enum: {
         FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR: number;
         FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR: number;
         CHD_FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION: number;
+        CHD_FIELD_POS_CORRECTOR_AGE_CHECK_ERROR: number;
+        CHD_FIELD_POS_CORRECTOR_SEX_CHECK_ERROR: number;
         OVI_IR_INVISIBLE: number;
         OVI_INSUFFICIENT_AREA: number;
         OVI_COLOR_INVARIABLE: number;
@@ -4529,6 +4616,8 @@ export declare const Enum: {
         SECURITY_FEATURE_TYPE_LIVENESS_BLACK_AND_WHITE_COPY_CHECK: number;
         SECURITY_FEATURE_TYPE_LIVENESS_DYNAPRINT_CHECK: number;
         SECURITY_FEATURE_TYPE_LIVENESS_GEOMETRY_CHECK: number;
+        SECURITY_FEATURE_TYPE_AGE_CHECK: number;
+        SECURITY_FEATURE_TYPE_SEX_CHECK: number;
     };
     OnlineMode: {
         MANUAL: number;
@@ -4538,6 +4627,23 @@ export declare const Enum: {
         SPT_DOC_9303_EDITION_2006: number;
         SPT_DOC_9303_LDS_PKI_MAINTENANCE: number;
     };
+    AuthenticityCheckType: {
+        USE_LIVENESS: string;
+        UV_LUMINISCENCE: string;
+        IR_B900: string;
+        IMAGE_PATTERNS: string;
+        FIBERS: string;
+        EXT_MRZ: string;
+        EXT_OCR: string;
+        AXIAL: string;
+        BARCODE_FORMAT: string;
+        IR_VISIBILITY: string;
+        IPI: string;
+        PHOTO_EMBEDDING: string;
+        PHOTO_COMPARISON: string;
+        LETTER_SCREEN: string;
+        SECURITY_TEXT: string;
+    };
     diDocType: {
         dtNotDefined: number;
         dtPassport: number;
@@ -4798,6 +4904,9 @@ export declare const Enum: {
         RFID_PROCESSING_SCREEN_HINT_LABEL: string;
         RFID_PROCESSING_SCREEN_PROGRESS_LABEL: string;
         RFID_PROCESSING_SCREEN_RESULT_LABEL: string;
+        RFID_ENABLE_NFC_TITLE_TEXT: string;
+        RFID_ENABLE_NFC_DESCRIPTION_TEXT: string;
+        RFID_ENABLE_NFC_BUTTON_TEXT: string;
     };
     ImageFormat: {
         PNG: number;
@@ -5791,6 +5900,7 @@ export declare const Enum: {
     };
     CustomizationImage: {
         RFID_PROCESSING_SCREEN_FAILURE_IMAGE: string;
+        RFID_ENABLE_NFC_IMAGE: string;
     };
     DocReaderFrame: {
         MAX: string;
@@ -6225,6 +6335,69 @@ export declare class DocumentReaderOriginal extends AwesomeCordovaNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     getTranslation(className: string, value: number): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} checkType
+     * @param {FilterObject} filter
+     * @return {Promise<any>} Returns a promise
+     */
+    processParamsSetCheckFilter(checkType: string, filter: FilterObject): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} checkType
+     * @return {Promise<any>} Returns a promise
+     */
+    processParamsRemoveCheckFilter(checkType: string): Promise<any>;
+    /**
+     *
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    processParamsClearCheckFilter(): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} checkType
+     * @param {FilterObject} filter
+     * @return {Promise<any>} Returns a promise
+     */
+    authenticityParamsSetCheckFilter(checkType: string, filter: FilterObject): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} checkType
+     * @return {Promise<any>} Returns a promise
+     */
+    authenticityParamsRemoveCheckFilter(checkType: string): Promise<any>;
+    /**
+     *
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    authenticityParamsClearCheckFilter(): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} checkType
+     * @param {FilterObject} filter
+     * @return {Promise<any>} Returns a promise
+     */
+    livenessParamsSetCheckFilter(checkType: string, filter: FilterObject): Promise<any>;
+    /**
+     *
+     *
+     * @param {string} checkType
+     * @return {Promise<any>} Returns a promise
+     */
+    livenessParamsRemoveCheckFilter(checkType: string): Promise<any>;
+    /**
+     *
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    livenessParamsClearCheckFilter(): 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>;