label-printer 0.9.1 → 0.10.0

package/dist/index.d.mts

@@ -102,7 +102,7 @@ interface CommandGenerator<T extends Command> {
     line: (start: Point, end: Point, thickness: number) => T;
     image: (image: BitmapLike, x: number, y: number, mode?: GraphicMode) => T;
     qrCode: (content: string, width: number, x: number, y: number) => T;
-    barCode: (content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment) => T;
+    barCode: (content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment, barWidth?: number) => T;
     /**
      * Should instruct the printer to display the image of the label on its screen instead of printing it
      */
@@ -162,7 +162,7 @@ type LabelDirection = "normal" | "inverse";
 type ECCLevel = "L" | "M" | "Q" | "H";
 type AutoManual = "A" | "M";
 type QRModel = "M1" | "M2";
-type BarcodeType = "CODE128" | "EAN13" | "EAN8" | "EAN5" | "EAN2" | "UPC" | "CODE39" | "ITF14" | "MSI10" | "MSI11" | "MSI1010" | "MSI1110" | "pharmacode" | "codabar";
+type BarcodeType = "128" | "EAN128" | "25" | "25C" | "39" | "39C" | "93" | "EAN13" | "EAN13+2" | "EAN13+5" | "EAN8" | "EAN8+2" | "EAN8+5" | "CODA" | "POST" | "UPCA" | "UPCA+2" | "UPCA+5" | "UPCE" | "UPCE+2" | "UPCE+5" | "CPOST" | "MSI" | "MSIC" | "PLESSEY" | "ITF14" | "EAN14" | "11" | "TELEPEN" | "TELEPENN" | "PLANET" | "CODE49" | "DPI" | "DPL";
 type BarcodeHumanReable = "none" | "left" | "right" | "center";
 
 /**
@@ -420,7 +420,16 @@ declare class TSPLCommandGenerator implements CommandGenerator<TSPLCommand> {
     line(start: Point, end: Point, thickness: number): TSPLCommand;
     image(image: BitmapLike, x: number, y: number, mode?: GraphicMode | undefined): TSPLCommand;
     qrCode(content: string, width: number, x: number, y: number): TSPLCommand;
-    barCode(content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment): TSPLCommand;
+    barCode(content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment, barWidth?: number): TSPLCommand;
+    /**
+     * Calculates the narrow and wide element widths for a barcode type based on the
+     * TSPL documentation's standard narrow:wide ratios.
+     *
+     * Types that only support 1:1 (continuous barcodes like CODE128, EAN, UPC) get
+     * narrow === wide. All other types use the 1:3 ratio, which is the industry
+     * standard for variable-ratio symbologies (CODE39, ITF14, codabar, MSI…).
+     */
+    private static narrowWideFor;
     private cellCount;
 }
 declare const _default: TSPLCommandGenerator;
@@ -514,6 +523,8 @@ type PrintConfig = {
     /** Width of the text in dots */
     textWidth: (text: string, font: FontOption) => number;
     getFontName: (font: FontOption) => string;
+    /** Factor to correct text width measurement vs printer rendering (default 1.0, typical 0.9-1.0) */
+    textWidthCorrectionFactor: number;
 };
 /**
  * A component that can be directly printed to label printer
@@ -565,10 +576,18 @@ declare class Label extends Printable {
     */
     private fields;
     private fontCounter;
+    private _textWidthCorrectionFactor;
     /**
      * Configuration used when generating commands
      */
     get printConfig(): PrintConfig;
