tauri-plugin-thermal-printer 1.3.2 → 2.0.0

package/README.md

@@ -1,5 +1,8 @@
 # Tauri Plugin thermal-printer
 
+> **BREAKING CHANGES:** The 2.0.0 and newer versions **removed** the `PrinterOptions` interface to simplify configuration. The `options` field in `PrintJobRequest` now directly accepts a `CodePage` object. 
+> The shorthand options (`cut_paper`, `beep`, and `open_cash_drawer`) have been **removed**. If you need these actions, explicitly append them as sections (e.g., `{"Cut": {"mode": "partial", "feed": 0}}`) at the end of your `sections` array.
+
 This plugin provides thermal printer functionality for Tauri applications, allowing you to print documents, test printers, and list available printers.
 
 | Platform | Supported |
@@ -116,8 +119,8 @@ pub fn generate_document(&mut self, print_job: &PrintJobRequest) -> Result<Vec<u
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false
+    "code_page": 6,
+    "encode": "WINDOWS_1252"
   },
   "sections": [
     {"Title": {"text": "My Title"}},
@@ -281,14 +284,9 @@ try { await test_thermal_printer({
     "printer": "TM-T20II",
     "paper_size": "Mm80",
     "options": {
-      "cut_paper": true,
-      "beep": true,
-      "open_cash_drawer": false,
-      "code_page": {
-        "code_page": 6,
-        "encode": ENCODE.WINDOWS_1252,
-        "use_gbk": false
-      }
+      "code_page": 6,
+      "encode": ENCODE.WINDOWS_1252,
+      "use_gbk": false
     },
     "sections": [] // it's not going to print anything
   },
@@ -352,14 +350,9 @@ try { await print_thermal_printer({
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false,
-    "code_page": {
-      "code_page": 6,
-      "encode": ENCODE.WINDOWS_1252,
-      "use_gbk": false
-    }
+    "code_page": 6,
+    "encode": ENCODE.WINDOWS_1252,
+    "use_gbk": false
   },
   "sections": [
     {"Title": {"text": "My Business"}},
@@ -390,11 +383,7 @@ Returns `Promise<void>`. Resolves when printing completes successfully. **Throws
 |-----------|------|----------|-------------|
 | `printer` | string | ✅ Yes | Printer name |
 | `paper_size` | PaperSize | ❌ No | Paper size (default: `"Mm80"`) — see [Paper Sizes](#paper-sizes) |
-| `options` | PrinterOptions | ❌ No | Configuration options |
-| `options.cut_paper` | boolean | ❌ No | Cut paper after printing (default: `true`) |
-| `options.beep` | boolean | ❌ No | Beep after printing (default: `false`) |
-| `options.open_cash_drawer` | boolean | ❌ No | Open cash drawer after printing (default: `false`) |
-| `options.code_page` | CodePage | ✅ Yes | Required ESC/POS page selection plus host-side encoding strategy — see [CodePage](#codepage) |
+| `options` | CodePage | ✅ Yes | Required ESC/POS page selection plus host-side encoding strategy — see [CodePage](#codepage) |
 | `sections` | array | ✅ Yes | Array of sections to print (see [Section Types](#section-types)) |
 
 #### Paper Sizes
@@ -897,14 +886,9 @@ Each printer model assigns its own `ESC t n` values, so `CodePage.code_page` acc
 import { ENCODE, type CodePage } from "tauri-plugin-thermal-printer";
 
 const options = {
-  cut_paper: true,
-  beep: false,
-  open_cash_drawer: false,
-  code_page: {
-    code_page: 6,
-    encode: ENCODE.WINDOWS_1252,
-    use_gbk: false,
-  }, // sends ESC t 6
+  code_page: 6,
+  encode: ENCODE.WINDOWS_1252,
+  use_gbk: false,
 };
 ```
 
@@ -1068,14 +1052,9 @@ const job: PrintJobRequest = {
   printer: "TM-T20II",
   paper_size: "Mm80",
   options: {
-    cut_paper: true,
-    beep: false,
-    open_cash_drawer: false,
-    code_page: {
-      code_page: 6,
-      encode: ENCODE.WINDOWS_1252,
-      use_gbk: false,
-    },
+    code_page: 0,
+    encode: ENCODE.ACCENT_REMOVER,
+    use_gbk: false,
   },
   sections: [
     globalStyles({ align: TEXT_ALIGN.LEFT }),
@@ -1144,7 +1123,7 @@ await print_thermal_printer(job);
 
 This section contains practical examples for different use cases. Each example demonstrates how to structure print jobs for various business scenarios.
 
-> **NOTE:** Paper is automatically cut at the end of printing with a full cut. You don't need to add a `Cut` section manually unless you want a specific partial cut.
+> **NOTE:** With default options, a tail `Cut` section is appended automatically as `{ "Cut": { "mode": "partial", "feed": 0 } }`. Add your own `Cut` section when you need an extra cut or different parameters.
 
 ### 🛒 Long Receipt (Supermarket - 80mm)
 
@@ -1155,9 +1134,9 @@ const receipt: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "SUPERMERCADO LA ECONOMÍA", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1277,9 +1256,9 @@ const restaurantTicket: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "RESTAURANTE EL BUEN SABOR", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1364,9 +1343,9 @@ const kitchenOrder: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": true,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "*** COMANDA COCINA ***", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1402,9 +1381,9 @@ const productLabel: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm58",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "PRODUCTO", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1430,9 +1409,9 @@ const turnTicket: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm58",
   "options": {
-    "cut_paper": true,
-    "beep": true,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "TICKET DE TURNO", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1463,9 +1442,9 @@ const parkingTicket: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "ESTACIONAMIENTO", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1500,9 +1479,9 @@ const eventTicket: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "CONCIERTO 2025", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1559,9 +1538,9 @@ const paymentReceipt: PrintJobRequest = {
   "printer": "TM-T20II",
   "paper_size": "Mm80",
   "options": {
-    "cut_paper": true,
-    "beep": false,
-    "open_cash_drawer": false
+    "code_page": 0,
+    "encode": ENCODE.ACCENT_REMOVER,
+    "use_gbk": false,
   },
   "sections": [
     {"Title": {"text": "COMPROBANTE DE PAGO", "styles": {"bold": true, "underline": false, "align": "center", "italic": false, "invert": false, "font": "A", "rotate": false, "upside_down": false, "size": "Double"}}},
@@ -1625,5 +1604,6 @@ const paymentReceipt: PrintJobRequest = {
 - No need to manually reset styles
 
 #### Paper Cutting
-- **Automatic**: Paper is automatically cut at the end with a full cut
-- **Manual** (optional): Add a `Cut` section if you need a specific partial cut
+- **Automatic**: `options.cut_paper = true` appends a tail `Cut` section with `mode: "partial"` and `feed: 0`
+- **Manual**: Add a `Cut` section anywhere in `sections` to issue explicit cut commands
+- **Combined**: Automatic and manual cuts are both emitted when both are present

package/dist-js/index.d.ts

@@ -10,7 +10,7 @@ export declare function getPaperSizePixelsWidth(paperSize: PaperSize): number;
 /**
  * ESC/POS page selection plus explicit host-side encoding behavior.
  *
- * - `codepage` controls the `ESC t n` command sent to the printer.
+ * - `code_page` controls the `ESC t n` command sent to the printer. Default is 0.
  * - `encode` selects the host-side encoding and defaults to
  *   `ENCODE.ACCENT_REMOVER`.
  * - `use_gbk` controls whether unmapped non-ASCII characters may fall back
@@ -92,13 +92,6 @@ export declare const CUT_MODE: {
     readonly FULL: CutMode;
     readonly PARTIAL: CutMode;
 };
-export interface PrinterOptions {
-    cut_paper: boolean;
-    beep: boolean;
-    open_cash_drawer: boolean;
-    /** Required ESC/POS page plus host-side encoding strategy. */
-    code_page: CodePage;
-}
 export interface GlobalStyles {
     bold?: boolean;
     underline?: boolean;
@@ -237,7 +230,7 @@ export type PrintSections = {
 export interface PrintJobRequest {
     printer: string;
     sections: PrintSections[];
-    options: PrinterOptions;
+    options: CodePage;
     paper_size: PaperSize;
 }
 export interface PrinterInfo {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tauri-plugin-thermal-printer",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "author": "luis3132",
   "description": "Plugin for Tauri to send esc/pos commands to thermal_printer",
   "type": "module",