@regulaforensics/vp-frontend-document-components 1.2.0 → 2.0.1

package/lib/constants.d.ts

@@ -0,0 +1,568 @@
+export declare enum FaceMessage {
+    Empty = 0,
+    FitFaceIntoOval = 1,
+    LookStraight = 2,
+    MoveCloser = 3,
+    MoveAway = 4,
+    HoldStill = 5,
+    ShowOnlyOneFace = 6
+}
+export declare enum FaceProcessingStage {
+    Far = 0,
+    Near = 1
+}
+export declare enum FaceMessageStyle {
+    Normal = 0,
+    Alarm = 1
+}
+export declare enum FaceStatus {
+    Finished = 0,
+    InProcess = 1,
+    Timeout = 2,
+    Failed = 3
+}
+export declare enum ImageOutputType {
+    UINT = "UINT",
+    BASE64 = "BASE64",
+    UINT_AND_BASE64 = "UINT_AND_BASE64"
+}
+export declare enum FaceEventActions {
+    ELEMENT_VISIBLE = "ELEMENT_VISIBLE",
+    PRESS_START_BUTTON = "PRESS_START_BUTTON",
+    PRESS_RETRY_BUTTON = "PRESS_RETRY_BUTTON",
+    CLOSE = "CLOSE",
+    PROCESS_FINISHED = "PROCESS_FINISHED",
+    SERVICE_INITIALIZED = "SERVICE_INITIALIZED"
+}
+export declare enum DocumentEventActions {
+    ELEMENT_VISIBLE = "ELEMENT_VISIBLE",
+    PRESS_CAMERA_BUTTON = "PRESS_CAMERA_BUTTON",
+    PRESS_FILE_BUTTON = "PRESS_FILE_BUTTON",
+    PRESS_RETRY_BUTTON = "PRESS_RETRY_BUTTON",
+    PRESS_SKIP_BUTTON = "PRESS_SKIP_BUTTON",
+    CLOSE = "CLOSE",
+    PROCESS_FINISHED = "PROCESS_FINISHED",
+    SERVICE_INITIALIZED = "SERVICE_INITIALIZED"
+}
+export declare enum DocumentCaptureStatus {
+    FINDING = "DocumentCaptureStatus.FINDING",
+    PROCESSING = "DocumentCaptureStatus.PROCESSING",
+    SUCCESS = "DocumentCaptureStatus.SUCCESS",
+    FAILED = "DocumentCaptureStatus.FAILED",
+    RESOLUTION = "DocumentCaptureStatus.RESOLUTION",
+    GLARE = "DocumentCaptureStatus.GLARE",
+    FOCUS = "DocumentCaptureStatus.FOCUS",
+    HOLD = "DocumentCaptureStatus.HOLD",
+    START_DETECTION = "DocumentCaptureStatus.START_DETECTION",
+    START_NEXT_PAGE = "DocumentCaptureStatus.START_NEXT_PAGE",
+    SNAPSHOT = "DocumentCaptureStatus.SNAPSHOT",
+    TIMEOUT = "DocumentCaptureStatus.TIMEOUT"
+}
+export declare enum ImageQualityCheckType {
+    IMAGE_GLARES = 0,
+    IMAGE_FOCUS = 1,
+    IMAGE_RESOLUTION = 2,
+    IMAGE_COLORNESS = 3,
+    PERSPECTIVE = 4,
+    BOUNDS = 5,
+    SCREEN_CAPTURE = 6,
+    PORTRAIT = 7,
+    HANDWRITTEN = 8
+}
+export declare enum ResponseCode {
+    EMPTY = -1,
+    ERROR = 0,
+    OK = 1
+}
+export declare enum CheckResult {
+    ERROR = 0,
+    OK = 1,
+    WAS_NOT_DONE = 2
+}
+export declare enum StreamStatus {
+    PREPARING = "StreamStatus.PREPARING",
+    REQUESTING = "StreamStatus.REQUESTING",
+    READY = "StreamStatus.READY",
+    PLAY = "StreamStatus.PLAY",
+    UNKNOWN_ERROR = "StreamStatus.UNKNOWN_ERROR",
+    PERMISSION_DENIED = "StreamStatus.PERMISSION_DENIED",
+    NO_CAMERA = "StreamStatus.NO_CAMERA",
+    INCORRECT_CAMERA_ID = "StreamStatus.INCORRECT_CAMERA_ID"
+}
+export declare enum FaceCompletionStatus {
+    INSTRUCTION = "FaceCompletionStatus.INSTRUCTION",
+    SUCCESS = "FaceCompletionStatus.SUCCESS",
+    FAILED = "FaceCompletionStatus.FAILED",
+    CAPTURING = "FaceCompletionStatus.CAPTURING",
+    PROCESSING_REQUEST = "FaceCompletionStatus.PROCESSING_REQUEST",
+    WASM_DEFAULT_ERROR = "FaceCompletionStatus.WASM_DEFAULT_ERROR",
+    NOT_SUPPORTED_ERROR = "FaceCompletionStatus.NOT_SUPPORTED_ERROR",
+    WASM_LICENSE_ERROR = "FaceCompletionStatus.WASM_LICENSE_ERROR",
+    UNKNOWN_ERROR = "FaceCompletionStatus.UNKNOWN_ERROR",
+    NO_CAMERA_ERROR = "FaceCompletionStatus.NO_CAMERA_ERROR",
+    PERMISSION_DENIED_ERROR = "FaceCompletionStatus.PERMISSION_DENIED_ERROR",
+    INCORRECT_CAMERA_ID_ERROR = "FaceCompletionStatus.INCORRECT_CAMERA_ID_ERROR"
+}
+export declare enum DocumentCompletionStatus {
+    CHOOSE_INPUT_SOURCE = "DocumentCompletionStatus.CHOOSE_INPUT_SOURCE",
+    CAMERA_PROCESSING = "DocumentCompletionStatus.CAMERA_PROCESSING",
+    FILE_PROCESSING = "DocumentCompletionStatus.FILE_PROCESSING",
+    API_PROCESSING = "DocumentCompletionStatus.API_PROCESSING",
+    SUCCESS = "DocumentCompletionStatus.SUCCESS",
+    FAILED = "DocumentCompletionStatus.FAILED",
+    FILE_SIZE_ERROR = "DocumentCompletionStatus.FILE_SIZE_ERROR",
+    WASM_DEFAULT_ERROR = "DocumentCompletionStatus.WASM_DEFAULT_ERROR",
+    NOT_SUPPORTED_ERROR = "DocumentCompletionStatus.NOT_SUPPORTED_ERROR",
+    WASM_LICENSE_ERROR = "DocumentCompletionStatus.WASM_LICENSE_ERROR",
+    INCORRECT_FILE_ERROR = "DocumentCompletionStatus.INCORRECT_FILE_ERROR",
+    UNKNOWN_ERROR = "DocumentCompletionStatus.UNKNOWN_ERROR",
+    TIMEOUT = "DocumentCompletionStatus.TIMEOUT"
+}
+export declare enum CameraFacingMode {
+    user = "user",
+    environment = "environment"
+}
+export declare enum ProcessingStatus {
+    NOT_FINISHED = 0,
+    FINISHED = 1,
+    TIMEOUT = 2
+}
+export declare enum DocumentCommandCode {
+    PROCESS = 12101,
+    PROCESS_IMAGE = 12104,
+    START_NEW_DOCUMENT = 12105,
+    START_NEW_PAGE = 12106
+}
+export declare enum ObjectFit {
+    contain = "contain",
+    cover = "cover"
+}
+export declare enum InternalScenarios {
+    MrzAndLocate = "MrzAndLocate",
+    MrzOrLocate = "MrzOrLocate",
+    Mrz = "Mrz",
+    Locate = "Locate"
+}
+export declare enum ErrorTypes {
+    WASM_ERROR = "WASM_ERROR",
+    WASM_LICENSE = "WASM_LICENSE",
+    FILE_SIZE = "FILE_SIZE",
+    INCORRECT_FILE = "INCORRECT_FILE",
+    UNKNOWN_ERROR = "UNKNOWN_ERROR",
+    NOT_SUPPORTED = "NOT_SUPPORTED",
+    CAMERA_UNKNOWN_ERROR = "CAMERA_UNKNOWN_ERROR",
+    CAMERA_PERMISSION_DENIED = "CAMERA_PERMISSION_DENIED",
+    NO_CAMERA = "NO_CAMERA",
+    INCORRECT_CAMERA_ID = "INCORRECT_CAMERA_ID",
+    CONNECTION_ERROR = "CONNECTION_ERROR",
+    LANDSCAPE_MODE_RESTRICTED = "LANDSCAPE_MODE_RESTRICTED",
+    NOT_PREPARED = "NOT_PREPARED",
+    NOT_INITIALIZED = "NOT_INITIALIZED",
+    IN_PROCESS = "IN_PROCESS",
+    ALREADY_PREPARED = "ALREADY_PREPARED",
+    ALREADY_INITIALIZED = "ALREADY_INITIALIZED"
+}
+export declare enum Method {
+    onRuntimeInitialized = "onRuntimeInitialized",
+    processImage = "processImage",
+    process = "process",
+    startNewPage = "startNewPage",
+    startNewDocument = "startNewDocument",
+    initializeService = "initializeService",
+    close = "close",
+    stderr = "strerr"
+}
+export declare enum MediaElementReadyState {
+    HAVE_NOTHING = 0,
+    HAVE_METADATA = 1,
+    HAVE_CURRENT_DATA = 2,
+    HAVE_FUTURE_DATA = 3,
+    HAVE_ENOUGH_DATA = 4
+}
+export declare enum Target {
+    stdout = "stdout",
+    stderr = "stderr",
+    custom = "custom"
+}
+export declare enum PromiseMethod {
+    resolve = "resolve",
+    reject = "reject"
+}
+export declare enum PromiseName {
+    empty = "empty",
+    prepare = "prepare",
+    initialize = "initialize",
+    process = "process",
+    processImage = "processImage",
+    startNewPage = "startNewPage",
+    startNewDocument = "startNewDocument"
+}
+export declare enum logLevels {
+    OFF = 0,
+    LOG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4
+}
+export declare enum DirectionType {
+    Rtl = "rtl",
+    Ltr = "ltr"
+}
+export declare const FACE_LIVENESS_EVENT = "face-liveness";
+export declare const FACE_CAPTURE_EVENT = "face-capture";
+export declare const DOCUMENT_READER_EVENT = "document-reader";
+export declare const CAMERA_SNAPSHOT_EVENT = "camera-snapshot";
+export declare const PERCENT_FRAME_OFFSET = 10;
+export declare const FLIP_TIMEOUT = 3000;
+export declare const FRAME_STROKE_WIDTH = 3;
+export declare const RESULT_TIMEOUT_MS = 2000;
+export declare const NEW_INDEX = 1;
+export declare const MAX_FILES_SIZE = 25000000;
+export declare const RESIZE_VALUE = 1920;
+export declare const MAX_BROWSER_SUPPORTED_RESOLUTION = 536870912;
+export declare const PERMISSION_DENIED_ERROR_NAME = "NotAllowedError";
+export declare const FACE_BACKEND_URL = "https://faceapi.regulaforensics.com";
+export declare const DEFAULT_COMPONENT_LANGUAGE = "en";
+export declare const RTL_LANGUAGES: string[];
+export declare const DEFAULT_CAMERA_ID = 0;
+export declare const OVAL_TRANSITION_TIME = 200;
+export declare const CameraResolution: {
+    VGA: {
+        width: number;
+        height: number;
+    };
+    HD: {
+        width: number;
+        height: number;
+    };
+    FULL_HD: {
+        width: number;
+        height: number;
+    };
+    SQUARE: {
+        width: number;
+        height: number;
+    };
+};
+export declare const BackCameraKeywords: string[];
+export declare const FaceErrorCodes: {
+    231: {
+        name: string;
+        type: number;
+    };
+    232: {
+        name: string;
+        type: number;
+    };
+    245: {
+        name: string;
+        type: number;
+    };
+    230: {
+        name: string;
+        type: number;
+    };
+    233: {
+        name: string;
+        type: number;
+    };
+    234: {
+        name: string;
+        type: number;
+    };
+    235: {
+        name: string;
+        type: number;
+    };
+    236: {
+        name: string;
+        type: number;
+    };
+    239: {
+        name: string;
+        type: number;
+    };
+    240: {
+        name: string;
+        type: number;
+    };
+    242: {
+        name: string;
+        type: number;
+    };
+    243: {
+        name: string;
+        type: number;
+    };
+    244: {
+        name: string;
+        type: number;
+    };
+};
+export declare const WebComponentErrorByStreamStatus: {
+    "StreamStatus.UNKNOWN_ERROR": ErrorTypes;
+    "StreamStatus.PERMISSION_DENIED": ErrorTypes;
+    "StreamStatus.NO_CAMERA": ErrorTypes;
+    "StreamStatus.INCORRECT_CAMERA_ID": ErrorTypes;
+};
+export declare const DocumentReaderStatusByError: {
+    FILE_SIZE: DocumentCompletionStatus;
+    WASM_ERROR: DocumentCompletionStatus;
+    NOT_SUPPORTED: DocumentCompletionStatus;
+    WASM_LICENSE: DocumentCompletionStatus;
+    INCORRECT_FILE: DocumentCompletionStatus;
+};
+export declare const DocumentReaderStatusByCaptureStatus: {
+    "DocumentCaptureStatus.SUCCESS": DocumentCompletionStatus;
+    "DocumentCaptureStatus.TIMEOUT": DocumentCompletionStatus;
+    "DocumentCaptureStatus.FAILED": DocumentCompletionStatus;
+};
+export declare const FaceLivenessStatusByError: {
+    WASM_ERROR: FaceCompletionStatus;
+    NOT_SUPPORTED: FaceCompletionStatus;
+    WASM_LICENSE: FaceCompletionStatus;
+};
+export declare const DocumentSupportedBrowsers: {
+    iOS: {
+        Chrome: number;
+        Firefox: number;
+        Opera: number;
+        Safari: number;
+        Edge: number;
+        Chromium: number;
+        IE: number;
+        'Internet Explorer': number;
+        'Mobile Safari': number;
+        'Samsung Browser': number;
+    };
+    Android: {
+        Chrome: number;
+        Firefox: number;
+        Opera: number;
+        Safari: number;
+        Edge: number;
+        Chromium: number;
+        IE: number;
+        'Internet Explorer': number;
+        'Mobile Safari': number;
+        'Samsung Browser': number;
+    };
+    desktop: {
+        Chrome: number;
+        Firefox: number;
+        Opera: number;
+        Safari: number;
+        Edge: number;
+        Chromium: number;
+        IE: number;
+        'Internet Explorer': number;
+        'Mobile Safari': number;
+        'Samsung Browser': number;
+    };
+};
+export declare const FaceSupportedBrowsers: {
+    iOS: {
+        Chrome: number;
+        Firefox: number;
+        Opera: number;
+        Safari: number;
+        Edge: number;
+        Chromium: number;
+        IE: number;
+        'Internet Explorer': number;
+        'Mobile Safari': number;
+        'Samsung Browser': number;
+    };
+    Android: {
+        Chrome: number;
+        Firefox: number;
+        Opera: number;
+        Safari: number;
+        Edge: number;
+        Chromium: number;
+        IE: number;
+        'Internet Explorer': number;
+        'Mobile Safari': number;
+        'Samsung Browser': number;
+    };
+    desktop: {
+        Chrome: number;
+        Firefox: number;
+        Opera: number;
+        Safari: number;
+        Edge: number;
+        Chromium: number;
+        IE: number;
+        'Internet Explorer': number;
+        'Mobile Safari': number;
+        'Samsung Browser': number;
+    };
+};
+export declare const DocumentScenarioFrameParams: {
+    scenario: ({
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        barcodeExt?: undefined;
+        faceExt?: undefined;
+        manualCrop?: undefined;
+        UVTorch?: undefined;
+    } | {
+        barcodeExt: number;
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: number;
+        frameKWHDoublePageSpreadPortrait: number;
+        frameKWHLandscape: number;
+        frameKWHPortrait: number;
+        frameOrientation: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        faceExt?: undefined;
+        manualCrop?: undefined;
+        UVTorch?: undefined;
+    } | {
+        caption: string;
+        desc: string;
+        faceExt: number;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        manualCrop: number;
+        name: string;
+        seriesProcessMode: number;
+        multiPageOff?: undefined;
+        barcodeExt?: undefined;
+        UVTorch?: undefined;
+    } | {
+        barcodeExt: number;
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        faceExt?: undefined;
+        manualCrop?: undefined;
+        UVTorch?: undefined;
+    } | {
+        caption: string;
+        desc: string;
+        faceExt: number;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        manualCrop: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        barcodeExt?: undefined;
+        UVTorch?: undefined;
+    } | {
+        barcodeExt: number;
+        caption: string;
+        desc: string;
+        faceExt: number;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        manualCrop: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        UVTorch?: undefined;
+    } | {
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        manualCrop: number;
+        name: string;
+        seriesProcessMode: number;
+        multiPageOff?: undefined;
+        barcodeExt?: undefined;
+        faceExt?: undefined;
+        UVTorch?: undefined;
+    } | {
+        barcodeExt: number;
+        caption: string;
+        desc: string;
+        faceExt: number;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        manualCrop: number;
+        name: string;
+        seriesProcessMode: number;
+        multiPageOff?: undefined;
+        UVTorch?: undefined;
+    } | {
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: string;
+        frameKWHDoublePageSpreadPortrait: string;
+        frameKWHLandscape: string;
+        frameKWHPortrait: string;
+        frameOrientation: number;
+        manualCrop: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        barcodeExt?: undefined;
+        faceExt?: undefined;
+        UVTorch?: undefined;
+    } | {
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: number;
+        frameKWHDoublePageSpreadPortrait: number;
+        frameKWHLandscape: number;
+        frameKWHPortrait: number;
+        frameOrientation: number;
+        multiPageOff: number;
+        name: string;
+        seriesProcessMode: number;
+        barcodeExt?: undefined;
+        faceExt?: undefined;
+        manualCrop?: undefined;
+        UVTorch?: undefined;
+    } | {
+        UVTorch: number;
+        caption: string;
+        desc: string;
+        frameKWHDoublePageSpreadLandscape: number;
+        frameKWHDoublePageSpreadPortrait: number;
+        frameKWHLandscape: number;
+        frameKWHPortrait: number;
+        frameOrientation: number;
+        name: string;
+        multiPageOff?: undefined;
+        seriesProcessMode?: undefined;
+        barcodeExt?: undefined;
+        faceExt?: undefined;
+        manualCrop?: undefined;
+    })[];
+};

