rxing-wasm 0.2.6 → 0.2.7

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.6",
+  "version": "0.2.7",
   "license": "Apache 2.0",
   "repository": {
     "type": "git",

package/rxing_wasm.d.ts

@@ -5,27 +5,27 @@
 * @param {string} data
 * @param {number} width
 * @param {number} height
-* @param {number} bc_type
+* @param {BarcodeFormat} bc_type
 * @returns {string}
 */
-export function encode_barcode(data: string, width: number, height: number, bc_type: number): string;
+export function encode_barcode(data: string, width: number, height: number, bc_type: BarcodeFormat): 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 {BarcodeFormat} 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;
+export function encode_barcode_with_hints(data: string, width: number, height: number, bc_type: BarcodeFormat, hints: EncodeHintDictionary): string;
 /**
 * Decode a barcode from an array of 8bit luma data
 * @param {Uint8Array} data
 * @param {number} width
 * @param {number} height
-* @param {boolean | undefined} try_harder
-* @param {boolean | undefined} filter_image
+* @param {boolean | undefined} [try_harder]
+* @param {boolean | undefined} [filter_image]
 * @returns {BarcodeResult}
 */
 export function decode_barcode(data: Uint8Array, width: number, height: number, try_harder?: boolean, filter_image?: boolean): BarcodeResult;
@@ -47,7 +47,7 @@ export function convert_js_image_to_luma(data: Uint8Array): Uint8Array;
 * @param {Uint32Array} data
 * @param {number} width
 * @param {number} height
-* @param {boolean | undefined} try_harder
+* @param {boolean | undefined} [try_harder]
 * @returns {BarcodeResult}
 */
 export function decode_barcode_rgb(data: Uint32Array, width: number, height: number, try_harder?: boolean): BarcodeResult;
@@ -56,7 +56,7 @@ export function decode_barcode_rgb(data: Uint32Array, width: number, height: num
 * @param {number} width
 * @param {number} height
 * @param {DecodeHintDictionary} hints
-* @param {boolean | undefined} filter_image
+* @param {boolean | undefined} [filter_image]
 * @returns {BarcodeResult}
 */
 export function decode_barcode_with_hints(data: Uint8Array, width: number, height: number, hints: DecodeHintDictionary, filter_image?: boolean): BarcodeResult;
@@ -70,175 +70,99 @@ 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,
+export enum DecodeHintTypes {
 /**
 *
-*     * 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).
+*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
 *     
 */
-  MARGIN = 6,
+  Other = 0,
 /**
 *
-*     * Specifies whether to use compact mode for PDF417 (type {@link Boolean}, or "true" or "false"
-*     * {@link String} value).
+*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
 *     
 */
-  Pdf417Compact = 7,
+  PureBarcode = 1,
 /**
 *
-*     * 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).
+*     * Image is known to be of one of a few possible formats.
+*     * Maps to a {@link List} of {@link BarcodeFormat}s.
 *     
 */
-  Pdf417Compaction = 8,
+  PossibleFormats = 2,
 /**
 *
-*     * Specifies the minimum and maximum number of rows and columns for PDF417 (type
-*     * {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}).
+*     * 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}.
 *     
 */
-  Pdf417Dimensions = 9,
+  TryHarder = 3,
 /**
 *
-*     * 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.
+*     * Specifies what character encoding to use when decoding, where applicable (type String)
 *     
 */
-  Pdf417AutoEci = 10,
+  CharacterSet = 4,
 /**
 *
-*     * 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).
+*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
 *     
 */
-  AztecLayers = 11,
+  AllowedLengths = 5,
 /**
 *
-*     * Specifies the exact version of QR code to be encoded.
-*     * (Type {@link Integer}, or {@link String} representation of the integer value).
+*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
+*     * use {@link Boolean#TRUE}.
 *     
 */
-  QrVersion = 12,
+  AssumeCode39CheckDigit = 6,
 /**
 *
-*     * 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).
+*     * 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}.
 *     
 */
-  QrMaskPattern = 13,
+  AssumeGs1 = 7,
 /**
 *
-*     * 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.
+*     * 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}.
 *     
 */
-  QrCompact = 14,
+  ReturnCodabarStartEnd = 8,
 /**
 *
-*     * Specifies whether the data should be encoded to the GS1 standard (type {@link Boolean}, or "true" or "false"
-*     * {@link String } value).
+*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
+*     * is found. Maps to a {@link RXingResultPointCallback}.
 *     
 */
-  Gs1Format = 15,
+  NeedResultPointCallback = 9,
 /**
 *
-*     * 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.
+*     * 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.
 *     
 */
-  ForceCodeSet = 16,
+  AllowedEanExtensions = 10,
 /**
 *
-*     * 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.
+*     * 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}.
 *     
 */
-  ForceC40 = 17,
+  AlsoInverted = 11,
 /**
 *
-*     * 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.
+*     * Translate the ASCII values parsed by the Telepen reader into the Telepen Numeric form; use {@link Boolean#TRUE}.
 *     
 */
-  Code128Compact = 18,
-  TelepenAsNumeric = 19,
+  TelepenAsNumeric = 12,
 }
 /**
 * Available barcode types
@@ -319,99 +243,175 @@ export enum BarcodeFormat {
 }
 /**
 */
-export enum DecodeHintTypes {
+export enum EncodeHintTypes {
 /**
 *
-*     * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.
+*     * 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.
 *     
 */
-  Other = 0,
+  ErrorCorrection = 0,
 /**
 *
-*     * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
+*     * Specifies what character encoding to use where applicable (type {@link String})
 *     
 */
-  PureBarcode = 1,
+  CharacterSet = 1,
 /**
 *
-*     * Image is known to be of one of a few possible formats.
-*     * Maps to a {@link List} of {@link BarcodeFormat}s.
+*     * Specifies the matrix shape for Data Matrix (type {@link com.google.zxing.datamatrix.encoder.SymbolShapeHint})
 *     
 */
-  PossibleFormats = 2,
+  DataMatrixShape = 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}.
+*     * 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.
 *     
 */
-  TryHarder = 3,
+  DataMatrixCompact = 3,
 /**
 *
-*     * Specifies what character encoding to use when decoding, where applicable (type String)
+*     * 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)}
 *     
 */
-  CharacterSet = 4,
+  MinSize = 4,
 /**
 *
-*     * Allowed lengths of encoded data -- reject anything else. Maps to an {@code int[]}.
+*     * Specifies a maximum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.
+*     *
+*     * @deprecated without replacement
 *     
 */
-  AllowedLengths = 5,
+  MaxSize = 5,
 /**
 *
-*     * Assume Code 39 codes employ a check digit. Doesn't matter what it maps to;
-*     * use {@link Boolean#TRUE}.
+*     * 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).
 *     
 */
-  AssumeCode39CheckDigit = 6,
+  MARGIN = 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}.
+*     * Specifies whether to use compact mode for PDF417 (type {@link Boolean}, or "true" or "false"
+*     * {@link String} value).
 *     
 */
-  AssumeGs1 = 7,
+  Pdf417Compact = 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}.
+*     * 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).
 *     
 */
