@regulaforensics/vp-frontend-face-components 2.0.1 → 3.0.0

package/lib/contexts/FaceAttributesContext.d.ts

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

package/lib/hoc/withDocumentAttributesContext.d.ts

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

package/lib/hoc/withDocumentSDKContext.d.ts

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

package/lib/hoc/withFaceAttributesContext.d.ts

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

package/lib/hoc/withLocalize.d.ts

@@ -1,8 +0,0 @@
-import { DocumentDictionaries, Locales } from '../types';
-import { ComponentType } from 'react';
-interface LocalizedProps {
-    locale?: Locales;
-    translations?: DocumentDictionaries;
-}
-declare function withLocalize<T>(Component: ComponentType<T>): ComponentType<T & LocalizedProps>;
-export default withLocalize;

package/lib/hooks/useDocumentReaderSeries.d.ts

@@ -1,19 +0,0 @@
-import { Response } from '../models/DocReaderWebclient/ext';
-import { DocumentCaptureStatus, InternalScenarios, StreamStatus } from '../constants';
-import { ImageInputParamType, VideoParamsType } from '../types';
-declare type ResponseType = {
-    status: DocumentCaptureStatus;
-    initialized: boolean;
-    error: unknown;
-    response: Response | null;
-};
-interface IUseDocumentReaderSeries extends ResponseType {
-    frameParams: ImageInputParamType;
-}
-declare type TUseDocumentReaderSeriesOptions = {
-    scenario?: InternalScenarios;
-    multipageProcessing?: boolean;
-    license?: string;
-};
-declare function useDocumentReaderSeries(videoElementParams: VideoParamsType, videoStatus: StreamStatus, options: TUseDocumentReaderSeriesOptions): IUseDocumentReaderSeries;
-export default useDocumentReaderSeries;

package/lib/hooks/useDocumentReaderSingle.d.ts

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

package/lib/hooks/useFaceLiveness.d.ts

@@ -1,41 +0,0 @@
-import { FaceMessage, FaceProcessingStage, FaceStatus, FaceEventActions, StreamStatus } from '../constants';
-import { CameraTypes, FaceDebugOutput, FacePositionLivenessDetection, Oval, VideoParamsType } from '../types';
-import CustomError from '../models/CustomError';
-declare type ResponseType = {
-    message: FaceMessage;
-    processingStage: FaceProcessingStage;
-    status: FaceStatus;
-    request: Uint8Array | null;
-    requestSize: number | null;
-    initialized: boolean;
-    debugOutput: FaceDebugOutput | null;
-    prepared: boolean;
-    images: Array<string>;
-    ovals: Array<Oval>;
-    step: number;
-    currSector: number;
-    numSectors: number;
-    targetSector: number | undefined;
-    readiness: number;
-    publicKey: string | null;
-    error: CustomError | null;
-    facePosition: FacePositionLivenessDetection;
-};
-declare function useFaceLiveness(options: {
-    videoStatus: StreamStatus;
-    videoElementParams: VideoParamsType;
-    cameraInfo: CameraTypes;
-    setSessionId?: (id: string) => void;
-    setTransactionId?: (id: string) => void;
-    sessionId?: string;
-    url?: string;
-    debug?: boolean;
-    faceSnapshot?: boolean;
-    backendUrl?: string;
-    abortProcess?: boolean;
-    videoRecording?: boolean;
-}, onAction: ({ manual, action }: {
-    manual: boolean;
-    action: FaceEventActions;
-}) => void): ResponseType;
-export default useFaceLiveness;

package/lib/hooks/useImageInputParam.d.ts

@@ -1,7 +0,0 @@
-import { ImageInputParamType, WidthAndHeight } from '../types';
-declare type UseImageInputParamPropsType = {
-    videoSize: WidthAndHeight;
-    scenario: string;
-};
-declare function useImageInputParam({ videoSize, scenario }: UseImageInputParamPropsType): ImageInputParamType;
-export default useImageInputParam;

package/lib/hooks/useOrientationChange.d.ts

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

package/lib/hooks/useStateCallback.d.ts

@@ -1 +0,0 @@
-export declare function useStateCallback<T>(initialState: T): [T, (state: T, cb?: (state: T) => void) => void];

package/lib/hooks/useStream.d.ts

@@ -1,10 +0,0 @@
-import { CameraFacingMode } from '../constants';
-import { StreamDataType } from '../types';
-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

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

package/lib/hooks/useWindowBlur.d.ts

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