@regulaforensics/document-reader 7.1.301-rc

package/test/test.tsx

@@ -0,0 +1,93 @@
+import { compare } from './utils'
+import { AccessControlProcedureType, Application, Attribute, AuthenticityCheck, AuthenticityElement, AuthenticityParams, AuthenticityResult, Authority, BackendProcessingConfig, BarcodeField, BarcodeResult, BytesData, CardProperties, CertificateChain, CertificateData, Comparison, Coordinate, Customization, CustomizationColors, CustomizationFonts, CustomizationImages, DataField, DocReaderException, DocReaderScenario, DocReaderVersion, DocumentsDatabase, DocumentType, EDLDataGroups, EIDDataGroups, DTCDataGroup, EPassportDataGroups, Extension, FaceApiParams, FaceApiSearchParams, File, FileData, Functionality, GlaresCheckParams, RFIDParams, GraphicField, GraphicResult, ImageInputData, ImageQA, ImageQuality, ImageQualityGroup, InitConfig, License, LivenessParams, OnlineProcessingConfig, OpticalStatus, PAAttribute, PAResourcesIssuer, PDF417Info, PKDCertificate, Position, PrepareProgress, ProcessParams, RecognizeConfig, Rect, Results, ResultsStatus, RFIDException, RFIDNotification, RFIDOrigin, RFIDScenario, RFIDSessionData, RFIDStatus, RFIDValidity, RFIDValue, ScannerConfig, SecurityObject, SecurityObjectCertificates, SignerInfo, Symbol, TAChallenge, TccParams, TextField, TextResult, TextSource, TransactionInfo, Validity, Value, VDSNCData } from '@regulaforensics/document-reader'
+import { accessControlProcedureType, application, attribute, authenticityCheck, authenticityElement, authenticityParams, authenticityResult, authority, backendProcessingConfig, barcodeField, barcodeResult, bytesData, cardProperties, certificateChain, certificateData, comparison, coordinate, customization, customizationColors, customizationFonts, customizationImages, dataField, docReaderException, docReaderScenario, docReaderVersion, documentsDatabase, documentType, eDLDataGroups, eIDDataGroups, dtcDataGroup, ePassportDataGroups, extension, faceApiParams, faceApiSearchParams, file, fileData, functionality, glaresCheckParams, rfidParams, graphicField, graphicResult, imageInputData, imageQA, imageQuality, imageQualityGroup, initConfig, license, livenessParams, onlineProcessingConfig, opticalStatus, paAttribute, paResourcesIssuer, pdf417Info, pkdCertificate, position, prepareProgress, processParams, recognizeConfig, recognizeConfig2, rect, results, resultsStatus, rfidException, rfidNotification, rfidOrigin, rfidScenario, rfidSessionData, rfidStatus, rfidValidity, rfidValue, scannerConfig, securityObject, securityObjectCertificates, signerInfo, symbol, taChallenge, tccParams, textField, textResult, textSource, transactionInfo, validity, value, vdsncData } from './json'
+
+compare('initConfig', initConfig, InitConfig.fromJson)
+compare('onlineProcessingConfig', onlineProcessingConfig, OnlineProcessingConfig.fromJson)
+compare('imageInputData', imageInputData, ImageInputData.fromJson)
+compare('recognizeConfig', recognizeConfig, RecognizeConfig.fromJson)
+compare('recognizeConfig2', recognizeConfig2, RecognizeConfig.fromJson)
+compare('scannerConfig', scannerConfig, ScannerConfig.fromJson)
+
+compare('faceApiSearchParams', faceApiSearchParams, FaceApiSearchParams.fromJson)
+compare('faceApiParams', faceApiParams, FaceApiParams.fromJson)
+
+compare('livenessParams', livenessParams, LivenessParams.fromJson)
+compare('authenticityParams', authenticityParams, AuthenticityParams.fromJson)
+compare('glaresCheckParams', glaresCheckParams, GlaresCheckParams.fromJson)
+compare('rfidParams', rfidParams, RFIDParams.fromJson)
+compare('imageQA', imageQA, ImageQA.fromJson)
+compare('backendProcessingConfig', backendProcessingConfig, BackendProcessingConfig.fromJson)
+compare('processParams', processParams, ProcessParams.fromJson, ['logs'])
+compare('eDLDataGroups', eDLDataGroups, EDLDataGroups.fromJson)
+compare('ePassportDataGroups', ePassportDataGroups, EPassportDataGroups.fromJson)
+compare('eIDDataGroups', eIDDataGroups, EIDDataGroups.fromJson)
+compare('dtcDataGroup', dtcDataGroup, DTCDataGroup.fromJson)
+compare('rfidScenario', rfidScenario, RFIDScenario.fromJson)
+compare('customizationColors', customizationColors, CustomizationColors.fromJson)
+compare('customizationFonts', customizationFonts, CustomizationFonts.fromJson)
+compare('customizationImages', customizationImages, CustomizationImages.fromJson)
+compare('customization', customization, Customization.fromJson)
+compare('functionality', functionality, Functionality.fromJson)
+
+compare('documentsDatabase', documentsDatabase, DocumentsDatabase.fromJson)
+compare('docReaderVersion', docReaderVersion, DocReaderVersion.fromJson)
+compare('docReaderScenario', docReaderScenario, DocReaderScenario.fromJson)
+compare('license', license, License.fromJson)
+compare('docReaderException', docReaderException, DocReaderException.fromJson)
+compare('rfidException', rfidException, RFIDException.fromJson)
+compare('prepareProgress', prepareProgress, PrepareProgress.fromJson)
+
+compare('authenticityElement', authenticityElement, AuthenticityElement.fromJson)
+compare('authenticityCheck', authenticityCheck, AuthenticityCheck.fromJson)
+compare('authenticityResult', authenticityResult, AuthenticityResult.fromJson)
+compare('pdf417Info', pdf417Info, PDF417Info.fromJson)
+compare('barcodeField', barcodeField, BarcodeField.fromJson)
+compare('barcodeResult', barcodeResult, BarcodeResult.fromJson)
+compare('imageQuality', imageQuality, ImageQuality.fromJson)
+compare('imageQualityGroup', imageQualityGroup, ImageQualityGroup.fromJson)
+compare('accessControlProcedureType', accessControlProcedureType, AccessControlProcedureType.fromJson)
+compare('fileData', fileData, FileData.fromJson)
+compare('certificateData', certificateData, CertificateData.fromJson)
+compare('securityObjectCertificates', securityObjectCertificates, SecurityObjectCertificates.fromJson)
+compare('file', file, File.fromJson)
+compare('application', application, Application.fromJson)
+compare('rfidValue', rfidValue, RFIDValue.fromJson)
+compare('attribute', attribute, Attribute.fromJson)
+compare('authority', authority, Authority.fromJson)
+compare('cardProperties', cardProperties, CardProperties.fromJson)
+compare('extension', extension, Extension.fromJson)
+compare('rfidValidity', rfidValidity, RFIDValidity.fromJson)
+compare('certificateChain', certificateChain, CertificateChain.fromJson)
+compare('dataField', dataField, DataField.fromJson)
+compare('signerInfo', signerInfo, SignerInfo.fromJson)
+compare('securityObject', securityObject, SecurityObject.fromJson)
+compare('rfidSessionData', rfidSessionData, RFIDSessionData.fromJson)
+compare('bytesData', bytesData, BytesData.fromJson)
+compare('vdsncData', vdsncData, VDSNCData.fromJson)
+compare('opticalStatus', opticalStatus, OpticalStatus.fromJson)
+compare('rfidStatus', rfidStatus, RFIDStatus.fromJson)
+compare('resultsStatus', resultsStatus, ResultsStatus.fromJson)
+compare('comparison', comparison, Comparison.fromJson)
+compare('rect', rect, Rect.fromJson)
+compare('graphicField', graphicField, GraphicField.fromJson)
+compare('graphicResult', graphicResult, GraphicResult.fromJson)
+compare('rfidOrigin', rfidOrigin, RFIDOrigin.fromJson)
+compare('symbol', symbol, Symbol.fromJson)
+compare('validity', validity, Validity.fromJson)
+compare('value', value, Value.fromJson)
+compare('textField', textField, TextField.fromJson)
+compare('textSource', textSource, TextSource.fromJson)
+compare('textResult', textResult, TextResult.fromJson)
+compare('documentType', documentType, DocumentType.fromJson)
+compare('coordinate', coordinate, Coordinate.fromJson)
+compare('position', position, Position.fromJson)
+compare('transactionInfo', transactionInfo, TransactionInfo.fromJson)
+compare('results', results, Results.fromJson)
+
+compare('rfidNotification', rfidNotification, RFIDNotification.fromJson)
+compare('paAttribute', paAttribute, PAAttribute.fromJson)
+compare('paResourcesIssuer', paResourcesIssuer, PAResourcesIssuer.fromJson)
+compare('pkdCertificate', pkdCertificate, PKDCertificate.fromJson)
+compare('taChallenge', taChallenge, TAChallenge.fromJson)
+compare('tccParams', tccParams, TccParams.fromJson)

