@richard.fadiora/liveness-detection 5.0.4 → 5.1.0

package/README.md

@@ -1,8 +1,8 @@
-# Liveness Detection SDK v5.0.2
+# Liveness Detection SDK v5.1.0
 
-A high-security, cross-framework **Liveness Detection SDK** designed for financial services. v5.0.2 introduces **Temporal Identity Locking** to prevent identity switching during the verification process.
+A high-security, cross-framework **Liveness Detection SDK** designed for financial services. v5.1.0 introduces **Temporal Identity Locking** to prevent identity switching during the verification process.
 
-## 🔒 New Security Protocols (v5.0.2)
+## 🔒 New Security Protocols (v5.1.0)
 
 This version introduces a "Zero-Trust" frontend architecture:
 
@@ -118,7 +118,7 @@ TypeScript
 
 * * *
 
-## 🚨 Updated Error Reference (v4.4.0)
+## 🚨 Updated Error Reference (v5.1.0)
 
 The following codes are now emitted by the frontend engine **instantly**, without hitting the backend:
 
@@ -129,6 +129,20 @@ The following codes are now emitted by the frontend engine **instantly**, withou
 | Security violation: Identity mismatch. | Biometric ratios shifted significantly mid-session. | Prevents mid-stream person-swapping. |
 | Another session is active. | User has the verification open in another tab. | Prevents multi-device brute forcing. |
 
+* * *
+### ⚠️ Security Warnings & Temporary Interruption
+
+Version 5.0.2 implements a non-fatal warning system for non-critical security events (e.g., fleeting obscuration).
+
+*   **Temporary Interruption**: If a security violation occurs (e.g., face obscured), the `LivenessEngine` will pause detection for **2 seconds** to allow the user to adjust their position.
+    
+*   **Warning Counter**: The engine tracks these events using `warningCount`. If the violations exceed `MAX_WARNINGS` (default: 3), the session will trigger a `failInstantly` event.
+    
+*   **State Feedback**: During the 2-second pause, the `errorMsg` property in `LivenessState` will be populated with a temporary notification (e.g., _"Please ensure both ears are fully visible. (Warning 1/3)"_).
+    
+
+**Best Practice:** Always subscribe to `onStateChange` in your UI layer to ensure your user-facing components react to the `errorMsg` text.
+
 * * *
 
 ## 🏗️ Architectural Flow
@@ -148,7 +162,7 @@ These images are cropped to **224x224px** focusing on the face, making them opti
 
 * * *
 
-## 🔧 Integration Notes for v5.0.2
+## 🔧 Integration Notes for v5.1.0
 
 *   **WASM Path**: Ensure your server allows cross-origin requests for the MediaPipe `.wasm` files hosted on JSDelivr.