@regulaforensics/document-reader-typings/dist/index.d.ts

Document Reader API typings

import { AreaContainer } from '@regulaforensics/document-reader-webclient';
import { AuthenticityCheckList as AuthenticityCheckList_2 } from '@regulaforensics/document-reader-webclient';
import { AuthenticityCheckListItem } from '@regulaforensics/document-reader-webclient';
import { AuthenticityCheckResult } from '@regulaforensics/document-reader-webclient';
import { AuthenticityCheckResultItem } from '@regulaforensics/document-reader-webclient';
import { AuthenticityCheckResultListInner } from '@regulaforensics/document-reader-webclient';
import { AuthParams } from '@regulaforensics/document-reader-webclient';
import { BarcodePositionItem } from '@regulaforensics/document-reader-webclient';
import { BcPDF417INFO } from '@regulaforensics/document-reader-webclient';
import { BinaryData as BinaryData_2 } from '@regulaforensics/document-reader-webclient';
import { ByteArrayItem } from '@regulaforensics/document-reader-webclient';
import { CandidatesListItem } from '@regulaforensics/document-reader-webclient';
import { CertificateData as CertificateData_2 } from '@regulaforensics/document-reader-webclient';
import { ContainerList as ContainerList_2 } from '@regulaforensics/document-reader-webclient';
import { CrossSourceValueComparison } from '@regulaforensics/document-reader-webclient';
import { DataModule } from '@regulaforensics/document-reader-webclient';
import { DetailsOptical as DetailsOptical_2 } from '@regulaforensics/document-reader-webclient';
import { DetailsRFID as DetailsRFID_2 } from '@regulaforensics/document-reader-webclient';
import { DocBarCodeInfoFieldsList } from '@regulaforensics/document-reader-webclient';
import { DocBarCodeInfoItem } from '@regulaforensics/document-reader-webclient';
import { DocGraphicsInfoItem } from '@regulaforensics/document-reader-webclient';
import { DocumentPosition } from '@regulaforensics/document-reader-webclient';
import { DocumentPositionItem } from '@regulaforensics/document-reader-webclient';
import { DocumentsDatabase as DocumentsDatabase_2 } from '@regulaforensics/document-reader-webclient';
import { DocumentTypesCandidatesList as DocumentTypesCandidatesList_2 } from '@regulaforensics/document-reader-webclient';
import { DocVisualExtendedField as DocVisualExtendedField_2 } from '@regulaforensics/document-reader-webclient';
import { DocVisualExtendedInfo as DocVisualExtendedInfo_2 } from '@regulaforensics/document-reader-webclient';
import { DocVisualExtendedInfoItem } from '@regulaforensics/document-reader-webclient';
import { AuthenticityResultType as eAuthenticity } from '@regulaforensics/document-reader-webclient';
import { BarCodeModuleType as eBarCodeModuleType } from '@regulaforensics/document-reader-webclient';
import { BarcodeType as eBarCodeType } from '@regulaforensics/document-reader-webclient';
import { CheckDiagnose as eCheckDiagnose } from '@regulaforensics/document-reader-webclient';
import { CheckResult as eCheckResult } from '@regulaforensics/document-reader-webclient';
import { DocumentFormat as eDocFormat } from '@regulaforensics/document-reader-webclient';
import { DocumentType as eDocType } from '@regulaforensics/document-reader-webclient';
import { DocumentTypeRecognitionResult as eDocumentTypeRecognitionResult } from '@regulaforensics/document-reader-webclient';
import { VerificationResult as eFieldVerificationResult } from '@regulaforensics/document-reader-webclient';
import { GraphicFieldType as eGraphicFieldType } from '@regulaforensics/document-reader-webclient';
import { ImageQualityCheckType as eImageQualityCheckType } from '@regulaforensics/document-reader-webclient';
import { InputBarcodeType as eInputBarcodeType } from '@regulaforensics/document-reader-webclient';
import { InputImageQualityChecks as eInputImageQualityChecks } from '@regulaforensics/document-reader-webclient';
import { Visibility as eIRVisibilityFlag } from '@regulaforensics/document-reader-webclient';
import { LCID as eLCID } from '@regulaforensics/document-reader-webclient';
import { ParsingErrorCodes as eLDSParsingErrorCodes } from '@regulaforensics/document-reader-webclient';
import { ParsingNotificationCodes as eLDSParsingNotificationCodes } from '@regulaforensics/document-reader-webclient';
import { Light as eLights } from '@regulaforensics/document-reader-webclient';
import { LogLevel as eLogLevel } from '@regulaforensics/document-reader-webclient';
import { MeasureSystem as eMeasureSystem } from '@regulaforensics/document-reader-webclient';
import { MrzDetectModeEnum as eMRZDetectMode } from '@regulaforensics/document-reader-webclient';
import { MRZFormat as eMRZFormat } from '@regulaforensics/document-reader-webclient';
import { EncryptedRCLItem } from '@regulaforensics/document-reader-webclient';
import { ProcessingStatus as eProcessingStatus } from '@regulaforensics/document-reader-webclient';
import { RfidAccessControlProcedureType as eRfidAccessControlProcedureType } from '@regulaforensics/document-reader-webclient';
import { RfidAChip as eRfidAChip } from '@regulaforensics/document-reader-webclient';
import { RfidApplicationType as eRfidApplicationType } from '@regulaforensics/document-reader-webclient';
import { RfidAuthenticationProcedureType as eRfidAuthenticationProcedureType } from '@regulaforensics/document-reader-webclient';
import { RfidBaudRate as eRfidBaudRate } from '@regulaforensics/document-reader-webclient';
import { RfidCertificateOrigin as eRfidCertificateOrigin } from '@regulaforensics/document-reader-webclient';
import { RfidCertificateType as eRfidCertificateType } from '@regulaforensics/document-reader-webclient';
import { RfidDataFileType as eRfidDataFileType } from '@regulaforensics/document-reader-webclient';
import { RFIDErrorCodes as eRfidErrorCodes } from '@regulaforensics/document-reader-webclient';
import { RfidPasswordType as eRfidPasswordType } from '@regulaforensics/document-reader-webclient';
import { RfidLocation as eRfidPresence } from '@regulaforensics/document-reader-webclient';
import { RfidTerminalType as eRfidTerminalType } from '@regulaforensics/document-reader-webclient';
import { RfidType as eRfidType } from '@regulaforensics/document-reader-webclient';
import { ErrorCoordinates as ErrorCoordinates_2 } from '@regulaforensics/document-reader-webclient';
import { Scenario as eScenario } from '@regulaforensics/document-reader-webclient';
import { Critical as eSecurityCriticalFlag } from '@regulaforensics/document-reader-webclient';
import { SecurityFeatureType as eSecurityFeatureType } from '@regulaforensics/document-reader-webclient';
import { Source as eSource } from '@regulaforensics/document-reader-webclient';
import { TextPostProcessing as eTextPostProcessing } from '@regulaforensics/document-reader-webclient';
import { TextFieldType as eVisualFieldType } from '@regulaforensics/document-reader-webclient';
import { FaceApi as FaceApi_2 } from '@regulaforensics/document-reader-webclient';
import { FaceApiSearch as FaceApiSearch_2 } from '@regulaforensics/document-reader-webclient';
import { FaceDetection as FaceDetection_2 } from '@regulaforensics/document-reader-webclient';
import { FaceDetectionItem } from '@regulaforensics/document-reader-webclient';
import { FaceItem as FaceItem_2 } from '@regulaforensics/document-reader-webclient';
import { FDSIDList as FDSIDList_2 } from '@regulaforensics/document-reader-webclient';
import { FiberResult } from '@regulaforensics/document-reader-webclient';
import { FieldItem as FieldItem_2 } from '@regulaforensics/document-reader-webclient';
import { FileImage as FileImage_2 } from '@regulaforensics/document-reader-webclient';
import { GraphData as GraphData_2 } from '@regulaforensics/document-reader-webclient';
import { GraphicField } from '@regulaforensics/document-reader-webclient';
import { GraphicFieldsList } from '@regulaforensics/document-reader-webclient';
import { IdentItem } from '@regulaforensics/document-reader-webclient';
import { ImageData as ImageData_3 } from '@regulaforensics/document-reader-webclient';
import { ImageQA as ImageQA_2 } from '@regulaforensics/document-reader-webclient';
import { ImageQualityCheck as ImageQualityCheck_2 } from '@regulaforensics/document-reader-webclient';
import { ImageQualityCheckList as ImageQualityCheckList_2 } from '@regulaforensics/document-reader-webclient';
import { ImageQualityCheckListItem } from '@regulaforensics/document-reader-webclient';
import { Images } from '@regulaforensics/document-reader-webclient';
import { ImagesAvailableSource } from '@regulaforensics/document-reader-webclient';
import { ImagesField } from '@regulaforensics/document-reader-webclient';
import { ImagesFieldValue } from '@regulaforensics/document-reader-webclient';
import { ImagesItem } from '@regulaforensics/document-reader-webclient';
import { LicenseItem } from '@regulaforensics/document-reader-webclient';
import { ListVerifiedFields as ListVerifiedFields_2 } from '@regulaforensics/document-reader-webclient';
import { ListVerifiedFieldsItem } from '@regulaforensics/document-reader-webclient';
import { LivenessParams as LivenessParams_2 } from '@regulaforensics/document-reader-webclient';
import { MrzPositionItem } from '@regulaforensics/document-reader-webclient';
import { MRZRowsItem as MRZRowsItem_2 } from '@regulaforensics/document-reader-webclient';
import { MRZTestQuality as MRZTestQuality_2 } from '@regulaforensics/document-reader-webclient';
import { MRZTestQualityItem } from '@regulaforensics/document-reader-webclient';
import { OCRSecurityTextItem } from '@regulaforensics/document-reader-webclient';
import { OneCandidate as OneCandidate_2 } from '@regulaforensics/document-reader-webclient';
import { OneCandidateItem } from '@regulaforensics/document-reader-webclient';
import { OriginalSymbol } from '@regulaforensics/document-reader-webclient';
import { PArrayField } from '@regulaforensics/document-reader-webclient';
import { ParsedData } from '@regulaforensics/document-reader-webclient';
import { PerDocumentConfig as PerDocumentConfig_2 } from '@regulaforensics/document-reader-webclient';
import { PhotoIdentItem } from '@regulaforensics/document-reader-webclient';
import { Point as Point_2 } from '@regulaforensics/document-reader-webclient';
import { PointsContainer } from '@regulaforensics/document-reader-webclient';
import { ProcessParams as ProcessParams_2 } from '@regulaforensics/document-reader-webclient';
import { ProcessParamsRfid as ProcessParamsRfid_2 } from '@regulaforensics/document-reader-webclient';
import { ProcessRequest as ProcessRequest_2 } from '@regulaforensics/document-reader-webclient';
import { ProcessRequestImage as ProcessRequestImage_2 } from '@regulaforensics/document-reader-webclient';
import { ProcessResponse as ProcessResponse_2 } from '@regulaforensics/document-reader-webclient';
import { ProcessSystemInfo as ProcessSystemInfo_2 } from '@regulaforensics/document-reader-webclient';
import { RawImageContainerItem } from '@regulaforensics/document-reader-webclient';
import { RawImageContainerList as RawImageContainerList_2 } from '@regulaforensics/document-reader-webclient';
import { RectangleCoordinates } from '@regulaforensics/document-reader-webclient';
import { Result } from '@regulaforensics/document-reader-webclient';
import { ResultItem } from '@regulaforensics/document-reader-webclient';
import { ResultMRZDetector as ResultMRZDetector_2 } from '@regulaforensics/document-reader-webclient';
import { ResultMRZDetectorItem } from '@regulaforensics/document-reader-webclient';
import { RfidAccessControlInfo as RfidAccessControlInfo_2 } from '@regulaforensics/document-reader-webclient';
import { RfidAccessKey as RfidAccessKey_2 } from '@regulaforensics/document-reader-webclient';
import { RfidApplication as RfidApplication_2 } from '@regulaforensics/document-reader-webclient';
import { RfidAttributeData as RfidAttributeData_2 } from '@regulaforensics/document-reader-webclient';
import { RfidAttributeName as RfidAttributeName_2 } from '@regulaforensics/document-reader-webclient';
import { RfidCardPropertiesExt as RfidCardPropertiesExt_2 } from '@regulaforensics/document-reader-webclient';
import { RfidCertificateEx as RfidCertificateEx_2 } from '@regulaforensics/document-reader-webclient';
import { RfidDataFile as RfidDataFile_2 } from '@regulaforensics/document-reader-webclient';
import { RfidDG1 as RfidDG1_2 } from '@regulaforensics/document-reader-webclient';
import { RfidDistinguishedName as RfidDistinguishedName_2 } from '@regulaforensics/document-reader-webclient';
import { RFIDDocVisualExtendedField as RFIDDocVisualExtendedField_2 } from '@regulaforensics/document-reader-webclient';
import { RFIDDocVisualExtendedInfo as RFIDDocVisualExtendedInfo_2 } from '@regulaforensics/document-reader-webclient';
import { RFIDDocVisualExtendedInfoItem } from '@regulaforensics/document-reader-webclient';
import { RfidOrigin as RfidOrigin_2 } from '@regulaforensics/document-reader-webclient';
import { RfidPkiExtension as RfidPkiExtension_2 } from '@regulaforensics/document-reader-webclient';
import { RfidRawData as RfidRawData_2 } from '@regulaforensics/document-reader-webclient';
import { RfidSecurityObject as RfidSecurityObject_2 } from '@regulaforensics/document-reader-webclient';
import { RfidSessionData } from '@regulaforensics/document-reader-webclient';
import { RfidSignerInfoEx as RfidSignerInfoEx_2 } from '@regulaforensics/document-reader-webclient';
import { RfidTerminal as RfidTerminal_2 } from '@regulaforensics/document-reader-webclient';
import { RfidValidity as RfidValidity_2 } from '@regulaforensics/document-reader-webclient';
import { SecurityFeatureItem } from '@regulaforensics/document-reader-webclient';
import { SecurityObjectCertificates } from '@regulaforensics/document-reader-webclient';
import { SourceValidity } from '@regulaforensics/document-reader-webclient';
import { Status as Status_2 } from '@regulaforensics/document-reader-webclient';
import { StatusItem } from '@regulaforensics/document-reader-webclient';
import { StringItem as StringItem_2 } from '@regulaforensics/document-reader-webclient';
import { StringRecognitionResult as StringRecognitionResult_2 } from '@regulaforensics/document-reader-webclient';
import { Symbol as Symbol_3 } from '@regulaforensics/document-reader-webclient';
import { SymbolCandidate as SymbolCandidate_2 } from '@regulaforensics/document-reader-webclient';
import { SymbolEstimationItem as SymbolEstimationItem_2 } from '@regulaforensics/document-reader-webclient';
import { SymbolRecognitionResult as SymbolRecognitionResult_2 } from '@regulaforensics/document-reader-webclient';
import { TDocBinaryInfo } from '@regulaforensics/document-reader-webclient';
import { TDocBinaryInfoItem } from '@regulaforensics/document-reader-webclient';
import { Text as Text_2 } from '@regulaforensics/document-reader-webclient';
import { TextAvailableSource } from '@regulaforensics/document-reader-webclient';
import { TextField as TextField_2 } from '@regulaforensics/document-reader-webclient';
import { TextFieldValue as TextFieldValue_2 } from '@regulaforensics/document-reader-webclient';
import { TextItem } from '@regulaforensics/document-reader-webclient';
import { TOriginalRFIDGraphicsInfo as TOriginalRFIDGraphicsInfo_2 } from '@regulaforensics/document-reader-webclient';
import { TOriginalRFIDGraphicsInfoItem } from '@regulaforensics/document-reader-webclient';
import { TransactionInfo as TransactionInfo_2 } from '@regulaforensics/document-reader-webclient';
import { TrfFtBytes as TrfFtBytes_2 } from '@regulaforensics/document-reader-webclient';
import { TrfFtString as TrfFtString_2 } from '@regulaforensics/document-reader-webclient';
import { ValidationError } from 'class-validator';
import { ValidationOptions } from 'class-validator';
import { VerifiedFieldMap as VerifiedFieldMap_2 } from '@regulaforensics/document-reader-webclient';
import { VisualExtendedFieldItem } from '@regulaforensics/document-reader-webclient';

