label-printer 0.11.0 → 0.12.0

package/dist/index.js

@@ -271,6 +271,19 @@ function dotToPoint(dots, dpi) {
   const inch = dots / dpi;
   return Math.round(inch * pointsPerInch);
 }
+function inToDot(inches, dpi, round = false) {
+  const res = inches * dpi;
+  if (round) return Math.round(res);
+  else return res;
+}
+function mmToDot(mm, dpi, round = false) {
+  const res = mm / 25.4 * dpi;
+  if (round) return Math.round(res);
+  else return res;
+}
+function unitToDot(value, dpi, unitSystem, round = false) {
+  return unitSystem === "imperial" ? inToDot(value, dpi, round) : mmToDot(value, dpi, round);
+}
 
 // src/helpers/ImageDataParser.ts
 function parsePNG(buffer2) {
@@ -1251,20 +1264,6 @@ var TSPLBitmapCommand = class _TSPLBitmapCommand extends TSPLVisualCommand {
   }
 };
 
-// src/commands/tspl/types.ts
-var alignmentToNumber = (alignment) => {
-  switch (alignment) {
-    case void 0:
-      return 0;
-    case "left":
-      return 1;
-    case "center":
-      return 2;
-    case "right":
-      return 3;
-  }
-};
-
 // src/commands/tspl/commands/basic/TSPLTextCommand.ts
 var TSPLTextCommand = class extends TSPLVisualCommand {
   constructor(content, x, y, font, rotation, xMultiplication, yMultiplication, alignment) {
@@ -1637,6 +1636,20 @@ var TSPLCommandGenerator = class _TSPLCommandGenerator {
 };
 var TSPLCommandGenerator_default = new TSPLCommandGenerator();
 
+// src/commands/tspl/types.ts
+var alignmentToNumber = (alignment) => {
+  switch (alignment) {
+    case void 0:
+      return 0;
+    case "left":
+      return 1;
+    case "center":
+      return 2;
+    case "right":
+      return 3;
+  }
+};
+
 // src/printers/index.ts
 var printers_exports = {};
 __export(printers_exports, {
@@ -2464,7 +2477,7 @@ var Printable = class {
   /**
    * Generates printable command for the given printer. Can be used to obtain a command for fields supported by the package then customizing it before printing
    * @param printer Printer to generate the command. Important because the command is printer language specific
-   * @returns A promise for a command. Most commands are syncronouse but some may require to access async resources
+   * @returns A promise for a command. Most commands are synchronous but some may require to access async resources
    */
   commandForPrinter(printer, config) {
     return __async(this, null, function* () {
@@ -2483,8 +2496,105 @@ var Printable = class {
   }
 };
 
+// src/labels/types.ts
+var rotationForOrientation = (orientation) => {
+  switch (orientation) {
+    case "normal":
+      return 0;
+    case "left":
+      return 90;
+    case "upside-down":
+      return 180;
+    case "right":
+      return 270;
+  }
+};
+
 // src/labels/Label.ts
 var fontkit = __toESM(require("fontkit"));
+
+// src/labels/fields/superClasses/LabelField.ts
+var LabelField = class extends Printable {
+};
+
+// src/labels/fields/superClasses/RotatableLabelField.ts
+var RotatableLabelField = class extends LabelField {
+  constructor() {
+    super(...arguments);
+    this.rotation = 0;
+  }
+  setRotation(rotation) {
+    this.rotation = rotation;
+  }
+  getRotation() {
+    return this.rotation;
+  }
+};
+
+// src/labels/RotatableContainer.ts
+var RotatableContainer = class extends RotatableLabelField {
+  /**
+   * @param size Size in dots
+   */
+  constructor(size) {
+    super();
+    this.fields = [];
+    this.size = size;
+  }
+  /**
+  * Place fields in the container
+  * @param fields 
+  */
+  add(...fields) {
+    this.fields.push(...fields);
+  }
+  commandForLanguage(language, config) {
+    return __async(this, null, function* () {
+      const commandList = yield Promise.all(this.fields.map((field) => this.rotationAdjustedCommand(field, language, config)));
+      return this.commandGeneratorFor(language).commandGroup(commandList);
+    });
+  }
+  rotationAdjustedCommand(field, language, config) {
+    return __async(this, null, function* () {
+      let originalRotation = void 0;
+      let originalPosition = void 0;
+      if (field.hasOwnProperty("rotation")) {
+        const rotatableField = field;
+        originalRotation = rotatableField.getRotation();
+        rotatableField.setRotation((originalRotation + this.rotation) % 360);
+      }
+      if (typeof field.getPosition === "function" && typeof field.setPosition === "function") {
+        const positionedField = field;
+        originalPosition = positionedField.getPosition();
+        positionedField.setPosition(this.adjustPosition(originalPosition));
+      }
+      const command = yield field.commandForLanguage(language, config);
+      if (originalRotation !== void 0) {
+        const rotatableField = field;
+        rotatableField.setRotation(originalRotation);
+      }
+      if (originalPosition !== void 0) {
+        const positionedField = field;
+        positionedField.setPosition(originalPosition);
+      }
+      return command;
+    });
+  }
+  adjustPosition(position) {
+    switch (this.rotation) {
+      case 90:
+        return { x: this.size.height - position.y, y: position.x };
+      case 180:
+        return { x: this.size.width - position.x, y: this.size.height - position.y };
+      case 270:
+        return { x: position.y, y: this.size.width - position.x };
+      default:
+        return position;
+    }
+  }
+};
+
+// src/labels/Label.ts
 var DEFAULT_FONT_WEIGHT = 400;
 var DEFAULT_FONT_STYLE = "normal";
 var FONT_PREFIX = "f";
@@ -2493,10 +2603,7 @@ var Label = class extends Printable {
     super();
     this.fonts = {};
     this.density = 8;
-    /**
-    * List of fields on the label
-    */
-    this.fields = [];
+    this.orientation = "normal";
     this.fontCounter = 0;
     this._textWidthCorrectionFactor = 0.935;
     this.width = width;
@@ -2504,6 +2611,9 @@ var Label = class extends Printable {
     this.unitSystem = dimensionUnit;
     this.dpi = dpi;
     this.density = density;
+    const widthInDots = unitToDot(width, dpi, dimensionUnit);
+    const heightInDots = unitToDot(height, dpi, dimensionUnit);
+    this.container = new RotatableContainer({ width: widthInDots, height: heightInDots });
   }
   /**
    * Configuration used when generating commands
@@ -2534,11 +2644,17 @@ var Label = class extends Printable {
   setTextWidthCorrectionFactor(factor) {
     this._textWidthCorrectionFactor = factor;
   }
+  /**
+   * Change the orientation the label is printed in. This will rotate all fields in the container
+   * @param orientation 
+   */
+  setOrientation(orientation) {
+    this.orientation = orientation;
+    this.container.setRotation(rotationForOrientation(orientation));
+  }
   commandForLanguage(language, config) {
     return __async(this, null, function* () {
-      const configuration = config != null ? config : this.printConfig;
-      const commandList = yield Promise.all(this.fields.map((field) => field.commandForLanguage(language, configuration)));
-      return this.commandGeneratorFor(language).commandGroup(commandList);
+      return yield this.container.commandForLanguage(language, config);
     });
   }
   /**
@@ -2546,7 +2662,7 @@ var Label = class extends Printable {
    * @param fields 
    */
   add(...fields) {
-    this.fields.push(...fields);
+    this.container.add(...fields);
   }
   /**
    * Register a font to be used. Use the name provided in components to use the font. 
@@ -2612,11 +2728,17 @@ var Label = class extends Printable {
    */
   fullCommand(language, gap, direction, mirror = false, gapOffset = 0, generator) {
     return __async(this, null, function* () {
+      let finalDimations;
+      if (this.orientation == "normal" || this.orientation == "upside-down") {
+        finalDimations = { width: this.width, height: this.height };
+      } else {
+        finalDimations = { width: this.height, height: this.width };
+      }
       const commands = [
         this.fontUploadCommands(generator),
         generator.setUp(
-          this.width,
-          this.height,
+          finalDimations.width,
+          finalDimations.height,
           gap,
           gapOffset,
           direction,
@@ -2647,10 +2769,10 @@ var Label = class extends Printable {
     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 weight = (_b = font.weight) != null ? _b : DEFAULT_FONT_WEIGHT;
     const fontKeys = Object.keys(family.fonts);
     const exactMatch = fontKeys.find(
-      (key) => family.fonts[key].style == style && family.fonts[key].weight == weigth
+      (key) => family.fonts[key].style == style && family.fonts[key].weight == weight
     );
     if (exactMatch) {
       return family.fonts[exactMatch];
@@ -2660,7 +2782,7 @@ var Label = class extends Printable {
         let weigthDiff = 99999999;
         let selectedKey = "";
         sameStyleKeys.forEach((key) => {
-          const diff = Math.abs(weigth - family.fonts[key].weight);
+          const diff = Math.abs(weight - family.fonts[key].weight);
           if (diff < weigthDiff) {
             weigthDiff = diff;
             selectedKey = key;
@@ -2688,10 +2810,6 @@ var Label = class extends Printable {
   }
 };
 
-// src/labels/fields/LabelField.ts
-var LabelField = class extends Printable {
-};
-
 // src/labels/fields/Line.ts
 var Line = class extends LabelField {
   /**
@@ -2720,12 +2838,11 @@ var UNDERLINE_TAG = "u";
 var STRIKE_TAG = ["s", "del", "strike"];
 var PARAGRAPH_TAG = "p";
 var BREAK_TAG = "br";
-var Text = class extends LabelField {
+var Text = class extends RotatableLabelField {
   constructor(content, x, y, formatted = true) {
     super();
     this.font = { name: "default", size: 10 };
     this.type = "singleline";
-    this.rotation = 0;
     this.context = void 0;
     this.lineSpacing = 1;
     this.content = content.replace("\n", "").replace('"', '\\"');
@@ -2751,6 +2868,13 @@ var Text = class extends LabelField {
     }
     return false;
   }
+  setPosition(position) {
+    this.x = position.x;
+    this.y = position.y;
+  }
+  getPosition() {
+    return { x: this.x, y: this.y };
+  }
   /**
    * Sets the field to single line
    * @param width Max width of the text. Leave it undefined to allow the field to grow 
@@ -2778,13 +2902,6 @@ var Text = class extends LabelField {
   setFont(font) {
     this.font = font;
   }
-  /**
-   * 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) {
-    this.rotation = rotation;
-  }
   // --- Rotation-aware position helpers ---
   /** Advance cursor by `amount` along the character direction */
   advanceChar(x, y, amount) {
@@ -3197,7 +3314,7 @@ var Text = class extends LabelField {
 };
 
 // src/labels/fields/BarCode.ts
-var BarCode = class extends LabelField {
+var BarCode = class extends RotatableLabelField {
   /**
    * @param content Content to encode
    * @param x X coordinate in dots
@@ -3215,16 +3332,19 @@ var BarCode = class extends LabelField {
     this.type = type;
     this.height = height;
     this.barWidth = barWidth;
-    this.rotation = 0;
     this.humanReadable = "none";
     this.alignment = "left";
   }
-  setRotation(rotation) {
-    this.rotation = rotation;
-  }
   setHumanReadable(humanReadable) {
     this.humanReadable = humanReadable;
   }
+  setPosition(position) {
+    this.x = position.x;
+    this.y = position.y;
+  }
+  getPosition() {
+    return { x: this.x, y: this.y };
+  }
   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, this.barWidth);
@@ -3233,16 +3353,19 @@ var BarCode = class extends LabelField {
 };
 
 // src/labels/fields/Image.ts
-var Image2 = class _Image extends LabelField {
+var Image2 = class _Image extends RotatableLabelField {
   constructor(x, y, image2) {
     super();
-    this.rotation = 0;
     this.x = x;
     this.y = y;
     this.image = image2;
   }
-  setRotation(rotation) {
-    this.rotation = rotation;
+  setPosition(position) {
+    this.x = position.x;
+    this.y = position.y;
+  }
+  getPosition() {
+    return { x: this.x, y: this.y };
   }
   commandForLanguage(language, _config) {
     return __async(this, null, function* () {
@@ -3287,17 +3410,20 @@ var Image2 = class _Image extends LabelField {
 };
 
 // src/labels/fields/QRCode.ts
-var QRCode = class extends LabelField {
+var QRCode = class extends RotatableLabelField {
   constructor(content, x, y, width) {
     super();
-    this.rotation = 0;
     this.content = content;
     this.x = x;
     this.y = y;
     this.width = width;
   }
-  setRotation(rotation) {
-    this.rotation = rotation;
+  setPosition(position) {
+    this.x = position.x;
+    this.y = position.y;
+  }
+  getPosition() {
+    return { x: this.x, y: this.y };
   }
   commandForLanguage(language, config) {
     return __async(this, null, function* () {