capacitor-card-scanner 0.3.3 → 0.3.4

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

@@ -1,189 +1,191 @@
-package pt.tcgclassifier.cardscanner;
-
-import android.Manifest;
-import androidx.annotation.Nullable;
-import com.getcapacitor.JSArray;
-import com.getcapacitor.JSObject;
-import com.getcapacitor.PermissionState;
-import com.getcapacitor.Plugin;
-import com.getcapacitor.PluginCall;
-import com.getcapacitor.PluginMethod;
-import com.getcapacitor.annotation.CapacitorPlugin;
-import com.getcapacitor.annotation.Permission;
-import com.getcapacitor.annotation.PermissionCallback;
-import java.util.ArrayList;
-import java.util.List;
-
-@CapacitorPlugin(name = "CardScanner", permissions = { @Permission(strings = { Manifest.permission.CAMERA }, alias = CardScannerPlugin.CAMERA) })
-public class CardScannerPlugin extends Plugin {
-
-    static final String CAMERA = "camera";
-
-    private CardScanner implementation;
-
-    @Override
-    public void load() {
-        implementation = new CardScanner(getActivity(), getBridge().getWebView());
-    }
-
-    @Override
-    protected void handleOnDestroy() {
-        getActivity().runOnUiThread(() -> implementation.stop());
-    }
-
-    @PluginMethod
-    public void start(PluginCall call) {
-        if (getPermissionState(CAMERA) != PermissionState.GRANTED) {
-            requestPermissionForAlias(CAMERA, call, "cameraPermsCallback");
-            return;
-        }
-        doStart(call);
-    }
-
-    @PermissionCallback
-    private void cameraPermsCallback(PluginCall call) {
-        if (getPermissionState(CAMERA) == PermissionState.GRANTED) {
-            doStart(call);
-        } else {
-            call.reject("Camera permission denied", "PERMISSION_DENIED");
-        }
-    }
-
-    private void doStart(PluginCall call) {
-        boolean front = "front".equals(call.getString("position", "rear"));
-        getActivity().runOnUiThread(() -> implementation.start(front, voidCallback(call)));
-    }
-
-    @PluginMethod
-    public void stop(PluginCall call) {
-        getActivity().runOnUiThread(() -> {
-            implementation.stop();
-            call.resolve();
-        });
-    }
-
-    @PluginMethod
-    public void flip(PluginCall call) {
-        if (!ensureRunning(call)) return;
-        getActivity().runOnUiThread(() -> implementation.flip(voidCallback(call)));
-    }
-
-    @PluginMethod
-    public void capture(PluginCall call) {
-        if (!ensureRunning(call)) return;
-        int quality = Math.max(0, Math.min(100, call.getInt("quality", 85)));
-        implementation.capture(
-            quality,
-            new CardScanner.Callback<>() {
-                @Override
-                public void onSuccess(CardScanner.Photo photo) {
-                    JSObject ret = new JSObject();
-                    ret.put("base64", photo.base64);
-                    ret.put("width", photo.width);
-                    ret.put("height", photo.height);
-                    call.resolve(ret);
-                }
-
-                @Override
-                public void onError(String message, Exception e) {
-                    call.reject(message, e);
-                }
-            }
-        );
-    }
-
-    @PluginMethod
-    public void startDetection(PluginCall call) {
-        if (!ensureRunning(call)) return;
-        CardDetector.Options options = new CardDetector.Options();
-        options.intervalMs = call.getInt("intervalMs", (int) options.intervalMs);
-        options.stableFrames = call.getInt("stableFrames", options.stableFrames);
-        options.includeImage = call.getBoolean("includeImage", options.includeImage);
-        options.cardAspectRatio = call.getFloat("cardAspectRatio", options.cardAspectRatio);
-        options.aspectTolerance = call.getFloat("aspectTolerance", options.aspectTolerance);
-        options.minCardArea = call.getFloat("minCardArea", options.minCardArea);
-        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);
-        options.repeatAfterMs = call.getInt("repeatAfterMs", (int) options.repeatAfterMs);
-        options.nameLines = call.getInt("nameLines", options.nameLines);
-        List<String> reservedWords = stringList(call, "reservedWords");
-        if (reservedWords != null) options.reservedWords = reservedWords;
-        List<String> reservedPrefixes = stringList(call, "reservedPrefixes");
-        if (reservedPrefixes != null) options.reservedPrefixes = reservedPrefixes;
-
-        CardDetector detector = new CardDetector(options, result -> notifyListeners("cardDetected", result));
-        getActivity().runOnUiThread(() -> {
-            try {
-                implementation.startDetection(detector);
-                call.resolve();
-            } catch (Exception e) {
-                detector.close();
-                call.reject("Failed to start detection: " + e.getMessage(), e);
-            }
-        });
-    }
-
-    @PluginMethod
-    public void stopDetection(PluginCall call) {
-        getActivity().runOnUiThread(() -> {
-            implementation.stopDetection();
-            call.resolve();
-        });
-    }
-
-    @PluginMethod
-    public void setTorch(PluginCall call) {
-        if (!ensureRunning(call)) return;
-        implementation.setTorch(Boolean.TRUE.equals(call.getBoolean("enabled", false)));
-        call.resolve();
-    }
-
-    @PluginMethod
-    public void setZoom(PluginCall call) {
-        if (!ensureRunning(call)) return;
-        Float ratio = call.getFloat("ratio");
-        if (ratio == null) {
-            call.reject("Missing 'ratio'");
-            return;
-        }
-        implementation.setZoom(ratio);
-        call.resolve();
-    }
-
-    /** A string array option, or null when it was not passed. */
-    @Nullable
-    private static List<String> stringList(PluginCall call, String key) {
-        JSArray array = call.getArray(key, null);
-        if (array == null) return null;
-        List<String> list = new ArrayList<>();
-        for (int i = 0; i < array.length(); i++) {
-            String s = array.optString(i, null);
-            if (s != null) list.add(s);
-        }
-        return list;
-    }
-
-    private boolean ensureRunning(PluginCall call) {
-        if (!implementation.isRunning()) {
-            call.reject("Camera is not running", "NOT_RUNNING");
-            return false;
-        }
-        return true;
-    }
-
-    private CardScanner.Callback<Void> voidCallback(PluginCall call) {
-        return new CardScanner.Callback<>() {
-            @Override
-            public void onSuccess(Void result) {
-                call.resolve();
-            }
-
-            @Override
-            public void onError(String message, Exception e) {
-                call.reject(message, e);
-            }
-        };
-    }
-}
+package pt.tcgclassifier.cardscanner;
+
+import android.Manifest;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PermissionState;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.annotation.Permission;
+import com.getcapacitor.annotation.PermissionCallback;
+import java.util.ArrayList;
+import java.util.List;
+
+@CapacitorPlugin(name = "CardScanner", permissions = { @Permission(strings = { Manifest.permission.CAMERA }, alias = CardScannerPlugin.CAMERA) })
+public class CardScannerPlugin extends Plugin {
+
+    static final String CAMERA = "camera";
+
+    private CardScanner implementation;
+
+    @Override
+    public void load() {
+        implementation = new CardScanner(getActivity(), getBridge().getWebView());
+    }
+
+    @Override
+    protected void handleOnDestroy() {
+        getActivity().runOnUiThread(() -> implementation.stop());
+    }
+
+    @PluginMethod
+    public void start(PluginCall call) {
+        if (getPermissionState(CAMERA) != PermissionState.GRANTED) {
+            requestPermissionForAlias(CAMERA, call, "cameraPermsCallback");
+            return;
+        }
+        doStart(call);
+    }
+
+    @PermissionCallback
+    private void cameraPermsCallback(PluginCall call) {
+        if (getPermissionState(CAMERA) == PermissionState.GRANTED) {
+            doStart(call);
+        } else {
+            call.reject("Camera permission denied", "PERMISSION_DENIED");
+        }
+    }
+
+    private void doStart(PluginCall call) {
+        boolean front = "front".equals(call.getString("position", "rear"));
+        getActivity().runOnUiThread(() -> implementation.start(front, voidCallback(call)));
+    }
+
+    @PluginMethod
+    public void stop(PluginCall call) {
+        getActivity().runOnUiThread(() -> {
+            implementation.stop();
+            call.resolve();
+        });
+    }
+
+    @PluginMethod
+    public void flip(PluginCall call) {
+        if (!ensureRunning(call)) return;
+        getActivity().runOnUiThread(() -> implementation.flip(voidCallback(call)));
+    }
+
+    @PluginMethod
+    public void capture(PluginCall call) {
+        if (!ensureRunning(call)) return;
+        int quality = Math.max(0, Math.min(100, call.getInt("quality", 85)));
+        implementation.capture(
+            quality,
+            new CardScanner.Callback<>() {
+                @Override
+                public void onSuccess(CardScanner.Photo photo) {
+                    JSObject ret = new JSObject();
+                    ret.put("base64", photo.base64);
+                    ret.put("width", photo.width);
+                    ret.put("height", photo.height);
+                    call.resolve(ret);
+                }
+
+                @Override
+                public void onError(String message, Exception e) {
+                    call.reject(message, e);
+                }
+            }
+        );
+    }
+
+    @PluginMethod
+    public void startDetection(PluginCall call) {
+        if (!ensureRunning(call)) return;
+        CardDetector.Options options = new CardDetector.Options();
+        options.intervalMs = call.getInt("intervalMs", (int) options.intervalMs);
+        options.stableFrames = call.getInt("stableFrames", options.stableFrames);
+        options.includeImage = call.getBoolean("includeImage", options.includeImage);
+        options.cardAspectRatio = call.getFloat("cardAspectRatio", options.cardAspectRatio);
+        options.aspectTolerance = call.getFloat("aspectTolerance", options.aspectTolerance);
+        options.minCardArea = call.getFloat("minCardArea", options.minCardArea);
+        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);
+        options.repeatAfterMs = call.getInt("repeatAfterMs", (int) options.repeatAfterMs);
+        options.nameLines = call.getInt("nameLines", options.nameLines);
+        options.cardGapMs = call.getInt("cardGapMs", (int) options.cardGapMs);
+        options.sameCardMaxDistance = call.getInt("sameCardMaxDistance", options.sameCardMaxDistance);
+        List<String> reservedWords = stringList(call, "reservedWords");
+        if (reservedWords != null) options.reservedWords = reservedWords;
+        List<String> reservedPrefixes = stringList(call, "reservedPrefixes");
+        if (reservedPrefixes != null) options.reservedPrefixes = reservedPrefixes;
+
+        CardDetector detector = new CardDetector(options, result -> notifyListeners("cardDetected", result));
+        getActivity().runOnUiThread(() -> {
+            try {
+                implementation.startDetection(detector);
+                call.resolve();
+            } catch (Exception e) {
+                detector.close();
+                call.reject("Failed to start detection: " + e.getMessage(), e);
+            }
+        });
+    }
+
+    @PluginMethod
+    public void stopDetection(PluginCall call) {
+        getActivity().runOnUiThread(() -> {
+            implementation.stopDetection();
+            call.resolve();
+        });
+    }
+
+    @PluginMethod
+    public void setTorch(PluginCall call) {
+        if (!ensureRunning(call)) return;
+        implementation.setTorch(Boolean.TRUE.equals(call.getBoolean("enabled", false)));
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void setZoom(PluginCall call) {
+        if (!ensureRunning(call)) return;
+        Float ratio = call.getFloat("ratio");
+        if (ratio == null) {
+            call.reject("Missing 'ratio'");
+            return;
+        }
+        implementation.setZoom(ratio);
+        call.resolve();
+    }
+
+    /** A string array option, or null when it was not passed. */
+    @Nullable
+    private static List<String> stringList(PluginCall call, String key) {
+        JSArray array = call.getArray(key, null);
+        if (array == null) return null;
+        List<String> list = new ArrayList<>();
+        for (int i = 0; i < array.length(); i++) {
+            String s = array.optString(i, null);
+            if (s != null) list.add(s);
+        }
+        return list;
+    }
+
+    private boolean ensureRunning(PluginCall call) {
+        if (!implementation.isRunning()) {
+            call.reject("Camera is not running", "NOT_RUNNING");
+            return false;
+        }
+        return true;
+    }
+
+    private CardScanner.Callback<Void> voidCallback(PluginCall call) {
+        return new CardScanner.Callback<>() {
+            @Override
+            public void onSuccess(Void result) {
+                call.resolve();
+            }
+
+            @Override
+            public void onError(String message, Exception e) {
+                call.reject(message, e);
+            }
+        };
+    }
+}

