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

package/dist/main.js.LICENSE.txt

@@ -1,21 +1,8 @@
-/*
-object-assign
-(c) Sindre Sorhus
-@license MIT
-*/
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
 
 /**
-@license @nocompile
-Copyright (c) 2018 The Polymer Project Authors. All rights reserved.
-This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
-The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
-The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
-Code distributed by Google as part of the polymer project is also
-subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
-*/
-
-/** @license React v0.20.2
- * scheduler.production.min.js
+ * @license React
+ * react-dom.production.min.js
  *
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -23,8 +10,9 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
  * LICENSE file in the root directory of this source tree.
  */
 
-/** @license React v17.0.2
- * react-dom.production.min.js
+/**
+ * @license React
+ * react.production.min.js
  *
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -32,11 +20,22 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
  * LICENSE file in the root directory of this source tree.
  */
 
-/** @license React v17.0.2
- * react.production.min.js
+/**
+ * @license React
+ * scheduler.production.min.js
  *
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+
+/**
+@license @nocompile
+Copyright (c) 2018 The Polymer Project Authors. All rights reserved.
+This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
+The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
+The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
+Code distributed by Google as part of the polymer project is also
+subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
+*/

package/lib/common/Icon.d.ts

@@ -1,6 +1,63 @@
 /// <reference types="react" />
+import FullscreenIcon from './FullscreenIcon';
+import FullscreenExitIcon from './FullscreenExitIcon';
+import CheckIcon from './CheckIcon';
+import ErrorIcon from './ErrorIcon';
+import CrossIcon from './CrossIcon';
+import RegulaLogo from './RegulaLogo';
+import BackCameraIcon from './BackCameraIcon';
+import FrontCameraIcon from './FrontCameraIcon';
+import CameraIcon from './CameraIcon';
+import VerifiedIcon from './VerifiedIcon';
+import FromCameraIcon from './FromCameraIcon';
+import FromGalleryIcon from './FromGalleryIcon';
+import DocReaderSearch from './DocReaderSearch';
+import DocReaderProcessingFinished from './DocReaderProcessingFinished';
+import DocReaderProcessingError from './DocReaderProcessingError';
+import DocReaderProcessing from './DocReaderProcessing';
+import DocReaderFlip from './DocReaderFlip';
+import DocReaderCameraDisabled from './DocReaderCameraDisabled';
+import DocReaderCameraPreparing from './DocReaderCameraPreparing';
+import SnapshotIcon from './SnapshotIcon';
+import SquareIcon from './SquareIcon';
+import StopIcon from './StopIcon';
+import NoSmilingIconLivenessDetection from './NoSmilingIconLivenessDetection';
+import NoGlareIconLivenessDetection from './NoGlareIconLivenessDetection';
+import CameraChangeIcon from './CameraChangeIcon';
+import RegulaLogoLivenessDetection from './RegulaLogoLivenessDetection';
+import PortraitOrientationOnlyIcon from './PortraitOrientationOnlyIcon';
+declare const icons: {
+    fullscreen: typeof FullscreenIcon;
+    verified: typeof VerifiedIcon;
+    check: typeof CheckIcon;
+    error: typeof ErrorIcon;
+    cross: typeof CrossIcon;
+    snapshot: typeof SnapshotIcon;
+    square: typeof SquareIcon;
+    stop: typeof StopIcon;
+    'regula-logo': typeof RegulaLogo;
+    'regula-logo-liveness-detection': typeof RegulaLogoLivenessDetection;
+    'back-camera': typeof BackCameraIcon;
+    'front-camera': typeof FrontCameraIcon;
+    'camera-logo': typeof CameraIcon;
+    'fullscreen-exit': typeof FullscreenExitIcon;
+    'no-smiling-liveness-detection': typeof NoSmilingIconLivenessDetection;
+    'no-glare-liveness-detection': typeof NoGlareIconLivenessDetection;
+    'from-camera': typeof FromCameraIcon;
+    'from-gallery': typeof FromGalleryIcon;
+    'docreader-search': typeof DocReaderSearch;
+    'docreader-processing-finished': typeof DocReaderProcessingFinished;
+    'docreader-processing-error': typeof DocReaderProcessingError;
+    'docreader-processing': typeof DocReaderProcessing;
+    'docreader-flip': typeof DocReaderFlip;
+    'docreader-camera-disabled': typeof DocReaderCameraDisabled;
+    'docreader-camera-preparing': typeof DocReaderCameraPreparing;
+    'camera-change': typeof CameraChangeIcon;
+    'portrait-orientation-only': typeof PortraitOrientationOnlyIcon;
+};
+export declare type TIcons = keyof typeof icons;
 declare function Icon({ type, size, color }: {
-    type: string;
+    type: TIcons;
     size?: number;
     color?: string;
 }): JSX.Element;