declare abstract class aAuthenticityCheck {
    /**
     * Check type
     * @type {eAuthenticity}
     */
    checkType: eAuthenticity;
    /**
     * Overall checking result
     * @type {eCheckResult}
     */
    checkResult: eCheckResult;
}

declare abstract class aAuthenticityCheckResult implements AuthenticityCheckResult {
    /**
     * Type of the performed check (eAuthenticity)
     * @type {eAuthenticity}
     */
    Type: eAuthenticity;
    /**
     * Overall checking result
     * @type {eCheckResult}
     */
    Result: eCheckResult;
    /**
     * Number of List items
     * @type {number|undefined}
     */
    Count?: number;
    /**
     * Array of results of checks
     * @type {AuthenticityCheckResultListInner[]}
     */
    List: AuthenticityCheckResultListInner[];
}

declare abstract class aAuthenticityCheckResultItem implements AuthenticityCheckResultItem {
    /**
     * Type of the performed check
     * @type {eAuthenticity}
     */
    Type: eAuthenticity;
    /**
     * Element responsible for the results of the checks
     * @type {eCheckResult|undefined}
     */
    ElementResult?: eCheckResult;
    /**
     * Element with which errors are checked
     * @type {eCheckDiagnose|undefined}
     */
    ElementDiagnose?: eCheckDiagnose;
    /**
     * @type {number|undefined}
     */
    PercentValue?: number;
}

