@sythos/js_barcode_universal 1.2.5 → 1.4.1

package/src/compactpdf417/detector.js

@@ -0,0 +1,140 @@
+/*!
+ * Sythos Barcode Suite
+ *
+ * MIT License
+ *
+ * Copyright (c) 2026 Sythos
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
+ * SPDX-License-Identifier: MIT
+ *
+ * Original work. No code from any other barcode implementation.
+ */
+
+/** Compact PDF417 detector for clean, integer-scaled rasters. @module compactpdf417/detector */
+
+import { BitMatrix } from '../core/bit-matrix.js';
+import { compactPdf417Width } from './tables.js';
+import { decodeCompactPDF417 } from './decoder.js';
+
+function rotateClockwise(source) {
+  const out = new BitMatrix(source.height, source.width);
+  for (let y = 0; y < source.height; y++) {
+    for (let x = 0; x < source.width; x++) {
+      if (source.get(x, y)) out.set(source.height - 1 - y, x);
+    }
+  }
+  return out;
+}
+function cropAndDownsample(source, box, width, height, scale) {
+  const out = new BitMatrix(width, height);
+  for (let y = 0; y < height; y++) {
+    for (let x = 0; x < width; x++) {
+      let dark = 0;
+      for (let dy = 0; dy < scale; dy++) {
+        for (let dx = 0; dx < scale; dx++) {
+          if (source.get(box.x + x * scale + dx, box.y + y * scale + dy)) dark++;
+        }
+      }
+      if (dark * 2 >= scale * scale) out.set(x, y);
+    }
+  }
+  return out;
+}
+
+function cornersFor(box) {
+  return [
+    { x: box.x, y: box.y },
+    { x: box.x + box.width, y: box.y },
+    { x: box.x + box.width, y: box.y + box.height },
+    { x: box.x, y: box.y + box.height },
+  ];
+}
+
+function mapCorners(corners, toOriginal) {
+  return corners.map((point) => toOriginal(point));
+}
+
+/**
+ * Detect one Compact PDF417 symbol in a binarized raster.
+ *
+ * The clean-raster detector uses the dark bounding box and enumerates legal
+ * compact widths, integer module scales, row counts and row heights. It is
+ * deliberately conservative: arbitrary perspective, non-integer resampling,
+ * grayscale thresholding and damaged stop bars belong to a future photo
+ * detector and are not claimed here.
+ *
+ * @param {import('../core/bit-matrix.js').BitMatrix} binaryImage
+ * @param {object} [options]
+ * @param {number} [options.rowHeight] Restrict the row-height search.
+ * @returns {object|null}
+ */
+export function detectCompactPDF417(binaryImage, options = {}) {
+  if (!binaryImage?.width || !binaryImage?.height || typeof binaryImage.get !== 'function') return null;
+
+  let oriented = binaryImage;
+  let toOriginal = (point) => ({ x: point.x, y: point.y });
+  for (let rotation = 0; rotation < 4; rotation++) {
+    const bounds = oriented.getBounds();
+    if (bounds) {
+      for (let columns = 1; columns <= 30; columns++) {
+        const width = compactPdf417Width(columns);
+        const scale = bounds.width / width;
+        if (!Number.isInteger(scale) || scale < 1) continue;
+        const baseHeight = bounds.height / scale;
+        const rowHeights = Number.isInteger(options.rowHeight)
+          ? [options.rowHeight]
+          : Array.from({ length: 18 }, (_, index) => index + 3);
+        for (const rowHeight of rowHeights) {
+          if (!Number.isInteger(baseHeight / rowHeight)) continue;
+          const rows = baseHeight / rowHeight;
+          if (rows < 3 || rows > 90) continue;
+          const matrix = cropAndDownsample(oriented, bounds, width, baseHeight, scale);
+          try {
+            const result = decodeCompactPDF417(matrix, { rowHeight });
+            const corners = mapCorners(cornersFor(bounds), toOriginal);
+            return {
+              ...result,
+              matrix,
+              corners,
+              rotation: rotation * 90,
+              moduleSize: scale,
+              compact: true,
+            };
+          } catch {
+            // Try another geometry; a standard PDF417 or random artwork should
+            // never be accepted unless the compact decoder validates every row.
+          }
+        }
+      }
+    }
+
+    const previous = oriented;
+    const previousToOriginal = toOriginal;
+    oriented = rotateClockwise(previous);
+    toOriginal = (point) => previousToOriginal({ x: point.y, y: previous.height - point.x });
+  }
+  return null;
+}
+
+export function detectAndDecodeCompactPDF417(binaryImage, options = {}) {
+  return detectCompactPDF417(binaryImage, options);
+}

