Releases: iProov/web
Releases · iProov/web
v3.2.1
18.06.2021 3.2.1
Fixed
- Fixed
cancelled
orinterrupted
events not firing if the back button is pressed on single page apps using popstate. - Fixed bug in how the UI scales in size to fit the whole screen.
- Fixed cases when
abort
events were fired twice due to an internal API race condition. - UX GPA:
moveLeft
andmoveRight
states have been removed from mobile devices.moveUp
,moveDown
,moveCloser
andmoveBack
remain in place. - UX GPA: limited video config will now only prompt for
moveCloser
andmoveBack
.
Added
- Added
error_too_many_requests
language string which is displayed when rate limiting is enforced at the client side.
v3.2.0
Fixed
- Fixed "Keep still" message from disappearing while streaming when
show_countdown
is set totrue
. - Fix rotate portrait issues on Android devices.
- Fix various fullscreen flicker issues.
- Fix race condition when exiting fullscreen where the UI may not hand control back to the host page.
Added
UI Customisation
- New options have been added to customise the UI colours:
header_background_color
header_text_color
footer_background_color
footer_text_color
progress_bar_color
loading_tint_color
not_ready_tint_color
ready_tint_color
oval_scanning_color
liveness_tint_color
liveness_scanning_tint_color
- A new
close_button
URL option has been added to customise the close button.
Timeout Logic
- The
network_timeout
option has been added, defaulting to 10 seconds. See the docs for more details. - If we don't receive a response from our backend in this time, we error with
error_network
.
Iframe Bridge
- Iframe Bridge for Mobile Safari has been added in order to support Liveness transactions, where the device would otherwise report
unsupported
.- New events:
iframe_bridge
- New slots:
iframe_bridge_title
iframe_bridge_button
- New language strings:
iframe_bridge_title
iframe_bridge_button
- New events:
General
- Added missing errors
error_asset_fetch
anderror_device_motion_unsupported
to readme. - Added
client_camera
andsdk_unsupported
to default English language file: https://github.com/iProov/web/blob/master/iproov-en.json.
Changed
- Various changes have been made to feedback and reason values within the
error
andfailure
event details that are passed back to match the documentation.user_timeout
is nowfailure_user_timeout
and only passed within thefailed
event. This was being triggered as anerror
event when the token had been used before or was invalid which has now been replaced witherror_expired_token
.error_camera
is nowclient_camera
which is fired when the device camera does not provide video for 8 seconds.
- The SDK has been split out into constituent chunks which are lazy loaded on demand. This increases page speed.
v3.1.10
Fixed
- Stability: internal resource lifecycle management has been improved to reduce crashes due to memory leakage.
- UX: touch scrolling is now blocked between the started event and exiting fullscreen.
- UX: Page jank when entering fullscreen, particularly in Chrome, has been fixed - see changes.
- Allow landscape: an issue causing broken images in the rotate slot has been fixed.
- Cameras: An issue where mobile devices could choose the environment facing camera has been fixed.
- Safari Desktop:
AbortError
is now handled. These cases remain subject to video data timeout checks.
Changed
started
event behaviour has been changed in a BC-safe way to reduce page jank:- The
started
event is now sent after entering fullscreen rather than in parallel - The
started
slot manager callback no longer hides all slots when entering fullscreen. - The
streaming
event is the soonest event that all slots are hidden.
- The
- Internal UI lifecycle management has been tidied which may yield a slight improvement in UI performance.
v3.1.9
Fixed
- Problems entering fullscreen will no longer abort the transaction. In these rare cases, transactions will be allowed to continue.
- Opera Touch is now a supported browser after working around a WebKit issue.
- When running Web SDK inside a react-native-webview, it no longer flags the environment as unsupported.
Internals
- The following are now sent to the backend to improve telemetry and customer support:
- When Web SDK detects it's within an iframe, the window innerWidth and innerHeight are sent.
- Fullscreen status is sent.
3.1.8
20.4.2021 3.1.8
Fixed
- When a user cancels inside Native Bridge, the
cancelled
event is now correctly triggered from the Web SDK. - UI text overflow is now elegantly managed, rather than clipping at the edges.
- Speculative fix to some Android webview environments crashing due to an
undefined
browser name. - Liveness transactions no longer experience UX issues when rotating to and from landscape orientation.
- The SDK will issue a clear error message if it receives an invalid looking token to the SDK, rather than displaying a server error.
- The
unsupported
event now aborts the claim with adevice_unsupported
code which will aid analytics.
3.1.7
14.4.2021 3.1.7
Fixed
is_native_bridge
property restored to event payloads. Previously this was only present during native bridge claims.- Fixed
streamed
event to fire when all video frames have streamed. Previously this erroneously fired after encoding.
3.1.6
5.3.2021 3.1.6
Fixed
- Fixed UI animation loop not always stopping
- Improve scanline synchronisation with flashing
- Various performance improvements
Changed
- Optimised UI opening / rotation experience
3.1.5
4.3.2021 3.1.5
Fixed
- Fixed starting in landscape orientation then rotating to portrait UI issues
- Improved GPA flash timing, particularly on Android
- Improved low FPS detection
- Added missing
feedback
property from some error events - Fixed documentation to correctly reflect
error_fullscreen_change
anderror_no_face_found
event names - Fixed instances when rare Android Native SDK crashes may take the Web SDK with them, too
- Fixed occasional
.emit
function not found errors - Fixed issues when lower end Android cameras were unable to request a video feed in a useful aspect ratio
Added
- Added
error_no_face_found
to public documentation
3.1.4
12.2.2021 3.1.4
Fixed
- Fixed an issue where the progress bar would not display if
show_countdown
is enabled. - Fixed
kiosk_mode
issue on iPads where the camera is drawn partly off screen. - Fixed an issue where the camera remains active after a timeout occurs.
- Fixed an issue where multiple cameras broadcasts multiple times. It now broadcasts once.
- Fixed an issue where slot encapsulation was broken and events may be bound to slots outside the component.
- Fixed iPads on iOS < 14 showing as unsupported in 3.1.x.
- Fixed an issue where specifying a path with base_url was not respected.
- Fixed an issue where iframed Web SDK components time out waiting for gyro information in mobile Safari.
- This is a WebKit issue: https://bugs.webkit.org/show_bug.cgi?id=221399
- Until this is fixed, iframed components in mobile Safari will immediately fire the unsupported event when using Liveness.
Changed
- Internals: changed Web Component attachment mode to closed.
- Internals: the Web SDK will now connect and emit console warnings and errors to our Socket.IO server for quality improvement and crash analysis.
- Bundle size: the main Web SDK entrypoint no longer includes Baidu and KaiOS build targets
- These browsers currently do not support our minimum requirements
- The iProovSupport component is still built to target these browsers so you can still establish support
- The main package size has reduced by 18% with no material change to browser support
Added
- 20% more π
3.1.3
6.1.2021 3.1.3
Fixed
- Fixed desktop Safari issue when starting in certain camera resolutions.