label-printer 0.11.0 → 0.12.0

package/dist/index.d.mts

@@ -91,6 +91,16 @@ type BitmapLike = {
  */
 type BWBitmap = BitmapLike;
 
+type Point = {
+    x: number;
+    y: number;
+};
+type Dimension = {
+    width: number;
+    height: number;
+};
+type Rotation = 0 | 90 | 180 | 270;
+
 /**
  * Interface that should be implemented by a command generator object for each language
  */
@@ -144,7 +154,6 @@ declare abstract class TSPLVisualCommand extends TSPLCommand {
     constructor(x: number, y: number);
 }
 
-type Rotation = 0 | 90 | 180 | 270;
 type Alignment = undefined | "left" | "center" | "right";
 /**
  * Convert an alignemnt string to its number value
@@ -442,7 +451,6 @@ type index$3_ECCLevel = ECCLevel;
 type index$3_GraphicMode = GraphicMode;
 type index$3_LabelDirection = LabelDirection;
 type index$3_QRModel = QRModel;
-type index$3_Rotation = Rotation;
 type index$3_TSPLBarCommand = TSPLBarCommand;
 declare const index$3_TSPLBarCommand: typeof TSPLBarCommand;
 type index$3_TSPLBitmapCommand = TSPLBitmapCommand;
@@ -481,14 +489,9 @@ type index$3_TSPLVisualCommand = TSPLVisualCommand;
 declare const index$3_TSPLVisualCommand: typeof TSPLVisualCommand;
 declare const index$3_alignmentToNumber: typeof alignmentToNumber;
 declare namespace index$3 {
-  export { type index$3_Alignment as Alignment, type index$3_AutoManual as AutoManual, type index$3_BarcodeHumanReable as BarcodeHumanReable, type index$3_BarcodeType as BarcodeType, type index$3_ECCLevel as ECCLevel, type index$3_GraphicMode as GraphicMode, type index$3_LabelDirection as LabelDirection, type index$3_QRModel as QRModel, type index$3_Rotation as Rotation, index$3_TSPLBarCommand as TSPLBarCommand, index$3_TSPLBitmapCommand as TSPLBitmapCommand, index$3_TSPLBlockCommand as TSPLBlockCommand, index$3_TSPLCLSCommand as TSPLCLSCommand, index$3_TSPLCommand as TSPLCommand, index$3_TSPLCommandGroup as TSPLCommandGroup, index$3_TSPLDensityCommand as TSPLDensityCommand, index$3_TSPLDiagonal as TSPLDiagonal, index$3_TSPLDirectionCommand as TSPLDirectionCommand, index$3_TSPLDisplay as TSPLDisplay, index$3_TSPLDownload as TSPLDownload, index$3_TSPLGapCommand as TSPLGapCommand, index$3_TSPLPrintCommand as TSPLPrintCommand, index$3_TSPLQRCommand as TSPLQRCommand, index$3_TSPLRawCommand as TSPLRawCommand, index$3_TSPLSizeCommand as TSPLSizeCommand, index$3_TSPLTextCommand as TSPLTextCommand, index$3_TSPLVisualCommand as TSPLVisualCommand, index$3_alignmentToNumber as alignmentToNumber, _default as commandGenerator };
+  export { type index$3_Alignment as Alignment, type index$3_AutoManual as AutoManual, type index$3_BarcodeHumanReable as BarcodeHumanReable, type index$3_BarcodeType as BarcodeType, type index$3_ECCLevel as ECCLevel, type index$3_GraphicMode as GraphicMode, type index$3_LabelDirection as LabelDirection, type index$3_QRModel as QRModel, index$3_TSPLBarCommand as TSPLBarCommand, index$3_TSPLBitmapCommand as TSPLBitmapCommand, index$3_TSPLBlockCommand as TSPLBlockCommand, index$3_TSPLCLSCommand as TSPLCLSCommand, index$3_TSPLCommand as TSPLCommand, index$3_TSPLCommandGroup as TSPLCommandGroup, index$3_TSPLDensityCommand as TSPLDensityCommand, index$3_TSPLDiagonal as TSPLDiagonal, index$3_TSPLDirectionCommand as TSPLDirectionCommand, index$3_TSPLDisplay as TSPLDisplay, index$3_TSPLDownload as TSPLDownload, index$3_TSPLGapCommand as TSPLGapCommand, index$3_TSPLPrintCommand as TSPLPrintCommand, index$3_TSPLQRCommand as TSPLQRCommand, index$3_TSPLRawCommand as TSPLRawCommand, index$3_TSPLSizeCommand as TSPLSizeCommand, index$3_TSPLTextCommand as TSPLTextCommand, index$3_TSPLVisualCommand as TSPLVisualCommand, index$3_alignmentToNumber as alignmentToNumber, _default as commandGenerator };
 }
 
-type Point = {
-    x: number;
-    y: number;
-};
-
 type PrinterLanguage = "tspl";
 type UnitSystem = "imperial" | "metric" | "dot";
 
@@ -496,11 +499,13 @@ type index$2_Command = Command;
 declare const index$2_Command: typeof Command;
 type index$2_CommandGroup<T extends Command> = CommandGroup<T>;
 declare const index$2_CommandGroup: typeof CommandGroup;
+type index$2_Dimension = Dimension;
 type index$2_Point = Point;
 type index$2_PrinterLanguage = PrinterLanguage;
+type index$2_Rotation = Rotation;
 type index$2_UnitSystem = UnitSystem;
 declare namespace index$2 {
-  export { index$2_Command as Command, index$2_CommandGroup as CommandGroup, type index$2_Point as Point, type index$2_PrinterLanguage as PrinterLanguage, type index$2_UnitSystem as UnitSystem, index$3 as tspl };
+  export { index$2_Command as Command, index$2_CommandGroup as CommandGroup, type index$2_Dimension as Dimension, type index$2_Point as Point, type index$2_PrinterLanguage as PrinterLanguage, type index$2_Rotation as Rotation, type index$2_UnitSystem as UnitSystem, index$3 as tspl };
 }
 
 type Expand<T> = T extends infer O ? {
@@ -517,6 +522,11 @@ type Font = {
 type FontOption = Expand<Partial<Pick<Font, "style" | "weight">> & Pick<Font, "name"> & {
     size: number;
 }>;
+/**
+ * The orientation, the label will be printed on. This allows designing a label in the natural orientation, than printing to
+ * a label that is rotated in the printer. The rotation is applied to all fields on the label, and it is independent from the rotation of individual fields.
+ */
+type LabelOrientation = "normal" | "left" | "right" | "upside-down";
 
 type PrintConfig = {
     dpi: number;
@@ -539,7 +549,7 @@ declare abstract class Printable {
     /**
      * 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: Printer, config?: PrintConfig): Promise<Command>;
     /**
@@ -571,10 +581,11 @@ declare class Label extends Printable {
     private fonts;
     private dpi;
     private density;
+    private orientation;
     /**
     * List of fields on the label
     */
-    private fields;
+    private container;
     private fontCounter;
     private _textWidthCorrectionFactor;
     /**
@@ -588,6 +599,11 @@ declare class Label extends Printable {
      * @param factor Correction factor (default 1.0, typical range 0.9-1.0)
      */
     setTextWidthCorrectionFactor(factor: number): void;
+    /**
+     * Change the orientation the label is printed in. This will rotate all fields in the container
+     * @param orientation
+     */
+    setOrientation(orientation: LabelOrientation): void;
     constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number, density?: number);
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
@@ -651,26 +667,40 @@ declare class Line extends LabelField {
     commandForLanguage(language: PrinterLanguage): Promise<Command>;
 }
 
+interface RotatableField {
+    setRotation(rotation: Rotation): void;
+    getRotation(): Rotation;
+}
+interface PositionedField {
+    getPosition(): Point;
+    setPosition(position: Point): void;
+}
+
+declare abstract class RotatableLabelField extends LabelField implements RotatableField {
+    protected rotation: Rotation;
+    setRotation(rotation: Rotation): void;
+    getRotation(): Rotation;
+}
+
 /**
  * Presents a piece of text on the label
  */
-declare class Text extends LabelField {
+declare class Text extends RotatableLabelField implements PositionedField {
     private readonly content;
     /**
      * X coordinate in dots
      */
-    private readonly x;
+    private x;
     /**
      * Y coordinate in dots
      */
-    private readonly y;
+    private y;
     /**
-     * If true, basic html elements will be interpretted, otherwise the raw string is printed out
+     * If true, basic html elements will be interpreted, otherwise the raw string is printed out
      */
     private readonly formatted;
     private font;
     private type;
-    private rotation;
     private context;
     private readonly lineSpacing;
     /**
@@ -685,6 +715,8 @@ declare class Text extends LabelField {
     private height;
     private endsWithBreak;
     constructor(content: string, x: number, y: number, formatted?: boolean);
+    setPosition(position: Point): void;
+    getPosition(): Point;
     /**
      * Sets the field to single line
      * @param width Max width of the text. Leave it undefined to allow the field to grow
@@ -702,11 +734,6 @@ 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) */
@@ -750,14 +777,13 @@ declare class Text extends LabelField {
     private defaultTextWidth;
 }
 
-declare class BarCode extends LabelField {
+declare class BarCode extends RotatableLabelField implements PositionedField {
     private readonly content;
-    private readonly x;
-    private readonly y;
+    private x;
+    private y;
     private readonly type;
     private readonly height;
     private readonly barWidth;
-    private rotation;
     private humanReadable;
     private readonly alignment;
     /**
@@ -770,24 +796,25 @@ declare class BarCode extends LabelField {
      *                 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;
+    setPosition(position: Point): void;
+    getPosition(): Point;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;
 }
 
-declare class Image extends LabelField {
+declare class Image extends RotatableLabelField implements PositionedField {
     /**
      * X coordinate in dots
      */
-    private readonly x;
+    private x;
     /**
      * Y coordinate in dots
      */
-    private readonly y;
+    private y;
     private readonly image;
-    private rotation;
     constructor(x: number, y: number, image: BitmapLike);
-    setRotation(rotation: Rotation): void;
+    setPosition(position: Point): void;
+    getPosition(): Point;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;
     /**
      * Create an image field for an image
@@ -801,14 +828,14 @@ declare class Image extends LabelField {
     static create(image: string | Blob, x: number, y: number, width?: number, height?: number): Promise<Image>;
 }
 
-declare class QRCode extends LabelField {
+declare class QRCode extends RotatableLabelField implements PositionedField {
     private readonly content;
-    private readonly x;
-    private readonly y;
+    private x;
+    private y;
     private readonly width;
-    private rotation;
     constructor(content: string, x: number, y: number, width: number);
-    setRotation(rotation: Rotation): void;
+    setPosition(position: Point): void;
+    getPosition(): Point;
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig | undefined): Promise<Command>;
 }
 

package/dist/index.d.ts

@@ -91,6 +91,16 @@ type BitmapLike = {
  */
 type BWBitmap = BitmapLike;
 
+type Point = {
+    x: number;
+    y: number;
+};
+type Dimension = {
+    width: number;
+    height: number;
+};
+type Rotation = 0 | 90 | 180 | 270;
+
 /**
  * Interface that should be implemented by a command generator object for each language
  */
@@ -144,7 +154,6 @@ declare abstract class TSPLVisualCommand extends TSPLCommand {
     constructor(x: number, y: number);
 }
 
-type Rotation = 0 | 90 | 180 | 270;
 type Alignment = undefined | "left" | "center" | "right";
 /**
  * Convert an alignemnt string to its number value
@@ -442,7 +451,6 @@ type index$3_ECCLevel = ECCLevel;
 type index$3_GraphicMode = GraphicMode;
 type index$3_LabelDirection = LabelDirection;
 type index$3_QRModel = QRModel;
-type index$3_Rotation = Rotation;
 type index$3_TSPLBarCommand = TSPLBarCommand;
 declare const index$3_TSPLBarCommand: typeof TSPLBarCommand;
 type index$3_TSPLBitmapCommand = TSPLBitmapCommand;
@@ -481,14 +489,9 @@ type index$3_TSPLVisualCommand = TSPLVisualCommand;
 declare const index$3_TSPLVisualCommand: typeof TSPLVisualCommand;
 declare const index$3_alignmentToNumber: typeof alignmentToNumber;
 declare namespace index$3 {
-  export { type index$3_Alignment as Alignment, type index$3_AutoManual as AutoManual, type index$3_BarcodeHumanReable as BarcodeHumanReable, type index$3_BarcodeType as BarcodeType, type index$3_ECCLevel as ECCLevel, type index$3_GraphicMode as GraphicMode, type index$3_LabelDirection as LabelDirection, type index$3_QRModel as QRModel, type index$3_Rotation as Rotation, index$3_TSPLBarCommand as TSPLBarCommand, index$3_TSPLBitmapCommand as TSPLBitmapCommand, index$3_TSPLBlockCommand as TSPLBlockCommand, index$3_TSPLCLSCommand as TSPLCLSCommand, index$3_TSPLCommand as TSPLCommand, index$3_TSPLCommandGroup as TSPLCommandGroup, index$3_TSPLDensityCommand as TSPLDensityCommand, index$3_TSPLDiagonal as TSPLDiagonal, index$3_TSPLDirectionCommand as TSPLDirectionCommand, index$3_TSPLDisplay as TSPLDisplay, index$3_TSPLDownload as TSPLDownload, index$3_TSPLGapCommand as TSPLGapCommand, index$3_TSPLPrintCommand as TSPLPrintCommand, index$3_TSPLQRCommand as TSPLQRCommand, index$3_TSPLRawCommand as TSPLRawCommand, index$3_TSPLSizeCommand as TSPLSizeCommand, index$3_TSPLTextCommand as TSPLTextCommand, index$3_TSPLVisualCommand as TSPLVisualCommand, index$3_alignmentToNumber as alignmentToNumber, _default as commandGenerator };
+  export { type index$3_Alignment as Alignment, type index$3_AutoManual as AutoManual, type index$3_BarcodeHumanReable as BarcodeHumanReable, type index$3_BarcodeType as BarcodeType, type index$3_ECCLevel as ECCLevel, type index$3_GraphicMode as GraphicMode, type index$3_LabelDirection as LabelDirection, type index$3_QRModel as QRModel, index$3_TSPLBarCommand as TSPLBarCommand, index$3_TSPLBitmapCommand as TSPLBitmapCommand, index$3_TSPLBlockCommand as TSPLBlockCommand, index$3_TSPLCLSCommand as TSPLCLSCommand, index$3_TSPLCommand as TSPLCommand, index$3_TSPLCommandGroup as TSPLCommandGroup, index$3_TSPLDensityCommand as TSPLDensityCommand, index$3_TSPLDiagonal as TSPLDiagonal, index$3_TSPLDirectionCommand as TSPLDirectionCommand, index$3_TSPLDisplay as TSPLDisplay, index$3_TSPLDownload as TSPLDownload, index$3_TSPLGapCommand as TSPLGapCommand, index$3_TSPLPrintCommand as TSPLPrintCommand, index$3_TSPLQRCommand as TSPLQRCommand, index$3_TSPLRawCommand as TSPLRawCommand, index$3_TSPLSizeCommand as TSPLSizeCommand, index$3_TSPLTextCommand as TSPLTextCommand, index$3_TSPLVisualCommand as TSPLVisualCommand, index$3_alignmentToNumber as alignmentToNumber, _default as commandGenerator };
 }
 
-type Point = {
-    x: number;
-    y: number;
-};
-
 type PrinterLanguage = "tspl";
 type UnitSystem = "imperial" | "metric" | "dot";
 
@@ -496,11 +499,13 @@ type index$2_Command = Command;
 declare const index$2_Command: typeof Command;
 type index$2_CommandGroup<T extends Command> = CommandGroup<T>;
 declare const index$2_CommandGroup: typeof CommandGroup;
+type index$2_Dimension = Dimension;
 type index$2_Point = Point;
 type index$2_PrinterLanguage = PrinterLanguage;
+type index$2_Rotation = Rotation;
 type index$2_UnitSystem = UnitSystem;
 declare namespace index$2 {
-  export { index$2_Command as Command, index$2_CommandGroup as CommandGroup, type index$2_Point as Point, type index$2_PrinterLanguage as PrinterLanguage, type index$2_UnitSystem as UnitSystem, index$3 as tspl };
+  export { index$2_Command as Command, index$2_CommandGroup as CommandGroup, type index$2_Dimension as Dimension, type index$2_Point as Point, type index$2_PrinterLanguage as PrinterLanguage, type index$2_Rotation as Rotation, type index$2_UnitSystem as UnitSystem, index$3 as tspl };
 }
 
 type Expand<T> = T extends infer O ? {
@@ -517,6 +522,11 @@ type Font = {
 type FontOption = Expand<Partial<Pick<Font, "style" | "weight">> & Pick<Font, "name"> & {
     size: number;
 }>;
+/**
+ * The orientation, the label will be printed on. This allows designing a label in the natural orientation, than printing to
+ * a label that is rotated in the printer. The rotation is applied to all fields on the label, and it is independent from the rotation of individual fields.
+ */
+type LabelOrientation = "normal" | "left" | "right" | "upside-down";
 
 type PrintConfig = {
     dpi: number;
@@ -539,7 +549,7 @@ declare abstract class Printable {
     /**
      * 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: Printer, config?: PrintConfig): Promise<Command>;
     /**
@@ -571,10 +581,11 @@ declare class Label extends Printable {
     private fonts;
     private dpi;
     private density;
+    private orientation;
     /**
     * List of fields on the label
     */
-    private fields;
+    private container;
     private fontCounter;
     private _textWidthCorrectionFactor;
     /**
@@ -588,6 +599,11 @@ declare class Label extends Printable {
      * @param factor Correction factor (default 1.0, typical range 0.9-1.0)
      */
     setTextWidthCorrectionFactor(factor: number): void;
+    /**
+     * Change the orientation the label is printed in. This will rotate all fields in the container
+     * @param orientation
+     */
+    setOrientation(orientation: LabelOrientation): void;
     constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number, density?: number);
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
@@ -651,26 +667,40 @@ declare class Line extends LabelField {
     commandForLanguage(language: PrinterLanguage): Promise<Command>;
 }
 
+interface RotatableField {
+    setRotation(rotation: Rotation): void;
+    getRotation(): Rotation;
+}
+interface PositionedField {
+    getPosition(): Point;
+    setPosition(position: Point): void;
+}
+
+declare abstract class RotatableLabelField extends LabelField implements RotatableField {
+    protected rotation: Rotation;
+    setRotation(rotation: Rotation): void;
+    getRotation(): Rotation;
+}
+
 /**
  * Presents a piece of text on the label
  */
-declare class Text extends LabelField {
+declare class Text extends RotatableLabelField implements PositionedField {
     private readonly content;
     /**
      * X coordinate in dots
      */
-    private readonly x;
+    private x;
     /**
      * Y coordinate in dots
      */
-    private readonly y;
+    private y;
     /**
-     * If true, basic html elements will be interpretted, otherwise the raw string is printed out
+     * If true, basic html elements will be interpreted, otherwise the raw string is printed out
      */
     private readonly formatted;
     private font;
     private type;
-    private rotation;
     private context;
     private readonly lineSpacing;
     /**
@@ -685,6 +715,8 @@ declare class Text extends LabelField {
     private height;
     private endsWithBreak;
     constructor(content: string, x: number, y: number, formatted?: boolean);
+    setPosition(position: Point): void;
+    getPosition(): Point;
     /**
      * Sets the field to single line
      * @param width Max width of the text. Leave it undefined to allow the field to grow
@@ -702,11 +734,6 @@ 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) */
@@ -750,14 +777,13 @@ declare class Text extends LabelField {
     private defaultTextWidth;
 }
 
-declare class BarCode extends LabelField {
+declare class BarCode extends RotatableLabelField implements PositionedField {
     private readonly content;
-    private readonly x;
-    private readonly y;
+    private x;
+    private y;
     private readonly type;
     private readonly height;
     private readonly barWidth;
-    private rotation;
     private humanReadable;
     private readonly alignment;
     /**
@@ -770,24 +796,25 @@ declare class BarCode extends LabelField {
      *                 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;
+    setPosition(position: Point): void;
+    getPosition(): Point;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;
 }
 
-declare class Image extends LabelField {
+declare class Image extends RotatableLabelField implements PositionedField {
     /**
      * X coordinate in dots
      */
-    private readonly x;
+    private x;
     /**
      * Y coordinate in dots
      */
-    private readonly y;
+    private y;
     private readonly image;
-    private rotation;
     constructor(x: number, y: number, image: BitmapLike);
-    setRotation(rotation: Rotation): void;
+    setPosition(position: Point): void;
+    getPosition(): Point;
     commandForLanguage(language: PrinterLanguage, _config?: PrintConfig | undefined): Promise<Command>;
     /**
      * Create an image field for an image
@@ -801,14 +828,14 @@ declare class Image extends LabelField {
     static create(image: string | Blob, x: number, y: number, width?: number, height?: number): Promise<Image>;
 }
 
-declare class QRCode extends LabelField {
+declare class QRCode extends RotatableLabelField implements PositionedField {
     private readonly content;
-    private readonly x;
-    private readonly y;
+    private x;
+    private y;
     private readonly width;
-    private rotation;
     constructor(content: string, x: number, y: number, width: number);
-    setRotation(rotation: Rotation): void;
+    setPosition(position: Point): void;
+    getPosition(): Point;
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig | undefined): Promise<Command>;
 }