@regulaforensics/document-reader 8.4.401-beta → 8.4.507-rc

package/www/types/info/DocReaderException.d.ts

@@ -68,6 +68,7 @@ export declare enum ErrorCodes {
     CAMERA_NOT_AVAILABLE = 30,
     /** The camera not supported in this scenario. */
     CANNOT_USE_CAMERA_IN_SCENario = 40,
+    BLUETOOTH_NO_PERMISSION = 41,
     BACKEND_ONLINE_PROCESSING = 303,
     WRONG_INPUT = 400,
     /** Missing output result. */
@@ -79,5 +80,6 @@ export declare enum ErrorCodes {
     FEATURE_BLUETOOTH_LE_NOT_SUPPORTED = 601,
     APP_BACKGROUND = 700,
     ONLINE_PROCESSING_WRONG_INPUT = 800,
+    MDL_EXCEPTION = 900,
     NATIVE_JAVA_EXCEPTION = 1000,
 }

package/www/types/params/Functionality.d.ts

@@ -135,6 +135,12 @@ export declare class Functionality {
      * @default false
      */
     preventScreenRecording?: boolean;
+    /**
+     * If it's set to true, system is allowed to hide the visual indicator for returning to the Home Screen in landscape mode.
+     *
+     * @default true
+     */
+    homeIndicatorAutoHide?: boolean;
     /**
      * Allows you to specify a time interval when the Capture button
      * has to be displayed after the document is detected.
@@ -219,6 +225,7 @@ export declare class Functionality {
      * Android only.
      */
     videoRecordingSizeDownscaleFactor?: number;
+    mdlTimeout?: number;
     /**
      * A list of devices that must not use the camera2 API.
      *

package/www/types/params/customization/Customization.d.ts

@@ -272,6 +272,11 @@ export declare class Customization {
      */
     cameraPreviewVerticalPositionMultiplier?: number;
 
+    /**
+     * Allows you to change the location of the multipage button.
+     */
+    multipageButtonPositionMultiplier?: number;
+
     /**
      * Allows you to set any image for the multipage animation (front side). Base64 string.
      */

package/www/types/params/process_params/AuthenticityParams.d.ts

@@ -1,4 +1,3 @@
-import { FilterObject } from "./FilterObject";
 import { LivenessParams } from "./LivenessParams";
 
 export declare class AuthenticityParams {
@@ -23,33 +22,9 @@ export declare class AuthenticityParams {
     checkLetterScreen?: boolean;
     checkSecurityText?: boolean;
 
-    setCheckFilter(checkType: AuthenticityCheckType, filter: FilterObject): void;
-
-    removeCheckFilter(checkType: AuthenticityCheckType): void;
-
-    clearCheckFilter(): void;
-
     /**
      * Allows you to deserialize object.
      * @param jsonObject
      */
     static fromJson(jsonObject: any): AuthenticityParams;
 }
-
-export declare enum AuthenticityCheckType {
-    USE_LIVENESS = "checkLiveness",
-    UV_LUMINISCENCE = "checkUVLuminiscence",
-    IR_B900 = "checkIRB900",
-    IMAGE_PATTERNS = "checkImagePatterns",
-    FIBERS = "checkFibers",
-    EXT_MRZ = "checkExtMRZ",
-    EXT_OCR = "checkExtOCR",
-    AXIAL = "checkAxial",
-    BARCODE_FORMAT = "checkBarcodeFormat",
-    IR_VISIBILITY = "checkIRVisibility",
-    IPI = "checkIPI",
-    PHOTO_EMBEDDING = "checkPhotoEmbedding",
-    PHOTO_COMPARISON = "checkPhotoComparison",
-    LETTER_SCREEN = "checkLetterScreen",
-    SECURITY_TEXT = "checkSecurityText",
-}

package/www/types/params/process_params/LivenessParams.d.ts

@@ -1,5 +1,3 @@
-import { FilterObject } from "./FilterObject";
-
 export declare class LivenessParams {
     checkOVI?: boolean;
     checkMLI?: boolean;
@@ -14,25 +12,9 @@ export declare class LivenessParams {
 
     checkGeometry?: boolean;
 
-    setCheckFilter(checkType: LivenessCheckType, filter: FilterObject): void;
-
-    removeCheckFilter(checkType: LivenessCheckType): void;
-
-    clearCheckFilter(): void;
-
     /**
      * Allows you to deserialize object.
      * @param jsonObject
      */
     static fromJson(jsonObject: any): LivenessParams;
 }
-
-export declare enum LivenessCheckType {
-    OVI = "checkOVI",
-    MLI = "checkMLI",
-    HOLO = "checkHolo",
-    ED = "checkED",
-    BLACK_AND_WHITE_COPY = "checkBlackAndWhiteCopy",
-    DYNAPRINT = "checkDynaprint",
-    GEOMETRY = "checkGeometry",
-}

package/www/types/params/process_params/ProcessParams.d.ts

@@ -1,4 +1,3 @@
-import { FilterObject } from "./FilterObject";
 import { AuthenticityParams } from "./AuthenticityParams";
 import { BackendProcessingConfig } from "./BackendProcessingConfig";
 import { FaceApiParams } from "./FaceApiParams";
@@ -202,6 +201,16 @@ export declare class ProcessParams {
      * When enabled, this parameter marks security checks that don’t meet minimum requirements as 'Failed' (instead of 'WasNotDone'), which causes the overall security status to be 'Failed'.
      */
     strictSecurityChecks?: boolean;
+    /**
+     * Allows transliteration to be turned on or off.
+     * Default: `true`.
+     */
+    returnTransliteratedFields?: boolean;
+
+    /** 
+     * Android only. 
+     */
+    checkCaptureProcessIntegrity?: boolean;
     /**
      * There are documents that contain barcodes which data can be parsed only
      * if document type verification is performed. The following property allows
@@ -392,6 +401,14 @@ export declare class ProcessParams {
      * Unmodifiable property. Use setter instead of editing.
      */
     lcidFilter?: LCID[];
+    /**
+     * If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction.
+     * All field types listed in this array are skipped during processing, while the remaining fields are recognized.
+     * This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted.
+     *
+     * Unmodifiable property. Use setter instead of editing.
+     */
+    fieldTypesIgnoreFilter?: FieldType[];
     /**
      * Controls properties of {@link ImageQA} checks.
      */
@@ -416,12 +433,6 @@ export declare class ProcessParams {
      */
     customParams?: Record<string, any>;
 
-    setCheckFilter(checkType: FilterCheckType, filter: FilterObject): void;
-
-    removeCheckFilter(checkType: FilterCheckType): void;
-
-    clearCheckFilter(): void;
-
     /**
      * Allows you to deserialize object.
      * @param jsonObject
@@ -478,7 +489,3 @@ export declare enum MrzDetectionModes {
     RESIZE_BINARIZE_WINDOW = 1,
     BLUR_BEFORE_BINARIZATION = 2,
 }
-
-export declare enum FilterCheckType {
-    AUTH = "checkAuth",
-}

package/www/types/results/Results.d.ts

@@ -15,6 +15,7 @@ import { VDSNCData } from "./visible_digital_seals/VDSNCData";
 import { Position } from "./Position";
 import { DocumentType } from "./DocumentType";
 import { TransactionInfo } from "./TransactionInfo";
+import { VDSData } from "./visible_digital_seals/VDSData";
 
 /** Class describing results returned on completion of Document Reader work. */
 export declare class Results {
@@ -47,6 +48,8 @@ export declare class Results {
     readonly barcodeResult: BarcodeResult | null;
     /** Visible Digital Seal data. */
     readonly vdsncData: VDSNCData | null;
+    /** Visible Digital Seal data. */
+    readonly vdsData: VDSData | null;
     /** DTCVC data. */
     readonly dtcData: string | null;
     /** Document processing finish status, one of RGLProcessingFinishedStatus values. */
@@ -279,5 +282,10 @@ export declare enum ResultType {
      */
     RFID_ORIGINAL_GRAPHICS = 105,
     /** Digital Travel Credential data. */
-    RFID_DTC_VC = 109
+    RFID_DTC_VC = 109,
+    MDL_PARSED_RESPONSE = 121,
+    /** VDS_NC. */
+    VDS_NC = 124,
+    /** VDS. */
+    VDS = 125,
 }

package/www/types/results/status/AgeStatus.d.ts

@@ -0,0 +1,14 @@
+import { CheckResult } from "./CheckResult";
+
+/** Container for an age related scanning statuses. */
+export declare class AgeStatus {
+    readonly threshold: number | null;
+    readonly overThreshold: CheckResult;
+    readonly over18: CheckResult;
+    readonly over21: CheckResult;
+    readonly over25: CheckResult;
+    readonly over65: CheckResult;
+
+    /** Allows you to deserialize object. */
+    static fromJson(jsonObject: any): AgeStatus | null;
+}

package/www/types/results/status/ResultsStatus.d.ts

@@ -1,5 +1,6 @@
 import { CheckResult } from "./CheckResult";
 import { OpticalStatus } from "./OpticalStatus";
+import { AgeStatus } from "./AgeStatus";
 import { RFIDStatus } from "./RFIDStatus";
 
 /** Provision of document verification status. */
@@ -18,6 +19,14 @@ export declare class ResultsStatus {
     readonly portrait: CheckResult;
     /** Verification status for document data against database. */
     readonly stopList: CheckResult;
+    /** Summary of all mDL results. */
+    readonly mDL: CheckResult;
+    /** Summary of all age results. */
+    readonly age: CheckResult;
+    /** Android only. */
+    readonly captureProcessIntegrity: CheckResult | null;
+    /** Container for an age related scanning statuses. */
+    readonly ageStatus: AgeStatus;
 
     /** Allows you to deserialize object. */
     static fromJson(jsonObject: any): ResultsStatus | null;

package/www/types/results/visible_digital_seals/DocFeature.d.ts

@@ -0,0 +1,9 @@
+import { BytesData } from "./BytesData";
+
+export declare class DocFeature {
+    readonly type: number;
+    readonly data: BytesData;
+
+    /** Allows you to deserialize object. */
+    static fromJson(jsonObject: any): DocFeature | null;
+}

package/www/types/results/visible_digital_seals/VDSData.d.ts

@@ -0,0 +1,32 @@
+import { CertificateChain } from "../rfid/CertificateChain";
+import { BytesData } from './BytesData';
+import { DocFeature } from "./DocFeature";
+
+/** Visible Digital Seal. */
+export declare class VDSData {
+    readonly type?: number;
+    readonly docType?: number;
+    readonly featureRef?: number;
+    /** Visible Digital Seal use case version. */
+    readonly version?: number;
+    /** Three letter code identifying the issuing state or organization. */
+    readonly issuingCountry?: string;
+    readonly docIssueDate?: string;
+    /** The binary data of the verified digital signature. */
+    readonly signature?: BytesData;
+    readonly signatureDate?: string;
+    readonly signer?: string;
+    readonly certificate?: string;
+    /** The certificate chain, used for the digital signature verification. */
+    readonly certificateChain: CertificateChain[];
+    /** The doc features. */
+    readonly docFeatures: DocFeature[];
+    /**
+     * The list of remarks occured during the scanning procedure.
+     * Each element belongs to the {@link LDSParsingErrorCodes} or the {@link LDSParsingNotificationCodes}.
+     */
+    readonly notifications: number[];
+
+    /** Allows you to deserialize object. */
+    static fromJson(jsonObject: any): VDSData | null;
+}

package/www/types/results/visible_digital_seals/VDSNCData.d.ts

@@ -28,7 +28,7 @@ export declare class VDSNCData {
      * The list of remarks occured during the scanning procedure.
      * Each element belongs to the {@link LDSParsingErrorCodes} or the {@link LDSParsingNotificationCodes}.
      */
-    readonly notifications?: number[];
+    readonly notifications: number[];
 
     /** Allows you to deserialize object. */
     static fromJson(jsonObject: any): VDSNCData | null;

package/www/types/results/visual_results/FieldType.d.ts

@@ -1307,6 +1307,12 @@ export declare enum FieldType {
   FIRST_ISSUE_DATE_CHECKDIGIT = 698,
   /** First issue date checksum. */
   FIRST_ISSUE_DATE_CHECKSUM = 699,
+  /** Commercial indicator. */
+  COMMERCIAL_INDICATOR = 701,
+  /** Non-domiciled indicator. */
+  NON_DOMICILED_INDICATOR = 702,
+  /** Jurisdiction specific data. */
+  JURISDICTION_SPECIFIC_DATA = 703,
 }
 
 export declare namespace FieldType {

package/www/types/rfid/PKDCertificate.d.ts

@@ -26,7 +26,13 @@ export declare enum PKDResourceType {
     /** Deviance List (.dl, .dls, .dvl). */
     DEVL = 6,
     /** Black List (.bl, .bls). */
-    BL = 7
+    BL = 7,
+    /** LDIF file contents for TA. */
+    LDIF_TA = 8,
+    /** Master List with CV certificates for TA. */
+    ML_TA = 9,
+    /** CBOR List. */
+    CBOR = 10,
 }
 
 export declare namespace PKDResourceType {

package/www/capacitor/params/process_params/FilterObject.js

@@ -1,60 +0,0 @@
-export class FilterObject {
-    docIDsFilter
-    docFormatsFilter
-    docCategoriesFilter
-    docCountriesFilter
-
-    static fromJson(json) {
-        var result = new FilterObject();
-        result.docIDsFilter = FilterObjectType.fromJson(json["docIDsFilter"]);
-        result.docFormatsFilter = FilterObjectType.fromJson(json["docFormatsFilter"]);
-        result.docCategoriesFilter = FilterObjectType.fromJson(json["docCategoriesFilter"]);
-        result.docCountriesFilter = FilterObjectType.fromJson(json["docCountriesFilter"]);
-        return result;
-    }
-
-    toJson() {
-        return {
-            "docIDsFilter": this.docIDsFilter?.toJson(),
-            "docFormatsFilter": this.docFormatsFilter?.toJson(),
-            "docCategoriesFilter": this.docCategoriesFilter?.toJson(),
-            "docCountriesFilter": this.docCountriesFilter?.toJson()
-        }
-    }
-}
-
-export class FilterObjectType {
-    _list
-    _isInclude
-
-    static createIncludeList(list) {
-        var result = new FilterObjectType();
-        result._list = list;
-        result._isInclude = true;
-        return result;
-    }
-
-    static createExcludeList(list) {
-        var result = new FilterObjectType();
-        result._list = list;
-        result._isInclude = false;
-        return result;
-    }
-
-    static fromJson(json) {
-        if (json == null) return null;
-        if (json["isInclude"]) {
-            return FilterObjectType.createIncludeList(json["list"]);
-        } else {
-            return FilterObjectType.createExcludeList(json["list"]);
-        }
-    }
-
-    toJson() {
-        return {
-            "list": this._list,
-            "isInclude": this._isInclude,
-        }
-    }
-}
-

package/www/react-native/params/process_params/FilterObject.js

@@ -1,60 +0,0 @@
-export class FilterObject {
-    docIDsFilter
-    docFormatsFilter
-    docCategoriesFilter
-    docCountriesFilter
-
-    static fromJson(json) {
-        var result = new FilterObject();
-        result.docIDsFilter = FilterObjectType.fromJson(json["docIDsFilter"]);
-        result.docFormatsFilter = FilterObjectType.fromJson(json["docFormatsFilter"]);
-        result.docCategoriesFilter = FilterObjectType.fromJson(json["docCategoriesFilter"]);
-        result.docCountriesFilter = FilterObjectType.fromJson(json["docCountriesFilter"]);
-        return result;
-    }
-
-    toJson() {
-        return {
-            "docIDsFilter": this.docIDsFilter?.toJson(),
-            "docFormatsFilter": this.docFormatsFilter?.toJson(),
-            "docCategoriesFilter": this.docCategoriesFilter?.toJson(),
-            "docCountriesFilter": this.docCountriesFilter?.toJson()
-        }
-    }
-}
-
-export class FilterObjectType {
-    _list
-    _isInclude
-
-    static createIncludeList(list) {
-        var result = new FilterObjectType();
-        result._list = list;
-        result._isInclude = true;
-        return result;
-    }
-
-    static createExcludeList(list) {
-        var result = new FilterObjectType();
-        result._list = list;
-        result._isInclude = false;
-        return result;
-    }
-
-    static fromJson(json) {
-        if (json == null) return null;
-        if (json["isInclude"]) {
-            return FilterObjectType.createIncludeList(json["list"]);
-        } else {
-            return FilterObjectType.createExcludeList(json["list"]);
-        }
-    }
-
-    toJson() {
-        return {
-            "list": this._list,
-            "isInclude": this._isInclude,
-        }
-    }
-}
-

package/www/types/params/process_params/FilterObject.d.ts

@@ -1,32 +0,0 @@
-export declare class FilterObject {
-    docIDsFilter?: FilterObjectType;
-    docFormatsFilter?: FilterObjectType;
-    docCategoriesFilter?: FilterObjectType;
-    docCountriesFilter?: FilterObjectType;
-
-    /**
-     * Allows you to deserialize object.
-     * @param jsonObject
-     */
-    static fromJson(jsonObject: any): FilterObject;
-
-    /** Allows you to serialize object. */
-    toJson(): Record<string, any>;
-}
-
-export declare class FilterObjectType {
-    private constructor()
-
-    static createIncludeList(list: any[]): FilterObjectType;
-
-    static createExcludeList(list: any[]): FilterObjectType;
-
-    /**
-     * Allows you to deserialize object.
-     * @param jsonObject
-     */
-    static fromJson(jsonObject: any): FilterObjectType;
-
-    /** Allows you to serialize object. */
-    toJson(): Record<string, any>;
-}