uqr 0.1.1 → 0.1.3

package/README.md

@@ -111,6 +111,10 @@ import { renderSVG } from 'uqr'
 const string = renderSVG(text, options)
 ```
 
+## Alternatives
+
+- [etiket](https://github.com/productdevbook/etiket) — Zero-dependency barcode & QR code SVG generator. 20+ formats (1D barcodes, QR, Data Matrix, PDF417, Aztec), styled QR codes with dot types/gradients/logos, tree-shakeable, CLI tool.
+
 ## Credits
 
 QR Code generation algorithm is modified from [nayuki/QR-Code-generator](https://github.com/nayuki/QR-Code-generator/blob/master/typescript-javascript/qrcodegen.ts) by Project Nayuki.
@@ -128,8 +132,6 @@ CLI renders are inspired by [qrcode-terminal](https://github.com/gtanner/qrcode-
 [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

package/dist/index.cjs

@@ -20,8 +20,8 @@ const EccMap = {
   Q: QUARTILE,
   H: HIGH
 };
-const NUMERIC_REGEX = /^[0-9]*$/;
-const ALPHANUMERIC_REGEX = /^[A-Z0-9 $%*+.\/:-]*$/;
+const NUMERIC_REGEX = /^\d*$/;
+const ALPHANUMERIC_REGEX = /^[A-Z0-9 $%*+./:-]*$/;
 const ALPHANUMERIC_CHARSET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:";
 const MIN_VERSION = 1;
 const MAX_VERSION = 40;
@@ -62,16 +62,12 @@ class QrCode {
   constructor(version, ecc, dataCodewords, msk) {
     this.version = version;
     this.ecc = ecc;
-    // The modules of this QR Code (false = light, true = dark).
-    // Immutable after constructor finishes. Accessed through getModule().
-    this.modules = [];
-    this.types = [];
     if (version < MIN_VERSION || version > MAX_VERSION)
       throw new RangeError("Version value out of range");
     if (msk < -1 || msk > 7)
       throw new RangeError("Mask value out of range");
     this.size = version * 4 + 17;
-    const row = Array.from({ length: this.size }, () => false);
+    const row = Array.from({ length: this.size }).fill(false);
     for (let i = 0; i < this.size; i++) {
       this.modules.push(row.slice());
       this.types.push(row.map(() => 0));
@@ -96,6 +92,18 @@ class QrCode {
     this.applyMask(msk);
     this.drawFormatBits(msk);
   }
+  /* -- Fields -- */
+  // The width and height of this QR Code, measured in modules, between
+  // 21 and 177 (inclusive). This is equal to version * 4 + 17.
+  size;
+  // The index of the mask pattern used in this QR Code, which is between 0 and 7 (inclusive).
+  // Even if a QR Code is created with automatic masking requested (mask = -1),
+  // the resulting object still has a mask value between 0 and 7.
+  mask;
+  // The modules of this QR Code (false = light, true = dark).
+  // Immutable after constructor finishes. Accessed through getModule().
+  modules = [];
+  types = [];
   /* -- Accessor methods -- */
   // Returns the color of the module (pixel) at the given coordinates, which is false
   // for light or true for dark. The top left corner has the coordinates (x=0, y=0).
@@ -342,8 +350,9 @@ class QrCode {
     for (let y = 0; y < this.size - 1; y++) {
       for (let x = 0; x < this.size - 1; x++) {
         const color = this.modules[y][x];
-        if (color === this.modules[y][x + 1] && color === this.modules[y + 1][x] && color === this.modules[y + 1][x + 1])
+        if (color === this.modules[y][x + 1] && color === this.modules[y + 1][x] && color === this.modules[y + 1][x + 1]) {
           result += PENALTY_N2;
+        }
       }
     }
     let dark = 0;
@@ -551,8 +560,9 @@ function reedSolomonMultiply(x, y) {
   return z;
 }
 function encodeSegments(segs, ecl, minVersion = 1, maxVersion = 40, mask = -1, boostEcl = true) {
-  if (!(MIN_VERSION <= minVersion && minVersion <= maxVersion && maxVersion <= MAX_VERSION) || mask < -1 || mask > 7)
+  if (!(MIN_VERSION <= minVersion && minVersion <= maxVersion && maxVersion <= MAX_VERSION) || mask < -1 || mask > 7) {
     throw new RangeError("Invalid value");
+  }
   let version;
   let dataUsedBits;
   for (version = minVersion; ; version++) {
@@ -671,7 +681,7 @@ function renderANSI(data, options = {}) {
   });
 }
 function renderUnicodeCompact(data, options = {}) {
-  const platte = {
+  const palette = {
     WHITE_ALL: "\u2588",
     WHITE_BLACK: "\u2580",
     BLACK_WHITE: "\u2584",
@@ -686,13 +696,13 @@ function renderUnicodeCompact(data, options = {}) {
   for (let row = 0; row < result.size; row += 2) {
     for (let col = 0; col < result.size; col++) {
       if (at(col, row) === WHITE && at(col, row + 1) === WHITE)
-        line += platte.WHITE_ALL;
+        line += palette.WHITE_ALL;
       else if (at(col, row) === WHITE && at(col, row + 1) === BLACK)
-        line += platte.WHITE_BLACK;
+        line += palette.WHITE_BLACK;
       else if (at(col, row) === BLACK && at(col, row + 1) === WHITE)
-        line += platte.BLACK_WHITE;
+        line += palette.BLACK_WHITE;
       else
-        line += platte.BLACK_ALL;
+        line += palette.BLACK_ALL;
     }
     lines.push(line);
     line = "";
@@ -700,6 +710,9 @@ function renderUnicodeCompact(data, options = {}) {
   return lines.join("\n");
 }
 
+function escapeAttr(value) {
+  return value.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
 function renderSVG(data, options = {}) {
   const result = encode(data, options);
   const {
@@ -710,17 +723,17 @@ function renderSVG(data, options = {}) {
   const height = result.size * pixelSize;
   const width = result.size * pixelSize;
   let svg = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${width} ${height}">`;
