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

package/lib/hooks/useFaceLiveness.d.ts

@@ -0,0 +1,30 @@
+import { FaceMessage, FaceProcessingStage, FaceStatus, FaceEventActions, StreamStatus } from '../constants';
+import { CameraTypes, FaceDebugOutput, 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>;
+    readiness: number;
+    error: CustomError | null;
+};
+declare function useFaceLiveness(options: {
+    videoStatus: StreamStatus;
+    videoElementParams: VideoParamsType;
+    cameraInfo: CameraTypes;
+    uuid?: string;
+    url?: string;
+    tryCount?: number;
+    debug?: boolean;
+}, onAction: ({ manual, action }: {
+    manual: boolean;
+    action: FaceEventActions;
+}) => void): ResponseType;
+export default useFaceLiveness;

package/lib/hooks/useImageInputParam.d.ts

@@ -0,0 +1,9 @@
+import { FrameParamsType, VideoParamsType } from '../types';
+import { ObjectFit } from '../constants';
+declare type UseImageInputParamPropsType = {
+    videoElementParams: VideoParamsType;
+    scenario: string;
+    objectFit: ObjectFit;
+};
+declare function useImageInputParam({ videoElementParams, scenario, objectFit }: UseImageInputParamPropsType): FrameParamsType;
+export default useImageInputParam;

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,10 @@
+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

@@ -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;