@regulaforensics/document-reader 8.4.401-beta → 8.5.443-nightly

package/www/react-native/index.js

@@ -94,17 +94,16 @@ import { Extension } from './results/rfid/Extension';
 import { AccessControlProcedureType } from './results/rfid/AccessControlProcedureType';
 export { SecurityObject, CardProperties, DataField, Attribute, SignerInfo, SecurityObjectCertificates, CertificateChain, Authority, File, RFIDValue, RFIDValidity, RFIDDataFileType, CertificateData, FileData, RFIDCertificateType, RFIDSessionData, Application, RFIDApplicationType, RFIDAccessControlProcedureType, Extension, AccessControlProcedureType };
 
-import { FilterObject, FilterObjectType } from './params/process_params/FilterObject';
-import { LivenessParams, LivenessCheckType } from './params/process_params/LivenessParams';
-import { ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, FilterCheckType } from './params/process_params/ProcessParams';
+import { LivenessParams } from './params/process_params/LivenessParams';
+import { ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes } from './params/process_params/ProcessParams';
 import { GlaresCheckParams } from './params/process_params/GlaresCheckParams';
 import { FaceApiParams } from './params/process_params/FaceApiParams';
 import { RFIDParams } from './params/process_params/RFIDParams';
 import { ImageQA } from './params/process_params/ImageQA';
-import { AuthenticityParams, AuthenticityCheckType } from './params/process_params/AuthenticityParams';
+import { AuthenticityParams } from './params/process_params/AuthenticityParams';
 import { BackendProcessingConfig } from './params/process_params/BackendProcessingConfig';
 import { FaceApiSearchParams } from './params/process_params/FaceApiSearchParams';
-export { FilterObject, FilterObjectType, LivenessParams, LivenessCheckType, ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, FilterCheckType, GlaresCheckParams, FaceApiParams, RFIDParams, ImageQA, AuthenticityParams, AuthenticityCheckType, BackendProcessingConfig, FaceApiSearchParams };
+export { LivenessParams, ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, GlaresCheckParams, FaceApiParams, RFIDParams, ImageQA, AuthenticityParams, BackendProcessingConfig, FaceApiSearchParams };
 
 import { Functionality, CameraPosition, CaptureMode, CameraMode, CaptureSessionPreset, DocReaderFrame, CameraSize } from './params/Functionality';
 export { Functionality, CameraPosition, CaptureMode, CameraMode, CaptureSessionPreset, DocReaderFrame, CameraSize };

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

@@ -1,6 +1,5 @@
 import { DocumentReader } from '../../index';
 import { LivenessParams } from './LivenessParams';
-import { FilterObject } from './FilterObject';
 
 export class AuthenticityParams {
     get useLivenessCheck() { return this._useLivenessCheck; }
@@ -9,6 +8,7 @@ export class AuthenticityParams {
         this._set({ "useLivenessCheck": val });
     }
 
+    _livenessParams = new LivenessParams();
     get livenessParams() { return this._livenessParams; }
     set livenessParams(val) { (this._livenessParams = val)._apply(); }
 
@@ -96,28 +96,6 @@ export class AuthenticityParams {
         this._set({ "checkSecurityText": val });
     }
 
-    _checkFilters = {};
-
-    setCheckFilter(checkType, filter) {
-        this._checkFilters[checkType] = filter;
-        this._set({
-            "setCheckFilter": {
-                "checkType": checkType,
-                "filterObject": filter.toJson(),
-            },
-        });
-    }
-
-    removeCheckFilter(checkType) {
-        delete this._checkFilters[checkType];
-        this._set({ "removeCheckFilter": checkType });
-    }
-
-    clearCheckFilter() {
-        this._checkFilters = {};
-        this._set({ "clearCheckFilter": null });
-    }
-
     static fromJson(jsonObject) {
         if (jsonObject == null) return new AuthenticityParams();
 
@@ -139,8 +117,6 @@ export class AuthenticityParams {
         result._checkPhotoComparison = jsonObject["checkPhotoComparison"];
         result._checkLetterScreen = jsonObject["checkLetterScreen"];
         result._checkSecurityText = jsonObject["checkSecurityText"];
-        result._checkFilters = Object.fromEntries(Object.entries(jsonObject["checkFilters"] ?? {})
-            .map(([k, v]) => [k, FilterObject.fromJson(v)]));
 
         return result;
     }
@@ -170,25 +146,6 @@ export class AuthenticityParams {
             "checkPhotoComparison": this.checkPhotoComparison,
             "checkLetterScreen": this.checkLetterScreen,
             "checkSecurityText": this.checkSecurityText,
-            "checkFilters": Object.fromEntries(Object.entries(this._checkFilters).map(([k, v]) => [k, v.toJson()])),
         }
     }
 }
-
-export const 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/react-native/params/process_params/LivenessParams.js

@@ -1,5 +1,4 @@
 import { DocumentReader } from '../../index';
