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

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # CHANGELOG
 
+## v2.1.0
+
+### New features
+
+- Improve security checks.
+- UI improvements on help dialogue.
+- Change feedback message for `OVERCONSTRAINED` and `NO_CAMERA` errors from
+  `Please try again` to `Please try using a different device`.
+
+### Fixes
+
+- Remove the duplication of `Preparing camera` message when the FCM loads.
+- Fix video layout bug on iOS's 17.X version.
+- Improve the `scale` feature to fit better the whole container when the FCM is
+  scaled.
+- Mute Help dialogue video stream.
+- Adjust the distribution of icons and text of `Help` to avoid visual bugs
+  in certain languages.
+
+#### Peer dependencies updates
+
+- Update `axios` dependency from `1.6.2` to `1.6.5`.
+
+## v2.0.0
+
+See section [v2.0.0-beta.1](#v200-beta1) with previous changes for version
+`2.0.0`.
+
+- Design:
+
+  - The minimum size for the Face Capture in landscape view is 527px.
+
+  - Improved the help dialogue UI.
+
+- Updated Tagalog localisation message for "Only one face allowed" feedback.
+
+### Fixes
+
+- Apply portrait or landscape custom styles when the user rotates the device.
+- Fix scale flick when the `FaceCapture` loads.
+- Solve Axios dependency CSRF vulnerability.
+
 ## v2.0.0-beta.1
 
 ### New features

package/README.md

@@ -24,12 +24,12 @@ The package depends on the following peer dependencies
 
 | Browser | Versions            |
 | ------- | ------------------- |
-| and_chr | 119                 |
-| chrome  | 119,118,117,116     |
-| edge    | 119,118             |
-| firefox | 119,118,117,116     |
-| ios_saf | 17.1,17.0,16.6-16.7 |
-| safari  | 17.1,17.0,16.6,16.5 |
+| and_chr | 121                 |
+| chrome  | 121,120,119,118     |
+| edge    | 121,120             |
+| firefox | 122,121,120,119     |
+| ios_saf | 17.3,17.2,17.1      |
+| safari  | 17.3,17.2,17.1,17.0 |
 
 </browserSupportTable>
 
@@ -43,6 +43,8 @@ Finally, some devices might experience poor performance when attempting to detec
 
 _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._
 
+_Note: It is possible to disable the picture-in-picture feature for Firefox in [its configuration](https://support.mozilla.org/en-US/kb/turn-picture-picture-mode)._
+
 ## React Face Capture
 
 ### Install dependency
@@ -64,12 +66,14 @@ import FaceCapture from "@getyoti/react-face-capture"
 For instance, in webpack you can use the plugin `copy-webpack-plugin` in the following way:
 
 ```js
-new CopyPlugin([
-  {
-    from: path.resolve(__dirname, './node_modules/@getyoti/react-face-capture/assets'),
-    to: path.resolve(__dirname, './dist/assets')
-  }
-]),
+new CopyPlugin({
+  patterns: [
+    {
+      from: path.resolve(__dirname, './node_modules/@getyoti/react-face-capture/assets'),
+      to: path.resolve(__dirname, './dist/assets'),
+    },
+  ],
+});
 ```
 
 ### CSS Customization
@@ -216,7 +220,9 @@ to verify that the image captured on the client-side browser with the FCM hasn't
 modified in any form. Note, the secure mode of Yoti FCM makes a request to Yoti
 back-end to download the encrypted capture package that takes the
 photo and create the secure result request. The secure result information will
-be returned in `onSuccess` callback (`payload` argument):
+be returned in `onSuccess` callback (`payload` argument). It is the information
+that the _Yoti back-end service_ needs to run a prediction. The service will
+return an error if the `payload` is modified:
 
 ```json
 {