@sythos/js_barcode_universal 1.2.5 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/LICENSE +8 -1
  2. package/NOTICE.md +3 -0
  3. package/README.md +548 -463
  4. package/bundle/sythos-barcode.esm.js +2377 -3
  5. package/bundle/sythos-barcode.js +2365 -3
  6. package/examples/create.html +1009 -730
  7. package/licenses/README.md +35 -58
  8. package/licenses/aztec-code.license +15 -13
  9. package/licenses/codabar.license +18 -15
  10. package/licenses/code-11.license +11 -9
  11. package/licenses/code-128.license +10 -8
  12. package/licenses/code-39.license +10 -8
  13. package/licenses/code-93.license +16 -14
  14. package/licenses/data-matrix.license +15 -13
  15. package/licenses/ean-13.license +10 -8
  16. package/licenses/ean-8.license +10 -8
  17. package/licenses/frameqr.license +84 -0
  18. package/licenses/gs1-128.license +10 -8
  19. package/licenses/isbn.license +10 -8
  20. package/licenses/itf-14.license +10 -8
  21. package/licenses/itf.license +9 -7
  22. package/licenses/micro-qr.license +79 -0
  23. package/licenses/micropdf417.license +52 -67
  24. package/licenses/msi-plessey.license +13 -11
  25. package/licenses/pdf417.license +78 -37
  26. package/licenses/pharmacode.license +14 -12
  27. package/licenses/qr-code.license +9 -7
  28. package/licenses/rmqr.license +79 -0
  29. package/licenses/upc-a.license +12 -10
  30. package/licenses/upc-e.license +10 -8
  31. package/package.json +97 -88
  32. package/src/datamatrix/decoder.js +262 -262
  33. package/src/datamatrix/detector.js +225 -225
  34. package/src/datamatrix/encoder.js +191 -191
  35. package/src/datamatrix/index.js +42 -42
  36. package/src/datamatrix/tables.js +123 -123
  37. package/src/frameqr/decoder.js +239 -0
  38. package/src/frameqr/detector.js +192 -0
  39. package/src/frameqr/encoder.js +156 -0
  40. package/src/frameqr/index.js +42 -0
  41. package/src/frameqr/tables.js +270 -0
  42. package/src/index.js +91 -2
  43. package/src/microqr/decoder.js +245 -0
  44. package/src/microqr/detector.js +355 -0
  45. package/src/microqr/encoder.js +269 -0
  46. package/src/microqr/index.js +36 -0
  47. package/src/microqr/tables.js +316 -0
  48. package/src/oned/index.js +59 -59
  49. package/src/rmqr/decoder.js +101 -0
  50. package/src/rmqr/detector.js +90 -0
  51. package/src/rmqr/encoder.js +172 -0
  52. package/src/rmqr/index.js +37 -0
  53. package/src/rmqr/tables.js +154 -0
