@getyoti/react-face-capture 2.2.1 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## v2.3.0
+
+### Notices
+
+- Localisation has been thoroughly revised. All languages have been updated to improve correctness and punctuation.
+- Reduce the number of retries to 3 for some errors so that the onError is triggered earlier.
+
+### New features
+
+- Add new property `numStableFrames` to determine how many frames are used for the stability check.
+  The minimum value is 3 and the maximum is 6.
+- Implemented localisation language:
+  - `hr-HR`: Croatian
+
+### Fixes
+
+- Fix text position and margin on initial guidance for large languages.
+
 ## v2.2.1
 
 ### Notices

package/README.md

@@ -24,10 +24,10 @@ The package depends on the following peer dependencies
 
 | Browser | Versions            |
 | ------- | ------------------- |
-| and_chr | 124                 |
-| chrome  | 125,124,123,122     |
-| edge    | 125,124             |
-| firefox | 126,125,124,123     |
+| and_chr | 127                 |
+| chrome  | 127,126,125,124     |
+| edge    | 127,126             |
+| firefox | 129,128,127,126     |
 | ios_saf | 17.5,17.4,17.3      |
 | safari  | 17.5,17.4,17.3,17.2 |
 
@@ -83,7 +83,7 @@ Now, it is possible to customize the style by changing the following CSS propert
 - `--fcm-primary-button-background-color` changes the background color in primary buttons (Take picture, Try again, ... ).
   - `--fcm-primary-button-background-color-hover` changes the background color in primary buttons (Take picture, Try again, ... ) when is hovered.
 - `--fcm-primary-button-text-color` changes the text color in primary buttons (Take picture, Try again, ... ).
-- `--fcm-secondary-button-background-color` changes the background color in primary buttons (Get help).
+- `--fcm-secondary-button-background-color` changes the background color in secondary buttons (Get help).
 - `--fcm-secondary-button-text-color` changes the text color in secondary buttons (Get help).
   - `--fcm-secondary-button-text-color-hover` changes the text color in secondary buttons (Get help) when the button is hovered.
 - `--fcm-font-family` sets the font family.
@@ -129,6 +129,7 @@ The CSS custom properties must be defined using the `:root` CSS selector. Here i
 | encryptImage             | Boolean                               | `true`                 | -         | Encrypt the image inside the payload argument on the `onSuccess` callback when it runs the secure mode.                                                                                                                                                                                 |
 | allowBackgroundFaces     | Boolean                               | `false`                | -         | Allows faces to be present in the background when the image is being captured. The face capture will return a cropped image with the main face when set to `true`. Note: This feature is designed for retail terminals and unsuitable for online user's face capture.                   |
 | faceSelectionMethod      | String `center/area`                  | `center`               | -         | Defines where the main face can be placed, in the center or anywhere in the image. Note: This feature is designed for retail terminals and unsuitable for online user's face capture. It is recommend to enable `allowBackgroundFaces` when `faceSelectionMethod` is set to `area`.     |
+| numStableFrames          | Number                                | 4                      | -         | Determines how many frames are used for the stability check. The minimum value is 3 and the maximum is 6.                                                                                                                                                                               |
 
 **(\*)**
 This field is only mandatory when using the secure mode. (secure = true)
@@ -152,6 +153,7 @@ Current languages supported:
 - `fr-FR`: French
 - `he-IL`: Hebrew
 - `hi-IN`: Hindi
+- `hr-HR`: Croatian
 - `hu-HU`: Hungarian
 - `hy-AM`: Armenian
 - `id-ID`: Bahasa
@@ -351,3 +353,7 @@ Face Capture uses the comment `/* webpackIgnore: true */` order to tell webpack
 that it does not need to resolve the dependency locally so this comment cannot
 be removed before webpack builds the final javascript files for the web
 application.
+
+### iOS distorted layout
+
+We are aware of a rare display issue on iOS devices which can make the video element appear distorted. This issue is not related to the FCM but is an open issue regarding iOS video elements. Refreshing or reloading will resolve this, and it should not happen often.

package/index.d.ts

@@ -116,6 +116,8 @@ declare module '@getyoti/react-face-capture' {
     HE_IL = 'he-IL',
     HI = 'hi',
     HI_IN = 'hi-IN',
+    HR = 'hr',
+    HR_HR = 'hr-HR',
     HU = 'hu',
     HU_HU = 'hu-HU',
     HY = 'hy',
@@ -251,6 +253,9 @@ declare module '@getyoti/react-face-capture' {
      * 'allowBackgroundFaces' when 'faceSelectionMethod' is set to 'area'.
      * (default:center) */
     faceSelectionMethod?: FACE_SELECTION_METHOD;
+    /** Determines how many frames are used for the stability check.
+     * The minimum value is 3 and the maximum is 6. */
+    numStableFrames: number;
   }
 
   /**