declare abstract class aContainer implements ResultItem {
    /* Excluded from this release type: buf_length */
    /**
     * Lighting scheme code for the given result (used only for images)
     * @type {eLights|undefined}
     */
    light?: eLights;
    /* Excluded from this release type: list_idx */
    /**
     * Page index (when working with multi-page document)
     * @type {number|undefined}
     */
    page_idx?: number;
    /**
     * Result type stored in the container
     * @type {eResultType}
     */
    result_type: Result;
    /**
     * Get lighting scheme
     *
     * @param {aContainer|number} input - input
     * @returns {Light[]}
     */
    static getLightingScheme: (input: ResultItem | number) => eLights[];
}

declare type AllowPrimitives<ModelInterface> = {
    [Property in keyof ModelInterface]: ModelInterface[Property] extends object ? AllowPrimitives<ModelInterface[Property]> : unknown;
};

/**
 * Structure serves for storage areas and contours.
 */
export declare class AreaArray implements AreaContainer {
    /**
     * Number of elements in List and Points
     * @type {number}
     */
    Count: number;
    /**
     * Array of areas
     * @type {Rect[]}
     */
    List: Rect[];
    /**
     * Array of points
     * @type {PointArray[]}
     */
    Points: PointArray[];
}

/**
 * Structure serves for storing the result of document authenticity check using the images for different lighting
 * schemes and passing it to the user application.
 */
