label-printer 0.4.10 → 0.5.2

package/README.md

@@ -39,6 +39,42 @@ This layer contains code to interact with printers
 
 - [TSPL](documentations/TSPL.pdf)
 
+## Label fields
+
+### Table
+
+The `Table` field draws a grid and places text into each cell. It uses the existing `Text` field for cell contents and the existing `Line` field for the grid lines.
+
+```ts
+import { Label } from "label-printer/dist/labels"
+import { Table } from "label-printer/dist/labels/fields"
+
+const label = new Label(50, 25)
+
+const table = new Table(10, 10, [
+  ["A1", "A2"],
+  ["B1", "B2"],
+], {
+  size: { width: 200, height: 100 },
+  columnWidths: [80, 120],
+  rowHeights: [40, 60],
+  lineThickness: 2,
+  cellPadding: 4,
+  formatted: false,
+  font: { name: "default", size: 10 },
+})
+
+label.add(table)
+```
+
+Sizing rules:
+
+- **If `size.width`/`size.height` are set**
+  - Any unspecified row/column sizes share the remaining space equally.
+  - Cell text is constrained to the cell content box and will wrap to multiple lines. If a row height is fixed, the text may be clipped once it reaches the height limit.
+- **If table size is not set**
+  - Unspecified row/column sizes are measured from their content.
+
 # Usefull units:
 
 - 1 pt = 1/72 inch
@@ -52,6 +88,9 @@ This layer contains code to interact with printers
 
 # Update package
 
-- Run `pnpm changeset` to create change. This change has to be merged into main first
-- Run `pnpm changeset version` to create an update with all the versions. 
-- PR is automatically created on push, merge it to trigger publish
+- Make changes on feature branch.
+- Run `pnpm changeset` on feature branch to create change.
+- Merge feature branch into main.
+- Run `pnpm changeset version` on main to create an update with all the versions. 
+- PR is automatically created on push, merge it to trigger publish
+- Note: If there are unpublished changes on main and the release fails, it will be run again on the next push to main, no need to start again from the first step

package/dist/index.d.mts

@@ -525,6 +525,7 @@ type FontOption = Expand<Partial<Pick<Font, "style" | "weight">> & Pick<Font, "n
 
 type PrintConfig = {
     dpi: number;
+    /** Width of the text in dots */
     textWidth: (text: string, font: FontOption) => number;
     getFontName: (font: FontOption) => string;
 };
@@ -717,7 +718,7 @@ declare class Text extends LabelField {
     private textCommand;
     private textLineCommand;
     private getFontName;
-    private get textWithFunction();
+    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
@@ -773,6 +774,50 @@ declare class QRCode extends LabelField {
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig | undefined): Promise<Command>;
 }
 
+type TableCellContent = string;
+type TableSize = {
+    width?: number;
+    height?: number;
+};
+type SizeSpec = number | undefined;
+type TableOptions = {
+    size?: TableSize;
+    columnWidths?: SizeSpec[];
+    rowHeights?: SizeSpec[];
+    lineThickness?: number;
+    cellPadding?: number;
+    formatted?: boolean;
+    font?: FontOption;
+};
+declare class Table extends LabelField {
+    private readonly x;
+    private readonly y;
+    private readonly rows;
+    private size;
+    private columnWidths;
+    private rowHeights;
+    private lineThickness;
+    private cellPadding;
+    private formatted;
+    private font;
+    constructor(x: number, y: number, rows: TableCellContent[][], options?: TableOptions);
+    setSize(size: TableSize): void;
+    setColumnWidths(widths: SizeSpec[]): void;
+    setRowHeights(heights: SizeSpec[]): void;
+    setLineThickness(thickness: number): void;
+    setCellPadding(padding: number): void;
+    setFormatted(formatted: boolean): void;
+    setFont(font: FontOption): void;
+    commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
+    private accumulatePositions;
+    private resolveTrackSizes;
+    private measureAutoColumnWidth;
+    private measureAutoRowHeight;
+    private estimateLineCount;
+    private textWidth;
+    private toPlainText;
+}
+
 type index$1_BarCode = BarCode;
 declare const index$1_BarCode: typeof BarCode;
 type index$1_Image = Image;
@@ -785,10 +830,12 @@ type index$1_Line = Line;
 declare const index$1_Line: typeof Line;
 type index$1_QRCode = QRCode;
 declare const index$1_QRCode: typeof QRCode;