+    /**
+     * Sets a correction factor for text width measurement.
+     * Values < 1.0 make text wrap less aggressively (more chars per line).
+     * Useful when the printer renders text narrower than fontkit measures.
+     * @param factor Correction factor (default 1.0, typical range 0.9-1.0)
+     */
+    setTextWidthCorrectionFactor(factor: number): void;
     constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number, density?: number);
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
@@ -653,7 +672,6 @@ declare class Text extends LabelField {
     private type;
     private context;
     private readonly lineSpacing;
-    private endsWithBreak;
     /**
      * Width of the text.
      * If set, the text will be clipped to this size
@@ -664,6 +682,7 @@ declare class Text extends LabelField {
      * Height of the text box, if empty and the type is multiline, the box can grow infinitely
      */
     private height;
+    private endsWithBreak;
     constructor(content: string, x: number, y: number, formatted?: boolean);
     /**
      * Sets the field to single line
@@ -720,10 +739,20 @@ declare class BarCode extends LabelField {
     private readonly y;
     private readonly type;
     private readonly height;
+    private readonly barWidth;
     private rotation;
     private humanReadable;
     private readonly alignment;
-    constructor(content: string, x: number, y: number, type: BarcodeType, height: number);
+    /**
+     * @param content Content to encode
+     * @param x X coordinate in dots
+     * @param y Y coordinate in dots
+     * @param type Barcode symbology
+     * @param height Height of the barcode in dots
+     * @param barWidth Width of the narrow bar element in dots. The wide element width is
+     *                 calculated automatically based on the symbology's standard ratio.
+     */
+    constructor(content: string, x: number, y: number, type: BarcodeType, height: number, barWidth?: number);
     setRotation(rotation: Rotation): void;
     setHumanReadable(humanReadable: BarcodeHumanReable): void;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;

package/dist/index.d.ts

@@ -102,7 +102,7 @@ interface CommandGenerator<T extends Command> {
     line: (start: Point, end: Point, thickness: number) => T;
     image: (image: BitmapLike, x: number, y: number, mode?: GraphicMode) => T;
     qrCode: (content: string, width: number, x: number, y: number) => T;
-    barCode: (content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment) => T;
+    barCode: (content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment, barWidth?: number) => T;
     /**
      * Should instruct the printer to display the image of the label on its screen instead of printing it
      */
@@ -162,7 +162,7 @@ type LabelDirection = "normal" | "inverse";
 type ECCLevel = "L" | "M" | "Q" | "H";
 type AutoManual = "A" | "M";
 type QRModel = "M1" | "M2";
-type BarcodeType = "CODE128" | "EAN13" | "EAN8" | "EAN5" | "EAN2" | "UPC" | "CODE39" | "ITF14" | "MSI10" | "MSI11" | "MSI1010" | "MSI1110" | "pharmacode" | "codabar";
+type BarcodeType = "128" | "EAN128" | "25" | "25C" | "39" | "39C" | "93" | "EAN13" | "EAN13+2" | "EAN13+5" | "EAN8" | "EAN8+2" | "EAN8+5" | "CODA" | "POST" | "UPCA" | "UPCA+2" | "UPCA+5" | "UPCE" | "UPCE+2" | "UPCE+5" | "CPOST" | "MSI" | "MSIC" | "PLESSEY" | "ITF14" | "EAN14" | "11" | "TELEPEN" | "TELEPENN" | "PLANET" | "CODE49" | "DPI" | "DPL";
 type BarcodeHumanReable = "none" | "left" | "right" | "center";
 
 /**
@@ -420,7 +420,16 @@ declare class TSPLCommandGenerator implements CommandGenerator<TSPLCommand> {
     line(start: Point, end: Point, thickness: number): TSPLCommand;
     image(image: BitmapLike, x: number, y: number, mode?: GraphicMode | undefined): TSPLCommand;
     qrCode(content: string, width: number, x: number, y: number): TSPLCommand;
-    barCode(content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment): TSPLCommand;
+    barCode(content: string, x: number, y: number, type: BarcodeType, height: number, rotation: Rotation, humanReadable: BarcodeHumanReable, alignment: Alignment, barWidth?: number): TSPLCommand;
+    /**
+     * Calculates the narrow and wide element widths for a barcode type based on the
+     * TSPL documentation's standard narrow:wide ratios.
+     *
+     * Types that only support 1:1 (continuous barcodes like CODE128, EAN, UPC) get
+     * narrow === wide. All other types use the 1:3 ratio, which is the industry
+     * standard for variable-ratio symbologies (CODE39, ITF14, codabar, MSI…).
+     */
+    private static narrowWideFor;
     private cellCount;
 }
 declare const _default: TSPLCommandGenerator;
@@ -514,6 +523,8 @@ type PrintConfig = {
     /** Width of the text in dots */
     textWidth: (text: string, font: FontOption) => number;
     getFontName: (font: FontOption) => string;
+    /** Factor to correct text width measurement vs printer rendering (default 1.0, typical 0.9-1.0) */
+    textWidthCorrectionFactor: number;
 };
 /**
  * A component that can be directly printed to label printer
@@ -565,10 +576,18 @@ declare class Label extends Printable {
     */
     private fields;
     private fontCounter;
+    private _textWidthCorrectionFactor;
     /**
      * Configuration used when generating commands
      */
     get printConfig(): PrintConfig;
+    /**
+     * Sets a correction factor for text width measurement.
+     * Values < 1.0 make text wrap less aggressively (more chars per line).
+     * Useful when the printer renders text narrower than fontkit measures.
+     * @param factor Correction factor (default 1.0, typical range 0.9-1.0)
+     */
+    setTextWidthCorrectionFactor(factor: number): void;
     constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number, density?: number);
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
@@ -653,7 +672,6 @@ declare class Text extends LabelField {
     private type;
     private context;
     private readonly lineSpacing;
-    private endsWithBreak;
     /**
      * Width of the text.
      * If set, the text will be clipped to this size
@@ -664,6 +682,7 @@ declare class Text extends LabelField {
      * Height of the text box, if empty and the type is multiline, the box can grow infinitely
      */
     private height;
+    private endsWithBreak;
     constructor(content: string, x: number, y: number, formatted?: boolean);
     /**
      * Sets the field to single line
@@ -720,10 +739,20 @@ declare class BarCode extends LabelField {
     private readonly y;
     private readonly type;
     private readonly height;
+    private readonly barWidth;
     private rotation;
     private humanReadable;
     private readonly alignment;
-    constructor(content: string, x: number, y: number, type: BarcodeType, height: number);
+    /**
+     * @param content Content to encode
+     * @param x X coordinate in dots
+     * @param y Y coordinate in dots
+     * @param type Barcode symbology
+     * @param height Height of the barcode in dots
+     * @param barWidth Width of the narrow bar element in dots. The wide element width is
+     *                 calculated automatically based on the symbology's standard ratio.
+     */
+    constructor(content: string, x: number, y: number, type: BarcodeType, height: number, barWidth?: number);
     setRotation(rotation: Rotation): void;
     setHumanReadable(humanReadable: BarcodeHumanReable): void;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;

package/dist/index.js

@@ -271,11 +271,6 @@ function dotToPoint(dots, dpi) {
   const inch = dots / dpi;
   return Math.round(inch * pointsPerInch);
 }
-function pointsToDots(points, dpi) {
-  const pointsPerInch2 = 72;
-  const dots = points * dpi / pointsPerInch2;
-  return dots;
-}
 
 // src/helpers/ImageDataParser.ts
 function parsePNG(buffer2) {
@@ -1507,7 +1502,7 @@ var QRLengthMapping = {
 };
 
 // src/commands/tspl/TSPLCommandGenerator.ts
-var TSPLCommandGenerator = class {
+var TSPLCommandGenerator = class _TSPLCommandGenerator {
   commandGroup(commands) {
     return new TSPLCommandGroup(commands);
   }
@@ -1548,8 +1543,41 @@ var TSPLCommandGenerator = class {
     const cellWidth = Math.round(width / cellCount);
     return new TSPLQRCommand(`A${content}`, x, y, cellWidth, "H", "M");
   }
-  barCode(content, x, y, type, height, rotation, humanReadable, alignment) {
-    return new TSPLBarcodeCommand(x, y, type, height, 1, 1, content, rotation, humanReadable, alignment);
+  barCode(content, x, y, type, height, rotation, humanReadable, alignment, barWidth = 2) {
+    const { narrow, wide } = _TSPLCommandGenerator.narrowWideFor(type, barWidth);
+    return new TSPLBarcodeCommand(x, y, type, height, narrow, wide, content, rotation, humanReadable, alignment);
+  }
+  /**
+   * Calculates the narrow and wide element widths for a barcode type based on the
+   * TSPL documentation's standard narrow:wide ratios.
+   *
+   * Types that only support 1:1 (continuous barcodes like CODE128, EAN, UPC) get
+   * narrow === wide. All other types use the 1:3 ratio, which is the industry
+   * standard for variable-ratio symbologies (CODE39, ITF14, codabar, MSI…).
+   */
+  static narrowWideFor(type, barWidth) {
+    switch (type) {
+      case "25":
+      case "25C":
+      case "39":
+      case "39C":
+      case "93":
+      case "CODA":
+      case "MSI":
+      case "MSIC":
+      case "PLESSEY":
+      case "ITF14":
+      case "11":
+      case "TELEPEN":
+      case "TELEPENN":
+      case "DPI":
+      case "DPL":
+        return { narrow: barWidth, wide: 3 * barWidth };
+      case "CPOST":
+        return { narrow: barWidth, wide: barWidth * 7 / 3 };
+      default:
+        return { narrow: barWidth, wide: barWidth };
+    }
   }
   cellCount(content) {
     const limits = Object.keys(QRLengthMapping).map((limit) => Number(limit)).sort((a, b) => a - b);
@@ -1665,6 +1693,8 @@ var StringUtils = class {
   }
 };
 var isWhitespace = (text) => text.trim() === "";
+var BREAK_AFTER_CHARS = /* @__PURE__ */ new Set([",", ";", ":", "."]);
+var isBreakAfterChar = (ch) => BREAK_AFTER_CHARS.has(ch);
 
 // src/helpers/USBUtils.ts
 var unsupportedUsbError = "usb-unsupported";
@@ -2081,7 +2111,6 @@ var TSPLPrinter = class _TSPLPrinter extends Printer {
   static try(device) {
     return __async(this, null, function* () {
       if (!device.opened) yield device.openAndConfigure();
-      console.log("Response: ", device.opened);
       const testCommand = new TSPLRawCommand("~!I");
       yield testCommand.writeTo(device);
       const response = yield device.readString(64);
@@ -2423,6 +2452,7 @@ var Label = class extends Printable {
     */
     this.fields = [];
     this.fontCounter = 0;
+    this._textWidthCorrectionFactor = 0.935;
     this.width = width;
     this.height = height;
     this.unitSystem = dimensionUnit;
@@ -2440,16 +2470,24 @@ var Label = class extends Printable {
         if (indexedFont == null) {
           return text.length * font.size;
         } else {
-          const size = dotToPoint(font.size, this.dpi);
           const fontObject = indexedFont.font;
           const run = fontObject.layout(text);
-          const scaledWidth = size * run.advanceWidth / fontObject.unitsPerEm;
-          return pointsToDots(scaledWidth, this.dpi);
+          return font.size * this._textWidthCorrectionFactor * run.advanceWidth / fontObject.unitsPerEm;
         }
       },
-      getFontName: this.getFontName.bind(this)
+      getFontName: this.getFontName.bind(this),
+      textWidthCorrectionFactor: this._textWidthCorrectionFactor
     };
   }
+  /**
+   * Sets a correction factor for text width measurement.
+   * Values < 1.0 make text wrap less aggressively (more chars per line).
+   * Useful when the printer renders text narrower than fontkit measures.
+   * @param factor Correction factor (default 1.0, typical range 0.9-1.0)
+   */
+  setTextWidthCorrectionFactor(factor) {
+    this._textWidthCorrectionFactor = factor;
+  }
   commandForLanguage(language, config) {
     return __async(this, null, function* () {
       const configuration = config != null ? config : this.printConfig;
@@ -2827,22 +2865,91 @@ var Text = class extends LabelField {
             commands.push(this.textCommand(remainingContent, x, y, font, features));
             remainingContent = "";
           } else {
-            let rows = remainingWidth / rowWidth;
-            rowWidth = this.width;
-            let rowEndIndex = Math.floor(remainingContent.length / rows);
+            let lo = 0, hi = remainingContent.length - 1;
+            let rowEndIndex = -1;
+            while (lo <= hi) {
+              const mid = Math.floor((lo + hi) / 2);
+              if (textWidhtFunction(remainingContent.substring(0, mid + 1), font) <= rowWidth) {
+                rowEndIndex = mid;
+                lo = mid + 1;
+              } else {
+                hi = mid - 1;
+              }
+            }
             let originalRowEndIndex = rowEndIndex;
-            if (rowEndIndex == 0) {
+            rowWidth = this.width;
+            if (rowEndIndex < 0) {
               x = this.x;
               y += font.size + this.lineSpacing;
               continue;
             }
-            while (!(!isWhitespace(remainingContent.charAt(rowEndIndex)) && (rowEndIndex == remainingContent.length - 1 || isWhitespace(remainingContent.charAt(rowEndIndex + 1)))) && rowEndIndex > 0) {
+            while (!(!isWhitespace(remainingContent.charAt(rowEndIndex)) && (rowEndIndex == remainingContent.length - 1 || isWhitespace(remainingContent.charAt(rowEndIndex + 1))) || isBreakAfterChar(remainingContent.charAt(rowEndIndex))) && rowEndIndex > 0) {
               rowEndIndex--;
             }
             let nextRowStartIndex = rowEndIndex + 1;
-            if (rowEndIndex == 0) {
+            const foundWordBoundary = !isWhitespace(remainingContent.charAt(rowEndIndex)) && (rowEndIndex == remainingContent.length - 1 || isWhitespace(remainingContent.charAt(rowEndIndex + 1))) || isBreakAfterChar(remainingContent.charAt(rowEndIndex));
+            const MIN_WORD_BREAK_CHARS = 2;
+            if (!foundWordBoundary) {
               rowEndIndex = originalRowEndIndex;
               nextRowStartIndex = originalRowEndIndex + 1;
+              let wordEnd = originalRowEndIndex + 1;
+              while (wordEnd < remainingContent.length && !isWhitespace(remainingContent.charAt(wordEnd))) {
+                wordEnd++;
+              }
+              const charsOnNext = wordEnd - originalRowEndIndex - 1;
+              if (charsOnNext > 0 && charsOnNext < MIN_WORD_BREAK_CHARS) {
+                const adjusted = originalRowEndIndex - (MIN_WORD_BREAK_CHARS - charsOnNext);
+                if (adjusted >= 0) {
+                  rowEndIndex = adjusted;
+                  nextRowStartIndex = adjusted + 1;
+                }
+              }
+            } else if (originalRowEndIndex > rowEndIndex) {
+              let wordStart = rowEndIndex + 1;
+              while (wordStart <= originalRowEndIndex && isWhitespace(remainingContent.charAt(wordStart))) {
+                wordStart++;
+              }
+              let fullWordEnd = wordStart;
+              while (fullWordEnd < remainingContent.length && !isWhitespace(remainingContent.charAt(fullWordEnd))) {
+                fullWordEnd++;
+              }
+              const lineWithFullWord = textWidhtFunction(remainingContent.substring(0, fullWordEnd), font);
+              if (lineWithFullWord <= rowWidth) {
+                rowEndIndex = fullWordEnd - 1;
+                nextRowStartIndex = fullWordEnd;
+              } else {
+                let lo2 = wordStart, hi2 = fullWordEnd - 1;
+                let midBreak = -1;
+                while (lo2 <= hi2) {
+                  const mid2 = Math.floor((lo2 + hi2) / 2);
+                  if (textWidhtFunction(remainingContent.substring(0, mid2 + 1), font) <= rowWidth) {
+                    midBreak = mid2;
+                    lo2 = mid2 + 1;
+                  } else {
+                    hi2 = mid2 - 1;
+                  }
+                }
+                let usedMidWordBreak = false;
+                if (midBreak >= wordStart) {
+                  let charsOnLine = midBreak - wordStart + 1;
+                  let charsOnNext = fullWordEnd - midBreak - 1;
+                  if (charsOnNext > 0 && charsOnNext < MIN_WORD_BREAK_CHARS) {
+                    midBreak -= MIN_WORD_BREAK_CHARS - charsOnNext;
+                    charsOnLine = midBreak - wordStart + 1;
+                  }
+                  if (charsOnLine >= MIN_WORD_BREAK_CHARS) {
+                    rowEndIndex = midBreak;
+                    nextRowStartIndex = midBreak + 1;
+                    usedMidWordBreak = true;
+                  }
+                }
+                if (!usedMidWordBreak) {
+                  nextRowStartIndex = rowEndIndex + 1;
+                  while (isWhitespace(remainingContent.charAt(nextRowStartIndex)) && nextRowStartIndex < remainingContent.length) {
+                    nextRowStartIndex++;
+                  }
+                }
+              }
             } else {
               while (isWhitespace(remainingContent.charAt(nextRowStartIndex)) && nextRowStartIndex < remainingContent.length) {
                 nextRowStartIndex++;
@@ -2941,13 +3048,23 @@ var Text = class extends LabelField {
 
 // src/labels/fields/BarCode.ts
 var BarCode = class extends LabelField {
-  constructor(content, x, y, type, height) {
+  /**
+   * @param content Content to encode
+   * @param x X coordinate in dots
+   * @param y Y coordinate in dots
+   * @param type Barcode symbology
+   * @param height Height of the barcode in dots
+   * @param barWidth Width of the narrow bar element in dots. The wide element width is
+   *                 calculated automatically based on the symbology's standard ratio.
+   */
+  constructor(content, x, y, type, height, barWidth = 2) {
     super();
     this.content = content;
     this.x = x;
     this.y = y;
     this.type = type;
     this.height = height;
+    this.barWidth = barWidth;
     this.rotation = 0;
     this.humanReadable = "none";
     this.alignment = "left";
@@ -2960,7 +3077,7 @@ var BarCode = class extends LabelField {
   }
   commandForLanguage(language, _config) {
     return __async(this, null, function* () {
-      return yield this.commandGeneratorFor(language).barCode(this.content, this.x, this.y, this.type, this.height, this.rotation, this.humanReadable, this.alignment);
+      return yield this.commandGeneratorFor(language).barCode(this.content, this.x, this.y, this.type, this.height, this.rotation, this.humanReadable, this.alignment, this.barWidth);
     });
   }
 };