package/dist/docs.json

@@ -17,7 +17,7 @@
         ],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Opens the camera **behind** the WebView. The WebView background is made\ntransparent, so the HTML page must also use transparent backgrounds\nwhere the camera should be visible.",
+        "docs": "Opens the camera **behind** the WebView. The WebView background is made\r\ntransparent, so the HTML page must also use transparent backgrounds\r\nwhere the camera should be visible.",
         "complexTypes": [
           "StartOptions"
         ],
@@ -110,7 +110,7 @@
         ],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Starts looking for cards: draws a red rectangle around the card and reads\nits text, emitting `cardDetected`. Requires `start()` first. Android only.",
+        "docs": "Starts looking for cards: draws a red rectangle around the card and reads\r\nits text, emitting `cardDetected`. Requires `start()` first. Android only.",
         "complexTypes": [
           "DetectionOptions"
         ],
@@ -309,7 +309,7 @@
               "name": "default"
             }
           ],
-          "docs": "Minimum time between two OCR runs, in milliseconds.\nThe red rectangle is updated on every frame regardless.",
+          "docs": "Minimum time between two OCR runs, in milliseconds.\r\nThe red rectangle is updated on every frame regardless.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -321,7 +321,7 @@
               "name": "default"
             }
           ],
-          "docs": "How many consecutive OCR runs must read the same card before\n`cardDetected` fires.",
+          "docs": "How many consecutive OCR runs must read the same card before\r\n`cardDetected` fires.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -345,7 +345,7 @@
               "name": "default"
             }
           ],
