@esslassi/electron-printer 0.0.1

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/Gruntfile.js

@@ -0,0 +1,80 @@
+module.exports = function(grunt) {
+    grunt.initConfig({
+        shell: {
+            'node-pre-gyp-ia32': {
+                command: 'node-pre-gyp configure build package --target_arch=ia32'
+            },
+            'node-pre-gyp-x64': {
+                command: 'node-pre-gyp configure build package --target_arch=x64'
+            },
+            'node-gyp-ia32': {
+                command: 'node-gyp rebuild --arch=ia32'
+            },
+            'node-gyp-x64': {
+                command: 'node-gyp rebuild --arch=x64'
+            },
+            'upload-binaries': {
+                command: 'node-pre-gyp-github publish'
+            }
+        },
+        copy: {
+            ia32: {
+                files: [
+                    {src: 'build/Release/electron-printer.node', dest: 'lib/electron-printer-' + process.platform + '-ia32.node'},
+                    {src: 'binding.js', dest: 'lib/binding.js'},
+                    {src: 'index.js', dest: 'lib/index.js'}
+                ]
+            },
+            x64: {
+                files: [
+                    {src: 'build/Release/electron-printer.node', dest: 'lib/electron-printer-' + process.platform + '-x64.node'},
+                    {src: 'binding.js', dest: 'lib/binding.js'},
+                    {src: 'index.js', dest: 'lib/index.js'}
+                ]
+            }
+        }
+    });
+
+    grunt.loadNpmTasks('grunt-contrib-jshint');
+    grunt.loadNpmTasks('grunt-shell');
+    grunt.loadNpmTasks('grunt-contrib-copy');
+
+    grunt.registerTask('build-pre-ia32', [
+        'shell:node-pre-gyp-ia32',
+        'copy:ia32'
+    ]);
+
+    grunt.registerTask('build-ia32', [
+        'shell:node-gyp-ia32',
+        'copy:ia32'
+    ]);
+
+    grunt.registerTask('build-x64', [
+        'shell:node-gyp-x64',
+        'copy:x64'
+    ]);
+
+    grunt.registerTask('build-pre-x64', [
+        'shell:node-pre-gyp-x64',
+        'copy:x64'
+    ]);
+
+    grunt.registerTask('build', [
+        'build-ia32',
+        'build-x64'
+    ]);
+
+    grunt.registerTask('build-pre', [
+        'build-pre-ia32',
+        'build-pre-x64'
+    ]);
+
+    grunt.registerTask('upload', [
+        'shell:upload-binaries'
+    ]);
+
+    grunt.registerTask('release', [
+        'build-pre',
+        'upload'
+    ]);
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MOHAMMED ESSLASSI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# @esslassi/electron-printer
+
+**No recompilation required when upgrading Node.js versions, thanks to N-API!** 🎉
+
+Native bind printers on POSIX and Windows OS from Node.js, Electron, and node-webkit.
+
+!npm version !Prebuild Binaries and Publish
+
+> Supports Node.js versions from 8.0.0 onwards, including the latest versions, thanks to the transition to N-API.
+
+> Prebuild and CI integration courtesy of @ekoeryanto in his FORK
+
+If you have a problem, ask a question on !Gitter or find/create a new Github issue
+
+___
+### **Below is the original README**
+___
+### Reason:
+
+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.
+
+### Features:
+
+* 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.
+
+### How to install:
+```
+npm install @esslassi/electron-printer
+```
+
+### How to use:
+
+See examples
+
+### Author(s):
+
+* Mohammed Esslassi, contact@foxneer.com
+
+### 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).
+
+Feel free to download, test, and propose new features.
+
+### License:
+ The MIT License (MIT)
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+## License
+
+This project is licensed under the MIT License.
+
+### Keywords:
+
+* node-printer
+* printer
+* electron-printer
+* node-addon-api
+* POSIX printer
+* Windows printer
+* CUPS printer
+* print job
+* printer driver
+
+---

package/binding.gyp

@@ -0,0 +1,39 @@
+{
+  '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)"
+        }
+      ]
+    },
+    {
+      '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"])'
+      ],
+      '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 },
+      }
+    }
+  ]
+}

