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

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # CHANGELOG
 
+## v1.3.0
+
+### New features
+
+- The secure payload has a new field `verification`.
+- Increased the protection against requests from untrusted devices. The
+  malicious and suspicious requests will return a new error code
+  `UNTRUSTED_SECURE_SESSION`.
+- The `manualCaptureFallback` time has been increased to 10 seconds.
+- Implemented localisation languages:
+
+  - `BG-bg`: Bulgarian
+  - `fa-IR`: Persian
+  - `pt-BR`: Portuguese (Brazil)
+    - `pt` and `pt-BR` are both Brazilian. `pt` is now deprecated and it will be
+      removed on future releases.
+  - `pt-PT`: Portuguese (Portugal)
+
+### Fixes
+
+- Secure session initialisation request is not longer cached.
+- Added missing fields in the typing file.
+- Camera feedback messages are shown only after the camera permissions were
+  giving not before.
+
 ## v1.2.0
 
 ### New features

package/README.md

@@ -1,5 +1,7 @@
 # Yoti Face capture integration
 
+> **IMPORTANT**: Testing version. It does not support the `secure` mode.
+
 The purpose of this module is to capture a face and return the output image.
 
 ## CHANGELOG
@@ -22,14 +24,14 @@ The package depends on the following peer dependencies
 
 <browserSupportTable>
 
-| Browser | Versions                 |
-| ------- | ------------------------ |
-| and_chr | 104                      |
-| chrome  | 105,104,103,102          |
-| edge    | 105,104                  |
-| firefox | 104,103,102,101          |
-| ios_saf | 15.6,15.5,15.4           |
-| safari  | 15.6,15.5,15.4,15.2-15.3 |
+| Browser | Versions            |
+| ------- | ------------------- |
+| and_chr | 117                 |
+| chrome  | 118,117,116,115     |
+| edge    | 118,117             |
+| firefox | 118,117,116,115     |
+| ios_saf | 17.0,16.6,16.5      |
+| safari  | 17.0,16.6,16.5,16.4 |
 
 </browserSupportTable>
 
@@ -41,6 +43,8 @@ _Note: Edge is only supported on desktop versions._
 
 Finally, some devices might experience poor performance when attempting to detect a face. This is because the underlying library TensorFlow.js can still be too demanding for older less performant devices.
 
+_Note: `iPhone 7` and older will take a longer time to load the face detector model than more recent devices, and in most cases, will fall back from auto to manual capture mode. If this behaviour is not desired, as an integrator you could disable the manual capture mode altogether, implementing manualCaptureFallback = false. Note, this could increase the load time for old and low-quality devices._
+
 ## React face capture module
 
 ### Install dependency
