uqr 0.0.2 → 0.0.4

package/dist/index.cjs

@@ -59,9 +59,9 @@ class QrCode {
   // error correction level, data codeword bytes, and mask number.
   // This is a low-level API that most users should not use directly.
   // A mid-level API is the encodeSegments() function.
-  constructor(version, errorCorrectionLevel, dataCodewords, msk) {
+  constructor(version, ecc, dataCodewords, msk) {
     this.version = version;
-    this.errorCorrectionLevel = errorCorrectionLevel;
+    this.ecc = ecc;
     // The modules of this QR Code (false = light, true = dark).
     // Immutable after constructor finishes. Accessed through getModule().
     this.modules = [];
@@ -92,7 +92,6 @@ class QrCode {
         this.applyMask(i);
       }
     }
-    assert(msk >= 0 && msk <= 7);
     this.mask = msk;
     this.applyMask(msk);
     this.drawFormatBits(msk);
@@ -128,12 +127,11 @@ class QrCode {
   // Draws two copies of the format bits (with its own error correction code)
   // based on the given mask and this object's error correction level field.
   drawFormatBits(mask) {
-    const data = this.errorCorrectionLevel[1] << 3 | mask;
+    const data = this.ecc[1] << 3 | mask;
     let rem = data;
     for (let i = 0; i < 10; i++)
       rem = rem << 1 ^ (rem >>> 9) * 1335;
     const bits = (data << 10 | rem) ^ 21522;
-    assert(bits >>> 15 === 0);
     for (let i = 0; i <= 5; i++)
       this.setFunctionModule(8, i, getBit(bits, i));
     this.setFunctionModule(8, 7, getBit(bits, 6));
@@ -156,7 +154,6 @@ class QrCode {
     for (let i = 0; i < 12; i++)
       rem = rem << 1 ^ (rem >>> 11) * 7973;
     const bits = this.version << 12 | rem;
-    assert(bits >>> 18 === 0);
     for (let i = 0; i < 18; i++) {
       const color = getBit(bits, i);
       const a = this.size - 11 + i % 3;
@@ -203,7 +200,7 @@ class QrCode {
   // codewords appended to it, based on this object's version and error correction level.
   addEccAndInterleave(data) {
     const ver = this.version;
-    const ecl = this.errorCorrectionLevel;
+    const ecl = this.ecc;
     if (data.length !== getNumDataCodewords(ver, ecl))
       throw new RangeError("Invalid argument");
     const numBlocks = NUM_ERROR_CORRECTION_BLOCKS[ecl[0]][ver];
@@ -228,7 +225,6 @@ class QrCode {
           result.push(block[i]);
       });
     }
-    assert(result.length === rawCodewords);
     return result;
   }
   // Draws the given sequence of 8-bit codewords (data and error correction) onto the entire
@@ -252,7 +248,6 @@ class QrCode {
         }
       }
     }
-    assert(i === data.length * 8);
   }
   // XORs the codeword modules in this QR Code with the given mask pattern.
   // The function modules must be marked and the codeword bits must be drawn
@@ -356,9 +351,7 @@ class QrCode {
       dark = row.reduce((sum, color) => sum + (color ? 1 : 0), dark);
     const total = this.size * this.size;
     const k = Math.ceil(Math.abs(dark * 20 - total * 10) / total) - 1;
-    assert(k >= 0 && k <= 9);
     result += k * PENALTY_N4;
-    assert(result >= 0 && result <= 2568888);
     return result;
   }
   /* -- Private helper functions -- */
@@ -381,7 +374,6 @@ class QrCode {
   // returns either 0, 1, or 2. A helper function for getPenaltyScore().
   finderPenaltyCountPatterns(runHistory) {
     const n = runHistory[1];
-    assert(n <= this.size * 3);
     const core = n > 0 && runHistory[2] === n && runHistory[3] === n * 3 && runHistory[4] === n && runHistory[5] === n;
     return (core && runHistory[0] >= n * 4 && runHistory[6] >= n ? 1 : 0) + (core && runHistory[6] >= n * 4 && runHistory[0] >= n ? 1 : 0);
   }
@@ -412,10 +404,6 @@ function appendBits(val, len, bb) {
 function getBit(x, i) {
   return (x >>> i & 1) !== 0;
 }
-function assert(cond) {
-  if (!cond)
-    throw new Error("Assertion error");
-}
 class QrSegment {
   // Creates a new QR Code segment with the given attributes and data.
   // The character count (numChars) must agree with the mode and the bit buffer length,
@@ -520,7 +508,6 @@ function getNumRawDataModules(ver) {
     if (ver >= 7)
       result -= 36;
   }
-  assert(result >= 208 && result <= 29648);
   return result;
 }
 function getNumDataCodewords(ver, ecl) {
@@ -561,7 +548,6 @@ function reedSolomonMultiply(x, y) {
     z = z << 1 ^ (z >>> 7) * 285;
     z ^= (y >>> i & 1) * x;
   }
-  assert(z >>> 8 === 0);
   return z;
 }
 function encodeSegments(segs, ecl, minVersion = 1, maxVersion = 40, mask = -1, boostEcl = true) {
@@ -590,17 +576,12 @@ function encodeSegments(segs, ecl, minVersion = 1, maxVersion = 40, mask = -1, b
     for (const b of seg.getData())
       bb.push(b);
   }
-  assert(bb.length === dataUsedBits);
   const dataCapacityBits = getNumDataCodewords(version, ecl) * 8;
-  assert(bb.length <= dataCapacityBits);
   appendBits(0, Math.min(4, dataCapacityBits - bb.length), bb);
   appendBits(0, (8 - bb.length % 8) % 8, bb);
-  assert(bb.length % 8 === 0);
   for (let padByte = 236; bb.length < dataCapacityBits; padByte ^= 236 ^ 17)
     appendBits(padByte, 8, bb);
-  const dataCodewords = [];
-  while (dataCodewords.length * 8 < bb.length)
-    dataCodewords.push(0);
+  const dataCodewords = Array.from({ length: Math.ceil(bb.length / 8) }, () => 0);
   bb.forEach((b, i) => dataCodewords[i >>> 3] |= b << 7 - (i & 7));
   return new QrCode(version, ecl, dataCodewords, mask);
 }
@@ -625,18 +606,20 @@ function encode(data, options) {
   );
   const result = addBorder({
     version: qr.version,
+    maskPattern: qr.mask,
     size: qr.size,
     data: qr.modules,
     types: qr.types
   }, 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) => {
@@ -718,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,
@@ -62,6 +66,10 @@ interface QrCodeGenerateResult {
      * Width and height of the QR Code array
      */
     size: number;
+    /**
+     * Mask pattern used
+     */
+    maskPattern: number;
     /**
      * Two dimensional array representing the QR Code
      *
@@ -84,7 +92,7 @@ interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
     /**
      * Size of each pixel
      *
-     * @default 5
+     * @default 20
      */
     pixelSize?: number;
     /**

package/dist/index.mjs

@@ -57,9 +57,9 @@ class QrCode {
   // error correction level, data codeword bytes, and mask number.
   // This is a low-level API that most users should not use directly.
   // A mid-level API is the encodeSegments() function.
-  constructor(version, errorCorrectionLevel, dataCodewords, msk) {
+  constructor(version, ecc, dataCodewords, msk) {
     this.version = version;
-    this.errorCorrectionLevel = errorCorrectionLevel;
+    this.ecc = ecc;
     // The modules of this QR Code (false = light, true = dark).
     // Immutable after constructor finishes. Accessed through getModule().
     this.modules = [];
@@ -90,7 +90,6 @@ class QrCode {
         this.applyMask(i);
       }
     }
-    assert(msk >= 0 && msk <= 7);
     this.mask = msk;
     this.applyMask(msk);
     this.drawFormatBits(msk);
@@ -126,12 +125,11 @@ class QrCode {
   // Draws two copies of the format bits (with its own error correction code)
   // based on the given mask and this object's error correction level field.
   drawFormatBits(mask) {
-    const data = this.errorCorrectionLevel[1] << 3 | mask;
+    const data = this.ecc[1] << 3 | mask;
     let rem = data;
     for (let i = 0; i < 10; i++)
       rem = rem << 1 ^ (rem >>> 9) * 1335;
     const bits = (data << 10 | rem) ^ 21522;
-    assert(bits >>> 15 === 0);
     for (let i = 0; i <= 5; i++)
       this.setFunctionModule(8, i, getBit(bits, i));
     this.setFunctionModule(8, 7, getBit(bits, 6));
@@ -154,7 +152,6 @@ class QrCode {
     for (let i = 0; i < 12; i++)
       rem = rem << 1 ^ (rem >>> 11) * 7973;
     const bits = this.version << 12 | rem;
-    assert(bits >>> 18 === 0);
     for (let i = 0; i < 18; i++) {
       const color = getBit(bits, i);
       const a = this.size - 11 + i % 3;
@@ -201,7 +198,7 @@ class QrCode {
   // codewords appended to it, based on this object's version and error correction level.
   addEccAndInterleave(data) {
     const ver = this.version;
-    const ecl = this.errorCorrectionLevel;
+    const ecl = this.ecc;
     if (data.length !== getNumDataCodewords(ver, ecl))
       throw new RangeError("Invalid argument");
     const numBlocks = NUM_ERROR_CORRECTION_BLOCKS[ecl[0]][ver];
@@ -226,7 +223,6 @@ class QrCode {
           result.push(block[i]);
       });
     }
-    assert(result.length === rawCodewords);
     return result;
   }
   // Draws the given sequence of 8-bit codewords (data and error correction) onto the entire
@@ -250,7 +246,6 @@ class QrCode {
         }
       }
     }
-    assert(i === data.length * 8);
   }
   // XORs the codeword modules in this QR Code with the given mask pattern.
   // The function modules must be marked and the codeword bits must be drawn
@@ -354,9 +349,7 @@ class QrCode {
       dark = row.reduce((sum, color) => sum + (color ? 1 : 0), dark);
     const total = this.size * this.size;
     const k = Math.ceil(Math.abs(dark * 20 - total * 10) / total) - 1;
-    assert(k >= 0 && k <= 9);
     result += k * PENALTY_N4;
-    assert(result >= 0 && result <= 2568888);
     return result;
   }
   /* -- Private helper functions -- */
@@ -379,7 +372,6 @@ class QrCode {
   // returns either 0, 1, or 2. A helper function for getPenaltyScore().
   finderPenaltyCountPatterns(runHistory) {
     const n = runHistory[1];
-    assert(n <= this.size * 3);
     const core = n > 0 && runHistory[2] === n && runHistory[3] === n * 3 && runHistory[4] === n && runHistory[5] === n;
     return (core && runHistory[0] >= n * 4 && runHistory[6] >= n ? 1 : 0) + (core && runHistory[6] >= n * 4 && runHistory[0] >= n ? 1 : 0);
   }
@@ -410,10 +402,6 @@ function appendBits(val, len, bb) {
 function getBit(x, i) {
   return (x >>> i & 1) !== 0;
 }
-function assert(cond) {
-  if (!cond)
-    throw new Error("Assertion error");
-}
 class QrSegment {
   // Creates a new QR Code segment with the given attributes and data.
   // The character count (numChars) must agree with the mode and the bit buffer length,
@@ -518,7 +506,6 @@ function getNumRawDataModules(ver) {
     if (ver >= 7)
       result -= 36;
   }
-  assert(result >= 208 && result <= 29648);
   return result;
 }
 function getNumDataCodewords(ver, ecl) {
@@ -559,7 +546,6 @@ function reedSolomonMultiply(x, y) {
     z = z << 1 ^ (z >>> 7) * 285;
     z ^= (y >>> i & 1) * x;
   }
-  assert(z >>> 8 === 0);
   return z;
 }
 function encodeSegments(segs, ecl, minVersion = 1, maxVersion = 40, mask = -1, boostEcl = true) {
@@ -588,17 +574,12 @@ function encodeSegments(segs, ecl, minVersion = 1, maxVersion = 40, mask = -1, b
     for (const b of seg.getData())
       bb.push(b);
   }
-  assert(bb.length === dataUsedBits);
   const dataCapacityBits = getNumDataCodewords(version, ecl) * 8;
-  assert(bb.length <= dataCapacityBits);
   appendBits(0, Math.min(4, dataCapacityBits - bb.length), bb);
   appendBits(0, (8 - bb.length % 8) % 8, bb);
-  assert(bb.length % 8 === 0);
   for (let padByte = 236; bb.length < dataCapacityBits; padByte ^= 236 ^ 17)
     appendBits(padByte, 8, bb);
-  const dataCodewords = [];
-  while (dataCodewords.length * 8 < bb.length)
-    dataCodewords.push(0);
+  const dataCodewords = Array.from({ length: Math.ceil(bb.length / 8) }, () => 0);
   bb.forEach((b, i) => dataCodewords[i >>> 3] |= b << 7 - (i & 7));
   return new QrCode(version, ecl, dataCodewords, mask);
 }
@@ -623,18 +604,20 @@ function encode(data, options) {
   );
   const result = addBorder({
     version: qr.version,
+    maskPattern: qr.mask,
     size: qr.size,
     data: qr.modules,
     types: qr.types
   }, 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) => {
@@ -716,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,7 +1,7 @@
 {
   "name": "uqr",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "packageManager": "pnpm@8.6.11",
   "description": "Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
@@ -56,6 +56,7 @@
     "lint-staged": "^13.2.3",
     "pnpm": "^8.6.11",
     "rimraf": "^5.0.1",
+    "rollup": "^3.27.2",
     "simple-git-hooks": "^2.9.0",
     "typescript": "^5.1.6",
     "unbuild": "^1.2.1",