export declare class AuthenticityCheckList implements iAuthenticityCheckList {
    /**
     * Number of elements in the list
     * @type {number}
     */
    Count: number;
    /**
     * Array of data structures with the results of performing of different document authenticity checks
     * @type {uAuthenticityCheckResult[]}
     */
    List: uAuthenticityCheckResult[];
}

/**
 * Container for iAuthenticityCheckList
 */
export declare class AuthenticityCheckListContainer extends aContainer implements iAuthenticityCheckListContainer {
    /**
     * Structure serves for storing the result of document authenticity check using the images for different lighting
     * schemes and passing it to the user application.
     * @type {AuthenticityCheckList}
     */
    AuthenticityCheckList: AuthenticityCheckList;
    /**
     * Result type stored in this container
     * @type {tAuthenticityCheckListContainerResultType}
     */
    result_type: tAuthenticityCheckListContainerResultType;
    /**
     * Create new instance of AuthenticityCheckListContainer from plain object
     *
     * @param {unknown} input - plain object
     * @returns {AuthenticityCheckListContainer}
     */
    static fromPlain: (input: unknown) => AuthenticityCheckListContainer;
    /**
     * Get list of AuthenticityCheckListContainer from ProcessResponse
     * @param {ProcessResponse} input - ProcessResponse with containers
     * @param {boolean} asPlain - return as plain object
     * @returns {(AuthenticityCheckListContainer|iAuthenticityCheckListContainer)[]}
     */
    static fromProcessResponse(input: ProcessResponse, asPlain: true): iAuthenticityCheckListContainer[];
    static fromProcessResponse(input: ProcessResponse, asPlain?: false): AuthenticityCheckListContainer[];
    /**
     * Check if the given instance is a valid AuthenticityCheckListContainer
     *
     * @param {AuthenticityCheckListContainer} instance - instance to check
     * @throws {DocReaderTypeError}
     * @returns {true | never}
     */
    static validate: (instance: AuthenticityCheckListContainer) => true | never;
}

/**
 * Result type of AuthenticityCheckListContainer
 * @type {tAuthenticityCheckListContainerResultType[]}
 */
export declare const AuthenticityCheckListContainerResultTypes: tAuthenticityCheckListContainerResultType[];

/**
 * Container for FibersType
 */
export declare class AuthenticityFibersTypeCheckResult extends aAuthenticityCheckResult implements iAuthenticityFibersTypeCheckResult {
    /**
     * Type of the performed check (eAuthenticity)
     * @type {tAuthenticityFibersTypeCheckResultType}
     */
    Type: tAuthenticityFibersTypeCheckResultType;
    /**
     * Array of results of checks
     * @type {FibersType[]}
     */
    List: FibersType[];
    /**
     * Convert plain object to AuthenticityFibersTypeCheckResult instance
     * @param {unknown} plain - plain object
     * @returns {AuthenticityFibersTypeCheckResult} - instance
     */
    static fromPlain: (plain: unknown) => AuthenticityFibersTypeCheckResult;
    /**
     * Check if the given object is an instance of AuthenticityFibersTypeCheckResult
     * @param {unknown} type - object to check
     * @returns {type is AuthenticityFibersTypeCheckResult} - result
     */
    static isBelongs: (type: unknown) => type is AuthenticityFibersTypeCheckResult;
}

/**
 * Result type of AuthenticityFibersTypeCheckResult
 */
export declare const AuthenticityFibersTypeCheckResultTypes: tAuthenticityFibersTypeCheckResultType[];

/**
 * Container for IdentResult
 */
export declare class AuthenticityIdentCheckResult extends aAuthenticityCheckResult implements iAuthenticityIdentCheckResult {
    /**
     * Type of the performed check
     * @type {tAuthenticityIdentCheckResultType}
     */
    Type: tAuthenticityIdentCheckResultType;
    /**
     * Array of results of checks
     * @type {IdentResult[]}
     */
    List: IdentResult[];
    /**
     * Creates an instance of AuthenticityIdentCheckResult.
     * @param {iAuthenticityIdentCheckResult} plain - plain object
     * @return {AuthenticityIdentCheckResult} - new instance
     */
    static fromPlain: (plain: unknown) => AuthenticityIdentCheckResult;
    /**
     * Check if the object is a valid AuthenticityIdentCheckResult
     * @param {unknown} type - object to check
     * @return {type is iAuthenticityIdentCheckResult} - result
     */
    static isBelongs: (type: unknown) => type is iAuthenticityIdentCheckResult;
}