package/src/compactpdf417/encoder.js

@@ -0,0 +1,141 @@
+/*!
+ * Sythos Barcode Suite
+ *
+ * MIT License
+ *
+ * Copyright (c) 2026 Sythos
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
+ * SPDX-License-Identifier: MIT
+ *
+ * Original work. No code from any other barcode implementation.
+ */
+
+/** Compact PDF417 (truncated PDF417) encoder. @module compactpdf417/encoder */
+
+import { BitMatrix } from '../core/bit-matrix.js';
+import { EncodeError } from '../core/errors.js';
+import { compactPdf417 } from '../pdf417/compaction.js';
+import { pdf417ErrorCorrection, pdf417EccLength } from '../pdf417/error-correction.js';
+import { pdf417PatternForCodeword } from '../pdf417/tables.js';
+import {
+  COMPACT_PDF417_START,
+  compactPdf417Indicators,
+  compactPdf417Width,
+  validateCompactPdf417Options,
+} from './tables.js';
+
+function appendWidths(matrix, y, x, sequence, height) {
+  let dark = true;
+  for (const digit of sequence) {
+    const width = digit.charCodeAt(0) - 48;
+    if (!Number.isInteger(width) || width < 1 || width > 8) {
+      throw new EncodeError('Compact PDF417: invalid module-width sequence');
+    }
+    if (dark) matrix.setRegion(x, y, width, height);
+    x += width;
+    dark = !dark;
+  }
+  return x;
+}
+
+function patternSequence(pattern) {
+  return pattern.toString(2).padStart(17, '0').replace(/0+|1+/g, (run) => String(run.length));
+}
+
+function dimensions(needed, level, options, rowHeight) {
+  const ecc = pdf417EccLength(level);
+  let best = null;
+  for (let rows = options.rows ?? 3; rows <= (options.rows ?? 90); rows++) {
+    for (let columns = options.columns ?? 1; columns <= (options.columns ?? 30); columns++) {
+      if (rows * columns > 928 || rows * columns - ecc < needed) continue;
+      const ratio = compactPdf417Width(columns) / (rows * rowHeight);
+      const score = (rows * columns - ecc - needed) * 10 +
+        Math.abs(ratio - (options.aspectRatio ?? 3));
+      if (!best || score < best.score) best = { rows, columns, score };
+    }
+  }
+  if (!best) {
+    throw new EncodeError(
+      'Compact PDF417: payload does not fit the requested dimensions and error correction level'
+    );
+  }
+  return best;
+}
+
+/**
+ * Encode Compact PDF417.
+ *
+ * High-level Text/Byte/Numeric compaction is intentionally delegated to the
+ * existing PDF417 compaction implementation. `compact` here describes only
+ * the physical truncated layout: right row indicators are omitted and the
+ * stop pattern is reduced to one dark module.
+ *
+ * @param {string|Uint8Array|number[]} value
+ * @param {object} [options]
+ * @returns {import('../core/bit-matrix.js').BitMatrix}
+ */
+export function encodeCompactPDF417(value, options = {}) {
+  const rowHeight = validateCompactPdf417Options(options);
+  const level = options.eccLevel ?? 2;
+  if (!Number.isInteger(level) || level < 0 || level > 8) {
+    throw new EncodeError('Compact PDF417: eccLevel must be an integer in 0..8');
+  }
+
+  const payload = compactPdf417(value, { compaction: options.compaction, charset: options.charset });
+  const { rows, columns } = dimensions(payload.length + 1, level, options, rowHeight);
+  const eccLength = pdf417EccLength(level);
+  const dataLength = rows * columns - eccLength;
+  const data = [dataLength, ...payload];
+  while (data.length < dataLength) data.push(900);
+  const codewords = data.concat(pdf417ErrorCorrection(data, level));
+
+  const matrix = new BitMatrix(compactPdf417Width(columns), rows * rowHeight);
+  for (let row = 0; row < rows; row++) {
+    const y = row * rowHeight;
+    const cluster = (row % 3) * 3;
+    let x = appendWidths(matrix, y, 0, COMPACT_PDF417_START, rowHeight);
+    const left = compactPdf417Indicators(row, rows, columns, level);
+    x = appendWidths(matrix, y, x, patternSequence(pdf417PatternForCodeword(left, cluster)), rowHeight);
+    for (let column = 0; column < columns; column++) {
+      const codeword = codewords[row * columns + column];
+      x = appendWidths(matrix, y, x,
+        patternSequence(pdf417PatternForCodeword(codeword, cluster)), rowHeight);
+    }
+    // Compact PDF417 terminates every row with one dark module, not the normal
+    // right indicator plus 18-module stop pattern.
+    matrix.setRegion(x, y, 1, rowHeight);
+    x++;
+    if (x !== matrix.width) throw new EncodeError('Compact PDF417: internal row width mismatch');
+  }
+
+  matrix.compactPdf417 = {
+    rows,
+    columns,
+    eccLevel: level,
+    rowHeight,
+    codewords,
+    layout: 'compact',
+  };
+  return matrix;
+}
+
+export { dimensions as compactPdf417Dimensions };

