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

package/ngx/index.d.ts

@@ -73,6 +73,8 @@ export declare class DocumentReaderValue {
     originalValue?: string;
     boundRect?: Rect;
     comparison?: Record<number, number>;
+    originalSymbols?: DocumentReaderSymbol[];
+    rfidOrigin?: DocumentReaderRfidOrigin;
     static fromJson(jsonObject?: any): DocumentReaderValue | undefined;
 }
 export declare class DocumentReaderTextField {
@@ -81,12 +83,18 @@ export declare class DocumentReaderTextField {
     status?: number;
     lcidName?: string;
     fieldName?: string;
-    value?: DocumentReaderValue;
+    value?: string;
+    getValue?: DocumentReaderValue;
     values?: DocumentReaderValue[];
+    comparisonList?: DocumentReaderComparison[];
+    validityList?: DocumentReaderValidity[];
     static fromJson(jsonObject?: any): DocumentReaderTextField | undefined;
 }
 export declare class DocumentReaderTextResult {
     status?: number;
+    comparisonStatus?: number;
+    validityStatus?: number;
+    availableSourceList?: DocumentReaderTextSource[];
     fields?: DocumentReaderTextField[];
     static fromJson(jsonObject?: any): DocumentReaderTextResult | undefined;
 }
@@ -343,28 +351,9 @@ export declare class RfidNotificationCompletion {
 }
 export declare class DocumentReaderException {
     errorCode?: number;
-    localizedMessage?: string;
     message?: string;
-    string?: string;
-    stackTrace?: StackTraceElement[];
     static fromJson(jsonObject?: any): DocumentReaderException | undefined;
 }
-export declare class Throwable {
-    localizedMessage?: string;
-    message?: string;
-    string?: string;
-    stackTrace?: StackTraceElement[];
-    static fromJson(jsonObject?: any): Throwable | undefined;
-}
-export declare class StackTraceElement {
-    lineNumber?: number;
-    isNativeMethod?: boolean;
-    className?: string;
-    fileName?: string;
-    methodName?: string;
-    string?: string;
-    static fromJson(jsonObject?: any): StackTraceElement | undefined;
-}
 export declare class PKDCertificate {
     binaryData?: string;
     resourceType?: number;
@@ -447,21 +436,6 @@ export declare class BytesData {
     type?: number;
     static fromJson(jsonObject?: any): BytesData | undefined;
 }
-export declare class DocumentReaderUvFiberElement {
-    rectArray?: DocReaderFieldRect[];
-    rectCount?: number;
-    expectedCount?: number;
-    width?: number[];
-    length?: number[];
-    area?: number[];
-    colorValues?: number[];
-    status?: number;
-    elementType?: number;
-    elementDiagnose?: number;
-    elementTypeName?: string;
-    elementDiagnoseName?: string;
-    static fromJson(jsonObject?: any): DocumentReaderUvFiberElement | undefined;
-}
 export declare class ImageInputData {
     pageIndex?: number;
     light?: number;
@@ -472,6 +446,45 @@ export declare class ImageInputData {
     imgBytes?: any[];
     static fromJson(jsonObject?: any): ImageInputData | undefined;
 }
+export declare class DocReaderDocumentsDatabase {
+    databaseID?: string;
+    version?: string;
+    date?: string;
+    databaseDescription?: string;
+    countriesNumber?: number;
+    documentsNumber?: number;
+    static fromJson(jsonObject?: any): DocReaderDocumentsDatabase | undefined;
+}
+export declare class DocumentReaderComparison {
+    sourceTypeLeft?: number;
+    sourceTypeRight?: number;
+    status?: number;
+    static fromJson(jsonObject?: any): DocumentReaderComparison | undefined;
+}
+export declare class DocumentReaderRfidOrigin {
+    dg?: number;
+    dgTag?: number;
+    entryView?: number;
+    tagEntry?: number;
+    static fromJson(jsonObject?: any): DocumentReaderRfidOrigin | undefined;
+}
+export declare class DocumentReaderTextSource {
+    sourceType?: number;
+    source?: string;
+    validityStatus?: number;
+    static fromJson(jsonObject?: any): DocumentReaderTextSource | undefined;
+}
+export declare class DocumentReaderSymbol {
+    code?: number;
+    rect?: Rect;
+    probability?: number;
+    static fromJson(jsonObject?: any): DocumentReaderSymbol | undefined;
+}
+export declare class DocumentReaderValidity {
+    sourceType?: number;
+    status?: number;
+    static fromJson(jsonObject?: any): DocumentReaderValidity | undefined;
+}
 export declare class DocumentReaderResults {
     chipPage?: number;
     processingFinishedStatus?: number;
@@ -494,28 +507,6 @@ export declare class DocumentReaderResults {
     documentType?: DocumentReaderDocumentType[];
     status?: DocumentReaderResultsStatus;
     vdsncData?: VDSNCData;
-    getTextFieldValueByType({ fieldType, lcid, source, original }: {
-        fieldType: number;
-        lcid?: number;
-        source?: number;
-        original?: boolean;
-    }): string | undefined;
-    getTextFieldStatusByType(fieldType: number, lcid?: number): number;
-    getGraphicFieldImageByType({ fieldType, source, light, pageIndex }: {
-        fieldType: number;
-        source?: number;
-        light?: number;
-        pageIndex?: number;
-    }): string | undefined;
-    getQualityResult({ imageQualityCheckType, securityFeature, pageIndex }: {
-        imageQualityCheckType: number;
-        securityFeature?: number;
-        pageIndex?: number;
-    }): number;
-    findByTypeAndLcid(type: number, lcid?: number): DocumentReaderTextField | undefined;
-    findBySource(field: DocumentReaderTextField, sourceType: number): DocumentReaderValue | undefined;
-    getContainers(resultTypes: number[]): string | undefined;
-    getEncryptedContainers(): string | undefined;
     static fromJson(jsonObject?: any): DocumentReaderResults | undefined;
 }
 export declare const FontStyle: {
@@ -541,6 +532,7 @@ export declare const eRPRM_Authenticity: {
     BARCODE_FORMAT_CHECK: number;
     KINEGRAM: number;
     HOLOGRAMS_DETECTION: number;
+    MRZ: number;
 };
 export declare const eRFID_ErrorCodes: {
     RFID_ERROR_NO_ERROR: number;
@@ -1074,6 +1066,7 @@ export declare const eCheckDiagnose: {
     FALSE_IPI_PARAMETERS: number;
     FIELD_POS_CORRECTOR_HIGHLIGHT_IR: number;
     FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA: number;
+    FIELD_POS_CORRECTOR_PHOTO_REPLACED: number;
     OVI_IR_INVISIBLE: number;
     OVI_INSUFFICIENT_AREA: number;
     OVI_COLOR_INVARIABLE: number;
@@ -1126,6 +1119,8 @@ 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_BACKGROUND: number;
     LAST_DIAGNOSE_VALUE: number;
 };
 export declare const RFIDDelegate: {
@@ -2704,6 +2699,7 @@ export declare const Enum: {
         BARCODE_FORMAT_CHECK: number;
         KINEGRAM: number;
         HOLOGRAMS_DETECTION: number;
+        MRZ: number;
     };
     eRFID_ErrorCodes: {
         RFID_ERROR_NO_ERROR: number;
@@ -3237,6 +3233,7 @@ export declare const Enum: {
         FALSE_IPI_PARAMETERS: number;
         FIELD_POS_CORRECTOR_HIGHLIGHT_IR: number;
         FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA: number;
+        FIELD_POS_CORRECTOR_PHOTO_REPLACED: number;
         OVI_IR_INVISIBLE: number;
         OVI_INSUFFICIENT_AREA: number;
         OVI_COLOR_INVARIABLE: number;
@@ -3289,6 +3286,8 @@ 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_BACKGROUND: number;
         LAST_DIAGNOSE_VALUE: number;
     };
     RFIDDelegate: {
@@ -4878,6 +4877,30 @@ export declare class DocumentReader extends AwesomeCordovaNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     initializeReaderAutomatically(): Promise<any>;
+    /**
+     *  Checks if all required bluetooth permissions are granted and requests them if needed(Android only, ignored on iOS)
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    isBlePermissionsGranted(): Promise<any>;
+    /**
+     *  Searches for ble devices(Android only, ignored on iOS)
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    startBluetoothService(): Promise<any>;
+    /**
+     *  Initializes document reader with license from connected Device7310(Android only, ignored on iOS)
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    initializeReaderBleDeviceConfig(): Promise<any>;
+    /**
+     *  returns tag property of DocumentReader class
+     *
+     * @return {Promise<any>} Returns a promise
+     */
+    getTag(): Promise<any>;
     /**
      *  Allows you to get the API version
      *
@@ -5130,6 +5153,20 @@ export declare class DocumentReader extends AwesomeCordovaNativePlugin {
      * @return {Promise<any>} Returns a promise
      */
     setCameraSessionIsPaused(paused: any): Promise<any>;
+    /**
+     *  sets DocumentReader.tag
+     *
+     * @param {string} tag tag
+     * @return {Promise<any>} Returns a promise
+     */
+    setTag(tag: any): Promise<any>;
+    /**
+     *  checks for database update
+     *
+     * @param {string} databaseId id of the database
+     * @return {Promise<any>} Returns a promise
+     */
+    checkDatabaseUpdate(databaseId: any): Promise<any>;
     /**
      *  Use this method to get a scenario
      *
@@ -5184,11 +5221,11 @@ export declare class DocumentReader extends AwesomeCordovaNativePlugin {
      *
      * @param {object} config Object with structure
      *      "license": "license base64 string(necessary)"
-     *      "customDb": "custom database base64 string(android only, ignored on iOS)"
+     *      "customDb": "custom database base64 string(Android only, ignored on iOS)"
      *      "databasePath": "database path(iOS only, ignored on android)"
      *      "licenseUpdate": true
      *      "delayedNNLoad": false
-     *      "blackList": {} // android only, ignored on iOS
+     *      "blackList": {} // Android only, ignored on iOS
      * @return {Promise<any>} Returns a promise
      */
     initializeReader(config: any): Promise<any>;
@@ -5315,4 +5352,21 @@ export declare class DocumentReader 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>;
 }