From 546aa58156714583f2f031aa51afa6c6c1fdf8f3 Mon Sep 17 00:00:00 2001 From: Josselin Guillozet Date: Fri, 21 Apr 2023 17:29:53 +0100 Subject: [PATCH] 4.2.0 release --- CHANGELOG.md | 32 +++++++++++-- README.md | 91 +++++++++++++++++++++---------------- languages/iproov-cy_GB.json | 4 +- languages/iproov-de.json | 4 +- languages/iproov-en.json | 4 +- languages/iproov-es.json | 4 +- languages/iproov-es_CO.json | 4 +- languages/iproov-fr.json | 4 +- languages/iproov-it.json | 4 +- languages/iproov-nl.json | 4 +- languages/iproov-pt.json | 4 +- languages/iproov-pt_BR.json | 4 +- 12 files changed, 100 insertions(+), 63 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04101ae..fae8632 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,25 +5,51 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## 21.04.2023 4.2.0 + +## Added + +- **UI** + - **Color Customization**: New `header_background_color` option, transparent by default. [See color documentation](https://github.com/iProov/web#colors). + - **Exterior Blur Customization**: New `disable_exterior_blur` option, disabled by default. [See disable exterior blur documentation](https://github.com/iProov/web#disable-exterior-blur). +- **Errors** + - **Logging & Telemetry**: Improved logging and telemetry to better understand errors we previously didn't have visibility of. + +## Changed + +- **Motion Permission**: Permission for motion collection is now requested for iOS or iPadOS after the `grant_permission` slot. [See upgrade guide for more details](https://github.com/iProov/web/wiki/Upgrade-Guide#upgrading-from-v4xx-to-v420) + +## Fixed + +- **UI** + - **Feedback Prompt**: Fixed prompt not expanding and forcing feedback messages onto 2 lines. + - **Progress Bar**: Fixed GPA progress bar not reaching 100%. + - **Landscape Orientation**: Fixed an issue where `allow_landscape` option was allowing LA claims to start in landscape on mobiles. [See behavior documentation](https://github.com/iProov/web#allow-landscape). + - **Android Tablet**: Fixed an issue to allow LA claims in landscape orientation on Android tablets (although this orientation is not recommended). + - **iPad's Version Reporting**: Fixed an issue where iPad's were reporting the wrong iOS version which triggered iframe bridge unnecessarily. + - **Event Details**: Fixed missing `type` in details + updated docs to correctly reflect expected data. + ## 27.02.2023 4.1.1 ## Fixed - **Supplementary Imagery**: Fixed issue with imagery not being returned. - ## 13.02.2023 4.1.0 ## Added + - **Support Checker**: New `localStorage` test to handle when `localStorage` is not supported and edge cases such as iframed integrations while using Chrome's incognito mode. ## Changed + - **UI** - **Optimisation**: We replaced ThreeJS with a custom WebGL implementation. - **Android**: Upto `20%` performance improvement with low-end Android devices. - **Bundle Size**: `200kb` removed from the overall bundle size! ## Fixed + - **SDK Options**: Fixed `base_url` option not accepting URLs which include a path name. - **Failed Event**: `ambiguous_outcome` not being replaced with `unknown` in the failed event data. - **Video Feed**: The camera feed not being visible after cancelling a claim and then when a new `iproov-me` element is loaded into the page the camera feed wouldn't be visible. @@ -51,9 +77,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **Networking**: SocketIO has been replaced with a more secure in-house solution directly based on WebSockets - **Networking**: Default network timeout has been increased to 20 seconds - **Events**: Removed `Interrupted` Event -- **UI**: Introduced the new NUX UI for WebSDK (Kiosk Mode is unaffected from all the following UI related changes) +- **UI**: Introduced a new UI for the Web SDK (Kiosk Mode is unaffected from all the following UI related changes) - **UI**: The centre prompt can now take a string of any length -- **UI**: Introduced the following options for new features brought by NUX: +- **UI**: Introduced the following options for new UI features: - `csp_nonce`: This can be set to a random string to avoid requiring `unsafe-inline` in your style-src CSP. - `floating_prompt_rounded_corners` has been renamed to `prompt_rounded_corners` - Removed `enable_floating_prompt` diff --git a/README.md b/README.md index 961a92f..930581b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![iProov: Biometric Face Verification for Remote Identity Assurance](https://github.com/iProov/web/raw/master/images/banner.png) -# iProov Biometrics Web SDK v4.1.1 +# iProov Biometrics Web SDK v4.2.0 ## 📖 Table of contents @@ -46,7 +46,7 @@ The NPM package [@iproov/web-sdk](https://www.npmjs.com/package/@iproov/web-sdk) Using the `@iproov/web-sdk` package is the recommended way of using the iProov Web SDK in production, and works best with a bundler like Webpack, Parcel or Rollup. The iProov Web SDK is held in a private NPM registry, to gain access, please contact [support@iproov.com](mailto:support@iproov.com) sharing your NPM username and you will be given instructions on using the private NPM reg ->⚠️When you have been granted access, to use the `@iproov/web-sdk` via your CLI, you will need to authenticate with [NPM Login](https://docs.npmjs.com/cli/v9/commands/npm-login) or [YARN login](https://classic.yarnpkg.com/lang/en/docs/cli/login/). +> ⚠️When you have been granted access, to use the `@iproov/web-sdk` via your CLI, you will need to authenticate with [NPM Login](https://docs.npmjs.com/cli/v9/commands/npm-login) or [YARN login](https://classic.yarnpkg.com/lang/en/docs/cli/login/). #### Setup @@ -130,7 +130,7 @@ There are also the following framework specific example integrations available o ## ⚙ Options -The behaviour of the iProov Biometrics Web SDK can be altered by setting the following options as attributes of the `` tag in the same way as the token. +The behavior of the iProov Biometrics Web SDK can be altered by setting the following options as attributes of the `` tag in the same way as the token. #### Network Timeout @@ -201,9 +201,9 @@ Specify a custom title to be shown. Defaults to empty string "" - hide the messa ``` -#### Colours +#### Colors -You can customise the look and feel of the main layout by changing the following options. You can pass a literal value `red`, RGB `rgb(230, 245, 66)`, a hex value `#e6f542` or an RGBA value `rgba(230, 245, 66, 0.8)`. +You can customize the look and feel of the main layout by changing the following options. You can pass a literal value `red`, RGB `rgb(230, 245, 66)`, a hex value `#e6f542` or an RGBA value `rgba(230, 245, 66, 0.8)`. ```javascript { @@ -211,6 +211,7 @@ You can customise the look and feel of the main layout by changing the following surround_color: "rgba(0, 0, 0, 0.4)", prompt_background_color: "rgba(0, 0, 0, 0.8)", prompt_text_color: "#ffffff", + header_background_color: "rgba(255, 0, 0, 0.8)", gpa_not_ready_oval_stroke_color: "#ffffff", gpa_ready_oval_stroke_color: "#01ac41", liveness_oval_stroke_color: "#ffffff", @@ -218,20 +219,21 @@ You can customise the look and feel of the main layout by changing the following } ``` -With the introduction of NUX the following colour options are possible: +Color option changes introduced in [v4.0.0](https://github.com/iProov/web/releases/tag/v4.0.0): -| Colour Option | Description | -| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| **title_text_color** | Adjusts the colour of the text that can be added above the oval (by default there is no text here - see the custom_title option for more information) | -| **surround_color** | Adjusts the colour of the surroundings to the centre oval in NUX. | -| **prompt_text_color** | Adjusts the colour of the text visible in the centre prompt of the screen | -| **prompt_background_color** | Adjusts the colour of the background visible in the centre prompt of the screen | -| **gpa_not_ready_oval_stroke_color** | Stroke colour for the centre oval whilst the SDK is in a "Not Ready" state in GPA | -| **gpa_ready_oval_stroke_color** | Stroke colour for the centre oval whilst the SDK is in a "Ready" state in GPA | -| **liveness_oval_stroke_color** | Stroke colour for the centre oval whilst the SDK before iProov-ing in Liveness | -| **liveness_completed_oval_stroke_color** | Stroke colour for the centre oval whilst the SDK after iProov-ing in Liveness | +| Color Option | Description | +| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| **title_text_color** | Adjusts the color of the text that can be added above the oval (by default there is no text here - see the custom_title option for more information) | +| **surround_color** | Adjusts the color of the surroundings to the centre oval. | +| **prompt_text_color** | Adjusts the color of the text visible in the centre prompt of the screen | +| **prompt_background_color** | Adjusts the color of the background visible in the centre prompt of the screen | +| **header_background_color** | Adjusts the color of the background visible in the top bar of the application (transparent by default) | +| **gpa_not_ready_oval_stroke_color** | Stroke color for the centre oval whilst the SDK is in a "Not Ready" state in GPA | +| **gpa_ready_oval_stroke_color** | Stroke color for the centre oval whilst the SDK is in a "Ready" state in GPA | +| **liveness_oval_stroke_color** | Stroke color for the centre oval whilst the SDK before iProov-ing in Liveness | +| **liveness_completed_oval_stroke_color** | Stroke color for the centre oval whilst the SDK after iProov-ing in Liveness | -Kiosk mode is unaffected from these changes to colour options. The same colour options passed through from 3.6.1 and prior should be utilised instead. +Kiosk mode is unaffected from these changes to color options. The same color options passed through from 3.6.1 and prior should be utilized instead. #### Aria Live @@ -273,11 +275,11 @@ Note that inline CSS _is_ needed to provide critical styles for `` fo When `allow_landscape` is set to `true`, handheld devices will be able to start in landscape orientation. -Here is the behaviour: +Here is the behavior: - For GPA and Liveness, landscape orientation is blocked in most handheld devices. - For Liveness, no handheld device will be able to start in landscape mode, regardless of this setting. -- This blocking behaviour is not enforced on Android tablets due to the varying position of their camera. +- This blocking behavior is not enforced on Android tablets due to the varying position of their camera. - When in landscape mode in an affected UX, the iProov component will display the `rotate_portrait` slot. - Desktop devices are unaffected by `allow_landscape`. @@ -299,7 +301,7 @@ By setting `show_countdown` to `true`, a countdown will be shown to the user bef Support multiple camera selection on desktop devices by setting `enable_camera_selector` to `true`. -When enabled, the `camera_selector` slot, `multiple_cameras` event will be exposed. See [Camera Selector](#-slots) slot for customisation options. This feature is only available on desktop devices (laptops, PCs etc). +When enabled, the `camera_selector` slot, `multiple_cameras` event will be exposed. See [Camera Selector](#-slots) slot for customization options. This feature is only available on desktop devices (laptops, PCs etc). Regardless of `enable_camera_selector` value, if more than one camera is available and if the browser is not Firefox, a button to switch camera will be available in the application. @@ -307,6 +309,16 @@ Regardless of `enable_camera_selector` value, if more than one camera is availab ``` +#### Disable Exterior Blur + +Disables the blur and vignette around the centre oval available by default. This option is disabled by default. + +This option is not compatible with the `blur` filter. + +```html + +``` + #### Debug Logs Logs at level info or lower are hidden, but can be exposed to the console by setting `debug` to `true`. @@ -316,13 +328,13 @@ Warnings and errors will always be emitted to the console. ``` -This setting has no effect on any `iProovSupport` instance that's been initialised separately to the main component. +This setting has no effect on any `iProovSupport` instance that's been initialized separately to the main component. The checker itself accepts a logger argument which could be `console`, or any common logging library which you are free to configure to your own requirements. #### Kiosk Mode -Kiosk mode still utilises the same UX as prior SDK versions - this also applies to SDK and colour options. +Kiosk mode still utilizes the same UX as prior SDK versions - this also applies to SDK and color options. When deploying iProov on physically secured hardware such as laptops and desktop devices, you can enable the kiosk mode UI. @@ -335,9 +347,9 @@ When deploying iProov on physically secured hardware such as laptops and desktop ## 📥 Slots Customise the markup, styling and automatically inherit your app's styles by [using slots](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_templates_and_slots). -You can customise the preparation and result stages of iProov to seamlessly integrate it into your application. +You can customize the preparation and result stages of iProov to seamlessly integrate it into your application. -The following examples show different ways to customise some commonly used slots. +The following examples show different ways to customize some commonly used slots. ### HTML @@ -412,19 +424,19 @@ To integrate with our localization feature, use special class names in your slot ``` -> ⚠️ When customising any the `button` and `grant_button` slots, the slot must contain a `