diff --git a/CHANGELOG.md b/CHANGELOG.md index ddbf7fd..fe8abec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added the `csp_nonce` option. See [Content Security Policy](https://github.com/iProov/web/wiki/Content-Security-Policy). - External dependencies are now loaded with `` for non-blocking parallel loading. - Our feature detector now runs the latest Tensorflow release which includes support for WebAssembly threads and SIMD. +- New `streamed` event to accommodate the original documented functionality. ## Fixed @@ -44,13 +45,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Tweaks to UI to bring the UI experience inline with native SDKs. - Improved our encoder for better speed and the latest bugfixes. - Bandwidth usage reduced +- The `streamed` event now emits at the correct time, which may break integrations that rely upon it. + - To upgrade, replace `streamed` with `streaming` which takes its place. ## Removed +- Bundled Web Component support. Polyfills are now loaded on an as-needed basis. - Automatic transpilation for the following outdated browsers: - Blackberry < 10 - - Edge < 84 - - Firefox < 80 + - Edge < 85 + - Firefox < 82 - IE < 11 - IE Mobile (all) - iOS Safari < 13.4 diff --git a/README.md b/README.md index 6bdcea8..90c43b9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# iProov Biometrics Web SDK v3.1.0-beta.4 +# iProov Biometrics Web SDK v3.1.0-beta.5 ## 📖 Table of contents @@ -396,6 +396,7 @@ The available events are detailed below with any extra properties that are suppl | **progress** | _percentage, message_ | iProov has published a progress update for the authentication | | **ready** | None | iProov has initialised successfully and has camera permission | | **started** | None | User has started iProov by launching into fullscreen | +| **streaming** | None | User has started streaming. The client remains in fullscreen. | | **streamed** | None | User has finished streaming and the client has exited fullscreen | | **unsupported** | _feedback, reason_ | Browser does not support using iProov | @@ -468,6 +469,7 @@ iProovMe.addEventListener("ready", iProovEvent) iProovMe.addEventListener("started", iProovEvent) iProovMe.addEventListener("cancelled", iProovEvent) iProovMe.addEventListener("interrupted", iProovEvent) +iProovMe.addEventListener("streaming", iProovEvent) iProovMe.addEventListener("streamed", iProovEvent) iProovMe.addEventListener("progress", iProovEvent) iProovMe.addEventListener("passed", iProovEvent) diff --git a/examples/html.html b/examples/html.html index 51c1106..212b964 100644 --- a/examples/html.html +++ b/examples/html.html @@ -23,7 +23,7 @@ component.addEventListener('ready', iProovEvent); component.addEventListener('started', iProovEvent); component.addEventListener('aborted', iProovEvent); - component.addEventListener('streamed', iProovEvent); + component.addEventListener('streaming', iProovEvent); component.addEventListener('progress', iProovEvent); component.addEventListener('passed', iProovEvent); component.addEventListener('failed', iProovEvent); diff --git a/script.js b/script.js index 88c509d..7f9970a 100644 --- a/script.js +++ b/script.js @@ -58,7 +58,7 @@ function injectIproov(data){ $('.loading').removeClass('show'); }); - $(component).on('ready permission started aborted streamed progress passed failed error unsupported', iProovEvent); + $(component).on('ready permission started aborted streaming progress passed failed error unsupported', iProovEvent); } function iProovProgress(event) {