react-native-vision-camera-spoof-detector 1.0.27 → 1.0.28

package/README.md

@@ -20,9 +20,10 @@ High-performance face anti-spoofing and liveness detection module for React Nati
 ## 📋 Requirements
 
 - React Native >= 0.60.0
-- react-native-vision-camera >= 4.6.4
-- react-native-reanimated >= 3.0.0
-- react-native-worklets-core >= 1.0.0
+- React Native Vision Camera `^4.6.4` or `^5.0.0`
+- `react-native-reanimated` `^3.0.0`
+- `react-native-worklets-core` `^1.0.0`
+- iOS 11.0 or later
 - react-native-vision-camera-face-detector (optional, for enhanced features)
 
 ## 📦 Installation
@@ -43,7 +44,26 @@ npm install react-native-vision-camera react-native-reanimated react-native-work
 yarn add react-native-vision-camera react-native-reanimated react-native-worklets-core
 ```
 
-### Step 3: Configure Android (if not auto-linked)
+### Step 3: Configure iOS
+
+Install the CocoaPods dependencies from the iOS directory:
+
+```bash
+cd ios
+pod install
+cd ..
+```
+
+Add a camera usage description to `ios/<YourApp>/Info.plist`:
+
+```xml
+<key>NSCameraUsageDescription</key>
+<string>This app uses the camera for face liveness verification.</string>
+```
+
+Open the generated `.xcworkspace` in Xcode, or run the app with the React Native CLI. The package pod bundles `FaceAntiSpoofing.tflite` and declares its `TensorFlowLiteSwift` and `VisionCamera` dependencies automatically. No manual model copy is required.
+
+### Step 4: Configure Android (if not auto-linked)
 
 Add to `android/app/build.gradle`:
 
@@ -53,7 +73,7 @@ dependencies {
 }
 ```
 
-### Step 4: Link native module (for React Native < 0.60)
+### Step 5: Link native module (for React Native < 0.60)
 
 ```bash
 react-native link react-native-vision-camera-spoof-detector
@@ -61,24 +81,31 @@ react-native link react-native-vision-camera-spoof-detector
 
 ## 🚀 Quick Start
 
+> **Important:** Request camera permission before rendering `Camera`, and call `initializeFaceAntiSpoof()` once before the frame processor starts. The frame processor returns `null` until native initialization or a result is available. Native inference is throttled and may return the most recent result while another frame is being processed.
+
 ### Simple Usage
 
 ```javascript
 import React, { useEffect, useState } from 'react';
 import { StyleSheet, Text, View } from 'react-native';
