@regulaforensics/cordova-plugin-document-reader-api 6.7.0 → 6.7.2

package/www/DocumentReader.js

@@ -174,6 +174,8 @@ class DocumentReaderTextField {
         if (jsonObject["validityList"] != null)
             for (const i in jsonObject["validityList"])
                 result.validityList.push(DocumentReaderValidity.fromJson(jsonObject["validityList"][i]))
+        result.comparisonStatus = jsonObject["comparisonStatus"]
+        result.validityStatus = jsonObject["validityStatus"]
 
         return result
     }
@@ -298,8 +300,10 @@ class DocumentReaderNotification {
         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
     }
@@ -1016,7 +1020,9 @@ class DocumentReaderResults {
         if (jsonObject == null) return null
         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"]
@@ -1046,6 +1052,7 @@ class DocumentReaderResults {
         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"])
@@ -1055,6 +1062,173 @@ class DocumentReaderResults {
 
         return result
     }
+
+    /**
+     * @deprecated Use DocumentReader.textFieldValueBy...()
+     */
+     getTextFieldValueByType({ fieldType, lcid = 0, source = -1, original = false }) {
+        if (this.textResult == null) return null
+        const field = this.findByTypeAndLcid(fieldType, lcid)
+        if (field == null) return null
+        const value = this.findBySource(field, source)
+        if (value == null) return null
+        return original ? value.originalValue : value.value
+    }
+
+    /**
+     * @deprecated
+     */
+    getTextFieldStatusByType(fieldType, lcid = 0) {
+        if (this.textResult == null) return 0
+        const field = this.findByTypeAndLcid(fieldType, lcid)
+        return field != null ? field.status : 0
+    }
+
+    /**
+     * @deprecated Use DocumentReader.graphicFieldImageBy...()
+     */
+    getGraphicFieldImageByType({ fieldType, source = -1, pageIndex = -1, light = -1 }) {
+        if (this.graphicResult == null) return null
+        const foundFields = []
+
+        for (const field of this.graphicResult.fields)
+            if (field.fieldType === fieldType)
+                foundFields.push(field)
+        if (source !== -1)
+            for (const index in foundFields)
+                if (foundFields[index].sourceType !== source)
+                    foundFields.splice(index, 1)
+        if (light !== -1)
+            for (const index in foundFields)
+                if (foundFields[index].lightType !== light)
+                    foundFields.splice(index, 1)
+        if (pageIndex !== -1)
+            for (const index in foundFields)
+                if (foundFields[index].pageIndex !== pageIndex)
+                    foundFields.splice(index, 1)
+        if (foundFields.length > 0)
+            return foundFields[0].value
+    }
+
+    /**
+     * @deprecated
+     */
+    getQualityResult(imageQualityCheckType, securityFeature = -1, pageIndex = 0) {
+        let resultSum = 2
+        if (this.imageQuality == null) return resultSum
+
+        let imageQualityGroup
+
+        for (const iq of this.imageQuality)
+            if (iq != null && iq.pageIndex === pageIndex)
+                imageQualityGroup = iq
+        if (imageQualityGroup == null)
+            return resultSum
+
+        for (const field of imageQualityGroup.imageQualityList)
+            if (field.type === imageQualityCheckType)
+                if (securityFeature === -1) {
+                    if (field.result === 0) {
+                        resultSum = 0
+                        break
+                    }
+                    if (field.result === 1)
+                        resultSum = field.result
+                } else if (field.featureType === securityFeature) {
+                    resultSum = field.result
+                    break
+                }
+
+        return resultSum
+    }
+
+    /**
+     * @deprecated
+     */
+    findByTypeAndLcid(type, lcid) {
+        let field
+        const foundFields = []
+
+        for (field of this.textResult.fields)
+            if (field.fieldType === type)
+                foundFields.push(field)
+        if (foundFields.length <= 0)
+            return null
+
+        let foundField = null
+
+        for (field of foundFields)
+            if (lcid === 0) {
+                foundField = field
+                if (field.lcid === lcid)
+                    break
+            } else if (field.lcid === lcid)
+                return field
+
+        return foundField
+    }
+
+    /**
+     * @deprecated
+     */
+    findBySource(field, sourceType) {
+        let value
+        if (sourceType === -1) {
+            const mrzVal = this.findBySource(field, 3)
+            if (mrzVal != null)
+                return mrzVal
+            value = this.findBySource(field, 18)
+            if (value != null)
+                return value
+            const visualVal = this.findBySource(field, 17)
+            return visualVal != null ? visualVal : null
+        }
+        for (const item of field.values)
+            if (item.sourceType === sourceType)
+                return item
+
+        return null
+    }
+
+    /**
+     * @deprecated Use DocumentReader.containers()
+     */
+    getContainers(resultTypes) {
+        try {
+            const json = JSON.parse(this.rawResult)
+            const containerList = json.List
+            const resultArray = []
+            for (const container of containerList){
+                if (container == null || container.length == 0)
+                    continue
+                for (const resultType of resultTypes)
+                    if(resultType == container.result_type){
+                        resultArray.push(container)
+                        break
+                    }
+            }
+            if (resultArray.length == 0)
+                return null
+            const newContainerList = {}
+            newContainerList.List = resultArray
+            const newJson = {}
+            newJson.ContainerList = newContainerList
+            newJson.TransactionInfo = json.TransactionInfo
+        } catch (error) {
+            return null
+        }
+    }
+
+    /**
+     * @deprecated DocumentReader.encryptedContainers()
+     */
+    getEncryptedContainers() {
+        return this.getContainers([
+            eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION,
+            eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_ENCRYPTED_RCL,
+            eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_LICENSE
+        ])
+    }
 }
 
 // Enum
@@ -1876,6 +2050,7 @@ 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,
@@ -1916,17 +2091,17 @@ const eRPRM_FieldVerificationResult = {
 }
 
 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,
 }
 
 const eProcessGLCommands = {
@@ -2217,6 +2392,13 @@ const RFIDDelegate = {
     FULL: 2,
 }
 
+const TextProcessing = {
+    ocNoChange: 0,
+    ocUppercase: 1,
+    ocLowercase: 2,
+    ocCapital: 3,
+}
+
 const ProcessingFinishedStatus = {
     NOT_READY: 0,
     READY: 1,
@@ -2916,6 +3098,31 @@ const eImageQualityCheckType = {
     IQC_SCREEN_CAPTURE: 6,
     IQC_PORTRAIT: 7,
     IQC_HANDWRITTEN: 8,
+
+    getTranslation: function (value) {
+        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
+        }
+    }
 }
 
 const MRZFormat = {
@@ -3324,6 +3531,10 @@ const eGraphicFieldType = {
     }
 }
 
+const RegDeviceConfigType = {
+    DEVICE_7310: 1,
+}
+
 const CameraMode = {
     AUTO: 0,
     CAMERA1: 1,
@@ -3470,7 +3681,7 @@ 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:
@@ -4202,6 +4413,12 @@ 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: function (value) {
         switch (value) {
@@ -4458,7 +4675,7 @@ 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:
@@ -5405,6 +5622,18 @@ 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
         }
@@ -6007,6 +6236,7 @@ const Enum = {
    eSignManagementAction,
    eCheckDiagnose,
    RFIDDelegate,
+   TextProcessing,
    ProcessingFinishedStatus,
    DocFormat,
    eLDS_ParsingNotificationCodes,
@@ -6021,6 +6251,7 @@ const Enum = {
    eRequestCommand,
    ImageFormat,
    eGraphicFieldType,
+   RegDeviceConfigType,
    CameraMode,
    CaptureMode,
    eCheckResult,
@@ -6109,23 +6340,23 @@ DocumentReader.showScannerWithCameraIDAndOpts = (cameraID, options, successCallb
 DocumentReader.recognizeImageWithCameraMode = (image, mode, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["recognizeImageWithCameraMode", image, mode])
 DocumentReader.recognizeImagesWithImageInputs = (images, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["recognizeImagesWithImageInputs", images])
 
-DocumentReader.getTextFieldValueByType = (results, fieldType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldValueByType", results.rawResult, fieldType])
-DocumentReader.getTextFieldValueByTypeLcid = (results, fieldType, lcid, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldValueByTypeLcid", results.rawResult, fieldType, lcid])
-DocumentReader.getTextFieldValueByTypeSource = (results, fieldType, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldValueByTypeSource", results.rawResult, fieldType, source])
-DocumentReader.getTextFieldValueByTypeLcidSource = (results, fieldType, lcid, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldValueByTypeLcidSource", results.rawResult, fieldType, lcid, source])
-DocumentReader.getTextFieldValueByTypeSourceOriginal = (results, fieldType, source, original, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldValueByTypeSourceOriginal", results.rawResult, fieldType, source, original])
-DocumentReader.getTextFieldValueByTypeLcidSourceOriginal = (results, fieldType, lcid, source, original, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldValueByTypeLcidSourceOriginal", results.rawResult, fieldType, lcid, source, original])
-DocumentReader.getTextFieldByType = (results, fieldType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldByType", results.rawResult, fieldType])
-DocumentReader.getTextFieldByTypeLcid = (results, fieldType, lcid, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getTextFieldByTypeLcid", results.rawResult, fieldType, lcid])
-DocumentReader.getGraphicFieldByTypeSource = (results, fieldType, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldByTypeSource", results.rawResult, fieldType, source])
-DocumentReader.getGraphicFieldByTypeSourcePageIndex = (results, fieldType, source, pageIndex, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldByTypeSourcePageIndex", results.rawResult, fieldType, source, pageIndex])
-DocumentReader.getGraphicFieldByTypeSourcePageIndexLight = (results, fieldType, source, pageIndex, light, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldByTypeSourcePageIndex", results.rawResult, fieldType, source, pageIndex, light])
-DocumentReader.getGraphicFieldImageByType = (results, fieldType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldImageByType", results.rawResult, fieldType])
-DocumentReader.getGraphicFieldImageByTypeSource = (results, fieldType, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldImageByTypeSource", results.rawResult, fieldType, source])
-DocumentReader.getGraphicFieldImageByTypeSourcePageIndex = (results, fieldType, source, pageIndex, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldImageByTypeSourcePageIndex", results.rawResult, fieldType, source, pageIndex])
-DocumentReader.getGraphicFieldImageByTypeSourcePageIndexLight = (results, fieldType, source, pageIndex, light, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getGraphicFieldImageByTypeSourcePageIndexLight", results.rawResult, fieldType, source, pageIndex, light])
-DocumentReader.getContainers = (results, resultType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getContainers", results.rawResult, resultType])
-DocumentReader.getEncryptedContainers = (results, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["getEncryptedContainers", results.rawResult])
+DocumentReader.textFieldValueByType = (results, fieldType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldValueByType", results.rawResult, fieldType])
+DocumentReader.textFieldValueByTypeLcid = (results, fieldType, lcid, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldValueByTypeLcid", results.rawResult, fieldType, lcid])
+DocumentReader.textFieldValueByTypeSource = (results, fieldType, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldValueByTypeSource", results.rawResult, fieldType, source])
+DocumentReader.textFieldValueByTypeLcidSource = (results, fieldType, lcid, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldValueByTypeLcidSource", results.rawResult, fieldType, lcid, source])
+DocumentReader.textFieldValueByTypeSourceOriginal = (results, fieldType, source, original, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldValueByTypeSourceOriginal", results.rawResult, fieldType, source, original])
+DocumentReader.textFieldValueByTypeLcidSourceOriginal = (results, fieldType, lcid, source, original, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldValueByTypeLcidSourceOriginal", results.rawResult, fieldType, lcid, source, original])
+DocumentReader.textFieldByType = (results, fieldType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldByType", results.rawResult, fieldType])
+DocumentReader.textFieldByTypeLcid = (results, fieldType, lcid, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["textFieldByTypeLcid", results.rawResult, fieldType, lcid])
+DocumentReader.graphicFieldByTypeSource = (results, fieldType, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldByTypeSource", results.rawResult, fieldType, source])
+DocumentReader.graphicFieldByTypeSourcePageIndex = (results, fieldType, source, pageIndex, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldByTypeSourcePageIndex", results.rawResult, fieldType, source, pageIndex])
+DocumentReader.graphicFieldByTypeSourcePageIndexLight = (results, fieldType, source, pageIndex, light, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldByTypeSourcePageIndex", results.rawResult, fieldType, source, pageIndex, light])
+DocumentReader.graphicFieldImageByType = (results, fieldType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldImageByType", results.rawResult, fieldType])
+DocumentReader.graphicFieldImageByTypeSource = (results, fieldType, source, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldImageByTypeSource", results.rawResult, fieldType, source])
+DocumentReader.graphicFieldImageByTypeSourcePageIndex = (results, fieldType, source, pageIndex, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldImageByTypeSourcePageIndex", results.rawResult, fieldType, source, pageIndex])
+DocumentReader.graphicFieldImageByTypeSourcePageIndexLight = (results, fieldType, source, pageIndex, light, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["graphicFieldImageByTypeSourcePageIndexLight", results.rawResult, fieldType, source, pageIndex, light])
+DocumentReader.containers = (results, resultType, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["containers", results.rawResult, resultType])
+DocumentReader.encryptedContainers = (results, successCallback, errorCallback) => cordova.exec(successCallback, errorCallback, "DocumentReader", "exec", ["encryptedContainers", results.rawResult])
 
 DocumentReader.DocumentReaderResults = DocumentReaderResults
 DocumentReader.Enum = Enum