@regulaforensics/document-reader 9.7.952-rc → 9.7.954-rc

package/www/types/index.d.ts

@@ -4,7 +4,26 @@ import { RFIDConfig, RFIDCompletion, RFIDProgressCompletion, ChipDetectedComplet
 import { ScannerConfig } from './config/ScannerConfig';
 import { RecognizeConfig, ImageInputData } from './config/RecognizeConfig';
 import { FinalizeConfig } from './config/FinalizeConfig';
-export { OnlineProcessingConfig, ImageFormat, OnlineMode, InitConfig, RFIDConfig, RFIDCompletion, RFIDProgressCompletion, ChipDetectedCompletion, RetryReadChipCompletion, PaCertificateCompletion, TaCertificateCompletion, PKDCertificateRequest, TaSignatureCompletion, TASignatureRequest, ScannerConfig, RecognizeConfig, ImageInputData, FinalizeConfig };
+export {
+    OnlineProcessingConfig,
+    ImageFormat,
+    OnlineMode,
+    InitConfig,
+    RFIDConfig,
+    RFIDCompletion,
+    RFIDProgressCompletion,
+    ChipDetectedCompletion,
+    RetryReadChipCompletion,
+    PaCertificateCompletion,
+    TaCertificateCompletion,
+    PKDCertificateRequest,
+    TaSignatureCompletion,
+    TASignatureRequest,
+    ScannerConfig,
+    RecognizeConfig,
+    ImageInputData,
+    FinalizeConfig,
+};
 
 import { DocReaderVersion } from './info/DocReaderVersion';
 import { PrepareProgress, DocumentReaderPrepareCompletion } from './info/PrepareProgress';
@@ -13,7 +32,19 @@ import { DocumentsDatabase } from './info/DocumentsDatabase';
 import { License } from './info/License';
 import { DocReaderScenario, Scenario, DocReaderOrientation } from './info/DocReaderScenario';
 import { RFIDException } from './info/RFIDException';
-export { DocReaderVersion, PrepareProgress, DocumentReaderPrepareCompletion, DocReaderException, ErrorCodes, DocumentsDatabase, License, DocReaderScenario, Scenario, DocReaderOrientation, RFIDException };
+export {
+    DocReaderVersion,
+    PrepareProgress,
+    DocumentReaderPrepareCompletion,
+    DocReaderException,
+    ErrorCodes,
+    DocumentsDatabase,
+    License,
+    DocReaderScenario,
+    Scenario,
+    DocReaderOrientation,
+    RFIDException,
+};
 
 import { LCID } from './results/visual_results/LCID';
 import { GraphicFieldType } from './results/visual_results/GraphicFieldType';
@@ -30,13 +61,38 @@ import { RFIDOrigin } from './results/visual_results/RFIDOrigin';
 import { TextResult } from './results/visual_results/TextResult';
 import { TextSource } from './results/visual_results/TextSource';
 import { GraphicResult } from './results/visual_results/GraphicResult';
-export { LCID, GraphicFieldType, Value, Rect, Symbol, Comparison, TextField, Lights, Validity, FieldType, GraphicField, RFIDOrigin, TextResult, TextSource, GraphicResult };
+export {
+    LCID,
+    GraphicFieldType,
+    Value,
+    Rect,
+    Symbol,
+    Comparison,
+    TextField,
+    Lights,
+    Validity,
+    FieldType,
+    GraphicField,
+    RFIDOrigin,
+    TextResult,
+    TextSource,
+    GraphicResult,
+};
 
 import { DocumentType, DocFormat, DocType as DocumentTypeEnum } from './results/DocumentType';
 import { Results, ResultType } from './results/Results';
 import { TransactionInfo } from './results/TransactionInfo';
 import { Position, Coordinate } from './results/Position';
-export { DocumentType, DocFormat, DocumentTypeEnum, Results, ResultType, TransactionInfo, Position, Coordinate };
+export {
+    DocumentType,
+    DocFormat,
+    DocumentTypeEnum,
+    Results,
+    ResultType,
+    TransactionInfo,
+    Position,
+    Coordinate,
+};
 
 import { RFIDStatus } from './results/status/RFIDStatus';
 import { ResultsStatus } from './results/status/ResultsStatus';
@@ -44,7 +100,14 @@ import { CheckResult } from './results/status/CheckResult';
 import { OpticalStatus } from './results/status/OpticalStatus';
 import { AgeStatus } from './results/status/AgeStatus';
 import { ProcessingFinishedStatus } from './results/Results';
-export { RFIDStatus, ResultsStatus, CheckResult, OpticalStatus, AgeStatus, ProcessingFinishedStatus };
+export {
+    RFIDStatus,
+    ResultsStatus,
+    CheckResult,
+    OpticalStatus,
+    AgeStatus,
+    ProcessingFinishedStatus,
+};
 
 import { CheckDiagnose } from './results/authenticity/CheckDiagnose';
 import { AuthenticityElement } from './results/authenticity/AuthenticityElement';
@@ -52,19 +115,36 @@ import { AuthenticityResult } from './results/authenticity/AuthenticityResult';
 import { AuthenticityCheck } from './results/authenticity/AuthenticityCheck';
 import { SecurityFeatureType } from './results/authenticity/SecurityFeatureType';
 import { Authenticity } from './results/authenticity/Authenticity';
-export { CheckDiagnose, AuthenticityElement, AuthenticityResult, AuthenticityCheck, SecurityFeatureType, Authenticity };
+export {
+    CheckDiagnose,
+    AuthenticityElement,
+    AuthenticityResult,
+    AuthenticityCheck,
+    SecurityFeatureType,
+    Authenticity,
+};
 
 import { PDF417Info } from './results/barcode/PDF417Info';
 import { BarcodeStatus } from './results/barcode/BarcodeStatus';
 import { BarcodeType } from './results/barcode/BarcodeType';
 import { BarcodeResult } from './results/barcode/BarcodeResult';
 import { BarcodeField } from './results/barcode/BarcodeField';
-export { PDF417Info, BarcodeStatus, BarcodeType, BarcodeResult, BarcodeField };
+export {
+    PDF417Info,
+    BarcodeStatus,
+    BarcodeType,
+    BarcodeResult,
+    BarcodeField,
+};
 
 import { ImageQuality } from './results/image_quality/ImageQuality';
 import { ImageQualityGroup } from './results/image_quality/ImageQualityGroup';
 import { ImageQualityCheckType } from './results/image_quality/ImageQualityCheckType';
-export { ImageQuality, ImageQualityGroup, ImageQualityCheckType };
+export {
+    ImageQuality,
+    ImageQualityGroup,
+    ImageQualityCheckType,
+};
 
 import { LDSParsingErrorCodes } from './results/visible_digital_seals/LDSParsingErrorCodes';
 import { VDSNCData } from './results/visible_digital_seals/VDSNCData';
@@ -72,7 +152,14 @@ import { BytesData } from './results/visible_digital_seals/BytesData';
 import { DocFeature } from './results/visible_digital_seals/DocFeature';
 import { VDSData } from './results/visible_digital_seals/VDSData';
 import { LDSParsingNotificationCodes } from './results/visible_digital_seals/LDSParsingNotificationCodes';
-export { LDSParsingErrorCodes, VDSNCData, BytesData, DocFeature, VDSData, LDSParsingNotificationCodes };
+export {
+    LDSParsingErrorCodes,
+    VDSNCData,
+    BytesData,
+    DocFeature,
+    VDSData,
+    LDSParsingNotificationCodes,
+};
 
 import { SecurityObject } from './results/rfid/SecurityObject';
 import { CardProperties } from './results/rfid/CardProperties';
@@ -94,9 +181,32 @@ import { Application, RFIDApplicationType } from './results/rfid/Application';
 import { RFIDAccessControlProcedureType } from './results/rfid/RFIDAccessControlProcedureType';
 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 };