-import { Camera, useCameraDevices, useFrameProcessor } from 'react-native-vision-camera';
+import { Camera, useCameraDevices, useCameraPermission, useFrameProcessor } from 'react-native-vision-camera';
 import { faceAntiSpoofFrameProcessor, initializeFaceAntiSpoof } from 'react-native-vision-camera-spoof-detector';
 import { runOnJS } from 'react-native-reanimated';
 
 export default function App() {
   const devices = useCameraDevices();
   const device = devices.front;
+  const { hasPermission, requestPermission } = useCameraPermission();
   const [spoofResult, setSpoofResult] = useState(null);
 
   useEffect(() => {
-    initializeFaceAntiSpoof().then((success) => {
-      console.log('FaceAntiSpoof initialized:', success);
-    });
+    if (!hasPermission) requestPermission();
+  }, [hasPermission, requestPermission]);
+
+  useEffect(() => {
+    initializeFaceAntiSpoof()
+      .then((success) => console.log('FaceAntiSpoof initialized:', success))
+      .catch((error) => console.error('FaceAntiSpoof initialization failed:', error));
   }, []);
 
   const frameProcessor = useFrameProcessor((frame) => {
@@ -89,7 +116,7 @@ export default function App() {
     }
   }, []);
 
-  if (device == null) return <Text>Loading...</Text>;
+  if (!hasPermission || device == null) return <Text>Waiting for camera permission...</Text>;
 
   return (
     <View style={styles.container}>
@@ -292,14 +319,14 @@ const result = faceAntiSpoofFrameProcessor(frame);
 
 **Parameters**: `frame` (Vision Camera Frame)
 
-**Returns**: `FaceAntiSpoofingResult | null`
+**Returns**: `FaceAntiSpoofingResult | null`. On iOS, inference runs off the frame callback and the returned object can be the latest completed result.
 
 ### `FaceAntiSpoofingResult`
 
 ```typescript
 interface FaceAntiSpoofingResult {
   isLive: boolean;              // Real face (true) or spoof (false)
-  label: string;                // "Live Face" or "Spoof Face"
+  label: string;                // Usually "live", "spoof", or "error"
   neuralNetworkScore: number;   // 0.0-1.0 confidence
   laplacianScore: number;       // Image quality score
   combinedScore: number;        // Weighted average
@@ -331,11 +358,7 @@ const FACE_CENTER_THRESHOLD_Y = 0.15;         // Y-axis tolerance
 
 ## 🎮 Complete Examples
 
-Check the [examples](./examples) folder for:
-- Basic anti-spoofing detection
-- Face detection with liveness
-- Complete capture flow
-- UI components and feedback
+The [Quick Start](#-quick-start) above shows the basic frame-processor integration. For the complete capture flow, face detection, liveness, and UI patterns, see the [project wiki](https://github.com/dpraful/react-native-vision-camera-spoof-detector/wiki).
 
 ## 🔍 Attack Detection Capabilities
 
@@ -363,8 +386,8 @@ Performance depends on:
 
 | Platform | Status | GPU | Notes |
 |----------|--------|-----|-------|
-| Android  | ✅ Supported | Yes | Fully optimized |
-| iOS      | ⏳ In Progress | Yes | Coming soon |
+| Android  | ✅ Supported | Yes | TensorFlow Lite model bundled in the AAR |
+| iOS      | ✅ Supported | CPU | Requires CocoaPods and iOS 11+ |
 | Web      | ❌ No | N/A | Not applicable |
 
 ## 🐛 Troubleshooting
@@ -377,11 +400,15 @@ if (!available) {
 }
 ```
 
+- iOS: run `pod install` from the `ios` directory and rebuild the app from the generated workspace.
+- iOS: verify `NSCameraUsageDescription` exists in the app's `Info.plist`.
+- Check the initialization promise result and inspect the native logs for model-loading errors.
+
 **Low accuracy**
 - Check lighting conditions
 - Ensure face is centered
 - Adjust `antispooflevel` parameter
-- Verify TensorFlow Lite models are bundled
+- Verify the `FaceAntiSpoofing.tflite` model is bundled (the package does this automatically on iOS)
 
 **Performance issues**
 - Reduce frame processing frequency
@@ -397,10 +424,9 @@ if (!available) {
 
 ## 📖 Documentation
 
-- [Complete API Documentation](./.docs/API.md)
-- [Migration Guide](./.docs/MIGRATION.md)
-- [Best Practices](./.docs/BEST_PRACTICES.md)
-- [Comprehensive Example](./examples/CompleteExampleApp.tsx)
+- [Project Wiki](https://github.com/dpraful/react-native-vision-camera-spoof-detector/wiki)
+- [Changelog](./CHANGELOG.md)
+- [Contributing Guide](./CONTRIBUTING.md)
 
 ## 🤝 Contributing
 

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -1,2 +1,2 @@
-#Thu Sep 03 17:04:14 IST 2026
+#Thu Sep 03 17:06:38 IST 2026
 gradle.version=8.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-vision-camera-spoof-detector",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "description": "High-performance face anti-spoofing and liveness detection module for React Native Vision Camera. Uses TensorFlow Lite with GPU acceleration and optimized YUV processing.",
   "homepage": "https://github.com/dpraful/react-native-vision-camera-spoof-detector",
   "repository": {