@regulaforensics/ionic-native-document-reader 5.6.0 → 6.1.1

package/ngx/index.d.ts

@@ -1,14 +1,12 @@
 import { IonicNativePlugin } from '@ionic-native/core';
 import { Observable } from 'rxjs';
 export declare class DocumentReaderScenario {
-    uvTorch?: boolean;
-    seriesProcessMode?: boolean;
     name?: string;
     caption?: string;
     description?: string;
     static fromJson(jsonObject?: any): DocumentReaderScenario;
 }
-export declare class DocumentReaderScenarioFull {
+export declare class CoreDetailedScenario {
     uvTorch?: boolean;
     frameOrientation?: number;
     faceExt?: boolean;
@@ -22,7 +20,7 @@ export declare class DocumentReaderScenarioFull {
     caption?: string;
     description?: string;
     manualCrop?: boolean;
-    static fromJson(jsonObject?: any): DocumentReaderScenarioFull;
+    static fromJson(jsonObject?: any): CoreDetailedScenario;
 }
 export declare class FaceMetaData {
     ID?: number;
@@ -346,9 +344,22 @@ export declare class DocumentReaderAuthenticityElement {
 export declare class DocumentReaderCompletion {
     action?: number;
     results?: DocumentReaderResults;
-    error?: Throwable;
+    error?: DocumentReaderException;
     static fromJson(jsonObject?: any): DocumentReaderCompletion;
 }
+export declare class RfidNotificationCompletion {
+    notification?: number;
+    value?: number;
+    static fromJson(jsonObject?: any): RfidNotificationCompletion;
+}
+export declare class DocumentReaderException {
+    errorCode?: number;
+    localizedMessage?: string;
+    message?: string;
+    string?: string;
+    stackTrace?: StackTraceElement[];
+    static fromJson(jsonObject?: any): DocumentReaderException;
+}
 export declare class Throwable {
     localizedMessage?: string;
     message?: string;
@@ -377,6 +388,76 @@ export declare class ImageInputParam {
     type?: number;
     static fromJson(jsonObject?: any): ImageInputParam;
 }
+export declare class PAResourcesIssuer {
+    data?: any[];
+    friendlyName?: string;
+    attributes?: PAAttribute[];
+    static fromJson(jsonObject?: any): PAResourcesIssuer;
+}
+export declare class PAAttribute {
+    type?: string;
+    value?: string;
+    static fromJson(jsonObject?: any): PAAttribute;
+}
+export declare class TAChallenge {
+    data?: any[];
+    auxPCD?: string;
+    challengePICC?: string;
+    hashPK?: string;
+    idPICC?: string;
+    static fromJson(jsonObject?: any): TAChallenge;
+}
+export declare class DocumentReaderResultsStatus {
+    overallStatus?: number;
+    optical?: number;
+    detailsOptical?: DetailsOptical;
+    rfid?: number;
+    detailsRFID?: DetailsRFID;
+    portrait?: number;
+    stopList?: number;
+    static fromJson(jsonObject?: any): DocumentReaderResultsStatus;
+}
+export declare class DetailsOptical {
+    overallStatus?: number;
+    mrz?: number;
+    text?: number;
+    docType?: number;
+    security?: number;
+    imageQA?: number;
+    expiry?: number;
+    vds?: number;
+    pagesCount?: number;
+    static fromJson(jsonObject?: any): DetailsOptical;
+}
+export declare class DetailsRFID {
+    pa?: number;
+    ca?: number;
+    aa?: number;
+    ta?: number;
+    bac?: number;
+    pace?: number;
+    overallStatus?: number;
+    static fromJson(jsonObject?: any): DetailsRFID;
+}
+export declare class VDSNCData {
+    type?: string;
+    version?: number;
+    issuingCountry?: string;
+    message?: any;
+    signatureAlgorithm?: string;
+    signature?: BytesData;
+    certificate?: BytesData;
+    certificateChain?: CertificateChain[];
+    notifications?: number[];
+    static fromJson(jsonObject?: any): VDSNCData;
+}
+export declare class BytesData {
+    data?: string;
+    length?: number;
+    status?: number;
+    type?: number;
+    static fromJson(jsonObject?: any): BytesData;
+}
 export declare class DocumentReaderResults {
     chipPage?: number;
     overallResult?: number;
@@ -398,6 +479,8 @@ export declare class DocumentReaderResults {
     authenticityResult?: DocumentReaderAuthenticityResult;
     barcodeResult?: DocumentReaderBarcodeResult;
     documentType?: DocumentReaderDocumentType[];
+    status?: DocumentReaderResultsStatus;
+    vdsncData?: VDSNCData;
     getTextFieldValueByType?({ fieldType, lcid, source, original }: {
         fieldType: number;
         lcid?: number;
@@ -745,6 +828,24 @@ export declare const DocReaderOrientation: {
     LANDSCAPE_LEFT: number;
     LANDSCAPE_RIGHT: number;
 };
+export declare const DocumentReaderExceptionEnum: {
+    NATIVE_JAVA_EXCEPTION: number;
+    DOCUMENT_READER_STATE_EXCEPTION: number;
+    DOCUMENT_READER_WRONG_INPUT: number;
+    INITIALIZATION_FAILED: number;
+    DOCUMENT_READER_BLE_EXCEPTION: number;
+    DB_DOWNLOAD_ERROR: number;
+    LICENSE_ABSENT_OR_CORRUPTED: number;
+    LICENSE_INVALID_DATE: number;
+    LICENSE_INVALID_VERSION: number;
+    LICENSE_INVALID_DEVICE_ID: number;
+    LICENSE_INVALID_SYSTEM_OR_APP_ID: number;
+    LICENSE_NO_CAPABILITIES: number;
+    LICENSE_NO_AUTHENTICITY: number;
+    LICENSE_NO_DATABASE: number;
+    LICENSE_DATABASE_INCORRECT: number;
+    FEATURE_BLUETOOTH_LE_NOT_SUPPORTED: number;
+};
 export declare const eCheckDiagnose: {
     UNKNOWN: number;
     PASS: number;
@@ -930,6 +1031,10 @@ export declare const eRFID_CertificateType: {
     CT_MLS: number;
     CT_DEV_LS: number;
     CT_DEF_LS: number;
+    CT_BLS: number;
+    CT_LDS2: number;
+    CT_BCS: number;
+    CT_BCSNC: number;
 };
 export declare const eRFID_DataFile_Type: {
     DFT_UNSPECIFIED: number;
@@ -1012,6 +1117,10 @@ export declare const eRFID_DataFile_Type: {
     DFT_SESSION: number;
     DFT_LOGDATA: number;
     DFT_CHIP_PROPERTIES: number;
+    DFT_SAM_DATA: number;
+    DFT_SAM_DATA_MAX: number;
+    DFT_VDS: number;
+    DFT_VDSNC: number;
     DFT_USERDEFINED: number;
     getTranslation(value: number): string;
 };
@@ -1072,6 +1181,7 @@ export declare const eRFID_NotificationAndErrorCodes: {
     RFID_ERROR_INVALID_PARAMETER: number;
     RFID_ERROR_NOT_INITIALIZED: number;
     RFID_Error_NotEnoughMemory: number;
+    RFID_ERROR_NOT_ENOUGH_DATA: number;
     RFID_ERROR_INVALID_DIRECTORY: number;
     RFID_ERROR_UNKNOWN_COMMAND: number;
     RFID_ERROR_FILE_IO_ERROR: number;
@@ -1150,6 +1260,22 @@ export declare const eRFID_NotificationAndErrorCodes: {
     RFID_LAYER6_EXT_AUTH_FAILURE: number;
     RFID_LAYER6_GENERAL_AUTH_FAILURE: number;
     RFID_ERROR_FAILED: number;
+    RFID_ERROR_CODES_LAYER_34_NO_ERROR: number;
+    RFID_ERROR_CODES_LAYER_34_TIMEOUT: number;
+    RFID_ERROR_CODES_LAYER_34_COLLISION: number;
+    RFID_ERROR_CODES_LAYER_34_CRC: number;
+    RFID_ERROR_CODES_LAYER_34_DATA_INTEGRITY: number;
+    RFID_ERROR_CODES_LAYER_34_DATA_LENGTH: number;
+    RFID_ERROR_CODES_LAYER_34_RFU: number;
+    RFID_ERROR_CODES_LAYER_34_COLLISION_TOO_MANY: number;
+    RFID_ERROR_CODES_LAYER_34_PROTOCOL_B: number;
+    RFID_ERROR_CODES_LAYER_34_DATA_CONTENTS: number;
+    RFID_ERROR_CODES_LAYER_34_PROTOCOL: number;
+    RFID_ERROR_CODES_LAYER_34_GLOBAL_TIMEOUT: number;
+    RFID_ERROR_CODES_LAYER_34_MIFARE_AUTH: number;
+    RFID_ERROR_CODES_LAYER_34_SAM_ERROR: number;
+    RFID_ERROR_CODES_LAYER_34_SAM_COLLISION: number;
+    RFID_ERROR_CODES_LAYER_34_SAM_ACKNOWLEDGE: number;
     getTranslation(value: number): string;
 };
 export declare const eRFID_Password_Type: {
@@ -1229,6 +1355,8 @@ export declare const eRPRM_ResultType: {
     RPRM_RESULT_TYPE_DATABASE_CHECK: number;
     RPRM_RESULT_TYPE_FINGERPRINT_TEMPLATE_ISO: number;
     RPRM_RESULT_TYPE_INPUT_IMAGE_QUALITY: number;
+    RPRM_RESULT_TYPE_IMAGES: number;
+    RPRM_RESULT_TYPE_HOLO_PARAMS: number;
     RPRM_RESULT_TYPE_DOCUMENT_POSITION: number;
     RPRM_RESULT_TYPE_CUSTOM: number;
     RFID_RESULT_TYPE_RFID_RAW_DATA: number;
@@ -1238,6 +1366,7 @@ export declare const eRPRM_ResultType: {
     RFID_RESULT_TYPE_RFID_ORIGINAL_GRAPHICS: number;
     RPRM_RESULT_TYPE_BARCODE_POSITION: number;
     RPRM_RESULT_TYPE_MRZ_POSITION: number;
+    RPRM_RESULT_TYPE_STATUS: number;
 };
 export declare const eRPRM_SecurityFeatureType: {
     NONE: number;
@@ -1868,6 +1997,15 @@ export declare const eVisualFieldType: {
     FT_DLCLASSCODE_D3_FROM: number;
     FT_DLCLASSCODE_D3_TO: number;
     FT_DLCLASSCODE_D3_NOTES: number;
+    FT_ALT_DATE_OF_EXPIRY: number;
+    FT_DLCLASSCODE_CD_FROM: number;
+    FT_DLCLASSCODE_CD_TO: number;
+    FT_DLCLASSCODE_CD_NOTES: number;
+    FT_PAYMENT_PERIOD_TO: number;
+    FT_PAYMENT_PERIOD_FROM: number;
+    FT_ISSUER_IDENTIFICATION_NUMBER: number;
+    FT_VACCINATION_CERTIFICATE_IDENTIFIER: number;
+    FT_FIRST_NAME: number;
     getTranslation(value: number): string;
 };
 export declare const FontStyle: {
@@ -1880,6 +2018,11 @@ export declare const FrameShapeType: {
     LINE: number;
     CORNER: number;
 };
+export declare const IRfidNotificationCompletion: {
+    RFID_EVENT_CHIP_DETECTED: number;
+    RFID_EVENT_READING_ERROR: number;
+    RFID_EXTRA_ERROR_CODE: string;
+};
 export declare const LCID: {
     LATIN: number;
     AFRIKAANS: number;
@@ -2040,6 +2183,11 @@ export declare const ProcessingFinishedStatus: {
     READY: number;
     TIMEOUT: number;
 };
+export declare const RFIDDelegate: {
+    NULL: number;
+    NO_PA: number;
+    FULL: number;
+};
 export declare const RGLMeasureSystem: {
     METRIC: number;
     IMPERIAL: number;
@@ -2440,6 +2588,24 @@ export declare const Enum: {
         LANDSCAPE_LEFT: number;
         LANDSCAPE_RIGHT: number;
     };
+    DocumentReaderExceptionEnum: {
+        NATIVE_JAVA_EXCEPTION: number;
+        DOCUMENT_READER_STATE_EXCEPTION: number;
+        DOCUMENT_READER_WRONG_INPUT: number;
+        INITIALIZATION_FAILED: number;
+        DOCUMENT_READER_BLE_EXCEPTION: number;
+        DB_DOWNLOAD_ERROR: number;
+        LICENSE_ABSENT_OR_CORRUPTED: number;
+        LICENSE_INVALID_DATE: number;
+        LICENSE_INVALID_VERSION: number;
+        LICENSE_INVALID_DEVICE_ID: number;
+        LICENSE_INVALID_SYSTEM_OR_APP_ID: number;
+        LICENSE_NO_CAPABILITIES: number;
+        LICENSE_NO_AUTHENTICITY: number;
+        LICENSE_NO_DATABASE: number;
+        LICENSE_DATABASE_INCORRECT: number;
+        FEATURE_BLUETOOTH_LE_NOT_SUPPORTED: number;
+    };
     eCheckDiagnose: {
         UNKNOWN: number;
         PASS: number;
@@ -2625,6 +2791,10 @@ export declare const Enum: {
         CT_MLS: number;
         CT_DEV_LS: number;
         CT_DEF_LS: number;
+        CT_BLS: number;
+        CT_LDS2: number;
+        CT_BCS: number;
+        CT_BCSNC: number;
     };
     eRFID_DataFile_Type: {
         DFT_UNSPECIFIED: number;
@@ -2707,6 +2877,10 @@ export declare const Enum: {
         DFT_SESSION: number;
         DFT_LOGDATA: number;
         DFT_CHIP_PROPERTIES: number;
+        DFT_SAM_DATA: number;
+        DFT_SAM_DATA_MAX: number;
+        DFT_VDS: number;
+        DFT_VDSNC: number;
         DFT_USERDEFINED: number;
         getTranslation(value: number): string;
     };
@@ -2767,6 +2941,7 @@ export declare const Enum: {
         RFID_ERROR_INVALID_PARAMETER: number;
         RFID_ERROR_NOT_INITIALIZED: number;
         RFID_Error_NotEnoughMemory: number;
+        RFID_ERROR_NOT_ENOUGH_DATA: number;
         RFID_ERROR_INVALID_DIRECTORY: number;
         RFID_ERROR_UNKNOWN_COMMAND: number;
         RFID_ERROR_FILE_IO_ERROR: number;
@@ -2845,6 +3020,22 @@ export declare const Enum: {
         RFID_LAYER6_EXT_AUTH_FAILURE: number;
         RFID_LAYER6_GENERAL_AUTH_FAILURE: number;
         RFID_ERROR_FAILED: number;
+        RFID_ERROR_CODES_LAYER_34_NO_ERROR: number;
+        RFID_ERROR_CODES_LAYER_34_TIMEOUT: number;
+        RFID_ERROR_CODES_LAYER_34_COLLISION: number;
+        RFID_ERROR_CODES_LAYER_34_CRC: number;
+        RFID_ERROR_CODES_LAYER_34_DATA_INTEGRITY: number;
+        RFID_ERROR_CODES_LAYER_34_DATA_LENGTH: number;
+        RFID_ERROR_CODES_LAYER_34_RFU: number;
+        RFID_ERROR_CODES_LAYER_34_COLLISION_TOO_MANY: number;
+        RFID_ERROR_CODES_LAYER_34_PROTOCOL_B: number;
+        RFID_ERROR_CODES_LAYER_34_DATA_CONTENTS: number;
+        RFID_ERROR_CODES_LAYER_34_PROTOCOL: number;
+        RFID_ERROR_CODES_LAYER_34_GLOBAL_TIMEOUT: number;
+        RFID_ERROR_CODES_LAYER_34_MIFARE_AUTH: number;
+        RFID_ERROR_CODES_LAYER_34_SAM_ERROR: number;
+        RFID_ERROR_CODES_LAYER_34_SAM_COLLISION: number;
+        RFID_ERROR_CODES_LAYER_34_SAM_ACKNOWLEDGE: number;
         getTranslation(value: number): string;
     };
     eRFID_Password_Type: {
@@ -2924,6 +3115,8 @@ export declare const Enum: {
         RPRM_RESULT_TYPE_DATABASE_CHECK: number;
         RPRM_RESULT_TYPE_FINGERPRINT_TEMPLATE_ISO: number;
         RPRM_RESULT_TYPE_INPUT_IMAGE_QUALITY: number;
+        RPRM_RESULT_TYPE_IMAGES: number;
+        RPRM_RESULT_TYPE_HOLO_PARAMS: number;
         RPRM_RESULT_TYPE_DOCUMENT_POSITION: number;
         RPRM_RESULT_TYPE_CUSTOM: number;
         RFID_RESULT_TYPE_RFID_RAW_DATA: number;
@@ -2933,6 +3126,7 @@ export declare const Enum: {
         RFID_RESULT_TYPE_RFID_ORIGINAL_GRAPHICS: number;
         RPRM_RESULT_TYPE_BARCODE_POSITION: number;
         RPRM_RESULT_TYPE_MRZ_POSITION: number;
+        RPRM_RESULT_TYPE_STATUS: number;
     };
     eRPRM_SecurityFeatureType: {
         NONE: number;
@@ -3563,6 +3757,15 @@ export declare const Enum: {
         FT_DLCLASSCODE_D3_FROM: number;
         FT_DLCLASSCODE_D3_TO: number;
         FT_DLCLASSCODE_D3_NOTES: number;
+        FT_ALT_DATE_OF_EXPIRY: number;
+        FT_DLCLASSCODE_CD_FROM: number;
+        FT_DLCLASSCODE_CD_TO: number;
+        FT_DLCLASSCODE_CD_NOTES: number;
+        FT_PAYMENT_PERIOD_TO: number;
+        FT_PAYMENT_PERIOD_FROM: number;
+        FT_ISSUER_IDENTIFICATION_NUMBER: number;
+        FT_VACCINATION_CERTIFICATE_IDENTIFIER: number;
+        FT_FIRST_NAME: number;
         getTranslation(value: number): string;
     };
     FontStyle: {
@@ -3575,6 +3778,11 @@ export declare const Enum: {
         LINE: number;
         CORNER: number;
     };
+    IRfidNotificationCompletion: {
+        RFID_EVENT_CHIP_DETECTED: number;
+        RFID_EVENT_READING_ERROR: number;
+        RFID_EXTRA_ERROR_CODE: string;
+    };
     LCID: {
         LATIN: number;
         AFRIKAANS: number;
@@ -3735,6 +3943,11 @@ export declare const Enum: {
         READY: number;
         TIMEOUT: number;
     };
+    RFIDDelegate: {
+        NULL: number;
+        NO_PA: number;
+        FULL: number;
+    };
     RGLMeasureSystem: {
         METRIC: number;
         IMPERIAL: number;
@@ -3834,6 +4047,16 @@ export declare const Enum: {
  * ```
  */
 export declare class DocumentReader extends IonicNativePlugin {
+    /**
+     *  Initially made for capacitor as it has no convenient way to read assets
+     *  Allows you to initialize document reader without reading license yourself.
+     *  License will be automatically read from
+     *  Android: "android/app/src/main/assets/regula.license"
+     *  iOS: "ios/App/App/regula.license"
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    initializeReaderAutomatically(): Promise<any>;
     /**
      *  Allows you to get the API version
      *
@@ -4044,6 +4267,17 @@ export declare class DocumentReader extends IonicNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     getRfidSessionStatus(): Promise<any>;
+    /**
+     *  Use this method to set RFID delegate on iOS to either null,
+     *  delegate with onRequestPACertificates callback or without
+     *
+     * @param {int} delegate use enum RFIDDelegate
+     *  NULL = 0
+     *  NO_PA = 1
+     *  FULL = 2
+     * @return {Promise<any>} Returns a promise
+     */
+    setRfidDelegate(delegate: any): Promise<any>;
     /**
      *  Use this method to enable Core logs
      *
@@ -4145,6 +4379,43 @@ export declare class DocumentReader extends IonicNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     setRfidSessionStatus(status: any): Promise<any>;
+    /**
+     *  Use this method to send PACertificates to the chip after you`ve got a request for them
+     *
+     * @param {PKDCertificate[]} certificates Array of jsonObjects with structure {binaryData: binaryData, resourceType: resourceType, privateKey: privateKey}
+     *  binaryData - base64 string
+     *  resourceType - number
+     *  privateKey(optional) - base64 string
+     * @return {Promise<any>} Returns a promise
+     */
+    providePACertificates(certificates: any): Promise<any>;
+    /**
+     *  Use this method to send TACertificates to the chip after you`ve got a request for them
+     *
+     * @param {PKDCertificate[]} certificates Array of jsonObjects with structure {binaryData: binaryData, resourceType: resourceType, privateKey: privateKey}
+     *  binaryData - base64 string
+     *  resourceType - number
+     *  privateKey(optional) - base64 string
+     * @return {Promise<any>} Returns a promise
+     */
+    provideTACertificates(certificates: any): Promise<any>;
+    /**
+     *  Use this method to send TASignature to the chip after you`ve got a request for them
+     *
+     * @param {byte[]} certificates Array of jsonObjects with structure {binaryData: binaryData, resourceType: resourceType, privateKey: privateKey}
+     *  binaryData - base64 string
+     *  resourceType - number
+     *  privateKey(optional) - base64 string
+     * @return {Promise<any>} Returns a promise
+     */
+    provideTASignature(certificates: any): Promise<any>;
+    /**
+     *  Use this method to parse results returned by the server when using an encrypted license
+     *
+     * @param {string} json results to parse
+     * @return {Promise<any>} Returns a promise
+     */
+    parseCoreResults(json: any): Promise<any>;
     /**
      *  Use this method to initialize Document Reader with the path to the database
      *
@@ -4153,6 +4424,14 @@ export declare class DocumentReader extends IonicNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     initializeReaderWithDatabasePath(license: any, path: any): Promise<any>;
+    /**
+     *  Use this method to initialize Document Reader with database binary
+     *
+     * @param {string} license License`s base64 representation
+     * @param {string} db Database`s base64 representation
+     * @return {Promise<any>} Returns a promise
+     */
+    initializeReaderWithDatabase(license: any, db: any): Promise<any>;
     /**
      *  Use this method to recognize an image frame
      *