/**
 * Result type of AuthenticityIdentCheckResult
 */
export declare const AuthenticityIdentCheckResultTypes: tAuthenticityIdentCheckResultType[];

/**
 * Container for OCRSecurityTextResult
 */
export declare class AuthenticityOCRSecurityTextCheckResult extends aAuthenticityCheckResult implements iAuthenticityOCRSecurityTextCheckResult {
    /**
     * Type of the performed check
     * @type {tAuthenticityOCRSecurityTextCheckResultType}
     */
    Type: tAuthenticityOCRSecurityTextCheckResultType;
    /**
     * Array of results of checks
     * @type {OCRSecurityTextResult[]}
     */
    List: OCRSecurityTextResult[];
    /**
     * Create a AuthenticityOCRSecurityTextCheckResult instance from a plain object
     * @param {unknown} plain - plain object
     * @return {AuthenticityOCRSecurityTextCheckResult} - new instance
     */
    static fromPlain: (plain: unknown) => AuthenticityOCRSecurityTextCheckResult;
    /**
     * Check if the given type belongs to AuthenticityOCRSecurityTextCheckResultType
     * @param {unknown} type - type to check
     * @return {type is iAuthenticityOCRSecurityTextCheckResult} - result
     */
    static isBelongs: (type: unknown) => type is iAuthenticityOCRSecurityTextCheckResult;
}

/**
 * Result type of AuthenticityOCRSecurityTextCheckResult
 */
export declare const AuthenticityOCRSecurityTextCheckResultTypes: tAuthenticityOCRSecurityTextCheckResultType[];

/**
 * Container for PhotoIdentResult
 */
export declare class AuthenticityPhotoIdentCheckResult extends aAuthenticityCheckResult implements iAuthenticityPhotoIdentCheckResult {
    /**
     * Type of the performed check
     * @type {tAuthenticityPhotoIdentCheckResultType}
     */
    Type: tAuthenticityPhotoIdentCheckResultType;
    /**
     * Array of results of checks
     * @type {iPhotoIdentResult[]}
     */
    List: PhotoIdentResult[];
    /**
     * Create instance of AuthenticityPhotoIdentCheckResult from plain object
     * @param {unknown} plain - plain object
     * @returns {AuthenticityPhotoIdentCheckResult}
     */
    static fromPlain: (plain: unknown) => AuthenticityPhotoIdentCheckResult;
    /**
     * Check if the given type belongs to AuthenticityPhotoIdentCheckResult
     * @param {unknown} type - type to check
     * @return {type is iAuthenticityPhotoIdentCheckResult} - result
     */
    static isBelongs: (type: unknown) => type is iAuthenticityPhotoIdentCheckResult;
}

/**
 * Result type of AuthenticityPhotoIdentCheckResult
 */
export declare const AuthenticityPhotoIdentCheckResultTypes: tAuthenticityPhotoIdentCheckResultType[];

/**
 * Container for SecurityFeatureCheck
 */
export declare class AuthenticitySecurityFeatureCheckResult extends aAuthenticityCheckResult implements iAuthenticitySecurityFeatureCheckResult {
    /**
     * Type of the performed check
     * @type {tAuthenticitySecurityFeatureCheckResultType}
     */
    Type: tAuthenticitySecurityFeatureCheckResultType;
    /**
     * Array of results of checks
     * @type {SecurityFeatureCheck[]}
     */
    List: SecurityFeatureCheck[];
    /**
     * Create a new instance of AuthenticitySecurityFeatureCheckResult from plain object
     * @param {unknown} plain - plain object
     * @return {AuthenticitySecurityFeatureCheckResult} - new instance
     */
    static fromPlain: (plain: unknown) => AuthenticitySecurityFeatureCheckResult;
    /**
     * Check if the given type belongs to AuthenticitySecurityFeatureCheckResult
     * @param {unknown} type - type to check
     * @return {type is iAuthenticitySecurityFeatureCheckResult} - result
     */
    static isBelongs: (type: unknown) => type is iAuthenticitySecurityFeatureCheckResult;
}

/**
 * Result type of AuthenticitySecurityFeatureCheckResult
 */
export declare const AuthenticitySecurityFeatureCheckResultTypes: tAuthenticitySecurityFeatureCheckResultType[];

export declare const AuthenticityTextCheckReferenceTypes: tAuthenticityTextCheckReferenceType[];

export declare abstract class aVisualExtendedFieldItem implements VisualExtendedFieldItem {
    /**
     * @type {eVisualFieldType}
     */
    wFieldType: eVisualFieldType;
    /**
     * Field symbolic name (null-terminated string)
     * @type {string}
     */
    FieldName: string;
    /**
     * Number of StringsResult array elements
     * @type {number}
     */
    StringsCount: number;
    /**
     * Array of recognizing probabilities for each line of text field. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.
     * @type {StringRecognitionResult[]}
     */
    StringsResult: StringRecognitionResult[];
    /**
     * Buf_Text text string length
     * @type {number}
     */
    Buf_Length: number;
    /**
     * Text field data in UTF8 format. Results of reading different lines of a multi-line field are separated by \'^\'
     * @type {string}
     */
    Buf_Text: string;
    /**
     * @type {string|undefined}
     */
    FieldMask?: string;
    /**
     * @type {number|undefined}
     */
    Validity?: number;
    /**
     * @type {number|undefined}
     */
    InComparison?: number;
    /**
     * @type {eLCID|undefined}
     */
    wLCID?: eLCID;
    /**
     * @type {number|undefined}
     */
    Reserved2?: number;
    /**
     * @type {number|undefined}
     */
    Reserved3?: number;
}

