zedbar 0.2.1 → 0.2.3

package/README.md

@@ -74,17 +74,18 @@ for (const { symbolType, text } of scanGrayscale(data, width, height)) {
 
 ## API
 
-### `scanImageBytes(bytes)`
+### `scanImageBytes(bytes, options?)`
 
 Scans an encoded image (PNG, JPEG, WebP, BMP) for barcodes and QR codes.
 
 **Parameters:**
 
 - `bytes` (`Uint8Array` or `Buffer`) - Raw bytes of an image file
+- `options` (`ScanOptions`, optional) - Scanning options
 
 **Returns:** `DecodeResult[]` - Array of decoded barcodes
 
-### `scanGrayscale(data, width, height)`
+### `scanGrayscale(data, width, height, options?)`
 
 Scans grayscale image data for barcodes and QR codes.
 
@@ -93,9 +94,14 @@ Scans grayscale image data for barcodes and QR codes.
 - `data` (`Uint8Array`) - Grayscale pixel data, 1 byte per pixel, row-major order
 - `width` (`number`) - Image width in pixels
 - `height` (`number`) - Image height in pixels
+- `options` (`ScanOptions`, optional) - Scanning options
 
 **Returns:** `DecodeResult[]` - Array of decoded barcodes
 
+### `ScanOptions`
+
+- `retryUndecodedRegions` (`boolean`, default: `true`) - Automatically retry undecoded QR finder regions by cropping and upscaling. Disable to skip the retry and reduce processing time for images that are known to have sufficient resolution.
+
 ### `DecodeResult`
 
 - `symbolType` (`string`) - Barcode format (e.g., `"QR-Code"`, `"EAN-13"`)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zedbar",
   "description": "Fast QR code and barcode scanner for Node.js, powered by WebAssembly",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "license": "LGPL-3.0-or-later",
   "repository": {
     "type": "git",

package/zedbar.d.ts

@@ -11,7 +11,7 @@
  *
  * Returns an array of `DecodeResult` objects.
  */
-export function scanImageBytes(bytes: Uint8Array): DecodeResult[];
+export function scanImageBytes(bytes: Uint8Array, options?: ScanOptions | null): DecodeResult[];
 /**
  * Scan grayscale image data for barcodes and QR codes.
  *
@@ -20,7 +20,7 @@ export function scanImageBytes(bytes: Uint8Array): DecodeResult[];
  *
  * Returns an array of `DecodeResult` objects.
  */
-export function scanGrayscale(data: Uint8Array, width: number, height: number): DecodeResult[];
+export function scanGrayscale(data: Uint8Array, width: number, height: number, options?: ScanOptions | null): DecodeResult[];
 /**
  * A decoded barcode/QR code result.
  */
@@ -34,10 +34,43 @@ export class DecodeResult {
   readonly symbolType: string;
   /**
    * Raw decoded bytes.
+   *
+   * For 2D codes (QR, SQ), these are the original bytes as encoded
+   * in the barcode, before any text encoding or base64 conversion.
    */
   readonly data: Uint8Array;
   /**
-   * Decoded data as UTF-8 text, or null if not valid UTF-8.
+   * Decoded data as text, or null if not decodable as text.
+   *
+   * For 2D codes, the text is produced by detecting the encoding (UTF-8,
+   * Shift-JIS, Windows-1252, etc.) and converting to a UTF-8 string.
+   * For linear barcodes, the data is always ASCII text.
    */
   readonly text: string | undefined;
 }
+/**
+ * Options for barcode scanning.
+ *
+ * All fields are optional and default to sensible values when omitted.
+ *
+ * ```js
+ * // Use defaults (retry enabled):
+ * const results = scanGrayscale(data, width, height);
+ *
+ * // Disable automatic retry of small QR codes:
+ * const results = scanGrayscale(data, width, height, { retryUndecodedRegions: false });
+ * ```
+ */
+export class ScanOptions {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new options object with defaults.
+   */
+  constructor();
+  /**
+   * Whether to automatically retry undecoded QR finder regions by
+   * cropping and upscaling them. Default: `true`.
+   */
+  set retryUndecodedRegions(value: boolean);
+}

package/zedbar.js

@@ -38,6 +38,16 @@ function passArray8ToWasm0(arg, malloc) {
     return ptr;
 }
 
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function _assertClass(instance, klass) {
+    if (!(instance instanceof klass)) {
+        throw new Error(`expected instance of ${klass.name}`);
+    }
+}
+
 function takeFromExternrefTable0(idx) {
     const value = wasm.__wbindgen_export_0.get(idx);
     wasm.__externref_table_dealloc(idx);
@@ -74,18 +84,24 @@ function getArrayJsValueFromWasm0(ptr, len) {
  *
  * Returns an array of `DecodeResult` objects.
  * @param {Uint8Array} bytes
+ * @param {ScanOptions | null} [options]
  * @returns {DecodeResult[]}
  */
-exports.scanImageBytes = function(bytes) {
+exports.scanImageBytes = function(bytes, options) {
     const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.scanImageBytes(ptr0, len0);
+    let ptr1 = 0;
+    if (!isLikeNone(options)) {
+        _assertClass(options, ScanOptions);
+        ptr1 = options.__destroy_into_raw();
+    }
+    const ret = wasm.scanImageBytes(ptr0, len0, ptr1);
     if (ret[3]) {
         throw takeFromExternrefTable0(ret[2]);
     }
-    var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
+    var v3 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
     wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
-    return v2;
+    return v3;
 };
 
 /**
@@ -98,18 +114,24 @@ exports.scanImageBytes = function(bytes) {
  * @param {Uint8Array} data
  * @param {number} width
  * @param {number} height
+ * @param {ScanOptions | null} [options]
  * @returns {DecodeResult[]}
  */
-exports.scanGrayscale = function(data, width, height) {
+exports.scanGrayscale = function(data, width, height, options) {
     const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.scanGrayscale(ptr0, len0, width, height);
+    let ptr1 = 0;
+    if (!isLikeNone(options)) {
+        _assertClass(options, ScanOptions);
+        ptr1 = options.__destroy_into_raw();
+    }
+    const ret = wasm.scanGrayscale(ptr0, len0, width, height, ptr1);
     if (ret[3]) {
         throw takeFromExternrefTable0(ret[2]);
     }
-    var v2 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
+    var v3 = getArrayJsValueFromWasm0(ret[0], ret[1]).slice();
     wasm.__wbindgen_free(ret[0], ret[1] * 4, 4);
-    return v2;
+    return v3;
 };
 
 const DecodeResultFinalization = (typeof FinalizationRegistry === 'undefined')
@@ -157,6 +179,9 @@ class DecodeResult {
     }
     /**
      * Raw decoded bytes.
+     *
+     * For 2D codes (QR, SQ), these are the original bytes as encoded
+     * in the barcode, before any text encoding or base64 conversion.
      * @returns {Uint8Array}
      */
     get data() {
@@ -166,7 +191,11 @@ class DecodeResult {
         return v1;
     }
     /**
-     * Decoded data as UTF-8 text, or null if not valid UTF-8.
+     * Decoded data as text, or null if not decodable as text.
+     *
+     * For 2D codes, the text is produced by detecting the encoding (UTF-8,
+     * Shift-JIS, Windows-1252, etc.) and converting to a UTF-8 string.
+     * For linear barcodes, the data is always ASCII text.
      * @returns {string | undefined}
      */
     get text() {
@@ -183,6 +212,57 @@ if (Symbol.dispose) DecodeResult.prototype[Symbol.dispose] = DecodeResult.protot
 
 exports.DecodeResult = DecodeResult;
 
+const ScanOptionsFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_scanoptions_free(ptr >>> 0, 1));
+/**
+ * Options for barcode scanning.
+ *
+ * All fields are optional and default to sensible values when omitted.
+ *
+ * ```js
+ * // Use defaults (retry enabled):
+ * const results = scanGrayscale(data, width, height);
+ *
+ * // Disable automatic retry of small QR codes:
+ * const results = scanGrayscale(data, width, height, { retryUndecodedRegions: false });
+ * ```
+ */
+class ScanOptions {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        ScanOptionsFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_scanoptions_free(ptr, 0);
+    }
+    /**
+     * Whether to automatically retry undecoded QR finder regions by
+     * cropping and upscaling them. Default: `true`.
+     * @param {boolean} value
+     */
+    set retryUndecodedRegions(value) {
+        wasm.scanoptions_set_retryUndecodedRegions(this.__wbg_ptr, value);
+    }
+    /**
+     * Create a new options object with defaults.
+     */
+    constructor() {
+        const ret = wasm.scanoptions_new();
+        this.__wbg_ptr = ret >>> 0;
+        ScanOptionsFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+}
+if (Symbol.dispose) ScanOptions.prototype[Symbol.dispose] = ScanOptions.prototype.free;
+
+exports.ScanOptions = ScanOptions;
+
 exports.__wbg_decoderesult_new = function(arg0) {
     const ret = DecodeResult.__wrap(arg0);
     return ret;