+export {
+    SecurityObject,
+    CardProperties,
+    DataField,
+    Attribute,
+    SignerInfo,
+    SecurityObjectCertificates,
+    CertificateChain,
+    Authority,
+    File,
+    RFIDValue,
+    RFIDValidity,
+    RFIDDataFileType,
+    CertificateData,
+    FileData,
+    RFIDCertificateType,
+    RFIDSessionData,
+    Application,
+    RFIDApplicationType,
+    RFIDAccessControlProcedureType,
+    Extension,
+    AccessControlProcedureType,
+};
 
 import { LivenessParams } from './params/process_params/LivenessParams';
+import { AuthenticityPropertiesParams } from './params/process_params/AuthenticityPropertiesParams';
 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';
@@ -106,10 +216,33 @@ import { AuthenticityParams } from './params/process_params/AuthenticityParams';
 import { BackendProcessingConfig } from './params/process_params/BackendProcessingConfig';
 import { Bsi } from './params/process_params/Bsi';
 import { FaceApiSearchParams } from './params/process_params/FaceApiSearchParams';
-export { LivenessParams, ProcessParams, MeasureSystem, MRZFormat, LogLevel, MrzDetectionModes, GlaresCheckParams, FaceApiParams, RFIDParams, ImageQA, AuthenticityParams,BackendProcessingConfig, Bsi, FaceApiSearchParams };
+export {
+    LivenessParams,
+    AuthenticityPropertiesParams,
+    ProcessParams,
+    MeasureSystem,
+    MRZFormat,
+    LogLevel,
+    MrzDetectionModes,
+    GlaresCheckParams,
+    FaceApiParams,
+    RFIDParams,
+    ImageQA,
+    AuthenticityParams, BackendProcessingConfig,
+    Bsi,
+    FaceApiSearchParams,
+};
 
 import { Functionality, CameraPosition, CaptureMode, CameraMode, CaptureSessionPreset, DocReaderFrame, CameraSize } from './params/Functionality';