@@ -98,6 +102,7 @@ new CopyPlugin([
 Current languages supported:
 
 - `en`: English
+- `bg-BG`: Bulgarian
 - `ar`: Arabic
 - `cs`: Czech
 - `da`: Danish
@@ -106,6 +111,7 @@ Current languages supported:
 - `es`: Spanish (Spain)
 - `es-419`: Spanish (Latin America)
 - `et`: Estonian
+- `fa-IR` : Persian
 - `fi`: Finnish
 - `fr`: French
 - `he`: Hebrew
@@ -121,7 +127,9 @@ Current languages supported:
 - `nb`: Norwegian
 - `nl`: Dutch
 - `pl`: Polish
-- `pt`: Portuguese
+- `pt`: Portuguese `[deprecated]`
+- `pt-BR`: Portuguese (Brazil)
+- `pt-PT`: Portuguese (Portugal)
 - `ro`: Romanian
 - `ru`: Russian
 - `sv`: Swedish
@@ -176,7 +184,8 @@ be returned in `onSuccess` callback:
   "secure": {
     "version": "<fcm_version>",
     "token": "<session_token>",
-    "signature": "<result_signature>"
+    "signature": "<result_signature>",
+    "verification": "<verification_data>"
   }
 }
 ```
@@ -191,6 +200,10 @@ on demand so the front-end must be able to handle that requests. Keep in mind if
 your front-end uses any mechanism to prevent data injection attacks or
 cross-site scripting like SCP you will need to allow the FCM requests.
 
+##### Virtual cameras
+
+The secure mode detects modifications on the camera stream source and fraudulent camera hardware. In these scenarios, it will return an `UNTRUSTED_SECURE_SESSION` error code when calling the Yoti BE service.
+
 ### Example
 
 ```js

package/index.css

@@ -1 +1 @@
-.mtcvKOHbFdRFpAH7ZHwW{align-items:center;background-color:#2875bc;border:none;border-radius:5px;color:#fff;cursor:pointer;display:block;display:flex;font-size:14px;font-weight:500;justify-content:center;letter-spacing:.5px;margin:auto;min-width:134px;outline:none;padding:12px 20px;text-transform:uppercase;transition:background-color .15s ease-out 0s;width:100%}.mtcvKOHbFdRFpAH7ZHwW.kYH4ilWb5sFtCcwqD29n{max-width:350px;width:45%}.mtcvKOHbFdRFpAH7ZHwW:hover{background-color:#27619b}.mtcvKOHbFdRFpAH7ZHwW:disabled{background-color:#6ba7df}.GusgiqC_1nbmjyHkruu0 use{fill:currentColor}.dDcfK_agfQV9XSYSuuxR{align-items:center;bottom:-8px;box-sizing:border-box;display:inline-block;justify-content:center;padding:16px;position:absolute;text-align:center;width:100%}._XKP_3EMO0LKJr53EW21{height:auto;transform:scaleX(-1);width:100%}._cYL8AOtgycwZXRT1onC{min-height:300px}.bX5GJJw3AqsCwBDA6qWZ{visibility:hidden}.RxkomAqHmrdu47_oGii4{bottom:-8px;box-sizing:border-box;display:grid;font-size:40px;grid-template-columns:repeat(3,80px) 50px;justify-content:center;padding:16px;position:absolute;text-align:center;width:100%}.ZSTtG9h6K6_0_axlDNnV,.__OOQVMtxL3v8uCw9eKy,.hwSkw4zQBundKmrqIwqC{color:#333b40;font-family:sans-serif;font-size:40px;font-weight:700;height:50px;line-height:55px;text-align:center;width:51px}.__OOQVMtxL3v8uCw9eKy{opacity:.5}.Gf_S7QnzULbIZZZ7roY2,.OZI1jG8pdtaOfb2ZsB2n,.XOix2SeWtEFksSSmLt9v{fill:#333b40}.Gf_S7QnzULbIZZZ7roY2 use,.OZI1jG8pdtaOfb2ZsB2n use,.XOix2SeWtEFksSSmLt9v use{fill:inherit}.ZSTtG9h6K6_0_axlDNnV svg,.__OOQVMtxL3v8uCw9eKy svg,.hwSkw4zQBundKmrqIwqC svg{font-size:50px}.Gf_S7QnzULbIZZZ7roY2{opacity:.5}.aM6UBOeSFg8vwirw8BEs{position:absolute}.HPEPfcUpwWOVOJSPP9R_{box-sizing:border-box;color:#546072;height:100%;left:0;position:absolute;right:0}.HPEPfcUpwWOVOJSPP9R_._0fft05LhDRetV8QdNSI{color:#1b9f4a}.HPEPfcUpwWOVOJSPP9R_.JHe4OqVjOOuBZXJn_axE{color:#db970e}.xsnSbKRs6MZbpP2odJGk{box-sizing:border-box;position:absolute;width:100%}.xsnSbKRs6MZbpP2odJGk.lSsJ_kvBTJOO0shULKLn{height:43.5%;top:28.3%}.xsnSbKRs6MZbpP2odJGk._6X0Zl0a0b8R2wCqGS_K{height:71.7%;top:11.5%}@keyframes TgYAVlLOGfJ_hl3TBdkC{0%{transform:rotate(0)}to{transform:rotate(1turn)}}.X_Bq5FImnGbO6TLe3Len{align-items:center;display:flex;height:100%;justify-content:center;line-height:0;text-align:center}.WPX6_jcjLpB6aH420ZCd{animation:TgYAVlLOGfJ_hl3TBdkC 1.5s infinite}.bPwt8l_jKvlB2llQ7azY{height:35.71px;width:35.71px}.bPwt8l_jKvlB2llQ7azY use{fill:#333b40}.Ds2gos19dHtdm4Aer1pq{display:flex;height:100%;justify-content:center;position:absolute;top:0;width:100%}.x_r8eQXclQHy5Jjno7pU{display:block;height:100%;margin:auto;position:absolute}.IpX4dJbHat9i3luoCwef{align-items:start;background-color:#fff;border-radius:.3em;box-shadow:0 8px 15px #333b401a;box-sizing:border-box;color:#333b40;display:flex;font-family:sans-serif;font-size:16px;font-size:var(--message-font-size);font-weight:900;justify-content:start;left:50%;padding:.4em 0;position:absolute;text-align:center}.a_0VmnisbKCGWfubHrmj{margin-bottom:50px;top:4.6%;transform:translate(-50%);width:90%}.CqNtyAmFAcDIeu8mRGPD{top:5.5%;transform:translate(-50%);width:51.25%}.rlF15FcuMGotbEHYe5KW{align-items:start;font-size:calc(var(--message-font-size) + 3px)}._CvVxyqwMB2D7fkKx_NZ{display:flex;justify-content:center;order:1;width:14%}._znJxLRvhRnuCU0KBY3_{order:2;width:72%}._2_U2DYHedfGUyvS1oS5{display:flex;flex-direction:column;overflow:hidden;position:relative}.mteIzegCA0cNMXt96BYN{position:relative}.Va8swWS5S29Uvou7UNnc{height:100%;position:absolute;width:100%}
+.mtcvKOHbFdRFpAH7ZHwW{align-items:center;background-color:#2875bc;border:none;border-radius:5px;color:#fff;cursor:pointer;display:block;display:flex;font-size:14px;font-weight:500;justify-content:center;letter-spacing:.5px;margin:auto;min-width:134px;outline:none;padding:12px 20px;text-transform:uppercase;transition:background-color .15s ease-out 0s;width:100%}.mtcvKOHbFdRFpAH7ZHwW.kYH4ilWb5sFtCcwqD29n{max-width:350px;width:45%}.mtcvKOHbFdRFpAH7ZHwW:hover{background-color:#27619b}.mtcvKOHbFdRFpAH7ZHwW:disabled{background-color:#6ba7df}.GusgiqC_1nbmjyHkruu0 use{fill:currentColor}.dDcfK_agfQV9XSYSuuxR{align-items:center;bottom:-8px;box-sizing:border-box;display:inline-block;justify-content:center;padding:16px;position:absolute;text-align:center;width:100%}._XKP_3EMO0LKJr53EW21{height:auto;transform:scaleX(-1);width:100%}._cYL8AOtgycwZXRT1onC{min-height:300px}.bX5GJJw3AqsCwBDA6qWZ{visibility:hidden}.RxkomAqHmrdu47_oGii4{bottom:-8px;box-sizing:border-box;display:grid;font-size:40px;grid-template-columns:repeat(3,80px) 50px;justify-content:center;padding:16px;position:absolute;text-align:center;width:100%}.ZSTtG9h6K6_0_axlDNnV,.__OOQVMtxL3v8uCw9eKy,.hwSkw4zQBundKmrqIwqC{color:#333b40;font-family:sans-serif;font-size:40px;font-weight:700;height:50px;line-height:55px;text-align:center;width:51px}.__OOQVMtxL3v8uCw9eKy{opacity:.5}.Gf_S7QnzULbIZZZ7roY2,.OZI1jG8pdtaOfb2ZsB2n,.XOix2SeWtEFksSSmLt9v{fill:#333b40}.Gf_S7QnzULbIZZZ7roY2 use,.OZI1jG8pdtaOfb2ZsB2n use,.XOix2SeWtEFksSSmLt9v use{fill:inherit}.ZSTtG9h6K6_0_axlDNnV svg,.__OOQVMtxL3v8uCw9eKy svg,.hwSkw4zQBundKmrqIwqC svg{font-size:50px}.Gf_S7QnzULbIZZZ7roY2{opacity:.5}.aM6UBOeSFg8vwirw8BEs{position:absolute}.HPEPfcUpwWOVOJSPP9R_{box-sizing:border-box;color:#546072;height:100%;left:0;position:absolute;right:0}.HPEPfcUpwWOVOJSPP9R_._0fft05LhDRetV8QdNSI{color:#1b9f4a}.HPEPfcUpwWOVOJSPP9R_.JHe4OqVjOOuBZXJn_axE{color:#db970e}.xsnSbKRs6MZbpP2odJGk{box-sizing:border-box;position:absolute;width:100%}.xsnSbKRs6MZbpP2odJGk.lSsJ_kvBTJOO0shULKLn{height:43.5%;top:28.3%}.xsnSbKRs6MZbpP2odJGk._6X0Zl0a0b8R2wCqGS_K{height:71.7%;top:11.5%}@keyframes TgYAVlLOGfJ_hl3TBdkC{0%{transform:rotate(0)}to{transform:rotate(1turn)}}.X_Bq5FImnGbO6TLe3Len{align-items:center;display:flex;height:100%;justify-content:center;line-height:0;text-align:center}.WPX6_jcjLpB6aH420ZCd{animation:TgYAVlLOGfJ_hl3TBdkC 1.5s infinite}.bPwt8l_jKvlB2llQ7azY{height:35.71px;width:35.71px}.bPwt8l_jKvlB2llQ7azY use{fill:#333b40}.Ds2gos19dHtdm4Aer1pq{display:flex;height:100%;justify-content:center;position:absolute;top:0;width:100%}.x_r8eQXclQHy5Jjno7pU{display:block;height:100%;margin:auto;position:absolute}.IpX4dJbHat9i3luoCwef{align-items:flex-start;background-color:#fff;border-radius:.3em;box-shadow:0 8px 15px #333b401a;box-sizing:border-box;color:#333b40;display:flex;font-family:sans-serif;font-size:16px;font-size:var(--message-font-size);font-weight:900;justify-content:flex-start;left:50%;padding:.4em 0;position:absolute;text-align:center}.a_0VmnisbKCGWfubHrmj{margin-bottom:50px;top:4.6%;transform:translate(-50%);width:90%}.CqNtyAmFAcDIeu8mRGPD{top:5.5%;transform:translate(-50%);width:51.25%}.rlF15FcuMGotbEHYe5KW{align-items:flex-start;font-size:calc(var(--message-font-size) + 3px)}._CvVxyqwMB2D7fkKx_NZ{display:flex;justify-content:center;order:1;width:14%}._znJxLRvhRnuCU0KBY3_{order:2;width:72%}._2_U2DYHedfGUyvS1oS5{display:flex;flex-direction:column;overflow:hidden;position:relative}.mteIzegCA0cNMXt96BYN{position:relative}.Va8swWS5S29Uvou7UNnc{height:100%;position:absolute;width:100%}

package/index.d.ts

@@ -13,6 +13,8 @@ declare module '@getyoti/react-face-capture' {
     FACE_DETECTION_INIT_ERROR = 'FACE_DETECTION_INIT_ERROR',
     CAPTURE_LOAD_ERROR = 'CAPTURE_LOAD_ERROR',
     INTERNAL_ERROR = 'INTERNAL_ERROR',
+    VIDEO_STREAM_INTERRUPTED = 'VIDEO_STREAM_INTERRUPTED',
+    SECURE_SESSION_EXPIRED = 'SECURE_SESSION_EXPIRED',
   }
 
   /**
@@ -79,13 +81,16 @@ declare module '@getyoti/react-face-capture' {
    */
   export enum LANGUAGE_CODE {
     AR = 'ar',
+    BG_BG = 'bg-BG',
     CS = 'cs',
     DA = 'da',
     DE = 'de',
+    EL = 'el',
     EN = 'en',
     ES = 'es',
     ES_419 = 'es-419',
     ET = 'et',
+    FA_IR = 'fa-IR',
     FI = 'fi',
     FR = 'fr',
     HE = 'he',
@@ -101,7 +106,12 @@ declare module '@getyoti/react-face-capture' {
     NB = 'nb',
     NL = 'nl',
     PL = 'pl',
+    /**
+     * @deprecated Use {@link LANGUAGE_CODE.PT_BR} or {@link LANGUAGE_CODE.PT_PT} instead.
+     */
     PT = 'pt',
+    PT_BR = 'pt-BR',
+    PT_PT = 'pt-PT',
     RO = 'ro',
     RU = 'ru',
     SV = 'sv',
@@ -119,6 +129,7 @@ declare module '@getyoti/react-face-capture' {
     version: string;
     token: string;
     signature: string;
+    verification: string;
   }
 
   /**