package/test/utils.tsx

@@ -0,0 +1,38 @@
+import test from 'node:test'
+import * as assert from 'assert'
+
+export function compare(
+    name: string,
+    json: Record<string, any>,
+    fromJson: (json: Record<string, any>) => any,
+    skip?: string[],
+) {
+    test(name, () => {
+        var actual = removeUndefineds(fromJson(json).toJson())
+        if (skip) for (const item of skip) delete actual[item]
+        assert.deepEqual(actual, json)
+    })
+}
+
+function removeUndefineds(input) {
+    const isPlainObject = obj => Object.prototype.toString.call(obj) === '[object Object]';
+  
+    if (input === undefined) return undefined;
+    if (input === null || typeof input !== 'object') return input;
+  
+    if (Array.isArray(input)) {
+      return input
+        .map(item => removeUndefineds(item))
+        .filter(item => item !== undefined);
+    }
+  
+    if (!isPlainObject(input)) return input;
+  
+    const result = {};
+    for (const [key, value] of Object.entries(input)) {
+      if (value === undefined) continue;
+      const cleaned = removeUndefineds(value);
+      if (cleaned !== undefined) result[key] = cleaned;
+    }
+    return result;
+  }

package/www/capacitor/config/InitConfig.js

@@ -0,0 +1,52 @@
+export class InitConfig {
+    license
+    licenseUpdate
+    delayedNNLoad
+    databasePath
+    customDb
+    blackList
+    useBleDevice
+
+    static withBleDevice() {
+        var result = new InitConfig()
+        result.useBleDevice = true
+        return result
+    }
+
+    constructor(license, options) {
+        this.license = license
+        this.licenseUpdate = options?.licenseUpdate ?? true
+        this.delayedNNLoad = options?.delayedNNLoad ?? false
+        this.databasePath = options?.databasePath
+        this.customDb = options?.customDb
+        this.blackList = options?.blackList
+        this.useBleDevice = false
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null;
+        var result = new InitConfig(jsonObject["license"]);
+
+        result.customDb = jsonObject["customDb"];
+        result.delayedNNLoad = jsonObject["delayedNNLoad"];
+        result.licenseUpdate = jsonObject["licenseUpdate"];
+        result.blackList = jsonObject["blackList"];
+        result.databasePath = jsonObject["databasePath"];
+        result.useBleDevice = jsonObject["useBleDevice"];
+
+        return result;
+    }
+
+
+    toJson() {
+        return {
+            "license": this.license,
+            "delayedNNLoad": this.delayedNNLoad,
+            "licenseUpdate": this.licenseUpdate,
+            "blackList": this.blackList,
+            "customDb": this.customDb,
+            "databasePath": this.databasePath,
+            "useBleDevice": this.useBleDevice,
+        }
+    }
+}