-import { FilterObject } from './FilterObject';
 
 export class LivenessParams {
     get checkOVI() { return this._checkOVI; }
@@ -44,28 +43,6 @@ export class LivenessParams {
         this._set({ "checkGeometry": val });
     }
 
-    _checkFilters = {};
-
-    setCheckFilter(checkType, filter) {
-        this._checkFilters[checkType] = filter;
-        this._set({
-            "setCheckFilter": {
-                "checkType": checkType,
-                "filterObject": filter.toJson(),
-            },
-        });
-    }
-
-    removeCheckFilter(checkType) {
-        delete this._checkFilters[checkType];
-        this._set({ "removeCheckFilter": checkType });
-    }
-
-    clearCheckFilter() {
-        this._checkFilters = {};
-        this._set({ "clearCheckFilter": null });
-    }
-
     static fromJson(jsonObject) {
         if (jsonObject == null) return new LivenessParams();
 
@@ -77,8 +54,6 @@ export class LivenessParams {
         result._checkBlackAndWhiteCopy = jsonObject["checkBlackAndWhiteCopy"];
         result._checkDynaprint = jsonObject["checkDynaprint"];
         result._checkGeometry = jsonObject["checkGeometry"];
-        result._checkFilters = Object.fromEntries(Object.entries(jsonObject["checkFilters"] ?? {})
-            .map(([k, v]) => [k, FilterObject.fromJson(v)]));
 
         return result;
     }
@@ -99,17 +74,6 @@ export class LivenessParams {
             "checkBlackAndWhiteCopy": this.checkBlackAndWhiteCopy,
             "checkDynaprint": this.checkDynaprint,
             "checkGeometry": this.checkGeometry,
-            "checkFilters": Object.fromEntries(Object.entries(this._checkFilters).map(([k, v]) => [k, v.toJson()])),
         }
     }
 }
-
-export const LivenessCheckType = {
-    OVI: "checkOVI",
-    MLI: "checkMLI",
-    HOLO: "checkHolo",
-    ED: "checkED",
-    BLACK_AND_WHITE_COPY: "checkBlackAndWhiteCopy",
-    DYNAPRINT: "checkDynaprint",
-    GEOMETRY: "checkGeometry",
-};

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

@@ -5,7 +5,6 @@ import { RFIDParams } from './RFIDParams';
 import { FaceApiParams } from './FaceApiParams';
 import { BackendProcessingConfig } from './BackendProcessingConfig';
 import { AuthenticityParams } from './AuthenticityParams';