+type index$1_Table = Table;
+declare const index$1_Table: typeof Table;
 type index$1_Text = Text;
 declare const index$1_Text: typeof Text;
 declare namespace index$1 {
-  export { index$1_BarCode as BarCode, index$1_Image as Image, index$1_Label as Label, index$1_LabelField as LabelField, index$1_Line as Line, index$1_QRCode as QRCode, index$1_Text as Text };
+  export { index$1_BarCode as BarCode, index$1_Image as Image, index$1_Label as Label, index$1_LabelField as LabelField, index$1_Line as Line, index$1_QRCode as QRCode, index$1_Table as Table, index$1_Text as Text };
 }
 
 /**

package/dist/index.d.ts

@@ -525,6 +525,7 @@ type FontOption = Expand<Partial<Pick<Font, "style" | "weight">> & Pick<Font, "n
 
 type PrintConfig = {
     dpi: number;
+    /** Width of the text in dots */
     textWidth: (text: string, font: FontOption) => number;
     getFontName: (font: FontOption) => string;
 };
@@ -717,7 +718,7 @@ declare class Text extends LabelField {
     private textCommand;
     private textLineCommand;
     private getFontName;
-    private get textWithFunction();
+    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
@@ -773,6 +774,50 @@ declare class QRCode extends LabelField {
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig | undefined): Promise<Command>;
 }
 
+type TableCellContent = string;
+type TableSize = {
+    width?: number;
+    height?: number;
+};
+type SizeSpec = number | undefined;
+type TableOptions = {
+    size?: TableSize;
+    columnWidths?: SizeSpec[];
+    rowHeights?: SizeSpec[];
+    lineThickness?: number;
+    cellPadding?: number;
+    formatted?: boolean;
+    font?: FontOption;
+};
+declare class Table extends LabelField {
+    private readonly x;
+    private readonly y;
+    private readonly rows;
+    private size;
+    private columnWidths;
+    private rowHeights;
+    private lineThickness;
+    private cellPadding;
+    private formatted;
+    private font;
+    constructor(x: number, y: number, rows: TableCellContent[][], options?: TableOptions);
+    setSize(size: TableSize): void;
+    setColumnWidths(widths: SizeSpec[]): void;
+    setRowHeights(heights: SizeSpec[]): void;
+    setLineThickness(thickness: number): void;
+    setCellPadding(padding: number): void;
+    setFormatted(formatted: boolean): void;
+    setFont(font: FontOption): void;
+    commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
+    private accumulatePositions;
+    private resolveTrackSizes;
+    private measureAutoColumnWidth;
+    private measureAutoRowHeight;
+    private estimateLineCount;
+    private textWidth;
+    private toPlainText;
+}
+
 type index$1_BarCode = BarCode;
 declare const index$1_BarCode: typeof BarCode;
 type index$1_Image = Image;
@@ -785,10 +830,12 @@ type index$1_Line = Line;
 declare const index$1_Line: typeof Line;
 type index$1_QRCode = QRCode;
 declare const index$1_QRCode: typeof QRCode;
