@sythos/js_barcode_universal 1.5.8 → 1.5.9

package/src/js/frameqr/encoder.js

@@ -27,7 +27,6 @@
  *
  * Original work. No code from any other barcode implementation.
  */
-
 /**
  * Sythos Canvas QR profile encoder.
  *
@@ -38,16 +37,9 @@
  *
  * @module frameqr/encoder
  */
-
 import { EncodeError } from '../core/errors.js';
 import { encodeQR } from '../qr/encoder.js';
-import {
-  FRAMEQR_PROFILE,
-  canvasModules,
-  normalizeCanvasSpec,
-  validateCanvasSpec,
-} from './tables.js';
-
+import { FRAMEQR_PROFILE, canvasModules, normalizeCanvasSpec, validateCanvasSpec, } from './tables.js';
 /**
  * @typedef {object} FrameQrEncodeOptions
  * @property {'H'} [ecc] The profile always uses QR error correction H.
@@ -57,15 +49,13 @@ import {
  * @property {boolean} [kanji] Allow QR kanji mode.
  * @property {object} [canvas] Profile artwork reservation.
  */
-
 function versionFor(matrix) {
-  return (matrix.width - 17) / 4;
+    return (matrix.width - 17) / 4;
 }
-
 function clearCanvas(matrix, modules) {
-  for (const [x, y] of modules) matrix.unset(x, y);
+    for (const [x, y] of modules)
+        matrix.unset(x, y);
 }