package/src/compactpdf417/index.js

@@ -0,0 +1,22 @@
+/*!
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
+ * SPDX-License-Identifier: MIT
+ */
+
+/* Compact PDF417 public module exports. */
+
+export {
+  COMPACT_PDF417_START,
+  COMPACT_PDF417_START_BITS,
+  COMPACT_PDF417_STOP_MODULES,
+  COMPACT_PDF417_LIMITS,
+  compactPdf417Width,
+  compactPdf417Geometry,
+  compactPdf417Indicators,
+  compactPdf417MatchingLevels,
+  validateCompactPdf417Options,
+  validateCompactPdf417Tables,
+} from './tables.js';
+export { encodeCompactPDF417, compactPdf417Dimensions } from './encoder.js';
+export { decodeCompactPDF417 } from './decoder.js';
+export { detectCompactPDF417, detectAndDecodeCompactPDF417 } from './detector.js';

package/src/compactpdf417/tables.js

@@ -0,0 +1,174 @@
+/*!
+ * Sythos Barcode Suite
+ *
+ * MIT License
+ *
+ * Copyright (c) 2026 Sythos
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
+ * SPDX-License-Identifier: MIT
+ *
+ * Original work. No code from any other barcode implementation.
+ */
+
+/**
+ * Compact (truncated) PDF417 layout.
+ *
+ * Compact PDF417 is a geometric variant of PDF417, not a new high-level
+ * compaction mode. It keeps the same codeword, cluster, row-indicator,
+ * Reed–Solomon and Text/Byte/Numeric compaction rules, while omitting each
+ * row's right row indicator and replacing the normal stop pattern with a
+ * single dark module. The resulting symbol remains distinguishable from the
+ * ordinary PDF417 layout by its width and row terminator.
+ *
+ * @module compactpdf417/tables
+ */
+
+import { EncodeError } from '../core/errors.js';
+
+/** PDF417 start pattern, in module widths. */
+export const COMPACT_PDF417_START = '81111113';
+
+/** Binary module representation of the start pattern. */
+export const COMPACT_PDF417_START_BITS = '11111111010101000';
+
+/** Compact PDF417's reduced stop is one dark module. */
+export const COMPACT_PDF417_STOP_MODULES = 1;
+
+/** Minimum/maximum number of rows and data columns. */
+export const COMPACT_PDF417_LIMITS = Object.freeze({
+  minRows: 3,
+  maxRows: 90,
+  minColumns: 1,
+  maxColumns: 30,
+  maxCodewords: 928,
+});
+
+/**
+ * Return the printed width in modules for a compact symbol.
+ *
+ * 17 start + 17 left indicator + 17 per codeword column + 1 reduced stop.
+ * @param {number} columns
+ */
+export function compactPdf417Width(columns) {
+  if (!Number.isInteger(columns) || columns < 1 || columns > 30) {
+    throw new RangeError(`Compact PDF417: columns must be an integer in 1..30, got ${columns}`);
+  }
+  return 35 + columns * 17;
+}
+
+/**
+ * Validate a compact matrix geometry and return its dimensions.
+ *
+ * @param {number} width
+ * @param {number} height
+ * @param {number} rowHeight
+ */
+export function compactPdf417Geometry(width, height, rowHeight = 3) {
+  if (!Number.isInteger(width) || !Number.isInteger(height)) {
+    throw new RangeError('Compact PDF417: matrix dimensions must be integers');
+  }
+  if (!Number.isInteger(rowHeight) || rowHeight < 1) {
+    throw new RangeError('Compact PDF417: rowHeight must be a positive integer');
+  }
+  if ((width - 35) % 17 !== 0) {
+    throw new RangeError(`Compact PDF417: width ${width} does not match the compact layout`);
+  }
+  const columns = (width - 35) / 17;
+  const rows = height / rowHeight;
+  if (!Number.isInteger(rows) || rows < 3 || rows > 90) {
+    throw new RangeError(`Compact PDF417: rows must be an integer in 3..90, got ${rows}`);
+  }
+  if (columns < 1 || columns > 30) {
+    throw new RangeError(`Compact PDF417: columns must be an integer in 1..30, got ${columns}`);
+  }
+  return { rows, columns, rowHeight, width, height };
+}
+
+/**
+ * Validate encoder dimensions before codeword packing.
+ * @param {object} options
+ */
+export function validateCompactPdf417Options(options = {}) {
+  const { minRows, maxRows, minColumns, maxColumns } = COMPACT_PDF417_LIMITS;
+  const rowHeight = options.rowHeight ?? 3;
+  if (!Number.isInteger(rowHeight) || rowHeight < 3) {
+    throw new EncodeError('Compact PDF417: rowHeight must be an integer of at least 3');
+  }
+  for (const [name, value, min, max] of [
+    ['rows', options.rows, minRows, maxRows],
+    ['columns', options.columns, minColumns, maxColumns],
+  ]) {
+    if (value !== undefined && (!Number.isInteger(value) || value < min || value > max)) {
+      throw new EncodeError(`Compact PDF417: ${name} must be an integer in ${min}..${max}`);
+    }
+  }
+  if (options.aspectRatio !== undefined &&
+      (!Number.isFinite(options.aspectRatio) || options.aspectRatio <= 0)) {
+    throw new EncodeError('Compact PDF417: aspectRatio must be positive');
+  }
+  return rowHeight;
+}
+
+/**
+ * The row indicator values used by ordinary PDF417 are retained unchanged.
+ * Compact symbols omit only the right indicator, so the left indicator still
+ * carries the row group, row count, error-correction level and column count.
+ */
+export function compactPdf417Indicators(row, rows, columns, level) {
+  const group = Math.floor(row / 3);
+  const y = Math.floor((rows - 1) / 3);
+  const z = level * 3 + (rows - 1) % 3;
+  const v = columns - 1;
+  if (row % 3 === 0) return 30 * group + y;
+  if (row % 3 === 1) return 30 * group + z;
+  return 30 * group + v;
+}
+
+/**
+ * Return all standard ECC levels which agree with the observed left
+ * indicators. This is kept as a table helper so decoder and tests share the
+ * same compact-layout rule.
+ */
+export function compactPdf417MatchingLevels(leftIndicators, rows, columns) {
+  const matches = [];
+  for (let level = 0; level <= 8; level++) {
+    if (leftIndicators.every((value, row) =>
+      value === compactPdf417Indicators(row, rows, columns, level))) matches.push(level);
+  }
+  return matches;
+}
+
+/** Validate representative layout invariants. */
+export function validateCompactPdf417Tables() {
+  const problems = [];
+  for (const columns of [1, 2, 3, 10, 30]) {
+    const width = compactPdf417Width(columns);
+    if (width !== 35 + columns * 17) problems.push(`columns ${columns}: width mismatch`);
+  }
+  for (const rows of [3, 4, 5, 6, 90]) {
+    const left = Array.from({ length: rows }, (_, row) => compactPdf417Indicators(row, rows, 3, 2));
+    if (compactPdf417MatchingLevels(left, rows, 3).length !== 1) {
+      problems.push(`rows ${rows}: row indicators do not identify one ECC level`);
+    }
+  }
+  return problems;
+}

package/src/core/bit-buffer.js

@@ -23,6 +23,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
  * SPDX-License-Identifier: MIT
  *
  * Original work. No code from any other barcode implementation.

package/src/core/bit-matrix.js

@@ -23,6 +23,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
  * SPDX-License-Identifier: MIT
  *
  * Original work. No code from any other barcode implementation.

package/src/core/errors.js

@@ -23,6 +23,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
  * SPDX-License-Identifier: MIT
  *
  * Original work. No code from any other barcode implementation.

package/src/core/galois-field.js

@@ -23,6 +23,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
  * SPDX-License-Identifier: MIT
  *
  * Original work. No code from any other barcode implementation.

package/src/core/index.js

@@ -23,6 +23,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
  * SPDX-License-Identifier: MIT
  *
  * Original work. No code from any other barcode implementation.

package/src/core/reed-solomon.js

@@ -23,6 +23,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
  * SPDX-License-Identifier: MIT
  *
  * Original work. No code from any other barcode implementation.