@vkontakte/vk-qr 2.1.1 → 3.1.0

package/src/figures.ts

@@ -0,0 +1,106 @@
+import { FINDER_PATTERN_SIZE } from './constants.ts';
+
+/** A connected group of modules stored in its smallest bounding box. */
+export interface Figure {
+  x: number;
+  y: number;
+  pixels: boolean[][];
+}
+
+export function isFinderPattern(figure: Figure, size: number): boolean {
+  const { x, y, pixels } = figure;
+  const width = pixels[0]?.length ?? 0;
+  const height = pixels.length;
+  const right = x + width - 1;
+  const bottom = y + height - 1;
+
+  const finderRegions: Array<[number, number, number, number]> = [
+    [0, 0, FINDER_PATTERN_SIZE - 1, FINDER_PATTERN_SIZE - 1],
+    [size - FINDER_PATTERN_SIZE, 0, size - 1, FINDER_PATTERN_SIZE - 1],
+    [0, size - FINDER_PATTERN_SIZE, FINDER_PATTERN_SIZE - 1, size - 1],
+  ];
+
+  for (const [rx1, ry1, rx2, ry2] of finderRegions) {
+    if (x >= rx1 && y >= ry1 && right <= rx2 && bottom <= ry2) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+export function extractFigures(image: boolean[][]): Figure[] {
+  const height = image.length;
+  const width = image[0]?.length ?? 0;
+
+  const visited: boolean[][] = Array.from({ length: height }, () => Array(width).fill(false));
+
+  const figures: Figure[] = [];
+
+  const directions = [
+    [0, -1], // up
+    [1, 0], // right
+    [0, 1], // down
+    [-1, 0], // left
+  ];
+
+  function isInside(x: number, y: number): boolean {
+    return y >= 0 && y < height && x >= 0 && x < width;
+  }
+
+  for (let y = 0; y < height; y++) {
+    for (let x = 0; x < width; x++) {
+      if (visited[y][x]) continue;
+      if (!image[y][x]) continue;
+
+      const cells: Array<[number, number]> = [[x, y]];
+
+      visited[y][x] = true;
+
+      let minX = x;
+      let maxX = x;
+      let minY = y;
+      let maxY = y;
+
+      for (let head = 0; head < cells.length; head++) {
+        const [cx, cy] = cells[head];
+
+        minX = Math.min(minX, cx);
+        maxX = Math.max(maxX, cx);
+        minY = Math.min(minY, cy);
+        maxY = Math.max(maxY, cy);
+
+        for (const [dx, dy] of directions) {
+          const nx = cx + dx;
+          const ny = cy + dy;
+
+          if (!isInside(nx, ny)) continue;
+          if (visited[ny][nx]) continue;
+          if (!image[ny][nx]) continue;
+
+          visited[ny][nx] = true;
+          cells.push([nx, ny]);
+        }
+      }
+
+      const figureWidth = maxX - minX + 1;
+      const figureHeight = maxY - minY + 1;
+
+      const pixels: boolean[][] = Array.from({ length: figureHeight }, () =>
+        Array(figureWidth).fill(false),
+      );
+
+      for (const [cellX, cellY] of cells) {
+        pixels[cellY - minY][cellX - minX] = true;
+      }
+
+      figures.push({
+        x: minX,
+        y: minY,
+        pixels,
+      });
+    }
+  }
+
+  return figures;
+}

package/src/index.ts

@@ -1,7 +1,7 @@
-import { convertSegmentsToSvgString, INC_TILE_SIZE } from './svg';
-import { QrSegment, QrCode } from './qr';
-import { QrOptions } from './types';
-import Ecc = QrCode.Ecc;
+import { convertSegmentsToSvgString, INC_TILE_SIZE } from './svg.ts';
+import { makeSegments, encodeSegments, QrCodeEcc } from './qr.ts';
+import type { QrOptions, RequiredQrOptions } from './types.ts';
+import { BACKGROUND_PADDING, BACKGROUND_RADIUS } from './constants.ts';
 
 /** Default width and height of QR code */
 const DEFAULT_SIZE = 128;
@@ -20,7 +20,7 @@ const LOGO_COLOR_DEFAULT = '#07f';
  * @param text String to encode
  * @param options QR code options
  */
-function createQR(text: string, options?: QrOptions): string;
+export function createQR(text: string, options?: QrOptions): string;
 
 /**
  * Legacy interface
@@ -30,16 +30,21 @@ function createQR(text: string, options?: QrOptions): string;
  * @param className SVG element class name
  * @param options Options of the QR code
  */
-function createQR(text: string, qrSize: number, className: string, options?: QrOptions): string;
+export function createQR(
+  text: string,
+  qrSize: number,
+  className: string,
+  options?: QrOptions,
+): string;
 
 /**
  * Implementation
  */
-function createQR(
+export function createQR(
   text: string,
   qrSizeOrOptions?: number | QrOptions,
   classNameLegacy?: string,
-  legacyOptions?: QrOptions
+  legacyOptions?: QrOptions,
 ): string {
   if (typeof text !== 'string') {
     throw new TypeError('Enter text for encoding');
@@ -50,46 +55,59 @@ function createQR(
     ...(typeof qrSizeOrOptions === 'object' && qrSizeOrOptions !== null ? qrSizeOrOptions : {}),
     ...(typeof legacyOptions === 'object' && legacyOptions !== null ? legacyOptions : {}),
     qrSize:
-      typeof qrSizeOrOptions === 'object' && qrSizeOrOptions !== null && typeof qrSizeOrOptions.qrSize === 'number'
+      typeof qrSizeOrOptions === 'object' &&
+      qrSizeOrOptions !== null &&
+      typeof qrSizeOrOptions.qrSize === 'number'
         ? qrSizeOrOptions.qrSize
         : (qrSizeOrOptions as number),
     className:
-      typeof qrSizeOrOptions === 'object' && qrSizeOrOptions !== null && typeof qrSizeOrOptions.className === 'string'
+      typeof qrSizeOrOptions === 'object' &&
+      qrSizeOrOptions !== null &&
+      typeof qrSizeOrOptions.className === 'string'
         ? qrSizeOrOptions.className
-        : classNameLegacy
+        : classNameLegacy,
   };
 
   // ECC levels mapping
-  const eccLevels = [
-    QrCode.Ecc.LOW,
-    QrCode.Ecc.MEDIUM,
-    QrCode.Ecc.QUARTILE,
-    QrCode.Ecc.HIGH
-  ];
+  const eccLevels = [QrCodeEcc.LOW, QrCodeEcc.MEDIUM, QrCodeEcc.QUARTILE, QrCodeEcc.HIGH];
 
   // Fallback undefined options
-  const fallbackOptions: Required<QrOptions> = {
+  const fallbackOptions: RequiredQrOptions = {
     qrSize: typeof options.qrSize === 'number' ? options.qrSize : DEFAULT_SIZE,
     className: typeof options.className === 'string' ? options.className : classNameLegacy || '',
     isShowLogo: !!options.isShowLogo || false,
     isShowBackground: !!options.isShowBackground || false,
-    foregroundColor: typeof options.foregroundColor === 'string' ? options.foregroundColor : FOREGROUND_COLOR_DEFAULT,
-    backgroundColor: typeof options.backgroundColor === 'string' ? options.backgroundColor : BACKGROUND_COLOR_DEFAULT,
+    foregroundColor:
+      typeof options.foregroundColor === 'string'
+        ? options.foregroundColor
+        : FOREGROUND_COLOR_DEFAULT,
+    backgroundColor:
+      typeof options.backgroundColor === 'string'
+        ? options.backgroundColor
+        : BACKGROUND_COLOR_DEFAULT,
+    backgroundPadding:
+      typeof options.backgroundPadding === 'number' &&
+      Number.isFinite(options.backgroundPadding) &&
+      options.backgroundPadding >= 0
+        ? options.backgroundPadding
+        : BACKGROUND_PADDING,
+    backgroundRadius:
+      typeof options.backgroundRadius === 'number' &&
+      Number.isFinite(options.backgroundRadius) &&
+      options.backgroundRadius >= 0
+        ? options.backgroundRadius
+        : BACKGROUND_RADIUS,
     logoColor: typeof options.logoColor === 'string' ? options.logoColor : LOGO_COLOR_DEFAULT,
     suffix: options.suffix ? options.suffix.toString() : '0',
     logoData: typeof options.logoData === 'string' ? options.logoData : null,
-    ecc: (typeof options.ecc === 'number' && eccLevels[options.ecc] ? options.ecc : 3),
+    ecc: typeof options.ecc === 'number' && eccLevels[options.ecc] ? options.ecc : 3,
     incTileSize: typeof options.incTileSize === 'number' ? options.incTileSize : INC_TILE_SIZE,
   };
 
   // Code generation
-  const segments: QrSegment[] = QrSegment.makeSegments(text);
-  const qrCode: QrCode = QrCode.encodeSegments(segments, eccLevels[fallbackOptions.ecc], 1, 40, -1, true);
+  const segments = makeSegments(text);
+  const qrCode = encodeSegments(segments, eccLevels[fallbackOptions.ecc], 1, 40, -1, true);
   const svgCode = convertSegmentsToSvgString(qrCode, fallbackOptions);
 
   return svgCode;
 }
-
-export default {
-  createQR
-};