-          "docs": "Expected width / height of an upright card. Only upright cards are\ndetected; a card lying sideways falls outside the tolerance.",
+          "docs": "Expected width / height of an upright card. Only upright cards are\r\ndetected; a card lying sideways falls outside the tolerance.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -357,7 +357,7 @@
               "name": "default"
             }
           ],
-          "docs": "Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\nIncrease it if tilted cards are not detected.",
+          "docs": "Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\r\nIncrease it if tilted cards are not detected.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -393,7 +393,7 @@
               "name": "default"
             }
           ],
-          "docs": "Only read text when a card-shaped object is visible. When false, the whole\nframe is read if no card is found.",
+          "docs": "Only read text when a card-shaped object is visible. When false, the whole\r\nframe is read if no card is found.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -405,7 +405,7 @@
               "name": "default"
             }
           ],
-          "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.",
+          "docs": "Every object found is always outlined: red when accepted as a card, grey\r\nwhen rejected. With `debug`, each outline is also labelled with its area\r\n(`a`), width/height ratio (`r`) and the filter that rejected it. Use it to\r\ntune the filters above.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -417,7 +417,7 @@
               "name": "default"
             }
           ],
-          "docs": "Outline (in grey) the objects that were not accepted as a card.\nThe accepted card is always outlined in red.",
+          "docs": "Outline (in grey) the objects that were not accepted as a card.\r\nThe accepted card is always outlined in red.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -429,7 +429,31 @@
               "name": "default"
             }
           ],