-import { FilterObject } from './FilterObject';
 
 export class ProcessParams {
     get multipageProcessing() { return this._multipageProcessing; }
@@ -242,6 +241,12 @@ export class ProcessParams {
         this._set({ "strictSecurityChecks": val });
     }
 
+    get returnTransliteratedFields() { return this._returnTransliteratedFields; }
+    set returnTransliteratedFields(val) {
+        this._returnTransliteratedFields = val;
+        this._set({ "returnTransliteratedFields": val });
+    }
+
     get barcodeParserType() { return this._barcodeParserType; }
     set barcodeParserType(val) {
         this._barcodeParserType = val;
@@ -434,6 +439,7 @@ export class ProcessParams {
         this._set({ "lcidFilter": val });
     }
 
+    _imageQA = new ImageQA();
     get imageQA() { return this._imageQA; }
     set imageQA(val) { (this._imageQA = val)._apply(); }
 
@@ -455,6 +461,7 @@ export class ProcessParams {
         this._set({ "backendProcessingConfig": val });
     }
 
+    _authenticityParams = new AuthenticityParams();
     get authenticityParams() { return this._authenticityParams; }
     set authenticityParams(val) { (this._authenticityParams = val)._apply(); }
 
@@ -464,28 +471,6 @@ export class ProcessParams {
         this._set({ "customParams": val });
     }
 
-    _checkFilters = {};
-
-    setCheckFilter(checkType, filter) {
-        this._checkFilters[checkType] = filter;
-        this._set({
-            "setCheckFilter": {
-                "checkType": checkType,
-                "filterObject": filter.toJson(),
-            },
-        });
-    }
-
-    removeCheckFilter(checkType) {
-        delete this._checkFilters[checkType];
-        this._set({ "removeCheckFilter": checkType });
-    }
-
-    clearCheckFilter() {
-        this._checkFilters = {};
-        this._set({ "clearCheckFilter": null });
-    }
-
     static fromJson(jsonObject) {
         if (jsonObject == null) return new ProcessParams();
         const result = new ProcessParams();
@@ -529,6 +514,7 @@ export class ProcessParams {
         result._generateAlpha2Codes = jsonObject["generateAlpha2Codes"];
         result._disableAuthResolutionFilter = jsonObject["disableAuthResolutionFilter"];
         result._strictSecurityChecks = jsonObject["strictSecurityChecks"];
+        result._returnTransliteratedFields = jsonObject["returnTransliteratedFields"];
         result._barcodeParserType = jsonObject["barcodeParserType"];
         result._perspectiveAngle = jsonObject["perspectiveAngle"];
         result._minDPI = jsonObject["minDPI"];
@@ -567,8 +553,6 @@ export class ProcessParams {
         result._backendProcessingConfig = BackendProcessingConfig.fromJson(jsonObject["backendProcessingConfig"]);
         result._authenticityParams = AuthenticityParams.fromJson(jsonObject["authenticityParams"]);
         result._customParams = jsonObject["customParams"];
-        result._checkFilters = Object.fromEntries(Object.entries(jsonObject["checkFilters"] ?? {})
-            .map(([k, v]) => [k, FilterObject.fromJson(v)]));
 
         return result;
     }
@@ -613,6 +597,7 @@ export class ProcessParams {
             "generateAlpha2Codes": this.generateAlpha2Codes,
             "disableAuthResolutionFilter": this.disableAuthResolutionFilter,
             "strictSecurityChecks": this.strictSecurityChecks,
+            "returnTransliteratedFields": this.returnTransliteratedFields,
             "measureSystem": this.measureSystem,
             "barcodeParserType": this.barcodeParserType,
             "perspectiveAngle": this.perspectiveAngle,
@@ -651,7 +636,6 @@ export class ProcessParams {
             "backendProcessingConfig": this.backendProcessingConfig?.toJson(),
             "authenticityParams": this.authenticityParams?.toJson(),
             "customParams": this.customParams,
-            "checkFilters": Object.fromEntries(Object.entries(this._checkFilters).map(([k, v]) => [k, v.toJson()])),
         }
     }
 
@@ -689,7 +673,3 @@ export const MrzDetectionModes = {
     RESIZE_BINARIZE_WINDOW: 1,
     BLUR_BEFORE_BINARIZATION: 2
 };
-
-export const FilterCheckType = {
-    AUTH: "checkAuth",
-};

package/www/types/index.d.ts

@@ -92,17 +92,16 @@ import { Extension } from './results/rfid/Extension';
 import { AccessControlProcedureType } from './results/rfid/AccessControlProcedureType';
 export { SecurityObject, CardProperties, DataField, Attribute, SignerInfo, SecurityObjectCertificates, CertificateChain, Authority, File, RFIDValue, RFIDValidity, RFIDDataFileType, CertificateData, FileData, RFIDCertificateType, RFIDSessionData, Application, RFIDApplicationType, RFIDAccessControlProcedureType, Extension, AccessControlProcedureType };
 
-import { FilterObject, FilterObjectType } from './params/process_params/FilterObject';
-import { LivenessParams, LivenessCheckType } from './params/process_params/LivenessParams';
-import { ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, FilterCheckType } from './params/process_params/ProcessParams';
+import { LivenessParams } from './params/process_params/LivenessParams';
+import { ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes } from './params/process_params/ProcessParams';
 import { GlaresCheckParams } from './params/process_params/GlaresCheckParams';
 import { FaceApiParams } from './params/process_params/FaceApiParams';
 import { RFIDParams } from './params/process_params/RFIDParams';
 import { ImageQA } from './params/process_params/ImageQA';
-import { AuthenticityParams, AuthenticityCheckType } from './params/process_params/AuthenticityParams';
+import { AuthenticityParams } from './params/process_params/AuthenticityParams';
 import { BackendProcessingConfig } from './params/process_params/BackendProcessingConfig';
 import { FaceApiSearchParams } from './params/process_params/FaceApiSearchParams';
-export { FilterObject, FilterObjectType, LivenessParams, LivenessCheckType, ProcessParams, FilterCheckType, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, GlaresCheckParams, FaceApiParams, RFIDParams, ImageQA, AuthenticityParams, AuthenticityCheckType,BackendProcessingConfig, FaceApiSearchParams };
+export { LivenessParams, ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, GlaresCheckParams, FaceApiParams, RFIDParams, ImageQA, AuthenticityParams,BackendProcessingConfig, FaceApiSearchParams };
 
 import { Functionality, CameraPosition, CaptureMode, CameraMode, CaptureSessionPreset, DocReaderFrame, CameraSize } from './params/Functionality';
 export { Functionality, CameraPosition, CaptureMode, CameraMode, CaptureSessionPreset, DocReaderFrame, CameraSize };
@@ -346,7 +345,7 @@ export class DocumentReader {
      *
      * @param certificates - PKD certificates.
      */
-    addPKDCertificates(certificates: [PKDCertificate]): void;
+    addPKDCertificates(certificates: PKDCertificate[]): void;
 
     /** It's used to remove certificates from your app that are used during the
      * RFID chip processing.

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,11 @@ 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;
     /**
      * There are documents that contain barcodes which data can be parsed only
      * if document type verification is performed. The following property allows
@@ -416,12 +420,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 +476,3 @@ export declare enum MrzDetectionModes {
     RESIZE_BINARIZE_WINDOW = 1,
     BLUR_BEFORE_BINARIZATION = 2,
 }
-
-export declare enum FilterCheckType {
-    AUTH = "checkAuth",
-}

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>;
-}