rxing-wasm 0.2.11 → 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.11",
+  "version": "0.3.0",
   "license": "Apache 2.0",
   "repository": {
     "type": "git",

package/rxing_wasm.d.ts

@@ -65,105 +65,10 @@ export function decode_barcode_with_hints(data: Uint8Array, width: number, heigh
 * @param {number} width
 * @param {number} height
 * @param {DecodeHintDictionary} hints
-* @returns {MultiDecodeResult}
-*/
-export function decode_multi(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary): MultiDecodeResult;
-/**
-*/
-export enum DecodeHintTypes {
-/**
-*
-*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
-*     
-*/
-  Other = 0,
-/**
-*
-*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
-*     
-*/
-  PureBarcode = 1,
-/**
-*
-*     * Image is known to be of one of a few possible formats.
-*     * Maps to a {@link List} of {@link BarcodeFormat}s.
-*     
-*/
-  PossibleFormats = 2,
-/**
-*
-*     * Spend more time to try to find a barcode; optimize for accuracy, not speed.
-*     * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
-*     
-*/
-  TryHarder = 3,
-/**
-*
-*     * Specifies what character encoding to use when decoding, where applicable (type String)
-*     
-*/
-  CharacterSet = 4,
-/**
-*
-*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
-*     
-*/
-  AllowedLengths = 5,
-/**
-*
-*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
-*     
-*/
-  AssumeCode39CheckDigit = 6,
-/**
-*
-*     * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
-*     * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
-*     
-*/
-  AssumeGs1 = 7,
-/**
-*
-*     * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
-*     * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
-*     * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
-*     
-*/
-  ReturnCodabarStartEnd = 8,
-/**
-*
-*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
-*     * is found. Maps to a {@link RXingResultPointCallback}.
-*     
-*/
-  NeedResultPointCallback = 9,
-/**
-*
-*     * Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this.
-*     * Maps to an {@code int[]} of the allowed extension lengths, for example [2], [5], or [2, 5].
-*     * If it is optional to have an extension, do not set this hint. If this is set,
-*     * and a UPC or EAN barcode is found but an extension is not, then no result will be returned
-*     * at all.
-*     
-*/
-  AllowedEanExtensions = 10,
-/**
-*
-*     * If true, also tries to decode as inverted image. All configured decoders are simply called a
-*     * second time with an inverted image. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
-*     
-*/
-  AlsoInverted = 11,
-/**
-*
-*     * Translate the ASCII values parsed by the Telepen reader into the Telepen Numeric form; use {@link Boolean#TRUE}.
-*     
+* @param {boolean | undefined} [filter_image]
+* @returns {(BarcodeResult)[]}
 */
-  TelepenAsNumeric = 12,
-}
+export function decode_multi(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary, filter_image?: boolean): (BarcodeResult)[];
 /**
 */
 export enum EncodeHintTypes {
@@ -415,6 +320,102 @@ export enum BarcodeFormat {
 }
 /**
 */
+export enum DecodeHintTypes {
+/**
+*
+*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
+*     
+*/
+  Other = 0,
+/**
+*
+*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*     
+*/
+  PureBarcode = 1,
+/**
+*
+*     * Image is known to be of one of a few possible formats.
+*     * Maps to a {@link List} of {@link BarcodeFormat}s.
+*     
+*/
+  PossibleFormats = 2,
+/**
+*
+*     * Spend more time to try to find a barcode; optimize for accuracy, not speed.
+*     * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*     
+*/
+  TryHarder = 3,
+/**
+*
+*     * Specifies what character encoding to use when decoding, where applicable (type String)
+*     
+*/
+  CharacterSet = 4,
+/**
+*
+*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
+*     
+*/
+  AllowedLengths = 5,
+/**
+*
+*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*     
+*/
+  AssumeCode39CheckDigit = 6,
+/**
+*
+*     * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
+*     * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*     
+*/
+  AssumeGs1 = 7,
+/**
+*
+*     * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
+*     * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
+*     * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*     
+*/
+  ReturnCodabarStartEnd = 8,
+/**
+*
+*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
+*     * is found. Maps to a {@link RXingResultPointCallback}.
+*     
+*/
+  NeedResultPointCallback = 9,
+/**
+*
+*     * Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this.
+*     * Maps to an {@code int[]} of the allowed extension lengths, for example [2], [5], or [2, 5].
+*     * If it is optional to have an extension, do not set this hint. If this is set,
+*     * and a UPC or EAN barcode is found but an extension is not, then no result will be returned
+*     * at all.
+*     
+*/
+  AllowedEanExtensions = 10,
+/**
+*
+*     * If true, also tries to decode as inverted image. All configured decoders are simply called a
+*     * second time with an inverted image. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*     
+*/
+  AlsoInverted = 11,
+/**
+*
+*     * Translate the ASCII values parsed by the Telepen reader into the Telepen Numeric form; use {@link Boolean#TRUE}.
+*     
+*/
+  TelepenAsNumeric = 12,
+}
+/**
+*/
 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,127 +349,46 @@ 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);
     }
 }
 