package/www/capacitor/config/OnlineProcessingConfig.js

@@ -0,0 +1,52 @@
+import { ProcessParams } from "../params/process_params/ProcessParams";
+import { Scenario } from "../info/DocReaderScenario";
+
+export class OnlineProcessingConfig {
+    mode
+    url
+    processParams
+    imageFormat
+    imageCompressionQuality
+    requestHeaders
+
+    constructor(mode) {
+        this.mode = mode
+        this.processParams = new ProcessParams()
+        this.processParams.scenario = Scenario.FULL_PROCESS
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        
+        const result = new OnlineProcessingConfig(jsonObject["mode"])
+        
+        result.url = jsonObject["url"]
+        result.imageFormat = jsonObject["imageFormat"]
+        result.imageCompressionQuality = jsonObject["imageCompressionQuality"]
+        result.processParams = ProcessParams.fromJson(jsonObject["processParams"])
+        result.requestHeaders = jsonObject["requestHeaders"]
+        
+        return result
+    }
+
+    toJson() {
+        return {
+            "mode": this.mode,
+            "url": this.url,
+            "imageFormat": this.imageFormat,
+            "imageCompressionQuality": this.imageCompressionQuality,
+            "processParams": this.processParams?.toJson(),
+            "requestHeaders": this.requestHeaders,
+        }
+    }
+}
+
+export const ImageFormat = {
+    PNG: 0,
+    JPG: 1
+}
+
+export const OnlineMode = {
+    MANUAL: 0,
+    AUTO: 1
+}

