@regulaforensics/vp-frontend-face-components 1.3.0 → 1.4.0

package/lib/constants.d.ts

@@ -0,0 +1,366 @@
+export declare enum eFL_Message {
+    eFL_Message_Empty = 0,
+    eFL_Message_FitFaceIntoOval = 1,
+    eFL_Message_LookStraight = 2,
+    eFL_Message_MoveCloser = 3,
+    eFL_Message_MoveAway = 4,
+    eFL_Message_HoldStill = 5,
+    eFL_Message_ShowOnlyOneFace = 6
+}
+export declare enum eFL_ProcessingStage {
+    eFL_ProcessingStage_Far = 0,
+    eFL_ProcessingStage_Near = 1
+}
+export declare enum eFL_MessageStyle {
+    eFL_MessageStyle_Normal = 0,
+    eFL_MessageStyle_Alarm = 1
+}
+export declare enum eFL_Status {
+    eFL_Status_Finished = 0,
+    eFL_Status_InProcess = 1,
+    eFL_Status_Timeout = 2,
+    eFL_Status_Failed = 3
+}
+export declare enum eFL_Commands {
+    eFL_Command_Init = 0,
+    eFL_Command_StartNewSession = 1,
+    eFL_Command_Process = 2,
+    eFL_Command_Free = 3
+}
+export declare enum webCameraComponentMode {
+    ONLY_UINT = 0,
+    ONLY_RAW = 1,
+    UINT_AND_RAW = 2
+}
+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 faceCaptureStatus {
+    ACCURATE = "faceCaptureStatus.ACCURATE",
+    NOFACE = "faceCaptureStatus.NOFACE",
+    SMALL = "faceCaptureStatus.SMALL",
+    HUGE = "faceCaptureStatus.HUGE",
+    PROCESSING = "faceCaptureStatus.PROCESSING",
+    NOT_CENTERED = "faceCaptureStatus.NOT_CENTERED"
+}
+export declare enum documentReaderCaptureStatus {
+    FINDING = "documentReaderStatus.FINDING",
+    PROCESSING = "documentReaderStatus.PROCESSING",
+    SUCCESS = "documentReaderStatus.SUCCESS",
+    FAILED = "documentReaderStatus.FAILED",
+    RESOLUTION = "documentReaderStatus.RESOLUTION",
+    GLARE = "documentReaderStatus.GLARE",
+    HOLD = "documentReaderStatus.HOLD",
+    START_DETECTION = "documentReaderStatus.START_DETECTION",
+    START_NEXT_PAGE = "documentReaderStatus.START_NEXT_PAGE",
+    SNAPSHOT = "documentReaderStatus.SNAPSHOT",
+    TIMEOUT = "documentReaderStatus.TIMEOUT"
+}
+export declare enum eImageQualityCheckType {
+    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 eCheckResult {
+    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 faceCaptureComplitionStatus {
+    INSTRUCTION = "faceCaptureReducerStatus.INSTRUCTION",
+    SUCCESS = "faceCaptureReducerStatus.SUCCESS",
+    FAILED = "faceCaptureReducerStatus.FAILED",
+    CAPTURING = "faceCaptureReducerStatus.CAPTURING",
+    PROCESSING_REQUEST = "faceCaptureReducerStatus.PROCESSING_REQUEST",
+    WASM_DEFAULT_ERROR = "faceCaptureReducerStatus.WASM_DEFAULT_ERROR",
+    NOT_SUPPORTED_ERROR = "faceCaptureReducerStatus.NOT_SUPPORTED_ERROR",
+    WASM_LICENSE_ERROR = "faceCaptureReducerStatus.WASM_LICENSE_ERROR",
+    UNKNOWN_ERROR = "faceCaptureReducerStatus.UNKNOWN_ERROR"
+}
+export declare enum documentReaderComplitionStatus {
+    CHOOSE_INPUT_SOURCE = "documentReaderReducerStatus.CHOOSE_INPUT_SOURCE",
+    CAMERA_PROCESSING = "documentReaderReducerStatus.CAMERA_PROCESSING",
+    FILE_PROCESSING = "documentReaderReducerStatus.FILE_PROCESSING",
+    API_PROCESSING = "documentReaderReducerStatus.API_PROCESSING",
+    SUCCESS = "documentReaderReducerStatus.SUCCESS",
+    FAILED = "documentReaderReducerStatus.FAILED",
+    FILE_SIZE_ERROR = "documentReaderReducerStatus.FILE_SIZE_ERROR",
+    WASM_DEFAULT_ERROR = "documentReaderReducerStatus.WASM_DEFAULT_ERROR",
+    NOT_SUPPORTED_ERROR = "documentReaderReducerStatus.NOT_SUPPORTED_ERROR",
+    WASM_LICENSE_ERROR = "documentReaderReducerStatus.WASM_LICENSE_ERROR",
+    INCORRECT_FILE_ERROR = "documentReaderReducerStatus.INCORRECT_FILE_ERROR",
+    UNKNOWN_ERROR = "documentReaderReducerStatus.UNKNOWN_ERROR"
+}
+export declare enum cameraFacingMode {
+    USER = "user",
+    ENVIRONMENT = "environment"
+}
+export declare enum ProcessingStatus {
+    NOT_FINISHED = 0,
+    FINISHED = 1,
+    TIMEOUT = 2
+}
+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 MINIMUM_DOCUMENT_AREA_PERCENT = 20;
+export declare const PERCENT_FRAME_OFFSET = 10;
+export declare const HEIGHT_ACCURACY_COEF = 0.45;
+export declare const WIDTH_ACCURACY_COEF = 0.93;
+export declare const FRAME_RATIO = 1.4;
+export declare const FACE_POSITION_ACCURACY = 0.1;
+export declare const SQUARE_RATIO_SMALL_X1 = 0.75;
+export declare const SQUARE_RATIO_HUGE_X1 = 0.9;
+export declare const SQUARE_RATIO_SMALL_X2 = 0.68;
+export declare const SQUARE_RATIO_HUGE_X2 = 0.8;
+export declare const CAPTURE_RATE_MS = 30;
+export declare const SUCCESS_CAPTURE_COUNT = 15;
+export declare const FRAME_SCALE_X1 = 0.8;
+export declare const FRAME_SCALE_X2 = 1.35;
+export declare const RESULT_TIMEOUT_MS = 2000;
+export declare const documentReaderCommandCode: {
+    PROCESS: number;
+    PROCESS_IMAGE: number;
+    START_NEW_DOCUMENT: number;
+    START_NEW_PAGE: number;
+};
+export declare const PERMISSION_DENIED_ERROR_NAME = "NotAllowedError";
+export declare const FACE_BACKEND_URL = "https://faceapi.regulaforensics.com";
+export declare const cameraResolution: {
+    VGA: {
+        width: number;
+        height: number;
+    };
+    HD: {
+        width: number;
+        height: number;
+    };
+    FULL_HD: {
+        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 enum WebComponentsError {
+    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",
+    CONNECTION_ERROR = "CONNECTION_ERROR",
+    LANDSCAPE_MODE_RESTRICTED = "LANDSCAPE_MODE_RESTRICTED"
+}
+export declare const webComponentErrorByStreamStatus: {
+    "streamStatus.UNKNOWN_ERROR": WebComponentsError;
+    "streamStatus.PERMISSION_DENIED": WebComponentsError;
+    "streamStatus.NO_CAMERA": WebComponentsError;
+};
+export declare const documentReaderStatusByError: {
+    FILE_SIZE: documentReaderComplitionStatus;
+    WASM_ERROR: documentReaderComplitionStatus;
+    NOT_SUPPORTED: documentReaderComplitionStatus;
+    WASM_LICENSE: documentReaderComplitionStatus;
+    INCORRECT_FILE: documentReaderComplitionStatus;
+};
+export declare const faceLivenessStatusByError: {
+    WASM_ERROR: faceCaptureComplitionStatus;
+    NOT_SUPPORTED: faceCaptureComplitionStatus;
+    WASM_LICENSE: faceCaptureComplitionStatus;
+};
+export declare enum Method {
+    onRuntimeInitialized = "onRuntimeInitialized",
+    processImage = "processImage",
+    process = "process",
+    startNewPage = "startNewPage",
+    startNewDocument = "startNewDocument",
+    initializeService = "initializeService",
+    close = "close",
+    stderr = "strerr"
+}
+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 enum logLevels {
+    OFF = 0,
+    LOG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4
+}
+export declare type DirectionType = 'rtl' | 'ltr';
+export declare const DEFAULT_CAMERA_ID = 0;
+export declare enum MediaElementReadyState {
+    HAVE_NOTHING = 0,
+    HAVE_METADATA = 1,
+    HAVE_CURRENT_DATA = 2,
+    HAVE_FUTURE_DATA = 3,
+    HAVE_ENOUGH_DATA = 4
+}

package/lib/contexts/FaceAttributesContext.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+import { FaceDetectionResponseType, FaceLivenessResponseType } from '../types';
+import { faceEventActions, WebComponentsError } 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: WebComponentsError) => void;
+    startScale?: number;
+    endScale?: number;
+    ovalOffset?: number;
+    locale?: string;
+    url?: string;
+    debug?: boolean;
+    mode?: number;
+    headers?: Record<string, string>;
+    copyright?: boolean;
+    cameraId?: string;
+};
+export declare const FaceAttributesContext: React.Context<FaceAttributesContextType>;
+export {};

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/useDebounce.d.ts

@@ -0,0 +1,2 @@
+declare function useDebounce<T>(value: T, delay: number): T;
+export default useDebounce;

package/lib/hooks/useFaceLiveness.d.ts

@@ -0,0 +1,33 @@
+import { eFL_Message, eFL_MessageStyle, eFL_ProcessingStage, eFL_Status, faceEventActions } from '../constants';
+import { CustomErrorObjectType, FrameObject, VideoParamsType } from '../types';
+import CameraModel from '../models/CameraModel';
+declare type UseFaceDetectionProps = {
+    videoFrame: Uint8ClampedArray;
+    sourceCaptureFrame: FrameObject;
+    videoElementParams: VideoParamsType;
+    onAction: ({ manual, action }: {
+        manual: boolean;
+        action: faceEventActions;
+    }) => void;
+    cameraInfo: CameraModel;
+    uuid?: string;
+    mode?: number;
+    url?: string;
+    tryCount?: number;
+    debug?: boolean;
+};
+declare type responseType = {
+    message: eFL_Message;
+    messageStyle: eFL_MessageStyle;
+    processingStage: eFL_ProcessingStage;
+    status: eFL_Status;
+    request: Uint8Array | null;
+    requestSize: number | null;
+    initialized: boolean;
+    debugOutput: Record<string, any>;
+    prepared: boolean;
+    images: Array<string>;
+    wasmError: CustomErrorObjectType | null;
+};
+declare function useFaceLiveness({ videoFrame, sourceCaptureFrame, videoElementParams, onAction, cameraInfo, uuid, mode, url, tryCount, debug, }: UseFaceDetectionProps): responseType;
+export default useFaceLiveness;

package/lib/hooks/useInterval.d.ts

@@ -0,0 +1,3 @@
+declare type IntervalFunction = () => unknown | void;
+declare function useInterval(callback: IntervalFunction, delay: number | null): void;
+export default useInterval;

package/lib/hooks/useOrientationChange.d.ts

@@ -0,0 +1,10 @@
+declare enum orientations {
+    portrait = "portrait",
+    landscape = "landscape"
+}
+export default function useMobileOrientation(): {
+    isPortrait: boolean;
+    isLandscape: boolean;
+    orientation: orientations;
+};
+export {};

package/lib/hooks/useStream.d.ts

@@ -0,0 +1,16 @@
+import { cameraFacingMode, streamStatus } from '../constants';
+import CameraModel from '../models/CameraModel';
+interface StreamDataType {
+    status: streamStatus;
+    stream: MediaStream | null;
+    camera: CameraModel;
+    twoFacingModesAvailable: boolean;
+}
+interface UseStreamReturnType extends StreamDataType {
+    onPlay: () => void;
+}
+declare function useStream(mode?: cameraFacingMode, resolution?: {
+    width: number;
+    height: number;
+}, preferredCameraId?: string): UseStreamReturnType;
+export default useStream;

package/lib/hooks/useUserAgent.d.ts

@@ -0,0 +1,3 @@
+import { UserAgentType } from '../types';
+declare function useUserAgent(): UserAgentType | null;
+export default useUserAgent;

package/lib/hooks/useWindowBlur.d.ts

@@ -0,0 +1,2 @@
+declare function useWindowBlur(videoStatus: string, callback?: null | (() => void)): void;
+export default useWindowBlur;