-
 /**
  * Encode a QR Code with a conservative artwork canvas according to the
  * non-certified Sythos Canvas QR profile.
@@ -83,74 +73,71 @@ function clearCanvas(matrix, modules) {
  *   cannot safely fit the selected QR version.
  */
 export function encodeFrameQR(text, options = {}) {
-  if (typeof text !== 'string') {
-    throw new EncodeError('Sythos Canvas QR: text must be a string');
-  }
-  if (options.ecc !== undefined && options.ecc !== 'H') {
-    throw new EncodeError('Sythos Canvas QR: ecc is fixed to H for this profile');
-  }
-
-  const qrOptions = {
-    mask: options.mask,
-    charset: options.charset,
-    kanji: options.kanji,
-    ecc: 'H',
-  };
-  for (const key of Object.keys(qrOptions)) {
-    if (qrOptions[key] === undefined) delete qrOptions[key];
-  }
-
-  const versions = options.version === undefined
-    ? Array.from({ length: 40 }, (_, index) => index + 1)
-    : [options.version];
-  let capacityError = null;
-  let unsafeAnalysis = null;
-  let selected = null;
-
-  for (const version of versions) {
-    let matrix;
-    try {
-      matrix = encodeQR(text, { ...qrOptions, version });
-    } catch (error) {
-      capacityError = error;
-      continue;
+    if (typeof text !== 'string') {
+        throw new EncodeError('Sythos Canvas QR: text must be a string');
     }
-
-    let canvas;
-    let analysis;
-    try {
-      canvas = normalizeCanvasSpec(matrix.width, options.canvas);
-      analysis = validateCanvasSpec(versionFor(matrix), canvas);
-    } catch (error) {
-      if (error instanceof EncodeError) throw error;
-      throw new EncodeError(`Sythos Canvas QR: invalid canvas: ${error.message}`);
+    if (options.ecc !== undefined && options.ecc !== 'H') {
+        throw new EncodeError('Sythos Canvas QR: ecc is fixed to H for this profile');
     }
-    if (!analysis.safe) {
-      unsafeAnalysis = analysis;
-      continue;
+    const qrOptions = {
+        mask: options.mask,
+        charset: options.charset,
+        kanji: options.kanji,
+        ecc: 'H',
+    };
+    for (const key of Object.keys(qrOptions)) {
+        if (qrOptions[key] === undefined)
+            delete qrOptions[key];
     }
-    selected = { matrix, canvas };
-    break;
-  }
-
-  if (!selected) {
-    if (unsafeAnalysis) {
-      throw new EncodeError(
-        'Sythos Canvas QR: canvas is not safe for the selected QR version; ' +
-        `it touches ${unsafeAnalysis.touchedCodewordCount} codewords and has ` +
-        `a per-block correction budget of ${unsafeAnalysis.correctionBudgetPerBlock}`
-      );
+    const versions = options.version === undefined
+        ? Array.from({ length: 40 }, (_, index) => index + 1)
+        : [options.version];
+    let capacityError = null;
+    let unsafeAnalysis = null;
+    let selected = null;
+    for (const version of versions) {
+        let matrix;
+        try {
+            matrix = encodeQR(text, { ...qrOptions, version });
+        }
+        catch (error) {
+            capacityError = error;
+            continue;
+        }
+        let canvas;
+        let analysis;
+        try {
+            canvas = normalizeCanvasSpec(matrix.width, options.canvas);
+            analysis = validateCanvasSpec(versionFor(matrix), canvas);
+        }
+        catch (error) {
+            if (error instanceof EncodeError)
+                throw error;
+            throw new EncodeError(`Sythos Canvas QR: invalid canvas: ${error.message}`);
+        }
+        if (!analysis.safe) {
+            unsafeAnalysis = analysis;
+            continue;
+        }
+        selected = { matrix, canvas };
+        break;
     }
-    if (capacityError) throw capacityError;
-    throw new EncodeError('Sythos Canvas QR: unable to select a QR version');
-  }
-
-  const { matrix, canvas } = selected;
-  clearCanvas(matrix, canvasModules(matrix.width, canvas));
-  matrix.frameqr = {
-    profile: FRAMEQR_PROFILE.id,
-    certified: false,
-    canvas,
-  };
-  return matrix;
+    if (!selected) {
+        if (unsafeAnalysis) {
+            throw new EncodeError('Sythos Canvas QR: canvas is not safe for the selected QR version; ' +
+                `it touches ${unsafeAnalysis.touchedCodewordCount} codewords and has ` +
+                `a per-block correction budget of ${unsafeAnalysis.correctionBudgetPerBlock}`);
+        }
+        if (capacityError)
+            throw capacityError;
+        throw new EncodeError('Sythos Canvas QR: unable to select a QR version');
+    }
+    const { matrix, canvas } = selected;
+    clearCanvas(matrix, canvasModules(matrix.width, canvas));
+    matrix.frameqr = {
+        profile: FRAMEQR_PROFILE.id,
+        certified: false,
+        canvas,
+    };
+    return matrix;
 }

package/src/js/frameqr/index.js

@@ -27,16 +27,7 @@
  *
  * Original work. No code from any other barcode implementation.
  */
-
 export { encodeFrameQR } from './encoder.js';
 export { decodeFrameQR } from './decoder.js';
 export { detectFrameQR, detectAndDecodeFrameQR } from './detector.js';
-export {
-  FRAMEQR_PROFILE,
-  FRAMEQR_CANVAS_SHAPES,
-  canvasModules,
-  normalizeCanvasSpec,
-  analyzeCanvasDamage,
-  validateCanvasSpec,
-  validateFrameQrTables,
-} from './tables.js';
+export { FRAMEQR_PROFILE, FRAMEQR_CANVAS_SHAPES, canvasModules, normalizeCanvasSpec, analyzeCanvasDamage, validateCanvasSpec, validateFrameQrTables, } from './tables.js';

package/src/js/frameqr/tables.js

@@ -27,7 +27,6 @@
  *
  * Original work. No code from any other barcode implementation.
  */
-
 /**
  * Structural contract for the Sythos Canvas QR profile.
  *
@@ -47,40 +46,30 @@
  *
  * @module frameqr/tables
  */
-
-import {
-  blockLayout,
-  dataModuleOrder,
-  reservedModules,
-  versionSize,
-} from '../qr/tables.js';
-
+import { blockLayout, dataModuleOrder, reservedModules, versionSize, } from '../qr/tables.js';
 /** Public identity and compatibility boundary of the implementable profile. */
 export const FRAMEQR_PROFILE = Object.freeze({
-  id: 'sythos-canvas-qr/1',
-  name: 'Sythos Canvas QR profile',
-  certified: false,
-  densoFrameQrCompatible: false,
-  baseSymbology: 'QR Code Model 2',
-  requiredEcc: 'H',
-  standard: 'ISO/IEC 18004 QR Code baseline',
+    id: 'sythos-canvas-qr/1',
+    name: 'Sythos Canvas QR profile',
+    certified: false,
+    densoFrameQrCompatible: false,
+    baseSymbology: 'QR Code Model 2',
+    requiredEcc: 'H',
+    standard: 'ISO/IEC 18004 QR Code baseline',
 });
-
 /** Canvas shapes whose module membership is fully deterministic. */
 export const FRAMEQR_CANVAS_SHAPES = Object.freeze(['square', 'circle', 'diamond']);
-
 function oddAtMost(value, maximum) {
-  let n = Math.max(1, Math.min(maximum, Math.floor(value)));
-  if ((n & 1) === 0) n--;
-  return Math.max(1, n);
+    let n = Math.max(1, Math.min(maximum, Math.floor(value)));
+    if ((n & 1) === 0)
+        n--;
+    return Math.max(1, n);
 }
-
 function assertSymbolSize(symbolSize) {
-  if (!Number.isInteger(symbolSize) || symbolSize < 21 || symbolSize > 177 || (symbolSize - 17) % 4 !== 0) {
-    throw new RangeError(`Frame QR profile: ${symbolSize} is not a QR Model 2 symbol size`);
-  }
+    if (!Number.isInteger(symbolSize) || symbolSize < 21 || symbolSize > 177 || (symbolSize - 17) % 4 !== 0) {
+        throw new RangeError(`Frame QR profile: ${symbolSize} is not a QR Model 2 symbol size`);
+    }
 }
-
 /**
  * Canonicalise a canvas request.
  *
@@ -93,44 +82,37 @@ function assertSymbolSize(symbolSize) {
  * @returns {{shape:string,centerX:number,centerY:number,width:number,height:number,angle:number}}
  */
 export function normalizeCanvasSpec(symbolSize, canvas = {}) {
-  assertSymbolSize(symbolSize);
-  if (canvas === null || typeof canvas !== 'object' || Array.isArray(canvas)) {
-    throw new TypeError('Frame QR profile: canvas must be an object');
-  }
-
-  const shape = String(canvas.shape ?? 'square').toLowerCase();
-  if (!FRAMEQR_CANVAS_SHAPES.includes(shape)) {
-    throw new RangeError(`Frame QR profile: unsupported canvas shape "${shape}"`);
-  }
-
-  const defaultSize = oddAtMost(Math.max(3, Math.round(symbolSize * 0.17)), symbolSize - 16);
-  const requestedSize = canvas.size;
-  const requestedWidth = canvas.width ?? requestedSize ?? defaultSize;
-  const requestedHeight = canvas.height ?? requestedSize ?? defaultSize;
-  const maximumDimension = symbolSize - 16;
-  for (const [name, value] of [['width', requestedWidth], ['height', requestedHeight]]) {
-    if (!Number.isFinite(Number(value)) || Number(value) < 1 || Number(value) > maximumDimension) {
-      throw new RangeError(
-        `Frame QR profile: canvas ${name} must be between 1 and ${maximumDimension} modules`
-      );
+    assertSymbolSize(symbolSize);
+    if (canvas === null || typeof canvas !== 'object' || Array.isArray(canvas)) {
+        throw new TypeError('Frame QR profile: canvas must be an object');
+    }
+    const shape = String(canvas.shape ?? 'square').toLowerCase();
+    if (!FRAMEQR_CANVAS_SHAPES.includes(shape)) {
+        throw new RangeError(`Frame QR profile: unsupported canvas shape "${shape}"`);
+    }
+    const defaultSize = oddAtMost(Math.max(3, Math.round(symbolSize * 0.17)), symbolSize - 16);
+    const requestedSize = canvas.size;
+    const requestedWidth = canvas.width ?? requestedSize ?? defaultSize;
+    const requestedHeight = canvas.height ?? requestedSize ?? defaultSize;
+    const maximumDimension = symbolSize - 16;
+    for (const [name, value] of [['width', requestedWidth], ['height', requestedHeight]]) {
+        if (!Number.isFinite(Number(value)) || Number(value) < 1 || Number(value) > maximumDimension) {
+            throw new RangeError(`Frame QR profile: canvas ${name} must be between 1 and ${maximumDimension} modules`);
+        }
     }
-  }
-  const width = oddAtMost(Number(requestedWidth), maximumDimension);
-  const height = oddAtMost(Number(requestedHeight), maximumDimension);
-  const centerX = Math.round(canvas.centerX ?? (symbolSize - 1) / 2);
-  const centerY = Math.round(canvas.centerY ?? (symbolSize - 1) / 2);
-  const angle = ((Number(canvas.angle ?? 0) % 360) + 360) % 360;
-
-  if (![0, 90, 180, 270].includes(angle)) {
-    throw new RangeError('Frame QR profile: angle must be 0, 90, 180 or 270 degrees');
-  }
-  if (centerX < 8 || centerY < 8 || centerX >= symbolSize - 8 || centerY >= symbolSize - 8) {
-    throw new RangeError('Frame QR profile: canvas centre must remain inside the finder-pattern boundary');
-  }
-
-  return { shape, centerX, centerY, width, height, angle };
+    const width = oddAtMost(Number(requestedWidth), maximumDimension);
+    const height = oddAtMost(Number(requestedHeight), maximumDimension);
+    const centerX = Math.round(canvas.centerX ?? (symbolSize - 1) / 2);
+    const centerY = Math.round(canvas.centerY ?? (symbolSize - 1) / 2);
+    const angle = ((Number(canvas.angle ?? 0) % 360) + 360) % 360;
+    if (![0, 90, 180, 270].includes(angle)) {
+        throw new RangeError('Frame QR profile: angle must be 0, 90, 180 or 270 degrees');
+    }
+    if (centerX < 8 || centerY < 8 || centerX >= symbolSize - 8 || centerY >= symbolSize - 8) {
+        throw new RangeError('Frame QR profile: canvas centre must remain inside the finder-pattern boundary');
+    }
+    return { shape, centerX, centerY, width, height, angle };
 }
-
 /**
  * Enumerate canvas modules, including any overlaps with QR function modules.
  * A conforming encoder rejects such overlaps rather than damaging function
@@ -141,50 +123,52 @@ export function normalizeCanvasSpec(symbolSize, canvas = {}) {
  * @returns {Array<[number, number]>}
  */
 export function canvasModules(symbolSize, canvas = {}) {
-  const spec = normalizeCanvasSpec(symbolSize, canvas);
-  const rotate = spec.angle === 90 || spec.angle === 270;
-  const width = rotate ? spec.height : spec.width;
-  const height = rotate ? spec.width : spec.height;
-  const halfWidth = (width - 1) / 2;
-  const halfHeight = (height - 1) / 2;
-  const modules = [];
-
-  for (let dy = -halfHeight; dy <= halfHeight; dy++) {
-    for (let dx = -halfWidth; dx <= halfWidth; dx++) {
-      const nx = halfWidth === 0 ? 0 : dx / halfWidth;
-      const ny = halfHeight === 0 ? 0 : dy / halfHeight;
-      let inside;
-      if (spec.shape === 'circle') inside = nx * nx + ny * ny <= 1 + Number.EPSILON;
-      else if (spec.shape === 'diamond') inside = Math.abs(nx) + Math.abs(ny) <= 1 + Number.EPSILON;
-      else inside = true;
-      if (inside) modules.push([spec.centerX + dx, spec.centerY + dy]);
+    const spec = normalizeCanvasSpec(symbolSize, canvas);
+    const rotate = spec.angle === 90 || spec.angle === 270;
+    const width = rotate ? spec.height : spec.width;
+    const height = rotate ? spec.width : spec.height;
+    const halfWidth = (width - 1) / 2;
+    const halfHeight = (height - 1) / 2;
+    const modules = [];
+    for (let dy = -halfHeight; dy <= halfHeight; dy++) {
+        for (let dx = -halfWidth; dx <= halfWidth; dx++) {
+            const nx = halfWidth === 0 ? 0 : dx / halfWidth;
+            const ny = halfHeight === 0 ? 0 : dy / halfHeight;
+            let inside;
+            if (spec.shape === 'circle')
+                inside = nx * nx + ny * ny <= 1 + Number.EPSILON;
+            else if (spec.shape === 'diamond')
+                inside = Math.abs(nx) + Math.abs(ny) <= 1 + Number.EPSILON;
+            else
+                inside = true;
+            if (inside)
+                modules.push([spec.centerX + dx, spec.centerY + dy]);
+        }
     }
-  }
-  return modules;
+    return modules;
 }
-
 /** Build the interleaved-codeword to RS-block map used by QR Model 2. */
 function codewordBlockMap(layout) {
-  const dataCounts = new Array(layout.blockCount);
-  for (let block = 0; block < layout.blockCount; block++) {
-    dataCounts[block] = block < layout.group1Blocks
-      ? layout.group1DataCount
-      : layout.group2DataCount;
-  }
-
-  const map = [];
-  const maxData = Math.max(...dataCounts);
-  for (let i = 0; i < maxData; i++) {
+    const dataCounts = new Array(layout.blockCount);
     for (let block = 0; block < layout.blockCount; block++) {
-      if (i < dataCounts[block]) map.push(block);
+        dataCounts[block] = block < layout.group1Blocks
+            ? layout.group1DataCount
+            : layout.group2DataCount;
+    }
+    const map = [];
+    const maxData = Math.max(...dataCounts);
+    for (let i = 0; i < maxData; i++) {
+        for (let block = 0; block < layout.blockCount; block++) {
+            if (i < dataCounts[block])
+                map.push(block);
+        }
     }
-  }
-  for (let i = 0; i < layout.eccPerBlock; i++) {
-    for (let block = 0; block < layout.blockCount; block++) map.push(block);
-  }
-  return map;
+    for (let i = 0; i < layout.eccPerBlock; i++) {
+        for (let block = 0; block < layout.blockCount; block++)
+            map.push(block);
+    }
+    return map;
 }
-
 /**
  * Calculate worst-case QR codeword damage caused by a canvas.
  * A codeword is counted if any of its modules is touched. This is conservative:
@@ -195,76 +179,74 @@ function codewordBlockMap(layout) {
  * @param {object} [canvas]
  */
 export function analyzeCanvasDamage(version, canvas = {}) {
-  if (!Number.isInteger(version) || version < 1 || version > 40) {
-    throw new RangeError(`Frame QR profile: version must be an integer 1-40, got ${version}`);
-  }
-  const symbolSize = versionSize(version);
-  const spec = normalizeCanvasSpec(symbolSize, canvas);
-  const modules = canvasModules(symbolSize, spec);
-  const reserved = reservedModules(version);
-  const reservedOverlaps = modules.filter(([x, y]) => reserved.get(x, y));
-
-  const moduleKeys = new Set(modules.map(([x, y]) => `${x},${y}`));
-  const order = dataModuleOrder(version);
-  const touchedCodewords = new Set();
-  for (let bit = 0; bit < order.length / 2; bit++) {
-    if (moduleKeys.has(`${order[bit * 2]},${order[bit * 2 + 1]}`)) touchedCodewords.add(bit >> 3);
-  }
-
-  const layout = blockLayout(version, 'H');
-  const blockMap = codewordBlockMap(layout);
-  const touchedByBlockSets = Array.from({ length: layout.blockCount }, () => new Set());
-  for (const codeword of touchedCodewords) {
-    const block = blockMap[codeword];
-    if (block !== undefined) touchedByBlockSets[block].add(codeword);
-  }
-  const touchedCodewordsByBlock = touchedByBlockSets.map((set) => set.size);
-  const correctionBudgetPerBlock = Math.floor(layout.eccPerBlock / 2);
-  const safe = reservedOverlaps.length === 0 &&
-    touchedCodewordsByBlock.every((count) => count <= correctionBudgetPerBlock);
-
-  return {
-    profile: FRAMEQR_PROFILE.id,
-    certified: false,
-    version,
-    symbolSize,
-    canvas: spec,
-    canvasModuleCount: modules.length,
-    reservedOverlaps,
-    touchedCodewordCount: touchedCodewords.size,
-    touchedCodewordsByBlock,
-    correctionBudgetPerBlock,
-    safe,
-  };
+    if (!Number.isInteger(version) || version < 1 || version > 40) {
+        throw new RangeError(`Frame QR profile: version must be an integer 1-40, got ${version}`);
+    }
+    const symbolSize = versionSize(version);
+    const spec = normalizeCanvasSpec(symbolSize, canvas);
+    const modules = canvasModules(symbolSize, spec);
+    const reserved = reservedModules(version);
+    const reservedOverlaps = modules.filter(([x, y]) => reserved.get(x, y));
+    const moduleKeys = new Set(modules.map(([x, y]) => `${x},${y}`));
+    const order = dataModuleOrder(version);
+    const touchedCodewords = new Set();
+    for (let bit = 0; bit < order.length / 2; bit++) {
+        if (moduleKeys.has(`${order[bit * 2]},${order[bit * 2 + 1]}`))
+            touchedCodewords.add(bit >> 3);
+    }
+    const layout = blockLayout(version, 'H');
+    const blockMap = codewordBlockMap(layout);
+    const touchedByBlockSets = Array.from({ length: layout.blockCount }, () => new Set());
+    for (const codeword of touchedCodewords) {
+        const block = blockMap[codeword];
+        if (block !== undefined)
+            touchedByBlockSets[block].add(codeword);
+    }
+    const touchedCodewordsByBlock = touchedByBlockSets.map((set) => set.size);
+    const correctionBudgetPerBlock = Math.floor(layout.eccPerBlock / 2);
+    const safe = reservedOverlaps.length === 0 &&
+        touchedCodewordsByBlock.every((count) => count <= correctionBudgetPerBlock);
+    return {
+        profile: FRAMEQR_PROFILE.id,
+        certified: false,
+        version,
+        symbolSize,
+        canvas: spec,
+        canvasModuleCount: modules.length,
+        reservedOverlaps,
+        touchedCodewordCount: touchedCodewords.size,
+        touchedCodewordsByBlock,
+        correctionBudgetPerBlock,
+        safe,
+    };
 }
-
 /** Validate a canvas and return the non-certifying structural analysis. */
 export function validateCanvasSpec(version, canvas = {}) {
-  return analyzeCanvasDamage(version, canvas);
+    return analyzeCanvasDamage(version, canvas);
 }
-
 /** Self-check the fixed profile contract and representative QR geometries. */
 export function validateFrameQrTables() {
-  const problems = [];
-  if (FRAMEQR_PROFILE.certified !== false || FRAMEQR_PROFILE.densoFrameQrCompatible !== false) {
-    problems.push('profile compatibility boundary must remain explicitly non-certified');
-  }
-  if (new Set(FRAMEQR_CANVAS_SHAPES).size !== FRAMEQR_CANVAS_SHAPES.length) {
-    problems.push('canvas shape identifiers must be unique');
-  }
-  for (const version of [1, 2, 3, 4, 7, 10, 20, 30, 40]) {
-    const size = versionSize(version);
-    const spec = normalizeCanvasSpec(size);
-    const modules = canvasModules(size, spec);
-    const unique = new Set(modules.map(([x, y]) => `${x},${y}`));
-    if (unique.size !== modules.length) problems.push(`v${version}: duplicate canvas modules`);
-    if (modules.some(([x, y]) => x < 0 || y < 0 || x >= size || y >= size)) {
-      problems.push(`v${version}: canvas escapes the symbol`);
+    const problems = [];
+    if (FRAMEQR_PROFILE.certified !== false || FRAMEQR_PROFILE.densoFrameQrCompatible !== false) {
+        problems.push('profile compatibility boundary must remain explicitly non-certified');
+    }
+    if (new Set(FRAMEQR_CANVAS_SHAPES).size !== FRAMEQR_CANVAS_SHAPES.length) {
+        problems.push('canvas shape identifiers must be unique');
     }
-    const analysis = analyzeCanvasDamage(version, spec);
-    if (analysis.touchedCodewordsByBlock.length !== blockLayout(version, 'H').blockCount) {
-      problems.push(`v${version}: damage analysis block count mismatch`);
+    for (const version of [1, 2, 3, 4, 7, 10, 20, 30, 40]) {
+        const size = versionSize(version);
+        const spec = normalizeCanvasSpec(size);
+        const modules = canvasModules(size, spec);
+        const unique = new Set(modules.map(([x, y]) => `${x},${y}`));
+        if (unique.size !== modules.length)
+            problems.push(`v${version}: duplicate canvas modules`);
+        if (modules.some(([x, y]) => x < 0 || y < 0 || x >= size || y >= size)) {
+            problems.push(`v${version}: canvas escapes the symbol`);
+        }
+        const analysis = analyzeCanvasDamage(version, spec);
+        if (analysis.touchedCodewordsByBlock.length !== blockLayout(version, 'H').blockCount) {
+            problems.push(`v${version}: damage analysis block count mismatch`);
+        }
     }
-  }
-  return problems;
+    return problems;
 }