package/lib/contexts/DocumentAttributesContext.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { CameraSnapshotResponseType, DocumentReaderResponseType } from '../types';
+import { DocumentEventActions, InternalScenarios, ObjectFit, ErrorTypes } from '../constants';
+declare type DocumentCallbackArgTypes = DocumentReaderResponseType | CameraSnapshotResponseType;
+export declare type DocumentAttributesContextType = {
+    onAction: ({ manual, action }: {
+        manual: boolean;
+        action: DocumentEventActions;
+    }) => void;
+    onResponse: (response: DocumentCallbackArgTypes) => void;
+    onFail: (reason: ErrorTypes) => void;
+    locale?: string;
+    internalScenario?: InternalScenarios;
+    multipageProcessing?: boolean;
+    startScreen?: boolean;
+    multiple?: boolean;
+    license?: string;
+    copyright?: boolean;
+    cameraId?: string;
+    objectFit?: ObjectFit;
+    changeCamera?: boolean;
+};
+export declare const DocumentAttributesContext: React.Context<DocumentAttributesContextType>;
+export {};

package/lib/contexts/DocumentSDKContext.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import DocumentReaderService from '../services/DocumentReaderService';
+export declare type DocumentSDKContextType = {
+    service: DocumentReaderService | null;
+};
+export declare const DocumentSDKContext: React.Context<DocumentSDKContextType>;