package/binding.js

@@ -0,0 +1,244 @@
+const path = require('path');
+const os = require('os');
+let addon = {}, binary_path;
+switch (os.platform()) {
+    case 'win32':
+        if (os.arch() === 'ia32') {
+            binary_path = path.join(__dirname, 'electron-printer.node');
+        } else if (os.arch() === 'x64') {
+            binary_path = path.join(__dirname, 'electron-printer.node');
+        }
+        addon = require(binary_path);
+        break;
+    case 'darwin':
+        binary_path = path.join(__dirname, 'electron-printer.node'); 
+        addon = require(binary_path);
+        break;
+    case 'linux':
+        if (os.arch() === 'ia32') {
+            addon = path.join(__dirname, 'electron-printer.node');
+        } else if (os.arch() === 'x64') {
+            addon = path.join(__dirname, 'electron-printer.node');
+        }
+        break;
+    default:
+        binary_path = path.join(__dirname, 'electron-printer.node'); 
+        addon = require(binary_path);
+}
+
+module.exports.sayMyName = addon.SayMyName
+module.exports.getPrinters = addon.getPrinters
+module.exports.printDirect = printDirect
+module.exports.getDefaultPrinterName = addon.getDefaultPrinterName
+module.exports.getPrinter = getPrinter;
+/// send file to printer
+module.exports.printFile = printFile;
+/** Get supported print format for printDirect
+ */
+module.exports.getSupportedPrintFormats = addon.getSupportedPrintFormats;
+/*
+ print raw data. This function is intend to be asynchronous
+
+ parameters:
+ parameters - Object, parameters objects with the following structure:
+ data - String, mandatory, data to printer
+ printer - String, optional, name of the printer, if missing, will try to print to default printer
+ docname - String, optional, name of document showed in printer status
+ type - String, optional, only for wind32, data type, one of the RAW, TEXT
+ options - JS object with CUPS options, optional
+ success - Function, optional, callback function
+ error - Function, optional, callback function if exists any error
+
+ or
+
+ data - String, mandatory, data to printer
+ printer - String, optional, name of the printer, if missing, will try to print to default printer
+ docname - String, optional, name of document showed in printer status
+ type - String, optional, data type, one of the RAW, TEXT
+ options - JS object with CUPS options, optional
+ success - Function, optional, callback function with first argument job_id
+ error - Function, optional, callback function if exists any error
+ */
+ function printDirect(parameters){
+    var data = parameters
+        , printer
+        , docname
+        , type
+        , options
+        , success
+        , error;
+
+    if(arguments.length==1){
+        //TODO: check parameters type
+        //if (typeof parameters )
+        data = parameters.data;
+        printer = parameters.printer;
+        docname = parameters.docname;
+        type = parameters.type;
+        options = parameters.options||{};
+        success = parameters.success;
+        error = parameters.error;
+    }else{
+        printer = arguments[1];
+        type = arguments[2];
+        docname = arguments[3];
+        options = arguments[4];
+        success = arguments[5];
+        error = arguments[6];
+    }
+
+    if(!type){
+        type = "RAW";
+    }
+
+    // Set default printer name
+    if(!printer) {
+        printer = addon.getDefaultPrinterName();
+    }
+
+    type = type.toUpperCase();
+
+    if(!docname){
+        docname = "node print job";
+    }
+
+    if (!options){
+        options = {};
+    }
+
+    //TODO: check parameters type
+    if(addon.printDirect){// call C++ binding
+        try{
+            var res = addon.printDirect(data, printer, docname, type, options);
+            if(res){
+                success(res);
+            }else{
+                error(Error("Something wrong in printDirect"));
+            }
+        }catch (e){
+            error(e);
+        }
+    }else{
+        error("Not supported");
+    }
+}
+
+/** Get printer info with jobs
+ * @param printerName printer name to extract the info
+ * @return printer object info:
+ *		TODO: to enum all possible attributes
+ */
+ function getPrinter(printerName)
+ {
+     if(!printerName) {
+         printerName = addon.getDefaultPrinterName();
+     }
+     var printer = addon.getPrinter(printerName);
+     correctPrinterinfo(printer);
+     return printer;
+ }
+
+
+function correctPrinterinfo(printer) {
+    if(printer.status || !printer.options || !printer.options['printer-state']){
+        return;
+    }
+
+    var status = printer.options['printer-state'];
+    // Add posix status
+    if(status == '3'){
+        status = 'IDLE'
+    }
+    else if(status == '4'){
+        status = 'PRINTING'
+    }
+    else if(status == '5'){
+        status = 'STOPPED'
+    }
+
+    // correct date type
+    var k;
+    for(k in printer.options) {
+        if(/time$/.test(k) && printer.options[k] && !(printer.options[k] instanceof Date)) {
+            printer.options[k] = new Date(printer.options[k] * 1000);
+        }
+    }
+
+    printer.status = status;
+}
+
+/**
+parameters:
+   parameters - Object, parameters objects with the following structure:
+      filename - String, mandatory, data to printer
+      docname - String, optional, name of document showed in printer status
+      printer - String, optional, mane of the printer, if missed, will try to retrieve the default printer name
+      success - Function, optional, callback function
+      error - Function, optional, callback function if exists any error
+*/
+function printFile(parameters){
+    var filename,
+        docname,
+        printer,
+        options,
+        success,
+        error;
+
+    if((arguments.length !== 1) || (typeof(parameters) !== 'object')){
+        throw new Error('must provide arguments object');
+    }
+
+    filename = parameters.filename;
+    docname = parameters.docname;
+    printer = parameters.printer;
+    options = parameters.options || {};
+    success = parameters.success;
+    error = parameters.error;
+
+    if(!success){
+        success = function(){};
+    }
+
+    if(!error){
+        error = function(err){
+            throw err;
+        };
+    }
+
+    if(!filename){
+        var err = new Error('must provide at least a filename');
+        return error(err);
+    }
+
+    // try to define default printer name
+    if(!printer) {
+        printer = addon.getDefaultPrinterName();
+    }
+
+    if(!printer) {
+        return error(new Error('Printer parameter of default printer is not defined'));
+    }
+
+    // set filename if docname is missing
+    if(!docname){
+        docname = filename;
+    }
+
+    //TODO: check parameters type
+    if(addon.printFile){// call C++ binding
+        try{
+            // TODO: proper success/error callbacks from the extension
+            var res = addon.printFile(filename, docname, printer, options);
+
+            if(!isNaN(parseInt(res))) {
+                success(res);
+            } else {
+                error(Error(res));
+            }
+        } catch (e) {
+            error(e);
+        }
+    } else {
+        error("Not supported");
+    }
+}

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./binding');