package/www/capacitor/config/RFIDConfig.js

@@ -0,0 +1,31 @@
+import { DocReaderAction } from "../index";
+import { Results } from "../results/Results";
+import { RFIDException } from "../info/RFIDException";
+import { RFIDNotification } from "../rfid/RFIDNotification";
+import { PAResourcesIssuer } from "../rfid/PAResourcesIssuer";
+import { PKDCertificate } from "../rfid/PKDCertificate";
+import { TAChallenge } from "../rfid/TAChallenge";
+
+export class RFIDConfig {
+    _completion
+    _rfidCompletion
+    _disableUI
+    onProgress
+    onChipDetected
+    onRetryReadChip
+    onRequestPACertificates
+    onRequestTACertificates
+    onRequestTASignature
+
+    constructor(completion) {
+        this._completion = completion
+        this._disableUI = false
+    }
+
+    static withoutUI(completion) {
+        const result = new RFIDConfig(null)
+        result._rfidCompletion = completion
+        result._disableUI = true
+        return result
+    }
+}

package/www/capacitor/config/RecognizeConfig.js

@@ -0,0 +1,126 @@
+import { OnlineProcessingConfig } from "./OnlineProcessingConfig";
+import { Scenario } from "../info/DocReaderScenario";
+import { Lights } from "../results/visual_results/Lights";
+
+export class RecognizeConfig {
+    scenario
+    onlineProcessingConfig
+    image
+    images
+    data
+    imageInputData
+    dtc
+    livePortrait
+    extPortrait
+    oneShotIdentification
+
+    constructor() {
+        this.oneShotIdentification = false
+    }
+
+    static withScenario(scenario, options) {
+        const result = new RecognizeConfig()
+        result.scenario = scenario
+        result.image = options?.image
+        result.images = options?.images
+        result.data = options?.data
+        result.imageInputData = options?.imageInputData
+        result.dtc = options?.dtc
+        result.livePortrait = options?.livePortrait
+        result.extPortrait = options?.extPortrait
+        result.oneShotIdentification = options?.oneShotIdentification ?? false
+        return result
+    }
+
+    static withOnlineProcessingConfig(onlineProcessingConfig, options) {
+        const result = new RecognizeConfig()
+        result.onlineProcessingConfig = onlineProcessingConfig
+        result.image = options?.image
+        result.images = options?.images
+        result.data = options?.data
+        result.imageInputData = options?.imageInputData
+        result.dtc = options?.dtc
+        result.livePortrait = options?.livePortrait
+        result.extPortrait = options?.extPortrait
+        result.oneShotIdentification = options?.oneShotIdentification ?? false
+        return result
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new RecognizeConfig()
+
+        result.scenario = jsonObject["scenario"]
+        result.onlineProcessingConfig = OnlineProcessingConfig.fromJson(jsonObject["onlineProcessingConfig"])
+        result.image = jsonObject["image"]
+        if (jsonObject["images"] != null) {
+            result.images = []
+            for (const item of jsonObject["images"]) {
+                if (item != null) {
+                    result.images.push(item)
+                }
+            }
+        }
+        result.data = jsonObject["data"]
+        if (jsonObject["imageInputData"] != null) {
+            result.imageInputData = []
+            for (const item of jsonObject["imageInputData"]) {
+                const imageInputData = ImageInputData.fromJson(item)
+                if (imageInputData != null) {
+                    result.imageInputData.push(imageInputData)
+                }
+            }
+        }
+        result.dtc = jsonObject["dtc"]
+        result.livePortrait = jsonObject["livePortrait"]
+        result.extPortrait = jsonObject["extPortrait"]
+        result.oneShotIdentification = jsonObject["oneShotIdentification"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "scenario": this.scenario,
+            "onlineProcessingConfig": this.onlineProcessingConfig?.toJson(),
+            "image": this.image,
+            "images": this.images,
+            "data": this.data,
+            "imageInputData": this.imageInputData?.map(e => e.toJson()),
+            "dtc": this.dtc,
+            "livePortrait": this.livePortrait,
+            "extPortrait": this.extPortrait,
+            "oneShotIdentification": this.oneShotIdentification,
+        }
+    }
+}
+
+export class ImageInputData {
+    image
+    light
+    pageIndex
+
+    constructor(image, options) {
+        this.image = image
+        this.light = options?.light ?? Lights.WHITE_FULL
+        this.pageIndex = options?.pageIndex ?? 0
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new ImageInputData(jsonObject["image"])
+
+        result.pageIndex = jsonObject["pageIndex"]
+        result.light = jsonObject["light"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "image": this.image,
+            "light": this.light,
+            "pageIndex": this.pageIndex,
+        }
+    }
+}

