@capgo/capacitor-document-scanner 8.3.10 → 8.3.11

package/README.md

@@ -29,6 +29,22 @@ npm install @capgo/capacitor-document-scanner
 npx cap sync
 ```
 
+## Important Notes
+
+### Android Emulator Limitations
+
+The ML Kit Document Scanner **does not work on Android emulators**. This is a limitation of Google Play Services and ML Kit on emulated devices. When testing your app:
+
+- ✅ Use a **physical Android device** for testing document scanning
+- ❌ Android emulators will show an error: "Document scanner is not supported on Android emulators"
+
+This limitation is due to:
+- Google Play Services compatibility issues with emulator environments
+- ML Kit Document Scanner requiring actual hardware camera capabilities
+- Emulators lacking the necessary ML Kit runtime components
+
+**For development and testing, always use a real Android device.**
+
 ## Demo
 
 ### Scanning one note

package/android/build.gradle

@@ -3,6 +3,7 @@ ext {
     androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
     androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
     androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+    playServicesBaseVersion = project.hasProperty('playServicesBaseVersion') ? rootProject.ext.playServicesBaseVersion : '18.5.0'
 }
 
 buildscript {
@@ -53,6 +54,7 @@ dependencies {
     implementation project(':capacitor-android')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     implementation "com.google.android.gms:play-services-mlkit-document-scanner:16.0.0"
+    implementation "com.google.android.gms:play-services-base:$playServicesBaseVersion"
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"

package/android/src/main/java/app/capgo/plugin/document_scanner/DocumentScannerPlugin.java

@@ -23,6 +23,8 @@ import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
+import com.google.android.gms.common.ConnectionResult;
+import com.google.android.gms.common.GoogleApiAvailability;
 import com.google.mlkit.vision.documentscanner.GmsDocumentScanner;
 import com.google.mlkit.vision.documentscanner.GmsDocumentScannerOptions;
 import com.google.mlkit.vision.documentscanner.GmsDocumentScanning;
@@ -93,7 +95,7 @@ public class DocumentScannerPlugin extends Plugin {
             return;
         }
 
-        // Check if running on emulator
+        // Check if running on emulator first (doesn't require activity reference)
         if (isRunningOnEmulator()) {
             call.reject(
                 "Document scanner is not supported on Android emulators. " +
@@ -109,6 +111,22 @@ public class DocumentScannerPlugin extends Plugin {
             return;
         }
 
+        // Check Google Play Services availability
+        GoogleApiAvailability apiAvailability = GoogleApiAvailability.getInstance();
+        int resultCode = apiAvailability.isGooglePlayServicesAvailable(activity);
+        if (resultCode != ConnectionResult.SUCCESS) {
+            StringBuilder errorMessage = new StringBuilder(
+                "The ML Kit Document Scanner requires Google Play Services, which is not available or needs an update. "
+            );
+            if (apiAvailability.isUserResolvableError(resultCode)) {
+                errorMessage.append("Please update Google Play Services and try again.");
+            } else {
+                errorMessage.append("This device may not support the document scanner.");
+            }
+            call.reject(errorMessage.toString());
+            return;
+        }
+
         int quality = clamp(call.getInt("croppedImageQuality", 100), 0, 100);
         String responseType = normalizeResponseType(call.getString("responseType"));
         int pageLimit = clamp(call.getInt("maxNumDocuments", 24), 1, 24);
@@ -419,22 +437,42 @@ public class DocumentScannerPlugin extends Plugin {
         String hardware = Build.HARDWARE.toLowerCase(Locale.ROOT);
         String board = Build.BOARD.toLowerCase(Locale.ROOT);
 
-        return (
-            fingerprint.startsWith("generic") ||
+        // Check for emulator characteristics
+        boolean isEmulator = (fingerprint.startsWith("generic") ||
             fingerprint.startsWith("unknown") ||
+            fingerprint.contains("test-keys") ||
             model.contains("google_sdk") ||
             model.contains("emulator") ||
             model.contains("android sdk built for x86") ||
+            model.contains("sdk_gphone") ||
             manufacturer.contains("genymotion") ||
             (brand.startsWith("generic") && device.startsWith("generic")) ||
             "google_sdk".equals(product) ||
             product.contains("sdk_gphone") ||
+            product.contains("sdk_google") ||
             product.contains("emulator") ||
+            product.contains("vbox") ||
             hardware.contains("ranchu") ||
             hardware.contains("goldfish") ||
             board.contains("ranchu") ||
-            board.contains("goldfish")
-        );
+            board.contains("goldfish") ||
+            board.contains("qemu"));
+
+        // Additional check: Build.SERIAL property for common emulator identifiers
+        // Emulators often have "emulator" or "unknown" in their serial number
+        if (!isEmulator) {
+            try {
+                String serial = Build.SERIAL;
+                if (serial != null) {
+                    serial = serial.toLowerCase(Locale.ROOT);
+                    isEmulator = serial.contains("emulator") || serial.equals("unknown");
+                }
+            } catch (SecurityException e) {
+                // Ignore if Build.SERIAL access is restricted (Android 8.0+)
+            }
+        }
+
+        return isEmulator;
     }
 
     @PluginMethod

package/ios/Sources/DocumentScannerPlugin/DocumentScannerPlugin.swift

@@ -3,7 +3,7 @@ import Foundation
 
 @objc(DocumentScannerPlugin)
 public class DocumentScannerPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let pluginVersion: String = "8.3.10"
+    private let pluginVersion: String = "8.3.11"
     public let identifier = "DocumentScannerPlugin"
     public let jsName = "DocumentScanner"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-document-scanner",
-  "version": "8.3.10",
+  "version": "8.3.11",
   "description": "Capacitor plugin to scan document iOS and Android",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",