label-printer 0.8.1 → 0.9.1

package/dist/index.d.mts

@@ -110,7 +110,7 @@ interface CommandGenerator<T extends Command> {
     /**
      * This should generate the needed commands to set up a label before printing
      */
-    setUp: (width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean, unitSystem: UnitSystem) => T;
+    setUp: (width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean, unitSystem: UnitSystem, density: number) => T;
 }
 
 /**
@@ -397,6 +397,16 @@ declare class TSPLDiagonal extends TSPLCommand {
     get commandString(): string;
 }
 
+/**
+ * Clear the image buffer
+ * {@link /documentsions/TSPL.pdf}
+ */
+declare class TSPLDensityCommand extends TSPLCommand {
+    private density;
+    constructor(density: number);
+    get commandString(): string;
+}
+
 /**
  * Command generator for tspl commands
  */
@@ -405,7 +415,7 @@ declare class TSPLCommandGenerator implements CommandGenerator<TSPLCommand> {
     print(sets: number, copiesPerSet: number): TSPLCommand;
     text(content: string, x: number, y: number, font: string | "default", size: number): TSPLCommand;
     upload(name: string, data: ArrayBuffer | Uint8Array): TSPLCommand;
-    setUp(width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean | undefined, unitSystem: UnitSystem): 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;
@@ -436,6 +446,8 @@ type index$3_TSPLCommand = TSPLCommand;
 declare const index$3_TSPLCommand: typeof TSPLCommand;
 type index$3_TSPLCommandGroup = TSPLCommandGroup;
 declare const index$3_TSPLCommandGroup: typeof TSPLCommandGroup;
+type index$3_TSPLDensityCommand = TSPLDensityCommand;
+declare const index$3_TSPLDensityCommand: typeof TSPLDensityCommand;
 type index$3_TSPLDiagonal = TSPLDiagonal;
 declare const index$3_TSPLDiagonal: typeof TSPLDiagonal;
 type index$3_TSPLDirectionCommand = TSPLDirectionCommand;
@@ -460,7 +472,7 @@ 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_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, 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 };
 }
 
 type Point = {
@@ -547,6 +559,7 @@ declare class Label extends Printable {
     private readonly unitSystem;
     private fonts;
     private dpi;
+    private density;
     /**
     * List of fields on the label
     */
@@ -556,7 +569,7 @@ declare class Label extends Printable {
      * Configuration used when generating commands
      */
     get printConfig(): PrintConfig;
-    constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number);
+    constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number, density?: number);
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
      * Place fields to a label
@@ -854,6 +867,13 @@ declare abstract class Printer {
      * @param text String to send to the printer
      */
     writeRawString(text: string): Promise<void>;
+    /**
+     * Writes raw bytes to the printer. Useful when bytes were built elsewhere
+     * (e.g. via Command.commandBytes) and transferred over the network to a service
+     * that is responsible for the physical printing.
+     * @param data Bytes to send to the printer
+     */
+    writeRawBytes(data: Uint8Array | ArrayBuffer): Promise<void>;
     /**
      * Check if the device is indeed a printer
      * @param device

package/dist/index.d.ts

@@ -110,7 +110,7 @@ interface CommandGenerator<T extends Command> {
     /**
      * This should generate the needed commands to set up a label before printing
      */
-    setUp: (width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean, unitSystem: UnitSystem) => T;
+    setUp: (width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean, unitSystem: UnitSystem, density: number) => T;
 }
 
 /**
@@ -397,6 +397,16 @@ declare class TSPLDiagonal extends TSPLCommand {
     get commandString(): string;
 }
 
+/**
+ * Clear the image buffer
+ * {@link /documentsions/TSPL.pdf}
+ */
+declare class TSPLDensityCommand extends TSPLCommand {
+    private density;
+    constructor(density: number);
+    get commandString(): string;
+}
+
 /**
  * Command generator for tspl commands
  */
@@ -405,7 +415,7 @@ declare class TSPLCommandGenerator implements CommandGenerator<TSPLCommand> {
     print(sets: number, copiesPerSet: number): TSPLCommand;
     text(content: string, x: number, y: number, font: string | "default", size: number): TSPLCommand;
     upload(name: string, data: ArrayBuffer | Uint8Array): TSPLCommand;
-    setUp(width: number, height: number, gap: number, offset: number, direction: LabelDirection, mirror: boolean | undefined, unitSystem: UnitSystem): 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;
@@ -436,6 +446,8 @@ type index$3_TSPLCommand = TSPLCommand;
 declare const index$3_TSPLCommand: typeof TSPLCommand;
 type index$3_TSPLCommandGroup = TSPLCommandGroup;
 declare const index$3_TSPLCommandGroup: typeof TSPLCommandGroup;
+type index$3_TSPLDensityCommand = TSPLDensityCommand;
+declare const index$3_TSPLDensityCommand: typeof TSPLDensityCommand;
 type index$3_TSPLDiagonal = TSPLDiagonal;
 declare const index$3_TSPLDiagonal: typeof TSPLDiagonal;
 type index$3_TSPLDirectionCommand = TSPLDirectionCommand;
@@ -460,7 +472,7 @@ 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_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, 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 };
 }
 
 type Point = {
@@ -547,6 +559,7 @@ declare class Label extends Printable {
     private readonly unitSystem;
     private fonts;
     private dpi;
+    private density;
     /**
     * List of fields on the label
     */
@@ -556,7 +569,7 @@ declare class Label extends Printable {
      * Configuration used when generating commands
      */
     get printConfig(): PrintConfig;
-    constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number);
+    constructor(width: number, height: number, dimensionUnit?: UnitSystem, dpi?: number, density?: number);
     commandForLanguage(language: PrinterLanguage, config?: PrintConfig): Promise<Command>;
     /**
      * Place fields to a label
@@ -854,6 +867,13 @@ declare abstract class Printer {
      * @param text String to send to the printer
      */
     writeRawString(text: string): Promise<void>;
+    /**
+     * Writes raw bytes to the printer. Useful when bytes were built elsewhere
+     * (e.g. via Command.commandBytes) and transferred over the network to a service
+     * that is responsible for the physical printing.
+     * @param data Bytes to send to the printer
+     */
+    writeRawBytes(data: Uint8Array | ArrayBuffer): Promise<void>;
     /**
      * Check if the device is indeed a printer
      * @param device

package/dist/index.js

@@ -193,6 +193,7 @@ __export(tspl_exports, {
   TSPLCLSCommand: () => TSPLCLSCommand,
   TSPLCommand: () => TSPLCommand,
   TSPLCommandGroup: () => TSPLCommandGroup,
+  TSPLDensityCommand: () => TSPLDensityCommand,
   TSPLDiagonal: () => TSPLDiagonal,
   TSPLDirectionCommand: () => TSPLDirectionCommand,
   TSPLDisplay: () => TSPLDisplay,
@@ -1409,6 +1410,17 @@ var TSPLDiagonal = class extends TSPLCommand {
   }
 };
 
+// src/commands/tspl/commands/basic/TSPLDensityCommand.ts
+var TSPLDensityCommand = class extends TSPLCommand {
+  constructor(density) {
+    super();
+    this.density = density;
+  }
+  get commandString() {
+    return `DENSITY ${this.density}`;
+  }
+};
+
 // src/commands/tspl/commands/basic/TSPLBarcodeCommand.ts
 var TSPLBarcodeCommand = class _TSPLBarcodeCommand extends TSPLVisualCommand {
   /**
@@ -1509,11 +1521,12 @@ var TSPLCommandGenerator = class {
   upload(name, data) {
     return new TSPLDownload(name, data);
   }
-  setUp(width, height, gap, offset, direction, mirror = false, unitSystem) {
+  setUp(width, height, gap, offset, direction, mirror = false, unitSystem, density) {
     const commands = [
       new TSPLSizeCommand(width, height, unitSystem),
       new TSPLGapCommand(gap, offset, unitSystem),
       new TSPLDirectionCommand(direction, mirror),
+      new TSPLDensityCommand(density),
       new TSPLCLSCommand()
     ];
     return new TSPLCommandGroup(commands);
@@ -1610,6 +1623,18 @@ var Printer = class {
       yield this.device.writeString(text);
     });
   }
+  /**
+   * Writes raw bytes to the printer. Useful when bytes were built elsewhere
+   * (e.g. via Command.commandBytes) and transferred over the network to a service
+   * that is responsible for the physical printing.
+   * @param data Bytes to send to the printer
+   */
+  writeRawBytes(data) {
+    return __async(this, null, function* () {
+      if (!this.device.opened) yield this.device.openAndConfigure();
+      yield this.device.writeData(data);
+    });
+  }
   /**
    * Check if the device is indeed a printer
    * @param device 
@@ -2389,9 +2414,10 @@ var DEFAULT_FONT_WEIGHT = 400;
 var DEFAULT_FONT_STYLE = "normal";
 var FONT_PREFIX = "f";
 var Label = class extends Printable {
-  constructor(width, height, dimensionUnit = "metric", dpi = 203) {
+  constructor(width, height, dimensionUnit = "metric", dpi = 203, density = 8) {
     super();
     this.fonts = {};
+    this.density = 8;
     /**
     * List of fields on the label
     */
@@ -2401,6 +2427,7 @@ var Label = class extends Printable {
     this.height = height;
     this.unitSystem = dimensionUnit;
     this.dpi = dpi;
+    this.density = density;
   }
   /**
    * Configuration used when generating commands
@@ -2503,7 +2530,16 @@ var Label = class extends Printable {
     return __async(this, null, function* () {
       const commands = [
         this.fontUploadCommands(generator),
-        generator.setUp(this.width, this.height, gap, gapOffset, direction, mirror, this.unitSystem),
+        generator.setUp(
+          this.width,
+          this.height,
+          gap,
+          gapOffset,
+          direction,
+          mirror,
+          this.unitSystem,
+          this.density
+        ),
         yield this.commandForLanguage(language, this.printConfig)
       ];
       return commands;