@regulaforensics/vp-frontend-document-components 8.3.2457-nightly → 8.4.1-nightly

package/dist/index.d.ts

@@ -6,6 +6,11 @@ import { ProcessResponse } from '@regulaforensics/document-reader-webclient';
 import { ProcessResult } from '@regulaforensics/document-reader-webclient';
 import { TransactionInfo } from '@regulaforensics/document-reader-webclient';
 
+declare enum AnimationType {
+    Flip = "flip",
+    Tilt = "tilt"
+}
+
 export declare interface BaseRequest {
     tag?: string;
     tenant?: string;
@@ -71,6 +76,11 @@ export declare enum CaptureMode {
 
 export declare type CaptureType = Array<Omit<CaptureFrameType, 'imageData'>>;
 
+export declare interface CoreProcessResponse extends ProcessResponse {
+    lightType: Array<Light>;
+    liveness?: LivenessData;
+}
+
 export declare interface CurrentPage {
     data: DocumentReaderResponseType | null;
     startNextPage: () => Promise<void>;
@@ -92,6 +102,8 @@ export declare interface DetailEvent<A, R> {
     data: CustomEventDataType<R> | null;
 }
 
+export declare type DocumentAnimation = FlipAnimation | TiltAnimation;
+
 export declare type DocumentDictionaries = Partial<Record<Locales, DocumentTranslations>>;
 
 declare enum DocumentImageType {
@@ -191,7 +203,7 @@ export declare class DocumentReaderProcessor {
     shutdown(): void;
 }
 
-export declare type DocumentReaderProcessParam = Pick<ProcessParams, 'generateNumericCodes' | 'returnUncroppedImage' | 'log' | 'resultTypeOutput' | 'customParams' | 'imageOutputMaxHeight' | 'imageOutputMaxWidth' | 'fieldTypesFilter' | 'dateFormat' | 'measureSystem' | 'imageDpiOutMax' | 'alreadyCropped' | 'fastDocDetect' | 'updateOCRValidityByGlare' | 'returnCroppedBarcode' | 'forceDocFormat' | 'noGraphics' | 'depersonalizeLog' | 'multiDocOnImage' | 'shiftExpiryDate' | 'minimalHolderAge' | 'mrzFormatsFilter' | 'forceReadMrzBeforeLocate' | 'parseBarcodes' | 'splitNames' | 'doublePageSpread' | 'strictImageQuality' | 'doDetectCan' | 'generateDoublePageSpreadImage' | 'mrzDetectMode' | 'strictBarcodeDigitalSignatureCheck' | 'selectLongestNames' | 'disableAuthResolutionFilter' | 'strictSecurityChecks'> & {
+export declare type DocumentReaderProcessParam = Pick<ProcessParams, 'generateNumericCodes' | 'returnUncroppedImage' | 'log' | 'resultTypeOutput' | 'customParams' | 'imageOutputMaxHeight' | 'imageOutputMaxWidth' | 'fieldTypesFilter' | 'dateFormat' | 'measureSystem' | 'imageDpiOutMax' | 'alreadyCropped' | 'fastDocDetect' | 'updateOCRValidityByGlare' | 'returnCroppedBarcode' | 'forceDocFormat' | 'noGraphics' | 'depersonalizeLog' | 'multiDocOnImage' | 'shiftExpiryDate' | 'minimalHolderAge' | 'mrzFormatsFilter' | 'forceReadMrzBeforeLocate' | 'parseBarcodes' | 'splitNames' | 'doublePageSpread' | 'strictImageQuality' | 'doDetectCan' | 'generateDoublePageSpreadImage' | 'mrzDetectMode' | 'strictBarcodeDigitalSignatureCheck' | 'selectLongestNames' | 'disableAuthResolutionFilter' | 'strictSecurityChecks' | 'fieldTypesIgnoreFilter'> & {
     generateAlpha2Codes?: boolean;
     returnPackageForReprocess?: boolean;
     scenario?: InternalScenarios;
@@ -298,6 +310,8 @@ export declare interface DocumentReaderSettings extends CameraSnapshotSettings {
     maxImageSize?: number;
     maxResolutionSize?: number;
     newLayout?: boolean;
+    processingDelay?: number;
+    manualMultipageMode?: boolean;
 }
 
 export declare class DocumentReaderWebComponent extends HTMLElement {
@@ -364,6 +378,11 @@ export declare enum EventActions {
     REMOTE_PROCESS_FINISHED = "REMOTE_PROCESS_FINISHED"
 }
 
+export declare type FlipAnimation = {
+    type: AnimationType.Flip;
+    image: Array<DocumentImageType>;
+};
+
 export declare enum FrameLineCap {
     butt = "butt",
     round = "round",
@@ -387,19 +406,6 @@ export declare class FullScreenContainer extends HTMLElement {
     constructor();
 }
 
-declare enum HoloAnimationType {
-    Unknown = 0,
-    Horizontal = 1,
-    Vertical = 2,
-    LeftBottomRightTop = 4,
-    RightBottomLeftTop = 8
-}
-
-export declare interface HoloData {
-    hologramTiltType: HoloAnimationType;
-    livenessAnimationImage: DocumentImageType;
-}
-
 export declare interface ICameraSnapshot {
     locale?: Locales;
     copyright?: boolean;
@@ -461,6 +467,15 @@ export declare type License = {
     scenario: Array<TScenarioParams>;
 };
 
+export declare interface LivenessData {
+    docAngleCurrent?: number;
+    docAngleMax?: number;
+    docAngleMin?: number;
+    livenessAnimationImage?: DocumentImageType;
+    hologramTiltType?: TiltAnimationType;
+    lightType: Array<Light>;
+}
+
 export declare type Locales = Languages | string;
 
 export declare const Logger: Logger_2;
@@ -498,8 +513,6 @@ export declare interface PackageParams {
     metadata?: Record<string, any>;
 }
 
-export declare type ProcessHoloResponse = HoloData & ProcessResponseWithLight;
-
 export declare interface ProcessingRequest extends BaseRequest {
     metadata?: Record<string, any>;
     delegateProcessing?: {
@@ -520,10 +533,6 @@ export declare interface ProcessRejectResponse extends ProcessResponse {
     reject_reason: number;
 }
 
-export declare interface ProcessResponseWithLight extends ProcessResponse {
-    lightType: Array<Light>;
-}
-
 declare type RecognizeListener = (data: DocumentReaderResponseType) => void;
 
 export declare type Resolution = Partial<WidthAndHeight>;
@@ -543,6 +552,20 @@ export declare interface StreamParams {
     resolution: Resolution;
 }
 
+export declare type TiltAnimation = {
+    type: AnimationType.Tilt;
+    image: Array<DocumentImageType | undefined>;
+    tiltType: TiltAnimationType;
+};
+
+declare enum TiltAnimationType {
+    Unknown = 0,
+    Horizontal = 1,
+    Vertical = 2,
+    LeftBottomRightTop = 4,
+    RightBottomLeftTop = 8
+}
+
 declare type TInitializeListener = ({ isInitialized }: {
     isInitialized: boolean;
 }) => void;