Skip to content

Latest commit

 

History

History
228 lines (125 loc) · 8.31 KB

CHANGELOG.md

File metadata and controls

228 lines (125 loc) · 8.31 KB

zxing-wasm

2.0.0-beta.4

Patch Changes

  • f8c33b2: Fix the zxing_writer.wasm size issue. See #190.

2.0.0-beta.3

Minor Changes

  • 615a321: - Add DXFilmEdge writing support.
    • Fix subpath exports TS compatibility with types-versions-wildcards strategy. Check this for more information.
    • Add types to .wasm subpath exports.
    • Add ImageData ambient type export.

2.0.0-beta.2

Patch Changes

  • b856d58: Add typesVersions field for moduleResolution: node

2.0.0-beta.1

Patch Changes

  • a10ffcc: Bump zxing-cpp to 0dfa36b to fix DataBarExpanded decoder error and ITF quiet zone detection heuristic

2.0.0-beta.0

Major Changes

  • 1a77296: V2: Breaking Release - Next Major Version

    This release introduces a major refactoring of the underlying Embind APIs and read / write functions. Key changes include transitioning away from Embind Enums toward numeric encoding and decoding, a new set of default reader options, enhanced writer capabilities backed by zint, and updated APIs for reading and writing barcodes. These changes break backward compatibility, so we are upgrading to the next major version.

    Breaking Changes

    Renamed & Consolidated Reader Function

    readBarcodes(...) replaces both readBarcodesFromImageFile(...) and readBarcodesFromImageData(...). The new function unifies code paths for Blob and ImageData inputs.

    [!NOTE]

    The v1 reader functions readBarcodesFromImageFile and readBarcodesFromImageData are still kept for a smooth migration experience, but marked as deprecated.

    Updated Reader Options

    A few reader options have changed their default values. This change is to align with the latest ZXing C library and provide a more consistent experience across different platforms:

    1. tryCode39ExtendedMode is now true by default. It was previously false.
    2. eanAddOnSymbol is now "Ignore" by default. It was previously "Read".
    3. textMode is now "HRI" by default. It was previously "Plain".

    Some deprecated options have been removed, see zxing-cpp#704 for more details:

    1. validateCode39CheckSum is now removed. The Code39 symbol has a valid checksum if the third character of the symbologyIdentifier is an odd digit.
    2. validateITFCheckSum is now removed. The ITF symbol has a valid checksum if the third character of the symbologyIdentifier is a '1'.
    3. returnCodabarStartEnd is now removed. The detected results of Codabar symbols now always include the start and end characters.

    eccLevel in Read Result Renamed to ecLevel

    In ReadResult, the eccLevel field has been renamed to ecLevel. It now holds strings like "L", "M", "Q", or "H" or stringified numeric values for error correction levels. An empty string indicates that the error correction level is not applicable.

    [!NOTE]

    The eccLevel field is still kept for a smooth migration experience, but marked as deprecated.

    Renamed & Enhanced Writer Function

    writeBarcode(...) replaces writeBarcodeToImageFile(...). The new function is powered by the new zint writer, which supports more barcode formats, supports both string and Uint8Array inputs for generating barcodes from text or binary data, and provides new output formats (e.g. SVG, UTF-8) in addition to the binary image file output.

    The WriterOptions object has also been updated completely.

    [!NOTE]

    The final shape of the writeBarcode function is still under discussion. The current implementation is subject to change.

    Module Initialization / Caching Overhaul

    prepareZXingModule(...) replaces both setZXingModuleOverrides(...) and getZXingModuleOverrides(...). The new function provides a more flexible way to initialize the ZXing module with custom options.

    [!NOTE]

    The v1 module initialization functions setZXingModuleOverrides and getZXingModuleOverrides are still kept for a smooth migration experience, but marked as deprecated.

    purgeZXingModule now only clears the relevant module cache from where it is imported. It no longer resets the global module cache.

    New Features & Enhancements

    More Barcode Formats Supported in Writer

    The new writeBarcode function supports more barcode formats than the previous writeBarcodeToImageFile. All barcode formats supported by the reader except for DXFilmEdge are now supported by the writer.

    New tryDenoise Option for Reading Barcodes

    The new tryDenoise option in ReaderOptions allows you to enable or disable the denoising algorithm when reading barcodes. This is an experimental feature and by default, it is set to false.

1.3.4

Patch Changes

  • 1a9a372: Bump zxing-cpp to 579650a to fix incorrect PDF417 position info.

1.3.3

Patch Changes

  • 0709489: Bump zxing-cpp to cd9bba3 to fix an ITF detection regression.

1.3.2

Patch Changes

  • 4b0ca08: Bump zxing-cpp to 308f820 and improve DataBar detection rate.

1.3.1

Patch Changes

  • 999335b: Bump zxing-cpp to 8fb2f81 to support shorter ITF symbols.

1.3.0

Minor Changes

  • 925e12f: Add reader support for DataBarLimited.

1.2.15

Patch Changes

  • fa87128: Fix webassembly exception handling. Increase success rate.
  • f1eef5c: Bump zxing-cpp to 81407a0 to fix reader options not being passed to the internal reader if isPure is set.

1.2.14

Patch Changes

  • aad8899: Patch emscripten to mitigate DOM Clobbering vulnerability.

1.2.13

Patch Changes

  • 650c295: DOM Clobbering security patch.

1.2.12

Patch Changes

  • 2228845: Bump zxing-cpp and switch to pnpm, renovate.

1.2.11

Patch Changes

  • d3c92ee:
    • Always use .js as the chunk filename extension.
    • Bump zxing-cpp to 986f785
    • Bump dependencies

1.2.10

Patch Changes

  • 0a43b27: Bump zxing-cpp to d0c1f34

1.2.9

Patch Changes

  • 01e8878: Bump zxing-cpp to 441132c

1.2.8

Patch Changes

  • 2fc9bec: Bump zxing-cpp to 4bbc1db

1.2.7

Patch Changes

  • 308d165: Bump zxing-cpp to 9ca0684

1.2.6

Patch Changes

  • a2339d3: Bump zxing-cpp to b58682b.

1.2.5

Patch Changes

  • 4358969: Fix WebAssembly instantiation issue in electron.

1.2.5-rc.0

Patch Changes

  • 4358969: Fix WebAssembly instantiation issue in electron.

1.2.4

Patch Changes

  • f749591: Bump zxing-cpp to b3aff4a:

    • Deprecate validateCode39CheckSum, validateITFCheckSum and returnCodabarStartEnd. Related commits from upstream: fc8f32d, b3fe574, d636c6d 68c97c7, 2f3c72c.
    • Reduce WASM binaries size. Related commits from upstream: 6741403, 1fa0070, b3aff4a.
    • Other fixes and improvements from upstream.

1.2.3

Patch Changes

  • de36dce: reset zxing-cpp to b152afd

    • validateITFCheckSum, tryCode39ExtendedMode and validateCode39CheckSum are deprecated in later commits.

1.2.2

Patch Changes

  • 02f0386: Bump zxing-cpp to b3fe574