isahaq-barcode 1.8.0 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,107 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2026-07-26
+
+This release replaces the rendering core. Before it, only PNG output produced a
+real barcode: SVG, HTML and PDF drew decorative bars derived from character
+codes, and any type that JsBarcode did not support (Data Matrix, PDF417, Aztec,
+the postal symbologies, MaxiCode, Code 16K, Code 49, ...) silently fell back to
+Code 128. Every advertised type and format now produces a real, scannable
+symbology, verified by decoding the output with ZXing (`npm run verify:scan`).
+
+### Breaking changes
+
+- `png()`, `svg()`, `html()` and `pdf()` now all return promises. Previously
+  `png()`, `svg()` and `html()` returned values synchronously.
+  Use `svgSync()` and `htmlSync()` where a synchronous call is needed.
+  ```js
+  // 1.x
+  const buffer = BarcodeGenerator.png('1234567890', 'code128');
+  // 2.x
+  const buffer = await BarcodeGenerator.png('1234567890', 'code128');
+  ```
+- `batch()` now returns a promise resolving to the results array.
+- SVG, HTML and PDF output changed completely, because it is now a real barcode.
+  HTML output is a single `<div>` wrapping an inline SVG instead of a grid of
+  styled `<div>` elements, and no longer emits a `<style>` block.
+- The `jpg` and `jpeg` render formats were removed from `getRenderFormats()`.
+  They were advertised but always failed with "No renderer available".
+  `QrCodeBuilder` still supports `format: 'jpeg'`.
+- The default quiet zone is now 10 modules (the value the specifications
+  require) rather than 10 pixels, so default output is slightly wider. Pass
+  `margin` in pixels or `quietZone` in modules to override it.
+- `canvas` moved to `optionalDependencies` and is only needed for QR codes with
+  a logo, label or watermark. Barcode rendering no longer uses it at all.
+- `jsbarcode` is no longer a dependency or a peer dependency; encoding is done
+  by `bwip-js`. `qrcode` moved from a peer dependency to a regular dependency.
+- Browser build: `png()` resolves to a `Blob` instead of a `Buffer` (`Buffer`
+  does not exist in browsers without a polyfill), and SVG generation no longer
+  requires a DOM.
+- `EAN-8` and `UPC-A` check digit validation is now correct. Codes that were
+  wrongly accepted before are now rejected, and vice versa.
+- The default QR `logoSize` is 20 (percent) instead of 60. A logo covering 60%
+  of a QR code destroys it.
+- A missing or unreadable QR logo now rejects instead of logging a warning and
+  silently producing a code without the logo.
+
+### Added
+
+- `svgSync()` and `htmlSync()` for synchronous SVG and HTML generation.
+- `generate(data, type, format, options)` on the public API.
+- Real support for all 45 registered types, including `datamatrix`, `pdf417`,
+  `aztec`, `microqr`, `maxicode`, `code16k`, `code49`, `postnet`, `planet`,
+  `rms4cc`, `kix`, `imb`, `pharmacode` and `pharmacodetwotracks`.
+- `size` option to size 2D symbologies in pixels, `quietZone` to set the quiet
+  zone in modules, `rotate` for 90/180/270 degree rotation, `textColor`, and
+  `bwipOptions` to pass raw encoder options through.
+- PDF options: `pageSize` (for example `'A4'`), `fitToBarcode`, `title`.
+- `getBarcodeCategories()`, `getBarcodeTypesByCategory()`, `getDefaultOptions()`.
+- `BarcodeTypes.getTypeInfo()`, `getSymbology()`, `getEncodeOptions()` and
+  `RenderFormats.getFormatInfo()`.
+- TypeScript declarations (`index.d.ts`) covering the whole public API.
+- QR codes as SVG (`format: 'svg'`) and `data:image/svg+xml` data URIs.
+- `npm run verify:scan`, which decodes generated barcodes with ZXing.
+- GitHub Actions CI across Node 18, 20 and 22.
+
+### Fixed
+
+- `getBarcodeTypes()`, `getRenderFormats()`, `getBarcodeTypeInfo()` and
+  `getRenderFormatInfo()` threw `TypeError: ... is not a function`; the methods
+  they called did not exist.
+- Code 93 output was missing its two mandatory check characters, so scanners
+  could not read it.
+- CLI: `barcode --format pdf` wrote a `[object Promise]` to disk, and `batch`
+  crashed with "results is not iterable", both from unawaited promises.
+- CLI: `require('chalk')`/`require('ora')` crashed on Node 18 and 20 because
+  those packages are ESM only. The CLI now has no colour dependencies, honours
+  `NO_COLOR`, writes diagnostics to stderr and data to stdout, and reports the
+  real package version instead of a hardcoded `1.0.0`.
+- `npm install` failed with `ERESOLVE` because `eslint-config-standard@17`
+  requires ESLint 8 while the project uses ESLint 9. The unused legacy
+  `.eslintrc.js` and its plugins were removed.
+- Express example: unawaited generator calls, an error handler Express ignored
+  because it declared three parameters, and non-JSON-serialisable buffers in the
+  batch response.
+- `QrCodeBuilder.build()` no longer shares mutable options with the builder.
+- Colour options now accept `#rgb`, `#rrggbb`, `rrggbb` and RGB arrays
+  consistently across the barcode and QR code APIs.
+
+### Changed
+
+- The test suite exercises the real encoders instead of mocking them. The
+  previous mocks made PDF tests hang until the 10 second timeout and asserted
+  nothing about the output.
+- `BarcodeTypes` and `RenderFormats` are generated from one registry, so type
+  metadata, categories, validation limits and the encoder mapping cannot drift.
+- Package contents are now limited to what is needed at runtime: tests, ESLint
+  and Prettier configs and the webpack config are no longer published, and
+  `LICENSE` is.
+
+## [1.9.0] and earlier
+
+See the [commit history](https://github.com/isahaq1/npm-barcodegenerator/commits/main).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 hmisahaq01
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.