package/package.json

@@ -0,0 +1,49 @@
+{
+  "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.1",
+  "main": "./lib/index.js",
+  "types": "types/index.d.ts",
+  "dependencies": {
+    "node-addon-api": "^8.1.0"
+  },
+  "scripts": {
+    "install": "prebuild-install || node-gyp rebuild",
+    "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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/esslassi/electron-printer.git"
+  },
+  "binary": {
+    "module_name": "electron-printer",
+    "module_path": "./lib/",
+    "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}"
+  },
+  "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"
+  }
+}

package/printer.js

@@ -0,0 +1 @@
+module.exports = require('./lib/binding');

package/src/hello_world.cc

@@ -0,0 +1,8 @@
+#include "node_printer.hpp"
+
+MY_NODE_MODULE_CALLBACK(SayMyName) 
+{
+  MY_NODE_MODULE_HANDLESCOPE
+   Napi::String result = Napi::String::New(info.Env(), "Hello, From C++ !");
+  MY_NODE_MODULE_RETURN_VALUE(result);
+}

package/src/macros.hh

@@ -0,0 +1,53 @@
+#ifndef NODE_PRINTER_SRC_MACROS_H
+#define NODE_PRINTER_SRC_MACROS_H
+#include <napi.h>
+
+
+#define MY_NODE_MODULE_ENV_DECL Napi::Env env = info.Env();
+#define MY_NODE_MODULE_ENV      env
+#define MY_NODE_MODULE_HANDLESCOPE MY_NODE_MODULE_ENV_DECL Napi::HandleScope scope(env);
+
+#define MY_MODULE_SET_METHOD(exports, name, method) \
+    (exports).Set(Napi::String::New(env, name), Napi::Function::New(env, method))
+
+#define MY_NODE_MODULE_CALLBACK(name) Napi::Value name(const Napi::CallbackInfo& info)
+
+#define MY_NODE_MODULE_RETURN_VALUE(value) \
+    return value;
+
+#define NAPI_STRING_NEW_UTF8(env, value) Napi::String::New(env, value)
+
+#define ADD_NAPI_NUMBER_PROPERTY(obj, name, value) \
+    obj.Set(Napi::String::New(obj.Env(), name), Napi::Number::New(obj.Env(), value))
+
+#define NAPI_STRING_NEW_2BYTES(env, value) Napi::String::New(env, (char16_t*)value)
+
+#define ADD_NAPI_STRING_PROPERTY(obj, name, key) \
+if ((job->key != NULL) && (*job->key != L'\0')) { \
+    obj.Set(Napi::String::New(obj.Env(), name), Napi::String::New(obj.Env(), (char16_t*)job->key)); \
+}
+
+#define RETURN_EXCEPTION(env, msg) \
+    Napi::Error::New(env, msg).ThrowAsJavaScriptException(); \
+    return env.Null(); // Ensure a Napi::Value is returned
+
+#define RETURN_EXCEPTION_STR(env, msg) \
+    RETURN_EXCEPTION(env, msg)
+
+#define REQUIRE_ARGUMENTS(env, args, n)                                                   \
+    if (args.Length() < (n)) {                                                 \
+        RETURN_EXCEPTION_STR(env, "Expected " #n " arguments");                       \
+    }
+
+#define ARG_CHECK_STRING(env, args, i)                                                   \
+    if ((args).Length() <= (i) || !(args)[(i)].IsString()) {                                                 \
+        RETURN_EXCEPTION_STR(env, "Argument " #i " must be a string");                       \
+    }
+
+#define REQUIRE_ARGUMENT_STRINGW(env, args, i, var)                                      \
+    ARG_CHECK_STRING(env, args, i);                                                      \
+    std::wstring var = (args)[(i)].As<Napi::String>().Utf16Value();
+
+
+#endif
+

package/src/node_printer.cc

@@ -0,0 +1,31 @@
+#include "node_printer.hpp"
+
+
+
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  MY_MODULE_SET_METHOD(exports, "SayMyName",  SayMyName);
+  MY_MODULE_SET_METHOD(exports, "getPrinters", getPrinters);
+  MY_MODULE_SET_METHOD(exports, "getDefaultPrinterName", getDefaultPrinterName);
+  MY_MODULE_SET_METHOD(exports, "printDirect", printDirect); 
+  MY_MODULE_SET_METHOD(exports, "getPrinter", getPrinter);
+  MY_MODULE_SET_METHOD(exports, "printFile", printFile);
+  MY_MODULE_SET_METHOD(exports, "getSupportedPrintFormats", getSupportedPrintFormats);
+  return exports;
+}
+
+NODE_API_MODULE(addon, Init)
+
+// Helpers
+
+bool getStringOrBufferFromNapiValue(const Napi::Value& value, std::string& oData) {
+    if (value.IsString()) {
+        oData = value.As<Napi::String>().Utf8Value();
+        return true;
+    }
+    if (value.IsBuffer()) {
+        Napi::Buffer<char> buffer = value.As<Napi::Buffer<char>>();
+        oData.assign(buffer.Data(), buffer.Length());
+        return true;
+    }
+    return false;
+}