@sythos/js_barcode_universal 1.5.13 → 1.5.15

package/src/js/oned/code25.js

@@ -0,0 +1,148 @@
+/*!
+ * Sythos Barcode Suite
+ *
+ * MIT License
+ *
+ * Copyright (c) 2026 Sythos
+ * SPDX-FileCopyrightText: 2026 Sythos (https://www.sythos.net)
+ *
+ * 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-License-Identifier: MIT
+ *
+ * Original work. No code from any other barcode implementation.
+ */
+/**
+ * Code 25 family writers.
+ *
+ * Code 25 (also called Standard or Industrial 2 of 5) represents each digit
+ * with five alternating bar/space elements, exactly two of the bars being wide.
+ * IATA 2 of 5 uses the same digit grammar with a shorter start/stop frame.
+ * The width descriptions below are expressed as module counts rather than
+ * copied implementation tables and are checked by the focused test suite.
+ *
+ * @module oned/code25
+ */
+import { BitMatrix } from '../core/bit-matrix.js';
+import { EncodeError } from '../core/errors.js';
+/** The ten digit patterns, each with five bars and five spaces. */
+export const CODE25_DIGIT_PATTERNS = [
+    '1111313111', '3111111131', '1131111131', '3131111111',
+    '1111311131', '3111311111', '1131311111', '1111113131',
+    '3111113111', '1131113111',
+];
+/** Start/stop run widths for the three public names. */
+export const CODE25_VARIANTS = {
+    // Code 25 and Industrial 2 of 5 share the discrete two-wide-bar grammar
+    // and canonical industrial frame. `standard` is the friendly API alias.
+    standard: { id: 'industrial2of5', label: 'Standard 2 of 5 (Code 25)', start: '313111', stop: '31113' },
+    industrial: { id: 'industrial2of5', label: 'Industrial 2 of 5', start: '313111', stop: '31113' },
+    iata: { id: 'iata2of5', label: 'IATA 2 of 5', start: '1111', stop: '311' },
+};
+const MAX_CODE25_DIGITS = 500;
+function requireDigits(value, label) {
+    const text = String(value);
+    if (!/^[0-9]+$/u.test(text)) {
+        throw new EncodeError(`${label}: payload must be digits only, got "${value}"`);
+    }
+    if (text.length === 0 || text.length > MAX_CODE25_DIGITS) {
+        throw new EncodeError(`${label}: payload length must be in 1..${MAX_CODE25_DIGITS}`);
+    }
+    return text;
+}
+/** Modulo-10 Code 25 check digit (alternating weights from the right). */
+export function code25CheckDigit(value) {
+    let sum = 0;
+    for (let i = 0; i < value.length; i++) {
+        const fromRight = value.length - 1 - i;
+        sum += Number(value[i]) * (fromRight % 2 === 0 ? 3 : 1);
+    }
+    return (10 - (sum % 10)) % 10;
+}
+function expandWidths(widths, wideRatio) {
+    let modules = '';
+    for (let i = 0; i < widths.length; i++) {
+        const width = Number(widths[i]);
+        const count = width > 1 ? wideRatio : 1;
+        modules += (i % 2 === 0 ? '1' : '0').repeat(count);
+    }
+    return modules;
+}
+function toMatrix(modules) {
+    const matrix = new BitMatrix(modules.length, 1);
+    for (let x = 0; x < modules.length; x++) {
+        if (modules[x] === '1')
+            matrix.set(x, 0);
+    }
+    return matrix;
+}
+function resolveVariant(value) {
+    const variant = String(value ?? 'standard').toLowerCase();
+    if (variant === 'industrial' || variant === 'industrial2of5' || variant === 'industrial-2-of-5')
+        return 'industrial';
+    if (variant === 'iata' || variant === 'iata2of5' || variant === 'iata-2-of-5')
+        return 'iata';
+    if (variant === 'standard' || variant === 'code2of5' || variant === 'code-2-of-5' || variant === 'standard2of5' || variant === 'standard-2-of-5')
+        return 'standard';
+    throw new EncodeError(`Code 25: unknown variant "${value}"`);
+}
+/**
+ * Encode one of the Code 25 family profiles.
+ *
+ * `checkDigit` is opt-in because the base symbologies do not require one. A
+ * camera-profile decoder will require and validate it before promoting a read.
+ *
+ * @param {string} value Numeric payload.
+ * @param {object} [options]
+ * @param {Code25Variant|string} [options.variant='standard'] Framing profile.
+ * @param {boolean} [options.checkDigit] Append a modulo-10 check digit.
+ * @param {number} [options.wideRatio=3] Number of modules in a wide bar.
+ * @returns {BitMatrix}
+ */
+export function encodeCode25(value, options = {}) {
+    const variant = resolveVariant(options.variant);
+    const profile = CODE25_VARIANTS[variant];
+    const label = profile.label;
+    const ratio = options.wideRatio ?? 3;
+    if (!Number.isInteger(ratio) || ratio < 2 || ratio > 8) {
+        throw new EncodeError(`${label}: wideRatio must be an integer in 2..8`);
+    }
+    let digits = requireDigits(value, label);
+    if (options.checkDigit === true)
+        digits += String(code25CheckDigit(digits));
+    let modules = expandWidths(profile.start, ratio);
+    for (const digit of digits)
+        modules += expandWidths(CODE25_DIGIT_PATTERNS[Number(digit)], ratio);
+    modules += expandWidths(profile.stop, ratio);
+    return toMatrix(modules);
+}
+/** Encode Standard 2 of 5 (the canonical Code 25 frame). */
+export function encodeStandard2of5(value, options = {}) {
+    return encodeCode25(value, { ...options, variant: 'standard' });
+}
+/** Encode Industrial 2 of 5. */
+export function encodeIndustrial2of5(value, options = {}) {
+    return encodeCode25(value, { ...options, variant: 'industrial' });
+}
+/** Encode IATA 2 of 5. */
+export function encodeIATA2of5(value, options = {}) {
+    return encodeCode25(value, { ...options, variant: 'iata' });
+}
+/** Internal limit used by the scanline reader and its safety checks. */
+export const CODE25_MAX_DIGITS = MAX_CODE25_DIGITS;

