rxing-wasm 0.2.10 → 0.3.0

package/README.md

@@ -1,6 +1,10 @@
 # rxing-wasm
 WASM bindings for common rxing functions. The NPM link is [https://www.npmjs.com/package/rxing-wasm](https://www.npmjs.com/package/rxing-wasm) and the rust source is [https://github.com/rxing-core/rxing-wasm](https://github.com/hschimke/rxing-wasm).
 
+## Decode Multi Breaking Change with v0.3.0
+Version `0.3.0` now returns `BarcodeResult` objects in a native javascript array. This fully deprecates the old method
+which returned a custom object with internal state.
+
 ## Data
 The `convert_js_image_to_luma` function is used to convert canvas image data to the luma 8
 format that rxing expects. An example might look like to below.
@@ -99,7 +103,8 @@ pub fn decode_multi(
     width: u32,
     height: u32,
     hints: &mut decode_hints::DecodeHintDictionary,
-) -> Result<MultiDecodeResult, String>;
+    filter_image: Option<bool>,
+) -> Result<Vec<BarcodeResult>, String>;
 ```
 
 ```rust
@@ -113,6 +118,4 @@ pub fn encode_barcode_with_hints(
 ```
 
 ## Beta Features
-`decode_multi` is currently in beta. The output may be unexpected, or undefined. Please use with caution. The interface may be unstable, and change.
-
 `encode_barcode_with_hints` is currently in alpha. The output and behaviour is unexpected and poorly documented. Use at your own risk, feature may change, unstable interface.

package/package.json

@@ -2,7 +2,7 @@
   "name": "rxing-wasm",
   "type": "module",
   "description": "wasm bindings for rxing to provide commong barcode operations (decode/encode)",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "license": "Apache 2.0",
   "repository": {
     "type": "git",

package/rxing_wasm.d.ts

@@ -65,9 +65,10 @@ export function decode_barcode_with_hints(data: Uint8Array, width: number, heigh
 * @param {number} width
 * @param {number} height
 * @param {DecodeHintDictionary} hints
-* @returns {MultiDecodeResult}
+* @param {boolean | undefined} [filter_image]
+* @returns {(BarcodeResult)[]}
 */
-export function decode_multi(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary): MultiDecodeResult;
+export function decode_multi(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary, filter_image?: boolean): (BarcodeResult)[];
 /**
 */
 export enum EncodeHintTypes {
@@ -241,6 +242,83 @@ export enum EncodeHintTypes {
   TelepenAsNumeric = 19,
 }
 /**
+* Available barcode types
+*/
+export enum BarcodeFormat {
+/**
+* Aztec 2D barcode format. 
+*/
+  AZTEC = 0,
+/**
+* CODABAR 1D format. 
+*/
+  CODABAR = 1,
+/**
+* Code 39 1D format. 
+*/
+  Code39 = 2,
+/**
+* Code 93 1D format. 
+*/
+  Code93 = 3,
+/**
+* Code 128 1D format. 
+*/
+  Code128 = 4,
+/**
+* Data Matrix 2D barcode format. 
+*/
+  DataMatrix = 5,
+/**
+* EAN-8 1D format. 
+*/
+  Ean8 = 6,
+/**
+* EAN-13 1D format. 
+*/
+  Ean13 = 7,
+/**
+* ITF (Interleaved Two of Five) 1D format. 
+*/
+  ITF = 8,
+/**
+* MaxiCode 2D barcode format. 
+*/
+  MAXICODE = 9,
+/**
+* PDF417 format. 
+*/
+  Pdf417 = 10,
+/**
+* QR Code 2D barcode format. 
+*/
+  QrCode = 11,
+/**
+* RSS 14 
+*/
+  Rss14 = 12,
+/**
+* RSS EXPANDED 
+*/
+  RssExpanded = 13,
+/**
+* UPC-A 1D format. 
+*/
+  UpcA = 14,
+/**
+* UPC-E 1D format. 
+*/
+  UpcE = 15,
+/**
+* UPC/EAN extension format. Not a stand-alone format. 
+*/
+  UpcEanExtension = 16,
+  MicroQR = 17,
+  Telepen = 18,
+  RectangularMicroQR = 19,
+  UnsuportedFormat = 20,
+}
+/**
 */
 export enum DecodeHintTypes {
 /**
@@ -337,83 +415,6 @@ export enum DecodeHintTypes {
   TelepenAsNumeric = 12,
 }
 /**
-* Available barcode types
-*/
-export enum BarcodeFormat {
-/**
-* Aztec 2D barcode format. 
-*/
-  AZTEC = 0,
-/**
-* CODABAR 1D format. 
-*/
-  CODABAR = 1,
-/**
-* Code 39 1D format. 
-*/
-  Code39 = 2,
-/**
-* Code 93 1D format. 
-*/
-  Code93 = 3,
-/**
-* Code 128 1D format. 
-*/
-  Code128 = 4,
-/**
-* Data Matrix 2D barcode format. 
-*/
-  DataMatrix = 5,
-/**
-* EAN-8 1D format. 
-*/
-  Ean8 = 6,
-/**
-* EAN-13 1D format. 
-*/
-  Ean13 = 7,
-/**
-* ITF (Interleaved Two of Five) 1D format. 
-*/
-  ITF = 8,
-/**
-* MaxiCode 2D barcode format. 
-*/
-  MAXICODE = 9,
-/**
-* PDF417 format. 
-*/
-  Pdf417 = 10,
-/**
-* QR Code 2D barcode format. 
-*/
-  QrCode = 11,
-/**
-* RSS 14 
-*/
-  Rss14 = 12,
-/**
-* RSS EXPANDED 
-*/
-  RssExpanded = 13,
-/**
-* UPC-A 1D format. 
-*/
-  UpcA = 14,
-/**
-* UPC-E 1D format. 
-*/
-  UpcE = 15,
-/**
-* UPC/EAN extension format. Not a stand-alone format. 
-*/
-  UpcEanExtension = 16,
-  MicroQR = 17,
-  Telepen = 18,
-  RectangularMicroQR = 19,
-  UnsuportedFormat = 20,
-}
-/**
 */
 export class BarcodeResult {
   free(): void;
@@ -495,15 +496,3 @@ export class EncodeHintDictionary {
 */
   remove_hint(hint: EncodeHintTypes): boolean;
 }
-/**
-*/
-export class MultiDecodeResult {
-  free(): void;
-/**
-*/
-  constructor();
-/**
-* @returns {BarcodeResult | undefined}
-*/
-  next(): BarcodeResult | undefined;
-}

package/rxing_wasm_bg.js

@@ -349,27 +349,41 @@ export function decode_barcode_with_hints(data, width, height, hints, filter_ima
     }
 }
 
+function getArrayJsValueFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    const mem = getUint32Memory0();
+    const slice = mem.subarray(ptr / 4, ptr / 4 + len);
+    const result = [];
+    for (let i = 0; i < slice.length; i++) {
+        result.push(takeObject(slice[i]));
+    }
+    return result;
+}
 /**
 * @param {Uint8Array} data
 * @param {number} width
 * @param {number} height
 * @param {DecodeHintDictionary} hints
-* @returns {MultiDecodeResult}
+* @param {boolean | undefined} [filter_image]
+* @returns {(BarcodeResult)[]}
 */
-export function decode_multi(data, width, height, hints) {
+export function decode_multi(data, width, height, hints, filter_image) {
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
         const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
         const len0 = WASM_VECTOR_LEN;
         _assertClass(hints, DecodeHintDictionary);
-        wasm.decode_multi(retptr, ptr0, len0, width, height, hints.__wbg_ptr);
+        wasm.decode_multi(retptr, ptr0, len0, width, height, hints.__wbg_ptr, isLikeNone(filter_image) ? 0xFFFFFF : filter_image ? 1 : 0);
         var r0 = getInt32Memory0()[retptr / 4 + 0];
         var r1 = getInt32Memory0()[retptr / 4 + 1];
         var r2 = getInt32Memory0()[retptr / 4 + 2];
-        if (r2) {
-            throw takeObject(r1);
+        var r3 = getInt32Memory0()[retptr / 4 + 3];
+        if (r3) {
+            throw takeObject(r2);
         }
-        return MultiDecodeResult.__wrap(r0);
+        var v2 = getArrayJsValueFromWasm0(r0, r1).slice();
+        wasm.__wbindgen_free(r0, r1 * 4, 4);
+        return v2;
     } finally {
         wasm.__wbindgen_add_to_stack_pointer(16);
     }
@@ -546,6 +560,78 @@ ForceC40:17,"17":"ForceC40",
 */
 Code128Compact:18,"18":"Code128Compact",TelepenAsNumeric:19,"19":"TelepenAsNumeric", });
 /**
+* Available barcode types
+*/
+export const BarcodeFormat = Object.freeze({
+/**
+* Aztec 2D barcode format.
+*/
+AZTEC:0,"0":"AZTEC",
+/**
+* CODABAR 1D format.
+*/
+CODABAR:1,"1":"CODABAR",
+/**
+* Code 39 1D format.
+*/
+Code39:2,"2":"Code39",
+/**
+* Code 93 1D format.
+*/
+Code93:3,"3":"Code93",
+/**
+* Code 128 1D format.
+*/
+Code128:4,"4":"Code128",
+/**
+* Data Matrix 2D barcode format.
+*/
+DataMatrix:5,"5":"DataMatrix",
+/**
+* EAN-8 1D format.
+*/
+Ean8:6,"6":"Ean8",
+/**
+* EAN-13 1D format.
+*/
+Ean13:7,"7":"Ean13",
+/**
+* ITF (Interleaved Two of Five) 1D format.
+*/
+ITF:8,"8":"ITF",
+/**
+* MaxiCode 2D barcode format.
+*/
+MAXICODE:9,"9":"MAXICODE",
+/**
+* PDF417 format.
+*/
+Pdf417:10,"10":"Pdf417",
+/**
+* QR Code 2D barcode format.
+*/
+QrCode:11,"11":"QrCode",
+/**
+* RSS 14
+*/
+Rss14:12,"12":"Rss14",
+/**
+* RSS EXPANDED
+*/
+RssExpanded:13,"13":"RssExpanded",
+/**
+* UPC-A 1D format.
+*/
+UpcA:14,"14":"UpcA",
+/**
+* UPC-E 1D format.
+*/
+UpcE:15,"15":"UpcE",
+/**
+* UPC/EAN extension format. Not a stand-alone format.
+*/
+UpcEanExtension:16,"16":"UpcEanExtension",MicroQR:17,"17":"MicroQR",Telepen:18,"18":"Telepen",RectangularMicroQR:19,"19":"RectangularMicroQR",UnsuportedFormat:20,"20":"UnsuportedFormat", });
+/**
 */
 export const DecodeHintTypes = Object.freeze({
 /**
@@ -640,78 +726,6 @@ AlsoInverted:11,"11":"AlsoInverted",
 *
 */
 TelepenAsNumeric:12,"12":"TelepenAsNumeric", });
-/**
-* Available barcode types
-*/
-export const BarcodeFormat = Object.freeze({
-/**
-* Aztec 2D barcode format.
-*/
-AZTEC:0,"0":"AZTEC",
-/**
-* CODABAR 1D format.
-*/
-CODABAR:1,"1":"CODABAR",
-/**
-* Code 39 1D format.
-*/
-Code39:2,"2":"Code39",
-/**
-* Code 93 1D format.
-*/
-Code93:3,"3":"Code93",
-/**
-* Code 128 1D format.
-*/
-Code128:4,"4":"Code128",
-/**
-* Data Matrix 2D barcode format.
-*/
-DataMatrix:5,"5":"DataMatrix",
-/**
-* EAN-8 1D format.
-*/
-Ean8:6,"6":"Ean8",
-/**
-* EAN-13 1D format.
-*/
-Ean13:7,"7":"Ean13",
-/**
-* ITF (Interleaved Two of Five) 1D format.
-*/
-ITF:8,"8":"ITF",
-/**
-* MaxiCode 2D barcode format.
-*/
-MAXICODE:9,"9":"MAXICODE",
-/**
-* PDF417 format.
-*/
-Pdf417:10,"10":"Pdf417",
-/**
-* QR Code 2D barcode format.
-*/
-QrCode:11,"11":"QrCode",
-/**
-* RSS 14
-*/
-Rss14:12,"12":"Rss14",
-/**
-* RSS EXPANDED
-*/
-RssExpanded:13,"13":"RssExpanded",
-/**
-* UPC-A 1D format.
-*/
-UpcA:14,"14":"UpcA",
-/**
-* UPC-E 1D format.
-*/
-UpcE:15,"15":"UpcE",
-/**
-* UPC/EAN extension format. Not a stand-alone format.
-*/
-UpcEanExtension:16,"16":"UpcEanExtension",MicroQR:17,"17":"MicroQR",Telepen:18,"18":"Telepen",RectangularMicroQR:19,"19":"RectangularMicroQR",UnsuportedFormat:20,"20":"UnsuportedFormat", });
 
 const BarcodeResultFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
@@ -953,48 +967,6 @@ export class EncodeHintDictionary {
     }
 }
 
-const MultiDecodeResultFinalization = (typeof FinalizationRegistry === 'undefined')
-    ? { register: () => {}, unregister: () => {} }
-    : new FinalizationRegistry(ptr => wasm.__wbg_multidecoderesult_free(ptr >>> 0));
-/**
-*/
-export class MultiDecodeResult {
-
-    static __wrap(ptr) {
-        ptr = ptr >>> 0;
-        const obj = Object.create(MultiDecodeResult.prototype);
-        obj.__wbg_ptr = ptr;
-        MultiDecodeResultFinalization.register(obj, obj.__wbg_ptr, obj);
-        return obj;
-    }
-
-    __destroy_into_raw() {
-        const ptr = this.__wbg_ptr;
-        this.__wbg_ptr = 0;
-        MultiDecodeResultFinalization.unregister(this);
-        return ptr;
-    }
-
-    free() {
-        const ptr = this.__destroy_into_raw();
-        wasm.__wbg_multidecoderesult_free(ptr);
-    }
-    /**
-    */
-    constructor() {
-        const ret = wasm.multidecoderesult_new();
-        this.__wbg_ptr = ret >>> 0;
-        return this;
-    }
-    /**
-    * @returns {BarcodeResult | undefined}
-    */
-    next() {
-        const ret = wasm.multidecoderesult_next(this.__wbg_ptr);
-        return ret === 0 ? undefined : BarcodeResult.__wrap(ret);
-    }
-}
-
 export function __wbindgen_object_drop_ref(arg0) {
     takeObject(arg0);
 };
@@ -1004,6 +976,11 @@ export function __wbindgen_string_new(arg0, arg1) {
     return addHeapObject(ret);
 };
 
+export function __wbg_barcoderesult_new(arg0) {
+    const ret = BarcodeResult.__wrap(arg0);
+    return addHeapObject(ret);
+};
+
 export function __wbg_new_d9bc3a0147634640() {
     const ret = new Map();
     return addHeapObject(ret);