@luckykiet/node-printer 1.0.0

package/ChangeLog

@@ -0,0 +1,36 @@
+2016.09.10, version 0.2.2
+* correct memory leak (thanks to @kjlaw89)
+
+2015.10.22, version 0.2.1
+* corrected printDirect with buffer data for node v4.X (#95)
+* corrected segmentation fault from get default printer for node v0.10.X
+
+2015.09, version 0.2.0
+* added possibility to compile with node v4.X
+* various bug/core dumps fix
+
+2015.04, version 0.1.2
+* posix: new method getPrinterDriverOptions(printerName) to retrieve PPD options
+* posix: new method getSelectedPaperSize(printerName) to retrieve the current paper size name
+* posix: new parameter `options` added to `printDirect` to set printer options (ex. `fit-to-page`, `media`, etc)
+* posix: new function printFile() to print a file
+
+2015.03.03, version 0.1.1
+* possibility to build for node-webkit with grunt
+
+2015.02.26, version 0.1.0
+* possibility to load native module for platform/arch: node_module_{platform}_{arch}.node
+
+2015.02.24, Version 0.0.5
+* added getDefaultPrinterName() method by returning the default printer name
+* make printer argument optional in getPrinter() and printDirect. If is missing, will try to print to default printer
+* resolve charest of getPrinter() #38
+* posix/win32: added more explicit errors
+* posix: do not throw error if job status code is not supported
+
+2015.01.30, Version 0.0.4
+* win: added RPC installed printers in getPrinters #40
+* posix: on some devices not all formats are supported, issue #23
+* posix: added link settings on build #28
+* corrected README.md
+* corrected examples

package/Gruntfile.js

@@ -0,0 +1,75 @@
+module.exports = function(grunt) {
+    grunt.initConfig({
+        gyp: {
+            ia32: {
+                command: 'rebuild',
+                options: {
+                    arch: 'ia32'
+                }
+            },
+            x64: {
+                command: 'rebuild',
+                options: {
+                    arch: 'x64'
+                }
+            }
+        },
+        "nw-gyp": {
+            ia32: {
+                command: 'rebuild',
+                options: {
+                    arch: 'ia32'
+                }
+            },
+            x64: {
+                command: 'rebuild',
+                options: {
+                    arch: 'x64'
+                }
+            }
+        },
+        copy: {
+            ia32: {
+                files: [{src: 'build/Release/node_printer.node', dest: 'lib/node_printer_' + process.platform + '_ia32.node'}]
+            },
+            x64: {
+                files: [{src: 'build/Release/node_printer.node', dest: 'lib/node_printer_' + process.platform + '_x64.node'}]
+            }
+        }
+    });
+
+    grunt.loadNpmTasks('grunt-contrib-jshint');
+    grunt.loadNpmTasks('grunt-node-gyp');
+    grunt.loadNpmTasks('grunt-nw-gyp');
+    grunt.loadNpmTasks('grunt-contrib-copy');
+
+    grunt.registerTask('build-nw-ia32', [
+            'nw-gyp:ia32',
+            'copy:ia32'
+    ]);
+
+    grunt.registerTask('build-ia32', [
+            'gyp:ia32',
+            'copy:ia32'
+    ]);
+
+    grunt.registerTask('build-x64', [
+            'gyp:x64',
+            'copy:x64'
+    ]);
+
+    grunt.registerTask('build-nw-x64', [
+            'nw-gyp:x64',
+            'copy:x64'
+    ]);
+
+    grunt.registerTask('build', [
+            'build-ia32',
+            'build-x64'
+    ]);
+
+    grunt.registerTask('build-nw', [
+            'build-nw-ia32',
+            'build-nw-x64'
+    ]);
+}

package/README.md

@@ -0,0 +1,61 @@
+Node Printer Prebuild
+============
+Native bind printers on POSIX and Windows OS from Node.js, electron and node-webkit.
+
+[![npm version](https://badge.fury.io/js/@thiagoelg%2Fnode-printer.svg)](https://www.npmjs.com/package/@thiagoelg/node-printer) [![Prebuild Binaries and Publish](https://github.com/thiagoelg/node-printer/actions/workflows/prebuild-main.yml/badge.svg)](https://github.com/thiagoelg/node-printer/actions/workflows/prebuild-main.yml)
+
+> It just works with Node 12 because of @thiagoelg in his [PR](https://github.com/tojocky/node-printer/pull/261)
+
+> Prebuild and CI integration courtesy of @ekoeryanto in his [FORK](https://github.com/ekoeryanto/node-printer)
+
+If you have a problem, ask question to [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tojocky/node-printer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or find/create a new [Github issue](https://github.com/thiagoelg/node-printer/issues)
+
+___
+### **Below is the original README**
+___
+### Reason:
+
+I was involved in a project where I need 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 dependecies;
+* native method wrappers from Windows  and POSIX (which uses [CUPS 1.4/MAC OS X 10.6](http://cups.org/)) APIs;
+* compatible with node v0.8.x, 0.9.x and v0.11.x (with 0.11.9 and 0.11.13);
+* compatible with node-webkit v0.8.x and 0.9.2;
+* `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](http://en.wikipedia.org/wiki/POSIX) only) to get a specific/default printer driver options such as supported paper size and other info
+* `getSelectedPaperSize(printerName)` ([POSIX](http://en.wikipedia.org/wiki/POSIX) only) to get a specific/default printer default paper size from its driver options
+* `getDefaultPrinterName()` return the default printer name;
+* `printDirect(options)` to send a job to a specific/default printer, now supports [CUPS options](http://www.cups.org/documentation.php/options.html) 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](https://github.com/tojocky/node-pdfium) to convert a PDF format into EMF and after to send to printer as EMF;
+* `printFile(options)`  ([POSIX](http://en.wikipedia.org/wiki/POSIX) only) to print a file;
+* `getSupportedPrintFormats()` to get all possible print formats for printDirect method which depends on OS. `RAW` and `TEXT` are supported from all OS-es;
+* `getJob(printerName, jobId)` to get a 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() depends on OS. `'CANCEL'` command is supported from all OS-es.
+
+
+### How to install:
+```
+npm install @thiagoelg/node-printer
+```
+
+### How to use:
+
+See [examples](https://github.com/thiagoelg/node-printer/tree/main/examples)
+
+### Author(s):
+
+* Ion Lupascu, ionlupascu@gmail.com
+
+### Contibutors:
+
+* Thiago Lugli, @thiagoelg
+* Eko Eryanto, @ekoeryanto
+
+Feel free to download, test and propose new futures
+
+### License:
+ [The MIT License (MIT)](http://opensource.org/licenses/MIT)

package/binding.gyp

@@ -0,0 +1,77 @@
+{
+  "variables": {
+    "module_name%": "node_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': 'node_printer',
+      'sources': [
+        '<!@(["python3", "tools/getSourceFiles.py", "src", "cc"])'
+      ],
+      'include_dirs' : [
+        "<!(node -e \"require('nan')\")"
+      ],
+      'cflags_cc+': [
+        "-std=c++20",
+        "-Wno-deprecated-declarations"
+      ],
+      'conditions': [
+        # common exclusions
+        ['OS!="linux"', {'sources/': [['exclude', '_linux\\.cc$']]}],
+        ['OS!="mac"', {'sources/': [['exclude', '_mac\\.cc|mm?$']]}],
+        ['OS!="win"', {
+          'sources/': [['exclude', '_win\\.cc$']]}, {
+          # else if OS==win, exclude also posix files
+          'sources/': [['exclude', '_posix\\.cc$']]
+        }],
+        # specific settings
+        ['OS!="win"', {
+          'cflags':[
+            '<!(cups-config --cflags)'
+          ],
+          'ldflags':[
+            '<!(cups-config --libs)'
+          ],
+          'libraries':[
+            '<!(cups-config --libs)'
+          ],
+          'link_settings': {
+            'libraries': [
+              '<!(cups-config --libs)'
+            ]
+          }
+        }],
+        ['OS=="mac"', {
+          'cflags':[
+            "-stdlib=libc++"
+          ],
+          'xcode_settings': {
+            "OTHER_CPLUSPLUSFLAGS":["-std=c++20", "-stdlib=libc++"],
+            "OTHER_LDFLAGS": ["-stdlib=libc++"],
+            "MACOSX_DEPLOYMENT_TARGET": "10.15",
+            "CLANG_CXX_LANGUAGE_STANDARD": "c++20",
+          },
+        }],
+        ['OS=="win"', {
+          'msvs_settings': {
+            'VCCLCompilerTool': {
+              'AdditionalOptions': ['/std:c++20'],
+            },
+          },
+        }],
+      ]
+    }
+  ]
+}

package/examples/cancelJob.js

@@ -0,0 +1,34 @@
+var printer = require("../lib"),
+    util = require('util'),
+    printerName = 'Foxit Reader PDF Printer',
+    printerFormat = 'TEXT';
+
+printer.printDirect({
+    data:"print from Node.JS buffer", // or simple String: "some text"
+	printer:printerName, // printer name
+	type: printerFormat, // type: RAW, TEXT, PDF, JPEG, .. depends on platform
+    options: // supported page sizes may be retrieved using getPrinterDriverOptions, supports CUPS printing options
+    {
+        media: 'Letter',
+        'fit-to-page': true
+    },
+	success:function(jobID){
+		console.log("sent to printer with ID: "+jobID);
+        var jobInfo = printer.getJob(printerName, jobID);
+        console.log("current job info:"+util.inspect(jobInfo, {depth: 10, colors:true}));
+        if(jobInfo.status.indexOf('PRINTED') !== -1)
+        {
+            console.log('too late, already printed');
+            return;
+        }
+        console.log('cancelling...');
+        var is_ok = printer.setJob(printerName, jobID, 'CANCEL');
+		console.log("cancelled: "+is_ok);
+		try{
+			console.log("current job info:"+util.inspect(printer.getJob(printerName, jobID), {depth: 10, colors:true}));
+		}catch(err){
+			console.log('job deleted. err:'+err);
+		}
+	},
+	error:function(err){console.log(err);}
+});

package/examples/example_zebra_printer.js

@@ -0,0 +1,15 @@
+var printer = require("../lib")
+	, template = "N\nS4\nD15\nq400\nR\nB20,10,0,1,2,30,173,B,\"barcode\"\nP0\n";
+
+function printZebra(barcode_text, printer_name){
+	printer.printDirect({data:template.replace(/barcode/, barcode_text)
+		, printer:printer_name
+		, type: "RAW"
+		, success:function(){
+			console.log("printed: "+barcode_text);
+		}
+		, error:function(err){console.log(err);}
+	});
+}
+
+printZebra("123", "ZEBRA");

package/examples/getDefaultPrinterName.js

@@ -0,0 +1,4 @@
+var printer = require("../lib");
+
+console.log('default printer name: ' + (printer.getDefaultPrinterName() || 'is not defined on your computer'));
+

package/examples/getPrinterDriverOptions.js

@@ -0,0 +1,9 @@
+var printer = require("../lib"),
+    util = require('util'),
+    printers = printer.getPrinters();
+
+printers.forEach(function(iPrinter, i){
+    console.log('' + i + 'ppd for printer "' + iPrinter.name + '":' + util.inspect(printer.getPrinterDriverOptions(iPrinter.name), {colors:true, depth:10} ));
+    console.log('\tselected page size:'+ printer.getSelectedPaperSize(iPrinter.name) + '\n');
+});
+

package/examples/getPrinters.js

@@ -0,0 +1,3 @@
+var printer = require("../lib"),
+    util = require('util');
+console.log("installed printers:\n"+util.inspect(printer.getPrinters(), {colors:true, depth:10}));

package/examples/getSupportedFormats.js

@@ -0,0 +1,3 @@
+var printer = require("../lib"),
+    util = require('util');
+console.log("supported formats are:\n"+util.inspect(printer.getSupportedPrintFormats(), {colors:true, depth:10}));

package/examples/getSupportedJobCommands.js

@@ -0,0 +1,3 @@
+var printer = require("../lib"), //=require('pritner')
+    util = require('util');
+console.log("supported job commands:\n"+util.inspect(printer.getSupportedJobCommands(), {colors:true, depth:10}));

package/examples/printFile.js

@@ -0,0 +1,30 @@
+// use: node printFile.js [filePath printerName]
+var printer = require("../lib"),
+    filename = process.argv[2] || __filename;
+
+console.log('platform:', process.platform);
+console.log('try to print file: ' + filename);
+
+if( process.platform != 'win32') {
+  printer.printFile({filename:filename,
+    printer: process.env[3], // printer name, if missing then will print to default printer
+    success:function(jobID){
+      console.log("sent to printer with ID: "+jobID);
+    },
+    error:function(err){
+      console.log(err);
+    }
+  });
+} else {
+  // not yet implemented, use printDirect and text
+  var fs = require('fs');
+  printer.printDirect({data:fs.readFileSync(filename),
+    printer: process.env[3], // printer name, if missing then will print to default printer
+    success:function(jobID){
+      console.log("sent to printer with ID: "+jobID);
+    },
+    error:function(err){
+      console.log(err);
+    }
+  });
+}

package/examples/printPDFFileInBuffer.js

@@ -0,0 +1,37 @@
+// Windows does not support PDF formats, but you can use imagemagick-native to achieve conversion from PDF to EMF.
+
+var printer = require("../lib"),
+    fs = require('fs'),
+    path = require('path'),
+    filename = process.argv[2],
+    printername = process.argv[3];
+
+if(process.platform == 'win32') {
+    throw 'Not yet supported for win32'
+}
+
+if(!filename || filename == '-h') {
+    throw 'PDF file name is missing. Please use the following params: <filename> [printername]'
+}
+
+filename = path.resolve(process.cwd(), filename);
+console.log('printing file name ' + filename);
+
+fs.readFile(filename, function(err, data){
+  if(err) {
+    console.error('err:' + err);
+    return;
+  }
+  console.log('data type is: '+typeof(data) + ', is buffer: ' + Buffer.isBuffer(data));
+    printer.printDirect({
+        data: data,
+        type: 'PDF',
+        success: function(id) {
+            console.log('printed with id ' + id);
+        },
+        error: function(err) {
+            console.error('error on printing: ' + err);
+        }
+    })
+});
+

package/examples/printPDFInWindows.js

@@ -0,0 +1,52 @@
+// Windows does not support PDF formats, but you can use imagemagick-native to achieve conversion from PDF to EMF.
+
+var printer = require("../lib"),
+    imagemagick, // will be loaded later with proper error.
+    fs = require('fs'),
+    filename = process.argv[2],
+    printername = process.argv[2];
+
+if(process.platform !== 'win32') {
+    throw 'This application can be run only on win32 as a demo of print PDF image'
+}
+
+if(!filename) {
+    throw 'PDF file name is missing. Please use the following params: <filename> [printername]'
+}
+
+try {
+    imagemagick = require('imagemagick-native');
+} catch(e) {
+    throw 'please install imagemagick-native: `npm install imagemagick-native`'
+}
+
+var data = fs.readFileSync(filename);
+
+console.log('data: ' + data.toString().substr(0, 20));
+
+//console.log(imagemagick.identify({srcData: data}));
+
+// First convert PDF into
+imagemagick.convert({
+    srcData: data,
+    srcFormat: 'PDF',
+    format: 'EMF',
+}, function(err, buffer) {
+    if (err) {
+        throw 'something went wrong on converting to EMF: ' + err;
+    }
+
+    // Now we have EMF file, send it to printer as EMF format
+    printer.printDirect({
+        data: buffer,
+        type: 'EMF',
+        success: function(id) {
+            console.log('printed with id ' + id);
+        },
+        error: function(err) {
+            console.error('error on printing: ' + err);
+        }
+    })
+})
+
+

package/examples/print_raw.js

@@ -0,0 +1,10 @@
+var printer = require("../lib");
+
+printer.printDirect({data:"print from Node.JS buffer" // or simple String: "some text"
+	//, printer:'Foxit Reader PDF Printer' // printer name, if missing then will print to default printer
+	, type: 'RAW' // type: RAW, TEXT, PDF, JPEG, .. depends on platform
+	, success:function(jobID){
+		console.log("sent to printer with ID: "+jobID);
+	}
+	, error:function(err){console.log(err);}
+});

package/lib/index.js

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