-export { Functionality, CameraPosition, CaptureMode, CameraMode, CaptureSessionPreset, DocReaderFrame, CameraSize };
+export {
+    Functionality,
+    CameraPosition,
+    CaptureMode,
+    CameraMode,
+    CaptureSessionPreset,
+    DocReaderFrame,
+    CameraSize,
+};
 
 import { CustomizationColors } from './params/customization/CustomizationColors';
 import { CustomizationFonts, Font, FontStyle } from './params/customization/CustomizationFonts';
@@ -118,14 +251,41 @@ import { CustomizationTimings } from './params/customization/CustomizationTiming
 import { CustomizationMatrices } from './params/customization/CustomizationMatrices';
 import { CustomizationContentModes, ViewContentMode } from './params/customization/CustomizationContentModes';
 import { Customization, Cap, FrameShapeType, CustomButtonTag, CustomizationTheme } from './params/customization/Customization';
-export { CustomizationColors, CustomizationFonts, CustomizationImages, CustomizationTimings, CustomizationMatrices, CustomizationContentModes, Font, FontStyle, Customization, Cap, FrameShapeType, ViewContentMode, CustomButtonTag, CustomizationTheme };
+export {
+    CustomizationColors,
+    CustomizationFonts,
+    CustomizationImages,
+    CustomizationTimings,
+    CustomizationMatrices,
+    CustomizationContentModes,
+    Font,
+    FontStyle,
+    Customization,
+    Cap,
+    FrameShapeType,
+    ViewContentMode,
+    CustomButtonTag,
+    CustomizationTheme,
+};
 
 import { EPassportDataGroups } from './params/rfid_scenario/EPassportDataGroups';
 import { EIDDataGroups } from './params/rfid_scenario/EIDDataGroups';
 import { DTCDataGroup } from './params/rfid_scenario/DTCDataGroup';
 import { RFIDScenario, RFIDAuthenticationProcedureType, RFIDPasswordType, RFIDSDKProfilerType, RFIDTerminalType, SignManagementAction, RFIDReadingBufferSize } from './params/rfid_scenario/RFIDScenario';
 import { EDLDataGroups } from './params/rfid_scenario/EDLDataGroups';
-export { EPassportDataGroups, EIDDataGroups, DTCDataGroup, RFIDScenario, RFIDAuthenticationProcedureType, RFIDPasswordType, RFIDSDKProfilerType, RFIDTerminalType, SignManagementAction, RFIDReadingBufferSize, EDLDataGroups };
+export {
+    EPassportDataGroups,
+    EIDDataGroups,
+    DTCDataGroup,
+    RFIDScenario,
+    RFIDAuthenticationProcedureType,
+    RFIDPasswordType,
+    RFIDSDKProfilerType,
+    RFIDTerminalType,
+    SignManagementAction,
+    RFIDReadingBufferSize,
+    EDLDataGroups,
+};
 
 import { PAResourcesIssuer } from './rfid/PAResourcesIssuer';
 import { RFIDErrorCodes } from './rfid/RFIDErrorCodes';
