qr 0.4.2 → 0.5.0

package/README.md

@@ -6,7 +6,7 @@ Minimal 0-dep QR code generator & reader.
 - 🏞️ Encoding (generating) supports ASCII, term, gif and svg codes
 - 📷 Decoding (reading) supports camera feed input, files and non-browser environments
 - 🔍 Extensive tests ensure correctness: 100MB+ of vectors
-- 🪶 35KB for encoding + decoding, 18KB for encoding (1000 lines of code)
+- 🪶 14KB (gzipped) for encoding + decoding, 7KB for encoding
 
 Check out:
 
@@ -43,7 +43,7 @@ A standalone file [qr.js](https://github.com/paulmillr/qr/releases) is also avai
 ```ts
 import encodeQR from 'qr';
 
-// import decodeQR from 'qr/decode';
+// import decodeQR from 'qr/decode.js';
 // See separate README section for decoding.
 
 const txt = 'Hello world';
@@ -100,7 +100,7 @@ Decoding raw bitmap is still possible.
 
 ```js
 import encodeQR from 'qr';
-import decodeQR from 'qr/decode';
+import decodeQR from 'qr/decode.js';
 import { Bitmap } from 'qr';
 
 // Scale so it would be 100x100 instead of 25x25
@@ -136,7 +136,7 @@ function decodeWithExternal() {
 }
 
 // c) draw gif/svg to browser DOM canvas
-import { svgToPng } from 'qr/dom';
+import { svgToPng } from 'qr/dom.js';
 const png = svgToPng(encodeQR('Hello world', 'svg'), 512, 512);
 ```
 
@@ -196,7 +196,7 @@ Check out `dom.ts` for browser-related camera code that would make your apps sim
 ## Using with Kotlin
 
 ```kotlin
-@JsModule("@paulmillr/qr")
+@JsModule("qr")
 @JsNonModule
 external object Qr {
     @JsName("default")
@@ -238,23 +238,22 @@ Benchmarks measured with Apple M2 on MacOS 13 with node.js 19.
 
 ```
 ======== encode/ascii ========
-encode/paulmillr-qr x 1,794 ops/sec @ 557μs/op
-encode/qrcode-generator x 3,128 ops/sec @ 319μs/op ± 1.12% (min: 293μs, max: 3ms)
-encode/nuintun x 1,872 ops/sec @ 533μs/op
+encode/paulmillr x 2,995 ops/sec @ 333μs/op
+encode/qrcode-generator x 6,029 ops/sec @ 165μs/op ± 1.39% (min: 142μs, max: 2ms)
+encode/nuintun x 3,647 ops/sec @ 274μs/op
 ======== encode/gif ========
-encode/paulmillr-qr x 1,771 ops/sec @ 564μs/op
-encode/qrcode-generator x 1,773 ops/sec @ 563μs/op
-encode/nuintun x 1,883 ops/sec @ 530μs/op
+encode/paulmillr x 2,967 ops/sec @ 337μs/op
+encode/qrcode-generator x 3,486 ops/sec @ 286μs/op
+encode/nuintun x 3,643 ops/sec @ 274μs/op
 ======== encode: big ========
-encode/paulmillr-qr x 87 ops/sec @ 11ms/op
-encode/qrcode-generator x 124 ops/sec @ 8ms/op
-encode/nuintun x 143 ops/sec @ 6ms/op
+encode/paulmillr x 156 ops/sec @ 6ms/op
+encode/qrcode-generator x 200 ops/sec @ 4ms/op
+encode/nuintun x 223 ops/sec @ 4ms/op
 ======== decode ========
-decode/paulmillr-qr x 96 ops/sec @ 10ms/op ± 1.39% (min: 9ms, max: 32ms)
-decode/jsqr x 34 ops/sec @ 28ms/op
-decode/nuintun x 35 ops/sec @ 28ms/op
-decode/instascan x 79 ops/sec @ 12ms/op ± 6.73% (min: 9ms, max: 223ms)
-======== Decoding quality ========
+decode/paulmillr x 154 ops/sec @ 6ms/op ± 1.29% (min: 6ms, max: 18ms)
+decode/jsqr x 52 ops/sec @ 18ms/op
+decode/nuintun x 51 ops/sec @ 19ms/op
+decode/instascan x 158 ops/sec @ 6ms/op ± 9.06% (min: 3ms, max: 144ms)======== Decoding quality ========
 blurred(45):  paulmillr-qr=12 (26.66%) jsqr=13 (28.88%) nuintun=13 (28.88%) instascan=11 (24.44%)
 ```
 

package/decode.js

@@ -1,4 +1,3 @@
-"use strict";
 /*!
 Copyright (c) 2023 Paul Miller (paulmillr.com)
 The library paulmillr-qr is dual-licensed under the Apache 2.0 OR MIT license.
@@ -23,11 +22,8 @@ limitations under the License.
 
 ```
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._tests = void 0;
-exports.decodeQR = decodeQR;
-const index_ts_1 = require("./index.js");
-const { best, bin, drawTemplate, fillArr, info, interleave, validateVersion, zigzag } = index_ts_1.utils;
+import { Bitmap, utils } from "./index.js";
+const { best, bin, drawTemplate, fillArr, info, interleave, validateVersion, zigzag } = utils;
 // Constants
 const MAX_BITS_ERROR = 3; // Up to 3 bit errors in version/format
 const GRAYSCALE_BLOCK_SIZE = 8;
@@ -115,7 +111,7 @@ function toBitmap(img) {
             blocks[bWidth * y + x] = int(average);
         }
     }
-    const matrix = new index_ts_1.Bitmap({ width: img.width, height: img.height });
+    const matrix = new Bitmap({ width: img.width, height: img.height });
     for (let y = 0; y < bHeight; y++) {
         const yPos = cap(y * block, 0, maxY);
         const top = cap(y, 2, bHeight - 3);
@@ -660,7 +656,7 @@ function transform(b, size, from, to) {
     ];
     const sToQ = squareToQuadrilateral(from);
     const transform = sToQ.map((i) => i.map((_, qx) => i.reduce((acc, v, j) => acc + v * qToS[j][qx], 0)));
-    const res = new index_ts_1.Bitmap(size);
+    const res = new Bitmap(size);
     const points = fillArr(2 * size, 0);
     const pointsLength = points.length;
     for (let y = 0; y < size; y++) {
@@ -886,7 +882,7 @@ function cropToSquare(img) {
     }
     return { offset, img: { height: squareSize, width: squareSize, data: croppedData } };
 }
-function decodeQR(img, opts = {}) {
+export function decodeQR(img, opts = {}) {
     for (const field of ['height', 'width']) {
         if (!Number.isSafeInteger(img[field]) || img[field] <= 0)
             throw new Error(`invalid img.${field}=${img[field]} (${typeof img[field]})`);
@@ -919,9 +915,9 @@ function decodeQR(img, opts = {}) {
         opts.imageOnResult(bits.toImage());
     return res;
 }
-exports.default = decodeQR;
+export default decodeQR;
 // Unsafe API utils, exported only for tests
-exports._tests = {
+export const _tests = {
     toBitmap,
     decodeBitmap,
     findFinder,

package/dom.js

@@ -1,4 +1,3 @@
-"use strict";
 /*!
 Copyright (c) 2023 Paul Miller (paulmillr.com)
 The library paulmillr-qr is dual-licensed under the Apache 2.0 OR MIT license.
@@ -23,19 +22,13 @@ limitations under the License.
  * The code is fragile: it is easy to make subtle errors, which will break decoding.
  * @module
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QRCanvas = exports.getSize = void 0;
-exports.frontalCamera = frontalCamera;
-exports.frameLoop = frameLoop;
-exports.svgToPng = svgToPng;
-const decode_ts_1 = require("./decode.js");
-const getSize = (elm) => {
+import decodeQR, {} from "./decode.js";
+export const getSize = (elm) => {
     const css = getComputedStyle(elm);
     const width = Math.floor(+css.width.split('px')[0]);
     const height = Math.floor(+css.height.split('px')[0]);
     return { width, height };
 };
-exports.getSize = getSize;
 const setCanvasSize = (canvas, height, width) => {
     // NOTE: setting canvas.width even to same size will clear & redraw it (flickering)
     if (canvas.height !== height)
@@ -55,9 +48,14 @@ const clearCanvas = ({ canvas, context }) => {
 /**
  * Handles canvases for QR code decoding
  */
-class QRCanvas {
+export class QRCanvas {
+    opts;
+    lastDetect = 0;
+    main;
+    overlay;
+    bitmap;
+    resultQR;
     constructor({ overlay, bitmap, resultQR } = {}, opts = {}) {
-        this.lastDetect = 0;
         this.opts = {
             resultBlockSize: 8,
             overlayMainColor: 'green',
@@ -171,7 +169,7 @@ class QRCanvas {
         if (this.resultQR)
             options.imageOnResult = (img) => this.drawResultQr(img);
         try {
-            const res = (0, decode_ts_1.default)(data, options);
+            const res = decodeQR(data, options);
             this.lastDetect = Date.now();
             return res;
         }
@@ -191,8 +189,9 @@ class QRCanvas {
             clearCanvas(this.resultQR);
     }
 }
-exports.QRCanvas = QRCanvas;
 class QRCamera {
+    stream;
+    player;
     constructor(stream, player) {
         this.stream = stream;
         this.player = player;
@@ -236,7 +235,7 @@ class QRCamera {
         const { player } = this;
         if (fullSize)
             return canvas.drawImage(player, player.videoHeight, player.videoWidth);
-        const size = (0, exports.getSize)(player);
+        const size = getSize(player);
         return canvas.drawImage(player, size.height, size.width);
     }
     stop() {
@@ -254,7 +253,7 @@ class QRCamera {
  * await camera.setDevice(devices[0].deviceId); // Change camera
  * const res = camera.readFrame(canvas);
  */
-async function frontalCamera(player) {
+export async function frontalCamera(player) {
     const stream = await navigator.mediaDevices.getUserMedia({
         video: {
             // Ask for screen resolution
@@ -274,7 +273,7 @@ async function frontalCamera(player) {
  * const cancel = frameLoop((ns) => console.log(ns));
  * cancel();
  */
-function frameLoop(cb) {
+export function frameLoop(cb) {
     let handle = undefined;
     function loop(ts) {
         cb(ts);
@@ -288,7 +287,7 @@ function frameLoop(cb) {
         handle = undefined;
     };
 }
-function svgToPng(svgData, width, height) {
+export function svgToPng(svgData, width, height) {
     return new Promise((resolve, reject) => {
         if (!(Number.isSafeInteger(width) &&
             Number.isSafeInteger(height) &&

package/index.js

@@ -1,4 +1,3 @@
-"use strict";
 /*!
 Copyright (c) 2023 Paul Miller (paulmillr.com)
 The library paulmillr-qr is dual-licensed under the Apache 2.0 OR MIT license.
@@ -15,24 +14,20 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._tests = exports.utils = exports.Encoding = exports.ECMode = exports.Bitmap = void 0;
-exports.utf8ToBytes = utf8ToBytes;
-exports.encodeQR = encodeQR;
 /**
  * Methods for encoding (generating) QR code patterns.
  * Check out decode.ts for decoding (reading).
  * @module
  * @example
 ```js
-import encodeQR from '@paulmillr/qr';
+import encodeQR from 'qr';
 const txt = 'Hello world';
 const ascii = encodeQR(txt, 'ascii'); // Not all fonts are supported
 const terminalFriendly = encodeQR(txt, 'term'); // 2x larger, all fonts are OK
 const gifBytes = encodeQR(txt, 'gif'); // Uncompressed GIF
 const svgElement = encodeQR(txt, 'svg'); // SVG vector image element
 const array = encodeQR(txt, 'raw'); // 2d array for canvas or other libs
-// import decodeQR from '@paulmillr/qr/decode';
+// import decodeQR from 'qr/decode.js';
 ```
  */
 // We do not use newline escape code directly in strings because it's not parser-friendly
@@ -125,7 +120,7 @@ function alphabet(alphabet) {
         },
     };
 }
-class Bitmap {
+export class Bitmap {
     static size(size, limit) {
         if (typeof size === 'number')
             size = { height: size, width: size };
@@ -168,6 +163,9 @@ class Bitmap {
             width = 0;
         return new Bitmap({ height, width }, data);
     }
+    data;
+    height;
+    width;
     constructor(size, data) {
         const { height, width } = Bitmap.size(size);
         this.data = data || Array.from({ length: height }, () => fillArr(width, undefined));
@@ -385,13 +383,12 @@ class Bitmap {
         return { height, width, data };
     }
 }
-exports.Bitmap = Bitmap;
 // End of utils
 // Runtime type-checking
 /** Error correction mode. low: 7%, medium: 15%, quartile: 25%, high: 30% */
-exports.ECMode = ['low', 'medium', 'quartile', 'high'];
+export const ECMode = ['low', 'medium', 'quartile', 'high'];
 /** QR Code encoding */
-exports.Encoding = ['numeric', 'alphanumeric', 'byte', 'kanji', 'eci'];
+export const Encoding = ['numeric', 'alphanumeric', 'byte', 'kanji', 'eci'];
 // Various constants & tables
 // prettier-ignore
 const BYTES = [
@@ -886,7 +883,7 @@ function detectType(str) {
 /**
  * @example utf8ToBytes('abc') // new Uint8Array([97, 98, 99])
  */
-function utf8ToBytes(str) {
+export function utf8ToBytes(str) {
     if (typeof str !== 'string')
         throw new Error(`utf8ToBytes expected string, got ${typeof str}`);
     return new Uint8Array(new TextEncoder().encode(str)); // https://bugzil.la/1681809
@@ -1036,12 +1033,12 @@ function drawQRBest(ver, ecc, data, maskIdx) {
     return drawQR(ver, ecc, data, maskIdx);
 }
 function validateECC(ec) {
-    if (!exports.ECMode.includes(ec))
-        throw new Error(`Invalid error correction mode=${ec}. Expected: ${exports.ECMode}`);
+    if (!ECMode.includes(ec))
+        throw new Error(`Invalid error correction mode=${ec}. Expected: ${ECMode}`);
 }
 function validateEncoding(enc) {
-    if (!exports.Encoding.includes(enc))
-        throw new Error(`Encoding: invalid mode=${enc}. Expected: ${exports.Encoding}`);
+    if (!Encoding.includes(enc))
+        throw new Error(`Encoding: invalid mode=${enc}. Expected: ${Encoding}`);
     if (enc === 'kanji' || enc === 'eci')
         throw new Error(`Encoding: ${enc} is not supported (yet?).`);
 }
@@ -1049,7 +1046,7 @@ function validateMask(mask) {
     if (![0, 1, 2, 3, 4, 5, 6, 7].includes(mask) || !PATTERNS[mask])
         throw new Error(`Invalid mask=${mask}. Expected number [0..7]`);
 }
-function encodeQR(text, output = 'raw', opts = {}) {
+export function encodeQR(text, output = 'raw', opts = {}) {
     const ecc = opts.ecc !== undefined ? opts.ecc : 'medium';
     validateECC(ecc);
     const encoding = opts.encoding !== undefined ? opts.encoding : detectType(text);
@@ -1099,8 +1096,8 @@ function encodeQR(text, output = 'raw', opts = {}) {
     else
         throw new Error(`Unknown output: ${output}`);
 }
-exports.default = encodeQR;
-exports.utils = {
+export default encodeQR;
+export const utils = {
     best,
     bin,
     drawTemplate,
@@ -1111,7 +1108,7 @@ exports.utils = {
     zigzag,
 };
 // Unsafe API utils, exported only for tests
-exports._tests = {
+export const _tests = {
     Bitmap,
     info,
     detectType,

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "qr",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Minimal 0-dep QR code generator & reader. Supports ascii, term, gif and svg formats",
   "files": [
-    "esm",
     "index.js",
     "index.d.ts",
     "index.d.ts.map",
@@ -16,17 +15,16 @@
     "dom.d.ts",
     "dom.d.ts.map",
     "dom.ts",
+    "src",
     "LICENSE",
     "LICENSE-MIT"
   ],
-  "main": "index.js",
-  "module": "index.js",
-  "types": "index.d.ts",
   "sideEffects": false,
   "devDependencies": {
-    "@paulmillr/jsbt": "0.3.3",
+    "@paulmillr/jsbt": "0.4.1",
+    "@types/node": "22.15.23",
     "micro-bmark": "0.4.1",
-    "micro-should": "0.5.2",
+    "micro-should": "0.5.3",
     "prettier": "3.5.3",
     "typescript": "5.8.3"
   },
@@ -37,28 +35,23 @@
     "type": "git",
     "url": "git+https://github.com/paulmillr/qr.git"
   },
+  "engines": {
+    "node": ">= 20.19.0"
+  },
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "build": "tsc",
     "build:release": "npx jsbt esbuild test/build",
+    "bench": "cd test/benchmark && npm ci && node index.ts",
     "lint": "prettier --check src",
     "format": "prettier --write src",
-    "test": "cd test; npm ci; node index.js",
-    "test:bun": "cd test; bun install; bun index.js",
-    "test:deno": "cd test; npm install; deno --allow-env --allow-read index.js"
-  },
-  "exports": {
-    ".": {
-      "import": "./esm/index.js",
-      "require": "./index.js"
-    },
-    "./decode.js": {
-      "import": "./esm/decode.js",
-      "require": "./decode.js"
-    },
-    "./dom.js": {
-      "import": "./esm/dom.js",
-      "require": "./dom.js"
-    }
+    "test": "cd test; npm ci; node --experimental-strip-types --no-warnings index.ts",
+    "test:bun": "cd test; bun install; bun index.ts",
+    "test:deno": "cd test; npm install; deno --allow-env --allow-read index.ts",
+    "test:node20": "cd test; npx tsc; cd compiled/test; npm install; node index.js"
   },
   "keywords": [
     "qr",