-  const pathes = [];
+  const paths = [];
   for (let row = 0; row < result.size; row++) {
     for (let col = 0; col < result.size; col++) {
       const x = col * pixelSize;
       const y = row * pixelSize;
       if (result.data[row][col])
-        pathes.push(`M${x},${y}h${pixelSize}v${pixelSize}h-${pixelSize}z`);
+        paths.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 += `<rect fill="${escapeAttr(whiteColor)}" width="${width}" height="${height}"/>`;
+  svg += `<path fill="${escapeAttr(blackColor)}" d="${paths.join("")}"/>`;
   svg += "</svg>";
   return svg;
 }

package/dist/index.d.cts

@@ -0,0 +1,161 @@
+/**
+ * String or binary
+ */
+type QrCodeGenerateData = string | Readonly<Array<number>>;
+interface QrCodeGenerateOptions {
+    /**
+     * Error correction level
+     *
+     * L - Allows recovery of up to 7% data loss
+     * M - Allows recovery of up to 15% data loss
+     * Q - Allows recovery of up to 25% data loss
+     * H - Allows recovery of up to 30% data loss
+     *
+     * @default 'L'
+     */
+    ecc?: 'L' | 'M' | 'Q' | 'H';
+    /**
+     * Mask pattern to use
+     *
+     * @default -1 (auto)
+     */
+    maskPattern?: number;
+    /**
+     * Boost the error correction level to the maximum allowed by the version and size
+     */
+    boostEcc?: boolean;
+    /**
+     * Minimum version of the QR code (1-40)
+     * @default 1
+     */
+    minVersion?: number;
+    /**
+     * Maximum version of the QR code (1-40)
+     * @default 40
+     */
+    maxVersion?: number;
+    /**
+     * Border around the QR code
+     *
+     * @default 1
+     */
+    border?: number;
+    /**
+     * Invert black and white
+     */
+    invert?: boolean;
+    /**
+     * Callback function to receive the generated QR Code
+     */
+    onEncoded?: (qr: QrCodeGenerateResult) => void;
+}
+declare enum QrCodeDataType {
+    Border = -1,
+    Data = 0,
+    Function = 1,
+    Position = 2,
+    Timing = 3,
+    Alignment = 4
+}
+interface QrCodeGenerateResult {
+    /**
+     * QR Code version
+     */
+    version: number;
+    /**
+     * Width and height of the QR Code array
+     */
+    size: number;
+    /**
+     * Mask pattern used
+     */
+    maskPattern: number;
+    /**
+     * Two dimensional array representing the QR Code
+     *
+     * `true` for black, `false` for white
+     */
+    data: boolean[][];
+    /**
+     * Data type of each module
+     */
+    types: QrCodeDataType[][];
+}
+interface QrCodeGenerateInvertableOptions extends QrCodeGenerateOptions {
+    /**
+     * Adds the option to invert the colour scheme of the QR code in addition to the standard options.
+     */
+    invert?: boolean;
+}
+interface QrCodeGenerateUnicodeOptions extends QrCodeGenerateInvertableOptions {
+    /**
+     * Character used to represent white modules in the QR code.
+     */
+    whiteChar?: string;
+    /**
+     * Character used to represent black modules in the QR code.
+     */
+    blackChar?: string;
+}
+interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
+    /**
+     * Size of each pixel
+     *
+     * @default 10
+     */
+    pixelSize?: number;
+    /**
+     * Color of the white module
+     *
+     * @default 'white'
+     */
+    whiteColor?: string;
+    /**
+     * Color of the black module
+     *
+     * @default 'black'
+     */
+    blackColor?: string;
+}
+
+/**
+ * Encodes the given data into a QR code format according to the given options.
+ * @param {QrCodeGenerateData} data - The data to encode, either as a string or an array of bytes. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - QR Code generation configuration options. Optional. See {@link QrCodeGenerateOptions}.
+ * @returns {QrCodeGenerateResult} The result of the QR code generation, including the QR code matrix. See {@link QrCodeGenerateResult}.
+ */
+declare function encode(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): QrCodeGenerateResult;
+
+/**
+ * Renders a QR code as a string using the specified Unicode characters for dark(`█`) and light(`░`) modules.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateUnicodeOptions} [options] - Rendering options, including characters for white and black modules. optional. See {@link QrCodeGenerateUnicodeOptions}.
+ * Returns {string} A string representing the QR code, with each module replaced by the specified Unicode character.
+ */
+declare function renderUnicode(data: QrCodeGenerateData, options?: QrCodeGenerateUnicodeOptions): string;
+/**
+ * Renders a QR code as a string suitable for display on terminals using ANSI background colours.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - Options to render the QR code. optional. See {@link QrCodeGenerateOptions}.
+ * @returns {string} A string representing the QR code using ANSI colours, formatted for terminal display.
+ */
+declare function renderANSI(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
+/**
+ * Renders a QR code as a compact string using a combination of top half block(`▀`), bottom half block(`▄`), full block(`█`) and spaces to represent two lines in a single line.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - Options to render the QR code in a compact form. optional. See {@link QrCodeGenerateOptions}.
+ * @returns {string} A string representing the QR code in a compact format, using Unicode block characters to combine two lines per line.
+ */
+declare function renderUnicodeCompact(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
+
+/**
+ * Renders a QR code as an SVG string.
+ * The function converts the input data into a QR code and then generates an SVG representation using the specified colours and pixel sizes.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateSvgOptions} [options] - Options to render the QR code in SVG format, including pixel size and colours for modules. optional. See {@link QrCodeGenerateSvgOptions}.
+ * @returns {string} An SVG string representing the QR code.
+ */
+declare function renderSVG(data: QrCodeGenerateData, options?: QrCodeGenerateSvgOptions): string;
+
+export { QrCodeDataType, encode, renderANSI, renderSVG, renderUnicode, renderUnicodeCompact };
+export type { QrCodeGenerateData, QrCodeGenerateInvertableOptions, QrCodeGenerateOptions, QrCodeGenerateResult, QrCodeGenerateSvgOptions, QrCodeGenerateUnicodeOptions };

package/dist/index.d.mts

@@ -0,0 +1,161 @@
+/**
+ * String or binary
+ */
+type QrCodeGenerateData = string | Readonly<Array<number>>;
+interface QrCodeGenerateOptions {
+    /**
+     * Error correction level
+     *
+     * L - Allows recovery of up to 7% data loss
+     * M - Allows recovery of up to 15% data loss
+     * Q - Allows recovery of up to 25% data loss
+     * H - Allows recovery of up to 30% data loss
+     *
+     * @default 'L'
+     */
+    ecc?: 'L' | 'M' | 'Q' | 'H';
+    /**
+     * Mask pattern to use
+     *
+     * @default -1 (auto)
+     */
+    maskPattern?: number;
+    /**
+     * Boost the error correction level to the maximum allowed by the version and size
+     */
+    boostEcc?: boolean;
+    /**
+     * Minimum version of the QR code (1-40)
+     * @default 1
+     */
+    minVersion?: number;
+    /**
+     * Maximum version of the QR code (1-40)
+     * @default 40
+     */
+    maxVersion?: number;
+    /**
+     * Border around the QR code
+     *
+     * @default 1
+     */
+    border?: number;
+    /**
+     * Invert black and white
+     */
+    invert?: boolean;
+    /**
+     * Callback function to receive the generated QR Code
+     */
+    onEncoded?: (qr: QrCodeGenerateResult) => void;
+}
+declare enum QrCodeDataType {
+    Border = -1,
+    Data = 0,
+    Function = 1,
+    Position = 2,
+    Timing = 3,
+    Alignment = 4
+}
+interface QrCodeGenerateResult {
+    /**
+     * QR Code version
+     */
+    version: number;
+    /**
+     * Width and height of the QR Code array
+     */
+    size: number;
+    /**
+     * Mask pattern used
+     */
+    maskPattern: number;
+    /**
+     * Two dimensional array representing the QR Code
+     *
+     * `true` for black, `false` for white
+     */
+    data: boolean[][];
+    /**
+     * Data type of each module
+     */
+    types: QrCodeDataType[][];
+}
+interface QrCodeGenerateInvertableOptions extends QrCodeGenerateOptions {
+    /**
+     * Adds the option to invert the colour scheme of the QR code in addition to the standard options.
+     */
+    invert?: boolean;
+}
+interface QrCodeGenerateUnicodeOptions extends QrCodeGenerateInvertableOptions {
+    /**
+     * Character used to represent white modules in the QR code.
+     */
+    whiteChar?: string;
+    /**
+     * Character used to represent black modules in the QR code.
+     */
+    blackChar?: string;
+}
+interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
+    /**
+     * Size of each pixel
+     *
+     * @default 10
+     */
+    pixelSize?: number;
+    /**
+     * Color of the white module
+     *
+     * @default 'white'
+     */
+    whiteColor?: string;
+    /**
+     * Color of the black module
+     *
+     * @default 'black'
+     */
+    blackColor?: string;
+}
+
+/**
+ * Encodes the given data into a QR code format according to the given options.
+ * @param {QrCodeGenerateData} data - The data to encode, either as a string or an array of bytes. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - QR Code generation configuration options. Optional. See {@link QrCodeGenerateOptions}.
+ * @returns {QrCodeGenerateResult} The result of the QR code generation, including the QR code matrix. See {@link QrCodeGenerateResult}.
+ */
+declare function encode(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): QrCodeGenerateResult;
+
+/**
+ * Renders a QR code as a string using the specified Unicode characters for dark(`█`) and light(`░`) modules.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateUnicodeOptions} [options] - Rendering options, including characters for white and black modules. optional. See {@link QrCodeGenerateUnicodeOptions}.
+ * Returns {string} A string representing the QR code, with each module replaced by the specified Unicode character.
+ */
+declare function renderUnicode(data: QrCodeGenerateData, options?: QrCodeGenerateUnicodeOptions): string;
+/**
+ * Renders a QR code as a string suitable for display on terminals using ANSI background colours.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - Options to render the QR code. optional. See {@link QrCodeGenerateOptions}.
+ * @returns {string} A string representing the QR code using ANSI colours, formatted for terminal display.
+ */
+declare function renderANSI(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
+/**
+ * Renders a QR code as a compact string using a combination of top half block(`▀`), bottom half block(`▄`), full block(`█`) and spaces to represent two lines in a single line.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - Options to render the QR code in a compact form. optional. See {@link QrCodeGenerateOptions}.
+ * @returns {string} A string representing the QR code in a compact format, using Unicode block characters to combine two lines per line.
+ */
+declare function renderUnicodeCompact(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
+
+/**
+ * Renders a QR code as an SVG string.
+ * The function converts the input data into a QR code and then generates an SVG representation using the specified colours and pixel sizes.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateSvgOptions} [options] - Options to render the QR code in SVG format, including pixel size and colours for modules. optional. See {@link QrCodeGenerateSvgOptions}.
+ * @returns {string} An SVG string representing the QR code.
+ */
+declare function renderSVG(data: QrCodeGenerateData, options?: QrCodeGenerateSvgOptions): string;
+
+export { QrCodeDataType, encode, renderANSI, renderSVG, renderUnicode, renderUnicodeCompact };
+export type { QrCodeGenerateData, QrCodeGenerateInvertableOptions, QrCodeGenerateOptions, QrCodeGenerateResult, QrCodeGenerateSvgOptions, QrCodeGenerateUnicodeOptions };

package/dist/index.d.ts

@@ -82,17 +82,26 @@ interface QrCodeGenerateResult {
     types: QrCodeDataType[][];
 }
 interface QrCodeGenerateInvertableOptions extends QrCodeGenerateOptions {
+    /**
+     * Adds the option to invert the colour scheme of the QR code in addition to the standard options.
+     */
     invert?: boolean;
 }
 interface QrCodeGenerateUnicodeOptions extends QrCodeGenerateInvertableOptions {
+    /**
+     * Character used to represent white modules in the QR code.
+     */
     whiteChar?: string;
+    /**
+     * Character used to represent black modules in the QR code.
+     */
     blackChar?: string;
 }
 interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
     /**
      * Size of each pixel
      *
-     * @default 20
+     * @default 10
      */
     pixelSize?: number;
     /**
@@ -109,24 +118,44 @@ interface QrCodeGenerateSvgOptions extends QrCodeGenerateOptions {
     blackColor?: string;
 }
 
+/**
+ * Encodes the given data into a QR code format according to the given options.
+ * @param {QrCodeGenerateData} data - The data to encode, either as a string or an array of bytes. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - QR Code generation configuration options. Optional. See {@link QrCodeGenerateOptions}.
+ * @returns {QrCodeGenerateResult} The result of the QR code generation, including the QR code matrix. See {@link QrCodeGenerateResult}.
+ */
 declare function encode(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): QrCodeGenerateResult;
 
 /**
- * Render QR Code with unicode `█`, `░`
+ * Renders a QR code as a string using the specified Unicode characters for dark(`█`) and light(`░`) modules.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateUnicodeOptions} [options] - Rendering options, including characters for white and black modules. optional. See {@link QrCodeGenerateUnicodeOptions}.
+ * Returns {string} A string representing the QR code, with each module replaced by the specified Unicode character.
  */
 declare function renderUnicode(data: QrCodeGenerateData, options?: QrCodeGenerateUnicodeOptions): string;
 /**
- * Render QR Code with ANSI color for terminal
+ * Renders a QR code as a string suitable for display on terminals using ANSI background colours.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - Options to render the QR code. optional. See {@link QrCodeGenerateOptions}.
+ * @returns {string} A string representing the QR code using ANSI colours, formatted for terminal display.
  */
 declare function renderANSI(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
 /**
- * Render QR Code with two rows into one line with unicode `▀`, `▄`, `█`, ` `
+ * Renders a QR code as a compact string using a combination of top half block(`▀`), bottom half block(`▄`), full block(`█`) and spaces to represent two lines in a single line.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateOptions} [options] - Options to render the QR code in a compact form. optional. See {@link QrCodeGenerateOptions}.
+ * @returns {string} A string representing the QR code in a compact format, using Unicode block characters to combine two lines per line.
  */
 declare function renderUnicodeCompact(data: QrCodeGenerateData, options?: QrCodeGenerateOptions): string;
 
 /**
- * Render QR Code with ANSI color for terminal
+ * Renders a QR code as an SVG string.
+ * The function converts the input data into a QR code and then generates an SVG representation using the specified colours and pixel sizes.
+ * @param {QrCodeGenerateData} data - The data to encode into the QR code. See {@link QrCodeGenerateData}.
+ * @param {QrCodeGenerateSvgOptions} [options] - Options to render the QR code in SVG format, including pixel size and colours for modules. optional. See {@link QrCodeGenerateSvgOptions}.
+ * @returns {string} An SVG string representing the QR code.
  */
 declare function renderSVG(data: QrCodeGenerateData, options?: QrCodeGenerateSvgOptions): string;
 
-export { QrCodeDataType, QrCodeGenerateData, QrCodeGenerateInvertableOptions, QrCodeGenerateOptions, QrCodeGenerateResult, QrCodeGenerateSvgOptions, QrCodeGenerateUnicodeOptions, encode, renderANSI, renderSVG, renderUnicode, renderUnicodeCompact };
+export { QrCodeDataType, encode, renderANSI, renderSVG, renderUnicode, renderUnicodeCompact };
+export type { QrCodeGenerateData, QrCodeGenerateInvertableOptions, QrCodeGenerateOptions, QrCodeGenerateResult, QrCodeGenerateSvgOptions, QrCodeGenerateUnicodeOptions };

package/dist/index.mjs

@@ -18,8 +18,8 @@ const EccMap = {
   Q: QUARTILE,
   H: HIGH
 };
-const NUMERIC_REGEX = /^[0-9]*$/;
-const ALPHANUMERIC_REGEX = /^[A-Z0-9 $%*+.\/:-]*$/;
+const NUMERIC_REGEX = /^\d*$/;
+const ALPHANUMERIC_REGEX = /^[A-Z0-9 $%*+./:-]*$/;
 const ALPHANUMERIC_CHARSET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ $%*+-./:";
 const MIN_VERSION = 1;
 const MAX_VERSION = 40;
@@ -60,16 +60,12 @@ class QrCode {
   constructor(version, ecc, dataCodewords, msk) {
     this.version = version;
     this.ecc = ecc;
-    // The modules of this QR Code (false = light, true = dark).
-    // Immutable after constructor finishes. Accessed through getModule().
-    this.modules = [];
-    this.types = [];
     if (version < MIN_VERSION || version > MAX_VERSION)
       throw new RangeError("Version value out of range");
     if (msk < -1 || msk > 7)
       throw new RangeError("Mask value out of range");
     this.size = version * 4 + 17;
-    const row = Array.from({ length: this.size }, () => false);
+    const row = Array.from({ length: this.size }).fill(false);
     for (let i = 0; i < this.size; i++) {
       this.modules.push(row.slice());
       this.types.push(row.map(() => 0));
@@ -94,6 +90,18 @@ class QrCode {
     this.applyMask(msk);
     this.drawFormatBits(msk);
   }
+  /* -- Fields -- */
+  // The width and height of this QR Code, measured in modules, between
+  // 21 and 177 (inclusive). This is equal to version * 4 + 17.
+  size;
+  // The index of the mask pattern used in this QR Code, which is between 0 and 7 (inclusive).
+  // Even if a QR Code is created with automatic masking requested (mask = -1),
+  // the resulting object still has a mask value between 0 and 7.
+  mask;
+  // The modules of this QR Code (false = light, true = dark).
+  // Immutable after constructor finishes. Accessed through getModule().
+  modules = [];
+  types = [];
   /* -- Accessor methods -- */
   // Returns the color of the module (pixel) at the given coordinates, which is false
   // for light or true for dark. The top left corner has the coordinates (x=0, y=0).
@@ -340,8 +348,9 @@ class QrCode {
     for (let y = 0; y < this.size - 1; y++) {
       for (let x = 0; x < this.size - 1; x++) {
         const color = this.modules[y][x];
-        if (color === this.modules[y][x + 1] && color === this.modules[y + 1][x] && color === this.modules[y + 1][x + 1])
+        if (color === this.modules[y][x + 1] && color === this.modules[y + 1][x] && color === this.modules[y + 1][x + 1]) {
           result += PENALTY_N2;
+        }
       }
     }
     let dark = 0;
@@ -549,8 +558,9 @@ function reedSolomonMultiply(x, y) {
   return z;
 }
 function encodeSegments(segs, ecl, minVersion = 1, maxVersion = 40, mask = -1, boostEcl = true) {
-  if (!(MIN_VERSION <= minVersion && minVersion <= maxVersion && maxVersion <= MAX_VERSION) || mask < -1 || mask > 7)
+  if (!(MIN_VERSION <= minVersion && minVersion <= maxVersion && maxVersion <= MAX_VERSION) || mask < -1 || mask > 7) {
     throw new RangeError("Invalid value");
+  }
   let version;
   let dataUsedBits;
   for (version = minVersion; ; version++) {
@@ -669,7 +679,7 @@ function renderANSI(data, options = {}) {
   });
 }
 function renderUnicodeCompact(data, options = {}) {
-  const platte = {
+  const palette = {
     WHITE_ALL: "\u2588",
     WHITE_BLACK: "\u2580",
     BLACK_WHITE: "\u2584",
@@ -684,13 +694,13 @@ function renderUnicodeCompact(data, options = {}) {
   for (let row = 0; row < result.size; row += 2) {
     for (let col = 0; col < result.size; col++) {
       if (at(col, row) === WHITE && at(col, row + 1) === WHITE)
-        line += platte.WHITE_ALL;
+        line += palette.WHITE_ALL;
       else if (at(col, row) === WHITE && at(col, row + 1) === BLACK)
-        line += platte.WHITE_BLACK;
+        line += palette.WHITE_BLACK;
       else if (at(col, row) === BLACK && at(col, row + 1) === WHITE)
-        line += platte.BLACK_WHITE;
+        line += palette.BLACK_WHITE;
       else
-        line += platte.BLACK_ALL;
+        line += palette.BLACK_ALL;
     }
     lines.push(line);
     line = "";
@@ -698,6 +708,9 @@ function renderUnicodeCompact(data, options = {}) {
   return lines.join("\n");
 }
 
+function escapeAttr(value) {
+  return value.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
 function renderSVG(data, options = {}) {
   const result = encode(data, options);
   const {
@@ -708,17 +721,17 @@ function renderSVG(data, options = {}) {
   const height = result.size * pixelSize;
   const width = result.size * pixelSize;
   let svg = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${width} ${height}">`;
-  const pathes = [];
+  const paths = [];
   for (let row = 0; row < result.size; row++) {
     for (let col = 0; col < result.size; col++) {
       const x = col * pixelSize;
       const y = row * pixelSize;
       if (result.data[row][col])
-        pathes.push(`M${x},${y}h${pixelSize}v${pixelSize}h-${pixelSize}z`);
+        paths.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 += `<rect fill="${escapeAttr(whiteColor)}" width="${width}" height="${height}"/>`;
+  svg += `<path fill="${escapeAttr(blackColor)}" d="${paths.join("")}"/>`;
   svg += "</svg>";
   return svg;
 }

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "uqr",
   "type": "module",
-  "version": "0.1.1",
-  "packageManager": "pnpm@8.6.12",
+  "version": "0.1.3",
   "description": "Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -16,7 +15,6 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     }
@@ -35,38 +33,37 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "unbuild",
-    "dev": "unbuild --stub",
-    "lint": "eslint .",
-    "prepublishOnly": "nr build",
-    "release": "bumpp && npm publish",
-    "play": "esno play/run.ts",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit"
-  },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.40.2",
-    "@antfu/ni": "^0.21.5",
-    "@antfu/utils": "^0.7.5",
-    "@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.12",
-    "rimraf": "^5.0.1",
-    "rollup": "^3.28.0",
-    "simple-git-hooks": "^2.9.0",
-    "typescript": "^5.1.6",
-    "unbuild": "^1.2.1",
-    "vite": "^4.4.9",
-    "vitest": "^0.34.1"
+    "@antfu/eslint-config": "^8.0.0",
+    "@antfu/ni": "^30.0.0",
+    "@antfu/utils": "^9.3.0",
+    "@types/node": "^25.5.0",
+    "bumpp": "^11.0.1",
+    "eslint": "^10.1.0",
+    "lint-staged": "^16.4.0",
+    "pnpm": "^10.33.0",
+    "rimraf": "^6.1.3",
+    "rollup": "^4.60.1",
+    "simple-git-hooks": "^2.13.1",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.2",
+    "unbuild": "^3.6.1",
+    "vite": "^8.0.3",
+    "vitest": "^4.1.2"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"
   },
   "lint-staged": {
     "*": "eslint --fix"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "lint": "eslint .",
+    "release": "bumpp && npm publish",
+    "play": "tsx play/run.ts",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
   }
-}
+}