@getyoti/react-face-capture 2.2.1-dev.1 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -15
- package/README.md +6 -8
- package/index.d.ts +0 -6
- package/index.js +7 -7
- package/package.json +1 -1
- package/vanilla/index.js +10 -10
- package/vanilla/index.js.LICENSE.txt +2 -2
- package/vanilla/index.js.map +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,23 +1,19 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
|
-
## v2.2.1
|
|
3
|
+
## v2.2.1
|
|
4
4
|
|
|
5
|
-
###
|
|
6
|
-
|
|
7
|
-
- Added new properties to allow configuration on faceStabilityCheck
|
|
8
|
-
|
|
9
|
-
- `faceStabilityThreshold` configures how strict the stability check will be.
|
|
10
|
-
The minimum value is 0.4 and the maximum value is 0.9.
|
|
11
|
-
|
|
12
|
-
- `numStableFrames` determines how many frames are used for the stability check.
|
|
13
|
-
The minimum value is 2 and the maximum is 5.
|
|
5
|
+
### Notices
|
|
14
6
|
|
|
15
|
-
|
|
16
|
-
|
|
7
|
+
- Improved face validations performance, resulting in faster image captures.
|
|
8
|
+
- Improved face stability validation. Now it is easier to capture the image.
|
|
17
9
|
|
|
18
|
-
###
|
|
10
|
+
### Fixes
|
|
19
11
|
|
|
20
|
-
-
|
|
12
|
+
- Fixed a bug causing undesired triggers of the `onError` callback when
|
|
13
|
+
`userRetryError` was set to `false`.
|
|
14
|
+
- A note for `userRetryError` property has been added in [`2.0.1-beta.1`](#v200-beta1) in the breaking changes section.
|
|
15
|
+
- `Right-to-left` language localisations now use the proper alignment.
|
|
16
|
+
- Fix wrong translation for "Move to the center" message for Portuguese (Brazil).
|
|
21
17
|
|
|
22
18
|
## v2.2.0
|
|
23
19
|
|
|
@@ -105,7 +101,7 @@ See section [v2.0.0-beta.1](#v200-beta1) with previous changes for version
|
|
|
105
101
|
|
|
106
102
|
- New property to allow auto-reload of the secure session before the session expires: `autoSessionReload`.
|
|
107
103
|
|
|
108
|
-
- New property to let the user handle errors by retrying several times: `userRetryError`.
|
|
104
|
+
- New property to let the user handle errors by retrying several times: `userRetryError`. It is enabled by default.
|
|
109
105
|
|
|
110
106
|
- New design:
|
|
111
107
|
|
|
@@ -170,6 +166,8 @@ See section [v2.0.0-beta.1](#v200-beta1) with previous changes for version
|
|
|
170
166
|
|
|
171
167
|
- The minimum size for the Face Capture in landscape view is 576px.
|
|
172
168
|
|
|
169
|
+
- As the `userRetryError` is set to true by default, the `onError` will not be triggered until the user runs out of tries.
|
|
170
|
+
|
|
173
171
|
#### Peer dependencies updates
|
|
174
172
|
|
|
175
173
|
- Updated `react` dependency version to be at least `16.14.0` and a maximum of `18.2.0`.
|
package/README.md
CHANGED
|
@@ -24,12 +24,12 @@ The package depends on the following peer dependencies
|
|
|
24
24
|
|
|
25
25
|
| Browser | Versions |
|
|
26
26
|
| ------- | ------------------- |
|
|
27
|
-
| and_chr |
|
|
28
|
-
| chrome | 124,123,122
|
|
29
|
-
| edge |
|
|
30
|
-
| firefox | 125,124,123
|
|
31
|
-
| ios_saf | 17.
|
|
32
|
-
| safari | 17.4,17.3,17.2
|
|
27
|
+
| and_chr | 124 |
|
|
28
|
+
| chrome | 125,124,123,122 |
|
|
29
|
+
| edge | 125,124 |
|
|
30
|
+
| firefox | 126,125,124,123 |
|
|
31
|
+
| ios_saf | 17.5,17.4,17.3 |
|
|
32
|
+
| safari | 17.5,17.4,17.3,17.2 |
|
|
33
33
|
|
|
34
34
|
</browserSupportTable>
|
|
35
35
|
|
|
@@ -129,8 +129,6 @@ The CSS custom properties must be defined using the `:root` CSS selector. Here i
|
|
|
129
129
|
| encryptImage | Boolean | `true` | - | Encrypt the image inside the payload argument on the `onSuccess` callback when it runs the secure mode. |
|
|
130
130
|
| 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. |
|
|
131
131
|
| 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`. |
|
|
132
|
-
| 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. |
|
|
133
|
-
| numStableFrames | Number | 4 | - | Determines how many frames are used for the stability check. The minimum value is 2 and the maximum is 5. |
|
|
134
132
|
|
|
135
133
|
**(\*)**
|
|
136
134
|
This field is only mandatory when using the secure mode. (secure = true)
|
package/index.d.ts
CHANGED
|
@@ -251,12 +251,6 @@ declare module '@getyoti/react-face-capture' {
|
|
|
251
251
|
* 'allowBackgroundFaces' when 'faceSelectionMethod' is set to 'area'.
|
|
252
252
|
* (default:center) */
|
|
253
253
|
faceSelectionMethod?: FACE_SELECTION_METHOD;
|
|
254
|
-
/** Configures how strict the stability check will be.
|
|
255
|
-
* The minimum value is 0.4 and the maximum value is 0.9. */
|
|
256
|
-
faceStabilityThreshold: number;
|
|
257
|
-
/** Determines how many frames are used for the stability check.
|
|
258
|
-
* The minimum value is 2 and the maximum is 5. */
|
|
259
|
-
numStableFrames: number;
|
|
260
254
|
}
|
|
261
255
|
|
|
262
256
|
/**
|