-          "docs": "How long (ms) the card must be out of view before the same card can be\nreported again. While a card stays in view it is reported only once.",
+          "docs": "How long (ms) the card must be out of view before the same card can be\r\nreported again. While a card stays in view it is reported only once.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "cardGapMs",
+          "tags": [
+            {
+              "text": "500",
+              "name": "default"
+            }
+          ],
+          "docs": "While the card outline stays in view, at most one card is reported, even\r\nif later readings give a different name. The outline must disappear for\r\nlonger than this (ms) for the next card to be read, e.g. when swapping cards.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "sameCardMaxDistance",
+          "tags": [
+            {
+              "text": "16",
+              "name": "default"
+            }
+          ],
+          "docs": "Two card images whose perceptual hashes differ in at most this many bits\r\n(of 64) are treated as the same card. Lower = stricter. Lets a card slid\r\nover another one be reported without the outline disappearing.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -441,7 +465,7 @@
               "name": "default"
             }
           ],
-          "docs": "The card name is looked for only in the first N lines of text on the\ncard, top to bottom.",
+          "docs": "The card name is looked for only in the first N lines of text on the\r\ncard, top to bottom.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -449,11 +473,11 @@
           "name": "reservedWords",
           "tags": [
             {
-              "text": "['Basic', 'Stage 1', 'Stage 2', 'Trainer', 'Item', 'Supporter', 'Stadium', 'Energy', 'Special Energy', 'Basic Energy', 'Pokémon', 'Pokémon Tool']",
+              "text": "['Basic', 'Stage', 'Stage 1', 'Stage 2', 'Trainer', 'Item', 'Supporter', 'Stadium', 'Energy', 'Special Energy', 'Basic Energy', 'Pokémon', 'Pokémon Tool', 'Tera']",
               "name": "default"
             }
           ],
