qr-kit 2.2.0 → 2.2.2

package/CHANGELOG.md

@@ -7,6 +7,57 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ---
 
+## [2.2.2] - 2025-02-22
+
+### Fixed
+- **Logo overlay reliability**: Reduced default `LOGO_MAX_COVERAGE_ECC_M` from 11% to 6% to ensure better scan reliability with ECC M. Empirical testing showed that 11% could sometimes interfere with decoding, while 6% provides a safe margin. Users can still override `maxCoverage` if a larger logo is required.
+- Updated documentation to reflect the new recommended coverage values.
+
+---
+
+## [2.2.2] - 2025-02-22
+
+### Fixed
+- **Badges on readme**: Fix badges
+
+---
+
+[2.2.0] - 2025-02-21
+Added
+functionMask in QR model: now every QR code generated by makeQr includes a flat Uint8Array functionMask indicating functional modules (finder, timing, alignment, format/version). This enables advanced styling and custom renderers.
+
+isFunctionModule helper: check whether a given module is functional (model.functionMask[y * model.size + x] === 1).
+
+Branded rendering: makeQrSvgString now accepts an optional fnColor parameter to style functional modules separately from data modules. The new makeQrPathSplit function splits the SVG path into data and function parts.
+
+Playground: added a live demo with Basic, Rounded and Branded modes, Link Builder, PDF export, and download options (SVG, PNG, JPEG).
+
+Fixed
+Critical module placement bug: corrected placeFunctionPatterns and setReserve to properly reserve separators, format areas, and version information. Previously, data could be written into reserved areas, making QR codes unreadable. Now all QR codes are fully compliant and scan reliably.
+
+Golden tests: updated snapshots to reflect the correct output; all 109 tests pass.
+
+TypeScript declarations: added missing @types/react dependency to CI to fix namespace errors during type checking.
+
+Changed
+Internal performance: optimised mask application and penalty score calculation; refactored helpers to work efficiently with flat Uint8Array.
+
+Documentation: updated README with examples for branded rendering and clarified API usage.
+
+Deprecated
+Nothing deprecated in this release.
+
+Removed
+Nothing removed.
+
+Security
+No security changes.
+
+⚠️ Experimental Feature
+Logo overlay (utils/logo.js) is still under development and may not produce reliably scannable QR codes. It is not recommended for production use until further notice. The API may change in future releases.
+
+---
+
 ## [2.1.0] — Logo overlay, Web Worker, AbortSignal
 
 ### Added

package/README.md