package/lib/contexts/FaceAttributesContext.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+import { FaceDetectionResponseType, FaceLivenessResponseType } from '../types';
+import { FaceEventActions, ErrorTypes } from '../constants';
+declare type FaceCallbackArgTypes = FaceLivenessResponseType | FaceDetectionResponseType;
+export declare type FaceAttributesContextType = {
+    onAction: ({ manual, action }: {
+        manual: boolean;
+        action: FaceEventActions;
+    }) => void;
+    onResponse: (response: FaceCallbackArgTypes) => void;
+    onFail: (reason: ErrorTypes) => void;
+    locale?: string;
+    url?: string;
+    debug?: boolean;
+    headers?: Record<string, string>;
+    copyright?: boolean;
+    cameraId?: string;
+    changeCamera?: boolean;
+};
+export declare const FaceAttributesContext: React.Context<FaceAttributesContextType>;
+export {};

package/lib/hoc/withDocumentAttributesContext.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { DocumentAttributesContextType } from '../contexts/DocumentAttributesContext';
+declare function withDocumentAttributesContext<T extends DocumentAttributesContextType>(Component: React.ComponentType<T>): React.ComponentType<T>;
+export default withDocumentAttributesContext;

package/lib/hoc/withDocumentSDKContext.d.ts

@@ -0,0 +1,3 @@
+import * as React from 'react';
+declare function withDocumentSDKContext<T>(Component: React.ComponentType<T>): React.ComponentType<T>;
+export default withDocumentSDKContext;