package/www/capacitor/config/ScannerConfig.js

@@ -0,0 +1,48 @@
+import { OnlineProcessingConfig } from "./OnlineProcessingConfig";
+
+export class ScannerConfig {
+    scenario
+    onlineProcessingConfig
+    livePortrait
+    extPortrait
+    cameraId
+
+    constructor(scenario, onlineProcessingConfig) {
+        this.scenario = scenario
+        this.onlineProcessingConfig = onlineProcessingConfig
+    }
+
+    static withScenario(scenario) {
+        const result = new ScannerConfig(scenario, undefined)
+        return result
+    }
+
+    static withOnlineProcessingConfig(onlineProcessingConfig) {
+        const result = new ScannerConfig(undefined, onlineProcessingConfig)
+        return result
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+
+        const result = new ScannerConfig(undefined, undefined)
+
+        result.scenario = jsonObject["scenario"]
+        result.onlineProcessingConfig = OnlineProcessingConfig.fromJson(jsonObject["onlineProcessingConfig"])
+        result.livePortrait = jsonObject["livePortrait"]
+        result.extPortrait = jsonObject["extPortrait"]
+        result.cameraId = jsonObject["cameraId"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "scenario": this.scenario,
+            "onlineProcessingConfig": this.onlineProcessingConfig?.toJson(),
+            "livePortrait": this.livePortrait,
+            "extPortrait": this.extPortrait,
+            "cameraId": this.cameraId,
+        }
+    }
+}