-          "docs": "Words/phrases that are never the card name (card types, subtypes...).\nA line made only of these words is skipped, so \"Trainer\" or \"Stage 1\" are\nignored but \"Energy Retrieval\" is still a name. Replaces the defaults.",
+          "docs": "Words/phrases that are never the card name (card types, subtypes...).\r\nA line made only of these words is skipped, so \"Trainer\" or \"Stage 1\" are\r\nignored but \"Energy Retrieval\" is still a name. Replaces the defaults.\r\nAlso matched without spaces, so \"STAGE1\" counts as \"Stage 1\".",
           "complexTypes": [],
           "type": "string[] | undefined"
         },
@@ -465,7 +489,7 @@
               "name": "default"
             }
           ],
-          "docs": "Lines starting with any of these are never the card name.\nReplaces the defaults.",
+          "docs": "Lines starting with any of these are never the card name.\r\nReplaces the defaults.",
           "complexTypes": [],
           "type": "string[] | undefined"
         }
@@ -539,6 +563,13 @@
           "docs": "Base64 JPEG of the card, when `includeImage` is true.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "imageHash",
+          "tags": [],
+          "docs": "64-bit perceptual hash of the card image (16 hex characters). Photos of\r\nthe same card give hashes that differ in only a few bits.",
+          "complexTypes": [],
+          "type": "string"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -96,6 +96,20 @@ export interface DetectionOptions {
      * @default 1500
      */
     repeatAfterMs?: number;
+    /**
+     * While the card outline stays in view, at most one card is reported, even
+     * if later readings give a different name. The outline must disappear for
+     * longer than this (ms) for the next card to be read, e.g. when swapping cards.
+     * @default 500
+     */
+    cardGapMs?: number;
+    /**
+     * Two card images whose perceptual hashes differ in at most this many bits
+     * (of 64) are treated as the same card. Lower = stricter. Lets a card slid
+     * over another one be reported without the outline disappearing.
+     * @default 16
+     */
+    sameCardMaxDistance?: number;
     /**
      * The card name is looked for only in the first N lines of text on the
      * card, top to bottom.
@@ -106,7 +120,8 @@ export interface DetectionOptions {
      * Words/phrases that are never the card name (card types, subtypes...).
      * A line made only of these words is skipped, so "Trainer" or "Stage 1" are
      * ignored but "Energy Retrieval" is still a name. Replaces the defaults.
-     * @default ['Basic', 'Stage 1', 'Stage 2', 'Trainer', 'Item', 'Supporter', 'Stadium', 'Energy', 'Special Energy', 'Basic Energy', 'Pokémon', 'Pokémon Tool']
+     * Also matched without spaces, so "STAGE1" counts as "Stage 1".
+     * @default ['Basic', 'Stage', 'Stage 1', 'Stage 2', 'Trainer', 'Item', 'Supporter', 'Stadium', 'Energy', 'Special Energy', 'Basic Energy', 'Pokémon', 'Pokémon Tool', 'Tera']
      */
     reservedWords?: string[];
     /**
@@ -140,6 +155,11 @@ export interface CardDetectedEvent {
     cardBox?: Box;
     /** Base64 JPEG of the card, when `includeImage` is true. */
     image?: string;
+    /**
+     * 64-bit perceptual hash of the card image (16 hex characters). Photos of
+     * the same card give hashes that differ in only a few bits.
+     */
+    imageHash: string;
 }
 export interface CardScannerPlugin {
     /**

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   * 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   * How long (ms) the card must be out of view before the same card can be\n   * reported again. While a card stays in view it is reported only once.\n   * @default 1500\n   */\n  repeatAfterMs?: number;\n  /**\n   * The card name is looked for only in the first N lines of text on the\n   * card, top to bottom.\n   * @default 3\n   */\n  nameLines?: number;\n  /**\n   * Words/phrases that are never the card name (card types, subtypes...).\n   * A line made only of these words is skipped, so \"Trainer\" or \"Stage 1\" are\n   * ignored but \"Energy Retrieval\" is still a name. Replaces the defaults.\n   * @default ['Basic', 'Stage 1', 'Stage 2', 'Trainer', 'Item', 'Supporter', 'Stadium', 'Energy', 'Special Energy', 'Basic Energy', 'Pokémon', 'Pokémon Tool']\n   */\n  reservedWords?: string[];\n  /**\n   * Lines starting with any of these are never the card name.\n   * Replaces the defaults.\n   * @default ['Evolves from', 'HP']\n   */\n  reservedPrefixes?: string[];\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';\r\n\r\nexport type CameraPosition = 'rear' | 'front';\r\n\r\nexport interface StartOptions {\r\n  /**\r\n   * Which camera to use.\r\n   * @default 'rear'\r\n   */\r\n  position?: CameraPosition;\r\n}\r\n\r\nexport interface CaptureOptions {\r\n  /**\r\n   * JPEG quality (0-100).\r\n   * @default 85\r\n   */\r\n  quality?: number;\r\n}\r\n\r\nexport interface CaptureResult {\r\n  /** Base64 encoded JPEG (without the `data:` prefix). */\r\n  base64: string;\r\n  width: number;\r\n  height: number;\r\n}\r\n\r\nexport interface TorchOptions {\r\n  enabled: boolean;\r\n}\r\n\r\nexport interface ZoomOptions {\r\n  /** Zoom ratio, clamped between the camera's min and max. */\r\n  ratio: number;\r\n}\r\n\r\nexport interface PermissionStatus {\r\n  camera: PermissionState;\r\n}\r\n\r\nexport interface DetectionOptions {\r\n  /**\r\n   * Minimum time between two OCR runs, in milliseconds.\r\n   * The red rectangle is updated on every frame regardless.\r\n   * @default 300\r\n   */\r\n  intervalMs?: number;\r\n  /**\r\n   * How many consecutive OCR runs must read the same card before\r\n   * `cardDetected` fires.\r\n   * @default 2\r\n   */\r\n  stableFrames?: number;\r\n  /**\r\n   * Include a JPEG of the detected card in the event.\r\n   * @default false\r\n   */\r\n  includeImage?: boolean;\r\n  /**\r\n   * Expected width / height of an upright card. Only upright cards are\r\n   * detected; a card lying sideways falls outside the tolerance.\r\n   * @default 0.716 (63 x 88 mm)\r\n   */\r\n  cardAspectRatio?: number;\r\n  /**\r\n   * Allowed relative deviation from `cardAspectRatio` (0.15 = ±15%).\r\n   * Increase it if tilted cards are not detected.\r\n   * @default 0.15\r\n   */\r\n  aspectTolerance?: number;\r\n  /**\r\n   * Smallest card size, as a fraction of the camera frame (0-1).\r\n   * @default 0.08\r\n   */\r\n  minCardArea?: number;\r\n  /**\r\n   * Largest card size, as a fraction of the camera frame (0-1).\r\n   * @default 0.9\r\n   */\r\n  maxCardArea?: number;\r\n  /**\r\n   * Only read text when a card-shaped object is visible. When false, the whole\r\n   * frame is read if no card is found.\r\n   * @default true\r\n   */\r\n  requireCard?: boolean;\r\n  /**\r\n   * Every object found is always outlined: red when accepted as a card, grey\r\n   * when rejected. With `debug`, each outline is also labelled with its area\r\n   * (`a`), width/height ratio (`r`) and the filter that rejected it. Use it to\r\n   * tune the filters above.\r\n   * @default false\r\n   */\r\n  debug?: boolean;\r\n  /**\r\n   * Outline (in grey) the objects that were not accepted as a card.\r\n   * The accepted card is always outlined in red.\r\n   * @default true\r\n   */\r\n  showRejected?: boolean;\r\n  /**\r\n   * How long (ms) the card must be out of view before the same card can be\r\n   * reported again. While a card stays in view it is reported only once.\r\n   * @default 1500\r\n   */\r\n  repeatAfterMs?: number;\r\n  /**\r\n   * While the card outline stays in view, at most one card is reported, even\r\n   * if later readings give a different name. The outline must disappear for\r\n   * longer than this (ms) for the next card to be read, e.g. when swapping cards.\r\n   * @default 500\r\n   */\r\n  cardGapMs?: number;\r\n  /**\r\n   * Two card images whose perceptual hashes differ in at most this many bits\r\n   * (of 64) are treated as the same card. Lower = stricter. Lets a card slid\r\n   * over another one be reported without the outline disappearing.\r\n   * @default 16\r\n   */\r\n  sameCardMaxDistance?: number;\r\n  /**\r\n   * The card name is looked for only in the first N lines of text on the\r\n   * card, top to bottom.\r\n   * @default 3\r\n   */\r\n  nameLines?: number;\r\n  /**\r\n   * Words/phrases that are never the card name (card types, subtypes...).\r\n   * A line made only of these words is skipped, so \"Trainer\" or \"Stage 1\" are\r\n   * ignored but \"Energy Retrieval\" is still a name. Replaces the defaults.\r\n   * Also matched without spaces, so \"STAGE1\" counts as \"Stage 1\".\r\n   * @default ['Basic', 'Stage', 'Stage 1', 'Stage 2', 'Trainer', 'Item', 'Supporter', 'Stadium', 'Energy', 'Special Energy', 'Basic Energy', 'Pokémon', 'Pokémon Tool', 'Tera']\r\n   */\r\n  reservedWords?: string[];\r\n  /**\r\n   * Lines starting with any of these are never the card name.\r\n   * Replaces the defaults.\r\n   * @default ['Evolves from', 'HP']\r\n   */\r\n  reservedPrefixes?: string[];\r\n}\r\n\r\n/** Normalized rectangle (0-1). */\r\nexport interface Box {\r\n  x: number;\r\n  y: number;\r\n  width: number;\r\n  height: number;\r\n}\r\n\r\nexport interface TextLine {\r\n  text: string;\r\n  /** Position inside the card image. */\r\n  box: Box;\r\n}\r\n\r\nexport interface CardDetectedEvent {\r\n  /** Best guess for the card name (topmost line of text on the card). */\r\n  name?: string;\r\n  /** Collector number, e.g. `025/165`. */\r\n  collectorNumber?: string;\r\n  /** All text read on the card. */\r\n  text: string;\r\n  lines: TextLine[];\r\n  /** Where the card is in the camera frame. Missing if no card outline was found. */\r\n  cardBox?: Box;\r\n  /** Base64 JPEG of the card, when `includeImage` is true. */\r\n  image?: string;\r\n  /**\r\n   * 64-bit perceptual hash of the card image (16 hex characters). Photos of\r\n   * the same card give hashes that differ in only a few bits.\r\n   */\r\n  imageHash: string;\r\n}\r\n\r\nexport interface CardScannerPlugin {\r\n  /**\r\n   * Opens the camera **behind** the WebView. The WebView background is made\r\n   * transparent, so the HTML page must also use transparent backgrounds\r\n   * where the camera should be visible.\r\n   */\r\n  start(options?: StartOptions): Promise<void>;\r\n\r\n  /** Stops the camera and removes the preview. */\r\n  stop(): Promise<void>;\r\n\r\n  /** Takes a photo from the running camera. */\r\n  capture(options?: CaptureOptions): Promise<CaptureResult>;\r\n\r\n  /** Turns the flashlight on/off. */\r\n  setTorch(options: TorchOptions): Promise<void>;\r\n\r\n  /** Sets the zoom ratio. */\r\n  setZoom(options: ZoomOptions): Promise<void>;\r\n\r\n  /** Switches between the rear and front camera. */\r\n  flip(): Promise<void>;\r\n\r\n  /**\r\n   * Starts looking for cards: draws a red rectangle around the card and reads\r\n   * its text, emitting `cardDetected`. Requires `start()` first. Android only.\r\n   */\r\n  startDetection(options?: DetectionOptions): Promise<void>;\r\n\r\n  /** Stops card detection and hides the rectangle. */\r\n  stopDetection(): Promise<void>;\r\n\r\n  /** Fired once per card, when its text has been read consistently. */\r\n  addListener(eventName: 'cardDetected', listener: (event: CardDetectedEvent) => void): Promise<PluginListenerHandle>;\r\n\r\n  removeAllListeners(): Promise<void>;\r\n\r\n  checkPermissions(): Promise<PermissionStatus>;\r\n\r\n  requestPermissions(): Promise<PermissionStatus>;\r\n}\r\n"]}

package/package.json

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