/**
 * Container for BarcodeBoundsResult
 */
export declare class BarcodeBoundsResultContainer extends aContainer implements iBarcodeBoundsResultContainer {
    /**
     * Barcode position
     * @type {BoundsResult}
     */
    BarcodePosition: BoundsResult;
    /**
     * Result type stored in this container
     * @type {tBarcodeBoundsResultContainerResultType}
     */
    result_type: tBarcodeBoundsResultContainerResultType;
    /**
     * Create new instance of BarcodeBoundsResultContainer from plain object
     *
     * @param {unknown} input - plain object
     * @return {BarcodeBoundsResultContainer}
     */
    static fromPlain: (input: unknown) => BarcodeBoundsResultContainer;
    /**
     * Get list of BarcodeBoundsResultContainer from ProcessResponse
     * @param {ProcessResponse} input - ProcessResponse object
     * @param {boolean} asPlain - return as plain object
     * @returns {(BarcodeBoundsResultContainer | iBarcodeBoundsResultContainer)[]}
     */
    static fromProcessResponse(input: ProcessResponse, asPlain: true): iBarcodeBoundsResultContainer[];
    static fromProcessResponse(input: ProcessResponse, asPlain?: false): BarcodeBoundsResultContainer[];
    /**
     * Check if the given instance of BarcodeBoundsResultContainer is valid
     *
     * @param {BarcodeBoundsResultContainer} instance - instance of BarcodeBoundsResultContainer to validate
     * @throws {DocReaderTypeError} - if BarcodeBoundsResultContainer is not valid
     * @return {true | never} - true if BarcodeBoundsResultContainer is valid, never otherwise
     */
    static validate: (instance: BarcodeBoundsResultContainer) => true | never;
}

/**
 * Result type of BarcodeBoundsResultContainer
 * @type {tBarcodeBoundsResultContainerResultType[]}
 */
export declare const BarcodeBoundsResultContainerResultTypes: tBarcodeBoundsResultContainerResultType[];

/**
 * Structure is used for storing the results of one bar-code module reading.
 */
export declare class BinaryData implements BinaryData_2 {
    /**
     * Structure used to store the contents of Authentication_Info
     * @type {Record<string, any>|undefined}
     */
    RFID_Authentication_Info?: Record<string, any>;
    /**
     * Structure used to store the contents of MIFARE_Data_Validity
     * @type {Record<string, any>|undefined}
     */
    RFID_MIFARE_Data_Validity?: Record<string, any>;
    /**
     * Structure used to store the contents of MIFARE_Data
     * @type {Record<string, any>|undefined}
     */
    RFID_MIFARE_Data?: Record<string, any>;
    /**
     * Structure used to store the contents of EF_COM
     * @type {Record<string, any>|undefined}
     */
    RFID_EF_COM?: Record<string, any>;
    /**
     * Structure used to store the contents of EF.DG1 informational data group of
     * ePassport application – document MRZ data
     * @type {RfidDG1}
     */
    RFID_DG1?: RfidDG1;
    /**
     * Structure used to store the contents of DG2
     * @type {Record<string, any>|undefined}
     */
    RFID_DG2?: Record<string, any>;
    /**
     * Structure used to store the contents of DG3
     * @type {Record<string, any>|undefined}
     */
    RFID_DG3?: Record<string, any>;
    /**
     * Structure used to store the contents of DG4
     * @type {Record<string, any>|undefined}
     */
    RFID_DG4?: Record<string, any>;
    /**
     * Structure used to store the contents of DG5
     * @type {Record<string, any>|undefined}
     */
    RFID_DG5?: Record<string, any>;
    /**
     * Structure used to store the contents of DG6
     * @type {Record<string, any>|undefined}
     */
    RFID_DG6?: Record<string, any>;
    /**
     * Structure used to store the contents of DG7
     * @type {Record<string, any>|undefined}
     */
    RFID_DG7?: Record<string, any>;
    /**
     * Structure used to store the contents of DG8
     * @type {Record<string, any>|undefined}
     */
    RFID_DG8?: Record<string, any>;
    /**
     * Structure used to store the contents of DG9
     * @type {Record<string, any>|undefined}
     */
    RFID_DG9?: Record<string, any>;
    /**
     * Structure used to store the contents of DG10
     * @type {Record<string, any>|undefined}
     */
    RFID_DG10?: Record<string, any>;
    /**
     * Structure used to store the contents of DG11
     * @type {Record<string, any>|undefined}
     */
    RFID_DG11?: Record<string, any>;
    /**
     * Structure used to store the contents of DG12
     * @type {Record<string, any>|undefined}
     */
    RFID_DG12?: Record<string, any>;
    /**
     * Structure used to store the contents of DG13
     * @type {Record<string, any>|undefined}
     */
    RFID_DG13?: Record<string, any>;
    /**
     * Structure used to store the contents of DG14
     * @type {Record<string, any>|undefined}
     */
    RFID_DG14?: Record<string, any>;
    /**
     * Structure used to store the contents of DG15
     * @type {Record<string, any>|undefined}
     */
    RFID_DG15?: Record<string, any>;
    /**
     * Structure used to store the contents of DG16
     * @type {Record<string, any>|undefined}
     */
    RFID_DG16?: Record<string, any>;
    /**
     * Structure used to store the contents of EF_SOD
     * @type {Record<string, any>|undefined}
     */
    RFID_EF_SOD?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG1
     * @type {Record<string, any>|undefined}
     */
    eID_DG1?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG2
     * @type {Record<string, any>|undefined}
     */
    eID_DG2?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG3
     * @type {Record<string, any>|undefined}
     */
    eID_DG3?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG4
     * @type {Record<string, any>|undefined}
     */
    eID_DG4?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG5
     * @type {Record<string, any>|undefined}
     */
    eID_DG5?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG6
     * @type {Record<string, any>|undefined}
     */
    eID_DG6?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG7
     * @type {Record<string, any>|undefined}
     */
    eID_DG7?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG8
     * @type {Record<string, any>|undefined}
     */
    eID_DG8?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG9
     * @type {Record<string, any>|undefined}
     */
    eID_DG9?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG10
     * @type {Record<string, any>|undefined}
     */
    eID_DG10?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG11
     * @type {Record<string, any>|undefined}
     */
    eID_DG11?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG12
     * @type {Record<string, any>|undefined}
     */
    eID_DG12?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG3
     * @type {Record<string, any>|undefined}
     */
    eID_DG13?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG14
     * @type {Record<string, any>|undefined}
     */
    eID_DG14?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG15
     * @type {Record<string, any>|undefined}
     */
    eID_DG15?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG16
     * @type {Record<string, any>|undefined}
     */
    eID_DG16?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG17
     * @type {Record<string, any>|undefined}
     */
    eID_DG17?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG18
     * @type {Record<string, any>|undefined}
     */
    eID_DG18?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG19
     * @type {Record<string, any>|undefined}
     */
    eID_DG19?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG20
     * @type {Record<string, any>|undefined}
     */
    eID_DG20?: Record<string, any>;
    /**
     * Structure used to store the contents of eID_DG21
     * @type {Record<string, any>|undefined}
     */
    eID_DG21?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_COM
     * @type {Record<string, any>|undefined}
     */
    eDL_COM?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_SOD
     * @type {Record<string, any>|undefined}
     */
    eDL_SOD?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG1
     * @type {Record<string, any>|undefined}
     */
    eDL_DG1?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG2
     * @type {Record<string, any>|undefined}
     */
    eDL_DG2?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG3
     * @type {Record<string, any>|undefined}
     */
    eDL_DG3?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG4
     * @type {Record<string, any>|undefined}
     */
    eDL_DG4?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG5
     * @type {Record<string, any>|undefined}
     */
    eDL_DG5?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG6
     * @type {Record<string, any>|undefined}
     */
    eDL_DG6?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG7
     * @type {Record<string, any>|undefined}
     */
    eDL_DG7?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG8
     * @type {Record<string, any>|undefined}
     */
    eDL_DG8?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG9
     * @type {Record<string, any>|undefined}
     */
    eDL_DG9?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG10
     * @type {Record<string, any>|undefined}
     */
    eDL_DG10?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG11
     * @type {Record<string, any>|undefined}
     */
    eDL_DG11?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG12
     * @type {Record<string, any>|undefined}
     */
    eDL_DG12?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG13
     * @type {Record<string, any>|undefined}
     */
    eDL_DG13?: Record<string, any>;
    /**
     * Structure used to store the contents of eDL_DG14
     * @type {Record<string, any>|undefined}
     */
    eDL_DG14?: Record<string, any>;
    /**
     * Structure used to store the contents of Visible_Digital_Seal
     * @type {Record<string, any>|undefined}
     */
    Visible_Digital_Seal?: Record<string, any>;
    /**
     * Structure used to store the contents of Visible_Digital_Seal_NC
     * @type {Record<string, any>|undefined}
     */
    Visible_Digital_Seal_NC?: Record<string, any>;
    /**
     * Structure used to store the contents of Digital_Signature
     * @type {Record<string, any>|undefined}
     */
    Digital_Signature?: Record<string, any>;
    /**
     * Structure is used to describe the results of work with the SDK within the context of the current communication
     * session with electronic document
     * @type {RfidSession|undefined}
     */
    RFID_Session_Data?: RfidSession;
    /**
     * RFID session status
     * @type {DetailsRFID|undefined}
     */
    RFID_Session_Data_Status?: DetailsRFID;
    /**
     * Indexes of groups that aren't read
     * @type {eRfidDataFileType[]|undefined}
     */
    RFID_ePassp_Directory?: eRfidDataFileType[];
}

