@getyoti/react-face-capture 2.2.0 → 2.2.1-dev.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # CHANGELOG
 
+## v2.2.1-dev.1
+
+### Testing features
+
+- Added new properties to allow configuration on faceStabilityCheck
+
+  - `faceStabilityThreshold` configures how strict the stability check will be.
+    The minimum value is 0.4 and the maximum value is 0.9.
+
+  - `numStableFrames` determines how many frames are used for the stability check.
+    The minimum value is 2 and the maximum is 5.
+
+  **Note:** These properties are for testing purposes and will be removed or refactored
+  in future versions.
+
+### Notices
+
+- Improved Face validations performance.
+
 ## v2.2.0
 
 ### New features

package/README.md

@@ -25,9 +25,9 @@ The package depends on the following peer dependencies
 | Browser | Versions            |
 | ------- | ------------------- |
 | and_chr | 123                 |
-| chrome  | 123,122,121,120     |
+| chrome  | 124,123,122,121     |
 | edge    | 123,122             |
-| firefox | 124,123,122,121     |
+| firefox | 125,124,123,122     |
 | ios_saf | 17.4,17.3,17.2      |
 | safari  | 17.4,17.3,17.2,17.1 |
 
@@ -129,6 +129,8 @@ 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`.     |
+| faceStabilityThreshold   | Number                                | 0.8                    | -         | Configures how strict the stability check will be. The minimum value is 0.4 and the maximum value is 0.9.                                                                                                                                                                               |
+| numStableFrames          | Number                                | 4                      | -         | Determines how many frames are used for the stability check. The minimum value is 2 and the maximum is 5.                                                                                                                                                                               |
 
 **(\*)**
 This field is only mandatory when using the secure mode. (secure = true)

package/index.d.ts

@@ -251,6 +251,12 @@ declare module '@getyoti/react-face-capture' {
      * 'allowBackgroundFaces' when 'faceSelectionMethod' is set to 'area'.
      * (default:center) */
     faceSelectionMethod?: FACE_SELECTION_METHOD;
+    /** Configures how strict the stability check will be.
+     * The minimum value is 0.4 and the maximum value is 0.9. */
+    faceStabilityThreshold: number;
+    /** Determines how many frames are used for the stability check.
+     * The minimum value is 2 and the maximum is 5. */
+    numStableFrames: number;
   }
 
   /**