tauri-plugin-thermal-printer 1.0.2 → 1.2.2

package/dist-js/index.js

@@ -1,17 +1,247 @@
 import { invoke } from '@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];
+}
+// ─── 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 = {
+    /** CP437 — ASCII only, no accented characters */
+    DEFAULT: 'Default',
+    /** CP850 — Spanish, French, Italian, German */
+    SPANISH: 'Spanish',
+    /** CP850 — Alias of Spanish */
+    FRENCH: 'French',
+    /** CP860 — Portuguese (ã, õ) */
+    PORTUGUESE: 'Portuguese',
+    /** CP863 — Canadian French */
+    CANADIAN_FRENCH: 'CanadianFrench',
+    /** CP865 — Nordic languages (å, ø, æ) */
+    NORDIC: 'Nordic',
+    /** CP1252 — Wide Western European, includes € */
+    WINDOWS_LATIN: 'WindowsLatin',
+    /** CP866 — Russian / Cyrillic */
+    RUSSIAN: 'Russian',
+    /** CP852 — Eastern Europe (Polish, Czech, Slovak, Hungarian) */
+    EASTERN_EUROPE: 'EasternEurope',
+    /** 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 invoke('plugin:thermal-printer|print_thermal_printer', {
-        printJobRequest: printJobRequest,
+    await 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 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 invoke('plugin:thermal-printer|test_thermal_printer', {
+    await invoke('plugin:thermal-printer|test_thermal_printer', {
         printTestRequest: testPrintRequest,
     });
 }
 
-export { list_thermal_printers, print_thermal_printer, test_thermal_printer };
+export { BARCODE_TEXT_POSITION, BARCODE_TYPE, CODE_PAGE, CUT_MODE, DEFAULT_PAPER_SIZE, IMAGE_MODE, PAPER_SIZE_CHARS_PER_LINE, PAPER_SIZE_PIXELS_WIDTH, QR_ERROR_CORRECTION, TEXT_ALIGN, TEXT_FONT, TEXT_SIZE, barcode, beep, cut, dataMatrix, drawer, feed, getPaperSizeCharsPerLine, getPaperSizePixelsWidth, globalStyles, image, line, list_thermal_printers, logo, pdf417, print_thermal_printer, qr, subtitle, table, test_thermal_printer, text, title };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tauri-plugin-thermal-printer",
-  "version": "1.0.2",
+  "version": "1.2.2",
   "author": "luis3132",
   "description": "Plugin for Tauri to send esc/pos commands to thermal_printer",
   "type": "module",
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "^12.3.0",
-    "rollup": "^4.57.1",
+    "rollup": "^4.60.1",
     "typescript": "^5.9.3",
     "tslib": "^2.8.1"
   }