rxing-wasm 0.2.1 → 0.2.3

package/README.md

@@ -102,5 +102,17 @@ pub fn decode_multi(
 ) -> Result<MultiDecodeResult, String>;
 ```
 
+```rust
+pub fn encode_barcode_with_hints(
+    data: &str,
+    width: u32,
+    height: u32,
+    bc_type: BarcodeFormat,
+    hints: &mut EncodeHintDictionary,
+) -> Result<String, String>;
+```
+
 ## 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.
+`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

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

package/rxing_wasm.d.ts

@@ -10,6 +10,16 @@
 */
 export function encode_barcode(data: string, width: number, height: number, bc_type: number): string;
 /**
+* Encode a barcode with the given data, dimensions, and type, use the given encoding hints
+* @param {string} data
+* @param {number} width
+* @param {number} height
+* @param {number} bc_type
+* @param {EncodeHintDictionary} hints
+* @returns {string}
+*/
+export function encode_barcode_with_hints(data: string, width: number, height: number, bc_type: number, hints: EncodeHintDictionary): string;
+/**
 * Decode a barcode from an array of 8bit luma data
 * @param {Uint8Array} data
 * @param {number} width
@@ -57,6 +67,178 @@ export function decode_barcode_with_hints(data: Uint8Array, width: number, heigh
 */
 export function decode_multi(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary): MultiDecodeResult;
 /**
+*/
+export enum EncodeHintTypes {
+/**
+*
+*     * Specifies what degree of error correction to use, for example in QR Codes.
+*     * Type depends on the encoder. For example for QR codes it's type
+*     * {@link com.google.zxing.qrcode.decoder.ErrorCorrectionLevel ErrorCorrectionLevel}.
+*     * For Aztec it is of type {@link Integer}, representing the minimal percentage of error correction words.
+*     * For PDF417 it is of type {@link Integer}, valid values being 0 to 8.
+*     * In all cases, it can also be a {@link String} representation of the desired value as well.
+*     * Note: an Aztec symbol should have a minimum of 25% EC words.
+*     
+*/
+  ErrorCorrection = 0,
+/**
+*
+*     * Specifies what character encoding to use where applicable (type {@link String})
+*     
+*/
+  CharacterSet = 1,
+/**
+*
+*     * Specifies the matrix shape for Data Matrix (type {@link com.google.zxing.datamatrix.encoder.SymbolShapeHint})
+*     
+*/
+  DataMatrixShape = 2,
+/**
+*
+*     * Specifies whether to use compact mode for Data Matrix (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     * The compact encoding mode also supports the encoding of characters that are not in the ISO-8859-1
+*     * character set via ECIs.
+*     * Please note that in that case, the most compact character encoding is chosen for characters in
+*     * the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not
+*     * support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by
+*     * means of the {@link #CHARACTER_SET} encoding hint.
+*     * Compact encoding also provides GS1-FNC1 support when {@link #GS1_FORMAT} is selected. In this case
+*     * group-separator character (ASCII 29 decimal) can be used to encode the positions of FNC1 codewords
+*     * for the purpose of delimiting AIs.
+*     * This option and {@link #FORCE_C40} are mutually exclusive.
+*     
+*/
+  DataMatrixCompact = 3,
+/**
+*
+*     * Specifies a minimum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.
+*     *
+*     * @deprecated use width/height params in
+*     * {@link com.google.zxing.datamatrix.DataMatrixWriter#encode(String, BarcodeFormat, int, int)}
+*     
+*/
+  MinSize = 4,
+/**
+*
+*     * Specifies a maximum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.
+*     *
+*     * @deprecated without replacement
+*     
+*/
+  MaxSize = 5,
+/**
+*
+*     * Specifies margin, in pixels, to use when generating the barcode. The meaning can vary
+*     * by format; for example it controls margin before and after the barcode horizontally for
+*     * most 1D formats. (Type {@link Integer}, or {@link String} representation of the integer value).
+*     
+*/
+  MARGIN = 6,
+/**
+*
+*     * Specifies whether to use compact mode for PDF417 (type {@link Boolean}, or "true" or "false"
+*     * {@link String} value).
+*     
+*/
+  Pdf417Compact = 7,
+/**
+*
+*     * Specifies what compaction mode to use for PDF417 (type
+*     * {@link com.google.zxing.pdf417.encoder.Compaction Compaction} or {@link String} value of one of its
+*     * enum values).
+*     
+*/
+  Pdf417Compaction = 8,
+/**
+*
+*     * Specifies the minimum and maximum number of rows and columns for PDF417 (type
+*     * {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}).
+*     
+*/
+  Pdf417Dimensions = 9,
+/**
+*
+*     * Specifies whether to automatically insert ECIs when encoding PDF417 (type {@link Boolean}, or "true" or "false"
+*     * {@link String} value).
+*     * Please note that in that case, the most compact character encoding is chosen for characters in
+*     * the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not
+*     * support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by
+*     * means of the {@link #CHARACTER_SET} encoding hint.
+*     
+*/
+  Pdf417AutoEci = 10,
+/**
+*
+*     * Specifies the required number of layers for an Aztec code.
+*     * A negative number (-1, -2, -3, -4) specifies a compact Aztec code.
+*     * 0 indicates to use the minimum number of layers (the default).
+*     * A positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code.
+*     * (Type {@link Integer}, or {@link String} representation of the integer value).
+*     
+*/
+  AztecLayers = 11,
+/**
+*
+*     * Specifies the exact version of QR code to be encoded.
+*     * (Type {@link Integer}, or {@link String} representation of the integer value).
+*     
+*/
+  QrVersion = 12,
+/**
+*
+*     * Specifies the QR code mask pattern to be used. Allowed values are
+*     * 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select
+*     * the optimal mask pattern.
+*     * * (Type {@link Integer}, or {@link String} representation of the integer value).
+*     
+*/
+  QrMaskPattern = 13,
+/**
+*
+*     * Specifies whether to use compact mode for QR code (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     * Please note that when compaction is performed, the most compact character encoding is chosen
+*     * for characters in the input that are not in the ISO-8859-1 character set. Based on experience,
+*     * some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can
+*     * be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint.
+*     
+*/
+  QrCompact = 14,
+/**
+*
+*     * Specifies whether the data should be encoded to the GS1 standard (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     
+*/
+  Gs1Format = 15,
+/**
+*
+*     * Forces which encoding will be used. Currently only used for Code-128 code sets (Type {@link String}).
+*     * Valid values are "A", "B", "C".
+*     * This option and {@link #CODE128_COMPACT} are mutually exclusive.
+*     
+*/
+  ForceCodeSet = 16,
+/**
+*
+*     * Forces C40 encoding for data-matrix (type {@link Boolean}, or "true" or "false") {@link String } value). This
+*     * option and {@link #DATA_MATRIX_COMPACT} are mutually exclusive.
+*     
+*/
+  ForceC40 = 17,
+/**
+*
+*     * Specifies whether to use compact mode for Code-128 code (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     * This can yield slightly smaller bar codes. This option and {@link #FORCE_CODE_SET} are mutually
+*     * exclusive.
+*     
+*/
+  Code128Compact = 18,
+  TelepenAsNumeric = 19,
+}
+/**
 * Available barcode types
 */
 export enum BarcodeFormat {
@@ -288,6 +470,30 @@ export class DecodeHintDictionary {
 }
 /**
 */
+export class EncodeHintDictionary {
+  free(): void;
+/**
+*/
+  constructor();
+/**
+* @param {number} hint
+* @returns {string}
+*/
+  get_hint(hint: number): string;
+/**
+* @param {number} hint
+* @param {string} value
+* @returns {boolean}
+*/
+  set_hint(hint: number, value: string): boolean;
+/**
+* @param {number} hint
+* @returns {boolean}
+*/
+  remove_hint(hint: number): boolean;
+}
+/**
+*/
 export class MultiDecodeResult {
   free(): void;
 /**

package/rxing_wasm_bg.js

@@ -61,23 +61,6 @@ function getInt32Memory0() {
     return cachedInt32Memory0;
 }
 
-let cachedFloat32Memory0 = null;
-
-function getFloat32Memory0() {
-    if (cachedFloat32Memory0 === null || cachedFloat32Memory0.byteLength === 0) {
-        cachedFloat32Memory0 = new Float32Array(wasm.memory.buffer);
-    }
-    return cachedFloat32Memory0;
-}
-
-function getArrayF32FromWasm0(ptr, len) {
-    return getFloat32Memory0().subarray(ptr / 4, ptr / 4 + len);
-}
-
-function getArrayU8FromWasm0(ptr, len) {
-    return getUint8Memory0().subarray(ptr / 1, ptr / 1 + len);
-}
-
 let WASM_VECTOR_LEN = 0;
 
 const lTextEncoder = typeof TextEncoder === 'undefined' ? (0, module.require)('util').TextEncoder : TextEncoder;
@@ -134,6 +117,23 @@ function passStringToWasm0(arg, malloc, realloc) {
     WASM_VECTOR_LEN = offset;
     return ptr;
 }
+
+let cachedFloat32Memory0 = null;
+
+function getFloat32Memory0() {
+    if (cachedFloat32Memory0 === null || cachedFloat32Memory0.byteLength === 0) {
+        cachedFloat32Memory0 = new Float32Array(wasm.memory.buffer);
+    }
+    return cachedFloat32Memory0;
+}
+
+function getArrayF32FromWasm0(ptr, len) {
+    return getFloat32Memory0().subarray(ptr / 4, ptr / 4 + len);
+}
+
+function getArrayU8FromWasm0(ptr, len) {
+    return getUint8Memory0().subarray(ptr / 1, ptr / 1 + len);
+}
 /**
 * Encode a barcode with the given data, dimensions, and type
 * @param {string} data
@@ -165,6 +165,45 @@ export function encode_barcode(data, width, height, bc_type) {
     }
 }
 
+function _assertClass(instance, klass) {
+    if (!(instance instanceof klass)) {
+        throw new Error(`expected instance of ${klass.name}`);
+    }
+    return instance.ptr;
+}
+/**
+* Encode a barcode with the given data, dimensions, and type, use the given encoding hints
+* @param {string} data
+* @param {number} width
+* @param {number} height
+* @param {number} bc_type
+* @param {EncodeHintDictionary} hints
+* @returns {string}
+*/
+export function encode_barcode_with_hints(data, width, height, bc_type, hints) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passStringToWasm0(data, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        _assertClass(hints, EncodeHintDictionary);
+        wasm.encode_barcode_with_hints(retptr, ptr0, len0, width, height, bc_type, hints.ptr);
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        var r2 = getInt32Memory0()[retptr / 4 + 2];
+        var r3 = getInt32Memory0()[retptr / 4 + 3];
+        var ptr1 = r0;
+        var len1 = r1;
+        if (r3) {
+            ptr1 = 0; len1 = 0;
+            throw takeObject(r2);
+        }
+        return getStringFromWasm0(ptr1, len1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_free(ptr1, len1);
+    }
+}
+
 function passArray8ToWasm0(arg, malloc) {
     const ptr = malloc(arg.length * 1);
     getUint8Memory0().set(arg, ptr / 1);
@@ -270,12 +309,6 @@ export function decode_barcode_rgb(data, width, height, try_harder) {
     }
 }
 
-function _assertClass(instance, klass) {
-    if (!(instance instanceof klass)) {
-        throw new Error(`expected instance of ${klass.name}`);
-    }
-    return instance.ptr;
-}
 /**
 * @param {Uint8Array} data
 * @param {number} width
@@ -328,6 +361,176 @@ export function decode_multi(data, width, height, hints) {
     }
 }
 
+/**
+*/
+export const EncodeHintTypes = Object.freeze({
+/**
+*
+*     * Specifies what degree of error correction to use, for example in QR Codes.
+*     * Type depends on the encoder. For example for QR codes it's type
+*     * {@link com.google.zxing.qrcode.decoder.ErrorCorrectionLevel ErrorCorrectionLevel}.
+*     * For Aztec it is of type {@link Integer}, representing the minimal percentage of error correction words.
+*     * For PDF417 it is of type {@link Integer}, valid values being 0 to 8.
+*     * In all cases, it can also be a {@link String} representation of the desired value as well.
+*     * Note: an Aztec symbol should have a minimum of 25% EC words.
+*
+*/
+ErrorCorrection:0,"0":"ErrorCorrection",
+/**
+*
+*     * Specifies what character encoding to use where applicable (type {@link String})
+*
+*/
+CharacterSet:1,"1":"CharacterSet",
+/**
+*
+*     * Specifies the matrix shape for Data Matrix (type {@link com.google.zxing.datamatrix.encoder.SymbolShapeHint})
+*
+*/
+DataMatrixShape:2,"2":"DataMatrixShape",
+/**
+*
+*     * Specifies whether to use compact mode for Data Matrix (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     * The compact encoding mode also supports the encoding of characters that are not in the ISO-8859-1
+*     * character set via ECIs.
+*     * Please note that in that case, the most compact character encoding is chosen for characters in
+*     * the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not
+*     * support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by
+*     * means of the {@link #CHARACTER_SET} encoding hint.
+*     * Compact encoding also provides GS1-FNC1 support when {@link #GS1_FORMAT} is selected. In this case
+*     * group-separator character (ASCII 29 decimal) can be used to encode the positions of FNC1 codewords
+*     * for the purpose of delimiting AIs.
+*     * This option and {@link #FORCE_C40} are mutually exclusive.
+*
+*/
+DataMatrixCompact:3,"3":"DataMatrixCompact",
+/**
+*
+*     * Specifies a minimum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.
+*     *
+*     * @deprecated use width/height params in
+*     * {@link com.google.zxing.datamatrix.DataMatrixWriter#encode(String, BarcodeFormat, int, int)}
+*
+*/
+MinSize:4,"4":"MinSize",
+/**
+*
+*     * Specifies a maximum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.
+*     *
+*     * @deprecated without replacement
+*
+*/
+MaxSize:5,"5":"MaxSize",
+/**
+*
+*     * Specifies margin, in pixels, to use when generating the barcode. The meaning can vary
+*     * by format; for example it controls margin before and after the barcode horizontally for
+*     * most 1D formats. (Type {@link Integer}, or {@link String} representation of the integer value).
+*
+*/
+MARGIN:6,"6":"MARGIN",
+/**
+*
+*     * Specifies whether to use compact mode for PDF417 (type {@link Boolean}, or "true" or "false"
+*     * {@link String} value).
+*
+*/
+Pdf417Compact:7,"7":"Pdf417Compact",
+/**
+*
+*     * Specifies what compaction mode to use for PDF417 (type
+*     * {@link com.google.zxing.pdf417.encoder.Compaction Compaction} or {@link String} value of one of its
+*     * enum values).
+*
+*/
+Pdf417Compaction:8,"8":"Pdf417Compaction",
+/**
+*
+*     * Specifies the minimum and maximum number of rows and columns for PDF417 (type
+*     * {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}).
+*
+*/
+Pdf417Dimensions:9,"9":"Pdf417Dimensions",
+/**
+*
+*     * Specifies whether to automatically insert ECIs when encoding PDF417 (type {@link Boolean}, or "true" or "false"
+*     * {@link String} value).
+*     * Please note that in that case, the most compact character encoding is chosen for characters in
+*     * the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not
+*     * support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by
+*     * means of the {@link #CHARACTER_SET} encoding hint.
+*
+*/
+Pdf417AutoEci:10,"10":"Pdf417AutoEci",
+/**
+*
+*     * Specifies the required number of layers for an Aztec code.
+*     * A negative number (-1, -2, -3, -4) specifies a compact Aztec code.
+*     * 0 indicates to use the minimum number of layers (the default).
+*     * A positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code.
+*     * (Type {@link Integer}, or {@link String} representation of the integer value).
+*
+*/
+AztecLayers:11,"11":"AztecLayers",
+/**
+*
+*     * Specifies the exact version of QR code to be encoded.
+*     * (Type {@link Integer}, or {@link String} representation of the integer value).
+*
+*/
+QrVersion:12,"12":"QrVersion",
+/**
+*
+*     * Specifies the QR code mask pattern to be used. Allowed values are
+*     * 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select
+*     * the optimal mask pattern.
+*     * * (Type {@link Integer}, or {@link String} representation of the integer value).
+*
+*/
+QrMaskPattern:13,"13":"QrMaskPattern",
+/**
+*
+*     * Specifies whether to use compact mode for QR code (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     * Please note that when compaction is performed, the most compact character encoding is chosen
+*     * for characters in the input that are not in the ISO-8859-1 character set. Based on experience,
+*     * some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can
+*     * be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint.
+*
+*/
+QrCompact:14,"14":"QrCompact",
+/**
+*
+*     * Specifies whether the data should be encoded to the GS1 standard (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*
+*/
+Gs1Format:15,"15":"Gs1Format",
+/**
+*
+*     * Forces which encoding will be used. Currently only used for Code-128 code sets (Type {@link String}).
+*     * Valid values are "A", "B", "C".
+*     * This option and {@link #CODE128_COMPACT} are mutually exclusive.
+*
+*/
+ForceCodeSet:16,"16":"ForceCodeSet",
+/**
+*
+*     * Forces C40 encoding for data-matrix (type {@link Boolean}, or "true" or "false") {@link String } value). This
+*     * option and {@link #DATA_MATRIX_COMPACT} are mutually exclusive.
+*
+*/
+ForceC40:17,"17":"ForceC40",
+/**
+*
+*     * Specifies whether to use compact mode for Code-128 code (type {@link Boolean}, or "true" or "false"
+*     * {@link String } value).
+*     * This can yield slightly smaller bar codes. This option and {@link #FORCE_CODE_SET} are mutually
+*     * exclusive.
+*
+*/
+Code128Compact:18,"18":"Code128Compact",TelepenAsNumeric:19,"19":"TelepenAsNumeric", });
 /**
 * Available barcode types
 */
@@ -660,6 +863,70 @@ export class DecodeHintDictionary {
 }
 /**
 */
+export class EncodeHintDictionary {
+
+    static __wrap(ptr) {
+        const obj = Object.create(EncodeHintDictionary.prototype);
+        obj.ptr = ptr;
+
+        return obj;
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.ptr;
+        this.ptr = 0;
+
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_encodehintdictionary_free(ptr);
+    }
+    /**
+    */
+    constructor() {
+        const ret = wasm.encodehintdictionary_new();
+        return EncodeHintDictionary.__wrap(ret);
+    }
+    /**
+    * @param {number} hint
+    * @returns {string}
+    */
+    get_hint(hint) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.encodehintdictionary_get_hint(retptr, this.ptr, hint);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(r0, r1);
+        }
+    }
+    /**
+    * @param {number} hint
+    * @param {string} value
+    * @returns {boolean}
+    */
+    set_hint(hint, value) {
+        const ptr0 = passStringToWasm0(value, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.encodehintdictionary_set_hint(this.ptr, hint, ptr0, len0);
+        return ret !== 0;
+    }
+    /**
+    * @param {number} hint
+    * @returns {boolean}
+    */
+    remove_hint(hint) {
+        const ret = wasm.encodehintdictionary_remove_hint(this.ptr, hint);
+        return ret !== 0;
+    }
+}
+/**
+*/
 export class MultiDecodeResult {
 
     static __wrap(ptr) {