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

package/CHANGELOG.md

@@ -1,11 +1,168 @@
 # CHANGELOG
 
+## v2.0.0-beta.1
+
+### New features
+
+- The secure mode returns an encrypted image by default now. Use `encryptImage`
+  property to return the base64 image in the secure payload. The face capture
+  also provides a new property to get the base64 image preview in the `onSuccess`
+  callback: `returnPreviewImage`.
+
+- New property to identify your Yoti Hub application: `clientSdkId`.
+
+- Secure module deprecation and end support handling.
+
+  - The Face Capture will log a warning message when the secure module version in use
+    becomes deprecated. It will return the error `VERSION_NO_LONGER_AVAILABLE`
+    in the `onError` callback when the support has ended.
+
+- New property to allow auto-reload of the secure session before the session expires: `autoSessionReload`.
+
+- New property to let the user handle errors by retrying several times: `userRetryError`.
+
+- New design:
+
+  - The Face Capture will show a loading screen when it returns a valid
+    image in the `onSuccess` callback or an error screen if it runs the
+    `onError` callback.
+
+  - New Guidance screen that will be shown before the webcam loads. It can be hidden by providing the property `showInitialGuidance` with value `false`
+
+  - New Get Help button in the webcam view. It can be hidden by providing the property `showGetHelpButton` with value `false`.
+
+  - New font family (it can still be changed by `--fcm-font-family` css
+    variable).
+
+  - Improved manual mode user feedback.
+
+  - Improved Face Capture responsiveness.
+
+  - It is possible to customize some styles by using css variables. These are
+    the properties that can be changed:
+
+    - `--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-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-prompt-text-color` changes the text color in the prompt.
+
+  - The countdown functionality has been removed.
+
+- Implemented localisation languages:
+
+  - `tl-PH`: Tagalog
+  - `zh-CN`: Chinese - Simplified
+
+- The Face Capture style has been encapsulated using shadow Dom. From now on, the only style customization available is through the CSS variables listed in the documentation.
+
+### Breaking changes
+
+- The `onSuccess` callback definition changed to (`(payload: FCMPayload, base64PreviewImage?: string) => {}`).
+
+  - The type of the `payload` argument changed from `FCMResult` to `FCMPayload`.
+
+- Secure mode is now the default mode for the Face Capture (`secure` property value is now `true` by default).
+
+  - The new property `clientSdkId` is required when using secure mode. So will be required by default.
+
+- The property `buttonSize` was removed.
+
+- The property `isConsentRequired` was removed.
+
+- The properties `CustomManualButton` and `CustomConsentButton` were removed.
+
+- The property `countdownMode` was removed.
+
+- The minimum size for the Face Capture in landscape view is 576px.
+
+#### Peer dependencies updates
+
+- Updated `react` dependency version to be at least `16.14.0` and a maximum of `18.2.0`.
+
+- Updated `react-dom` dependency version to be at least `16.14.0` and a maximum of `18.2.0`.
+
+## v1.4.0
+
+### New features
+
+- If the module takes more than 15 seconds to be downloaded, the onError callback will be called with error code `EXCEEDED_TIME_TO_LOAD`. You can modify the timeout to call `onError` by changing the `loadTimeout` property.
+- Implemented localisation languages:
+
+  - `sk-SK`: Slovak
+  - `hu-HU`: Hungarian
+
+- The translations are available for the manual button.
+
+- It is possible to change the default button size. There are three options: SMALL, MEDIUM and LARGE. The new field, `buttonSize`, can be used for changing the button size: `buttonSize={BUTTON_SIZE.SMALL}`.
+  MEDIUM and LARGE values are not supported in mobile devices
+
+- It is possible to change some values by css variables. These are the properties that can be changed:
+
+  - --fcm-button-color-background. Changes the background color in buttons.
+  - --fcm-button-text-color. Changes the text color in buttons.
+  - --fcm-button-background-color-hover. Changes the background color for buttons on hover.
+  - --fcm-button-background-color-disabled. Changes the background color for buttons when they are disabled.
+  - --fcm-font-family. Sets the font family.
+  - --fcm-prompt-background-color. Sets the background color in the message prompt.
+
+  > **Note**: We do not recommend changing these css properties, all changes on the font and colors are under the integrator's responsibility and need to be tested by the integrator.
+  > In addition, we can't guarantee external customizations support on new versions of the library
+
+### Notices
+
+- `CustomManualButton` and `CustomConsentButton` are deprecated. They will be removed on 2.0.0 version.
+- Region subtag added to localisation tags. Codes with a single primary subtag (e.g.`en`) are still valid, although we encourage using region-variant codes explicitly.
+  - `ar` --> `ar-XN`
+  - `cs` --> `cs-CZ`
+  - `da` --> `da-DK`
+  - `de` --> `de-DE`
+  - `el` --> `el-GR`
+  - `en` --> `en-GB`
+  - `es` --> `es-ES`
+  - `et` --> `et-EE`
+  - `fi` --> `fi-FI`
+  - `fr` --> `fr-FR`
+  - `he` --> `he-IL`
+  - `hi` --> `hi-IN`
+  - `hy` --> `hy-AM`
+  - `id` --> `id-ID`
+  - `it` --> `it-IT`
+  - `ja` --> `ja-JP`
+  - `ko` --> `ko-KR`
+  - `lt` --> `lt-LT`
+  - `lv` --> `lv-LV`
+  - `ms` --> `ms-MY`
+  - `nb` --> `nb-NO`
+  - `nl` --> `nl-NL`
+  - `pl` --> `pl-PL`
+  - `ro` --> `ro-RO`
+  - `ru` --> `ru-RU`
+  - `sv` --> `sv-SE`
+  - `th` --> `th-TH`
+  - `tr` --> `tr-TR`
+  - `uk` --> `uk-UA`
+  - `ur` --> `ur-PK`
+  - `vi` --> `vi-VN`
+
+### Fixes
+
+- Fix Greek localisation for "Place your face in the frame" feedback.
+
 ## v1.3.0
 
 ### New features
 
 - The secure payload has a new field `verification`.