package/src/js/oned/index.js

@@ -32,12 +32,18 @@
  *
  * @module oned
  */
-export { encodeEAN13, encodeEAN8, encodeUPCA, encodeUPCE, encodeISBN, encodeCode39, encodeCode93, encodeCode128, encodeITF, encodeITF14, encodeCodabar, encodeCode11, encodeMSI, encodePharmacode, ean13CheckDigit, } from './writers.js';
+export { encodeEAN13, encodeEAN8, encodeUPCA, encodeUPCE, encodeISBN, encodeCode39, encodeCode93, encodeCode128, code128DataCodewords, encodeITF, encodeITF14, encodeCodabar, encodeCode11, encodeMSI, encodePharmacode, encodeCode32, encodePZN, code32CheckDigit, decodeCode32Payload, decodePZNPayload, ean13CheckDigit, } from './writers.js';
+export { CODE25_DIGIT_PATTERNS, CODE25_VARIANTS, CODE25_MAX_DIGITS, code25CheckDigit, encodeCode25, encodeStandard2of5, encodeIndustrial2of5, encodeIATA2of5, } from './code25.js';
+export { TELEPEN_START_VALUE, TELEPEN_STOP_VALUE, TELEPEN_MAX_LENGTH, telepenPattern, encodeTelepen, encodeTelepenNumeric, decodeTelepen, decodeTelepenNumeric, } from './telepen.js';
 export { EAN2_PARITY, EAN5_PARITY, EAN2_WIDTH, EAN5_WIDTH, EAN_ADDON_START, EAN_ADDON_SEPARATOR, ean2Parity, ean5Checksum, ean5CheckDigit, ean5Parity, encodeEAN2, encodeEAN5, encodeEANAddon, encodeEANAddOn, decodeEAN2, decodeEAN5, decodeEANAddon, decodeEANAddOn, composeEANAddon, encodeEAN13WithAddon, encodeEAN8WithAddon, encodeUPCAWithAddon, encodeUPCEWithAddon, } from './addons.js';
