uqr 0.0.3 → 0.1.0

package/README.md

@@ -1,8 +1,14 @@
 # uqr
 
-[![NPM version](https://img.shields.io/npm/v/uqr?color=a1b858&label=)](https://www.npmjs.com/package/uqr)
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![License][license-src]][license-href]
+[![JSDocs][jsdocs-src]][jsdocs-href]
 
-Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.
+<!-- [![Codecov][codecov-src]][codecov-href] -->
+
+Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG. ES module , zero dependency, tree-shakable.
 
 ## Install
 
@@ -114,3 +120,19 @@ CLI renders are inspired by [qrcode-terminal](https://github.com/gtanner/qrcode-
 ## License
 
 [MIT](./LICENSE) License
+
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/uqr?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-href]: https://npmjs.com/package/uqr
+[npm-downloads-src]: https://img.shields.io/npm/dm/uqr?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-downloads-href]: https://npmjs.com/package/uqr
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/uqr/main?style=flat&colorA=18181B&colorB=F0DB4F
+[codecov-href]: https://codecov.io/gh/unjs/uqr
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/uqr?style=flat&colorA=18181B&colorB=F0DB4F
+[bundle-href]: https://bundlephobia.com/result?p=uqr
+[license-src]: https://img.shields.io/github/license/unjs/uqr.svg?style=flat&colorA=18181B&colorB=F0DB4F
+[license-href]: https://github.com/unjs/uqr/blob/main/LICENSE
+[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=F0DB4F
+[jsdocs-href]: https://www.jsdocs.io/package/uqr

package/dist/index.cjs

@@ -613,12 +613,13 @@ function encode(data, options) {
   }, border);
   if (options?.invert)
     result.data = result.data.map((row) => row.map((mod) => !mod));
+  options?.onEncoded?.(result);
   return result;
 }
 function addBorder(input, border = 1) {
   if (!border)
     return input;
-  const { size, data } = input;
+  const { size } = input;
   const newSize = size + border * 2;
   input.size = newSize;
   input.data.forEach((row) => {
@@ -700,21 +701,24 @@ function renderUnicodeCompact(data, options = {}) {
 function renderSVG(data, options = {}) {
   const result = encode(data, options);
   const {
-    pixelSize = 5,
+    pixelSize = 10,
     whiteColor = "white",
     blackColor = "black"
   } = options;
   const height = result.size * pixelSize;
   const width = result.size * pixelSize;
-  let svg = `<svg xmlns="http://www.w3.org/2000/svg" height="${height}" width="${width}">`;
+  let svg = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${width} ${height}">`;
+  const pathes = [];
   for (let row = 0; row < result.size; row++) {
     for (let col = 0; col < result.size; col++) {
       const x = col * pixelSize;
       const y = row * pixelSize;
-      const fillColor = result.data[row][col] ? blackColor : whiteColor;
-      svg += `<rect x="${x}" y="${y}" width="${pixelSize}" height="${pixelSize}" fill="${fillColor}"/>`;
+      if (result.data[row][col])
+        pathes.push(`M${x},${y}h${pixelSize}v${pixelSize}h-${pixelSize}z`);
     }
   }
+  svg += `<rect fill="${whiteColor}" width="${width}" height="${height}"/>`;
+  svg += `<path fill="${blackColor}" d="${pathes.join("")}"/>`;
   svg += "</svg>";
   return svg;
 }

package/dist/index.d.ts

@@ -44,6 +44,10 @@ interface QrCodeGenerateOptions {
      * Invert black and white
      */
     invert?: boolean;
+    /**
+     * Callback function to receive the generated QR Code
+     */
+    onEncoded?: (qr: QrCodeGenerateResult) => void;
 }
 declare enum QrCodeDataType {
     Border = -1,
@@ -88,7 +92,7 @@ interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
     /**
      * Size of each pixel
      *
-     * @default 5
+     * @default 20
      */
     pixelSize?: number;
     /**

package/dist/index.mjs

@@ -611,12 +611,13 @@ function encode(data, options) {
   }, border);
   if (options?.invert)
     result.data = result.data.map((row) => row.map((mod) => !mod));
+  options?.onEncoded?.(result);
   return result;
 }
 function addBorder(input, border = 1) {
   if (!border)
     return input;
-  const { size, data } = input;
+  const { size } = input;
   const newSize = size + border * 2;
   input.size = newSize;
   input.data.forEach((row) => {
@@ -698,21 +699,24 @@ function renderUnicodeCompact(data, options = {}) {
 function renderSVG(data, options = {}) {
   const result = encode(data, options);
   const {
-    pixelSize = 5,
+    pixelSize = 10,
     whiteColor = "white",
     blackColor = "black"
   } = options;
   const height = result.size * pixelSize;
   const width = result.size * pixelSize;
-  let svg = `<svg xmlns="http://www.w3.org/2000/svg" height="${height}" width="${width}">`;
+  let svg = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${width} ${height}">`;
+  const pathes = [];
   for (let row = 0; row < result.size; row++) {
     for (let col = 0; col < result.size; col++) {
       const x = col * pixelSize;
       const y = row * pixelSize;
-      const fillColor = result.data[row][col] ? blackColor : whiteColor;
-      svg += `<rect x="${x}" y="${y}" width="${pixelSize}" height="${pixelSize}" fill="${fillColor}"/>`;
+      if (result.data[row][col])
+        pathes.push(`M${x},${y}h${pixelSize}v${pixelSize}h-${pixelSize}z`);
     }
   }
+  svg += `<rect fill="${whiteColor}" width="${width}" height="${height}"/>`;
+  svg += `<path fill="${blackColor}" d="${pathes.join("")}"/>`;
   svg += "</svg>";
   return svg;
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "uqr",
   "type": "module",
-  "version": "0.0.3",
-  "packageManager": "pnpm@8.6.11",
+  "version": "0.1.0",
+  "packageManager": "pnpm@8.6.12",
   "description": "Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -46,21 +46,21 @@
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.40.0",
+    "@antfu/eslint-config": "^0.40.2",
     "@antfu/ni": "^0.21.5",
     "@antfu/utils": "^0.7.5",
-    "@types/node": "^20.4.7",
+    "@types/node": "^20.4.9",
     "bumpp": "^9.1.1",
     "eslint": "^8.46.0",
     "esno": "^0.17.0",
     "lint-staged": "^13.2.3",
-    "pnpm": "^8.6.11",
+    "pnpm": "^8.6.12",
     "rimraf": "^5.0.1",
-    "rollup": "^3.27.2",
+    "rollup": "^3.28.0",
     "simple-git-hooks": "^2.9.0",
     "typescript": "^5.1.6",
     "unbuild": "^1.2.1",
-    "vite": "^4.4.8",
+    "vite": "^4.4.9",
     "vitest": "^0.34.1"
   },
   "simple-git-hooks": {