@getyoti/react-face-capture 1.4.0 → 2.0.0

package/index.d.ts

@@ -16,6 +16,8 @@ declare module '@getyoti/react-face-capture' {
     VIDEO_STREAM_INTERRUPTED = 'VIDEO_STREAM_INTERRUPTED',
     SECURE_SESSION_EXPIRED = 'SECURE_SESSION_EXPIRED',
     EXCEEDED_TIME_TO_LOAD = 'EXCEEDED_TIME_TO_LOAD',
+    VERSION_NO_LONGER_AVAILABLE = 'VERSION_NO_LONGER_AVAILABLE',
+    INVALID_SECURE_CLIENT_SDK_ID = 'INVALID_SECURE_CLIENT_SDK_ID',
   }
 
   /**
@@ -51,16 +53,6 @@ declare module '@getyoti/react-face-capture' {
     LOW = 'low',
   }
 
-  /**
-   *  Scenarios in which the countdown will be used.
-   */
-  export enum COUNTDOWN_MODES {
-    ALWAYS = 'always',
-    ONLY_MOBILE = 'only_mobile',
-    ONLY_DESKTOP = 'only_desktop',
-    NEVER = 'never',
-  }
-
   /**
    *  Politeness setting of the live region supported by the Face Capture.
    */
@@ -77,15 +69,6 @@ declare module '@getyoti/react-face-capture' {
     FULL_HD = 'full_hd',
   }
 
-  /**
-   *  Button sizes supported by the Face Capture.
-   */
-  export enum BUTTON_SIZE {
-    SMALL = 'SMALL',
-    MEDIUM = 'MEDIUM',
-    LARGE = 'LARGE'
-  }
-
   /**
    *  Languages supported by the Face Capture.
    */
@@ -156,6 +139,8 @@ declare module '@getyoti/react-face-capture' {
     SV_SE = 'sv-SE',
     TH = 'th',
     TH_TH = 'th-TH',
+    TL = 'tl',
+    TL_PH = 'tl-PH',
     TR = 'tr',
     TR_TR = 'tr-TR',
     UK = 'uk',
@@ -164,6 +149,8 @@ declare module '@getyoti/react-face-capture' {
     UR_PK = 'ur-PK',
     VI = 'vi',
     VI_VN = 'vi-VN',
+    ZH = 'zh',
+    ZH_CN = 'zh-CN',
   }
 
   /**
@@ -177,9 +164,10 @@ declare module '@getyoti/react-face-capture' {
   }
 
   /**
-   *  Result entity the FCM will return on the onSuccess callback.
+   *  Result entity the FCM will return on the onSuccess callback. It is the
+   *  content that needs to be sent to the Yoti AI services.
    */
-  export interface FCMResult {
+  export interface FCMPayload {
     img: string;
     secure?: Secure;
   }
@@ -195,7 +183,7 @@ declare module '@getyoti/react-face-capture' {
     /** If true, the face capture module will use the secure mode. (default:false) */
     secure?: boolean;
     /** Callback called once the result (capture) is complete. */
-    onSuccess: (e: FCMResult) => void;
+    onSuccess: (payload: FCMPayload, base64PreviewImage?: string) => void;
     /** Callback called when there is an error. */
     onError?: (e: ERROR_CODE) => void;
     /** Callback called when the face capture module is ready to take images. */
@@ -206,12 +194,6 @@ declare module '@getyoti/react-face-capture' {
     resolutionType?: RESOLUTION_TYPE;
     /** Image format type. (default:jpeg) */
     format?: FORMAT_TYPE;
-    /** @deprecated It will be removed in 2.0.0 version. Custom UI of the manual capture button. It uses onClick and disabled as props */
-    CustomManualButton?: (props: any) => JSX.Element;
-    /** @deprecated It will be removed in 2.0.0 version. Custom UI of the consent button. It uses onClick and disabled as props */
-    CustomConsentButton?: (props: any) => JSX.Element;
-    /** Indicates when the countdown will be used. Note: It's only used if captureMethod is set to manual. (default:never) */
-    countdownMode?: COUNTDOWN_MODES;
     /** imageType select if the image will be the original or it will be cropped in order to improve the timing 
     response when processing the image in the API call. (default:original) */
     imageType?: IMAGE_TYPE;
@@ -221,14 +203,25 @@ declare module '@getyoti/react-face-capture' {
     language?: LANGUAGE_CODE;
     /** Determines the politeness setting of the live region used to read out prompts for screen reader users. (default:polite) */
     a11yLiveRegionMode?: A11Y_LIVE_REGION_MODE;
-    /** isConsentRequired Adds a step to click a button to ensure the user gives consent to the tool to start the face capture process. (default:false) */
-    isConsentRequired?: boolean;
+    /** showInitialGuidance determines if the initial help guidance will show or not the help section */
+    showInitialGuidance?: boolean;
     /** Indicates if the face capture will use the manual capture method because of slow performance. (default:true) */
     manualCaptureFallback?: boolean;
     /** Indicates the time (in milliseconds) to call the onError callback if the module takes that time to load */
     loadTimeout?: number;
-    /** Indicates the size for buttons (default:medium) */
-    buttonSize?: BUTTON_SIZE;
+    /** Identifies your Yoti Hub application. */
+    clientSdkId?: string;
+    /** If the Get Help button is shown or not. */
+    showGetHelpButton?: boolean;
+    /** Automatically renews sessions after they expire. */
+    autoSessionReload?: boolean;
+    /** Gives the possibility to users to retry several times when an error occurs. */
+    userRetryError?: boolean;
+    /** If the `onSuccess` method will return the base64 image. */
+    returnPreviewImage?: boolean;
+    /** If the face capture will encrypt the image inside the payload argument
+     * on the `onSuccess` callback when it runs the secure mode. */
+    encryptImage?: boolean;
   }
 
   /**