/**
 * This model is used for storing document bounds detection result
 */
export declare class BoundsResult implements DocumentPosition {
    /**
     * Document format
     * @type {eDocFormat}
     */
    docFormat: eDocFormat;
    /**
     * Document rotation angle
     * @type {number}
     */
    Angle: number;
    /**
     * Document width
     * @type {number}
     */
    Width: number;
    /**
     * Document height
     * @type {number}
     */
    Height: number;
    /**
     * Document center coordinates
     * @type {Point}
     */
    Center: Point;
    /**
     * Document left bottom corner coordinates
     * @type {Point}
     */
    LeftBottom: Point;
    /**
     * Document left top corner coordinates
     * @type {Point}
     */
    LeftTop: Point;
    /**
     * Document right bottom corner coordinates
     * @type {Point}
     */
    RightBottom: Point;
    /**
     * Document right top corner coordinates
     * @type {Point}
     */
    RightTop: Point;
    /**
     * Resolution in dots per inch
     * @type {number}
     */
    Dpi: number;
    /**
     * @type {number|undefined}
     */
    Inverse?: number;
    /**
     * @type {number|undefined}
     */
    ObjArea?: number;
    /**
     * @type {number|undefined}
     */
    ObjIntAngleDev?: number;
    /**
     * @type {number|undefined}
     */
    PerspectiveTr?: number;
    /**
     * @type {number|undefined}
     */
    ResultStatus?: number;
}

/**
 * Container for BoundsResult
 */
