@esslassi/electron-printer 0.0.3 → 0.0.6

package/README.md

@@ -1,82 +1,251 @@
-# @esslassi/electron-printer
+Here is the clean **README.md** content ready to copy and paste:
 
-**No recompilation required when upgrading Node.js versions, thanks to N-API!** 🎉
+---
+
+# Electron Printer (@esslassi/electron-printer)
+
+Node.js and Electron bindings for printer management and direct printing. Supports Windows and Linux (CUPS).
 
-Native bind printers on POSIX and Windows OS from Node.js, Electron, and node-webkit.
+## Features
 
-!npm version !Prebuild Binaries and Publish
+* 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
 
-> Supports Node.js versions from 8.0.0 onwards, including the latest versions, thanks to the transition to N-API.
+## Requirements
 
-> Prebuild and CI integration courtesy of @ekoeryanto in his FORK
+* 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
+```
 
-If you have a problem, ask a question on !Gitter or find/create a new Github issue
+## Installation
 
-___
-### **Below is the original README**
-___
-### Reason:
+```bash
+npm install @esslassi/electron-printer
+```
 
-I was involved in a project where I needed to print from Node.js. This is the reason why I created this project and I want to share my code with others.
+For development:
 
-### Features:
+```bash
+git clone https://github.com/esslassi/electron-printer.git
+cd electron-printer
+npm install
+npm run rebuild
+```
 
-* No dependencies on NAN or V8;
-* Native method wrappers for Windows and POSIX (which uses CUPS 1.4/MAC OS X 10.6) APIs;
-* Compatible with Node.js versions that support N-API, ensuring long-term stability and compatibility;
-* Compatible with Electron versions that support N-API, reducing the need for frequent recompilation;
-* `getPrinters()` to enumerate all installed printers with current jobs and statuses;
-* `getPrinter(printerName)` to get a specific/default printer info with current jobs and statuses;
-* `getPrinterDriverOptions(printerName)` (POSIX only) to get a specific/default printer driver options such as supported paper size and other info;
-* `getSelectedPaperSize(printerName)` (POSIX only) to get a specific/default printer default paper size from its driver options;
-* `getDefaultPrinterName()` returns the default printer name;
-* `printDirect(options)` to send a job to a specific/default printer, now supports CUPS options passed in the form of a JS object (see `cancelJob.js` example). To print a PDF from Windows, it is possible by using node-pdfium module to convert a PDF format into EMF and then send it to the printer as EMF;
-* `printFile(options)` (POSIX only) to print a file;
-* `getSupportedPrintFormats()` to get all possible print formats for the `printDirect` method, which depends on the OS. `RAW` and `TEXT` are supported on all OSes;
-* `getJob(printerName, jobId)` to get specific job info including job status;
-* `setJob(printerName, jobId, command)` to send a command to a job (e.g., `'CANCEL'` to cancel the job);
-* `getSupportedJobCommands()` to get supported job commands for `setJob()`, depending on the OS. The `'CANCEL'` command is supported on all OSes.
+## 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);
+```
 
-### How to install:
+### 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);
+  }
+}
 ```
-npm install @esslassi/electron-printer
+
+## 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;
+  };
+}
 ```
 
-### How to use:
+---
+
+### getDefaultPrinter(): Promise<Printer>
 
-See examples
+Returns the system default printer.
+
+---
 
-### Author(s):
+### getStatusPrinter(options: GetStatusPrinterOptions): Promise<Printer>
 
-* Mohammed Esslassi, contact@foxneer.com
+```typescript
+interface GetStatusPrinterOptions {
+  printerName: string;
+}
+```
 
-### Node.js Version Support:
+---
 