-  ReturnCodabarStartEnd = 8,
+  Pdf417Compaction = 8,
 /**
 *
-*     * The caller needs to be notified via callback when a possible {@link RXingResultPoint}
-*     * is found. Maps to a {@link RXingResultPointCallback}.
+*     * Specifies the minimum and maximum number of rows and columns for PDF417 (type
+*     * {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}).
 *     
 */
-  NeedResultPointCallback = 9,
+  Pdf417Dimensions = 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.
+*     * 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.
 *     
 */
-  AllowedEanExtensions = 10,
+  Pdf417AutoEci = 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}.
+*     * 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).
 *     
 */
-  AlsoInverted = 11,
+  AztecLayers = 11,
 /**
 *
-*     * Translate the ASCII values parsed by the Telepen reader into the Telepen Numeric form; use {@link Boolean#TRUE}.
+*     * Specifies the exact version of QR code to be encoded.
+*     * (Type {@link Integer}, or {@link String} representation of the integer value).
 *     
 */
-  TelepenAsNumeric = 12,
+  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,
 }
 /**
 */
@@ -422,9 +422,9 @@ export class BarcodeResult {
 */
   timestamp(): number;
 /**
-* @returns {number}
+* @returns {BarcodeFormat}
 */
-  format(): number;
+  format(): BarcodeFormat;
 /**
 * Each pair of f32 values is an (x,y) point
 * @returns {Float32Array}
@@ -455,21 +455,21 @@ export class DecodeHintDictionary {
 */
   constructor();
 /**
-* @param {number} hint
+* @param {DecodeHintTypes} hint
 * @returns {string}
 */
-  get_hint(hint: number): string;
+  get_hint(hint: DecodeHintTypes): string;
 /**
-* @param {number} hint
+* @param {DecodeHintTypes} hint
 * @param {string} value
 * @returns {boolean}
 */
-  set_hint(hint: number, value: string): boolean;
+  set_hint(hint: DecodeHintTypes, value: string): boolean;
 /**
-* @param {number} hint
+* @param {DecodeHintTypes} hint
 * @returns {boolean}
 */
-  remove_hint(hint: number): boolean;
+  remove_hint(hint: DecodeHintTypes): boolean;
 }
 /**
 */
@@ -479,21 +479,21 @@ export class EncodeHintDictionary {
 */
   constructor();
 /**
-* @param {number} hint
+* @param {EncodeHintTypes} hint
 * @returns {string}
 */
-  get_hint(hint: number): string;
+  get_hint(hint: EncodeHintTypes): string;
 /**
-* @param {number} hint
+* @param {EncodeHintTypes} hint
 * @param {string} value
 * @returns {boolean}
 */
-  set_hint(hint: number, value: string): boolean;
+  set_hint(hint: EncodeHintTypes, value: string): boolean;
 /**
-* @param {number} hint
+* @param {EncodeHintTypes} hint
 * @returns {boolean}
 */
-  remove_hint(hint: number): boolean;
+  remove_hint(hint: EncodeHintTypes): boolean;
 }
 /**
 */