export declare class BoundsResultContainer extends aContainer implements iBoundsResultContainer {
    /**
     * Document position
     * @type {BoundsResult}
     */
    DocumentPosition: BoundsResult;
    /**
     * Result type stored in this container
     * @type {tBoundsResultContainerResultType}
     */
    result_type: tBoundsResultContainerResultType;
    /**
     * Create new instance of BoundsResultContainer from plain object
     *
     * @param {unknown} input - plain object
     * @return {BoundsResultContainer}
     */
    static fromPlain: (input: unknown) => BoundsResultContainer;
    /**
     * Get list of BoundsResultContainer from ProcessResponse
     * @param {ProcessResponse} input - ProcessResponse object
     * @param {boolean} asPlain - return as plain object
     * @returns {(BoundsResultContainer | iBoundsResultContainer)[]}
     */
    static fromProcessResponse(input: ProcessResponse, asPlain: true): iBoundsResultContainer[];
    static fromProcessResponse(input: ProcessResponse, asPlain?: false): BoundsResultContainer[];
    /**
     * Check if the given instance of BoundsResultContainer is valid
     *
     * @param {BoundsResultContainer} instance - instance of BoundsResultContainer to validate
     * @throws {DocReaderTypeError} - if BoundsResultContainer is not valid
     * @return {true | never} - true if BoundsResultContainer is valid, never otherwise
     */
    static validate: (instance: BoundsResultContainer) => true | never;
}

/**
 * Result type of BoundsResultContainer
 * @type {tBoundsResultContainerResultType[]}
 */
export declare const BoundsResultContainerResultTypes: tBoundsResultContainerResultType[];

/**
 * Container for byte array
 */
export declare class ByteArrayContainer extends aContainer implements iByteArrayContainer {
    /**
     * @type {string}
     */
    ByteArray: string;
    /**
     * Result type stored in this container
     * @type {tByteArrayContainerResultType}
     */
    result_type: tByteArrayContainerResultType;
    /**
     * Creates an instance of ByteArrayContainer from plain object
     *
     * @param {unknown} input - plain object
     * @returns {ByteArrayContainer}
     */
    static fromPlain: (input: unknown) => ByteArrayContainer;
    /**
     * Get ByteArrayContainer from ProcessResponse
     * @param {ProcessResponse} input - ProcessResponse object
     * @param {boolean} asPlain - return as plain object
     * @returns {(ByteArrayContainer|iByteArrayContainer)[]}
     */
    static fromProcessResponse(input: ProcessResponse, asPlain: true): iByteArrayContainer[];
    static fromProcessResponse(input: ProcessResponse, asPlain?: false): ByteArrayContainer[];
    /**
     * Check if the given instance of ByteArrayContainer is valid
     *
     * @param {ByteArrayContainer} instance - instance of ByteArrayContainer to be checked
     * @throws {DocReaderTypeError} - if the given instance of ByteArrayContainer is not valid
     * @returns {true | never} - true if the given instance of ByteArrayContainer is valid
     */
    static validate: (instance: ByteArrayContainer) => true | never;
}

/**
 * Result type of ByteArrayContainer
 * @type {tByteArrayContainerResultType[]}
 */
export declare const ByteArrayContainerResultTypes: tByteArrayContainerResultType[];

/**
 * Certificate data
 */
export declare class CertificateData implements CertificateData_2 {
    /**
     * @type {string}
     */
    Data: string;
    /**
     * @type {number}
     */
    Length: number;
}

export declare class ContainerList implements ContainerList_2 {
    /**
     * Length of list (Count for items)
     * @type {number|undefined}
     */
    Count?: number;
    /**
     * List of containers with results
     * @type {uContainer[]}
     */
    List: uContainer[];
}

/**
 * Converts a generalized date string to a local date string.
 * @param {string} dateStr - Generalized date string
 * @returns {string} Local date string
 */
export declare const convertGeneralizedDateToLocal: (dateStr: string) => string;

/**
 * Decode the packed data
 * @param {string} data - packed data
 * @returns {string} - unpacked data
 */
export declare const decode: (data: string) => string;

/**
 * The summary of all optical checks.
 */
export declare class DetailsOptical implements DetailsOptical_2 {
    /**
     * The summary of all optical checks.
     * @type {eCheckResult}
     */
    overallStatus: eCheckResult;
    /**
     * The check status if document type was recognized or not.
     * @type {eCheckResult}
     */
    docType: eCheckResult;
    /**
     * The document validity period verification status.
     * @type {eCheckResult}
     */
    expiry: eCheckResult;
    /**
     * The input images quality verification status.
     * @type {eCheckResult}
     */
    imageQA: eCheckResult;
    /**
     * MRZ verification: values validity, dates, checkdigits verification.
     * @type {eCheckResult}
     */
    mrz: eCheckResult;
    /**
     * The number of scanned document pages, integer.
     * @type {number}
     */
    pagesCount: number;
    /**
     * The authenticity verification status.
     * @type {eCheckResult}
     */
    security: eCheckResult;
    /**
     * Text fields valitity: values validity for specific fields, cross-comparison of values from different sources,
     * dates & checkdigits verification.
     * @type {eCheckResult}
     */
    text: eCheckResult;
    /**
     * @type {number|undefined}
     */
    vds?: number;
}

/**
 * The summary of all RFID checks.
 */
export declare class DetailsRFID implements DetailsRFID_2 {
    /**
     * The summary of all RFID checks.
     * @type {eCheckResult}
     */
    overallStatus: eCheckResult;
    /**
     * The Active Authentication status.
     * @see {@link https://docs.regulaforensics.com/develop/doc-reader-sdk/overview/security-mechanisms-for-electronic-documents/#active-authentication}
     * @type {eCheckResult}
     */
    AA: eCheckResult;
    /**
     * The Basic Access Control status
     * @type {eCheckResult}
     */
    BAC: eCheckResult;
    /**
     * The Chip Authentication status.
     * @see {@link https://docs.regulaforensics.com/develop/doc-reader-sdk/overview/security-mechanisms-for-electronic-documents/#chip-authentication}
     * @type {eCheckResult}
     */
    CA: eCheckResult;
    /**
     * The Passive Authentication status.
     * @see {@link https://docs.regulaforensics.com/develop/doc-reader-sdk/overview/security-mechanisms-for-electronic-documents/#passive-authentication}
     * @type {eCheckResult}
     */
    PA: eCheckResult;
    /**
     * The Password Authenticated Connection Establishment status.
     * @see {@link https://docs.reg