tauri-plugin-thermal-printer 1.1.0 → 1.3.0

package/dist-js/index.cjs

@@ -2,20 +2,267 @@
 
 var core = require('@tauri-apps/api/core');
 
+const PAPER_SIZE_CHARS_PER_LINE = {
+    Mm40: 21,
+    Mm44: 24,
+    Mm58: 32,
+    Mm72: 42,
+    Mm80: 48,
+    Mm104: 62,
+};
+const PAPER_SIZE_PIXELS_WIDTH = {
+    Mm40: 256,
+    Mm44: 288,
+    Mm58: 384,
+    Mm72: 512,
+    Mm80: 576,
+    Mm104: 752,
+};
+const DEFAULT_PAPER_SIZE = 'Mm80';
+function getPaperSizeCharsPerLine(paperSize) {
+    return PAPER_SIZE_CHARS_PER_LINE[paperSize];
+}
+function getPaperSizePixelsWidth(paperSize) {
+    return PAPER_SIZE_PIXELS_WIDTH[paperSize];
+}
+/** Creates a `CodePage` that sends the given ESC/POS code page number. */
+function codePage(n) {
+    return { Page: n };
+}
+// ─── Convenience style presets ────────────────────────────────────────────────
+const TEXT_ALIGN = {
+    LEFT: 'left',
+    CENTER: 'center',
+    RIGHT: 'right',
+};
+const TEXT_SIZE = {
+    NORMAL: 'normal',
+    HEIGHT: 'height',
+    WIDTH: 'width',
+    DOUBLE: 'double',
+};
+const TEXT_FONT = {
+    A: 'A',
+    B: 'B',
+    C: 'C',
+};
+const BARCODE_TYPE = {
+    UPC_A: 'UPC-A',
+    UPC_E: 'UPC-E',
+    EAN13: 'EAN13',
+    EAN8: 'EAN8',
+    CODE39: 'CODE39',
+    ITF: 'ITF',
+    CODABAR: 'CODABAR',
+    CODE93: 'CODE93',
+    CODE128: 'CODE128',
+};
+const BARCODE_TEXT_POSITION = {
+    NONE: 'none',
+    ABOVE: 'above',
+    BELOW: 'below',
+    BOTH: 'both',
+};
+const QR_ERROR_CORRECTION = {
+    /** Low — 7% recovery */
+    L: 'L',
+    /** Medium — 15% recovery (recommended default) */
+    M: 'M',
+    /** Quartile — 25% recovery */
+    Q: 'Q',
+    /** High — 30% recovery */
+    H: 'H',
+};
+const IMAGE_MODE = {
+    NORMAL: 'normal',
+    DOUBLE_WIDTH: 'double_width',
+    DOUBLE_HEIGHT: 'double_height',
+    QUADRUPLE: 'quadruple',
+};
+const CUT_MODE = {
+    FULL: 'full',
+    PARTIAL: 'partial',
+};
+const CODE_PAGE = {
+    /** Strips accents and special chars to plain ASCII. Use when the printer
+     *  ignores ESC t commands. á→a, é→e, ñ→n, ß→ss, ¿→?, €→EUR, etc. */
+    ACCENT_REMOVER: 'AccentRemover',
+};
+// ─── Helper builders ──────────────────────────────────────────────────────────
+/** Creates a Title section */
+function title(text, styles) {
+    return { Title: { text, styles } };
+}
+/** Creates a Subtitle section */
+function subtitle(text, styles) {
+    return { Subtitle: { text, styles } };
+}
+/** Creates a Text section */
+function text(text, styles) {
+    return { Text: { text, styles } };
+}
+/** Creates a Line separator section */
+function line(character = '-') {
+    return { Line: { character } };
+}
+/** Creates a Feed section */
+function feed(value, feed_type = 'lines') {
+    return { Feed: { feed_type, value } };
+}
+/** Creates a Cut section */
+function cut(mode = 'partial', feedLines = 4) {
+    return { Cut: { mode, feed: feedLines } };
+}
+/** Creates a GlobalStyles section — affects all subsequent sections until changed */
+function globalStyles(styles) {
+    return { GlobalStyles: styles };
+}
+/** Creates a Beep section */
+function beep(times = 1, duration = 3) {
+    return { Beep: { times, duration } };
+}
+/** Creates a Drawer section */
+function drawer(pin = 2, pulse_time = 120) {
+    return { Drawer: { pin, pulse_time } };
+}
+/** Creates a Table section */
+function table(columns, body, options) {
+    return {
+        Table: {
+            columns,
+            body,
+            column_widths: options?.column_widths,
+            header: options?.header,
+            truncate: options?.truncate ?? true,
+        },
+    };
+}
+/** Creates a QR section */
+function qr(data, options) {
+    return {
+        Qr: {
+            data,
+            size: options?.size ?? 6,
+            error_correction: options?.error_correction ?? 'M',
+            model: options?.model ?? 2,
+            align: options?.align,
+        },
+    };
+}
+/** Creates a Barcode section */
+function barcode(data, barcode_type = 'CODE128', options) {
+    return {
+        Barcode: {
+            data,
+            barcode_type,
+            width: options?.width ?? 3,
+            height: options?.height ?? 80,
+            text_position: options?.text_position ?? 'below',
+            align: options?.align,
+        },
+    };
+}
+/** Creates a DataMatrix section */
+function dataMatrix(data, size = 6) {
+    return {
+        DataMatrix: {
+            data,
+            size,
+        },
+    };
+}
+/** Creates a PDF417 section */
+function pdf417(data, options) {
+    return {
+        Pdf417: {
+            data,
+            columns: options?.columns ?? 0,
+            rows: options?.rows ?? 0,
+            width: options?.width ?? 2,
+            height: options?.height ?? 3,
+            error_correction: options?.error_correction ?? 2,
+        },
+    };
+}
+/** Creates an Image section */
+function image(data, options) {
+    return {
+        Image: {
+            data,
+            max_width: options?.max_width ?? 0,
+            align: options?.align ?? 'center',
+            dithering: options?.dithering ?? true,
+            size: options?.size ?? 'normal',
+        },
+    };
+}
+/** Creates a Logo section */
+function logo(key_code, mode = 'normal') {
+    return {
+        Logo: {
+            key_code,
+            mode,
+        },
+    };
+}
+// ─── Commands ─────────────────────────────────────────────────────────────────
+/**
+ * Sends a print job to the specified thermal printer.
+ * @throws {string} Error message from the printer or document generation if the job fails.
+ */
 async function print_thermal_printer(printJobRequest) {
-    return await core.invoke('plugin:thermal-printer|print_thermal_printer', {
-        printJobRequest: printJobRequest,
+    await core.invoke('plugin:thermal-printer|print_thermal_printer', {
+        printJobRequest,
     });
 }
+/**
+ * Returns the list of available thermal printers on the current system.
+ * @throws {string} Error message if printer enumeration fails.
+ */
 async function list_thermal_printers() {
     return await core.invoke('plugin:thermal-printer|list_thermal_printers');
 }
+/**
+ * Sends a test print job to verify the printer is working correctly.
+ * @throws {string} Error message from the printer or document generation if the job fails.
+ */
 async function test_thermal_printer(testPrintRequest) {
-    return await core.invoke('plugin:thermal-printer|test_thermal_printer', {
+    await core.invoke('plugin:thermal-printer|test_thermal_printer', {
         printTestRequest: testPrintRequest,
     });
 }
 
+exports.BARCODE_TEXT_POSITION = BARCODE_TEXT_POSITION;
+exports.BARCODE_TYPE = BARCODE_TYPE;
+exports.CODE_PAGE = CODE_PAGE;
+exports.CUT_MODE = CUT_MODE;
+exports.DEFAULT_PAPER_SIZE = DEFAULT_PAPER_SIZE;
+exports.IMAGE_MODE = IMAGE_MODE;
+exports.PAPER_SIZE_CHARS_PER_LINE = PAPER_SIZE_CHARS_PER_LINE;
+exports.PAPER_SIZE_PIXELS_WIDTH = PAPER_SIZE_PIXELS_WIDTH;
+exports.QR_ERROR_CORRECTION = QR_ERROR_CORRECTION;
+exports.TEXT_ALIGN = TEXT_ALIGN;
+exports.TEXT_FONT = TEXT_FONT;
+exports.TEXT_SIZE = TEXT_SIZE;
+exports.barcode = barcode;
+exports.beep = beep;
+exports.codePage = codePage;
+exports.cut = cut;
+exports.dataMatrix = dataMatrix;
+exports.drawer = drawer;
+exports.feed = feed;
+exports.getPaperSizeCharsPerLine = getPaperSizeCharsPerLine;
+exports.getPaperSizePixelsWidth = getPaperSizePixelsWidth;
+exports.globalStyles = globalStyles;
+exports.image = image;
+exports.line = line;
 exports.list_thermal_printers = list_thermal_printers;
+exports.logo = logo;
+exports.pdf417 = pdf417;
 exports.print_thermal_printer = print_thermal_printer;
+exports.qr = qr;
+exports.subtitle = subtitle;
+exports.table = table;
 exports.test_thermal_printer = test_thermal_printer;
+exports.text = text;
+exports.title = title;

package/dist-js/index.d.ts

@@ -1,19 +1,117 @@
-export type PaperSize = 'Mm58' | 'Mm80';
+export type PaperSize = 'Mm40' | 'Mm44' | 'Mm58' | 'Mm72' | 'Mm80' | 'Mm104';
+export declare const PAPER_SIZE_CHARS_PER_LINE: Record<PaperSize, number>;
+export declare const PAPER_SIZE_PIXELS_WIDTH: Record<PaperSize, number>;
+export declare const DEFAULT_PAPER_SIZE: PaperSize;
+export declare function getPaperSizeCharsPerLine(paperSize: PaperSize): number;
+export declare function getPaperSizePixelsWidth(paperSize: PaperSize): number;
+/**
+ * Character encoding page to use for printing.
+ *
+ * - `{ Page: n }` — sends `ESC t n` to the printer; the user is responsible
+ *   for choosing the correct number for their printer model and ensuring the
+ *   text is already encoded accordingly.
+ * - `"AccentRemover"` — strips accents/diacritics to plain ASCII before
+ *   sending. Use when the printer ignores `ESC t` or has no alternate code
+ *   page. Examples: á→a, é→e, ñ→n, ß→ss, ¿→?, €→EUR.
+ */
+export type CodePage = {
+    Page: number;
+} | 'AccentRemover';
+/** Creates a `CodePage` that sends the given ESC/POS code page number. */
+export declare function codePage(n: number): CodePage;
+/** Text alignment options */
+export type TextAlign = 'left' | 'center' | 'right';
+/** Text size options */
+export type TextSize = 'normal' | 'height' | 'width' | 'double';
+/** Font options */
+export type TextFont = 'A' | 'B' | 'C';
+/** Barcode text position options */
+export type BarcodeTextPosition = 'none' | 'above' | 'below' | 'both';
+/** Barcode type options */
+export type BarcodeType = 'UPC-A' | 'UPC-E' | 'EAN13' | 'EAN8' | 'CODE39' | 'ITF' | 'CODABAR' | 'CODE93' | 'CODE128';
+/** QR error correction level */
+export type QrErrorCorrection = 'L' | 'M' | 'Q' | 'H';
+/** Image size mode */
+export type ImageMode = 'normal' | 'double_width' | 'double_height' | 'quadruple';
+/** Feed type */
+export type FeedType = 'lines' | 'dots' | 'line_feed';
+/** Cut mode */
+export type CutMode = 'full' | 'partial' | 'partial_alt' | 'partial_alt2';
+export declare const TEXT_ALIGN: {
+    readonly LEFT: TextAlign;
+    readonly CENTER: TextAlign;
+    readonly RIGHT: TextAlign;
+};
+export declare const TEXT_SIZE: {
+    readonly NORMAL: TextSize;
+    readonly HEIGHT: TextSize;
+    readonly WIDTH: TextSize;
+    readonly DOUBLE: TextSize;
+};
+export declare const TEXT_FONT: {
+    readonly A: TextFont;
+    readonly B: TextFont;
+    readonly C: TextFont;
+};
+export declare const BARCODE_TYPE: {
+    readonly UPC_A: BarcodeType;
+    readonly UPC_E: BarcodeType;
+    readonly EAN13: BarcodeType;
+    readonly EAN8: BarcodeType;
+    readonly CODE39: BarcodeType;
+    readonly ITF: BarcodeType;
+    readonly CODABAR: BarcodeType;
+    readonly CODE93: BarcodeType;
+    readonly CODE128: BarcodeType;
+};
+export declare const BARCODE_TEXT_POSITION: {
+    readonly NONE: BarcodeTextPosition;
+    readonly ABOVE: BarcodeTextPosition;
+    readonly BELOW: BarcodeTextPosition;
+    readonly BOTH: BarcodeTextPosition;
+};
+export declare const QR_ERROR_CORRECTION: {
+    /** Low — 7% recovery */
+    readonly L: QrErrorCorrection;
+    /** Medium — 15% recovery (recommended default) */
+    readonly M: QrErrorCorrection;
+    /** Quartile — 25% recovery */
+    readonly Q: QrErrorCorrection;
+    /** High — 30% recovery */
+    readonly H: QrErrorCorrection;
+};
+export declare const IMAGE_MODE: {
+    readonly NORMAL: ImageMode;
+    readonly DOUBLE_WIDTH: ImageMode;
+    readonly DOUBLE_HEIGHT: ImageMode;
+    readonly QUADRUPLE: ImageMode;
+};
+export declare const CUT_MODE: {
+    readonly FULL: CutMode;
+    readonly PARTIAL: CutMode;
+};
+export declare const CODE_PAGE: {
+    /** Strips accents and special chars to plain ASCII. Use when the printer
+     *  ignores ESC t commands. á→a, é→e, ñ→n, ß→ss, ¿→?, €→EUR, etc. */
+    readonly ACCENT_REMOVER: CodePage;
+};
 export interface PrinterOptions {
     cut_paper: boolean;
     beep: boolean;
     open_cash_drawer: boolean;
+    /** Character encoding for the printer. Default: `{ Page: 0 }` (CP437, ASCII only). */
+    code_page?: CodePage;
 }
 export interface GlobalStyles {
     bold?: boolean;
     underline?: boolean;
-    align?: 'left' | 'center' | 'right' | string;
+    align?: TextAlign;
     italic?: boolean;
     invert?: boolean;
-    font?: 'A' | 'B' | 'C' | 'D' | 'E' | string;
+    font?: TextFont;
     rotate?: boolean;
     upside_down?: boolean;
-    size?: 'normal' | 'height' | 'width' | 'double' | string;
+    size?: TextSize;
 }
 export interface Title {
     text: string;
@@ -28,19 +126,21 @@ export interface Text {
     styles?: GlobalStyles;
 }
 export interface Feed {
-    feed_type: 'lines' | 'pixels' | string;
+    feed_type: FeedType;
     value: number;
 }
 export interface Cut {
-    mode: 'full' | 'partial' | string;
+    mode: CutMode;
     feed: number;
 }
 export interface Beep {
+    /** Number of beeps (1–9) */
     times: number;
+    /** Duration per beep in ms (1–255) */
     duration: number;
 }
 export interface Drawer {
-    pin: number;
+    pin: 2 | 5;
     pulse_time: number;
 }
 export interface Table {
@@ -52,43 +152,56 @@ export interface Table {
 }
 export interface Qr {
     data: string;
+    /** Module size 1–16 (default 6) */
     size: number;
-    error_correction: 'L' | 'M' | 'Q' | 'H' | string;
-    model: number;
-    align?: 'left' | 'center' | 'right' | string;
+    error_correction: QrErrorCorrection;
+    model: 1 | 2;
+    align?: TextAlign;
 }
 export interface Barcode {
     data: string;
-    barcode_type: 'UPCA' | 'UPCE' | 'EAN13' | 'EAN8' | 'CODE39' | 'ITF' | 'CODABAR' | 'CODE93' | 'CODE128' | string;
+    barcode_type: BarcodeType;
+    /** Bar width 2–6 */
     width: number;
+    /** Bar height in dots (1–255) */
     height: number;
-    text_position: 'none' | 'above' | 'below' | 'both' | string;
-    align?: 'left' | 'center' | 'right' | string;
+    text_position: BarcodeTextPosition;
+    align?: TextAlign;
 }
 export interface DataMatrixModel {
     data: string;
+    /** Module size 1–16 */
     size: number;
 }
 export interface Pdf417 {
     data: string;
+    /** Columns 0 (auto) or 1–30 */
     columns: number;
+    /** Rows 0 (auto) or 3–90 */
     rows: number;
+    /** Module width 2–8 */
     width: number;
+    /** Row height 2–8 */
     height: number;
+    /** Error correction level 0–8 */
     error_correction: number;
 }
 export interface Image {
+    /** Base64 encoded image (with or without data URI prefix) */
     data: string;
+    /** Max width in pixels. 0 = use full paper width. */
     max_width: number;
-    align: 'left' | 'center' | 'right' | string;
+    align: TextAlign;
     dithering: boolean;
-    size: 'normal' | 'double_width' | 'double_height' | 'double' | string;
+    size: ImageMode;
 }
 export interface Logo {
+    /** NV memory key code (1–255) */
     key_code: number;
-    mode: 'normal' | 'double_width' | 'double_height' | 'double' | string;
+    mode: ImageMode;
 }
 export interface Line {
+    /** Single character to repeat across the paper width (default '-') */
     character: string;
 }
 export type PrintSections = {
@@ -139,6 +252,8 @@ export interface PrinterInfo {
 export interface TestPrintRequest {
     printer_info: PrintJobRequest;
     include_text?: boolean;
+    include_custom_text?: boolean;
+    custom_text?: string | null;
     include_text_styles?: boolean;
     include_alignment?: boolean;
     include_columns?: boolean;
@@ -156,6 +271,75 @@ export interface TestPrintRequest {
     test_invert?: boolean;
     test_rotate?: boolean;
 }
-export declare function print_thermal_printer(printJobRequest: PrintJobRequest): Promise<boolean>;
+/** Creates a Title section */
+export declare function title(text: string, styles?: GlobalStyles): PrintSections;
+/** Creates a Subtitle section */
+export declare function subtitle(text: string, styles?: GlobalStyles): PrintSections;
+/** Creates a Text section */
+export declare function text(text: string, styles?: GlobalStyles): PrintSections;
+/** Creates a Line separator section */
+export declare function line(character?: string): PrintSections;
+/** Creates a Feed section */
+export declare function feed(value: number, feed_type?: FeedType): PrintSections;
+/** Creates a Cut section */
+export declare function cut(mode?: CutMode, feedLines?: number): PrintSections;
+/** Creates a GlobalStyles section — affects all subsequent sections until changed */
+export declare function globalStyles(styles: GlobalStyles): PrintSections;
+/** Creates a Beep section */
+export declare function beep(times?: number, duration?: number): PrintSections;
+/** Creates a Drawer section */
+export declare function drawer(pin?: 2 | 5, pulse_time?: number): PrintSections;
+/** Creates a Table section */
+export declare function table(columns: number, body: Text[][], options?: {
+    column_widths?: number[];
+    header?: Text[];
+    truncate?: boolean;
+}): PrintSections;
+/** Creates a QR section */
+export declare function qr(data: string, options?: {
+    size?: number;
+    error_correction?: QrErrorCorrection;
+    model?: 1 | 2;
+    align?: TextAlign;
+}): PrintSections;
+/** Creates a Barcode section */
+export declare function barcode(data: string, barcode_type?: BarcodeType, options?: {
+    width?: number;
+    height?: number;
+    text_position?: BarcodeTextPosition;
+    align?: TextAlign;
+}): PrintSections;
+/** Creates a DataMatrix section */
+export declare function dataMatrix(data: string, size?: number): PrintSections;
+/** Creates a PDF417 section */
+export declare function pdf417(data: string, options?: {
+    columns?: number;
+    rows?: number;
+    width?: number;
+    height?: number;
+    error_correction?: number;
+}): PrintSections;
+/** Creates an Image section */
+export declare function image(data: string, options?: {
+    max_width?: number;
+    align?: TextAlign;
+    dithering?: boolean;
+    size?: ImageMode;
+}): PrintSections;
+/** Creates a Logo section */
+export declare function logo(key_code: number, mode?: ImageMode): PrintSections;
+/**
+ * Sends a print job to the specified thermal printer.
+ * @throws {string} Error message from the printer or document generation if the job fails.
+ */
+export declare function print_thermal_printer(printJobRequest: PrintJobRequest): Promise<void>;
+/**
+ * Returns the list of available thermal printers on the current system.
+ * @throws {string} Error message if printer enumeration fails.
+ */
 export declare function list_thermal_printers(): Promise<PrinterInfo[]>;
-export declare function test_thermal_printer(testPrintRequest: TestPrintRequest): Promise<boolean>;
+/**
+ * Sends a test print job to verify the printer is working correctly.
+ * @throws {string} Error message from the printer or document generation if the job fails.
+ */
+export declare function test_thermal_printer(testPrintRequest: TestPrintRequest): Promise<void>;