bry-biometric-collector 2.2.23 → 2.2.24

package/README.md

@@ -191,6 +191,12 @@ Currently supported tag parameters:
 
   Example: `show_justification_field=false`
 
+- **min_eye_to_eye_dist**: The minimum distance between the eyes that should be accepted on face collector.
+
+  Default: `0`
+
+  Example: `min_eye_to_eye_dist=50`
+
 ### **Run-time Configuration**
 
 #### **Functions**
@@ -231,6 +237,8 @@ The Web-component exports a series of functions that the host environment may ca
 
 - **reset**: Completely resets the web component to its startup state. Unlike clear, this function doesn't depend on finger selected state.
 
+- **$destroy**: Removes the web component from the DOM and triggers all onDestroy handlers, also stops the camera on face collector.
+
 - **setExportEnableStrategy**: Sets the export buttons enable strategy. The available strategies are subdivied into 3 groups. The CollectedFingersExportEnableStrategy, the BadFingersExportEnableStrategy, and the FaceExportStrategy. The first one defines how the fingers should be captured and how many. The second one fulfills the edge case, when no finger can be captured. The third one affects the behaviour when the face capture is involved. When evaluating wether to turn the export button on or not, first we check the first strategy, and if it doesn't turn on, then evauluate the second strategy, and then the third. The last two strategies will not override the first one to turn the button off, only on. The CollectedFingersExportEnableStrategy accepts the following values:
 
   - ALWAYS_ON
@@ -529,6 +537,12 @@ The web component listens to and emits a few events. The events emitted are:
   * only if liveness_enable=true
 ```
 
+- **low-quality-face**: When the photo is captured and the distance between the eyes is below the minimum required (min_eye_to_eye_dist), this event is emitted.
+
+```ts
+  {detail: {bodyParts[{bodyPart: 'FACE', minEyeToEyeDist: number, capturedEyeToEyeDist: number}], errorCode: string, translatedError: string}}
+```
+
 - **export-face**: When the user saves their face (by clicking finish), an event of this kind is emitted with their picture like so:
 
 ```ts
@@ -553,7 +567,7 @@ The web component listens to and emits a few events. The events emitted are:
 
 - **document-scrapped**: When the user scraps their document photo (by clicking capture again after having saved their picture) this event gets emitted without any data.
 
-- **export-document**: When the user saves their document photo (by clicking finish), an event of this kind is emitted with their picture like so:
+- **export-document**: When the user saves their document photo (by clicking finish), an event of this kind is fired with their picture like so:
 
 ```ts
   {detail: {bodyPart: 'DOCUMENT', data: string, justification: string}}
@@ -567,6 +581,12 @@ And the events the webcomponent listens to are:
 dispatchEvent(new CustomEvent('change-tabs', { detail: 'Face' }));
 ```
 
+- **extension-error**: When extension errors are caught, this event is fired . The data is exported like so:
+
+```ts
+  {detail :{code: number,  description: string, key: string  }};
+```
+
 ## **Slots**
 
 Due to the computational power required to find finger matches in the browser, the main thread gets stuck when a finger is scanned. To circumvent this, the web-component uses a gif with a delay to show the gif before computation begins. As a way for the user to not lose the ability to customize the loading gif, we implemented a slot. This way, the loading gif and its accompanying text can be completely overhauled. To override the loading gif, the passed-in element's `slot` property must be set to `validating-fingerprint-gif`. Below we provide an example of how to do that.
@@ -579,7 +599,11 @@ Due to the computational power required to find finger matches in the browser, t
   enable_minutiae="true"
   collector_select="BOTH"
 >
-  <img slot="validating-fingerprint-gif" src="https://www.w3schools.com/html/programming.gif" alt="" />
+  <img 
+  slot="validating-fingerprint-gif" 
+  src="https://www.w3schools.com/html/programming.gif" 
+  style="height: 100px; width: 100px;" 
+  alt="" />
 </biometric-collector>
 ```