From 4cc7fc17a7ba3009bb0e7a30e2592cb923cc49b8 Mon Sep 17 00:00:00 2001
From: Will Morgan <will@willmorgan.co.uk>
Date: Fri, 12 Feb 2021 17:10:37 +0000
Subject: [PATCH] 3.1.4

---
 CHANGELOG.md                 | 27 ++++++++++++++++++++
 README.md                    | 49 ++++++++++++++++++++----------------
 demo/src/static/package.json |  2 +-
 demo/src/static/yarn.lock    |  8 +++---
 4 files changed, 60 insertions(+), 26 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3288a80..7e6505c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,33 @@ 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).
 
+## 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 π
 
 ## 6.1.2021 3.1.3
 
diff --git a/README.md b/README.md
index 8b35f03..b793170 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# iProov Biometrics Web SDK v3.1.3
+# iProov Biometrics Web SDK v3.1.4
 
 ## 📖 Table of contents
 
@@ -295,6 +295,7 @@ The simplest way to add a slot is to include it within the `<iproov-me>` HTML ta
 You can also build up the slots with the `<template>` element and JavaScript before injecting the Web Component:
 
 Template to be placed anywhere in your page:
+
 ```html
 <template id="iproov_template">
   <div slot="ready">
@@ -307,6 +308,7 @@ Template to be placed anywhere in your page:
 ```
 
 JavaScript:
+
 ```javascript
 window.addEventListener("WebComponentsReady", function (event) {
   const iProovMe = document.createElement("iproov-me")
@@ -331,10 +333,12 @@ window.addEventListener("WebComponentsReady", function (event) {
 ```
 
 To integrate with our localization feature, use special class names in your slotted content:
-* Headings must use `.iproov-lang-heading`
-* Supplementary terms (message, reason etc) must have `.iproov-lang-term`
+
+- Headings must use `.iproov-lang-heading`
+- Supplementary terms (message, reason etc) must have `.iproov-lang-term`
 
 **Example:** The below text will be swapped with the correctly localized strings when displayed:
+
 ```html
 <div slot="passed">
   <h3 class="iproov-lang-heading">Passed</h3>
@@ -384,22 +388,24 @@ Every event has a [detail](https://developer.mozilla.org/en-US/docs/Web/API/Cust
 
 The available events are detailed below with any extra properties that are supplied:
 
-| Event                   | Extra Properties                 | Description                                                                                               |
-| ----------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| **cancelled**           | _feedback, reason_               | User has cancelled iProov by exiting fullscreen                                                           |
-| **error**               | _feedback, reason_               | iProov encountered an error while processing the authentication                                           |
-| **failed**              | _type, passed, feedback, reason_ | Authentication was unsuccessful, the user needs to try again                                              |
-| **interrupted**         | _feedback, reason_               | Fast fullscreen exit possible due to software. Retry is possible.                                         |
-| **multiple_cameras** \* | _devices, device_selector, slot_ | If `enable_camera_selector` is `true` returns an array of devices if more than 1 video device is detected |
-| **passed**              | _type, passed_                   | Authentication was successful, the result can now be validated                                            |
-| **permission**          | None                             | Camera permission is unknown & not blocked, show permission                                               |
-| **permission_denied**   | None                             | User has blocked access to the camera                                                                     |
-| **progress**            | _progress, 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                                                                     |
+| Event                   | Extra Properties                 | Description                                                                                                                                           |
+| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **cancelled**           | _feedback, reason_               | User has cancelled iProov by exiting fullscreen                                                                                                       |
+| **connecting**          | None                             | The SDK is connecting to the server. You should provide an indeterminate progress indicator to let the user know that the connection is taking place. |
+| **connected**           | None                             | The SDK has connected. You should hide any progress indication at this point.                                                                         |
+| **error**               | _feedback, reason_               | iProov encountered an error while processing the authentication                                                                                       |
+| **failed**              | _type, passed, feedback, reason_ | Authentication was unsuccessful, the user needs to try again                                                                                          |
+| **interrupted**         | _feedback, reason_               | Fast fullscreen exit possible due to software. Retry is possible.                                                                                     |
+| **multiple_cameras** \* | _devices, device_selector, slot_ | If `enable_camera_selector` is `true` returns an array of devices if more than 1 video device is detected                                             |
+| **passed**              | _type, passed_                   | Authentication was successful, the result can now be validated                                                                                        |
+| **permission**          | None                             | Camera permission is unknown & not blocked, show permission                                                                                           |
+| **permission_denied**   | None                             | User has blocked access to the camera                                                                                                                 |
+| **progress**            | _progress, 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                                                                                                                 |
 
 > \* See [Multiple Camera Example](https://github.com/iProov/web/wiki/Camera-Selection-Example) for an example demonstrating how a camera selection feature could be implemented.
 
@@ -527,8 +533,8 @@ window.addEventListener("WebComponentsReady", (event) => {
   iProovMe.setAttribute("token", "***YOUR_TOKEN_HERE***")
 
   const customLanguage = {
-    "passed": "You passed!",
-    "prompt_connecting": "It's loading..."
+    passed: "You passed!",
+    prompt_connecting: "It's loading...",
   }
   element.setAttribute("language", JSON.stringify(customLanguage))
 
@@ -598,6 +604,7 @@ Using `iProovSupport` on a standalone basis means that consumers can code split
 We recommend using this pattern and splitting entrypoints on your app so that iProov is downloaded only when necessary to ensure a quick UX.
 
 **Example usage when using a bundler that treats UMD like ESM:**
+
 ```javascript
 import { iProovSupport } from "@iproov/web/iProovSupport.js"
 const optionalLogger = console
diff --git a/demo/src/static/package.json b/demo/src/static/package.json
index cba9934..6543694 100644
--- a/demo/src/static/package.json
+++ b/demo/src/static/package.json
@@ -7,6 +7,6 @@
   "author": "",
   "devDependencies": {},
   "dependencies": {
-    "@iproov/web": "^3.1.3"
+    "@iproov/web": "latest"
   }
 }
diff --git a/demo/src/static/yarn.lock b/demo/src/static/yarn.lock
index 28bdb3b..5b1e0f1 100644
--- a/demo/src/static/yarn.lock
+++ b/demo/src/static/yarn.lock
@@ -2,7 +2,7 @@
 # yarn lockfile v1
 
 
-"@iproov/web@^3.1.2":
-  version "3.1.2"
-  resolved "https://registry.yarnpkg.com/@iproov/web/-/web-3.1.2.tgz#c05d2582d976bff74464b46ac5cfeae64f9a924d"
-  integrity sha512-hvw0767mLEHNZvEhppH+5aaDeWzUMHp5h58zJtMqFR3GwmGiFr+4USEUeHFXOg3r1n+ESCGcaDKz2Qabsg8URw==
+"@iproov/web@latest":
+  version "3.1.4"
+  resolved "https://registry.yarnpkg.com/@iproov/web/-/web-3.1.4.tgz#bb8b0c7507303f348b899c76d79875c14f977d1e"
+  integrity sha512-B9Bw/yKX0HhktPDjkQWnCSNTQaMqfIopxUvfaBFMUuDSanCHV0s+3Kk3tz7rNdM65JY4BbE/oIu40M5Az+ug4Q==