@@ -7,7 +7,7 @@
 [![npm version](https://img.shields.io/npm/v/qr-kit?color=success)](https://www.npmjs.com/package/qr-kit)
 [![bundle size](https://img.shields.io/bundlephobia/minzip/qr-kit?label=gzip&color=success)](https://bundlephobia.com/package/qr-kit)
 [![tests](https://img.shields.io/badge/tests-109%20passing-success)](tests/)
-[![license](https://img.shields.io/npm/l/qr-kit)](LICENSE)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Yaroslav3991/qr-kit/blob/main/LICENSE)
 
 **[🛝 Live Playground](playground/index.html)** · **[📖 Docs](#installation)** · **[🎨 Examples](#quick-start)**
 
@@ -66,7 +66,7 @@ import { buildQrWithLogoSvgAsync } from 'qr-kit/utils/logo';
 const model = makeQr('https://example.com', { eccLevel: 'M' });
 const svg = await buildQrWithLogoSvgAsync(model, '/logo.svg', {
   size: 400,
-  maxCoverage: 0.11, // 11% of QR area — safe for ECC M
+  maxCoverage: 0.06, // 6% of QR area — recommended for reliable scanning with ECC M
 });
 
 document.body.innerHTML = svg; // self-contained SVG string

package/package.json

@@ -1,71 +1,71 @@
-{
-  "name": "qr-kit",
-  "version": "2.2.0",
-  "description": "Complete QR code toolkit. Zero dependencies. Logo overlay, PDF export, link optimizer. 5.4 kB core.",
-  "type": "module",
-  "main": "index.js",
-  "module": "index.js",
-  "types": "types/index.d.ts",
-  "exports": {
-    ".": "./index.js",
-    "./qr/qr-core": "./qr/qr-core.js",
-    "./utils/layout": "./utils/layout.js",
-    "./utils/url": "./utils/url.js",
-    "./utils/link": "./utils/link.js",
-    "./utils/logo": "./utils/logo.js",
-    "./renderers/svg": "./renderers/svg.js",
-    "./renderers/canvas": "./renderers/canvas.js",
-    "./utils/raster": "./utils/raster.js",
-    "./utils/jpegQr": "./utils/jpegQr.js",
-    "./utils/poster": "./utils/poster.js",
-    "./utils/pdf": "./utils/pdf.js",
-    "./worker/qr.worker": "./worker/qr.worker.js"
-  },
-  "scripts": {
-    "test": "node tests/run.js",
-    "test:watch": "node --watch tests/run.js",
-    "size": "node scripts/size.js"
-  },
-  "sideEffects": false,
-  "keywords": [
-    "qr",
-    "qrcode",
-    "qr-code",
-    "generator",
-    "zero-dependencies",
-    "logo",
-    "pdf",
-    "svg",
-    "react",
-    "typescript",
-    "browser",
-    "nodejs"
-  ],
-  "peerDependencies": {
-    "react": ">=17"
-  },
-  "peerDependenciesMeta": {
-    "react": {
-      "optional": true
-    }
-  },
-  "files": [
-    "index.js",
-    "qr/",
-    "components/",
-    "renderers/",
-    "utils/",
-    "worker/",
-    "types/",
-    "CHANGELOG.md"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Yaroslav3991/qr-kit.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Yaroslav3991/qr-kit/issues"
-  },
-  "homepage": "https://github.com/Yaroslav3991/qr-kit#readme"
-}
+{
+  "name": "qr-kit",
+  "version": "2.2.2",
+  "description": "Complete QR code toolkit. Zero dependencies. Logo overlay, PDF export, link optimizer. 5.4 kB core.",
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": "./index.js",
+    "./qr/qr-core": "./qr/qr-core.js",
+    "./utils/layout": "./utils/layout.js",
+    "./utils/url": "./utils/url.js",
+    "./utils/link": "./utils/link.js",
+    "./utils/logo": "./utils/logo.js",
+    "./renderers/svg": "./renderers/svg.js",
+    "./renderers/canvas": "./renderers/canvas.js",
+    "./utils/raster": "./utils/raster.js",
+    "./utils/jpegQr": "./utils/jpegQr.js",
+    "./utils/poster": "./utils/poster.js",
+    "./utils/pdf": "./utils/pdf.js",
+    "./worker/qr.worker": "./worker/qr.worker.js"
+  },
+  "scripts": {
+    "test": "node tests/run.js",
+    "test:watch": "node --watch tests/run.js",
+    "size": "node scripts/size.js"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "qr",
+    "qrcode",
+    "qr-code",
+    "generator",
+    "zero-dependencies",
+    "logo",
+    "pdf",
+    "svg",
+    "react",
+    "typescript",
+    "browser",
+    "nodejs"
+  ],
+  "peerDependencies": {
+    "react": ">=17"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "files": [
+    "index.js",
+    "qr/",
+    "components/",
+    "renderers/",
+    "utils/",
+    "worker/",
+    "types/",
+    "CHANGELOG.md"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Yaroslav3991/qr-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Yaroslav3991/qr-kit/issues"
+  },
+  "homepage": "https://github.com/Yaroslav3991/qr-kit#readme"
+}

package/utils/logo.js

@@ -26,7 +26,7 @@ import { makeQrPathSplit } from '../renderers/svg.js';
 // ─── Public constants ──────────────────────────────────────────────────────────
 
 /** Maximum fraction of QR area safe to cover with ECC M (~15% budget, 4% safety margin). */
-export const LOGO_MAX_COVERAGE_ECC_M = 0.11;
+export const LOGO_MAX_COVERAGE_ECC_M = 0.06;
 
 /** Maximum fraction of QR area safe to cover with ECC L (~7% budget, 3% safety margin). */
 export const LOGO_MAX_COVERAGE_ECC_L = 0.04;