@@ -136,14 +296,37 @@ import { TAChallenge } from './rfid/TAChallenge';
 import { PACEProtocol } from './rfid/PACEProtocol';
 import { CAProtocol } from './rfid/CAProtocol';
 import { PKDCertificate, PKDResourceType } from './rfid/PKDCertificate';
-export { PAResourcesIssuer, RFIDErrorCodes, TccParams, RFIDNotification, RFIDNotificationCodes, PAAttribute, TAChallenge, PACEProtocol, CAProtocol, PKDCertificate, PKDResourceType };
+export {
+    PAResourcesIssuer,
+    RFIDErrorCodes,
+    TccParams,
+    RFIDNotification,
+    RFIDNotificationCodes,
+    PAAttribute,
+    TAChallenge,
+    PACEProtocol,
+    CAProtocol,
+    PKDCertificate,
+    PKDResourceType,
+};
 
 import { DataRetrieval, MDLDocRequestPreset, MDLDeviceRetrieval } from './mdl/DataRetrieval';
 import { DeviceEngagement, MDLDeviceEngagement } from './mdl/DeviceEngagement';
 import { NameSpaceMDL, MDLIntentToRetain } from './mdl/NameSpaceMDL';
 import { DocumentRequestMDL, DocumentRequest18013MDL } from './mdl/DocumentRequestMDL';
 import { DeviceRetrievalMethod } from './mdl/DeviceRetrievalMethod';
-export { DataRetrieval, MDLDocRequestPreset, MDLDeviceRetrieval, DeviceEngagement, MDLDeviceEngagement, DeviceRetrievalMethod, DocumentRequest18013MDL, MDLIntentToRetain, NameSpaceMDL, DocumentRequestMDL };
+export {
+    DataRetrieval,
+    MDLDocRequestPreset,
+    MDLDeviceRetrieval,
+    DeviceEngagement,
+    MDLDeviceEngagement,
+    DeviceRetrievalMethod,
+    DocumentRequest18013MDL,
+    MDLIntentToRetain,
+    NameSpaceMDL,
+    DocumentRequestMDL,
+};
 
 
 /**
@@ -308,7 +491,11 @@ export class DocumentReader {
     /** Cancels any ongoing database update or preparation. */
     cancelDBUpdate(): Promise<boolean>;
 
-    /** Removes the current document database. */
+    /**
+     * Allows you to remove the database from your app.
+     * 
+     * @returns `true` only if the database was removed or absent.
+     */
     removeDatabase(): Promise<boolean>;
 
     /** Used to start the processing of the next page of the document once the current one is processed. */
@@ -398,7 +585,7 @@ export class DocumentReader {
      * 
      * @param data - Required if @param type = {@link MDLDeviceEngagement.QR} and @param withoutUI = `true`.
      */
-    engageDevice(type: MDLDeviceEngagement, options?: {withoutUI: boolean, data?: string}): Promise<[engagement: DeviceEngagement | null, error: DocReaderException | null]>;
+    engageDevice(type: MDLDeviceEngagement, options?: { withoutUI: boolean, data?: string }): Promise<[engagement: DeviceEngagement | null, error: DocReaderException | null]>;
 
     /**
      * Used to retrieve data.
@@ -407,7 +594,7 @@ export class DocumentReader {
      * 
      * @param engagement - Required for @param withoutUI = `null` or {@link MDLDeviceRetrieval.BLE}. Not needed for {@link MDLDeviceRetrieval.NFC}
      */
-    retrieveData(retrieval: DataRetrieval, options?: {withoutUI?: MDLDeviceRetrieval, engagement?: DeviceEngagement}): Promise<[action: DocReaderAction, results: Results | null, error: DocReaderException | null]>;
+    retrieveData(retrieval: DataRetrieval, options?: { withoutUI?: MDLDeviceRetrieval, engagement?: DeviceEngagement }): Promise<[action: DocReaderAction, results: Results | null, error: DocReaderException | null]>;
 }
 
 /**

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

@@ -1,11 +1,9 @@
 import { LivenessParams } from "./LivenessParams";
+import { AuthenticityPropertiesParams } from "./AuthenticityPropertiesParams";
 
 export declare class AuthenticityParams {
-    /**
-     * This parameter is used to enable document liveness check.
-     */
+    /** This parameter is used to enable document liveness check. */
     useLivenessCheck?: boolean;