package/lib/common/Message.d.ts

@@ -1,7 +1,8 @@
 import * as React from 'react';
 declare type MessageProps = {
-    children: React.ReactChildren | string;
+    children: string;
+    isLivenessDetection?: boolean;
 };
-declare function Message({ children }: MessageProps): JSX.Element;
+declare function Message({ children, isLivenessDetection }: MessageProps): JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof Message>;
 export default _default;

package/lib/common/NoGlareIconLivenessDetection.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+declare function NoGlareIconLivenessDetection({ size }: {
+    size?: number;
+}): JSX.Element;
+export default NoGlareIconLivenessDetection;

package/lib/common/NoSmilingIconLivenessDetection.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+declare function NoSmilingIconLivenessDetection({ size }: {
+    size?: number;
+}): JSX.Element;
+export default NoSmilingIconLivenessDetection;

package/lib/common/PortraitOrientationOnlyIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+declare function PortraitOrientationOnlyIcon({ size, color }: {
+    size?: number;
+    color?: string;
+}): JSX.Element;
+export default PortraitOrientationOnlyIcon;

package/lib/common/RegulaLogoLivenessDetection.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+declare function RegulaLogoLivenessDetection({ color }: {
+    color?: string;
+}): JSX.Element;
+export default RegulaLogoLivenessDetection;

package/lib/components/ButtonFaceLiveness.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+declare type ButtonLivenessDetectionProps = {
+    children: React.ReactNode | string;
+    onClick: () => void;
+};
+declare function ButtonFaceLiveness({ children, onClick, ...rest }: ButtonLivenessDetectionProps): JSX.Element;
+export default ButtonFaceLiveness;

package/lib/components/CameraCapture.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { DocumentCompletionStatus } from '../constants';
+import { CaptureType } from '../types';
+declare type CameraCaptureProps = {
+    onStatusChange: (completionStatus: DocumentCompletionStatus) => void;
+    onCapture: (capture: CaptureType) => void;
+};
+declare function CameraCapture({ onStatusChange, onCapture }: CameraCaptureProps): JSX.Element;
+export default CameraCapture;

package/lib/components/CameraSnapshot.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/lib/components/CameraSnapshotFileCapture.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { DocumentCompletionStatus } from '../constants';
+import { CaptureType } from '../types';
+declare type DocumentReaderFileCaptureProps = {
+    onStatusChange: (completionStatus: DocumentCompletionStatus) => void;
+    onCapture: (capture: CaptureType) => void;
+    images: FileList | null;
+};
+declare function CameraSnapshotFileCapture({ onStatusChange, onCapture, images }: DocumentReaderFileCaptureProps): JSX.Element;
+export default CameraSnapshotFileCapture;

package/lib/components/DocumentCapture.d.ts

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import { DocumentCompletionStatus } from '../constants';
+import { Response as DocumentReaderResponseType } from '../models/DocReaderWebclient/ext';
+declare type DocumentCaptureProps = {
+    onResponse: (res: DocumentReaderResponseType) => void;
+    onStatusChange: (statusData: DocumentCompletionStatus) => void;
+    onFileImageSet: (images: Array<ImageData> | null) => void;
+};
+declare function DocumentCapture({ onResponse, onStatusChange, onFileImageSet }: DocumentCaptureProps): JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof DocumentCapture>;
+export default _default;

package/lib/components/DocumentContainer.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { DirectionType, DocumentCompletionStatus } from '../constants';
+declare type DocumentFullScreenOverlayProps = {
+    onClose: () => void;
+    children: JSX.Element;
+    completionStatus?: DocumentCompletionStatus;
+    copyright?: boolean;
+    direction: DirectionType;
+};
+declare function DocumentContainer({ onClose, children, completionStatus, copyright, direction, }: DocumentFullScreenOverlayProps): JSX.Element;
+export default DocumentContainer;

