zedbar 0.2.2 → 0.2.3

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.2",
+  "version": "0.2.3",
   "license": "LGPL-3.0-or-later",
   "repository": {
     "type": "git",

package/zedbar.d.ts

@@ -1,14 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * Scan grayscale image data for barcodes and QR codes.
- *
- * `data` must be an array of 8-bit grayscale pixel values,
- * row-major, with dimensions `width` x `height`.
- *
- * Returns an array of `DecodeResult` objects.
- */
-export function scanGrayscale(data: Uint8Array, width: number, height: number, options?: ScanOptions | null): DecodeResult[];
 /**
  * Scan an encoded image (PNG, JPEG, BMP, WebP) for barcodes and QR codes.
  *
@@ -21,6 +12,15 @@ export function scanGrayscale(data: Uint8Array, width: number, height: number, o
  * Returns an array of `DecodeResult` objects.
  */
 export function scanImageBytes(bytes: Uint8Array, options?: ScanOptions | null): DecodeResult[];
+/**
+ * Scan grayscale image data for barcodes and QR codes.
+ *
+ * `data` must be an array of 8-bit grayscale pixel values,
+ * row-major, with dimensions `width` x `height`.
+ *
+ * Returns an array of `DecodeResult` objects.
+ */
+export function scanGrayscale(data: Uint8Array, width: number, height: number, options?: ScanOptions | null): DecodeResult[];
 /**
  * A decoded barcode/QR code result.
  */
@@ -34,10 +34,17 @@ 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;
 }

package/zedbar.js

@@ -74,27 +74,28 @@ function getArrayJsValueFromWasm0(ptr, len) {
     return result;
 }
 /**
- * Scan grayscale image data for barcodes and QR codes.
+ * Scan an encoded image (PNG, JPEG, BMP, WebP) for barcodes and QR codes.
  *
- * `data` must be an array of 8-bit grayscale pixel values,
- * row-major, with dimensions `width` x `height`.
+ * `bytes` should contain the raw bytes of an image file in one of the
+ * supported formats: PNG, JPEG, BMP, or WebP.
+ *
+ * The image will be automatically decoded and converted to grayscale
+ * before scanning.
  *
  * Returns an array of `DecodeResult` objects.
- * @param {Uint8Array} data
- * @param {number} width
- * @param {number} height
+ * @param {Uint8Array} bytes
  * @param {ScanOptions | null} [options]
  * @returns {DecodeResult[]}
  */
-exports.scanGrayscale = function(data, width, height, options) {
-    const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+exports.scanImageBytes = function(bytes, options) {
+    const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
     let ptr1 = 0;
     if (!isLikeNone(options)) {
         _assertClass(options, ScanOptions);
         ptr1 = options.__destroy_into_raw();
     }
-    const ret = wasm.scanGrayscale(ptr0, len0, width, height, ptr1);
+    const ret = wasm.scanImageBytes(ptr0, len0, ptr1);
     if (ret[3]) {
         throw takeFromExternrefTable0(ret[2]);
     }
@@ -104,28 +105,27 @@ exports.scanGrayscale = function(data, width, height, options) {
 };
 
 /**
- * Scan an encoded image (PNG, JPEG, BMP, WebP) for barcodes and QR codes.
- *
- * `bytes` should contain the raw bytes of an image file in one of the
- * supported formats: PNG, JPEG, BMP, or WebP.
+ * Scan grayscale image data for barcodes and QR codes.
  *
- * The image will be automatically decoded and converted to grayscale
- * before scanning.
+ * `data` must be an array of 8-bit grayscale pixel values,
+ * row-major, with dimensions `width` x `height`.
  *
  * Returns an array of `DecodeResult` objects.
- * @param {Uint8Array} bytes
+ * @param {Uint8Array} data
+ * @param {number} width
+ * @param {number} height
  * @param {ScanOptions | null} [options]
  * @returns {DecodeResult[]}
  */
-exports.scanImageBytes = function(bytes, options) {
-    const ptr0 = passArray8ToWasm0(bytes, wasm.__wbindgen_malloc);
+exports.scanGrayscale = function(data, width, height, options) {
+    const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
     const len0 = WASM_VECTOR_LEN;
     let ptr1 = 0;
     if (!isLikeNone(options)) {
         _assertClass(options, ScanOptions);
         ptr1 = options.__destroy_into_raw();
     }
-    const ret = wasm.scanImageBytes(ptr0, len0, ptr1);
+    const ret = wasm.scanGrayscale(ptr0, len0, width, height, ptr1);
     if (ret[3]) {
         throw takeFromExternrefTable0(ret[2]);
     }
@@ -179,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() {
@@ -188,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() {