package/lib/hoc/withFaceAttributesContext.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { FaceAttributesContextType } from '../contexts/FaceAttributesContext';
+declare function withFaceAttributesContext<T extends FaceAttributesContextType>(Component: React.ComponentType<T>): React.ComponentType<T>;
+export default withFaceAttributesContext;

package/lib/hoc/withLocalize.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { DirectionType } from '../constants';
+interface Locale {
+    locale: string | undefined;
+}
+declare function withLocalize<T>(Component: React.ComponentType<T>): React.ComponentType<T & Locale & DirectionType>;
+export default withLocalize;

package/lib/hooks/useDocumentReaderSeries.d.ts

@@ -0,0 +1,25 @@
+import { Response } from '@regulaforensics/document-reader-webclient';
+import { DocumentCaptureStatus, DocumentEventActions, InternalScenarios, ObjectFit, StreamStatus } from '../constants';
+import { FrameParamsType, VideoParamsType } from '../types';
+import CustomError from '../models/CustomError';
+declare type ResponseType = {
+    status: DocumentCaptureStatus;
+    initialized: boolean;
+    error: CustomError | null;
+    response: Response | null;
+};
+interface useDocumentReaderSeriesInterface extends ResponseType {
+    frameParams: FrameParamsType;
+}
+declare function useDocumentReaderSeries(options: {
+    videoStatus: StreamStatus;
+    videoElementParams: VideoParamsType;
+    scenario?: InternalScenarios;
+    multipageProcessing?: boolean;
+    license?: string;
+    objectFit?: ObjectFit;
+}, onAction: ({ manual, action }: {
+    manual: boolean;
+    action: DocumentEventActions;
+}) => void): useDocumentReaderSeriesInterface;
+export default useDocumentReaderSeries;

package/lib/hooks/useDocumentReaderSingle.d.ts

@@ -0,0 +1,15 @@
+import { DocumentCaptureStatus } from '../constants';
+import { Response } from '@regulaforensics/document-reader-webclient';
+import CustomError from '../models/CustomError';
+declare type ResponseType = {
+    status: DocumentCaptureStatus;
+    error: CustomError | null;
+    response: Response | null;
+    initialized: boolean;
+    prepared: boolean;
+};
+declare function useDocumentReaderSingle(imageDataArray: Array<ImageData>, options: {
+    scenario?: string;
+    license?: string;
+}): ResponseType;
+export default useDocumentReaderSingle;