package/README.md CHANGED
@@ -1,277 +1,289 @@
1
- # Sythos Barcode Suite
2
-
3
- Read and write barcodes in JavaScript.
4
-
5
- [![npm](https://img.shields.io/npm/v/@sythos/js_barcode_universal.svg)](https://www.npmjs.com/package/@sythos/js_barcode_universal)
6
- [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
7
- [![Runtime dependencies: 0](https://img.shields.io/badge/runtime%20dependencies-0-brightgreen.svg)](package.json)
8
-
1
+ # Sythos Barcode Suite
2
+
3
+ Read and write barcodes in JavaScript.
4
+
5
+ [![npm](https://img.shields.io/npm/v/@sythos/js_barcode_universal.svg)](https://www.npmjs.com/package/@sythos/js_barcode_universal)
6
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
7
+ [![Runtime dependencies: 0](https://img.shields.io/badge/runtime%20dependencies-0-brightgreen.svg)](package.json)
8
+ [![ESM](https://img.shields.io/badge/ESM-supported-3178C6.svg?logo=javascript&logoColor=white)](https://nodejs.org/api/esm.html)
9
+ [![Node](https://img.shields.io/node/v/%40sythos%2Fjs_barcode_universal.svg)](https://www.npmjs.com/package/@sythos/js_barcode_universal)
10
+
11
+ [![npm downloads](https://img.shields.io/npm/dm/%40sythos%2Fjs_barcode_universal.svg?label=npm%20downloads)](https://www.npmjs.com/package/@sythos/js_barcode_universal)
12
+ [![GitHub last commit](https://img.shields.io/github/last-commit/Sythos/JS_Barcode_Universal.svg)](https://github.com/Sythos/JS_Barcode_Universal/commits/main/)
13
+ [![GitHub issues](https://img.shields.io/github/issues/Sythos/JS_Barcode_Universal.svg)](https://github.com/Sythos/JS_Barcode_Universal/issues)
14
+
9
15
  Original Sythos implementation, zero runtime dependencies, MIT. It runs unmodified in Node, in browsers
10
- (including Safari on iOS) and in web workers. The core requires no canvas, no filesystem and no
11
- DOM — images go in and come out as plain `{ data, width, height }` RGBA objects, which is exactly
12
- what an `ImageData` is.
13
-
14
- **The code is complete and entirely human-readable.** The full source ships. There is no
15
- WebAssembly, no native addon, no compiled artefact, no binary blob and no minified file anywhere
16
- in this repository — every tracked file is text you can open and read.
17
-
18
- That includes the prebuilt bundles. They are *generated*, concatenated and wrapped from `src/` by
19
- the project's own bundler, but nothing is stripped in the process:
20
- [`bundle/sythos-barcode.js`](bundle/sythos-barcode.js) runs to roughly 7,900 lines, about a third
21
- of them comments, averaging a little over 30 characters a line. Open it anywhere and you are
22
- reading the same annotated code as the source, in the same order — a convenience, not a black box.
23
-
24
- Don't take that on trust either; it takes one command:
25
-
26
- ```sh
27
- awk '{ n += length($0) } END { print "lines:", NR, " avg length:", int(n/NR) }' bundle/sythos-barcode.js
28
- ```
29
-
30
- A minified bundle gives you a handful of lines averaging thousands of characters. This one does
31
- not, and that is the whole point.
32
-
33
- This is deliberate. A barcode library decides what a scanner believes a label says, so it belongs
34
- in the category of code you can audit rather than have to trust. Every constant table, every
35
- check digit and every error-correction step is here in full, with the reasoning next to it.
36
-
37
- ```js
38
- import { encode, decode, toSVG, toImageData } from './src/index.js';
39
-
40
- const matrix = encode('https://example.com', { format: 'qr', ecc: 'M' });
41
- const svg = toSVG(matrix, { scale: 8 });
42
-
43
- const found = decode(toImageData(matrix, { scale: 4 }), { formats: ['qr'] });
44
- console.log(found[0].text); // 'https://example.com'
45
- ```
46
-
47
- ---
48
-
49
- ## Quick start
50
-
51
- There are four ways in, and none of them needs a build step.
52
-
53
- ### 1. npm
54
-
55
- ```sh
56
- npm install @sythos/js_barcode_universal
57
- ```
58
-
59
- `yarn add @sythos/js_barcode_universal` and `pnpm add @sythos/js_barcode_universal` do the same thing. Nothing is installed
60
- alongside it — there are no runtime dependencies, no postinstall script and no native build. The
61
- package is plain ESM (`"type": "module"`) and asks for Node 18 or newer.
62
-
63
- ```js
64
- import { encode, decode, toSVG, toImageData } from '@sythos/js_barcode_universal';
65
-
66
- const code = encode('SYT-2026-0042', { format: 'code128' });
67
-
68
- const svg = toSVG(code, { scale: 2, margin: 10, barHeight: 60 });
69
- // '<svg xmlns="http://www.w3.org/2000/svg" width="374" height="100" …'
70
-
71
- const found = decode(toImageData(code, { scale: 4, margin: 10 }), { formats: ['code128'] });
72
- console.log(found[0].text); // 'SYT-2026-0042'
73
- ```
74
-
75
- **Subpath exports** hand you one layer instead of the whole surface, which is what lets a
76
- tree-shaking bundler drop everything you did not ask for. Importing only the QR writer and only
77
- the SVG renderer never pulls in the 1D formats, the PNG encoder or the read pipeline:
78
-
79
- ```js
80
- import { encodeQR } from '@sythos/js_barcode_universal/qr';
81
- import { toSVG } from '@sythos/js_barcode_universal/render/svg';
82
-
83
- const svg = toSVG(encodeQR('https://example.com', { ecc: 'M' }), { scale: 8 });
84
- // a 25×25 module symbol — 264×264 px at scale 8 with the default 4-module quiet zone
85
- ```
86
-
87
- | Subpath | What it exports |
88
- |---|---|
89
- | `@sythos/js_barcode_universal` | The whole surface: `encode`, `decode`, every renderer, every error type |
90
- | `@sythos/js_barcode_universal/core` | `BitMatrix`, `GaloisField`, Reed–Solomon, the error classes |
91
- | `@sythos/js_barcode_universal/image` | `LuminanceSource`, the binarizers, grid sampling, `PerspectiveTransform` |
92
- | `@sythos/js_barcode_universal/oned` | The per-format 1D writers (`encodeEAN13`, `encodeCode128`, …) and `decodeOneD` |
93
- | `@sythos/js_barcode_universal/qr` | `encodeQR`, `decodeQR`, `detectQR`, `detectAndDecodeQR` |
16
+ (including Safari on iOS) and in web workers. The core requires no canvas, no filesystem and no
17
+ DOM — images go in and come out as plain `{ data, width, height }` RGBA objects, which is exactly
18
+ what an `ImageData` is.
19
+
20
+ **The code is complete and entirely human-readable.** The full source ships. There is no
21
+ WebAssembly, no native addon, no compiled artefact, no binary blob and no minified file anywhere
22
+ in this repository — every tracked file is text you can open and read.
23
+
24
+ That includes the prebuilt bundles. They are *generated*, concatenated and wrapped from `src/` by
25
+ the project's own bundler, but nothing is stripped in the process:
26
+ [`bundle/sythos-barcode.js`](bundle/sythos-barcode.js) runs to roughly 7,900 lines, about a third
27
+ of them comments, averaging a little over 30 characters a line. Open it anywhere and you are
28
+ reading the same annotated code as the source, in the same order — a convenience, not a black box.
29
+
30
+ Don't take that on trust either; it takes one command:
31
+
32
+ ```sh
33
+ awk '{ n += length($0) } END { print "lines:", NR, " avg length:", int(n/NR) }' bundle/sythos-barcode.js
34
+ ```
35
+
36
+ A minified bundle gives you a handful of lines averaging thousands of characters. This one does
37
+ not, and that is the whole point.
38
+
39
+ This is deliberate. A barcode library decides what a scanner believes a label says, so it belongs
40
+ in the category of code you can audit rather than have to trust. Every constant table, every
41
+ check digit and every error-correction step is here in full, with the reasoning next to it.
42
+
43
+ ```js
44
+ import { encode, decode, toSVG, toImageData } from './src/index.js';
45
+
46
+ const matrix = encode('https://example.com', { format: 'qr', ecc: 'M' });
47
+ const svg = toSVG(matrix, { scale: 8 });
48
+
49
+ const found = decode(toImageData(matrix, { scale: 4 }), { formats: ['qr'] });
50
+ console.log(found[0].text); // 'https://example.com'
51
+ ```
52
+
53
+ ---
54
+
55
+ ## Quick start
56
+
57
+ There are four ways in, and none of them needs a build step.
58
+
59
+ ### 1. npm
60
+
61
+ ```sh
62
+ npm install @sythos/js_barcode_universal
63
+ ```
64
+
65
+ `yarn add @sythos/js_barcode_universal` and `pnpm add @sythos/js_barcode_universal` do the same thing. Nothing is installed
66
+ alongside it — there are no runtime dependencies, no postinstall script and no native build. The
67
+ package is plain ESM (`"type": "module"`) and asks for Node 18 or newer.
68
+
69
+ ```js
70
+ import { encode, decode, toSVG, toImageData } from '@sythos/js_barcode_universal';
71
+
72
+ const code = encode('SYT-2026-0042', { format: 'code128' });
73
+
74
+ const svg = toSVG(code, { scale: 2, margin: 10, barHeight: 60 });
75
+ // '<svg xmlns="http://www.w3.org/2000/svg" width="374" height="100" …'
76
+
77
+ const found = decode(toImageData(code, { scale: 4, margin: 10 }), { formats: ['code128'] });
78
+ console.log(found[0].text); // 'SYT-2026-0042'
79
+ ```
80
+
81
+ **Subpath exports** hand you one layer instead of the whole surface, which is what lets a
82
+ tree-shaking bundler drop everything you did not ask for. Importing only the QR writer and only
83
+ the SVG renderer never pulls in the 1D formats, the PNG encoder or the read pipeline:
84
+
85
+ ```js
86
+ import { encodeQR } from '@sythos/js_barcode_universal/qr';
87
+ import { toSVG } from '@sythos/js_barcode_universal/render/svg';
88
+
89
+ const svg = toSVG(encodeQR('https://example.com', { ecc: 'M' }), { scale: 8 });
90
+ // a 25×25 module symbol — 264×264 px at scale 8 with the default 4-module quiet zone
91
+ ```
92
+
93
+ | Subpath | What it exports |
94
+ |---|---|
95
+ | `@sythos/js_barcode_universal` | The whole surface: `encode`, `decode`, every renderer, every error type |
96
+ | `@sythos/js_barcode_universal/core` | `BitMatrix`, `GaloisField`, Reed–Solomon, the error classes |
97
+ | `@sythos/js_barcode_universal/image` | `LuminanceSource`, the binarizers, grid sampling, `PerspectiveTransform` |
98
+ | `@sythos/js_barcode_universal/oned` | The per-format 1D writers (`encodeEAN13`, `encodeCode128`, …) and `decodeOneD` |
99
+ | `@sythos/js_barcode_universal/qr` | `encodeQR`, `decodeQR`, `detectQR`, `detectAndDecodeQR` |
94
100
  | `@sythos/js_barcode_universal/datamatrix` | `encodeDataMatrix`, `decodeDataMatrix`, `detectDataMatrix`, `detectAndDecodeDataMatrix` |
95
101
  | `@sythos/js_barcode_universal/aztec` | `encodeAztec`, `decodeAztec`, `detectAztec`, `detectAndDecodeAztec` |
96
102
  | `@sythos/js_barcode_universal/pdf417` | `encodePDF417`, `decodePDF417`, `detectPDF417`, `detectAndDecodePDF417` |
97
103
  | `@sythos/js_barcode_universal/micropdf417` | `encodeMicroPDF417`, `decodeMicroPDF417`, `detectMicroPDF417`, `detectAndDecodeMicroPDF417` |
98
- | `@sythos/js_barcode_universal/render` | Every renderer plus `isWebGL2Available` / `isWebGPUAvailable` |
99
- | `@sythos/js_barcode_universal/render/svg` | `toSVG`, `toSVGDataURI` |
100
- | `@sythos/js_barcode_universal/render/png` | `toPNG`, `toPNGDataURI` |
101
- | `@sythos/js_barcode_universal/render/image-data` | `toImageData`, `toCanvas` |
102
- | `@sythos/js_barcode_universal/bundle` | The prebuilt ESM bundle, as one file |
103
- | `@sythos/js_barcode_universal/bundle/iife` | The prebuilt IIFE bundle, for a `<script>` tag |
104
-
105
- The `unpkg` and `jsdelivr` fields point at the IIFE bundle, so a CDN needs no install at all:
106
-
107
- ```html
108
- <script src="https://unpkg.com/@sythos/js_barcode_universal"></script>
109
- <script src="https://unpkg.com/@sythos/js_barcode_universal@1.2.5"></script>
110
- <script src="https://cdn.jsdelivr.net/npm/@sythos/js_barcode_universal@1.2.5"></script>
111
- ```
112
-
113
- Pin the version for anything you ship; the unpinned form resolves to `latest` and will move under
114
- you.
115
-
116
- Both CDNs serve the same file the repository ships in
117
- [`bundle/sythos-barcode.js`](bundle/sythos-barcode.js) — byte for byte, since that is exactly what
118
- npm publishes.
119
-
120
- ### 2. A `<script>` tag
121
-
122
- [`bundle/sythos-barcode.js`](bundle/sythos-barcode.js) is a self-contained IIFE that exposes a
123
- single global, `SythosBarcode`. It works straight from `file://` — open an HTML file off your
124
- disk and it runs.
125
-
126
- ```html
127
- <script src="bundle/sythos-barcode.js"></script>
128
- <script>
129
- var encode = SythosBarcode.encode;
130
- var toSVGDataURI = SythosBarcode.toSVGDataURI;
131
-
132
- var img = new Image();
133
- img.src = toSVGDataURI(encode('https://example.com', { format: 'qr' }), { scale: 8 });
134
- document.body.appendChild(img);
135
- </script>
136
- ```
137
-
138
- ### 3. ESM bundle
139
-
140
- [`bundle/sythos-barcode.esm.js`](bundle/sythos-barcode.esm.js) is the same code as a single ES
141
- module, for `<script type="module">`, a bundler, or Node.
142
-
143
- ```js
144
- import { encode, toSVG, toPNG } from './bundle/sythos-barcode.esm.js';
145
-
146
- const ean = encode('5901234123457', { format: 'ean13' });
147
-
148
- const svg = toSVG(ean, { scale: 3, margin: 10, barHeight: 80 });
149
- // '<svg xmlns="http://www.w3.org/2000/svg" width="345" height="141" '
150
-
151
- toPNG(ean, { scale: 3, barHeight: 80 }).then((bytes) => {
152
- // Uint8Array a 1-bit palette PNG
153
- });
154
- ```
155
-
156
- ### 4. The source directly
157
-
158
- [`src/index.js`](src/index.js) is plain ESM with JSDoc types and no build step of its own. Import
159
- it and let your bundler tree-shake; the package is marked side-effect free.
160
-
161
- ```js
162
- import { encode, decode, toImageData, listFormats } from './src/index.js';
163
-
164
- const matrix = encode('https://example.com', { format: 'qr', ecc: 'M' });
165
- const image = toImageData(matrix, { scale: 4, margin: 4 });
166
-
167
- const found = decode(image, { formats: ['qr'] });
168
- // [ { text: 'https://example.com', format: 'qr', version: 2, ecc: 'M', } ]
169
- ```
170
-
171
- Decoding takes anything `ImageData`-shaped, so a canvas, an `OffscreenCanvas`,
172
- `createImageBitmap`, or an image library's raw buffer all satisfy it without an adapter:
173
-
174
- ```js
175
- const ctx = canvas.getContext('2d');
176
- ctx.drawImage(video, 0, 0, canvas.width, canvas.height);
177
-
178
- for (const hit of decode(ctx.getImageData(0, 0, canvas.width, canvas.height))) {
179
- console.log(hit.format, hit.text);
180
- }
181
- ```
182
-
183
- `decode` returns an array, empty when nothing is found. A frame with no barcode is an ordinary
184
- outcome for a camera loop, not an error, so the common case needs no `try`/`catch`. Use
185
- `decodeStrict` when absence really is a failure.
186
-
187
- ---
188
-
189
- ## Supported formats
190
-
191
- Generated from `listFormats()`, which reports writing and reading as separate capabilities.
192
- Writing a symbology is a table lookup; reading one needs a detector that finds it in a
193
- photograph. The two lists legitimately differ, and saying so here is better than failing at call
194
- time.
195
-
196
- | Format | `id` | Kind | Write | Read |
197
- |---|---|:---:|:---:|:---:|
198
- | EAN-13 | `ean13` | 1D | ✅ | ✅ |
199
- | EAN-8 | `ean8` | 1D | | |
200
- | UPC-A | `upca` | 1D | ✅ | ✅ |
201
- | UPC-E | `upce` | 1D | ✅ | ✅ |
202
- | ISBN (Bookland) | `isbn` | 1D | ✅ | ✅ [^1] |
203
- | Code 128 | `code128` | 1D | ✅ | ✅ |
204
- | GS1-128 | `gs1128` | 1D | ✅ | ✅ [^1] |
205
- | Code 39 | `code39` | 1D | ✅ | ✅ |
206
- | Code 93 | `code93` | 1D | ✅ | ✅ |
207
- | ITF (Interleaved 2 of 5) | `itf` | 1D | ✅ | ✅ |
208
- | ITF-14 | `itf14` | 1D | ✅ | ✅ [^1] |
209
- | Codabar | `codabar` | 1D | ✅ | ✅ |
210
- | Code 11 | `code11` | 1D | ✅ | |
211
- | MSI Plessey | `msi` | 1D | ✅ | |
212
- | Pharmacode | `pharmacode` | 1D | ✅ | |
213
- | QR Code | `qr` | 2D | ✅ | |
214
- | Data Matrix ECC 200 | `datamatrix` | 2D | ✅ | |
104
+ | `@sythos/js_barcode_universal/microqr` | `encodeMicroQR`, `decodeMicroQR`, `detectMicroQR`, `detectAndDecodeMicroQR` |
105
+ | `@sythos/js_barcode_universal/rmqr` | `encodeRMQR`, `decodeRMQR`, `detectRMQR`, `detectAndDecodeRMQR` |
106
+ | `@sythos/js_barcode_universal/frameqr` | `encodeFrameQR`, `decodeFrameQR`, `detectFrameQR`, `detectAndDecodeFrameQR` |
107
+ | `@sythos/js_barcode_universal/render` | Every renderer plus `isWebGL2Available` / `isWebGPUAvailable` |
108
+ | `@sythos/js_barcode_universal/render/svg` | `toSVG`, `toSVGDataURI` |
109
+ | `@sythos/js_barcode_universal/render/png` | `toPNG`, `toPNGDataURI` |
110
+ | `@sythos/js_barcode_universal/render/image-data` | `toImageData`, `toCanvas` |
111
+ | `@sythos/js_barcode_universal/bundle` | The prebuilt ESM bundle, as one file |
112
+ | `@sythos/js_barcode_universal/bundle/iife` | The prebuilt IIFE bundle, for a `<script>` tag |
113
+
114
+ The `unpkg` and `jsdelivr` fields point at the IIFE bundle, so a CDN needs no install at all:
115
+
116
+ ```html
117
+ <script src="https://unpkg.com/@sythos/js_barcode_universal"></script>
118
+ <script src="https://unpkg.com/@sythos/js_barcode_universal@1.3.1"></script>
119
+ <script src="https://cdn.jsdelivr.net/npm/@sythos/js_barcode_universal@1.3.1"></script>
120
+ ```
121
+
122
+ Pin the version for anything you ship; the unpinned form resolves to `latest` and will move under
123
+ you.
124
+
125
+ Both CDNs serve the same file the repository ships in
126
+ [`bundle/sythos-barcode.js`](bundle/sythos-barcode.js) byte for byte, since that is exactly what
127
+ npm publishes.
128
+
129
+ ### 2. A `<script>` tag
130
+
131
+ [`bundle/sythos-barcode.js`](bundle/sythos-barcode.js) is a self-contained IIFE that exposes a
132
+ single global, `SythosBarcode`. It works straight from `file://` — open an HTML file off your
133
+ disk and it runs.
134
+
135
+ ```html
136
+ <script src="bundle/sythos-barcode.js"></script>
137
+ <script>
138
+ var encode = SythosBarcode.encode;
139
+ var toSVGDataURI = SythosBarcode.toSVGDataURI;
140
+
141
+ var img = new Image();
142
+ img.src = toSVGDataURI(encode('https://example.com', { format: 'qr' }), { scale: 8 });
143
+ document.body.appendChild(img);
144
+ </script>
145
+ ```
146
+
147
+ ### 3. ESM bundle
148
+
149
+ [`bundle/sythos-barcode.esm.js`](bundle/sythos-barcode.esm.js) is the same code as a single ES
150
+ module, for `<script type="module">`, a bundler, or Node.
151
+
152
+ ```js
153
+ import { encode, toSVG, toPNG } from './bundle/sythos-barcode.esm.js';
154
+
155
+ const ean = encode('5901234123457', { format: 'ean13' });
156
+
157
+ const svg = toSVG(ean, { scale: 3, margin: 10, barHeight: 80 });
158
+ // '<svg xmlns="http://www.w3.org/2000/svg" width="345" height="141" …'
159
+
160
+ toPNG(ean, { scale: 3, barHeight: 80 }).then((bytes) => {
161
+ // Uint8Array — a 1-bit palette PNG
162
+ });
163
+ ```
164
+
165
+ ### 4. The source directly
166
+
167
+ [`src/index.js`](src/index.js) is plain ESM with JSDoc types and no build step of its own. Import
168
+ it and let your bundler tree-shake; the package is marked side-effect free.
169
+
170
+ ```js
171
+ import { encode, decode, toImageData, listFormats } from './src/index.js';
172
+
173
+ const matrix = encode('https://example.com', { format: 'qr', ecc: 'M' });
174
+ const image = toImageData(matrix, { scale: 4, margin: 4 });
175
+
176
+ const found = decode(image, { formats: ['qr'] });
177
+ // [ { text: 'https://example.com', format: 'qr', version: 2, ecc: 'M', … } ]
178
+ ```
179
+
180
+ Decoding takes anything `ImageData`-shaped, so a canvas, an `OffscreenCanvas`,
181
+ `createImageBitmap`, or an image library's raw buffer all satisfy it without an adapter:
182
+
183
+ ```js
184
+ const ctx = canvas.getContext('2d');
185
+ ctx.drawImage(video, 0, 0, canvas.width, canvas.height);
186
+
187
+ for (const hit of decode(ctx.getImageData(0, 0, canvas.width, canvas.height))) {
188
+ console.log(hit.format, hit.text);
189
+ }
190
+ ```
191
+
192
+ `decode` returns an array, empty when nothing is found. A frame with no barcode is an ordinary
193
+ outcome for a camera loop, not an error, so the common case needs no `try`/`catch`. Use
194
+ `decodeStrict` when absence really is a failure.
195
+
196
+ ---
197
+
198
+ ## Supported formats
199
+
200
+ Generated from `listFormats()`, which reports writing and reading as separate capabilities.
201
+ Writing a symbology is a table lookup; reading one needs a detector that finds it in a
202
+ photograph. The two lists legitimately differ, and saying so here is better than failing at call
203
+ time.
204
+
205
+ | Format | `id` | Kind | Write | Read |
206
+ |---|---|:---:|:---:|:---:|
207
+ | EAN-13 | `ean13` | 1D | ✅ | ✅ |
208
+ | EAN-8 | `ean8` | 1D | ✅ | ✅ |
209
+ | UPC-A | `upca` | 1D | ✅ | ✅ |
210
+ | UPC-E | `upce` | 1D | ✅ | ✅ |
211
+ | ISBN (Bookland) | `isbn` | 1D | ✅ | ✅ [^1] |
212
+ | Code 128 | `code128` | 1D | ✅ | ✅ |
213
+ | GS1-128 | `gs1128` | 1D | ✅ | ✅ [^1] |
214
+ | Code 39 | `code39` | 1D | ✅ | ✅ |
215
+ | Code 93 | `code93` | 1D | ✅ | ✅ |
216
+ | ITF (Interleaved 2 of 5) | `itf` | 1D | ✅ | |
217
+ | ITF-14 | `itf14` | 1D | ✅ | [^1] |
218
+ | Codabar | `codabar` | 1D | ✅ | |
219
+ | Code 11 | `code11` | 1D | ✅ | |
220
+ | MSI Plessey | `msi` | 1D | ✅ | |
221
+ | Pharmacode | `pharmacode` | 1D | ✅ | — |
222
+ | QR Code | `qr` | 2D | ✅ | ✅ |
223
+ | Data Matrix ECC 200 | `datamatrix` | 2D | ✅ | ✅ |
215
224
  | Aztec Code | `aztec` | 2D | ✅ | ✅ |
216
225
  | PDF417 | `pdf417` | 2D | ✅ | ✅ |
217
226
  | MicroPDF417 | `micropdf417` | 2D | ✅ | ✅ |
227
+ | Micro QR Code | `microqr` | 2D | ✅ | ✅ |
228
+ | rMQR Code | `rmqr` | 2D | ✅ | ✅ |
229
+ | Sythos Canvas QR profile (non-certified; not DENSO FrameQR) | `frameqr` | 2D | ✅ | ✅ |
218
230
 
219
- Twenty formats, all writable, seventeen readable. **Code 11, MSI Plessey and Pharmacode remain
231
+ Twenty-three formats, all writable, twenty readable. **Code 11, MSI Plessey and Pharmacode remain
220
232
  write-only in the generic image pipeline.** PDF417 exposes direct matrix decoding, automatic
221
233
  camera localization and an assisted quadrilateral sampler through its subpath. Its detector is
222
234
  validated on degraded synthetic photographs and real Pixel 10/Chrome and iPhone 17/Safari camera
223
235
  tests; external black-box vectors from ZXing 3.5.3 and bwip-js also pass in both directions.
224
236
  Text and Numeric vectors are covered bidirectionally; binary byte-for-byte interop remains
225
237
  explicitly unclaimed until a dedicated external byte corpus is added.
226
-
227
- [^1]: `gs1128`, `itf14` and `isbn` are sub-variants that share a decoder with their base format, so
228
- they decode under that base id: a GS1-128 comes back as `code128`, an ITF-14 as `itf`, and an ISBN
229
- as `ean13`. The payload is intact either way — a GS1-128 *is* a Code 128 with a leading FNC1, an
230
- ITF-14 *is* an ITF fixed at fourteen digits, and an ISBN barcode *is* an EAN-13 with a 978/979
231
- prefix. Match on `result.format === 'code128'` rather than `'gs1128'`, or a
232
- condition on the sub-variant id will silently never fire.
233
-
234
- ### Data Matrix ECC 200
235
-
236
- `datamatrix` writes and reads the 30 classic ECC 200 square and rectangular symbol sizes. The
237
- encoder supports ASCII compaction (including numeric pairs), Base256 binary payloads, automatic
238
- or forced square/rectangular shape, Reed–Solomon error correction and GS1 FNC1 in the first
239
- position. DMRE is not included.
240
-
241
- ```js
242
- import { encodeDataMatrix, decodeDataMatrix } from '@sythos/js_barcode_universal/datamatrix';
243
-
244
- const symbol = encodeDataMatrix('0101234567890128', { gs1: true, shape: 'square' });
245
- const result = decodeDataMatrix(symbol);
246
- console.log(result.text, result.gs1); // 0101234567890128 true
247
- ```
248
-
249
- Binary content is accepted as a `Uint8Array` with `encoding: 'base256'`. The current high-level
250
- decoder handles ASCII and Base256 codewords; C40, Text, X12 and EDIFACT input symbols are not yet
251
- decoded. The current detector accepts axis-aligned square or rectangular symbols; the normal
252
- `decode(image, { formats: ['datamatrix'] })` pipeline also retries quarter-turn rotations.
253
- Arbitrary-angle and perspective-skewed Data Matrix photographs are not yet guaranteed.
254
-
255
- ### Aztec Code
256
-
257
- `aztec` writes Compact layers 1–4 and Full layers 1–32, selecting a fitting symbol automatically
258
- unless `layers` and `compact` are forced. It supports the five Aztec text tables and UTF-8 byte
259
- payloads through Binary Shift, with `eccPercent` (default 23) controlling the requested
260
- error-correction level.
261
- ECI is not yet a configurable public option.
262
-
263
- ```js
264
- import { encodeAztec, decodeAztec } from '@sythos/js_barcode_universal/aztec';
265
-
266
- const symbol = encodeAztec('Greetings My Lord Sythos 👋', { eccPercent: 23 });
267
- const result = decodeAztec(symbol);
268
- console.log(result.text); // Greetings My Lord Sythos 👋
269
- ```
270
-
271
- The image detector handles rotation, inverted polarity and quadrilateral sampling around the
272
- central bull’s-eye. Severe photographic perspective remains an interoperability and robustness
273
- gate rather than a guaranteed capability.
274
-
238
+
239
+ [^1]: `gs1128`, `itf14` and `isbn` are sub-variants that share a decoder with their base format, so
240
+ they decode under that base id: a GS1-128 comes back as `code128`, an ITF-14 as `itf`, and an ISBN
241
+ as `ean13`. The payload is intact either way — a GS1-128 *is* a Code 128 with a leading FNC1, an
242
+ ITF-14 *is* an ITF fixed at fourteen digits, and an ISBN barcode *is* an EAN-13 with a 978/979
243
+ prefix. Match on `result.format === 'code128'` rather than `'gs1128'`, or a
244
+ condition on the sub-variant id will silently never fire.
245
+
246
+ ### Data Matrix ECC 200
247
+
248
+ `datamatrix` writes and reads the 30 classic ECC 200 square and rectangular symbol sizes. The
249
+ encoder supports ASCII compaction (including numeric pairs), Base256 binary payloads, automatic
250
+ or forced square/rectangular shape, Reed–Solomon error correction and GS1 FNC1 in the first
251
+ position. DMRE is not included.
252
+
253
+ ```js
254
+ import { encodeDataMatrix, decodeDataMatrix } from '@sythos/js_barcode_universal/datamatrix';
255
+
256
+ const symbol = encodeDataMatrix('0101234567890128', { gs1: true, shape: 'square' });
257
+ const result = decodeDataMatrix(symbol);
258
+ console.log(result.text, result.gs1); // 0101234567890128 true
259
+ ```
260
+
261
+ Binary content is accepted as a `Uint8Array` with `encoding: 'base256'`. The current high-level
262
+ decoder handles ASCII and Base256 codewords; C40, Text, X12 and EDIFACT input symbols are not yet
263
+ decoded. The current detector accepts axis-aligned square or rectangular symbols; the normal
264
+ `decode(image, { formats: ['datamatrix'] })` pipeline also retries quarter-turn rotations.
265
+ Arbitrary-angle and perspective-skewed Data Matrix photographs are not yet guaranteed.
266
+
267
+ ### Aztec Code
268
+
269
+ `aztec` writes Compact layers 1–4 and Full layers 1–32, selecting a fitting symbol automatically
270
+ unless `layers` and `compact` are forced. It supports the five Aztec text tables and UTF-8 byte
271
+ payloads through Binary Shift, with `eccPercent` (default 23) controlling the requested
272
+ error-correction level.
273
+ ECI is not yet a configurable public option.
274
+
275
+ ```js
276
+ import { encodeAztec, decodeAztec } from '@sythos/js_barcode_universal/aztec';
277
+
278
+ const symbol = encodeAztec('Greetings My Lord Sythos 👋', { eccPercent: 23 });
279
+ const result = decodeAztec(symbol);
280
+ console.log(result.text); // Greetings My Lord Sythos 👋
281
+ ```
282
+
283
+ The image detector handles rotation, inverted polarity and quadrilateral sampling around the
284
+ central bull’s-eye. Severe photographic perspective remains an interoperability and robustness
285
+ gate rather than a guaranteed capability.
286
+
275
287
  ### PDF417 (writer, matrix decoder and camera reader)
276
288
 
277
289
  `pdf417` supports PDF417 Text, Byte and Numeric compaction, ECI 3 (ISO-8859-1) and ECI 26
@@ -309,209 +321,278 @@ The detector accepts clean, integer-scaled raster symbols and quarter-turn rotat
309
321
  perspective, severe photographic degradation and multi-symbol scenes are not yet claimed as
310
322
  robust capabilities.
311
323
 
324
+ ### Micro QR Code
325
+
326
+ `microqr` implements the M1–M4 family with Numeric, Alphanumeric, ISO-8859-1 Byte and Kanji
327
+ payloads, BCH format protection, the four Micro QR masks and Reed–Solomon correction. M1 is
328
+ detection-only. ECI, FNC1/GS1 and Structured Append are intentionally outside the current API.
329
+ The detector accepts clean scaled rasters, quarter-turns, inverted polarity and mild projective
330
+ sampling, and rejects normal QR Model 2 symbols.
331
+
332
+ ```js
333
+ import { encodeMicroQR, decodeMicroQR } from '@sythos/js_barcode_universal/microqr';
334
+
335
+ const symbol = encodeMicroQR('12345', { version: 'M2', ecc: 'L' });
336
+ console.log(decodeMicroQR(symbol).text);
337
+ ```
338
+
339
+ ### rMQR Code
340
+
341
+ `rmqr` implements all 32 standard rectangular geometries, M/H ECC, Numeric, Alphanumeric, Byte,
342
+ Kanji and ECI payloads. The detector accepts clean integer-scaled rasters, quiet zones and
343
+ quarter-turns; arbitrary photographic perspective and multi-symbol scenes are not claimed.
344
+
345
+ ```js
346
+ import { encodeRMQR, decodeRMQR } from '@sythos/js_barcode_universal/rmqr';
347
+
348
+ const symbol = encodeRMQR('rMQR SAMPLE', { ecc: 'M' });
349
+ console.log(decodeRMQR(symbol).text);
350
+ ```
351
+
352
+ ### Sythos Canvas QR profile
353
+
354
+ `frameqr` is an explicitly scoped, non-certified Sythos profile: it reserves a bounded square,
355
+ circle or diamond artwork canvas inside an ECC-H QR Model 2 symbol. It is **not** a native DENSO
356
+ FrameQR encoder or decoder, and the package makes no DENSO interoperability claim. The profile
357
+ can be read from clean rendered rasters and is exposed through the normal `encode`/`decode` API
358
+ and the `frameqr` subpath.
359
+
360
+ ```js
361
+ import { encodeFrameQR, decodeFrameQR } from '@sythos/js_barcode_universal/frameqr';
362
+
363
+ const symbol = encodeFrameQR('https://www.sythos.net/', {
364
+ canvas: { shape: 'square', size: 5 },
365
+ });
366
+ console.log(decodeFrameQR(symbol).text);
367
+ ```
368
+
369
+ The canonical `examples/create.html` preview loads `https://www.sythos.net/favicon.ico` and
370
+ falls back to `https://www.sythos.net/apple-touch-icon.png`. The image is never copied into the
371
+ repository; if browser CORS prevents safe compositing, the page keeps a preview overlay and
372
+ exports the QR symbol without embedding the remote artwork.
373
+
312
374
  ### Not implemented
313
-
375
+
314
376
  **GS1 DataBar and MaxiCode are not implemented** — neither writing nor reading. Data Matrix ECC
315
377
  200 is implemented for its classic square and rectangular symbols;
316
378
  DMRE remains outside the current scope. See [`PLAN.md`](PLAN.md) for the remaining symbologies.
317
-
318
- ---
319
-
320
- ## Live examples
321
-
322
- Two self-contained pages, each loading the IIFE bundle with a plain `<script>` tag. **Both open
323
- directly from disk** — double-click the file, no server and no build. This `examples/` directory is
324
- the single canonical source; the development workspace references these files instead of keeping
325
- a second copy.
326
-
327
- ### [`examples/create.html`](examples/create.html)
328
-
329
- Pick any writable format, type a payload, and watch the symbol redraw as you type; download it as
330
- PNG or SVG. For QR it adds a **content-type builder** that assembles the payload for you across
331
- URL, email, phone, SMS, Wi-Fi network, contact card (both vCard and MeCard), geo location and
332
- calendar event — with correct escaping for each — and shows you the exact string it produced, so
333
- you can see what a Wi-Fi or vCard QR actually contains. ECC level, version, scale, margin and both
334
- colours are exposed.
335
-
336
- ### [`examples/read.html`](examples/read.html)
337
-
338
- Decode from an image: drop one onto the page, or click to choose a file. It then offers a live
339
- camera loop that decodes continuously from the video stream.
340
-
341
- > The file and drag-drop path works anywhere, `file://` included. **The camera needs http(s)**,
342
- > because `getUserMedia` requires a secure context and refuses to run from `file://`. Serve the
343
- > folder over localhost for that half; the page detects the situation and says so rather than
344
- > failing silently.
345
-
346
- ---
347
-
348
- ## API summary
349
-
350
- Two functions carry the whole surface. Everything else is a renderer or a format-specific escape
351
- hatch.
352
-
353
- ### Encoding and decoding
354
-
355
- ```js
356
- encode(text, options?) → BitMatrix
357
- ```
358
-
359
- `options`: `format` (default `'qr'`), `ecc` (`'L'|'M'|'Q'|'H'`), `version` (QR 1–40, auto if
360
- omitted), `checkDigit`, `fullAscii` (Code 39 extended), `gs1` (emit a leading FNC1). Data Matrix
361
- ECC 200 accepts `shape: 'any' | 'square' | 'rectangular'` and `encoding: 'ascii' | 'base256'`.
379
+
380
+ ---
381
+
382
+ ## Live examples
383
+
384
+ Two self-contained pages, each loading the IIFE bundle with a plain `<script>` tag. **Both open
385
+ directly from disk** — double-click the file, no server and no build. This `examples/` directory is
386
+ the single canonical source; the development workspace references these files instead of keeping
387
+ a second copy.
388
+
389
+ ### [`examples/create.html`](examples/create.html)
390
+
391
+ Pick any writable format, type a payload, and watch the symbol redraw as you type; download it as
392
+ PNG or SVG. For QR it adds a **content-type builder** that assembles the payload for you across
393
+ URL, email, phone, SMS, Wi-Fi network, contact card (both vCard and MeCard), geo location and
394
+ calendar event — with correct escaping for each — and shows you the exact string it produced, so
395
+ you can see what a Wi-Fi or vCard QR actually contains. ECC level, version, scale, margin and both
396
+ colours are exposed.
397
+
398
+ ### [`examples/read.html`](examples/read.html)
399
+
400
+ Decode from an image: drop one onto the page, or click to choose a file. It then offers a live
401
+ camera loop that decodes continuously from the video stream.
402
+
403
+ > The file and drag-drop path works anywhere, `file://` included. **The camera needs http(s)**,
404
+ > because `getUserMedia` requires a secure context and refuses to run from `file://`. Serve the
405
+ > folder over localhost for that half; the page detects the situation and says so rather than
406
+ > failing silently.
407
+
408
+ ---
409
+
410
+ ## API summary
411
+
412
+ Two functions carry the whole surface. Everything else is a renderer or a format-specific escape
413
+ hatch.
414
+
415
+ ### Encoding and decoding
416
+
417
+ ```js
418
+ encode(text, options?) → BitMatrix
419
+ ```
420
+
421
+ `options`: `format` (default `'qr'`), `ecc` (`'L'|'M'|'Q'|'H'`), `version` (QR 1–40, auto if
422
+ omitted), `checkDigit`, `fullAscii` (Code 39 extended), `gs1` (emit a leading FNC1). Data Matrix
423
+ ECC 200 accepts `shape: 'any' | 'square' | 'rectangular'` and `encoding: 'ascii' | 'base256'`.
362
424
  Aztec accepts `layers`, `compact` and `eccPercent`; it transports UTF-8 byte payloads through
363
425
  Binary Shift, and it does not expose configurable ECI yet.
364
426
  MicroPDF417 accepts `compaction: 'auto' | 'text' | 'byte' | 'numeric'`, ECI 3 or 26 for Byte
365
427
  compaction, and optional `columns`, `rowHeight` and `aspectRatio` constraints.
366
-
367
- ```js
368
- encode('5901234123457', { format: 'ean13' })
369
- encode('ABC-123', { format: 'code39', fullAscii: true, checkDigit: true })
370
- encode('https://example.com', { format: 'qr', ecc: 'H', version: 7 })
371
- encode('0101234567890128', { format: 'datamatrix', gs1: true })
428
+ Micro QR accepts `version: 'M1' | 'M2' | 'M3' | 'M4'`, its legal ECC level and mask; its
429
+ unsupported ECI, FNC1/GS1 and Structured Append features are rejected explicitly. rMQR accepts
430
+ `ecc: 'M' | 'H'`, optional geometry/version constraints and ECI for byte payloads. The Sythos
431
+ Canvas QR profile accepts `canvas: { shape: 'square' | 'circle' | 'diamond', size, width,
432
+ height, centerX, centerY, angle }`; it is non-certified and separate from DENSO FrameQR.
433
+
434
+ ```js
435
+ encode('5901234123457', { format: 'ean13' })
436
+ encode('ABC-123', { format: 'code39', fullAscii: true, checkDigit: true })
437
+ encode('https://example.com', { format: 'qr', ecc: 'H', version: 7 })
438
+ encode('0101234567890128', { format: 'datamatrix', gs1: true })
372
439
  encode('Greetings My Lord Sythos 👋', { format: 'aztec', eccPercent: 23 })
373
440
  encode('MICRO PDF417', { format: 'micropdf417', compaction: 'text' })
374
- ```
375
-
376
- ```js
377
- decode(image, options?) → Result[]
378
- decodeStrict(image, options?) Result // throws NotFoundError instead of returning []
379
- ```
380
-
381
- `image` is `{ data, width, height }` with RGBA bytes. `options`: `formats` (restrict the search,
382
- and go faster), `tryHarder` (retry inverted, default `true`), `binarizer`
383
- (`'global' | 'hybrid' | 'auto'`). A `Result` carries at least `text` and `format`; QR results also
384
- carry `bytes`, `version` and `ecc`.
385
-
386
- ```js
387
- listFormats() { id, label, canWrite, canRead, kind }[]
388
- ```
389
-
390
- The table above is this function's output. Read it at runtime rather than hard-coding a format
391
- list — that is how the demo pages build their dropdowns.
392
-
393
- ### Renderers
394
-
395
- ```js
396
- toSVG(matrix, options?) string // one merged <path>, not a rect per module
397
- toSVGDataURI(matrix, options?) string // data: URI for an <img src>
398
- toImageData(matrix, options?) → { data, width, height }
399
- toPNG(matrix, options?) → Promise<Uint8Array> // 1-bit palette PNG
400
- toPNGDataURI(matrix, options?) → Promise<string>
401
- toCanvas(matrix, canvas, options?) → boolean // 2D context
402
- renderToCanvasAuto(matrix, canvas, options?) → { backend: 'webgl2' | '2d' | 'none' }
403
- renderToCanvasAutoAsync(matrix, canvas, options?) → Promise<{ backend: 'webgpu' | 'webgl2' | '2d' | 'none' }>
404
- ```
405
-
406
- The two PNG functions are async because they use the platform's deflate — `node:zlib` or
407
- `CompressionStream` and fall back to stored blocks where neither exists.
408
-
409
- `renderToCanvasAuto` is synchronous and therefore cannot reach WebGPU: acquiring an adapter is
410
- asynchronous, and a synchronous function can never wait for one. Use `renderToCanvasAutoAsync`
411
- when you want WebGPU in the chain. Both fall through to the 2D context, which always exists.
412
-
413
- All renderers share the same options:
414
-
415
- | Option | Default | Meaning |
416
- |---|---|---|
417
- | `scale` | `8` | Pixels per module |
418
- | `margin` | `4` | Quiet-zone modules on every side |
419
- | `dark` | `'#000000'` | Colour of set modules |
420
- | `light` | `'#ffffff'` | Colour of clear modules; `'none'` for transparent |
421
- | `barHeight` | auto | 1D only: total bar height in pixels |
422
-
423
- Also exported: `BitMatrix`, the error types (`BarcodeError`, `EncodeError`, `NotFoundError`,
424
- `FormatError`, `ChecksumError`), the per-format writers (`encodeEAN13`, `encodeCode128`, …), the
425
- QR entry points (`encodeQR`, `decodeQR`, `detectQR`, `detectAndDecodeQR`), the image primitives
426
- (`LuminanceSource`, `binarize`, `binarizeGlobal`, `binarizeHybrid`), and the capability probes
427
- `isWebGL2Available` / `isWebGPUAvailable`.
428
-
429
- ---
430
-
431
- ## How it works
432
-
433
- **`BitMatrix` is the interchange type.** Every writer produces one, every reader consumes one,
434
- every renderer draws one. That single currency is what keeps symbologies and output targets
435
- independent of each other — adding a format touches no renderer, and adding a renderer touches no
436
- format. Storage is row-packed into a `Uint32Array`: one allocation, cache-friendly row scans, and
437
- cheap whole-row operations for the 1D readers.
438
-
439
- **A set bit is a dark module.** This matches how every specification describes its symbols;
440
- renderers invert where their medium needs it.
441
-
442
- **`encode` returns no quiet zone.** The margin is a rendering decision, not an encoding one — how
443
- much white space a symbol needs depends on where it is going — so the renderers add it and the
444
- matrix stays the pure symbol. For the same reason, **linear symbols come back exactly one module
445
- tall**: height carries no information in a 1D barcode, so encoding one would be inventing data.
446
- The renderer stretches the single row to `barHeight` *before* applying the quiet zone, so the
447
- margin ends up uniform on all four sides.
448
-
449
- **The read pipeline** is a straight line, each stage a separate module:
450
-
451
- ```
452
- RGBA bytes luminance binarize detect sample error-correct decode
453
- ```
454
-
455
- Luminance conversion flattens the image to greyscale. Binarization turns that into a `BitMatrix`,
456
- either globally or with a hybrid local threshold that survives uneven lighting. Detection locates
457
- a symbol and its corners in that bit plane. Detectors that recover four perspective-aware corners
458
- (currently QR) sample the symbol back through a perspective transform. Data Matrix currently uses
459
- an axis-aligned bounding box plus quarter-turn retries. Error correction repairs what the camera
460
- lost. Only then is the payload decoded.
461
-
462
- **Reed–Solomon is generic over the finite field.** The `GaloisField` class is constructed with a
463
- field order and a primitive polynomial rather than hard-coding GF(256), which is what lets one
464
- implementation serve QR, and the prime field GF(929) that PDF417 needs. Prime fields are the
465
- subtle case: in a binary field addition and subtraction are both XOR, so a decoder that inlines
466
- `^` for field addition passes every binary field and fails only the prime one.
467
-
468
- ---
469
-
470
- ## About the GPU path
471
-
472
- The WebGL2 and WebGPU backends accelerate **drawing** a barcode, not **computing** one. That is
473
- worth stating plainly, because "GPU barcode generation" naturally suggests the latter.
474
-
475
- Encoding is sequential integer work: Reed–Solomon polynomial division, mask penalty scoring, bit
476
- placement along a zig-zag path. Each step depends on the one before it, which is precisely the
477
- shape a GPU cannot exploit. A complete QR encode takes well under a millisecond on the CPU — less
478
- time than dispatching a compute shader and reading the result back would cost. Moving it to the
479
- GPU would make it slower.
480
-
481
- So encoding stays on the CPU because that is the correct engineering answer, not because
482
- something is missing. Where the GPU genuinely earns its place is drawing large symbols, or many
483
- symbols per frame, straight into a canvas without a CPU-side pixel buffer and it would earn it
484
- again on the read side, where per-frame greyscale conversion and block statistics over a 4K camera
485
- image are both the real bottleneck and embarrassingly parallel.
486
-
487
- ---
488
-
489
- ## Browser support
490
-
491
- The syntax floor is **iOS Safari 15**. No `Array.prototype.at`, no top-level `await`, no
492
- `Object.groupBy`.
493
-
494
- `OffscreenCanvas`, WebGL2 and WebGPU are feature-detected, never assumed. The 2D canvas path
495
- always exists, so nothing is unreachable on an older device — `renderToCanvasAuto` degrades to it
496
- and reports which backend actually drew.
497
-
498
- ---
499
-
500
- ## Licence
501
-
502
- MIT © 2026 Sythos. Every source file carries the header.
503
-
441
+ encode('12345', { format: 'microqr', version: 'M2', ecc: 'L' })
442
+ encode('rMQR SAMPLE', { format: 'rmqr', ecc: 'M' })
443
+ encode('https://www.sythos.net/', {
444
+ format: 'frameqr',
445
+ canvas: { shape: 'square', size: 5 },
446
+ })
447
+ ```
448
+
449
+ ```js
450
+ decode(image, options?) Result[]
451
+ decodeStrict(image, options?) Result // throws NotFoundError instead of returning []
452
+ ```
453
+
454
+ `image` is `{ data, width, height }` with RGBA bytes. `options`: `formats` (restrict the search,
455
+ and go faster), `tryHarder` (retry inverted, default `true`), `binarizer`
456
+ (`'global' | 'hybrid' | 'auto'`). A `Result` carries at least `text` and `format`; QR results also
457
+ carry `bytes`, `version` and `ecc`.
458
+
459
+ ```js
460
+ listFormats() → { id, label, canWrite, canRead, kind }[]
461
+ ```
462
+
463
+ The table above is this function's output. Read it at runtime rather than hard-coding a format
464
+ list that is how the demo pages build their dropdowns.
465
+
466
+ ### Renderers
467
+
468
+ ```js
469
+ toSVG(matrix, options?) → string // one merged <path>, not a rect per module
470
+ toSVGDataURI(matrix, options?) → string // data: URI for an <img src>
471
+ toImageData(matrix, options?) → { data, width, height }
472
+ toPNG(matrix, options?) → Promise<Uint8Array> // 1-bit palette PNG
473
+ toPNGDataURI(matrix, options?) Promise<string>
474
+ toCanvas(matrix, canvas, options?) boolean // 2D context
475
+ renderToCanvasAuto(matrix, canvas, options?) → { backend: 'webgl2' | '2d' | 'none' }
476
+ renderToCanvasAutoAsync(matrix, canvas, options?) Promise<{ backend: 'webgpu' | 'webgl2' | '2d' | 'none' }>
477
+ ```
478
+
479
+ The two PNG functions are async because they use the platform's deflate — `node:zlib` or
480
+ `CompressionStream` and fall back to stored blocks where neither exists.
481
+
482
+ `renderToCanvasAuto` is synchronous and therefore cannot reach WebGPU: acquiring an adapter is
483
+ asynchronous, and a synchronous function can never wait for one. Use `renderToCanvasAutoAsync`
484
+ when you want WebGPU in the chain. Both fall through to the 2D context, which always exists.
485
+
486
+ All renderers share the same options:
487
+
488
+ | Option | Default | Meaning |
489
+ |---|---|---|
490
+ | `scale` | `8` | Pixels per module |
491
+ | `margin` | `4` | Quiet-zone modules on every side |
492
+ | `dark` | `'#000000'` | Colour of set modules |
493
+ | `light` | `'#ffffff'` | Colour of clear modules; `'none'` for transparent |
494
+ | `barHeight` | auto | 1D only: total bar height in pixels |
495
+
496
+ Also exported: `BitMatrix`, the error types (`BarcodeError`, `EncodeError`, `NotFoundError`,
497
+ `FormatError`, `ChecksumError`), the per-format writers (`encodeEAN13`, `encodeCode128`, …), the
498
+ QR entry points (`encodeQR`, `decodeQR`, `detectQR`, `detectAndDecodeQR`), the image primitives
499
+ (`LuminanceSource`, `binarize`, `binarizeGlobal`, `binarizeHybrid`), and the capability probes
500
+ `isWebGL2Available` / `isWebGPUAvailable`.
501
+
502
+ ---
503
+
504
+ ## How it works
505
+
506
+ **`BitMatrix` is the interchange type.** Every writer produces one, every reader consumes one,
507
+ every renderer draws one. That single currency is what keeps symbologies and output targets
508
+ independent of each other — adding a format touches no renderer, and adding a renderer touches no
509
+ format. Storage is row-packed into a `Uint32Array`: one allocation, cache-friendly row scans, and
510
+ cheap whole-row operations for the 1D readers.
511
+
512
+ **A set bit is a dark module.** This matches how every specification describes its symbols;
513
+ renderers invert where their medium needs it.
514
+
515
+ **`encode` returns no quiet zone.** The margin is a rendering decision, not an encoding one — how
516
+ much white space a symbol needs depends on where it is going so the renderers add it and the
517
+ matrix stays the pure symbol. For the same reason, **linear symbols come back exactly one module
518
+ tall**: height carries no information in a 1D barcode, so encoding one would be inventing data.
519
+ The renderer stretches the single row to `barHeight` *before* applying the quiet zone, so the
520
+ margin ends up uniform on all four sides.
521
+
522
+ **The read pipeline** is a straight line, each stage a separate module:
523
+
524
+ ```
525
+ RGBA bytes luminance binarize detect sample error-correct decode
526
+ ```
527
+
528
+ Luminance conversion flattens the image to greyscale. Binarization turns that into a `BitMatrix`,
529
+ either globally or with a hybrid local threshold that survives uneven lighting. Detection locates
530
+ a symbol and its corners in that bit plane. Detectors that recover four perspective-aware corners
531
+ (currently QR) sample the symbol back through a perspective transform. Data Matrix currently uses
532
+ an axis-aligned bounding box plus quarter-turn retries. Error correction repairs what the camera
533
+ lost. Only then is the payload decoded.
534
+
535
+ **Reed–Solomon is generic over the finite field.** The `GaloisField` class is constructed with a
536
+ field order and a primitive polynomial rather than hard-coding GF(256), which is what lets one
537
+ implementation serve QR, and the prime field GF(929) that PDF417 needs. Prime fields are the
538
+ subtle case: in a binary field addition and subtraction are both XOR, so a decoder that inlines
539
+ `^` for field addition passes every binary field and fails only the prime one.
540
+
541
+ ---
542
+
543
+ ## About the GPU path
544
+
545
+ The WebGL2 and WebGPU backends accelerate **drawing** a barcode, not **computing** one. That is
546
+ worth stating plainly, because "GPU barcode generation" naturally suggests the latter.
547
+
548
+ Encoding is sequential integer work: Reed–Solomon polynomial division, mask penalty scoring, bit
549
+ placement along a zig-zag path. Each step depends on the one before it, which is precisely the
550
+ shape a GPU cannot exploit. A complete QR encode takes well under a millisecond on the CPU — less
551
+ time than dispatching a compute shader and reading the result back would cost. Moving it to the
552
+ GPU would make it slower.
553
+
554
+ So encoding stays on the CPU because that is the correct engineering answer, not because
555
+ something is missing. Where the GPU genuinely earns its place is drawing large symbols, or many
556
+ symbols per frame, straight into a canvas without a CPU-side pixel buffer — and it would earn it
557
+ again on the read side, where per-frame greyscale conversion and block statistics over a 4K camera
558
+ image are both the real bottleneck and embarrassingly parallel.
559
+
560
+ ---
561
+
562
+ ## Browser support
563
+
564
+ The syntax floor is **iOS Safari 15**. No `Array.prototype.at`, no top-level `await`, no
565
+ `Object.groupBy`.
566
+
567
+ `OffscreenCanvas`, WebGL2 and WebGPU are feature-detected, never assumed. The 2D canvas path
568
+ always exists, so nothing is unreachable on an older device — `renderToCanvasAuto` degrades to it
569
+ and reports which backend actually drew.
570
+
571
+ ---
572
+
573
+ ## Licence
574
+
575
+ MIT © 2026 Sythos. Every source file carries the header.
576
+
504
577
  **The implementation is original Sythos work.** No third-party barcode source code is copied into
505
578
  or shipped by this package. The symbologies are implemented from published descriptions of the
506
- formats and from original Sythos data structures; MicroPDF417 normative/public values carry
507
- provenance and pending legal review in `NOTICE.md`. The distributed package has no runtime
508
- third-party licence or co-author attribution.
509
-
510
- **Trademark is not licence.** QR Code® is a registered trademark of DENSO WAVE; Aztec Code,
511
- MaxiCode and GS1 DataBar are likewise marks of their owners. A trademark does not restrict
512
- implementing a symbology, but it does constrain branding which is why this package is named
513
- descriptively rather than after any mark.
514
-
579
+ formats and from original Sythos data structures; MicroPDF417, Micro QR, rMQR and the Sythos
580
+ Canvas QR profile carry provenance and pending legal review in `NOTICE.md`. Independent
581
+ implementations and public technical material may be consulted for engineering review or
582
+ black-box verification; no third-party source code is copied or shipped. The distributed package has no runtime third-party
583
+ dependencies. See [`NOTICE.md`](NOTICE.md) and the per-format files in [`licenses/`](licenses/).
584
+
585
+ Public DENSO FrameQR material was consulted only to document the compatibility boundary. ZXing
586
+ was used only as an independent black-box validation tool; no ZXing source code or tables are
587
+ copied or shipped. The Sythos Canvas QR profile does not claim native DENSO FrameQR
588
+ interoperability.
589
+ licence or co-author attribution.
590
+
591
+ **Trademark is not licence.** QR Code® is a registered trademark of DENSO WAVE; Aztec Code,
592
+ MaxiCode and GS1 DataBar are likewise marks of their owners. A trademark does not restrict
593
+ implementing a symbology, but it does constrain branding — which is why this package is named
594
+ descriptively rather than after any mark.
595
+
515
596
  Data Matrix ECC 200 is governed by ISO/IEC 16022:2024; GS1 DataMatrix additionally uses the GS1
516
597
  General Specifications and a leading FNC1. Its engineering provenance, patent and trademark
517
598
  research notes are recorded in [`licenses/data-matrix.license`](licenses/data-matrix.license),
@@ -521,22 +602,26 @@ PDF417 and MicroPDF417 provenance and legal review notes are recorded in
521
602
  [`licenses/pdf417.license`](licenses/pdf417.license),
522
603
  [`licenses/micropdf417.license`](licenses/micropdf417.license) and the attribution log in
523
604
  [`NOTICE.md`](NOTICE.md).
524
-
525
- [`LICENSE`](LICENSE) carries the full MIT text plus an informational appendix inventorying the
526
- specification copyrights, patent history and trademarks that surround these symbologies. None of
605
+
606
+ Micro QR and rMQR provenance and scoped legal-review notes are recorded in
607
+ [`licenses/micro-qr.license`](licenses/micro-qr.license),
608
+ [`licenses/rmqr.license`](licenses/rmqr.license) and [`NOTICE.md`](NOTICE.md).
609
+
610
+ [`LICENSE`](LICENSE) carries the full MIT text plus an informational appendix inventorying the
611
+ specification copyrights, patent history and trademarks that surround these symbologies. None of
527
612
  them is resolved by this file; the appendix is an engineering inventory, not legal advice.
528
- [`NOTICE.md`](NOTICE.md) records the origin of the code and how its correctness is verified.
529
-
530
- ---
531
-
613
+ [`NOTICE.md`](NOTICE.md) records the origin of the code and how its correctness is verified.
614
+
615
+ ---
616
+
532
617
  ## Contributing and roadmap
533
618
 
534
619
  [`PLAN.md`](PLAN.md) is the live status document: what is shipped, what is next, and the ground
535
620
  rules — chief among them that no third-party source code is copied into or shipped by this
536
621
  project, while public or normative values remain provenance-tracked and subject to legal review.
537
-
538
- Issues and pull requests are welcome at
539
- [Sythos/JS_Barcode_Universal](https://github.com/Sythos/JS_Barcode_Universal). A patch that adds a
540
- symbology should implement it from the published description of the format, generate its tables
541
- where they are derivable, and come with a symbol that a scanner this project did not write has
542
- actually read — that last one is the check that matters.
622
+
623
+ Issues and pull requests are welcome at
624
+ [Sythos/JS_Barcode_Universal](https://github.com/Sythos/JS_Barcode_Universal). A patch that adds a
625
+ symbology should implement it from the published description of the format, generate its tables
626
+ where they are derivable, and come with a symbol that a scanner this project did not write has
627
+ actually read — that last one is the check that matters.