-export { decodeOneD, decodeOneDStrict, decodeCode11, decodeMSI, patternVariance, recordPattern, toNarrowWidePattern, } from './reader.js';
+export { decodeOneD, decodeOneDStrict, decodeCode32, decodePZN, decodeCode25, decodeStandard2of5, decodeIndustrial2of5, decodeIATA2of5, decodeCode11, decodeMSI, patternVariance, recordPattern, toNarrowWidePattern, } from './reader.js';
+export { POSTAL_FORMATS, POSTAL_ALIASES, STATE_PROFILES, encodePostnet, encodePlanet, encodeRM4SCC, encodeKIX, encodeAustraliaPost, encodeJapanPost, encodeIMB, decodePostal, } from './postal.js';
 export { validateTables } from './patterns.js';
-import { encodeEAN13, encodeEAN8, encodeUPCA, encodeUPCE, encodeISBN, encodeCode39, encodeCode93, encodeCode128, encodeITF, encodeITF14, encodeCodabar, encodeCode11, encodeMSI, encodePharmacode, } from './writers.js';
+import { encodeEAN13, encodeEAN8, encodeUPCA, encodeUPCE, encodeISBN, encodeCode39, encodeCode93, encodeCode128, encodeITF, encodeITF14, encodeCodabar, encodeCode11, encodeMSI, encodePharmacode, encodeCode32, encodePZN, } from './writers.js';
 import { encodeEAN2, encodeEAN5 } from './addons.js';
+import { encodeTelepen } from './telepen.js';
+import { encodeIndustrial2of5, encodeIATA2of5 } from './code25.js';
+import { encodePostnet, encodePlanet, encodeRM4SCC, encodeKIX, encodeAustraliaPost, encodeJapanPost, encodeIMB, } from './postal.js';
 /**
  * Writers by format id, for the top-level `encode()` dispatcher.
  *
@@ -64,12 +70,24 @@ export const ONED_FORMATS = {
     code93: { encode: encodeCode93, readable: true, label: 'Code 93' },
     itf: { encode: encodeITF, readable: true, label: 'ITF (Interleaved 2 of 5)' },
     itf14: { encode: encodeITF14, readable: true, label: 'ITF-14' },
+    industrial2of5: { encode: encodeIndustrial2of5, readable: true, label: 'Industrial 2 of 5' },
+    iata2of5: { encode: encodeIATA2of5, readable: true, label: 'IATA 2 of 5' },
     codabar: { encode: encodeCodabar, readable: true, label: 'Codabar' },
     code11: { encode: encodeCode11, readable: true, label: 'Code 11' },
     msi: { encode: encodeMSI, readable: true, label: 'MSI Plessey' },
+    code32: { encode: encodeCode32, readable: true, label: 'Code 32 (Italian Pharmacode)' },
+    pzn: { encode: encodePZN, readable: true, label: 'PZN (Pharmazentralnummer)' },
+    telepen: { encode: encodeTelepen, readable: true, label: 'Telepen' },
     pharmacode: { encode: encodePharmacode, readable: false, label: 'Pharmacode' },
     // Supplements are reported as readable capabilities, but the image reader
     // only accepts them when attached to a validated EAN/UPC parent symbol.
     ean2: { encode: encodeEAN2, readable: true, role: 'supplement', label: 'EAN-2 supplement' },
     ean5: { encode: encodeEAN5, readable: true, role: 'supplement', label: 'EAN-5 supplement' },
+    postnet: { encode: encodePostnet, readable: true, label: 'USPS POSTNET' },
+    planet: { encode: encodePlanet, readable: true, label: 'USPS PLANET' },
+    rm4scc: { encode: encodeRM4SCC, readable: true, label: 'Royal Mail 4-State (RM4SCC)' },
+    kix: { encode: encodeKIX, readable: true, label: 'KIX postal code' },
+    auspost: { encode: encodeAustraliaPost, readable: true, label: 'Australia Post 4-State' },
+    japanpost: { encode: encodeJapanPost, readable: true, label: 'Japan Post 4-State' },
+    imb: { encode: encodeIMB, readable: true, label: 'USPS Intelligent Mail (IMb)' },
 };