package/lib/components/DocumentReader.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/lib/components/DocumentReaderFileCapture.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { DocumentCompletionStatus, InternalScenarios } from '../constants';
+import { Response as DocumentReaderResponseType } from '../models/DocReaderWebclient/ext';
+declare type DocumentReaderFileCaptureProps = {
+    onStatusChange: (completionStatus: DocumentCompletionStatus) => void;
+    onResponse: (response: DocumentReaderResponseType) => void;
+    images: FileList | Array<ImageData> | null;
+    scenario?: InternalScenarios;
+    license?: string;
+};
+declare function DocumentReaderFileCapture({ onStatusChange, onResponse, images, scenario, license, }: DocumentReaderFileCaptureProps): JSX.Element;
+export default DocumentReaderFileCapture;

package/lib/components/DocumentReaderLayout.d.ts

@@ -0,0 +1,22 @@
+import * as React from 'react';
+import { DocumentCaptureStatus } from '../constants';
+import { ImageInputParamType, VideoParamsType, VideoStatusParamsType } from '../types';
+declare type DocumentReaderLayoutProps = {
+    status: DocumentCaptureStatus;
+    isServiceInitialized: boolean;
+    children: JSX.Element | null;
+    mirroring: boolean;
+    onChangeMirroring: () => void;
+    onChangeCamera: () => void;
+    videoStatusParams: VideoStatusParamsType;
+    videoElementParams: VideoParamsType;
+    onClose: () => void;
+    onSnapshotProcess?: () => void;
+    onCameraSnapshot?: () => void;
+    onSkip?: () => void;
+    frameParams?: ImageInputParamType;
+    showChangeCameraButton?: boolean;
+};
+declare function DocumentReaderLayout({ status, isServiceInitialized, children, mirroring, onChangeMirroring, onChangeCamera, videoStatusParams, videoElementParams, onClose, onSnapshotProcess, onCameraSnapshot, onSkip, frameParams, showChangeCameraButton, }: DocumentReaderLayoutProps): JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof DocumentReaderLayout>;
+export default _default;

package/lib/components/DocumentReaderStartScreen.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+declare type DocumentReaderStartScreenProps = {
+    onStart: () => void;
+    onFileImageSet: (images: FileList | null) => void;
+    title: string;
+    subtitle: string;
+    multiple?: boolean;
+};
+declare function DocumentReaderStartScreen({ onStart, onFileImageSet, title, subtitle, multiple, }: DocumentReaderStartScreenProps): JSX.Element;
+export default DocumentReaderStartScreen;

package/lib/components/ErrorBoundary.d.ts

@@ -1,16 +1,17 @@
 import * as React from 'react';
-import { WebComponentsError } from '../constants';
-import { CustomErrorObjectType, SupportedBrowserVersionsByOsType } from '../types';
+import { ErrorTypes } from '../constants';
+import { SupportedBrowserVersionsByOsType } from '../types';
+import CustomError from '../models/CustomError';
 declare type PropsType = {
     children: React.ReactNode;
-    onError: (error: WebComponentsError) => void;
+    onError: (error: ErrorTypes) => void;
     supportedBrowserVersions?: SupportedBrowserVersionsByOsType;
 };
 declare class ErrorBoundary extends React.Component<PropsType> {
-    onError: (error: WebComponentsError) => void;
+    onError: (error: ErrorTypes) => void;
     supportedBrowserVersions?: SupportedBrowserVersionsByOsType;
     constructor(props: PropsType);
-    componentDidCatch(error: Error | CustomErrorObjectType): void;
+    componentDidCatch(error: Error | CustomError): void;
     componentDidMount(): void;
     render(): React.ReactNode;
 }

package/lib/components/FaceCapture.d.ts