-- Increased the protection against requests from untrusted devices. The
+- Increased 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.
@@ -20,7 +177,7 @@
 
 ### Fixes
 
-- Secure session initialisation request is not longer cached.
+- Secure session initialisation request is no longer cached.
 - Added missing fields in the typing file.
 - Camera feedback messages are shown only after the camera permissions were
   giving not before.
@@ -68,11 +225,11 @@
 
 - Added `onReadyForCapture` callback to provide a way for the integrators to know when the module is ready to take images.
 
-- Now the Face Capture Module will stop the process and the camera when the page is hidden.
+- Now, the Face Capture Module will stop the process and the camera when the page is hidden.
 
-  - There is a known issue on iPhone Firefox, when opening a new FCM instance in a different tab, that may cause the previous one to freeze.
+  - There is a known issue on iPhone Firefox when opening a new FCM instance in a different tab, that may cause the previous one to freeze.
 
-- Now the vanilla version of the Face Capture Module also exports some useful constants, as the React version does. Here is a list of all of them:
+- Now, the vanilla version of the Face Capture Module also exports some useful constants, as the React version does. Here is a list of all of them:
 
   - **CAPTURE_METHOD**
   - **COUNTDOWN_MODES**
@@ -85,7 +242,7 @@
 
     New constants can be accessed by using `Yoti.<CONSTANT_NAME>`.
 
-- Now `countdownMode` has new options:
+- Now, `countdownMode` has new options:
 
   - `never` and `always` remains the same.
   - `auto` has been replaced by `only_mobile` and `only_desktop` which brings extra configuration for all possible scenarios.
@@ -96,7 +253,7 @@
   - `hy`: Armenian
   - `he`: Hebrew
 
-- Updated localisations languages:
+- Updated localisation languages:
 
   - `it`: Italian
   - `es-419`: Latin American Spanish
@@ -119,7 +276,7 @@
 
 ## v1.0.0-beta.3
 
-Fix a package install error which cause `yarn` and older `npm` versions to fail.
+Fix a package install error which causes `yarn` and older `npm` versions to fail.
 
 ## v1.0.0-beta.2
 
@@ -133,7 +290,7 @@ Fix a package install error which cause `yarn` and older `npm` versions to fail.
 
 ### Breaking changes
 
-Now the `onSuccess` callback returns the image in the `img` field instead for
+Now, the `onSuccess` callback returns the image in the `img` field instead of
 `image`.
 
 - Before:
@@ -167,9 +324,9 @@ Now the `onSuccess` callback returns the image in the `img` field instead for
     }
     ```
 
-Now the `CustomButton` has been splited in `CustomManualButton` and `CustomConsentButton` because
+Now, the `CustomButton` has been split into `CustomManualButton` and `CustomConsentButton` because
 of the implementation of the new consent mode. Each of the properties has the same definitions as
-the old `CustomButton`, funtions using `onClick` and `disabled` as props that returns a button
+the old `CustomButton`, functions using `onClick` and `disabled` as props that return a button
 component.
 
 ## v0.6.0
@@ -190,7 +347,7 @@ component.
   - `ko`: Korean
   - `lt`: Lithuanian
   - `ms`: Malay
-  - `uk`: Ukranian
+  - `uk`: Ukrainian
 
 ## v0.4.0
 
@@ -251,7 +408,7 @@ component.
 ### New Features
 
 - Add image quality prop
-- Set JPEG High quality as default image format
+- Set JPEG High quality as the default image format
 - Add languages support:
 
   - EN - English