@esslassi/electron-printer 0.0.5 → 0.0.7

package/README.md

@@ -1,251 +1,319 @@
-Here is the clean **README.md** content ready to copy and paste:
-
----
-
-# Electron Printer (@esslassi/electron-printer)
-
-Node.js and Electron bindings for printer management and direct printing. Supports Windows and Linux (CUPS).
-
-## Features
-
-* List all available printers
-* Get the system default printer
-* Get detailed printer status
-* Direct printing (raw printing)
-* TypeScript support
-* Asynchronous API (Promises)
-* Compatible with Node.js and Electron
-
-## Requirements
-
-* Node.js >= 18.20.6
-* Electron >= 20.0.0
-* Windows or Linux
-* For Windows: Visual Studio Build Tools
-* For Linux: CUPS development headers
-
-```bash
-sudo apt-get install libcups2-dev
-```
-
-## Installation
-
-```bash
-npm install @esslassi/electron-printer
-```
-
-For development:
-
-```bash
-git clone https://github.com/esslassi/electron-printer.git
-cd electron-printer
-npm install
-npm run rebuild
-```
-
-## Usage
-
-### JavaScript
-
-```javascript
-const printer = require('@esslassi/electron-printer');
-
-// List all printers
-printer.getPrinters()
-  .then(printers => {
-    console.log('Available printers:', printers);
-  })
-  .catch(console.error);
-
-// Get default printer
-printer.getDefaultPrinter()
-  .then(defaultPrinter => {
-    console.log('Default printer:', defaultPrinter);
-  })
-  .catch(console.error);
-
-// Check printer status
-printer.getStatusPrinter({ printerName: 'Printer Name' })
-  .then(status => {
-    console.log('Printer status:', status);
-  })
-  .catch(console.error);
-
-// Print directly
-const printOptions = {
-  printerName: 'Printer Name',
-  data: 'Text to print',
-  dataType: 'RAW' // optional (default is 'RAW')
-};
-
-printer.printDirect(printOptions)
-  .then(result => {
-    console.log('Result:', result);
-  })
-  .catch(console.error);
-```
-
-### TypeScript
-
-```typescript
-import printer, { 
-  Printer, 
-  PrintDirectOptions, 
-  GetStatusPrinterOptions 
-} from '@esslassi/electron-printer';
-
-async function example() {
-  try {
-    const printers: Printer[] = await printer.getPrinters();
-    console.log('Printers:', printers);
-
-    const defaultPrinter: Printer = await printer.getDefaultPrinter();
-    console.log('Default printer:', defaultPrinter);
-
-    const statusOptions: GetStatusPrinterOptions = {
-      printerName: 'Printer Name'
-    };
-    const status: Printer = await printer.getStatusPrinter(statusOptions);
-    console.log('Status:', status);
-
-    const printOptions: PrintDirectOptions = {
-      printerName: 'Printer Name',
-      data: Buffer.from('Text to print'),
-      dataType: 'RAW'
-    };
-
-    const result = await printer.printDirect(printOptions);
-    console.log('Result:', result);
-
-  } catch (error) {
-    console.error('Error:', error);
-  }
-}
-```
-
-## API
-
-### getPrinters(): Promise<Printer[]>
-
-Lists all printers installed on the system.
-
-```typescript
-interface Printer {
-  name: string;
-  isDefault: boolean;
-  status: string;
-  details: {
-    location?: string;
-    comment?: string;
-    driver?: string;
-    port?: string;
-    [key: string]: string | undefined;
-  };
-}
-```
-
----
-
-### getDefaultPrinter(): Promise<Printer>
-
-Returns the system default printer.
-
----
-
-### getStatusPrinter(options: GetStatusPrinterOptions): Promise<Printer>
-
-```typescript
-interface GetStatusPrinterOptions {
-  printerName: string;
-}
-```
-
----
-
-### printDirect(options: PrintDirectOptions): Promise<string>
-
-```typescript
-interface PrintDirectOptions {
-  printerName: string;
-  data: string | Buffer;
-  dataType?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO';
-}
-```
-
-### Possible Status Values
-
-* ready
-* offline
-* error
-* paper-jam
-* paper-out
-* manual-feed
-* paper-problem
-* busy
-* printing
-* output-bin-full
-* not-available
-* waiting
-* processing
-* initializing
-* warming-up
-* toner-low
-* no-toner
-* page-punt
-* user-intervention
-* out-of-memory
-* door-open
-
----
-
-## Supported Platforms
-
-* Windows (32/64-bit)
-* Linux (CUPS)
-
----
-
-## Troubleshooting
-
-### Windows
-
-1. Install Visual Studio Build Tools
-2. Run:
-
-```bash
-npm run rebuild
-```
-
-3. Verify printer access permissions
-
-### Linux
-
-```bash
-sudo apt-get install libcups2-dev
-sudo service cups status
-sudo usermod -a -G lp $USER
-```
-
----
-
-## Development
-
-```bash
-git clone https://github.com/esslassi/electron-printer.git
-cd electron-printer
-npm install
-npm run rebuild
-node test.js
-```
-
----
-
-## License
-
-MIT
-
----
-
-## Author
-
-Esslassi
+# 📦 @esslassi/electron-printer
+
+Cross-platform native printer driver for **Windows, macOS, and Linux**, built with Node-API (N-API).
+Works in **Node.js** and **Electron**.
+
+Supports:
+
+* 🖨 List printers
+* 📄 Print raw/text/command data
+* 📁 Print files
+* 📋 Get printer driver options
+* 📑 Get selected paper size
+* 📦 Get job status
+* ⛔ Cancel / pause / resume jobs
+* 🔄 Promise (async/await) wrappers included
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install @esslassi/electron-printer
+```
+
+If using Electron:
+
+```bash
+npx electron-rebuild
+```
+
+---
+
+## 🧩 Supported Platforms
+
+| OS      | Backend      |
+| ------- | ------------ |
+| Windows | WinSpool API |
+| macOS   | CUPS         |
+| Linux   | CUPS         |
+
+---
+
+# 📖 Usage
+
+```ts
+import * as printer from '@esslassi/electron-printer'
+```
+
+---
+
+# 🖨 Printer Management
+
+### Get all printers
+
+```ts
+const printers = printer.getPrinters()
+```
+
+### Async version
+
+```ts
+const printers = await printer.getPrintersAsync()
+```
+
+---
+
+### Get single printer
+
+```ts
+const details = printer.getPrinter("My Printer")
+```
+
+---
+
+### Get default printer
+
+```ts
+const defaultPrinter = printer.getDefaultPrinterName()
+```
+
+---
+
+### Get printer driver options
+
+```ts
+const options = printer.getPrinterDriverOptions("My Printer")
+```
+
+---
+
+### Get selected paper size
+
+```ts
+const paper = printer.getSelectedPaperSize("My Printer")
+```
+
+---
+
+# 🖨 Printing
+
+---
+
+## 🟢 Print Raw/Text Data (Callback)
+
+```ts
+printer.printDirect({
+  data: "Hello Printer\n\n",
+  printer: "My Printer",
+  type: "RAW",
+  success: (jobId) => {
+    console.log("Printed. Job ID:", jobId)
+  },
+  error: (err) => {
+    console.error("Print error:", err)
+  }
+})
+```
+
+---
+
+## 🟢 Print Raw/Text Data (Async/Await)
+
+```ts
+const jobId = await printer.printDirectAsync({
+  data: Buffer.from("Hello Printer\n\n"),
+  printer: "My Printer",
+  type: "RAW"
+})
+
+console.log("Printed. Job ID:", jobId)
+```
+
+---
+
+## 🟢 Print File (Callback)
+
+```ts
+printer.printFile({
+  filename: "./file.txt",
+  printer: "My Printer",
+  success: (jobId) => console.log(jobId),
+  error: (err) => console.error(err)
+})
+```
+
+---
+
+## 🟢 Print File (Async)
+
+```ts
+const jobId = await printer.printFileAsync({
+  filename: "./file.txt",
+  printer: "My Printer"
+})
+```
+
+---
+
+# 📦 Job Management
+
+---
+
+## Get Job Details
+
+```ts
+const job = printer.getJob("My Printer", 42)
+```
+
+### Async
+
+```ts
+const job = await printer.getJobAsync("My Printer", 42)
+```
+
+---
+
+## Cancel / Pause / Resume Job
+
+```ts
+printer.setJob("My Printer", 42, "CANCEL")
+printer.setJob("My Printer", 42, "PAUSE")
+printer.setJob("My Printer", 42, "RESUME")
+```
+
+---
+
+## Get Supported Job Commands
+
+```ts
+const commands = printer.getSupportedJobCommands()
+```
+
+---
+
+# 📄 Supported Print Formats
+
+```ts
+const formats = printer.getSupportedPrintFormats()
+```
+
+Typical values:
+
+* `RAW`
+* `TEXT`
+* `COMMAND`
+* `AUTO`
+
+> Windows supports RAW/TEXT/COMMAND directly.
+> macOS/Linux support additional formats via CUPS.
+
+---
+
+# 🧠 TypeScript Types
+
+Fully typed. Example:
+
+```ts
+export interface PrintDirectOptions {
+  data: string | Buffer
+  printer?: string
+  type?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO'
+  options?: { [key: string]: string }
+}
+```
+
+---
+
+# ⚡ Promise Wrappers Included
+
+Built-in async wrappers:
+
+* `printDirectAsync`
+* `printFileAsync`
+* `getPrintersAsync`
+* `getPrinterAsync`
+* `getJobAsync`
+
+No extra wrapper needed.
+
+---
+
+# 🧪 Example Full Test
+
+```ts
+import * as printer from '@esslassi/electron-printer'
+
+async function test() {
+  const printers = await printer.getPrintersAsync()
+  const defaultPrinter = printer.getDefaultPrinterName()
+
+  const jobId = await printer.printDirectAsync({
+    data: "Test print\n\n",
+    printer: defaultPrinter,
+    type: "RAW"
+  })
+
+  const job = await printer.getJobAsync(defaultPrinter!, Number(jobId))
+
+  console.log(job)
+}
+
+test()
+```
+
+---
+
+# 🏗 Architecture
+
+```
+Node.js / Electron
+        ↓
+N-API
+        ↓
+PrinterFactory
+        ↓
+Windows | macOS | Linux drivers
+```
+
+Native C++ backend with platform-specific implementations.
+
+---
+
+# 🔧 Development
+
+Build from source:
+
+```bash
+npx node-gyp rebuild
+```
+
+Electron:
+
+```bash
+npx electron-rebuild
+```
+
+---
+
+# 📜 License
+
+MIT
+
+---
+
+# 👨‍💻 Author
+
+Esslassi
+
+---
+
+If you want, I can also generate:
+
+* 🔥 NPM package.json template
+* 🧱 binding.gyp optimized version
+* ⚡ Prebuild support (no node-gyp required for users)
+* 🧪 Jest test suite
+* 📦 CLI tool version
+
+Tell me the next step 🚀

package/binding.gyp

@@ -1,57 +1,57 @@
-{
-  "targets": [
-    {
-      "target_name": "electron_printer",
-      "sources": [
-        "src/main.cpp",
-        "src/print.cpp",
-        "src/printer_factory.cpp"
-      ],
-      "include_dirs": [
-        "<!@(node -p \"require('node-addon-api').include\")"
-      ],
-      "dependencies": [
-        "<!(node -p \"require('node-addon-api').gyp\")"
-      ],
-      "defines": [ "NAPI_CPP_EXCEPTIONS" ],
-      "conditions": [
-        ['OS=="win"', {
-          "sources": ["src/windows_printer.cpp"],
-          "libraries": ["winspool.lib"],
-          "msvs_settings": {
-            "VCCLCompilerTool": {
-              "ExceptionHandling": 1
-            }
-          }
-        }],
-        ['OS=="mac"', {
-          "sources": ["src/mac_printer.cpp"],
-          "libraries": ["-lcups"],
-          "include_dirs": [
-            "/usr/include/cups"
-          ],
-          "xcode_settings": {
-            "OTHER_CFLAGS": ["-Wall"],
-            "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
-            "CLANG_CXX_LIBRARY": "libc++",
-            "MACOSX_DEPLOYMENT_TARGET": "10.7"
-          }
-        }],
-        ['OS=="linux"', {
-          "sources": ["src/linux_printer.cpp"],
-          "libraries": ["-lcups"],
-          "include_dirs": [
-            "/usr/include/cups"
-          ],
-          "cflags": [
-            "-Wall",
-            "-fexceptions"
-          ],
-          "cflags_cc": [
-            "-fexceptions"
-          ]
-        }]
-      ]
-    }
-  ]
-}
+{
+  "targets": [
+    {
+      "target_name": "electron_printer",
+      "sources": [
+        "src/main.cpp",
+        "src/print.cpp",
+        "src/printer_factory.cpp"
+      ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').gyp\")"
+      ],
+      "defines": [ "NAPI_CPP_EXCEPTIONS" ],
+      "conditions": [
+        ['OS=="win"', {
+          "sources": ["src/windows_printer.cpp"],
+          "libraries": ["winspool.lib"],
+          "msvs_settings": {
+            "VCCLCompilerTool": {
+              "ExceptionHandling": 1
+            }
+          }
+        }],
+        ['OS=="mac"', {
+          "sources": ["src/mac_printer.cpp"],
+          "libraries": ["-lcups"],
+          "include_dirs": [
+            "/usr/include/cups"
+          ],
+          "xcode_settings": {
+            "OTHER_CFLAGS": ["-Wall"],
+            "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
+            "CLANG_CXX_LIBRARY": "libc++",
+            "MACOSX_DEPLOYMENT_TARGET": "10.7"
+          }
+        }],
+        ['OS=="linux"', {
+          "sources": ["src/linux_printer.cpp"],
+          "libraries": ["-lcups"],
+          "include_dirs": [
+            "/usr/include/cups"
+          ],
+          "cflags": [
+            "-Wall",
+            "-fexceptions"
+          ],
+          "cflags_cc": [
+            "-fexceptions"
+          ]
+        }]
+      ]
+    }
+  ]
+}