label-printer 0.9.1 → 0.11.0

package/dist/index.d.mts

@@ -97,12 +97,12 @@ type BWBitmap = BitmapLike;
 interface CommandGenerator<T extends Command> {
     commandGroup: (commands: T[]) => CommandGroup<T>;
     print: (sets: number, copiesPerSet: number) => T;
-    text: (content: string, x: number, y: number, font: string | "default", size: number) => T;
+    text: (content: string, x: number, y: number, font: string | "default", size: number, rotation?: Rotation) => T;
     upload: (name: string, data: ArrayBuffer | Uint8Array) => T;
     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;
+    qrCode: (content: string, width: number, x: number, y: number, rotation?: Rotation) => 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";
 
 /**
@@ -413,14 +413,23 @@ declare class TSPLDensityCommand extends TSPLCommand {
 declare class TSPLCommandGenerator implements CommandGenerator<TSPLCommand> {
     commandGroup(commands: TSPLCommand[]): TSPLCommandGroup;
     print(sets: number, copiesPerSet: number): TSPLCommand;
-    text(content: string, x: number, y: number, font: string | "default", size: number): TSPLCommand;
+    text(content: string, x: number, y: number, font: string | "default", size: number, rotation?: Rotation): TSPLCommand;
     upload(name: string, data: ArrayBuffer | Uint8Array): TSPLCommand;
     setUp(width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean | undefined, unitSystem: UnitSystem, density: number): TSPLCommand;
     display(): TSPLCommandGroup;
     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;
+    qrCode(content: string, width: number, x: number, y: number, rotation?: Rotation): 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>;
     /**
@@ -651,9 +670,9 @@ declare class Text extends LabelField {
     private readonly formatted;
     private font;
     private type;
+    private rotation;
     private context;
     private readonly lineSpacing;
-    private endsWithBreak;
     /**
      * Width of the text.
      * If set, the text will be clipped to this size
@@ -664,6 +683,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
@@ -682,6 +702,21 @@ declare class Text extends LabelField {
      * that is registered on the label using 'registerFont'.
      */
     setFont(font: FontOption): void;
+    /**
+     * Set the rotation of the text field. All text commands in this field will be rotated.
+     * For multiline text, lines advance perpendicular to the character direction.
+     */
+    setRotation(rotation: Rotation): void;
+    /** Advance cursor by `amount` along the character direction */
+    private advanceChar;
+    /** Advance to the next line (reset char axis, advance in line direction) */
+    private advanceLine;
+    /** How far into the current line the cursor is (for width constraint calc) */
+    private charOffset;
+    /** How many lines deep we are (for height constraint calc) */
+    private lineOffset;
+    /** Whether the cursor is at the start of its line (char axis at origin) */
+    private atLineStart;
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
      * Generate commands for formatted text
@@ -708,8 +743,9 @@ declare class Text extends LabelField {
     private getFontName;
     private get textWidthFunction();
     /**
-     * This function is used to calculate the font size if no
-     * print config is provided. This will asume that the font has square characters
+     * Fallback width estimate when no font metrics are available.
+     * Uses the TSPL x-multiplication value (dotToPoint of the dot size) as
+     * the per-character width, which matches the rendered width of font "0".
      */
     private defaultTextWidth;
 }
@@ -720,10 +756,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>;
@@ -739,7 +785,9 @@ declare class Image extends LabelField {
      */
     private readonly y;
     private readonly image;
+    private rotation;
     constructor(x: number, y: number, image: BitmapLike);
+    setRotation(rotation: Rotation): void;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;
     /**
      * Create an image field for an image
@@ -758,7 +806,9 @@ declare class QRCode extends LabelField {
     private readonly x;
     private readonly y;
     private readonly width;
+    private rotation;
     constructor(content: string, x: number, y: number, width: number);
+    setRotation(rotation: Rotation): void;
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig | undefined): Promise<Command>;
 }
 

package/dist/index.d.ts

@@ -97,12 +97,12 @@ type BWBitmap = BitmapLike;
 interface CommandGenerator<T extends Command> {
     commandGroup: (commands: T[]) => CommandGroup<T>;
     print: (sets: number, copiesPerSet: number) => T;
-    text: (content: string, x: number, y: number, font: string | "default", size: number) => T;
+    text: (content: string, x: number, y: number, font: string | "default", size: number, rotation?: Rotation) => T;
     upload: (name: string, data: ArrayBuffer | Uint8Array) => T;
     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;
+    qrCode: (content: string, width: number, x: number, y: number, rotation?: Rotation) => 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";
 
 /**
@@ -413,14 +413,23 @@ declare class TSPLDensityCommand extends TSPLCommand {
 declare class TSPLCommandGenerator implements CommandGenerator<TSPLCommand> {
     commandGroup(commands: TSPLCommand[]): TSPLCommandGroup;
     print(sets: number, copiesPerSet: number): TSPLCommand;
-    text(content: string, x: number, y: number, font: string | "default", size: number): TSPLCommand;
+    text(content: string, x: number, y: number, font: string | "default", size: number, rotation?: Rotation): TSPLCommand;
     upload(name: string, data: ArrayBuffer | Uint8Array): TSPLCommand;
     setUp(width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean | undefined, unitSystem: UnitSystem, density: number): TSPLCommand;
     display(): TSPLCommandGroup;
     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;
+    qrCode(content: string, width: number, x: number, y: number, rotation?: Rotation): 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>;
     /**
@@ -651,9 +670,9 @@ declare class Text extends LabelField {
     private readonly formatted;
     private font;
     private type;
+    private rotation;
     private context;
     private readonly lineSpacing;
-    private endsWithBreak;
     /**
      * Width of the text.
      * If set, the text will be clipped to this size
@@ -664,6 +683,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
@@ -682,6 +702,21 @@ declare class Text extends LabelField {
      * that is registered on the label using 'registerFont'.
      */
     setFont(font: FontOption): void;
+    /**
+     * Set the rotation of the text field. All text commands in this field will be rotated.
+     * For multiline text, lines advance perpendicular to the character direction.
+     */
+    setRotation(rotation: Rotation): void;
+    /** Advance cursor by `amount` along the character direction */
+    private advanceChar;
+    /** Advance to the next line (reset char axis, advance in line direction) */
+    private advanceLine;
+    /** How far into the current line the cursor is (for width constraint calc) */
+    private charOffset;
+    /** How many lines deep we are (for height constraint calc) */
+    private lineOffset;
+    /** Whether the cursor is at the start of its line (char axis at origin) */
+    private atLineStart;
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
      * Generate commands for formatted text
@@ -708,8 +743,9 @@ declare class Text extends LabelField {
     private getFontName;
     private get textWidthFunction();
     /**
-     * This function is used to calculate the font size if no
-     * print config is provided. This will asume that the font has square characters
+     * Fallback width estimate when no font metrics are available.
+     * Uses the TSPL x-multiplication value (dotToPoint of the dot size) as
+     * the per-character width, which matches the rendered width of font "0".
      */
     private defaultTextWidth;
 }
@@ -720,10 +756,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>;
@@ -739,7 +785,9 @@ declare class Image extends LabelField {
      */
     private readonly y;
     private readonly image;
+    private rotation;
     constructor(x: number, y: number, image: BitmapLike);
+    setRotation(rotation: Rotation): void;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;
     /**
      * Create an image field for an image
@@ -758,7 +806,9 @@ declare class QRCode extends LabelField {
     private readonly x;
     private readonly y;
     private readonly width;
+    private rotation;
     constructor(content: string, x: number, y: number, width: number);
+    setRotation(rotation: Rotation): void;
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig | undefined): Promise<Command>;
 }