-
     livenessParams: LivenessParams;
     checkUVLuminiscence?: boolean;
     checkIRB900?: boolean;
@@ -21,6 +19,9 @@ export declare class AuthenticityParams {
     checkPhotoComparison?: boolean;
     checkLetterScreen?: boolean;
     checkSecurityText?: boolean;
+    /** Set to true to enable detection of the document properties, such as holder's signature and other attributes. */
+    checkProperties?: boolean;
+    propertiesParams: AuthenticityPropertiesParams;
 
     /**
      * Allows you to deserialize object.

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

@@ -0,0 +1,10 @@
+export declare class AuthenticityPropertiesParams {
+    /** Set to true to enable detection of the document holder’s signature. */
+    checkHoldersSignature?: boolean;
+
+    /**
+     * Allows you to deserialize object.
+     * @param jsonObject
+     */
+    static fromJson(jsonObject: any): AuthenticityPropertiesParams;
+}

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

@@ -47,6 +47,9 @@ export declare class FaceApiParams {
      */
     readonly proxyType?: number;
 
+    /** This parameter allows you to use a liveness transaction id instead of a selfie photo. */
+    readonly livenessTransactionId?: string;
+
     constructor(
         options?: {
             url?: string,
@@ -57,6 +60,7 @@ export declare class FaceApiParams {
             proxy?: string,
             proxyPassword?: string,
             proxyType?: number,
+            livenessTransactionId?: string,
         }
     );
 

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

@@ -377,9 +377,10 @@ export declare class ProcessParams {
      */
     resultTypeOutput?: ResultType[];
     /**
-     * This option allows limiting MRZ formats to be recognized by specifying
-     * them in array.
+     * This option allows limiting MRZ formats to be recognized by specifying them in array.
      *
+     * If left empty, all MRZ formats will be recognized, except for 2x30, which is disabled by default.
+     * 
      * Unmodifiable property. Use setter instead of editing.
      */
     mrzFormatsFilter?: MRZFormat[];

package/www/types/results/authenticity/Authenticity.d.ts

@@ -62,6 +62,7 @@ export declare enum Authenticity {
      * absence of signs that the image was edited.
      */
     MRZ = 8388608,
+    PROPERTY = 33554432,
     /** Status only. */
     STATUS_ONLY = 2147483648,
 }

package/www/types/results/authenticity/CheckDiagnose.d.ts

@@ -234,4 +234,7 @@ export declare enum CheckDiagnose {
     ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT = 248,
     /** Incorrect object color. */
     INCORRECT_OBJECT_COLOR = 250,
+    PROPERTY_NO_SIGNATURE = 260,
+    PROPERTY_TEXT_AS_SIGNATURE = 261,
+    PROPERTY_FINGERPRINT_AS_SIGNATURE = 262,
 }

package/www/types/results/authenticity/SecurityFeatureType.d.ts

@@ -105,4 +105,5 @@ export declare enum SecurityFeatureType {
     PORTRAIT_COMPARISON_BARCODEVSGHOST = 59,
     PORTRAIT_COMPARISON_GHOSTVSLIVE = 60,
     PORTRAIT_COMPARISON_EXTVSGHOST = 61,
+    SIGNATURE_PRESENCE = 62,
 }

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

@@ -1316,7 +1316,9 @@ export declare enum FieldType {
   JURISDICTION_SPECIFIC_DATA = 703,
   DATA_DATE_OF_EXPIRY = 704,
   CONSUL = 705,
-  CANTON_REFERENCE = 706,
+  DLCLASSCODE_B3_FROM = 706,
+  DLCLASSCODE_B3_TO = 707,
+  DLCLASSCODE_B3_NOTES = 708,
 }
 
 export declare namespace FieldType {