+type index$1_Table = Table;
+declare const index$1_Table: typeof Table;
 type index$1_Text = Text;
 declare const index$1_Text: typeof Text;
 declare namespace index$1 {
-  export { index$1_BarCode as BarCode, index$1_Image as Image, index$1_Label as Label, index$1_LabelField as LabelField, index$1_Line as Line, index$1_QRCode as QRCode, index$1_Text as Text };
+  export { index$1_BarCode as BarCode, index$1_Image as Image, index$1_Label as Label, index$1_LabelField as LabelField, index$1_Line as Line, index$1_QRCode as QRCode, index$1_Table as Table, index$1_Text as Text };
 }
 
 /**

package/dist/index.js

@@ -443,7 +443,6 @@ var ImageProcessor = class {
    */
   static getImageDataBrowser(image2) {
     return __async(this, null, function* () {
-      console.log("Processing image in browser environment");
       return new Promise((resolve, reject) => {
         const img = new Image();
         img.crossOrigin = "anonymous";
@@ -1439,6 +1438,9 @@ var UsbDevice = class {
   writeData(data) {
     return __async(this, null, function* () {
       const endpointNumber = this.outEndpoint;
+      if (endpointNumber == null) {
+        throw new Error("usb-no-out-endpoint");
+      }
       yield this.device.transferOut(endpointNumber, data);
     });
   }
@@ -1460,6 +1462,9 @@ var UsbDevice = class {
   readData(length) {
     return __async(this, null, function* () {
       const endpointNumber = this.inEndpoint;
+      if (endpointNumber == null) {
+        throw new Error("usb-no-in-endpoint");
+      }
       const result = yield this.device.transferIn(endpointNumber, length);
       if (result.status == "ok" && result.data) {
         return result.data;
@@ -1515,8 +1520,12 @@ var PrinterService = class _PrinterService {
     return __async(this, null, function* () {
       const classes = [TSPLPrinter];
       for (const key in classes) {
-        if (yield classes[key].try(device)) {
-          return new classes[key](device);
+        try {
+          if (yield classes[key].try(device)) {
+            return new classes[key](device);
+          }
+        } catch (_e) {
+          return void 0;
         }
       }
       return void 0;
@@ -1558,6 +1567,7 @@ __export(labels_exports, {
   LabelField: () => LabelField,
   Line: () => Line,
   QRCode: () => QRCode,
+  Table: () => Table,
   Text: () => Text
 });
 
@@ -1611,11 +1621,16 @@ var Label = class extends Printable {
     return {
       dpi: this.dpi,
       textWidth: (text, font) => {
-        const size = dotToPoint(font.size, this.dpi);
-        const fontObject = this.getIndexedFont(font).font;
-        const run = fontObject.layout(text);
-        const scaledWidth = size * run.advanceWidth / fontObject.unitsPerEm;
-        return pointsToDots(scaledWidth, this.dpi);
+        const indexedFont = this.getIndexedFont(font);
+        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);
+        }
       },
       getFontName: this.getFontName.bind(this)
     };
@@ -1689,8 +1704,7 @@ var Label = class extends Printable {
       const generator = this.commandGeneratorFor(language);
       const commands = yield this.fullCommand(language, 0, direction, mirror, 0, generator);
       commands.push(generator.display());
-      const group = generator.commandGroup(commands);
-      return group;
+      return generator.commandGroup(commands);
     });
   }
   /**
@@ -1722,6 +1736,7 @@ var Label = class extends Printable {
   getIndexedFont(font) {
     var _a, _b;
     const family = this.fonts[font.name];
+    if (!family) return null;
     const style = (_a = font.style) != null ? _a : DEFAULT_FONT_STYLE;
     const weigth = (_b = font.weight) != null ? _b : DEFAULT_FONT_WEIGHT;
     const fontKeys = Object.keys(family.fonts);
@@ -1750,6 +1765,9 @@ var Label = class extends Printable {
   }
   getFontName(font) {
     const indexedFont = this.getIndexedFont(font);
+    if (indexedFont == null) {
+      return font.name;
+    }
     return indexedFont.alias;
   }
   /// This can be extended when we want support multiple fonts
@@ -1798,7 +1816,7 @@ var Text = class extends LabelField {
     this.type = "singleline";
     this.context = void 0;
     this.lineSpacing = 1;
-    this.content = content.replace("\n", "");
+    this.content = content.replace("\n", "").replace('"', '\\"');
     this.x = x;
     this.y = y;
     this.formatted = formatted;
@@ -1909,7 +1927,7 @@ var Text = class extends LabelField {
    */
   generatePlainTextCore(content, initialX, initialY, font, features = []) {
     if (!this.context) throw "context-not-set";
-    const textWidhtFunction = this.textWithFunction;
+    const textWidhtFunction = this.textWidthFunction;
     let fullWidth = textWidhtFunction(content, font);
     if (this.width) {
       const initialPadding = initialX - this.x;
@@ -2011,7 +2029,7 @@ var Text = class extends LabelField {
       return textCommand;
     } else {
       let lineHeight = font.size * 0.1;
-      let textWidth = this.textWithFunction(text, font);
+      let textWidth = this.textWidthFunction(text, font);
       if (features.includes("strike")) {
         commands.push(this.textLineCommand(textWidth, x, y, lineHeight, 0.5, font.size));
       }
@@ -2040,7 +2058,7 @@ var Text = class extends LabelField {
       return (_a = this.context.config) == null ? void 0 : _a.getFontName(font);
     }
   }
-  get textWithFunction() {
+  get textWidthFunction() {
     var _a, _b, _c;
     if (this.font.name == "default") {
       return this.defaultTextWidth;
@@ -2128,6 +2146,210 @@ var QRCode = class extends LabelField {
     });
   }
 };
+
+// src/labels/fields/Table.ts
+var Table = class extends LabelField {
+  constructor(x, y, rows, options = {}) {
+    var _a, _b, _c, _d;
+    super();
+    this.x = x;
+    this.y = y;
+    this.rows = rows;
+    this.size = options.size;
+    this.columnWidths = options.columnWidths;
+    this.rowHeights = options.rowHeights;
+    this.lineThickness = (_a = options.lineThickness) != null ? _a : 2;
+    this.cellPadding = (_b = options.cellPadding) != null ? _b : 4;
+    this.formatted = (_c = options.formatted) != null ? _c : true;
+    this.font = (_d = options.font) != null ? _d : { name: "default", size: 10 };
+  }
+  setSize(size) {
+    this.size = size;
+  }
+  setColumnWidths(widths) {
+    this.columnWidths = widths;
+  }
+  setRowHeights(heights) {
+    this.rowHeights = heights;
+  }
+  setLineThickness(thickness) {
+    this.lineThickness = thickness;
+  }
+  setCellPadding(padding) {
+    this.cellPadding = padding;
+  }
+  setFormatted(formatted) {
+    this.formatted = formatted;
+  }
+  setFont(font) {
+    this.font = font;
+  }
+  commandForLanguage(language, config) {
+    return __async(this, null, function* () {
+      var _a, _b, _c, _d;
+      const generator = this.commandGeneratorFor(language);
+      const rowCount = this.rows.length;
+      const colCount = Math.max(0, ...this.rows.map((r) => r.length));
+      const resolvedColumnWidths = this.resolveTrackSizes({
+        trackCount: colCount,
+        explicitSizes: this.columnWidths,
+        total: (_a = this.size) == null ? void 0 : _a.width,
+        measure: (i) => this.measureAutoColumnWidth(i, colCount, config)
+      });
+      const resolvedRowHeights = this.resolveTrackSizes({
+        trackCount: rowCount,
+        explicitSizes: this.rowHeights,
+        total: (_b = this.size) == null ? void 0 : _b.height,
+        measure: (i) => this.measureAutoRowHeight(i, resolvedColumnWidths, config)
+      });
+      const xPositions = this.accumulatePositions(this.x, resolvedColumnWidths);
+      const yPositions = this.accumulatePositions(this.y, resolvedRowHeights);
+      const fields = [];
+      for (let rowIndex = 0; rowIndex < rowCount; rowIndex++) {
+        for (let colIndex = 0; colIndex < colCount; colIndex++) {
+          const cellContent = (_d = (_c = this.rows[rowIndex]) == null ? void 0 : _c[colIndex]) != null ? _d : "";
+          const cellX = xPositions[colIndex];
+          const cellY = yPositions[rowIndex];
+          const cellWidth = resolvedColumnWidths[colIndex];
+          const cellHeight = resolvedRowHeights[rowIndex];
+          const textX = cellX + this.cellPadding;
+          const textY = cellY + this.cellPadding;
+          const textWidth = Math.max(1, cellWidth - this.cellPadding * 2);
+          const textHeight = Math.max(1, cellHeight - this.cellPadding * 2);
+          const text = new Text(cellContent, textX, textY, this.formatted);
+          text.setFont(this.font);
+          text.setMultiLine(textWidth, textHeight);
+          fields.push(text);
+        }
+      }
+      const totalWidth = resolvedColumnWidths.reduce((a, b) => a + b, 0);
+      const totalHeight = resolvedRowHeights.reduce((a, b) => a + b, 0);
+      for (let colIndex = 0; colIndex <= colCount; colIndex++) {
+        const sx = colIndex == colCount ? this.x + totalWidth : xPositions[colIndex];
+        fields.push(new Line(
+          { x: sx, y: this.y },
+          { x: sx, y: this.y + totalHeight },
+          this.lineThickness
+        ));
+      }
+      for (let rowIndex = 0; rowIndex <= rowCount; rowIndex++) {
+        const sy = rowIndex == rowCount ? this.y + totalHeight : yPositions[rowIndex];
+        fields.push(new Line(
+          { x: this.x, y: sy },
+          { x: this.x + totalWidth, y: sy },
+          this.lineThickness
+        ));
+      }
+      const commandList = yield Promise.all(fields.map((field) => field.commandForLanguage(language, config)));
+      return generator.commandGroup(commandList);
+    });
+  }
+  accumulatePositions(start, sizes) {
+    const positions = [];
+    let current = start;
+    for (const s of sizes) {
+      positions.push(current);
+      current += s;
+    }
+    return positions;
+  }
+  resolveTrackSizes(params) {
+    if (params.trackCount == 0) return [];
+    const sizes = new Array(params.trackCount).fill(void 0);
+    if (params.explicitSizes) {
+      for (let i = 0; i < Math.min(params.trackCount, params.explicitSizes.length); i++) {
+        sizes[i] = params.explicitSizes[i];
+      }
+    }
+    if (params.total != void 0) {
+      const fixedTotal = sizes.reduce((sum, s) => sum + (s != null ? s : 0), 0);
+      const flexibleCount = sizes.filter((s) => s == void 0).length;
+      const remaining = Math.max(0, params.total - fixedTotal);
+      const flexSize = flexibleCount == 0 ? 0 : remaining / flexibleCount;
+      return sizes.map((s, i) => {
+        var _a;
+        return Math.max(1, (_a = s != null ? s : flexSize) != null ? _a : params.measure(i));
+      });
+    }
+    return sizes.map((s, i) => Math.max(1, s != null ? s : params.measure(i)));
+  }
+  measureAutoColumnWidth(columnIndex, colCount, config) {
+    var _a;
+    const contentWidths = [];
+    for (const row of this.rows) {
+      const content = (_a = row == null ? void 0 : row[columnIndex]) != null ? _a : "";
+      const plain = this.toPlainText(content);
+      const w = this.textWidth(plain, config);
+      contentWidths.push(w);
+    }
+    const maxContentWidth = contentWidths.length == 0 ? 0 : Math.max(...contentWidths);
+    const minWidth = this.font.size;
+    const measured = Math.max(minWidth, maxContentWidth) + this.cellPadding * 2;
+    if (colCount == 0) return measured;
+    return measured;
+  }
+  measureAutoRowHeight(rowIndex, columnWidths, config) {
+    var _a, _b;
+    const row = (_a = this.rows[rowIndex]) != null ? _a : [];
+    const contentHeights = [];
+    for (let colIndex = 0; colIndex < columnWidths.length; colIndex++) {
+      const content = (_b = row[colIndex]) != null ? _b : "";
+      const plain = this.toPlainText(content);
+      const availableWidth = Math.max(1, columnWidths[colIndex] - this.cellPadding * 2);
+      const lineCount = this.estimateLineCount(plain, availableWidth, config);
+      const lineHeight = this.font.size + 1;
+      contentHeights.push(lineCount * lineHeight);
+    }
+    const maxContentHeight = contentHeights.length == 0 ? this.font.size : Math.max(...contentHeights);
+    return maxContentHeight + this.cellPadding * 2;
+  }
+  estimateLineCount(content, width, config) {
+    const normalized = content.replace("\n", " ");
+    if (normalized.trim() == "") return 1;
+    const words = [];
+    let buffer2 = "";
+    for (let i = 0; i < normalized.length; i++) {
+      const ch = normalized.charAt(i);
+      if (isWhitespace(ch)) {
+        if (buffer2 != "") {
+          words.push(buffer2);
+          buffer2 = "";
+        }
+        continue;
+      }
+      buffer2 += ch;
+    }
+    if (buffer2 != "") words.push(buffer2);
+    let lines = 1;
+    let currentLine = "";
+    for (const word of words) {
+      const candidate = currentLine == "" ? word : `${currentLine} ${word}`;
+      if (this.textWidth(candidate, config) <= width) {
+        currentLine = candidate;
+      } else {
+        if (currentLine == "") {
+          const charsPerLine = Math.max(1, Math.floor(width / Math.max(1, this.font.size)));
+          const neededLines = Math.ceil(word.length / charsPerLine);
+          lines += neededLines - 1;
+          currentLine = word.substring((neededLines - 1) * charsPerLine);
+        } else {
+          lines += 1;
+          currentLine = word;
+        }
+      }
+    }
+    return Math.max(1, lines);
+  }
+  textWidth(text, config) {
+    if (this.font.name == "default" || !config) {
+      return text.length * this.font.size;
+    }
+    return config.textWidth(text, this.font);
+  }
+  toPlainText(content) {
+    return content.replace(/<[^>]*>/g, "");
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   commands,