@@ -1,17 +1,25 @@
-/// <reference types="react" />
-import { faceCaptureComplitionStatus as appStatus, streamStatus } from '../constants';
-declare type FaceCaptureProps = {
-    onStatusChange: (complitionStatus: appStatus) => void;
+import * as React from 'react';
+import { FaceAbortSessionStatus, FaceCompletionStatus } from '../constants';
+declare type FaceCapturePropsLivenessDetection = {
+    onStatusChange: (completionStatus: FaceCompletionStatus) => void;
     onImagesCapture: (images: Array<string>) => void;
-    onVideoStatusChange: (streamStatus: streamStatus) => void;
     onReset: () => void;
-    videoStatus: streamStatus;
-    uuid?: string;
-    tryCount?: number;
+    sessionId?: string;
+    setSessionId?: (id: string) => void;
+    setTransactionId?: (id: string) => void;
+    setPublicKey?: (id: string) => void;
     onRequestChange?: (request: Uint8Array | null) => void;
     faceSnapshot?: boolean;
     debug?: boolean;
     showChangeCameraButton?: boolean;
+    backendUrl?: string;
+    userCameraId?: string;
+    setUserCameraId: React.Dispatch<React.SetStateAction<string | undefined>>;
+    onRestart: (forceCapture?: boolean) => void;
+    abortProcess?: boolean;
+    setAbortProcess?: React.Dispatch<React.SetStateAction<boolean>>;
+    setAbortSessionStatus?: React.Dispatch<React.SetStateAction<FaceAbortSessionStatus | null>>;
+    videoRecording?: boolean;
 };
-declare function FaceCapture({ onStatusChange, onImagesCapture, onVideoStatusChange, onReset, videoStatus, tryCount, uuid, onRequestChange, faceSnapshot, debug, showChangeCameraButton, }: FaceCaptureProps): JSX.Element;
+declare function FaceCapture({ onStatusChange, onImagesCapture, onReset, sessionId, setSessionId, onRequestChange, faceSnapshot, debug, showChangeCameraButton, setTransactionId, setPublicKey, backendUrl, userCameraId, setUserCameraId, onRestart, abortProcess, setAbortProcess, setAbortSessionStatus, videoRecording, }: FaceCapturePropsLivenessDetection): JSX.Element;
 export default FaceCapture;

package/lib/components/FaceFullScreenOverlay.d.ts

@@ -1,11 +1,10 @@
 /// <reference types="react" />
-import { DirectionType, faceCaptureComplitionStatus } from '../constants';
+import { DirectionType } from '../constants';
 declare type FaceFullScreenOverlayProps = {
     onClose: () => void;
     children: JSX.Element;
-    completionStatus: faceCaptureComplitionStatus;
     copyright?: boolean;
     direction: DirectionType;
 };
-declare function FaceFullScreenOverlay({ onClose, children, completionStatus, copyright, direction, }: FaceFullScreenOverlayProps): JSX.Element;
+declare function FaceFullScreenOverlay({ onClose, children, copyright, direction }: FaceFullScreenOverlayProps): JSX.Element;
 export default FaceFullScreenOverlay;

package/lib/components/FaceHintAnimaition.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { FacePositionLivenessDetection } from '../types';
+declare type FaceHintAnimaitionProps = {
+    targetSector: number;
+    roundRadiusX?: number;
+    roundRadiusY: number;
+    isFaceAnimation: boolean;
+    setCameraBlur: (toggle: boolean) => void;
+    isSectorMode: boolean;
+    message: number;
+    facePosition: FacePositionLivenessDetection;
+    centerX: number;
+    centerY: number;
+};
+export declare const FaceHintAnimaition: React.FC<FaceHintAnimaitionProps>;
+export {};

package/lib/components/FaceLayout.d.ts

@@ -1,19 +1,23 @@
 import * as React from 'react';
-import { eFL_Message, eFL_MessageStyle, streamStatus } from '../constants';
-import { FrameObject } from '../types';
+import { FaceMessage } from '../constants';
+import { FacePositionLivenessDetection, FrameObject, VideoStatusParamsType } from '../types';
 declare type FaceLayoutProps = {
-    children: Array<JSX.Element | null>;
-    onFrameResize: (frameObj: FrameObject) => void;
-    scale: number;
-    videoStatus: streamStatus;
-    message: eFL_Message;
-    messageStyle: eFL_MessageStyle;
+    children: JSX.Element | null;
+    captureFrame: FrameObject;
+    videoStatusParams: VideoStatusParamsType;
+    message: FaceMessage;
     prepared: boolean;
     onChangeCamera: () => void;
-    isChangeCameraAvailable: boolean;
+    readiness: number;
+    step: number;
+    numSectors: number;
+    currSector: number;
+    targetSector: number | undefined;
     breakpoint?: string;
     showChangeCameraButton?: boolean;
+    facePosition: FacePositionLivenessDetection;
+    faceSnapshot: boolean | undefined;
 };
-declare function FaceLayout({ children, scale, videoStatus, onFrameResize, message, messageStyle, prepared, onChangeCamera, isChangeCameraAvailable, showChangeCameraButton, }: FaceLayoutProps): JSX.Element;
+declare function FaceLayout({ children, captureFrame, videoStatusParams, message, prepared, onChangeCamera, readiness, numSectors, currSector, targetSector, step, showChangeCameraButton, facePosition, faceSnapshot, }: FaceLayoutProps): JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof FaceLayout>;
 export default _default;

package/lib/components/InfoScreen.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="react" />
+import { TIcons } from '../common/Icon';
 declare type InfoScreenProps = {
     title: string;
-    type: string;
+    type: TIcons;
     subtitle?: string;
     onReset?: () => void;
     size?: number;

package/lib/components/InfoScreenFaceLiveness.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { TIcons } from '../common/Icon';
+declare type InfoScreenFaceLivenessProps = {
+    title: string;
+    type: TIcons;
+    subtitle?: string;
+    onReset?: () => void;
+    size?: number;
+    iconColor?: string;
+};
+declare function InfoScreenFaceLiveness({ title, type, subtitle, onReset, size, iconColor, }: InfoScreenFaceLivenessProps): JSX.Element;
+export default InfoScreenFaceLiveness;

package/lib/components/InstructionVideoScreen.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+declare type InstructionVideoScreenProps = {
+    onStart: () => void;
+    title: string;
+    subtitle: string;
+    videoSrc: string;
+};
+declare function InstructionVideoScreen({ onStart, title, subtitle, videoSrc }: InstructionVideoScreenProps): JSX.Element;
+export default InstructionVideoScreen;

package/lib/components/ProcessScreenFaceLiveness.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+declare type ProcessScreenFaceLivenessProps = {
+    title: string;
+};
+declare function ProcessScreenFaceLiveness({ title }: ProcessScreenFaceLivenessProps): JSX.Element;
+export default ProcessScreenFaceLiveness;

package/lib/components/RetryScreenFaceLiveness.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+declare type RetryScreenFaceLivenessProps = {
+    errorCode: number;
+    onReset: () => void;
+};
+declare function RetryScreenFaceLiveness({ errorCode, onReset }: RetryScreenFaceLivenessProps): JSX.Element;
+export default RetryScreenFaceLiveness;

package/lib/components/SectorAnimationSvg.d.ts

@@ -0,0 +1,11 @@
+import * as React from 'react';
+interface SectorAnimationSvgProps {
+    numSectors: number;
+    targetSector: number;
+    currSector: number;
+    centerX: number;
+    centerY: number;
+    sectorRadius: number;
+}
+export declare const SectorAnimationSvg: React.FC<SectorAnimationSvgProps>;
+export {};

package/lib/components/WebCamera.d.ts

@@ -1,20 +1,19 @@
 import * as React from 'react';
-import { cameraFacingMode, webCameraComponentMode, WebComponentsError } from '../constants';
-import { CaptureFrameType, VideoParamsType, VideoStatusParamsType } from '../types';
+import { CameraFacingMode, ErrorTypes } from '../constants';
+import { VideoParamsType, VideoStatusParamsType } from '../types';
 declare type WebCameraVideoProps = {
-    captureMode: webCameraComponentMode;
     onVideoStatusChange: (status: VideoStatusParamsType) => void;
-    onCapture: (document: CaptureFrameType) => void;
     onVideoSizeChange?: (params: VideoParamsType) => void;
-    mode?: cameraFacingMode;
+    mode?: CameraFacingMode;
     resolution?: {
         width: number;
         height: number;
     };
     mirroring?: boolean;
-    onFailStatus?: (reason: WebComponentsError) => void;
+    onFailStatus?: (reason: ErrorTypes) => void;
     cameraId?: string;
+    videoRecording?: boolean;
 };
-declare function WebCamera({ captureMode, onVideoStatusChange, onCapture, onVideoSizeChange, mode, resolution, mirroring, onFailStatus, cameraId, }: WebCameraVideoProps): JSX.Element;
+declare function WebCamera({ onVideoStatusChange, onVideoSizeChange, mode, resolution, mirroring, onFailStatus, cameraId, videoRecording, }: WebCameraVideoProps): JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof WebCamera>;
 export default _default;