@richard.fadiora/liveness-detection 3.0.3 → 3.1.0

package/README.md

@@ -2,7 +2,11 @@
 
 A React-based liveness detection component that performs randomized user challenges and verifies real-user presence via a backend anti-spoofing API.
 
-This version introduces **headless mode**, **render-prop customization**, and robust **challenge sequencing**, allowing you to fully control the UI while keeping the verification logic encapsulated.
+This version introduces **headless mode**, **render-prop customization**, and robust **challenge sequencing**, **configurable thresholds** for `Smile`, `Blink`, and `Turn_Head` challenges
+
+Pause between steps for user feedback
+
+Sequential challenge execution with strict timeout handling allowing you to fully control the UI while keeping the verification logic encapsulated.
 
 ---
 
@@ -14,7 +18,8 @@ This component strengthens identity verification by combining:
 - Strict timeout enforcement  
 - Backend spoof detection  
 - Callback-based integration for easy usage  
-- Headless / fully customizable UI via render props  
+- Headless / fully customizable UI via render props
+- Configurable challenge thresholds to adapt difficulty  
 
 It protects against:
 
@@ -38,6 +43,14 @@ It protects against:
 - Real-time validation using webcam input and MediaPipe models.  
 - Sequential verification ensures **no steps are skipped**.  
 - Developers can render custom UI via the **render prop** while using the same underlying logic.
+- Challenge thresholds are configurable through props:
+
+| Prop Name             | Default | Description                              |
+|-----------------------|---------|------------------------------------------|
+| `smileThreshold`      | 0.20    | Minimum smile width to count as valid    |
+| `blinkThreshold`      | 0.01    | Maximum eye aspect ratio to count as blink |
+| `minturnHeadThreshold`| 0.15    | Minimum yaw for right head turn detection      |
+| `maxturnHeadThreshold`| 0.85    | Maximum yaw for left head turn detection      |
 
 ### 3️⃣ Backend Liveness Verification
 
@@ -76,6 +89,11 @@ onError({ success: false, reason, skinConfidence: null });
 | `duration` | `number`                     | No       | Maximum time for all challenges (default: 60s) |
 | `render`   | `(sdk: object) => JSX.Element` | No      | Optional render prop for full UI customization |
 | `classNames` | `object`                   | No       | Optional CSS class names to customize default UI |
+| `smileThreshold`       | `number`     | No       | Minimum smile width for Smile challenge                  |
+| `blinkThreshold`       | `number`     | No       | Maximum eye aspect ratio for Blink challenge             |
+| `minturnHeadThreshold` | `number`     | No       | Minimum yaw for Turn_Head challenge                      |
+| `maxturnHeadThreshold` | `number`     | No       | Maximum yaw for Turn_Head challenge                      |
+
 
 ---
 
@@ -126,6 +144,7 @@ classNames={{
   container: "liveness-container",
   webcam: "liveness-webcam",
   button: "liveness-button",
+  challenge: "liveness-challenge",
   timer: "liveness-timer",
   error: "liveness-error",
   success: "liveness-success",
@@ -158,6 +177,11 @@ classNames={{
   cursor: pointer;
   margin-top: 10px;
 }
+.liveness-challenge {
+  margin: 5px 0;
+  font-weight: bold;
+  font-size: 40px;
+}
 .liveness-timer {
   margin: 10px 0;
   font-weight: bold;
@@ -203,7 +227,7 @@ classNames={{
 
 - Webcam permissions required  
 - Backend must accept 5 frames in expected format  
-- `apiUrl` must be reachable and have an endpoint `v1/verify` 
+- `apiUrl` must be reachable and have an endpoint `/v1/verify` 
 - CORS must be configured properly
 
 ---