@regulaforensics/react-native-document-reader-api 6.6.0 → 6.7.1

package/index.d.ts

@@ -230,6 +230,8 @@ export class DocumentReaderTextField {
     values?: DocumentReaderValue[]
     comparisonList?: DocumentReaderComparison[]
     validityList?: DocumentReaderValidity[]
+    comparisonStatus?: number
+    validityStatus?: number
 
     static fromJson(jsonObject?: any): DocumentReaderTextField | undefined {
         if (jsonObject == null || jsonObject == undefined) return undefined
@@ -266,6 +268,8 @@ export class DocumentReaderTextField {
                     result.validityList.push(item)
             }
         }
+        result.comparisonStatus = jsonObject["comparisonStatus"]
+        result.validityStatus = jsonObject["validityStatus"]
 
         return result
     }
@@ -447,16 +451,20 @@ export class DocumentReaderDocumentType {
 
 export class DocumentReaderNotification {
     code?: number
-    attachment?: number
     value?: number
+    notificationCode?: number
+    dataFileType?: number
+    progress?: number
 
     static fromJson(jsonObject?: any): DocumentReaderNotification | undefined {
         if (jsonObject == null || jsonObject == undefined) return undefined
         const result = new DocumentReaderNotification
 
         result.code = jsonObject["code"]
-        result.attachment = jsonObject["attachment"]
         result.value = jsonObject["value"]
+        result.notificationCode = jsonObject["notificationCode"]
+        result.dataFileType = jsonObject["dataFileType"]
+        result.progress = jsonObject["progress"]
 
         return result
     }
@@ -1496,7 +1504,9 @@ export class DocumentReaderValidity {
 }
 
 export class DocumentReaderResults {
+    videoCaptureSessionId?: string
     chipPage?: number
+    irElapsedTime?: number
     processingFinishedStatus?: number
     elapsedTime?: number
     elapsedTimeRFID?: number
@@ -1514,11 +1524,83 @@ export class DocumentReaderResults {
     rfidSessionData?: RFIDSessionData
     authenticityResult?: DocumentReaderAuthenticityResult
     barcodeResult?: DocumentReaderBarcodeResult
+    ppmIn?: number
     documentType?: DocumentReaderDocumentType[]
     status?: DocumentReaderResultsStatus
     vdsncData?: VDSNCData
 
-    getTextFieldValueByType({ fieldType, lcid = 0, source = -1, original = false }: { fieldType: number, lcid?: number, source?: number, original?: boolean }): string | undefined {
+
+    static fromJson(jsonObject?: any): DocumentReaderResults | undefined {
+        if (jsonObject == null || jsonObject == undefined) return undefined
+        const result = new DocumentReaderResults
+
+        result.videoCaptureSessionId = jsonObject["videoCaptureSessionId"]
+        result.chipPage = jsonObject["chipPage"]
+        result.irElapsedTime = jsonObject["irElapsedTime"]
+        result.processingFinishedStatus = jsonObject["processingFinishedStatus"]
+        result.elapsedTime = jsonObject["elapsedTime"]
+        result.elapsedTimeRFID = jsonObject["elapsedTimeRFID"]
+        result.morePagesAvailable = jsonObject["morePagesAvailable"]
+        result.rfidResult = jsonObject["rfidResult"]
+        result.highResolution = jsonObject["highResolution"]
+        result.graphicResult = DocumentReaderGraphicResult.fromJson(jsonObject["graphicResult"])
+        result.textResult = DocumentReaderTextResult.fromJson(jsonObject["textResult"])
+        result.documentPosition = []
+        if (jsonObject["documentPosition"] != null) {
+            for (const i in jsonObject["documentPosition"]) {
+                const item = ElementPosition.fromJson(jsonObject["documentPosition"][i])
+                if (item != undefined)
+                    result.documentPosition.push(item)
+            }
+        }
+        result.barcodePosition = []
+        if (jsonObject["barcodePosition"] != null) {
+            for (const i in jsonObject["barcodePosition"]) {
+                const item = ElementPosition.fromJson(jsonObject["barcodePosition"][i])
+                if (item != undefined)
+                    result.barcodePosition.push(item)
+            }
+        }
+        result.mrzPosition = []
+        if (jsonObject["mrzPosition"] != null) {
+            for (const i in jsonObject["mrzPosition"]) {
+                const item = ElementPosition.fromJson(jsonObject["mrzPosition"][i])
+                if (item != undefined)
+                    result.mrzPosition.push(item)
+            }
+        }
+        result.imageQuality = []
+        if (jsonObject["imageQuality"] != null) {
+            for (const i in jsonObject["imageQuality"]) {
+                const item = ImageQualityGroup.fromJson(jsonObject["imageQuality"][i])
+                if (item != undefined)
+                    result.imageQuality.push(item)
+            }
+        }
+        result.rawResult = jsonObject["rawResult"]
+        result.documentReaderNotification = DocumentReaderNotification.fromJson(jsonObject["documentReaderNotification"])
+        result.rfidSessionData = RFIDSessionData.fromJson(jsonObject["rfidSessionData"])
+        result.authenticityResult = DocumentReaderAuthenticityResult.fromJson(jsonObject["authenticityResult"])
+        result.barcodeResult = DocumentReaderBarcodeResult.fromJson(jsonObject["barcodeResult"])
+        result.ppmIn = jsonObject["ppmIn"]
+        result.documentType = []
+        if (jsonObject["documentType"] != null) {
+            for (const i in jsonObject["documentType"]) {
+                const item = DocumentReaderDocumentType.fromJson(jsonObject["documentType"][i])
+                if (item != undefined)
+                    result.documentType.push(item)
+            }
+        }
+        result.status = DocumentReaderResultsStatus.fromJson(jsonObject["status"])
+        result.vdsncData = VDSNCData.fromJson(jsonObject["vdsncData"])
+
+        return result
+    }
+
+    /**
+     * @deprecated Use textFieldValueBy...()
+     */
+     getTextFieldValueByType({ fieldType, lcid = 0, source = -1, original = false }: { fieldType: number, lcid?: number, source?: number, original?: boolean }): string | undefined {
         if (this.textResult == undefined) return undefined
         const field = this.findByTypeAndLcid(fieldType, lcid)
         if (field == undefined) return undefined
@@ -1527,6 +1609,9 @@ export class DocumentReaderResults {
         return original ? value.originalValue : value.value
     }
 
+    /**
+     * @deprecated
+     */
     getTextFieldStatusByType(fieldType: number, lcid?: number): number {
         if (this.textResult == undefined) return 0
         const field = this.findByTypeAndLcid(fieldType, lcid)
@@ -1535,6 +1620,9 @@ export class DocumentReaderResults {
         return 0
     }
 
+    /**
+     * @deprecated Use graphicFieldImageBy...()
+     */
     getGraphicFieldImageByType({ fieldType, source = -1, light = -1, pageIndex = -1 }: { fieldType: number, source?: number, light?: number, pageIndex?: number }): string | undefined {
         if (this.graphicResult == undefined || this.graphicResult.fields == undefined) return undefined
         const foundFields: DocumentReaderGraphicField[] = []
@@ -1558,6 +1646,9 @@ export class DocumentReaderResults {
         return foundFields.length > 0 ? foundFields[0].value : undefined
     }
 
+    /**
+     * @deprecated
+     */
     getQualityResult({ imageQualityCheckType, securityFeature = -1, pageIndex = 0 }: { imageQualityCheckType: number, securityFeature?: number, pageIndex?: number }): number {
         let resultSum = 2
         if (this.imageQuality == undefined)
@@ -1588,6 +1679,9 @@ export class DocumentReaderResults {
         return resultSum
     }
 
+    /**
+     * @deprecated
+     */
     findByTypeAndLcid(type: number, lcid?: number): DocumentReaderTextField | undefined {
         if (this.textResult == undefined || this.textResult.fields == undefined) return undefined
         let field
@@ -1612,6 +1706,9 @@ export class DocumentReaderResults {
         return foundField
     }
 
+    /**
+     * @deprecated
+     */
     findBySource(field: DocumentReaderTextField, sourceType: number): DocumentReaderValue | undefined {
         let value
         if (sourceType === -1) {
@@ -1632,6 +1729,9 @@ export class DocumentReaderResults {
         return undefined
     }
 
+    /**
+     * @deprecated Use containers()
+     */
     getContainers(resultTypes: number[]): string | undefined {
         try {
             if(this.rawResult == undefined) return undefined
@@ -1658,6 +1758,9 @@ export class DocumentReaderResults {
         }
     }
 
+    /**
+     * @deprecated Use encryptedContainers()
+     */
     getEncryptedContainers(): string | undefined {
         return this.getContainers([
             eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION,
@@ -1666,69 +1769,23 @@ export class DocumentReaderResults {
         ])
     }
 
-    static fromJson(jsonObject?: any): DocumentReaderResults | undefined {
-        if (jsonObject == null || jsonObject == undefined) return undefined
-        const result = new DocumentReaderResults
-
-        result.chipPage = jsonObject["chipPage"]
-        result.processingFinishedStatus = jsonObject["processingFinishedStatus"]
-        result.elapsedTime = jsonObject["elapsedTime"]
-        result.elapsedTimeRFID = jsonObject["elapsedTimeRFID"]
-        result.morePagesAvailable = jsonObject["morePagesAvailable"]
-        result.rfidResult = jsonObject["rfidResult"]
-        result.highResolution = jsonObject["highResolution"]
-        result.graphicResult = DocumentReaderGraphicResult.fromJson(jsonObject["graphicResult"])
-        result.textResult = DocumentReaderTextResult.fromJson(jsonObject["textResult"])
-        result.documentPosition = []
-        if (jsonObject["documentPosition"] != null) {
-            for (const i in jsonObject["documentPosition"]) {
-                const item = ElementPosition.fromJson(jsonObject["documentPosition"][i])
-                if (item != undefined)
-                    result.documentPosition.push(item)
-            }
-        }
-        result.barcodePosition = []
-        if (jsonObject["barcodePosition"] != null) {
-            for (const i in jsonObject["barcodePosition"]) {
-                const item = ElementPosition.fromJson(jsonObject["barcodePosition"][i])
-                if (item != undefined)
-                    result.barcodePosition.push(item)
-            }
-        }
-        result.mrzPosition = []
-        if (jsonObject["mrzPosition"] != null) {
-            for (const i in jsonObject["mrzPosition"]) {
-                const item = ElementPosition.fromJson(jsonObject["mrzPosition"][i])
-                if (item != undefined)
-                    result.mrzPosition.push(item)
-            }
-        }
-        result.imageQuality = []
-        if (jsonObject["imageQuality"] != null) {
-            for (const i in jsonObject["imageQuality"]) {
-                const item = ImageQualityGroup.fromJson(jsonObject["imageQuality"][i])
-                if (item != undefined)
-                    result.imageQuality.push(item)
-            }
-        }
-        result.rawResult = jsonObject["rawResult"]
-        result.documentReaderNotification = DocumentReaderNotification.fromJson(jsonObject["documentReaderNotification"])
-        result.rfidSessionData = RFIDSessionData.fromJson(jsonObject["rfidSessionData"])
-        result.authenticityResult = DocumentReaderAuthenticityResult.fromJson(jsonObject["authenticityResult"])
-        result.barcodeResult = DocumentReaderBarcodeResult.fromJson(jsonObject["barcodeResult"])
-        result.documentType = []
-        if (jsonObject["documentType"] != null) {
-            for (const i in jsonObject["documentType"]) {
-                const item = DocumentReaderDocumentType.fromJson(jsonObject["documentType"][i])
-                if (item != undefined)
-                    result.documentType.push(item)
-            }
-        }
-        result.status = DocumentReaderResultsStatus.fromJson(jsonObject["status"])
-        result.vdsncData = VDSNCData.fromJson(jsonObject["vdsncData"])
-
-        return result
-    }
+    textFieldValueByType(fieldType: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldValueByTypeLcid(fieldType: number, lcid: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldValueByTypeSource(fieldType: number, source: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldValueByTypeLcidSource(fieldType: number, lcid: number, source: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldValueByTypeSourceOriginal(fieldType: number, source: number, original: boolean, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldValueByTypeLcidSourceOriginal(fieldType: number, lcid: number, source: number, original: boolean, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldByType(fieldType: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    textFieldByTypeLcid(fieldType: number, lcid: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldByTypeSource(fieldType: number, source: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldByTypeSourcePageIndex(fieldType: number, source: number, pageIndex: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldByTypeSourcePageIndexLight(fieldType: number, source: number, pageIndex: number, light: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldImageByType(fieldType: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldImageByTypeSource(fieldType: number, source: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldImageByTypeSourcePageIndex(fieldType: number, source: number, pageIndex: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    graphicFieldImageByTypeSourcePageIndexLight(fieldType: number, source: number, pageIndex: number, light: number, successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    containers(resultType: number[], successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
+    encryptedContainers(successCallback: (response: string) => void, errorCallback?: (error: string) => void): void;
 }
 
 export const FontStyle = {
@@ -2548,6 +2605,7 @@ export const eRPRM_ResultType = {
     RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION: 48,
     RPRM_RESULT_TYPE_INTERNAL_ENCRYPTED_RCL: 49,
     RPRM_RESULT_TYPE_INTERNAL_LICENSE: 50,
+    RPRM_RESULT_TYPE_TEXT: 36,
     RPRM_RESULT_TYPE_IMAGES: 37,
     RPRM_RESULT_TYPE_HOLO_PARAMS: 47,
     RPRM_RESULT_TYPE_DOCUMENT_POSITION: 85,
@@ -2588,17 +2646,17 @@ export const eRPRM_FieldVerificationResult = {
 }
 
 export const DocReaderAction = {
-    COMPLETE: 1,
-    PROCESS: 0,
-    CANCEL: 2,
-    ERROR: 3,
-    NOTIFICATION: 5,
-    PROCESS_WHITE_UV_IMAGES: 6,
-    PROCESS_WHITE_FLASHLIGHT: 7,
-    MORE_PAGES_AVAILABLE: 8,
-    PROCESS_IR_FRAME: 9,
-    TIMEOUT: 10,
-    PROCESSING_ON_SERVICE: 11,
+    COMPLETE: 0,
+    PROCESS: 1,
+    MORE_PAGES_AVAILABLE: 2,
+    CANCEL: 3,
+    ERROR: 4,
+    PROCESS_WHITE_FLASHLIGHT: 5,
+    TIMEOUT: 6,
+    PROCESSING_ON_SERVICE: 7,
+    NOTIFICATION: 101,
+    PROCESS_WHITE_UV_IMAGES: 102,
+    PROCESS_IR_FRAME: 103,
 }
 
 export const eProcessGLCommands = {
@@ -2889,6 +2947,13 @@ export const RFIDDelegate = {
     FULL: 2,
 }
 
+export const TextProcessing = {
+    ocNoChange: 0,
+    ocUppercase: 1,
+    ocLowercase: 2,
+    ocCapital: 3,
+}
+
 export const ProcessingFinishedStatus = {
     NOT_READY: 0,
     READY: 1,
@@ -3588,6 +3653,31 @@ export const eImageQualityCheckType = {
     IQC_SCREEN_CAPTURE: 6,
     IQC_PORTRAIT: 7,
     IQC_HANDWRITTEN: 8,
+
+    getTranslation(value: number) {
+        switch (value) {
+            case this.IQC_IMAGE_GLARES:
+                return "Glares"
+            case this.IQC_IMAGE_FOCUS:
+                return "Focus"
+            case this.IQC_IMAGE_RESOLUTION:
+                return "Resolution"
+            case this.IQC_IMAGE_COLORNESS:
+                return "Color"
+            case this.IQC_PERSPECTIVE:
+                return "Perspective angle"
+            case this.IQC_BOUNDS:
+                return "Bounds"
+            case this.IQC_SCREEN_CAPTURE:
+                return "Moire pattern"
+            case this.IQC_PORTRAIT:
+                return "Portrait"
+            case this.IQC_HANDWRITTEN:
+                return "Handwritten"
+            default:
+                return value.toString()
+        }
+    }
 }
 
 export const MRZFormat = {
@@ -3996,6 +4086,10 @@ export const eGraphicFieldType = {
     }
 }
 
+export const RegDeviceConfigType = {
+    DEVICE_7310: 1,
+}
+
 export const CameraMode = {
     AUTO: 0,
     CAMERA1: 1,
@@ -4142,7 +4236,7 @@ export const eRFID_DataFile_Type = {
             case this.DFT_PASSPORT_DG5:
                 return "Portrait(s) (DG5)"
             case this.DFT_ID_DG5:
-                return "Surname/given name at birth" + " (DG5)"
+                return "Family name" + " (DG5)"
             case this.DFT_DL_DG5:
                 return "Signature / usual mark image (DG5)"
             case this.DFT_PASSPORT_DG6:
@@ -4874,6 +4968,12 @@ export const eVisualFieldType = {
     FT_THIRD_NAME: 648,
     FT_FOURTH_NAME: 649,
     FT_LAST_NAME: 650,
+    FT_DLCLASSCODE_RM_FROM: 651,
+    FT_DLCLASSCODE_RM_NOTES: 652,
+    FT_DLCLASSCODE_RM_TO: 653,
+    FT_DLCLASSCODE_PW_FROM: 654,
+    FT_DLCLASSCODE_PW_NOTES: 655,
+    FT_DLCLASSCODE_PW_TO: 656,
 
     getTranslation(value: number) {
         switch (value) {
@@ -5130,7 +5230,7 @@ export const eVisualFieldType = {
             case this.FT_JURISDICTION_RESTRICTION_CODE:
                 return "Jurisdiction restriction code"
             case this.FT_FAMILY_NAME:
-                return "Surname/given name at birth"
+                return "Family name"
             case this.FT_GIVEN_NAMES_RUS:
                 return "Given name (National)"
             case this.FT_VISA_ID_RUS:
@@ -6077,6 +6177,18 @@ export const eVisualFieldType = {
                 return "Fourth name"
             case this.FT_LAST_NAME:
                 return "Last name"
+            case this.FT_DLCLASSCODE_PW_FROM:
+                return "DL class code PW valid from"
+            case this.FT_DLCLASSCODE_PW_NOTES:
+                return "DL class code PW notes"
+            case this.FT_DLCLASSCODE_PW_TO:
+                return "DL class code PW valid to"
+            case this.FT_DLCLASSCODE_RM_FROM:
+                return "DL class code RM valid from"
+            case this.FT_DLCLASSCODE_RM_NOTES:
+                return "DL class code RM notes"
+            case this.FT_DLCLASSCODE_RM_TO:
+                return "DL class code RM valid to"
             default:
                 return value.toString()
         }
@@ -6679,6 +6791,7 @@ export const Enum = {
    eSignManagementAction,
    eCheckDiagnose,
    RFIDDelegate,
+   TextProcessing,
    ProcessingFinishedStatus,
    DocFormat,
    eLDS_ParsingNotificationCodes,
@@ -6693,6 +6806,7 @@ export const Enum = {
    eRequestCommand,
    ImageFormat,
    eGraphicFieldType,
+   RegDeviceConfigType,
    CameraMode,
    CaptureMode,
    eCheckResult,