-/**
-*/
-export const DecodeHintTypes = Object.freeze({
-/**
-*
-*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
-*
-*/
-Other:0,"0":"Other",
-/**
-*
-*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
-*
-*/
-PureBarcode:1,"1":"PureBarcode",
-/**
-*
-*     * Image is known to be of one of a few possible formats.
-*     * Maps to a {@link List} of {@link BarcodeFormat}s.
-*
-*/
-PossibleFormats:2,"2":"PossibleFormats",
-/**
-*
-*     * Spend more time to try to find a barcode; optimize for accuracy, not speed.
-*     * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
-*
-*/
-TryHarder:3,"3":"TryHarder",
-/**
-*
-*     * Specifies what character encoding to use when decoding, where applicable (type String)
-*
-*/
-CharacterSet:4,"4":"CharacterSet",
-/**
-*
-*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
-*
-*/
-AllowedLengths:5,"5":"AllowedLengths",
-/**
-*
-*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
-*
-*/
-AssumeCode39CheckDigit:6,"6":"AssumeCode39CheckDigit",
-/**
-*
-*     * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
-*     * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
-*
-*/
-AssumeGs1:7,"7":"AssumeGs1",
-/**
-*
-*     * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
-*     * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
-*     * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
-*
-*/
-ReturnCodabarStartEnd:8,"8":"ReturnCodabarStartEnd",
-/**
-*
-*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
-*     * is found. Maps to a {@link RXingResultPointCallback}.
-*
-*/
-NeedResultPointCallback:9,"9":"NeedResultPointCallback",
-/**
-*
-*     * Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this.
-*     * Maps to an {@code int[]} of the allowed extension lengths, for example [2], [5], or [2, 5].
-*     * If it is optional to have an extension, do not set this hint. If this is set,
-*     * and a UPC or EAN barcode is found but an extension is not, then no result will be returned
-*     * at all.
-*
-*/
-AllowedEanExtensions:10,"10":"AllowedEanExtensions",
-/**
-*
-*     * If true, also tries to decode as inverted image. All configured decoders are simply called a
-*     * second time with an inverted image. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
-*
-*/
-AlsoInverted:11,"11":"AlsoInverted",
-/**
-*
-*     * Translate the ASCII values parsed by the Telepen reader into the Telepen Numeric form; use {@link Boolean#TRUE}.
-*
-*/
-TelepenAsNumeric:12,"12":"TelepenAsNumeric", });
 /**
 */
 export const EncodeHintTypes = Object.freeze({
@@ -712,6 +631,101 @@ 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({
+/**
+*
+*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
+*
+*/
+Other:0,"0":"Other",
+/**
+*
+*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*
+*/
+PureBarcode:1,"1":"PureBarcode",
+/**
+*
+*     * Image is known to be of one of a few possible formats.
+*     * Maps to a {@link List} of {@link BarcodeFormat}s.
+*
+*/
+PossibleFormats:2,"2":"PossibleFormats",
+/**
+*
+*     * Spend more time to try to find a barcode; optimize for accuracy, not speed.
+*     * Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*
+*/
+TryHarder:3,"3":"TryHarder",
+/**
+*
+*     * Specifies what character encoding to use when decoding, where applicable (type String)
+*
+*/
+CharacterSet:4,"4":"CharacterSet",
+/**
+*
+*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
+*
+*/
+AllowedLengths:5,"5":"AllowedLengths",
+/**
+*
+*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*
+*/
+AssumeCode39CheckDigit:6,"6":"AssumeCode39CheckDigit",
+/**
+*
+*     * Assume the barcode is being processed as a GS1 barcode, and modify behavior as needed.
+*     * For example this affects FNC1 handling for Code 128 (aka GS1-128). Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
+*
+*/
+AssumeGs1:7,"7":"AssumeGs1",
+/**
+*
+*     * If true, return the start and end digits in a Codabar barcode instead of stripping them. They
+*     * are alpha, whereas the rest are numeric. By default, they are stripped, but this causes them
+*     * to not be. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*
+*/
+ReturnCodabarStartEnd:8,"8":"ReturnCodabarStartEnd",
+/**
+*
+*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
+*     * is found. Maps to a {@link RXingResultPointCallback}.
+*
+*/
+NeedResultPointCallback:9,"9":"NeedResultPointCallback",
+/**
+*
+*     * Allowed extension lengths for EAN or UPC barcodes. Other formats will ignore this.
+*     * Maps to an {@code int[]} of the allowed extension lengths, for example [2], [5], or [2, 5].
+*     * If it is optional to have an extension, do not set this hint. If this is set,
+*     * and a UPC or EAN barcode is found but an extension is not, then no result will be returned
+*     * at all.
+*
+*/
+AllowedEanExtensions:10,"10":"AllowedEanExtensions",
+/**
+*
+*     * If true, also tries to decode as inverted image. All configured decoders are simply called a
+*     * second time with an inverted image. Doesn't matter what it maps to; use {@link Boolean#TRUE}.
+*
+*/
+AlsoInverted:11,"11":"AlsoInverted",
+/**
+*
+*     * Translate the ASCII values parsed by the Telepen reader into the Telepen Numeric form; use {@link Boolean#TRUE}.
+*
+*/
+TelepenAsNumeric:12,"12":"TelepenAsNumeric", });
 
 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);