bry-biometric-collector - npm Package Compare versions

Comparing version 2.2.23 to 2.2.24

dist/bry-biometric-collector-main.js

@@ -1,4 +0,4 @@
-import { bb as e } from "./main_af3a4af6_2.2.23.js";
+import { bd as e } from "./main_0c38f58d_2.2.24.js";
 export {
   e as default
 };

dist/index.d.ts

@@ -40,3 +40,4 @@ export interface livenessResult {
   SHOW_UNCONFORMITIES = 'show_unconformities',
-  VIDEO_FILTER = 'video_filter',
+  VIDEO_OVERLAY = 'video_overlay',
+  VIDEO_OVERLAY_TRANSPARENCY= 'video_overlay_transparency',
   SHOW_CONFIG_BUTTON = 'show_config_button',
@@ -46,3 +47,4 @@ SHOW_AUTO_CAPTURE_BUTTON = 'show_auto_capture_button',
   LANGUAGE = 'language',
-  SHOW_JUSTIFICATION_FIELD = 'show_justification_field'
+  SHOW_JUSTIFICATION_FIELD = 'show_justification_field',
+  MIN_EYE_TO_EYE_DIST = 'MIN_EYE_TO_EYE_DIST'
 }
@@ -105,2 +107,12 @@
 }>;
+export type lowQualityFaceEvent = CustomEvent<{
+  bodyParts: BodyPart[];
+  errorCode: string;
+  translatedError: string;
+}>;
+export type extensionErrorEvent = CustomEvent<{
+  code: number;
+  description: string;
+  key: string;  
+}>;
 
@@ -141,3 +153,4 @@ declare global {
     [Props.SHOW_UNCONFORMITIES]: string;
-    [Props.VIDEO_FILTER]: string;
+    [Props.VIDEO_OVERLAY]: string;
+    [Props.VIDEO_OVERLAY_TRANSPARENCY]: number;
     [Props.SHOW_CONFIG_BUTTON]: string;
@@ -148,2 +161,3 @@ [Props.SHOW_AUTO_CAPTURE_BUTTON]: string;
     [Props.SHOW_JUSTIFICATION_FIELD]: string;
+    [Props.MIN_EYE_TO_EYE_DIST]: number;
     /**
@@ -232,3 +246,5 @@ * Clears fingers and face, to make ready for a new collection.
     'document-unconformities-validated': documentUnconformitiesValidated;
+    'low-quality-face': lowQualityFaceEvent;
+    'extension-error': extensionErrorEvent;
   }
 }

dist/index.js

@@ -1,4 +0,4 @@
-import { bb as e } from "./main_af3a4af6_2.2.23.js";
+import { bd as e } from "./main_0c38f58d_2.2.24.js";
 export {
   e as default
 };

package.json

@@ -5,3 +5,3 @@ {
   "description": "BRy web-collector component for biometric capture.",
-  "version": "2.2.23",
+  "version": "2.2.24",
   "main": "dist/bry-biometric-collector-main.js",
@@ -8,0 +8,0 @@ "type": "module",

README.md

@@ -194,2 +194,8 @@ # **Web Component Collector**
 
+- **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**
@@ -235,2 +241,4 @@
 
+- **$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:
@@ -534,2 +542,8 @@
 
+- **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:
@@ -559,3 +573,3 @@
 
-- **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:
 
@@ -574,2 +588,8 @@ ```ts
 
+- **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**
@@ -587,3 +607,7 @@
 >
-  <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>
@@ -590,0 +614,0 @@ ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5916681

increased by0.02%

Lines of code

83471

increased by0.03%

Number of lines in readme file

724

increased by3.43%

Number of low supply chain risk alerts

1

decreased by-50%

No dependency changes