@getyoti/react-face-capture 1.3.1-test.1 → 2.0.0-beta.1

package/index.d.ts

@@ -15,6 +15,9 @@ declare module '@getyoti/react-face-capture' {
     INTERNAL_ERROR = 'INTERNAL_ERROR',
     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',
   }
 
   /**
@@ -50,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.
    */
@@ -81,49 +74,87 @@ declare module '@getyoti/react-face-capture' {
    */
   export enum LANGUAGE_CODE {
     AR = 'ar',
+    AR_XN = 'ar-XN',
+    BG = 'bg',
     BG_BG = 'bg-BG',
     CS = 'cs',
+    CS_CZ = 'cs-CZ',
     DA = 'da',
+    DA_DK = 'da-DK',
     DE = 'de',
+    DE_DE = 'de-DE',
     EL = 'el',
+    EL_GR = 'el-GR',
     EN = 'en',
+    EN_GB = 'en-GB',
     ES = 'es',
+    ES_ES = 'es-ES',
     ES_419 = 'es-419',
     ET = 'et',
+    ET_EE = 'et-EE',
+    FA = 'fa',
     FA_IR = 'fa-IR',
     FI = 'fi',
+    FI_FI = 'fi-FI',
     FR = 'fr',
+    FR_FR = 'fr-FR',
     HE = 'he',
+    HE_IL = 'he-IL',
     HI = 'hi',
+    HI_IN = 'hi-IN',
+    HU = 'hu',
+    HU_HU = 'hu-HU',
     HY = 'hy',
+    HY_AM = 'hy-AM',
     ID = 'id',
+    ID_ID = 'id-ID',
     IT = 'it',
+    IT_IT = 'it-IT',
     JA = 'ja',
+    JA_JP = 'ja-JP',
     KO = 'ko',
+    KO_KR = 'ko-KR',
     LT = 'lt',
+    LT_LT = 'lt-LT',
     LV = 'lv',
+    LV_LV = 'lv-LV',
     MS = 'ms',
+    MS_MY = 'ms-MY',
     NB = 'nb',
+    NB_NO = 'nb-NO',
     NL = 'nl',
+    NL_NL = 'nl-NL',
     PL = 'pl',
-    /**
-     * @deprecated Use {@link LANGUAGE_CODE.PT_BR} or {@link LANGUAGE_CODE.PT_PT} instead.
-     */
+    PL_PL = 'pl-PL',
     PT = 'pt',
     PT_BR = 'pt-BR',
     PT_PT = 'pt-PT',
     RO = 'ro',
+    RO_RO = 'ro-RO',
     RU = 'ru',
+    RU_RU = 'ru-RU',
+    SK = 'sk',
+    SK_SK = 'sk-SK',
     SV = 'sv',
+    SV_SE = 'sv-SE',
     TH = 'th',
+    TH_TH = 'th-TH',
+    TL = 'tl',
+    TL_PH = 'tl-PH',
     TR = 'tr',
+    TR_TR = 'tr-TR',
     UK = 'uk',
+    UK_UA = 'uk-UA',
     UR = 'ur',
+    UR_PK = 'ur-PK',
     VI = 'vi',
+    VI_VN = 'vi-VN',
+    ZH = 'zh',
+    ZH_CN = 'zh-CN',
   }
 
   /**
-   *  Secure information the Face Capture will provide as result when it takes a picture (onSuccess callback). Only when the secure prop is set to true.
+   *  Secure information the Face Capture will provide as a result when it takes a picture (onSuccess callback). Only when the secure prop is set to true.
    */
   export interface Secure {
     version: string;
@@ -133,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;
   }
@@ -144,14 +176,14 @@ declare module '@getyoti/react-face-capture' {
    * Face Capture properties.
    */
   export interface FaceCaptureProps {
-    /** Root url where assets for the face detection are located. */
+    /** Root URL where assets for the face detection are located. */
     faceCaptureAssetsRootUrl?: string;
     /** Capture method to take the photo: by clicking a button or auto-capture. (default:auto) */
     captureMethod?: CAPTURE_METHOD;
     /** 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. */
@@ -162,12 +194,6 @@ declare module '@getyoti/react-face-capture' {
     resolutionType?: RESOLUTION_TYPE;
     /** Image format type. (default:jpeg) */
     format?: FORMAT_TYPE;
-    /** Custom UI of the manual capture button. It uses onClick and disabled as props */
-    CustomManualButton?: (props: any) => JSX.Element;
-    /** 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;
@@ -177,10 +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;
+    /** 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;
   }
 
   /**