@scr2em/capacitor-scanner 6.0.21 → 6.0.23

package/README.md

@@ -26,7 +26,7 @@ npx cap sync
 * [`removeAllListeners()`](#removealllisteners)
 * [`enableObjectDetection(...)`](#enableobjectdetection)
 * [`disableObjectDetection()`](#disableobjectdetection)
-* [`enableBarcodeDetection()`](#enablebarcodedetection)
+* [`enableBarcodeDetection(...)`](#enablebarcodedetection)
 * [`disableBarcodeDetection()`](#disablebarcodedetection)
 * [`zoom(...)`](#zoom)
 * [Type Aliases](#type-aliases)
@@ -183,12 +183,12 @@ removeAllListeners() => any
 ### enableObjectDetection(...)
 
 ```typescript
-enableObjectDetection({ types }: ObjectDetectionOptions) => any
+enableObjectDetection(options: ObjectDetectionOptions) => any
 ```
 
-| Param     | Type                                                                      |
-| --------- | ------------------------------------------------------------------------- |
-| **`__0`** | <code><a href="#objectdetectionoptions">ObjectDetectionOptions</a></code> |
+| Param         | Type                                                                      |
+| ------------- | ------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#objectdetectionoptions">ObjectDetectionOptions</a></code> |
 
 **Returns:** <code>any</code>
 
@@ -206,13 +206,17 @@ disableObjectDetection() => any
 --------------------
 
 
-### enableBarcodeDetection()
+### enableBarcodeDetection(...)
 
 ```typescript
-enableBarcodeDetection() => any
+enableBarcodeDetection(options?: BarcodeDetectionOptions | undefined) => any
 ```
 
-Enable barcode detection. This will start detecting barcodes and drawing overlays.
+Enable barcode detection. This will start detecting barcodes.
+
+| Param         | Type                                                                        | Description                                    |
+| ------------- | --------------------------------------------------------------------------- | ---------------------------------------------- |
+| **`options`** | <code><a href="#barcodedetectionoptions">BarcodeDetectionOptions</a></code> | - Optional configuration for barcode detection |
 
 **Returns:** <code>any</code>
 
@@ -254,7 +258,7 @@ Set the camera zoom level.
 
 #### StartOptions
 
-<code>{ /** * Barcode formats to detect when barcodeDetection is enabled. */ formats?: BarcodeFormat[]; /** * Camera direction to use. Defaults to 'BACK'. */ cameraDirection?: 'BACK' | 'FRONT'; /** * Enable barcode detection on start. Defaults to false. * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events. */ barcodeDetection?: boolean; /** * Enable object detection (business card) on start. Defaults to false. * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events. */ objectDetection?: boolean; }</code>
+<code>{ /** * Barcode formats to detect when barcodeDetection is enabled. */ formats?: BarcodeFormat[]; /** * Camera direction to use. Defaults to 'BACK'. */ cameraDirection?: 'BACK' | 'FRONT'; /** * Enable barcode detection on start. Defaults to false. * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events. */ barcodeDetection?: boolean; /** * Whether to show the highlight overlay for detected barcodes. Defaults to false. * Only applies when barcodeDetection is true. */ barcodeHighlight?: boolean; /** * Enable object detection (business card) on start. Defaults to false. * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events. */ objectDetection?: boolean; /** * Whether to show the highlight overlay for detected business cards. Defaults to true. * Only applies when objectDetection is true. */ objectHighlight?: boolean; debounceTimeInMilli?: number; /** * Optional regex pattern to filter scanned barcodes. * If provided, only barcodes matching this pattern will be reported. */ regex?: string; /** * Optional regex flags (e.g., 'i' for case-insensitive, 'm' for multiline). */ regexFlags?: string; }</code>
 
 
 #### CapturePhotoOptions
@@ -289,7 +293,12 @@ Set the camera zoom level.
 
 #### ObjectDetectionOptions
 
-<code>{ /** * Detection types to enable. Only 'businessCard' is supported. * For barcode detection, use enableBarcodeDetection() instead. */ types: ('businessCard')[], /** * Optional padding ratio to apply around detected rectangles when cropping. * Value must be between 0 and 1, where: * - 0 = no padding * - 1 = 100% padding (not recommended) * Default is 0.01 (1%) if not specified. */ paddingRatio?: number }</code>
+<code>{ /** * Detection types to enable. Only 'businessCard' is supported. * For barcode detection, use enableBarcodeDetection() instead. */ types: ('businessCard')[], /** * Optional padding ratio to apply around detected rectangles when cropping. * Value must be between 0 and 1, where: * - 0 = no padding * - 1 = 100% padding (not recommended) * Default is 0.01 (1%) if not specified. */ paddingRatio?: number, /** * Whether to show the highlight overlay for detected business cards. * Defaults to true. */ showHighlight?: boolean }</code>
+
+
+#### BarcodeDetectionOptions
+
+<code>{ /** * Whether to show the highlight overlay for detected barcodes. * Defaults to false. */ showHighlight?: boolean; }</code>
 
 
 #### ZoomOptions

package/android/src/main/java/com/leadliaion/capacitorscanner/CapacitorScannerPlugin.java

@@ -98,6 +98,7 @@ public class CapacitorScannerPlugin extends Plugin {
     private final AtomicBoolean isScanning = new AtomicBoolean(false);
     private FrameLayout containerView;
     private DetectionOverlay detectionOverlay;
+    private java.util.regex.Pattern regexFilter;
 
     private OrientationEventListener orientationEventListener;
     private Preview preview;
@@ -108,6 +109,7 @@ public class CapacitorScannerPlugin extends Plugin {
     private int currentLensFacing = CameraSelector.LENS_FACING_BACK;
 
     private final Set<String> enabledDetectionTypes = new HashSet<>();
+    private final Set<String> enabledHighlightTypes = new HashSet<>(); // Controls overlay display
     private float paddingRatio = 0.01f; // Default padding ratio of 1%
     // Add detection history for temporal smoothing
     private java.util.List<DetectionResult> recentDetectionResults = new java.util.ArrayList<>();
@@ -186,6 +188,9 @@ public class CapacitorScannerPlugin extends Plugin {
         // Read detection options (defaults to false)
         boolean enableBarcodeDetection = call.getBoolean("barcodeDetection", false);
         boolean enableObjectDetection = call.getBoolean("objectDetection", false);
+        // Read highlight options (barcode defaults to false, businessCard defaults to true)
+        boolean enableBarcodeHighlight = call.getBoolean("barcodeHighlight", false);
+        boolean enableObjectHighlight = call.getBoolean("objectHighlight", true);
 
         getActivity().runOnUiThread(() -> {
             // Stop any existing session first
@@ -196,11 +201,17 @@ public class CapacitorScannerPlugin extends Plugin {
             // Enable barcode detection if requested
             if (enableBarcodeDetection) {
                 enabledDetectionTypes.add("barcode");
+                if (enableBarcodeHighlight) {
+                    enabledHighlightTypes.add("barcode");
+                }
             }
 
             // Enable object detection (businessCard) if requested
             if (enableObjectDetection) {
                 enabledDetectionTypes.add("businessCard");
+                if (enableObjectHighlight) {
+                    enabledHighlightTypes.add("businessCard");
+                }
             }
 
             try {
@@ -215,6 +226,27 @@ public class CapacitorScannerPlugin extends Plugin {
                 // **FIX**: Ensure currentLensFacing is updated when starting the scan
                 currentLensFacing = lensFacing;
 
+                // Handle Regex Filter
+                String regexPattern = call.getString("regex");
+                if (regexPattern != null) {
+                    String flags = call.getString("regexFlags", "");
+                    int patternFlags = 0;
+                    if (flags.contains("i")) {
+                        patternFlags |= java.util.regex.Pattern.CASE_INSENSITIVE;
+                    }
+                    if (flags.contains("m")) {
+                        patternFlags |= java.util.regex.Pattern.MULTILINE;
+                    }
+                    try {
+                        regexFilter = java.util.regex.Pattern.compile(regexPattern, patternFlags);
+                    } catch (Exception e) {
+                        call.reject("Invalid Regex pattern");
+                        return;
+                    }
+                } else {
+                    regexFilter = null;
+                }
+
                 JSArray formatsArray = call.getArray("formats");
                 BarcodeScannerOptions.Builder optionsBuilder = new BarcodeScannerOptions.Builder();
 
@@ -413,8 +445,11 @@ public class CapacitorScannerPlugin extends Plugin {
                         scanner.process(image)
                                 .addOnSuccessListener(executor, barcodes -> {
                                     processBarcodes(barcodes);
-                                    displayDetectedBarcodes(barcodes, imageProxy.getWidth(), imageProxy.getHeight(),
-                                            imageProxy.getImageInfo().getRotationDegrees());
+                                    // Only display barcode overlay if highlight is enabled
+                                    if (enabledHighlightTypes.contains("barcode")) {
+                                        displayDetectedBarcodes(barcodes, imageProxy.getWidth(), imageProxy.getHeight(),
+                                                imageProxy.getImageInfo().getRotationDegrees());
+                                    }
                                 })
                                 .addOnFailureListener(executor, e -> {
                                     echo("Failed to process image for barcode: " + e.getMessage());
@@ -525,7 +560,8 @@ public class CapacitorScannerPlugin extends Plugin {
                         // This runs for both freshly detected rectangles and reused detection results
                         final DetectionResult finalResult = detectionResult;
                         getActivity().runOnUiThread(() -> {
-                            if (enabledDetectionTypes.contains("businessCard")) {
+                            // Only display rectangle overlay if highlight is enabled
+                            if (enabledHighlightTypes.contains("businessCard")) {
                                 // Show the rectangles
                                 displayDetectedRectangles(finalResult,
                                         imageProxy.getWidth(),
@@ -787,6 +823,15 @@ public class CapacitorScannerPlugin extends Plugin {
                 }
             }
             echo("Processing barcode with rawValue: " + rawValue);
+
+            // Apply Regex Filter if present
+            if (regexFilter != null) {
+                if (rawValue == null || !regexFilter.matcher(rawValue).find()) {
+                    echo("Barcode " + rawValue + " does not match regex filter, skipping");
+                    continue;
+                }
+            }
+
             int format = barcode.getFormat();
 
             VoteStatus voteStatus = scannedCodesVotes.get(rawValue);
@@ -1065,34 +1110,36 @@ public class CapacitorScannerPlugin extends Plugin {
             detectionOverlay = null;
         }
 
-            scannedCodesVotes.clear();
+        scannedCodesVotes.clear();
+        regexFilter = null;
             isScanning.set(false);
 
-            showWebViewBackground();
-
-            if (orientationEventListener != null) {
-                orientationEventListener.disable();
-                orientationEventListener = null;
-            }
+        showWebViewBackground();
 
-            // Reset all detection state variables
-            lastGoodRectangleTime = 0;
-            lastGoodDetectionResult = null;
-            lastRectangleNotificationTime = 0;
-            lastRectangleProcessingTime = 0;
-            lastRectangleDetectionTime = 0;
+        if (orientationEventListener != null) {
+            orientationEventListener.disable();
+            orientationEventListener = null;
+        }
 
-            // Clear detection histories and caches
-            enabledDetectionTypes.clear();
-            recentDetectionResults.clear();
-            detectionHistory.clear();
-            lastGoodRects = Collections.emptyList();
+        // Reset all detection state variables
+        lastGoodRectangleTime = 0;
+        lastGoodDetectionResult = null;
+        lastRectangleNotificationTime = 0;
+        lastRectangleProcessingTime = 0;
+        lastRectangleDetectionTime = 0;
+
+        // Clear detection histories and caches
+        enabledDetectionTypes.clear();
+        enabledHighlightTypes.clear();
+        recentDetectionResults.clear();
+        detectionHistory.clear();
+        lastGoodRects = Collections.emptyList();
 
-            // Clear overlay rectangles
-            synchronized (overlayLock) {
-                currentBarcodeRects.clear();
-                currentRectangleRects.clear();
-            }
+        // Clear overlay rectangles
+        synchronized (overlayLock) {
+            currentBarcodeRects.clear();
+            currentRectangleRects.clear();
+        }
 
         echo("All detection state variables have been reset");
     }
@@ -1122,6 +1169,9 @@ public class CapacitorScannerPlugin extends Plugin {
             });
         }
 
+        // Read showHighlight option (defaults to true for businessCard)
+        boolean showHighlight = call.getBoolean("showHighlight", true);
+
         // Only accept "businessCard" type - barcode detection is handled separately
         List<String> addedTypes = new ArrayList<>();
         try {
@@ -1129,6 +1179,9 @@ public class CapacitorScannerPlugin extends Plugin {
                 String type = types.getString(i);
                 if ("businessCard".equals(type)) {
                     enabledDetectionTypes.add(type);
+                    if (showHighlight) {
+                        enabledHighlightTypes.add(type);
+                    }
                     addedTypes.add(type);
                 }
             }
@@ -1175,7 +1228,7 @@ public class CapacitorScannerPlugin extends Plugin {
             // this should not happen
         }
 
-        if (enabledDetectionTypes.contains("businessCard")) {
+        if (enabledHighlightTypes.contains("businessCard")) {
             getActivity().runOnUiThread(() -> {
                 setupDetectionOverlay();
             });
@@ -1186,8 +1239,9 @@ public class CapacitorScannerPlugin extends Plugin {
 
     @PluginMethod
     public void disableObjectDetection(PluginCall call) {
-        // Only remove businessCard - barcode detection is handled separately
+        // Remove businessCard from both detection and highlight types
         enabledDetectionTypes.remove("businessCard");
+        enabledHighlightTypes.remove("businessCard");
 
         // Reset businessCard detection state
         detectionHistory.clear();
@@ -1558,11 +1612,15 @@ public class CapacitorScannerPlugin extends Plugin {
     @PluginMethod
     public void enableBarcodeDetection(PluginCall call) {
         echo("enableBarcodeDetection");
-        enabledDetectionTypes.add("barcode");
+        boolean showHighlight = call.getBoolean("showHighlight", false);
 
-        getActivity().runOnUiThread(() -> {
-            setupDetectionOverlay();
-        });
+        enabledDetectionTypes.add("barcode");
+        if (showHighlight) {
+            enabledHighlightTypes.add("barcode");
+            getActivity().runOnUiThread(() -> {
+                setupDetectionOverlay();
+            });
+        }
 
         JSObject result = new JSObject();
         result.put("enabled", true);
@@ -1573,6 +1631,7 @@ public class CapacitorScannerPlugin extends Plugin {
     public void disableBarcodeDetection(PluginCall call) {
         echo("disableBarcodeDetection");
         enabledDetectionTypes.remove("barcode");
+        enabledHighlightTypes.remove("barcode");
 
         // Clear cached barcodes
         scannedCodesVotes.clear();

package/dist/docs.json

@@ -171,10 +171,10 @@
       },
       {
         "name": "enableObjectDetection",
-        "signature": "({ types }: ObjectDetectionOptions) => any",
+        "signature": "(options: ObjectDetectionOptions) => any",
         "parameters": [
           {
-            "name": "__0",
+            "name": "options",
             "docs": "",
             "type": "ObjectDetectionOptions"
           }
@@ -199,12 +199,25 @@
       },
       {
         "name": "enableBarcodeDetection",
-        "signature": "() => any",
-        "parameters": [],
+        "signature": "(options?: BarcodeDetectionOptions | undefined) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Optional configuration for barcode detection",
+            "type": "BarcodeDetectionOptions | undefined"
+          }
+        ],
         "returns": "any",
-        "tags": [],
-        "docs": "Enable barcode detection. This will start detecting barcodes and drawing overlays.",
-        "complexTypes": [],
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Optional configuration for barcode detection"
+          }
+        ],
+        "docs": "Enable barcode detection. This will start detecting barcodes.",
+        "complexTypes": [
+          "BarcodeDetectionOptions"
+        ],
         "slug": "enablebarcodedetection"
       },
       {
@@ -326,7 +339,7 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  /**\n   * Barcode formats to detect when barcodeDetection is enabled.\n   */\n  formats?: BarcodeFormat[];\n  /**\n   * Camera direction to use. Defaults to 'BACK'.\n   */\n  cameraDirection?: 'BACK' | 'FRONT';\n  /**\n   * Enable barcode detection on start. Defaults to false.\n   * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events.\n   */\n  barcodeDetection?: boolean;\n  /**\n   * Enable object detection (business card) on start. Defaults to false.\n   * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events.\n   */\n  objectDetection?: boolean;\n}",
+          "text": "{\n  /**\n   * Barcode formats to detect when barcodeDetection is enabled.\n   */\n  formats?: BarcodeFormat[];\n  /**\n   * Camera direction to use. Defaults to 'BACK'.\n   */\n  cameraDirection?: 'BACK' | 'FRONT';\n  /**\n   * Enable barcode detection on start. Defaults to false.\n   * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events.\n   */\n  barcodeDetection?: boolean;\n  /**\n   * Whether to show the highlight overlay for detected barcodes. Defaults to false.\n   * Only applies when barcodeDetection is true.\n   */\n  barcodeHighlight?: boolean;\n  /**\n   * Enable object detection (business card) on start. Defaults to false.\n   * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events.\n   */\n  objectDetection?: boolean;\n  /**\n   * Whether to show the highlight overlay for detected business cards. Defaults to true.\n   * Only applies when objectDetection is true.\n   */\n  objectHighlight?: boolean;\n  debounceTimeInMilli?: number;\n  /**\n   * Optional regex pattern to filter scanned barcodes.\n   * If provided, only barcodes matching this pattern will be reported.\n   */\n  regex?: string;\n  /**\n   * Optional regex flags (e.g., 'i' for case-insensitive, 'm' for multiline).\n   */\n  regexFlags?: string;\n}",
           "complexTypes": [
             "BarcodeFormat"
           ]
@@ -405,7 +418,18 @@
       "docs": "",
       "types": [
         {
-          "text": "{\n  /**\n   * Detection types to enable. Only 'businessCard' is supported.\n   * For barcode detection, use enableBarcodeDetection() instead.\n   */\n  types: ('businessCard')[],\n  /**\n   * Optional padding ratio to apply around detected rectangles when cropping.\n   * Value must be between 0 and 1, where:\n   * - 0 = no padding\n   * - 1 = 100% padding (not recommended)\n   * Default is 0.01 (1%) if not specified.\n   */\n  paddingRatio?: number\n}",
+          "text": "{\n  /**\n   * Detection types to enable. Only 'businessCard' is supported.\n   * For barcode detection, use enableBarcodeDetection() instead.\n   */\n  types: ('businessCard')[],\n  /**\n   * Optional padding ratio to apply around detected rectangles when cropping.\n   * Value must be between 0 and 1, where:\n   * - 0 = no padding\n   * - 1 = 100% padding (not recommended)\n   * Default is 0.01 (1%) if not specified.\n   */\n  paddingRatio?: number,\n  /**\n   * Whether to show the highlight overlay for detected business cards.\n   * Defaults to true.\n   */\n  showHighlight?: boolean\n}",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "BarcodeDetectionOptions",
+      "slug": "barcodedetectionoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  /**\n   * Whether to show the highlight overlay for detected barcodes.\n   * Defaults to false.\n   */\n  showHighlight?: boolean;\n}",
           "complexTypes": []
         }
       ]

package/dist/esm/definitions.d.ts

@@ -17,15 +17,16 @@ export interface CapacitorScannerPlugin {
     addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void): Promise<void>;
     addListener(event: 'rectangleDetected', listenerFunc: (result: RectangleDetectedEvent) => void): Promise<void>;
     removeAllListeners(): Promise<void>;
-    enableObjectDetection({ types }: ObjectDetectionOptions): Promise<void>;
+    enableObjectDetection(options: ObjectDetectionOptions): Promise<void>;
     disableObjectDetection(): Promise<{
         enabled: false;
         types: [];
     }>;
     /**
-     * Enable barcode detection. This will start detecting barcodes and drawing overlays.
+     * Enable barcode detection. This will start detecting barcodes.
+     * @param options - Optional configuration for barcode detection
      */
-    enableBarcodeDetection(): Promise<{
+    enableBarcodeDetection(options?: BarcodeDetectionOptions): Promise<{
         enabled: true;
     }>;
     /**
@@ -40,6 +41,13 @@ export interface CapacitorScannerPlugin {
      */
     zoom(options: ZoomOptions): Promise<ZoomResult>;
 }
+export declare type BarcodeDetectionOptions = {
+    /**
+     * Whether to show the highlight overlay for detected barcodes.
+     * Defaults to false.
+     */
+    showHighlight?: boolean;
+};
 export declare type ObjectDetectionOptions = {
     /**
      * Detection types to enable. Only 'businessCard' is supported.
@@ -54,6 +62,11 @@ export declare type ObjectDetectionOptions = {
      * Default is 0.01 (1%) if not specified.
      */
     paddingRatio?: number;
+    /**
+     * Whether to show the highlight overlay for detected business cards.
+     * Defaults to true.
+     */
+    showHighlight?: boolean;
 };
 export declare type StartOptions = {
     /**
@@ -69,11 +82,31 @@ export declare type StartOptions = {
      * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events.
      */
     barcodeDetection?: boolean;
+    /**
+     * Whether to show the highlight overlay for detected barcodes. Defaults to false.
+     * Only applies when barcodeDetection is true.
+     */
+    barcodeHighlight?: boolean;
     /**
      * Enable object detection (business card) on start. Defaults to false.
      * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events.
      */
     objectDetection?: boolean;
+    /**
+     * Whether to show the highlight overlay for detected business cards. Defaults to true.
+     * Only applies when objectDetection is true.
+     */
+    objectHighlight?: boolean;
+    debounceTimeInMilli?: number;
+    /**
+     * Optional regex pattern to filter scanned barcodes.
+     * If provided, only barcodes matching this pattern will be reported.
+     */
+    regex?: string;
+    /**
+     * Optional regex flags (e.g., 'i' for case-insensitive, 'm' for multiline).
+     */
+    regexFlags?: string;
 };
 export declare type BarcodeScannedEvent = {
     scannedCode: string;

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA0HA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,qCAAoB,CAAA;IACpB,2CAA0B,CAAA;IAC1B,+BAAc,CAAA;IACd,iCAAgB,CAAA;IAChB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,+BAAc,CAAA;AAChB,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB","sourcesContent":["export interface CapacitorScannerPlugin {\n  /**\n   * Start the camera preview with optional barcode and object detection.\n   * @param options - Configuration options for the camera and detection\n   */\n  start(options?: StartOptions): Promise<void>;\n\n  /**\n   * Stop the camera preview and all detection.\n   */\n  stop(): Promise<void>;\n\n  openSettings(): Promise<void>;\n\n  capturePhoto(options?: CapturePhotoOptions): Promise<CapturePhotoResult>;\n\n  checkPermissions(): Promise<PermissionsResult>;\n\n  requestPermissions(): Promise<PermissionsResult>;\n\n  flipCamera(): Promise<void>;\n\n  toggleFlash(): Promise<FlashResult>;\n\n  addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void): Promise<void>;\n\n  addListener(event: 'rectangleDetected', listenerFunc: (result: RectangleDetectedEvent) => void): Promise<void>;\n\n  removeAllListeners(): Promise<void>;\n\n  enableObjectDetection({ types }: ObjectDetectionOptions): Promise<void>;\n\n  disableObjectDetection(): Promise<{ enabled: false, types: [] }>;\n\n  /**\n   * Enable barcode detection. This will start detecting barcodes and drawing overlays.\n   */\n  enableBarcodeDetection(): Promise<{ enabled: true }>;\n\n  /**\n   * Disable barcode detection. This will stop detecting barcodes and clear cached barcodes.\n   */\n  disableBarcodeDetection(): Promise<{ enabled: false }>;\n\n  /**\n   * Set the camera zoom level.\n   * @param options - The zoom options containing the level (1, 2, or 3)\n   */\n  zoom(options: ZoomOptions): Promise<ZoomResult>;\n}\n\nexport type ObjectDetectionOptions = {\n  /**\n   * Detection types to enable. Only 'businessCard' is supported.\n   * For barcode detection, use enableBarcodeDetection() instead.\n   */\n  types: ('businessCard')[],\n  /**\n   * Optional padding ratio to apply around detected rectangles when cropping.\n   * Value must be between 0 and 1, where:\n   * - 0 = no padding\n   * - 1 = 100% padding (not recommended)\n   * Default is 0.01 (1%) if not specified.\n   */\n  paddingRatio?: number\n}\n\nexport type StartOptions = {\n  /**\n   * Barcode formats to detect when barcodeDetection is enabled.\n   */\n  formats?: BarcodeFormat[];\n  /**\n   * Camera direction to use. Defaults to 'BACK'.\n   */\n  cameraDirection?: 'BACK' | 'FRONT';\n  /**\n   * Enable barcode detection on start. Defaults to false.\n   * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events.\n   */\n  barcodeDetection?: boolean;\n  /**\n   * Enable object detection (business card) on start. Defaults to false.\n   * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events.\n   */\n  objectDetection?: boolean;\n};\n\nexport type BarcodeScannedEvent = { scannedCode: string; format: string };\n\n\nexport type RectangleDetectedEvent = {\n  detected: true\n};\n\nexport type CapturePhotoOptions = {\n  /**\n   * The desired quality of the captured image, expressed as a value between 0.0 (lowest quality, smallest file size)\n   * and 1.0 (highest quality, largest file size). Defaults to 1.0.\n   * This parameter directly influences the compression level of the resulting JPEG image.\n   */\n  qualityRatio?: number;\n};\n\nexport type PermissionsResult = { camera: 'prompt' | 'denied' | 'granted' };\n\nexport type CapturePhotoResult = { imageBase64: string };\n\nexport type FlashResult = { enabled: boolean };\n\nexport type ZoomOptions = {\n  /**\n   * The zoom level to set. Must be 1, 2, or 3.\n   * - 1 = 1.0x (no zoom)\n   * - 2 = 2.0x\n   * - 3 = 3.0x\n   */\n  level: 1 | 2 | 3;\n};\n\nexport type ZoomResult = { level: number };\n\nexport enum BarcodeFormat {\n  Aztec = 'AZTEC',\n  Code39 = 'CODE_39',\n  Code93 = 'CODE_93',\n  Code128 = 'CODE_128',\n  DataMatrix = 'DATA_MATRIX',\n  Ean8 = 'EAN_8',\n  Ean13 = 'EAN_13',\n  Itf14 = 'ITF14',\n  Pdf417 = 'PDF_417',\n  QrCode = 'QR_CODE',\n  UpcE = 'UPC_E',\n}\n\ndeclare global {\n  interface PluginRegistry {\n    QRScanner: CapacitorScannerPlugin;\n  }\n}"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA4JA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,qCAAoB,CAAA;IACpB,2CAA0B,CAAA;IAC1B,+BAAc,CAAA;IACd,iCAAgB,CAAA;IAChB,gCAAe,CAAA;IACf,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,+BAAc,CAAA;AAChB,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB","sourcesContent":["export interface CapacitorScannerPlugin {\n  /**\n   * Start the camera preview with optional barcode and object detection.\n   * @param options - Configuration options for the camera and detection\n   */\n  start(options?: StartOptions): Promise<void>;\n\n  /**\n   * Stop the camera preview and all detection.\n   */\n  stop(): Promise<void>;\n\n  openSettings(): Promise<void>;\n\n  capturePhoto(options?: CapturePhotoOptions): Promise<CapturePhotoResult>;\n\n  checkPermissions(): Promise<PermissionsResult>;\n\n  requestPermissions(): Promise<PermissionsResult>;\n\n  flipCamera(): Promise<void>;\n\n  toggleFlash(): Promise<FlashResult>;\n\n  addListener(event: 'barcodeScanned', listenerFunc: (result: BarcodeScannedEvent) => void): Promise<void>;\n\n  addListener(event: 'rectangleDetected', listenerFunc: (result: RectangleDetectedEvent) => void): Promise<void>;\n\n  removeAllListeners(): Promise<void>;\n\n  enableObjectDetection(options: ObjectDetectionOptions): Promise<void>;\n\n  disableObjectDetection(): Promise<{ enabled: false, types: [] }>;\n\n  /**\n   * Enable barcode detection. This will start detecting barcodes.\n   * @param options - Optional configuration for barcode detection\n   */\n  enableBarcodeDetection(options?: BarcodeDetectionOptions): Promise<{ enabled: true }>;\n\n  /**\n   * Disable barcode detection. This will stop detecting barcodes and clear cached barcodes.\n   */\n  disableBarcodeDetection(): Promise<{ enabled: false }>;\n\n  /**\n   * Set the camera zoom level.\n   * @param options - The zoom options containing the level (1, 2, or 3)\n   */\n  zoom(options: ZoomOptions): Promise<ZoomResult>;\n}\n\nexport type BarcodeDetectionOptions = {\n  /**\n   * Whether to show the highlight overlay for detected barcodes.\n   * Defaults to false.\n   */\n  showHighlight?: boolean;\n}\n\nexport type ObjectDetectionOptions = {\n  /**\n   * Detection types to enable. Only 'businessCard' is supported.\n   * For barcode detection, use enableBarcodeDetection() instead.\n   */\n  types: ('businessCard')[],\n  /**\n   * Optional padding ratio to apply around detected rectangles when cropping.\n   * Value must be between 0 and 1, where:\n   * - 0 = no padding\n   * - 1 = 100% padding (not recommended)\n   * Default is 0.01 (1%) if not specified.\n   */\n  paddingRatio?: number,\n  /**\n   * Whether to show the highlight overlay for detected business cards.\n   * Defaults to true.\n   */\n  showHighlight?: boolean\n}\n\nexport type StartOptions = {\n  /**\n   * Barcode formats to detect when barcodeDetection is enabled.\n   */\n  formats?: BarcodeFormat[];\n  /**\n   * Camera direction to use. Defaults to 'BACK'.\n   */\n  cameraDirection?: 'BACK' | 'FRONT';\n  /**\n   * Enable barcode detection on start. Defaults to false.\n   * When enabled, the camera will automatically detect barcodes and emit 'barcodeScanned' events.\n   */\n  barcodeDetection?: boolean;\n  /**\n   * Whether to show the highlight overlay for detected barcodes. Defaults to false.\n   * Only applies when barcodeDetection is true.\n   */\n  barcodeHighlight?: boolean;\n  /**\n   * Enable object detection (business card) on start. Defaults to false.\n   * When enabled, the camera will automatically detect business cards and emit 'rectangleDetected' events.\n   */\n  objectDetection?: boolean;\n  /**\n   * Whether to show the highlight overlay for detected business cards. Defaults to true.\n   * Only applies when objectDetection is true.\n   */\n  objectHighlight?: boolean;\n  debounceTimeInMilli?: number;\n  /**\n   * Optional regex pattern to filter scanned barcodes.\n   * If provided, only barcodes matching this pattern will be reported.\n   */\n  regex?: string;\n  /**\n   * Optional regex flags (e.g., 'i' for case-insensitive, 'm' for multiline).\n   */\n  regexFlags?: string;\n};\n\nexport type BarcodeScannedEvent = { scannedCode: string; format: string };\n\n\nexport type RectangleDetectedEvent = {\n  detected: true\n};\n\nexport type CapturePhotoOptions = {\n  /**\n   * The desired quality of the captured image, expressed as a value between 0.0 (lowest quality, smallest file size)\n   * and 1.0 (highest quality, largest file size). Defaults to 1.0.\n   * This parameter directly influences the compression level of the resulting JPEG image.\n   */\n  qualityRatio?: number;\n};\n\nexport type PermissionsResult = { camera: 'prompt' | 'denied' | 'granted' };\n\nexport type CapturePhotoResult = { imageBase64: string };\n\nexport type FlashResult = { enabled: boolean };\n\nexport type ZoomOptions = {\n  /**\n   * The zoom level to set. Must be 1, 2, or 3.\n   * - 1 = 1.0x (no zoom)\n   * - 2 = 2.0x\n   * - 3 = 3.0x\n   */\n  level: 1 | 2 | 3;\n};\n\nexport type ZoomResult = { level: number };\n\nexport enum BarcodeFormat {\n  Aztec = 'AZTEC',\n  Code39 = 'CODE_39',\n  Code93 = 'CODE_93',\n  Code128 = 'CODE_128',\n  DataMatrix = 'DATA_MATRIX',\n  Ean8 = 'EAN_8',\n  Ean13 = 'EAN_13',\n  Itf14 = 'ITF14',\n  Pdf417 = 'PDF_417',\n  QrCode = 'QR_CODE',\n  UpcE = 'UPC_E',\n}\n\ndeclare global {\n  interface PluginRegistry {\n    QRScanner: CapacitorScannerPlugin;\n  }\n}"]}

package/ios/Sources/CapacitorScannerPlugin/CapacitorScannerPlugin.swift

@@ -39,6 +39,7 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 
 	private let voteThreshold = 3
 	private var scannedCodesVotes = TTLMap<String, VoteStatus>(ttlSeconds: 5) // 5 second TTL
+	private var regexFilter: NSRegularExpression?
 
 	// for capturing images
 	private var photoOutput: AVCapturePhotoOutput?
@@ -58,7 +59,9 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 	private var lastBarcodeDetectionTime: Date?
 	private let rectangleVisibilityTimeout: TimeInterval = 1.0 // Time in seconds before considering rectangle no longer visible
 
- // Object detection highlighting properties
+ // Detection state (controls what detection runs)
+ private var enabledDetectionTypes: Set<String> = []
+ // Highlight state (controls what overlay is shown)
  private var enabledHighlightTypes: Set<String> = []
  private var overlayView: UIView?
  private var barcodeOverlays: [CAShapeLayer] = []
@@ -119,10 +122,16 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 			return
 		}
 
+		let showHighlight = call.getBool("showHighlight", true)
+
 		DispatchQueue.main.async {
-			// Add businessCard to enabled types (don't clear existing barcode detection)
-			self.enabledHighlightTypes.insert("businessCard")
-			self.setupOverlayView()
+			// Add businessCard to enabled detection types
+			self.enabledDetectionTypes.insert("businessCard")
+			// Add to highlight types if showHighlight is true (default)
+			if showHighlight {
+				self.enabledHighlightTypes.insert("businessCard")
+				self.setupOverlayView()
+			}
 
 			call.resolve([
 				"enabled": true,
@@ -133,7 +142,8 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 
 	@objc func disableObjectDetection(_ call: CAPPluginCall) {
 		DispatchQueue.main.async {
-			// Only remove businessCard - barcode detection is handled separately
+			// Remove businessCard from both detection and highlight types
+			self.enabledDetectionTypes.remove("businessCard")
 			self.enabledHighlightTypes.remove("businessCard")
 
 			// Clear only businessCard overlay (not barcode overlay)
@@ -319,7 +329,7 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 		self.capturePhotoCall = call
 
 		// If business card detection is enabled, wait for 1 second before capturing
-		if self.enabledHighlightTypes.contains("businessCard") {
+		if self.enabledDetectionTypes.contains("businessCard") {
 			DispatchQueue.main.asyncAfter(deadline: .now() + 0.6) {
 				photoOutput.capturePhoto(with: photoSettings, delegate: self)
 			}
@@ -341,7 +351,7 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 		}
 
 		// Check if object detection is enabled and we have a detected rectangle with sufficient confidence
-		if self.enabledHighlightTypes.contains("businessCard"),
+		if self.enabledDetectionTypes.contains("businessCard"),
 		   let detectedRect = self.lastDetectedRectangle { // Only use rectangles with sufficient confidence
 			// If we have a snapshot from the detection, use it directly
 			if let snapshot = detectedRect.snapshot {
@@ -514,6 +524,9 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 		// Read detection options (defaults to false)
 		let enableBarcodeDetection = call.getBool("barcodeDetection", false)
 		let enableObjectDetection = call.getBool("objectDetection", false)
+		// Read highlight options (barcode defaults to false, businessCard defaults to true)
+		let enableBarcodeHighlight = call.getBool("barcodeHighlight", false)
+		let enableObjectHighlight = call.getBool("objectHighlight", true)
 
 		DispatchQueue.main.async {
 			// Stop any existing session first (must be on main thread for UI operations)
@@ -525,12 +538,35 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 
 			// Enable barcode detection if requested
 			if enableBarcodeDetection {
-				self.enabledHighlightTypes.insert("barcode")
+				self.enabledDetectionTypes.insert("barcode")
+				if enableBarcodeHighlight {
+					self.enabledHighlightTypes.insert("barcode")
+				}
 			}
 
 			// Enable object detection (businessCard) if requested
 			if enableObjectDetection {
-				self.enabledHighlightTypes.insert("businessCard")
+				self.enabledDetectionTypes.insert("businessCard")
+				if enableObjectHighlight {
+					self.enabledHighlightTypes.insert("businessCard")
+				}
+			}
+
+			// Handle Regex Filter
+			if let pattern = call.getString("regex") {
+				let flags = call.getString("regexFlags") ?? ""
+				var options: NSRegularExpression.Options = []
+				if flags.contains("i") { options.insert(.caseInsensitive) }
+				if flags.contains("m") { options.insert(.anchorsMatchLines) }
+
+				do {
+					self.regexFilter = try NSRegularExpression(pattern: pattern, options: options)
+				} catch {
+					call.reject("Invalid Regex pattern")
+					return
+				}
+			} else {
+				self.regexFilter = nil
 			}
 
 			// Start monitoring device motion
@@ -644,12 +680,15 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 		self.videoDataOutput = nil
 		self.currentPixelBuffer = nil
 		self.scannedCodesVotes.clear()
-		self.clearAllOverlays()
-		self.showWebViewBackground()
-		self.enabledHighlightTypes.removeAll()
-		self.lastRectangleDetectionTime = nil
-		self.lastBarcodeDetectionTime = nil
-		self.removeOrientationChangeObserver()
+		self.regexFilter = nil
+			self.clearAllOverlays()
+			self.showWebViewBackground()
+			self.enabledDetectionTypes.removeAll()
+			self.enabledHighlightTypes.removeAll()
+			self.lastRectangleDetectionTime = nil
+			self.lastBarcodeDetectionTime = nil
+			self.removeOrientationChangeObserver()
+
 	}
 
 	private func addOrientationChangeObserver() {
@@ -818,9 +857,16 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 			return
 		}
 
-		// First find the barcode with highest confidence
+		// First find the barcode with highest confidence that matches the regex (if provided)
 		let highestConfidenceBarcode = observations
-			.filter { $0.payloadStringValue != nil }
+			.filter { observation in
+				guard let payload = observation.payloadStringValue else { return false }
+				if let regex = self.regexFilter {
+					let range = NSRange(location: 0, length: payload.utf16.count)
+					return regex.firstMatch(in: payload, options: [], range: range) != nil
+				}
+				return true
+			}
 			.max(by: { $0.confidence < $1.confidence })
 
 		// Then process only that barcode if found
@@ -1045,9 +1091,14 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 	}
 
 	@objc func enableBarcodeDetection(_ call: CAPPluginCall) {
+		let showHighlight = call.getBool("showHighlight", false)
+
 		DispatchQueue.main.async {
-			self.enabledHighlightTypes.insert("barcode")
-			self.setupOverlayView()
+			self.enabledDetectionTypes.insert("barcode")
+			if showHighlight {
+				self.enabledHighlightTypes.insert("barcode")
+				self.setupOverlayView()
+			}
 
 			call.resolve([
 				"enabled": true,
@@ -1057,6 +1108,7 @@ public class CapacitorScannerPlugin: CAPPlugin, CAPBridgedPlugin, AVCaptureMetad
 
 	@objc func disableBarcodeDetection(_ call: CAPPluginCall) {
 		DispatchQueue.main.async {
+			self.enabledDetectionTypes.remove("barcode")
 			self.enabledHighlightTypes.remove("barcode")
 
 			// Clear cached barcodes
@@ -1150,12 +1202,12 @@ extension CapacitorScannerPlugin: AVCaptureVideoDataOutputSampleBufferDelegate {
 		var requests: [VNRequest] = []
 
 		// Only include barcode detection if enabled
-		if self.enabledHighlightTypes.contains("barcode") {
+		if self.enabledDetectionTypes.contains("barcode") {
 			requests.append(self.barcodeDetectionRequest)
 		}
 
-		// Add rectangle detection if business card highlighting is enabled
-		if self.enabledHighlightTypes.contains("businessCard") {
+		// Add rectangle detection if business card detection is enabled
+		if self.enabledDetectionTypes.contains("businessCard") {
 			requests.append(self.rectangleDetectionRequest)
 		}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scr2em/capacitor-scanner",
-  "version": "6.0.21",
+  "version": "6.0.23",
   "description": "scan codes",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",