-This project supports Node.js versions from 8.0.0 onwards. N-API ensures that native addons do not require recompilation when upgrading Node.js versions. For more details, refer to the [Node.js N-API documentation](https://nodejs.org/api/n-api.html)¹(https://nodejs.org/api/n-api.html).
+### printDirect(options: PrintDirectOptions): Promise<string>
 
-Feel free to download, test, and propose new features.
+```typescript
+interface PrintDirectOptions {
+  printerName: string;
+  data: string | Buffer;
+  dataType?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO';
+}
+```
 
-### License:
- The MIT License (MIT)
+### 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
 
-## Contributing
+---
 
-Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+## Supported Platforms
 
-## License
+* Windows (32/64-bit)
+* Linux (CUPS)
 
-This project is licensed under the MIT License.
+---
+
+## 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
+```
 
-### Keywords:
+---
+
+## Development
+
+```bash
+git clone https://github.com/esslassi/electron-printer.git
+cd electron-printer
+npm install
+npm run rebuild
+node test.js
+```
+
+---
+
+## License
 
-* node-printer
-* printer
-* electron-printer
-* node-addon-api
-* POSIX printer
-* Windows printer
-* CUPS printer
-* print job
-* printer driver
+MIT
 
 ---
+
+## Author
+
+Esslassi

package/binding.gyp

@@ -1,39 +1,57 @@
 {
-  'variables': {
-    'module_name%': 'electron-printer',
-    'module_path%': 'lib'
-  },
-  'targets': [
-      {
-      "target_name": "action_after_build",
-      "type": "none",
-      "dependencies": [ "<(module_name)" ],
-      "copies": [
-        {
-          "files": [ "<(PRODUCT_DIR)/<(module_name).node" ],
-          "destination": "<(module_path)"
-        }
-      ]
-    },
+  "targets": [
     {
-      'target_name': '<(module_name)',
-      'sources': [
-        # is like "ls -1 src/*.cc", but gyp does not support direct patterns on
-        # sources
-        '<!@(["python", "tools/getSourceFiles.py", "src", "cc"])'
+      "target_name": "electron_printer",
+      "sources": [
+        "src/main.cpp",
+        "src/print.cpp",
+        "src/printer_factory.cpp"
+      ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
       ],
-      'include_dirs': ["<!@(node -p \"require('node-addon-api').include\")"],
-      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
-      'cflags!': [ '-fno-exceptions' ],
-      'cflags_cc!': [ '-fno-exceptions' ],
-      'xcode_settings': {
-        'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
-        'CLANG_CXX_LIBRARY': 'libc++',
-        'MACOSX_DEPLOYMENT_TARGET': '10.7'
-      },
-      'msvs_settings': {
-        'VCCLCompilerTool': { 'ExceptionHandling': 1 },
-      }
+      "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"
+          ]
+        }]
+      ]
     }
   ]
 }

package/lib/electronPrinter.d.ts

@@ -0,0 +1,33 @@
+export interface PrintOptions {
+    printerName: string;
+    data: string | Buffer;
+    dataType?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO' | undefined;
+}
+export interface Printer {
+    name: string;
+    isDefault: boolean;
+    status: string;
+    details: {
+        location?: string;
+        comment?: string;
+        driver?: string;
+        port?: string;
+        [key: string]: string | undefined;
+    };
+}
+export interface PrintDirectOptions {
+    printerName: string;
+    data: string | Buffer;
+    dataType?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO' | undefined;
+}
+export interface GetStatusPrinterOptions {
+    printerName: string;
+}
+export interface PrintDirectOutput {
+    name: string;
+    status: 'success' | 'failed';
+}
+export declare function printDirect(printOptions: PrintOptions): Promise<PrintDirectOutput>;
+export declare function getStatusPrinter(printOptions: GetStatusPrinterOptions): Promise<Printer>;
+export declare function getPrinters(): Promise<Printer[]>;
+export declare function getDefaultPrinter(): Promise<Printer>;

package/lib/electronPrinter.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printDirect = printDirect;
+exports.getStatusPrinter = getStatusPrinter;
+exports.getPrinters = getPrinters;
+exports.getDefaultPrinter = getDefaultPrinter;
+const bindings_1 = __importDefault(require("bindings"));
+const electronPrinter = (0, bindings_1.default)('electron_printer');
+async function printDirect(printOptions) {
+    const input = {
+        ...printOptions,
+        printerName: normalizeString(printOptions.printerName)
+    };
+    const printer = await electronPrinter.printDirect(input);
+    return printer;
+}
+async function getStatusPrinter(printOptions) {
+    const input = {
+        ...printOptions,
+        printerName: normalizeString(printOptions.printerName)
+    };
+    const printer = await electronPrinter.getStatusPrinter(input);
+    return printer;
+}
+async function getPrinters() {
+    const printers = await electronPrinter.getPrinters();
+    return printers;
+}
+async function getDefaultPrinter() {
+    const printer = await electronPrinter.getDefaultPrinter();
+    return printer;
+}
+function normalizeString(str) {
+    return String.raw `${str}`;
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './electronPrinter';

package/lib/index.js

@@ -1 +1,17 @@
-module.exports = require('./binding');
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./electronPrinter"), exports);

package/package.json

@@ -1,48 +1,62 @@
 {
   "name": "@esslassi/electron-printer",
-  "description": "Node API (N-API) supported electron.s || node.js printer bindings",
-  "homepage": "https://github.com/esslassi/electron-printer",
-  "version": "0.0.3",
+  "description": "Node.js and Electron bindings",
+  "version": "0.0.6",
   "main": "./lib/index.js",
-  "types": "types/index.d.ts",
-  "dependencies": {
-    "node-addon-api": "^8.1.0"
-  },
+  "private": false,
   "scripts": {
-    "install": "prebuild-install || node-gyp rebuild",
+    "install": "node-gyp rebuild",
+    "prebuild:master": "prebuild-install || node-gyp rebuild",
+    "clean:lib": "rimraf lib/ && rimraf tsconfig-build.tsbuildinfo",
+    "build": "npm run clean:lib && tsc -p tsconfig-build.json && node-gyp build",
     "rebuild": "node-gyp rebuild",
-    "release": "node-pre-gyp-github publish --release --commitish main",
-    "electron-rebuild": "node-gyp rebuild --target_platform=win32 --target_arch=x64  --runtime=electron --target=35.0.1 --dist-url=https://electronjs.org/headers",
-    "test": "node --test test/"
-  },
-  "author": {
-    "name": "Esslassi Mohammed",
-    "url": "http://foxneer.com/",
-    "email": "contact@foxneer.com"
+    "release": "node release.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/esslassi/electron-printer.git"
+    "url": "git@github.com:esslassi/electron-printer.git"
+  },
+  "homepage": "https://github.com/esslassi/electron-printer/#readme",
+  "keywords": [
+    "native",
+    "electron",
+    "node",
+    "printer"
+  ],
+  "author": {
+    "name": "Esslassi Mohammed",
+    "url": "https://github.com/esslassi/electron-printer/#readme",
+    "email": "esslassi1996@gmail.com"
   },
   "binary": {
-    "module_name": "electron-printer",
-    "module_path": "./lib/",
+    "module_name": "electron_printer",
+    "module_path": "build/Release/",
     "host": "https://github.com/esslassi/electron-printer/releases/download/",
-    "remote_path": "v{version}",
-    "tag_path": "https://github.com/esslassi/electron-printer/releases/tag/v{version}"
+    "remote_path": "v{version}"
+  },
+  "license": "MIT",
+  "gypfile": true,
+  "dependencies": {
+    "bindings": "1.5.0",
+    "dotenv": "17.2.3",
+    "node-addon-api": "8.5.0",
+    "node-gyp": "12.1.0"
   },
-  "licenses": [
-    {
-      "type": "BSD"
-    }
-  ],
   "devDependencies": {
-    "@mapbox/node-pre-gyp": "^2.0.0",
-    "grunt": "^1.6.1",
-    "grunt-contrib-copy": "^1.0.0",
-    "grunt-contrib-jshint": "^3.2.0",
-    "grunt-node-gyp": "^5.0.0",
-    "grunt-shell": "^4.0.0",
-    "node-pre-gyp-github": "^2.0.0"
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "13.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "11.0.1",
+    "@semantic-release/npm": "12.0.1",
+    "@semantic-release/release-notes-generator": "14.0.3",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/bindings": "^1.5.5",
+    "@types/node": "22.12.0",
+    "prebuild-install": "7.1.3",
+    "rimraf": "^6.0.1",
+    "typescript": "5.7.3"
+  },
+  "engines": {
+    "node": ">= 18.x"
   }
 }