capacitor-card-scanner 0.3.0 → 0.3.1

package/README.md

@@ -328,17 +328,18 @@ requestPermissions() => Promise<PermissionStatus>
 
 #### DetectionOptions
 
-| Prop                  | Type                 | Description                                                                                                                                                                                               | Default                         |
-| --------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
-| **`intervalMs`**      | <code>number</code>  | Minimum time between two OCR runs, in milliseconds. The red rectangle is updated on every frame regardless.                                                                                               | <code>300</code>                |
-| **`stableFrames`**    | <code>number</code>  | How many consecutive OCR runs must read the same card before `cardDetected` fires.                                                                                                                        | <code>2</code>                  |
-| **`includeImage`**    | <code>boolean</code> | Include a JPEG of the detected card in the event.                                                                                                                                                         | <code>false</code>              |
-| **`cardAspectRatio`** | <code>number</code>  | Expected width / height of an upright card. Only upright cards are detected; a card lying sideways falls outside the tolerance.                                                                           | <code>0.716 (63 x 88 mm)</code> |
-| **`aspectTolerance`** | <code>number</code>  | Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%). Increase it if tilted cards are not detected.                                                                                            | <code>0.15</code>               |
-| **`minCardArea`**     | <code>number</code>  | Smallest card size, as a fraction of the camera frame (0-1).                                                                                                                                              | <code>0.08</code>               |
-| **`maxCardArea`**     | <code>number</code>  | Largest card size, as a fraction of the camera frame (0-1).                                                                                                                                               | <code>0.9</code>                |
-| **`requireCard`**     | <code>boolean</code> | Only read text when a card-shaped object is visible. When false, the whole frame is read if no card is found.                                                                                             | <code>true</code>               |
-| **`debug`**           | <code>boolean</code> | Draw every object found, labelled with its area (`a`) and width/height ratio (`r`): red when accepted as a card, grey when rejected (with the filter that rejected it). Use it to tune the filters above. | <code>false</code>              |
+| Prop                  | Type                 | Description                                                                                                                                                                                                                                          | Default                         |
+| --------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
+| **`intervalMs`**      | <code>number</code>  | Minimum time between two OCR runs, in milliseconds. The red rectangle is updated on every frame regardless.                                                                                                                                          | <code>300</code>                |
+| **`stableFrames`**    | <code>number</code>  | How many consecutive OCR runs must read the same card before `cardDetected` fires.                                                                                                                                                                   | <code>2</code>                  |
+| **`includeImage`**    | <code>boolean</code> | Include a JPEG of the detected card in the event.                                                                                                                                                                                                    | <code>false</code>              |
+| **`cardAspectRatio`** | <code>number</code>  | Expected width / height of an upright card. Only upright cards are detected; a card lying sideways falls outside the tolerance.                                                                                                                      | <code>0.716 (63 x 88 mm)</code> |
+| **`aspectTolerance`** | <code>number</code>  | Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%). Increase it if tilted cards are not detected.                                                                                                                                       | <code>0.15</code>               |
+| **`minCardArea`**     | <code>number</code>  | Smallest card size, as a fraction of the camera frame (0-1).                                                                                                                                                                                         | <code>0.08</code>               |
+| **`maxCardArea`**     | <code>number</code>  | Largest card size, as a fraction of the camera frame (0-1).                                                                                                                                                                                          | <code>0.9</code>                |
+| **`requireCard`**     | <code>boolean</code> | Only read text when a card-shaped object is visible. When false, the whole frame is read if no card is found.                                                                                                                                        | <code>true</code>               |
+| **`debug`**           | <code>boolean</code> | Every object found is always outlined: red when accepted as a card, grey when rejected. With `debug`, each outline is also labelled with its area (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to tune the filters above. | <code>false</code>              |
+| **`showRejected`**    | <code>boolean</code> | Outline (in grey) the objects that were not accepted as a card. The accepted card is always outlined in red.                                                                                                                                         | <code>true</code>               |
 
 
 #### PluginListenerHandle

package/android/src/main/java/pt/tcgclassifier/cardscanner/CardDetector.java

@@ -25,7 +25,6 @@ import com.google.mlkit.vision.text.TextRecognizer;
 import com.google.mlkit.vision.text.latin.TextRecognizerOptions;
 import java.io.ByteArrayOutputStream;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Locale;
 import java.util.regex.Matcher;
@@ -61,8 +60,10 @@ public class CardDetector implements ImageAnalysis.Analyzer {
         public float maxCardArea = 0.9f;
         /** Only run OCR when a card-shaped object is visible. */
         public boolean requireCard = true;
-        /** Report every detected object (with its area/ratio) so the overlay can show why it was rejected. */
+        /** Label every detected object with its area/ratio and the filter that rejected it. */
         public boolean debug = false;
+        /** Outline (in grey) the objects that were not accepted as a card. */
+        public boolean showRejected = true;
     }
 
     /** An object found by ML Kit, with the values the card filters were checked against. */
@@ -94,7 +95,7 @@ public class CardDetector implements ImageAnalysis.Analyzer {
     public interface BoxListener {
         /**
          * @param card card bounds normalized (0-1) to the upright frame, or null when no card is visible
-         * @param candidates every detected object; empty unless debug is on
+         * @param candidates every detected object, accepted or not
          */
         void onDetections(@Nullable RectF card, List<Candidate> candidates, int frameWidth, int frameHeight);
     }
@@ -133,6 +134,14 @@ public class CardDetector implements ImageAnalysis.Analyzer {
         this.listener = listener;
     }
 
+    public boolean isDebug() {
+        return options.debug;
+    }
+
+    public boolean isShowRejected() {
+        return options.showRejected;
+    }
+
     public void setBoxListener(BoxListener boxListener) {
         this.boxListener = boxListener;
     }
@@ -157,7 +166,7 @@ public class CardDetector implements ImageAnalysis.Analyzer {
 
         try {
             List<DetectedObject> objects = Tasks.await(objectDetector.process(InputImage.fromBitmap(upright, 0)));
-            List<Candidate> candidates = options.debug ? new ArrayList<>() : Collections.emptyList();
+            List<Candidate> candidates = new ArrayList<>();
             Rect card = pickCard(objects, frameW, frameH, candidates);
             RectF cardBox = card == null ? null : normalize(card, frameW, frameH);
             BoxListener bl = boxListener;
@@ -181,7 +190,7 @@ public class CardDetector implements ImageAnalysis.Analyzer {
 
     /**
      * The biggest detected object with the size and upright proportions of a card.
-     * When debug is on, every object is added to {@code candidates}.
+     * Every object, accepted or not, is added to {@code candidates}.
      */
     @Nullable
     private Rect pickCard(List<DetectedObject> objects, int frameW, int frameH, List<Candidate> candidates) {
@@ -203,9 +212,7 @@ public class CardDetector implements ImageAnalysis.Analyzer {
             } else if (ratio < minRatio || ratio > maxRatio) {
                 rejectedBy = "ratio";
             }
-            if (options.debug) {
-                candidates.add(new Candidate(normalize(r, frameW, frameH), fraction, ratio, rejectedBy));
-            }
+            candidates.add(new Candidate(normalize(r, frameW, frameH), fraction, ratio, rejectedBy));
             if (rejectedBy != null) continue;
 
             if (area > bestArea) {

package/android/src/main/java/pt/tcgclassifier/cardscanner/CardScanner.java

@@ -151,6 +151,8 @@ public class CardScanner {
         closeDetector();
         detector = newDetector;
         DetectionOverlay target = overlay;
+        target.setShowLabels(newDetector.isDebug());
+        target.setShowRejected(newDetector.isShowRejected());
         detector.setBoxListener((card, candidates, frameW, frameH) ->
             target.post(() -> {
                 // Ignore frames that arrive after detection was stopped or restarted.

package/android/src/main/java/pt/tcgclassifier/cardscanner/CardScannerPlugin.java

@@ -101,6 +101,7 @@ public class CardScannerPlugin extends Plugin {
         options.maxCardArea = call.getFloat("maxCardArea", options.maxCardArea);
         options.requireCard = call.getBoolean("requireCard", options.requireCard);
         options.debug = call.getBoolean("debug", options.debug);
+        options.showRejected = call.getBoolean("showRejected", options.showRejected);
 
         CardDetector detector = new CardDetector(options, result -> notifyListeners("cardDetected", result));
         getActivity().runOnUiThread(() -> {

package/android/src/main/java/pt/tcgclassifier/cardscanner/DetectionOverlay.java

@@ -1,114 +1,127 @@
-package pt.tcgclassifier.cardscanner;
-
-import android.content.Context;
-import android.graphics.Canvas;
-import android.graphics.Color;
-import android.graphics.Paint;
-import android.graphics.RectF;
-import android.os.SystemClock;
-import android.view.View;
-import androidx.annotation.Nullable;
-import java.util.Collections;
-import java.util.List;
-
-/**
- * Draws a red rectangle around the detected card. Sits between the camera
- * preview and the (transparent) WebView, and maps frame coordinates the same
- * way PreviewView's FILL_CENTER does. In debug mode it also draws every object
- * ML Kit found, labelled with its area/ratio (grey when rejected).
- */
-public class DetectionOverlay extends View {
-
-    /** Keep the rectangle this long after the card was last seen, to avoid flicker. */
-    private static final long HIDE_AFTER_MS = 300;
-
-    private final Paint cardPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
-    private final Paint rejectedPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
-    private final Paint labelPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
-    private final float radius;
-    private final float labelPadding;
-    private final RectF drawRect = new RectF();
-
-    @Nullable
-    private RectF card;
-    private List<CardDetector.Candidate> candidates = Collections.emptyList();
-    private int frameWidth;
-    private int frameHeight;
-    private boolean mirror;
-    private long lastCardAt;
-
-    public DetectionOverlay(Context context) {
-        super(context);
-        float density = context.getResources().getDisplayMetrics().density;
-        radius = 8 * density;
-        labelPadding = 4 * density;
-
-        cardPaint.setColor(Color.RED);
-        cardPaint.setStyle(Paint.Style.STROKE);
-        cardPaint.setStrokeWidth(3 * density);
-
-        rejectedPaint.setColor(Color.argb(200, 180, 180, 180));
-        rejectedPaint.setStyle(Paint.Style.STROKE);
-        rejectedPaint.setStrokeWidth(2 * density);
-
-        labelPaint.setColor(Color.WHITE);
-        labelPaint.setTextSize(13 * density);
-        labelPaint.setShadowLayer(3 * density, 0, 0, Color.BLACK);
-    }
-
-    public void setMirror(boolean mirror) {
-        this.mirror = mirror;
-    }
-
-    /** Must be called on the UI thread. */
-    public void setDetections(@Nullable RectF card, List<CardDetector.Candidate> candidates, int frameWidth, int frameHeight) {
-        long now = SystemClock.uptimeMillis();
-        if (card != null) {
-            lastCardAt = now;
-            this.card = card;
-        } else if (now - lastCardAt >= HIDE_AFTER_MS) {
-            this.card = null;
-        }
-        this.candidates = candidates;
-        this.frameWidth = frameWidth;
-        this.frameHeight = frameHeight;
-        invalidate();
-    }
-
-    public void clear() {
-        card = null;
-        candidates = Collections.emptyList();
-        invalidate();
-    }
-
-    @Override
-    protected void onDraw(Canvas canvas) {
-        if (frameWidth == 0 || frameHeight == 0) return;
-
-        for (CardDetector.Candidate c : candidates) {
-            map(c.box);
-            canvas.drawRoundRect(drawRect, radius, radius, c.rejectedBy == null ? cardPaint : rejectedPaint);
-            canvas.drawText(c.label(), drawRect.left + labelPadding, drawRect.top - labelPadding, labelPaint);
-        }
-
-        if (card != null) {
-            map(card);
-            canvas.drawRoundRect(drawRect, radius, radius, cardPaint);
-        }
-    }
-
-    /** Maps a normalized frame rectangle into drawRect, in view coordinates. */
-    private void map(RectF box) {
-        float vw = getWidth();
-        float vh = getHeight();
-        float scale = Math.max(vw / frameWidth, vh / frameHeight);
-        float sw = frameWidth * scale;
-        float sh = frameHeight * scale;
-        float dx = (vw - sw) / 2f;
-        float dy = (vh - sh) / 2f;
-
-        float left = mirror ? 1f - box.right : box.left;
-        float right = mirror ? 1f - box.left : box.right;
-        drawRect.set(dx + left * sw, dy + box.top * sh, dx + right * sw, dy + box.bottom * sh);
-    }
-}
+package pt.tcgclassifier.cardscanner;
+
+import android.content.Context;
+import android.graphics.Canvas;
+import android.graphics.Color;
+import android.graphics.Paint;
+import android.graphics.RectF;
+import android.os.SystemClock;
+import android.view.View;
+import androidx.annotation.Nullable;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Draws a red rectangle around the detected card. Sits between the camera
+ * preview and the (transparent) WebView, and maps frame coordinates the same
+ * way PreviewView's FILL_CENTER does. Objects that are not accepted as a card
+ * are drawn in grey; with labels on, each one shows its area/ratio.
+ */
+public class DetectionOverlay extends View {
+
+    /** Keep the rectangle this long after the card was last seen, to avoid flicker. */
+    private static final long HIDE_AFTER_MS = 300;
+
+    private final Paint cardPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
+    private final Paint rejectedPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
+    private final Paint labelPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
+    private final float radius;
+    private final float labelPadding;
+    private final RectF drawRect = new RectF();
+
+    @Nullable
+    private RectF card;
+    private List<CardDetector.Candidate> candidates = Collections.emptyList();
+    private int frameWidth;
+    private int frameHeight;
+    private boolean mirror;
+    private boolean showLabels;
+    private boolean showRejected = true;
+    private long lastCardAt;
+
+    public DetectionOverlay(Context context) {
+        super(context);
+        float density = context.getResources().getDisplayMetrics().density;
+        radius = 8 * density;
+        labelPadding = 4 * density;
+
+        cardPaint.setColor(Color.RED);
+        cardPaint.setStyle(Paint.Style.STROKE);
+        cardPaint.setStrokeWidth(3 * density);
+
+        rejectedPaint.setColor(Color.argb(200, 180, 180, 180));
+        rejectedPaint.setStyle(Paint.Style.STROKE);
+        rejectedPaint.setStrokeWidth(2 * density);
+
+        labelPaint.setColor(Color.WHITE);
+        labelPaint.setTextSize(13 * density);
+        labelPaint.setShadowLayer(3 * density, 0, 0, Color.BLACK);
+    }
+
+    public void setMirror(boolean mirror) {
+        this.mirror = mirror;
+    }
+
+    public void setShowLabels(boolean showLabels) {
+        this.showLabels = showLabels;
+    }
+
+    public void setShowRejected(boolean showRejected) {
+        this.showRejected = showRejected;
+    }
+
+    /** Must be called on the UI thread. */
+    public void setDetections(@Nullable RectF card, List<CardDetector.Candidate> candidates, int frameWidth, int frameHeight) {
+        long now = SystemClock.uptimeMillis();
+        if (card != null) {
+            lastCardAt = now;
+            this.card = card;
+        } else if (now - lastCardAt >= HIDE_AFTER_MS) {
+            this.card = null;
+        }
+        this.candidates = candidates;
+        this.frameWidth = frameWidth;
+        this.frameHeight = frameHeight;
+        invalidate();
+    }
+
+    public void clear() {
+        card = null;
+        candidates = Collections.emptyList();
+        invalidate();
+    }
+
+    @Override
+    protected void onDraw(Canvas canvas) {
+        if (frameWidth == 0 || frameHeight == 0) return;
+
+        for (CardDetector.Candidate c : candidates) {
+            if (c.rejectedBy != null && !showRejected) continue;
+            map(c.box);
+            canvas.drawRoundRect(drawRect, radius, radius, c.rejectedBy == null ? cardPaint : rejectedPaint);
+            if (showLabels) {
+                canvas.drawText(c.label(), drawRect.left + labelPadding, drawRect.top - labelPadding, labelPaint);
+            }
+        }
+
+        if (card != null) {
+            map(card);
+            canvas.drawRoundRect(drawRect, radius, radius, cardPaint);
+        }
+    }
+
+    /** Maps a normalized frame rectangle into drawRect, in view coordinates. */
+    private void map(RectF box) {
+        float vw = getWidth();
+        float vh = getHeight();
+        float scale = Math.max(vw / frameWidth, vh / frameHeight);
+        float sw = frameWidth * scale;
+        float sh = frameHeight * scale;
+        float dx = (vw - sw) / 2f;
+        float dy = (vh - sh) / 2f;
+
+        float left = mirror ? 1f - box.right : box.left;
+        float right = mirror ? 1f - box.left : box.right;
+        drawRect.set(dx + left * sw, dy + box.top * sh, dx + right * sw, dy + box.bottom * sh);
+    }
+}

package/dist/docs.json

@@ -405,7 +405,19 @@
               "name": "default"
             }
           ],
-          "docs": "Draw every object found, labelled with its area (`a`) and width/height\nratio (`r`): red when accepted as a card, grey when rejected (with the\nfilter that rejected it). Use it to tune the filters above.",
+          "docs": "Every object found is always outlined: red when accepted as a card, grey\nwhen rejected. With `debug`, each outline is also labelled with its area\n(`a`), width/height ratio (`r`) and the filter that rejected it. Use it to\ntune the filters above.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "showRejected",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Outline (in grey) the objects that were not accepted as a card.\nThe accepted card is always outlined in red.",
           "complexTypes": [],
           "type": "boolean | undefined"
         }

package/dist/esm/definitions.d.ts

@@ -77,12 +77,19 @@ export interface DetectionOptions {
      */
     requireCard?: boolean;
     /**
-     * Draw every object found, labelled with its area (`a`) and width/height
-     * ratio (`r`): red when accepted as a card, grey when rejected (with the
-     * filter that rejected it). Use it to tune the filters above.
+     * Every object found is always outlined: red when accepted as a card, grey
+     * when rejected. With `debug`, each outline is also labelled with its area
+     * (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to
+     * tune the filters above.
      * @default false
      */
     debug?: boolean;
+    /**
+     * Outline (in grey) the objects that were not accepted as a card.
+     * The accepted card is always outlined in red.
+     * @default true
+     */
+    showRejected?: boolean;
 }
 /** Normalized rectangle (0-1). */
 export interface Box {

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type CameraPosition = 'rear' | 'front';\n\nexport interface StartOptions {\n  /**\n   * Which camera to use.\n   * @default 'rear'\n   */\n  position?: CameraPosition;\n}\n\nexport interface CaptureOptions {\n  /**\n   * JPEG quality (0-100).\n   * @default 85\n   */\n  quality?: number;\n}\n\nexport interface CaptureResult {\n  /** Base64 encoded JPEG (without the `data:` prefix). */\n  base64: string;\n  width: number;\n  height: number;\n}\n\nexport interface TorchOptions {\n  enabled: boolean;\n}\n\nexport interface ZoomOptions {\n  /** Zoom ratio, clamped between the camera's min and max. */\n  ratio: number;\n}\n\nexport interface PermissionStatus {\n  camera: PermissionState;\n}\n\nexport interface DetectionOptions {\n  /**\n   * Minimum time between two OCR runs, in milliseconds.\n   * The red rectangle is updated on every frame regardless.\n   * @default 300\n   */\n  intervalMs?: number;\n  /**\n   * How many consecutive OCR runs must read the same card before\n   * `cardDetected` fires.\n   * @default 2\n   */\n  stableFrames?: number;\n  /**\n   * Include a JPEG of the detected card in the event.\n   * @default false\n   */\n  includeImage?: boolean;\n  /**\n   * Expected width / height of an upright card. Only upright cards are\n   * detected; a card lying sideways falls outside the tolerance.\n   * @default 0.716 (63 x 88 mm)\n   */\n  cardAspectRatio?: number;\n  /**\n   * Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\n   * Increase it if tilted cards are not detected.\n   * @default 0.15\n   */\n  aspectTolerance?: number;\n  /**\n   * Smallest card size, as a fraction of the camera frame (0-1).\n   * @default 0.08\n   */\n  minCardArea?: number;\n  /**\n   * Largest card size, as a fraction of the camera frame (0-1).\n   * @default 0.9\n   */\n  maxCardArea?: number;\n  /**\n   * Only read text when a card-shaped object is visible. When false, the whole\n   * frame is read if no card is found.\n   * @default true\n   */\n  requireCard?: boolean;\n  /**\n   * Draw every object found, labelled with its area (`a`) and width/height\n   * ratio (`r`): red when accepted as a card, grey when rejected (with the\n   * filter that rejected it). Use it to tune the filters above.\n   * @default false\n   */\n  debug?: boolean;\n}\n\n/** Normalized rectangle (0-1). */\nexport interface Box {\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n}\n\nexport interface TextLine {\n  text: string;\n  /** Position inside the card image. */\n  box: Box;\n}\n\nexport interface CardDetectedEvent {\n  /** Best guess for the card name (topmost line of text on the card). */\n  name?: string;\n  /** Collector number, e.g. `025/165`. */\n  collectorNumber?: string;\n  /** All text read on the card. */\n  text: string;\n  lines: TextLine[];\n  /** Where the card is in the camera frame. Missing if no card outline was found. */\n  cardBox?: Box;\n  /** Base64 JPEG of the card, when `includeImage` is true. */\n  image?: string;\n}\n\nexport interface CardScannerPlugin {\n  /**\n   * Opens the camera **behind** the WebView. The WebView background is made\n   * transparent, so the HTML page must also use transparent backgrounds\n   * where the camera should be visible.\n   */\n  start(options?: StartOptions): Promise<void>;\n\n  /** Stops the camera and removes the preview. */\n  stop(): Promise<void>;\n\n  /** Takes a photo from the running camera. */\n  capture(options?: CaptureOptions): Promise<CaptureResult>;\n\n  /** Turns the flashlight on/off. */\n  setTorch(options: TorchOptions): Promise<void>;\n\n  /** Sets the zoom ratio. */\n  setZoom(options: ZoomOptions): Promise<void>;\n\n  /** Switches between the rear and front camera. */\n  flip(): Promise<void>;\n\n  /**\n   * Starts looking for cards: draws a red rectangle around the card and reads\n   * its text, emitting `cardDetected`. Requires `start()` first. Android only.\n   */\n  startDetection(options?: DetectionOptions): Promise<void>;\n\n  /** Stops card detection and hides the rectangle. */\n  stopDetection(): Promise<void>;\n\n  /** Fired once per card, when its text has been read consistently. */\n  addListener(eventName: 'cardDetected', listener: (event: CardDetectedEvent) => void): Promise<PluginListenerHandle>;\n\n  removeAllListeners(): Promise<void>;\n\n  checkPermissions(): Promise<PermissionStatus>;\n\n  requestPermissions(): Promise<PermissionStatus>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport type CameraPosition = 'rear' | 'front';\n\nexport interface StartOptions {\n  /**\n   * Which camera to use.\n   * @default 'rear'\n   */\n  position?: CameraPosition;\n}\n\nexport interface CaptureOptions {\n  /**\n   * JPEG quality (0-100).\n   * @default 85\n   */\n  quality?: number;\n}\n\nexport interface CaptureResult {\n  /** Base64 encoded JPEG (without the `data:` prefix). */\n  base64: string;\n  width: number;\n  height: number;\n}\n\nexport interface TorchOptions {\n  enabled: boolean;\n}\n\nexport interface ZoomOptions {\n  /** Zoom ratio, clamped between the camera's min and max. */\n  ratio: number;\n}\n\nexport interface PermissionStatus {\n  camera: PermissionState;\n}\n\nexport interface DetectionOptions {\n  /**\n   * Minimum time between two OCR runs, in milliseconds.\n   * The red rectangle is updated on every frame regardless.\n   * @default 300\n   */\n  intervalMs?: number;\n  /**\n   * How many consecutive OCR runs must read the same card before\n   * `cardDetected` fires.\n   * @default 2\n   */\n  stableFrames?: number;\n  /**\n   * Include a JPEG of the detected card in the event.\n   * @default false\n   */\n  includeImage?: boolean;\n  /**\n   * Expected width / height of an upright card. Only upright cards are\n   * detected; a card lying sideways falls outside the tolerance.\n   * @default 0.716 (63 x 88 mm)\n   */\n  cardAspectRatio?: number;\n  /**\n   * Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\n   * Increase it if tilted cards are not detected.\n   * @default 0.15\n   */\n  aspectTolerance?: number;\n  /**\n   * Smallest card size, as a fraction of the camera frame (0-1).\n   * @default 0.08\n   */\n  minCardArea?: number;\n  /**\n   * Largest card size, as a fraction of the camera frame (0-1).\n   * @default 0.9\n   */\n  maxCardArea?: number;\n  /**\n   * Only read text when a card-shaped object is visible. When false, the whole\n   * frame is read if no card is found.\n   * @default true\n   */\n  requireCard?: boolean;\n  /**\n   * Every object found is always outlined: red when accepted as a card, grey\n   * when rejected. With `debug`, each outline is also labelled with its area\n   * (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to\n   * tune the filters above.\n   * @default false\n   */\n  debug?: boolean;\n  /**\n   * Outline (in grey) the objects that were not accepted as a card.\n   * The accepted card is always outlined in red.\n   * @default true\n   */\n  showRejected?: boolean;\n}\n\n/** Normalized rectangle (0-1). */\nexport interface Box {\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n}\n\nexport interface TextLine {\n  text: string;\n  /** Position inside the card image. */\n  box: Box;\n}\n\nexport interface CardDetectedEvent {\n  /** Best guess for the card name (topmost line of text on the card). */\n  name?: string;\n  /** Collector number, e.g. `025/165`. */\n  collectorNumber?: string;\n  /** All text read on the card. */\n  text: string;\n  lines: TextLine[];\n  /** Where the card is in the camera frame. Missing if no card outline was found. */\n  cardBox?: Box;\n  /** Base64 JPEG of the card, when `includeImage` is true. */\n  image?: string;\n}\n\nexport interface CardScannerPlugin {\n  /**\n   * Opens the camera **behind** the WebView. The WebView background is made\n   * transparent, so the HTML page must also use transparent backgrounds\n   * where the camera should be visible.\n   */\n  start(options?: StartOptions): Promise<void>;\n\n  /** Stops the camera and removes the preview. */\n  stop(): Promise<void>;\n\n  /** Takes a photo from the running camera. */\n  capture(options?: CaptureOptions): Promise<CaptureResult>;\n\n  /** Turns the flashlight on/off. */\n  setTorch(options: TorchOptions): Promise<void>;\n\n  /** Sets the zoom ratio. */\n  setZoom(options: ZoomOptions): Promise<void>;\n\n  /** Switches between the rear and front camera. */\n  flip(): Promise<void>;\n\n  /**\n   * Starts looking for cards: draws a red rectangle around the card and reads\n   * its text, emitting `cardDetected`. Requires `start()` first. Android only.\n   */\n  startDetection(options?: DetectionOptions): Promise<void>;\n\n  /** Stops card detection and hides the rectangle. */\n  stopDetection(): Promise<void>;\n\n  /** Fired once per card, when its text has been read consistently. */\n  addListener(eventName: 'cardDetected', listener: (event: CardDetectedEvent) => void): Promise<PluginListenerHandle>;\n\n  removeAllListeners(): Promise<void>;\n\n  checkPermissions(): Promise<PermissionStatus>;\n\n  requestPermissions(): Promise<PermissionStatus>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-card-scanner",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Recognize a pokemon card with camera open in background",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",