@esslassi/electron-printer 0.0.1

package/test/getPrinters.test.js

@@ -0,0 +1,26 @@
+const assert = require('assert/strict');
+const { test, beforeEach } = require('node:test');
+
+let addon;
+
+beforeEach(() => {
+  addon = require('../lib');
+});
+
+test('Ensure getPrinters function exists', (t) => {
+  assert.ok(addon.getPrinters, 'getPrinters function should exist');
+  assert.strictEqual(typeof addon.getPrinters, 'function', 'getPrinters should be a function');
+});
+
+test('Ensure getPrinters returns an array', (t) => {
+  const printers = addon.getPrinters();
+  assert.ok(Array.isArray(printers), 'getPrinters should return an array');
+});
+
+test('Ensure getPrinters handles no printers scenario', (t) => {
+  const printers = addon.getPrinters();
+  assert.ok(Array.isArray(printers), 'getPrinters should return an array');
+  if (printers.length > 0) {
+    assert.strictEqual(typeof printers[0], 'object', 'Each printer should be an object');
+  }
+});

package/test/incompleteFunctions.js

@@ -0,0 +1,56 @@
+const assert = require('assert/strict');
+const { test, beforeEach } = require('node:test');
+
+let addon;
+
+beforeEach(() => {
+  addon = require('../lib');
+});
+  
+test('Ensure Non-functional apis do not lead any issues', (t) => {
+    assert.ok(addon, 'Non-functional apis');
+    // Add checks for specific functions if needed
+    assert.strictEqual(typeof addon.getPrinter, 'function', 'Addon should have getPrinter');
+  });
+
+// Additional test cases 
+test('Test getPrinter behavior', (t) => {
+  const result = addon.getPrinter();
+  assert.strictEqual(result, 'getPrinter is not implemented yet, request for a PR if required', 'getPrinter is not implemented yet, request for a PR if required"');
+});
+
+test('Test printFile behavior', (t) => {
+  const filename = process.argv[2] || __filename; // use this file as an input
+  if( process.platform != 'win32') {
+    addon.printFile({filename:filename,
+      printer: process.env[3], // printer name, if missing then will print to default printer
+      success:function(jobID){
+        console.log("addon.printFile: Job ID: "+jobID);
+      },
+      error:function(err){
+        console.log(err);
+      }
+    });
+  } else {
+    // not yet implemented, use printDirect and text
+    var fs = require('fs');
+    addon.printDirect({data:fs.readFileSync(filename),
+      printer: addon.getDefaultPrinterName(), // printer name, if missing then will print to default printer
+      type: "RAW",
+      success:function(jobID){
+        assert.equal(jobID>0, true, 'addon.printFile');
+      },
+      error:function(err){
+        console.log(err);
+        assert.strictEqual(!err, true, 'addon.printFile'); // failed test case
+      }
+    });
+  }
+});
+
+// getSupportedPrintFormats
+test('Test getSupportedPrintFormats behavior', (t) => {
+  assert.throws(() => {
+    addon.getSupportedPrintFormats();
+  }, /Error/, 'getSupportedPrintFormats should throw an error when no arguments are passed');
+});

package/test/printDirect.test.js

@@ -0,0 +1,34 @@
+const assert = require('assert/strict');
+const { test, beforeEach } = require('node:test');
+
+let addon;
+let template;
+beforeEach(() => {
+  addon = require('../lib');
+  template = "N\nS4\nD15\nq400\nR\nB20,10,0,1,2,30,173,B,\"barcode\"\nP0\n";
+});
+
+test('Ensure printDirect function exists', (t) => {
+  assert.ok(addon.printDirect, 'printDirect function should exist');
+  assert.strictEqual(typeof addon.printDirect, 'function', 'printDirect should be a function');
+});
+
+test('Ensure printDirect throws error when no arguments are passed', (t) => {
+  assert.throws(() => {
+    addon.printDirect();
+  }, /Error/, 'printDirect should throw an error when no arguments are passed');
+});
+
+test('Ensure printDirect works properly', (t) => {
+ let barcode_text = "123";
+ let printer_name = addon.getDefaultPrinterName();
+  addon.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);}
+	});
+});

package/test/sayMyName.test.js

@@ -0,0 +1,21 @@
+const assert = require('assert/strict');
+const { test, beforeEach } = require('node:test');
+
+let addon;
+
+beforeEach(() => {
+  addon = require('../lib');
+});
+  
+test('Ensure addon is loaded correctly', (t) => {
+    assert.ok(addon, 'Addon should be loaded');
+    assert.strictEqual(typeof addon, 'object', 'Addon should be an object');
+    // Add checks for specific functions if needed
+    assert.strictEqual(typeof addon.sayMyName, 'function', 'Addon should have sayMyName');
+  });
+
+// Additional test cases 
+test('Test sayMyName behavior', (t) => {
+  const result = addon.sayMyName();
+  assert.strictEqual(result, 'Hello, From C++ !', 'sayMyName should return "Hello, From C++ !"');
+});

package/tools/buildElectronLinux.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+VERSION=$1
+
+# # Build Electron Linux 64bit
+node-pre-gyp configure --target=$VERSION --arch=x64 --dist-url=https://electronjs.org/headers --module_name=node_printer --module_path=../lib/
+node-pre-gyp build package --runtime=electron --target=$VERSION --target_arch=x64 --build-from-source
+
+# #Build Electron Linux 32bit
+node-pre-gyp configure --target=$VERSION --arch=ia32 --dist-url=https://electronjs.org/headers --module_name=node_printer --module_path=../lib/
+node-pre-gyp build package --runtime=electron --target=$VERSION --target_arch=ia32 --build-from-source

package/tools/buildElectronWindows.ps1

@@ -0,0 +1,20 @@
+#
+# Usage: buildElectronWindows.ps1 <version>
+#
+
+if ($args.Length -ne 1) {
+  echo "Must Supply only 1 argument - Version"
+  return
+}
+
+$version = $args[0]
+
+echo "Building Electron Version -> $version"
+
+# Build Electron Windows 64bit
+../node_modules\.bin\node-pre-gyp.cmd configure --target=$version --arch=x64 --dist-url=https://electronjs.org/headers --module_name=node_printer
+../node_modules\.bin\node-pre-gyp.cmd build package --runtime=electron --target=$version --target_arch=x64 --build-from-source
+
+# Build Electron Windows 32bit
+../node_modules\.bin\node-pre-gyp.cmd configure --target=$version --arch=ia32 --dist-url=https://electronjs.org/headers --module_name=node_printer
+../node_modules\.bin\node-pre-gyp.cmd build package --runtime=electron --target=$version --target_arch=ia32 --build-from-source

package/tools/buildWindows.ps1

@@ -0,0 +1,23 @@
+# Build Win32 64bit
+# node_modules\.bin\node-pre-gyp.cmd configure --target=$env:nodejs_version
+# node_modules\.bin\node-pre-gyp.cmd build package --target=$env:nodejs_version --target_arch=x64
+
+# Build Win32 32bit
+# node_modules\.bin\node-pre-gyp.cmd configure --target=$env:nodejs_version
+# node_modules\.bin\node-pre-gyp.cmd build package --target=$env:nodejs_version --target_arch=ia32
+
+if ($env:build_electron -ne "true") {
+  echo "Skipping Electron Build as flag not set"
+  return
+}
+
+# Build Electron Versions
+./tools/buildElectronWindows.ps1 1.2.8
+./tools/buildElectronWindows.ps1 1.3.8
+./tools/buildElectronWindows.ps1 1.4.6
+./tools/buildElectronWindows.ps1 1.7.12
+./tools/buildElectronWindows.ps1 2.0.18
+./tools/buildElectronWindows.ps1 3.1.13
+./tools/buildElectronWindows.ps1 4.2.10
+./tools/buildElectronWindows.ps1 5.0.10
+./tools/buildElectronWindows.ps1 6.0.7

package/tools/generateReleaseBuildsLinux.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+RELEASE_VERSION=$1
+PACKAGE_VERSION=$(node -pe "require('./package.json').version")
+SOURCE_PATH="${BASH_SOURCE%/*}/.."
+
+declare -a node_versions=(
+  "0.10.48"
+  "0.12.18"
+  "4.9.1"
+  "5.9.1"
+  "6.17.1"
+  "8.16.1"
+  "10.16.0"
+  "11.15.0"
+  "12.10.0"
+)
+
+declare -a electron_versions=(
+  "1.2.8"
+  "1.3.8"
+  "1.4.6"
+  "1.7.12"
+  "2.0.18"
+  "3.1.13"
+  "4.2.10"
+  "5.0.10"
+  "6.0.7"
+)
+
+# remove old build directory
+rm -rf "$SOURCHE_PATH/build" > /dev/null
+
+# create release path
+mkdir -p "$SOURCE_PATH/releases/$RELEASE_VERSION" > /dev/null
+
+for version in "${node_versions[@]}"
+do
+  echo "Building for node version: $version..."
+  node-pre-gyp configure --target=$version --module_name=node_printer --silent
+  node-pre-gyp build package --target=$version --target_arch=x64 --build-from-source --silent
+  node-pre-gyp configure --target=$version --module_name=node_printer --silent
+  node-pre-gyp build package --target=$version --target_arch=ia32 --build-from-source --silent
+  rsync -a -v "$SOURCE_PATH/build/stage/$PACKAGE_VERSION/" "$SOURCE_PATH/releases/$RELEASE_VERSION/" --remove-source-files > /dev/null
+  echo "Done"
+done
+
+for version in "${electron_versions[@]}"
+do
+  echo "Building for electron version: $version..."
+  node-pre-gyp configure --target=$version --dist-url=https://electronjs.org/headers --module_name=node_printer --silent
+  node-pre-gyp build package --target=$version --target_arch=x64 --runtime=electron --build-from-source --silent
+  node-pre-gyp configure --target=$version --dist-url=https://electronjs.org/headers --module_name=node_printer --silent
+  node-pre-gyp build package --target=$version --target_arch=ia32 --runtime=electron --build-from-source --silent
+  rsync -a -v "$SOURCE_PATH/build/stage/$PACKAGE_VERSION/" "$SOURCE_PATH/releases/$RELEASE_VERSION/" --remove-source-files > /dev/null
+  echo "Done"
+done
+
+echo "Finished succesfully!"

package/tools/generateReleaseBuildsWindows.ps1

@@ -0,0 +1,63 @@
+param (
+  [Parameter(Mandatory=$true)][string]$release
+)
+
+$SOURCE_PATH = split-path -parent $MyInvocation.MyCommand.Definition
+$RELEASE_VERSION = $release
+$PACKAGE_VERSION = node -pe "require('./package.json').version"
+
+echo $SOURCE_PATH
+
+$node_versions = @(
+  "0.10.48",
+  "0.12.18",
+  "4.9.1",
+  "5.9.1",
+  "6.17.1",
+  "8.16.1",
+  "10.16.0",
+  "11.15.0",
+  "12.10.0"
+)
+
+$electron_versions = @(
+  "1.2.8",
+  "1.3.8",
+  "1.4.6",
+  "1.7.12",
+  "2.0.18",
+  "3.1.13",
+  "4.2.10",
+  "5.0.10",
+  "6.0.7",
+)
+
+# remove old build directory
+Remove-Item -Recurse -Force $SOURCE_PATH'\..\build' -ErrorAction Ignore | Out-Null
+
+# create release path
+New-Item $SOURCE_PATH'\..\releases\'$RELEASE_VERSION -ItemType Directory -ea 0 | Out-Null
+
+foreach ($version in $node_versions) {
+  Write-Output "Building for node version: $version..."
+  node-pre-gyp configure --target=$version --module_name=node_printer --silent | Out-Null
+  node-pre-gyp build package --target=$version --target_arch=x64 --build-from-source --silent | Out-Null
+  node-pre-gyp configure --target=$version --module_name=node_printer --silent | Out-Null
+  node-pre-gyp build package --target=$version --target_arch=ia32 --build-from-source --silent | Out-Null
+  Copy-item -Force -Recurse $SOURCE_PATH'\..\build\stage\'$PACKAGE_VERSION\* -Destination $SOURCE_PATH'\..\releases\'$RELEASE_VERSION -ErrorAction Ignore | Out-Null
+  Remove-Item -Recurse -Force $SOURCE_PATH'\..\build\stage' | Out-Null
+  Write-Output "Done"
+}
+
+foreach ($version in $electron_versions) {
+  Write-Output "Building for electron version: $version..."
+  node-pre-gyp configure --target=$version --dist-url=https://electronjs.org/headers --module_name=node_printer --silent | Out-Null
+  node-pre-gyp build package --target=$version --target_arch=x64 --runtime=electron --build-from-source --silent | Out-Null
+  node-pre-gyp configure --target=$version --dist-url=https://electronjs.org/headers --module_name=node_printer --silent | Out-Null
+  node-pre-gyp build package --target=$version --target_arch=ia32 --runtime=electron --build-from-source --silent | Out-Null
+  Copy-item -Force -Recurse $SOURCE_PATH'\..\build\stage\'$PACKAGE_VERSION\* -Destination $SOURCE_PATH'\..\releases\'$RELEASE_VERSION -ErrorAction Ignore | Out-Null
+  Remove-Item -Recurse -Force $SOURCE_PATH'\..\build\stage' | Out-Null
+  Write-Output "Done"
+}
+
+Write-Output "Finished succesfully!"

package/tools/getSourceFiles.py

@@ -0,0 +1,12 @@
+# simple python command to list files like ls -1
+import os, sys
+
+if len(sys.argv) < 3:
+    sys.stderr.write('use: '+sys.argv[0]+' <path> <ext>. e.g.:'+sys.argv[0]+' src cc\n')
+    sys.exit(1)
+folder = sys.argv[1]
+file_ext = '.'+sys.argv[2]
+
+for file in os.listdir(folder):
+    if (file.endswith(file_ext)):
+        print(folder+'/'+file)

package/tools/remove_directory.py

@@ -0,0 +1,27 @@
+import shutil
+import sys
+import os
+
+def remove_directory(directory):
+    try:
+        shutil.rmtree(directory)
+    except OSError as e:
+        print(f"Error: {directory} : {e.strerror}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    # Check if the directory argument is provided
+    if len(sys.argv) < 2:
+        print("Usage: python remove_directory.py <directory>")
+        sys.exit(1)
+
+    # Get the directory to remove from command line argument
+    directory = sys.argv[1]
+
+    # Check if the directory exists
+    if not os.path.exists(directory):
+        print(f"Error: Directory '{directory}' does not exist.")
+        sys.exit(1)
+
+    # Call the function to remove the directory
+    remove_directory(directory)

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": [
+        "es6"
+    ],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "baseUrl": "../",
+    "typeRoots": [
+        "../"
+    ],
+    "types": [],
+    "noEmit": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "files": [
+    "types/index.d.ts",
+  ]
+}

package/types/index.d.ts

@@ -0,0 +1,56 @@
+export function getPrinters(): PrinterDetails[];
+export function getPrinter(printerName: string): PrinterDetails;
+export function getPrinterDriverOptions(printerName: string): PrinterDriverOptions;
+export function getSelectedPaperSize(printerName: string): string;
+export function getDefaultPrinterName(): string | undefined;
+export function printDirect(options: PrintDirectOptions): void;
+export function printFile(options: PrintFileOptions): void;
+export function getSupportedPrintFormats(): string[];
+export function getJob(printerName: string, jobId: number): JobDetails;
+export function setJob(printerName: string, jobId: number, command: 'CANCEL' | string): void;
+export function getSupportedJobCommands(): string[];
+
+export interface PrintDirectOptions {
+    data: string | Buffer;
+    printer?: string | undefined;
+    type?: 'RAW' | 'TEXT' | 'PDF' | 'JPEG' | 'POSTSCRIPT' | 'COMMAND' | 'AUTO' | undefined;
+    options?: { [key: string]: string } | undefined;
+    success?: PrintOnSuccessFunction | undefined;
+    error?: PrintOnErrorFunction | undefined;
+}
+
+export interface PrintFileOptions {
+    filename: string;
+    printer?: string | undefined;
+    success?: PrintOnSuccessFunction | undefined;
+    error?: PrintOnErrorFunction | undefined;
+}
+
+export type PrintOnSuccessFunction = (jobId: string) => any;
+export type PrintOnErrorFunction = (err: Error) => any;
+
+export interface PrinterDetails {
+    name: string;
+    isDefault: boolean;
+    options: { [key: string]: string; };
+}
+
+export interface PrinterDriverOptions {
+    [key: string]: { [key: string]: boolean; };
+}
+
+export interface JobDetails {
+    id: number;
+    name: string;
+    printerName: string;
+    user: string;
+    format: string;
+    priority: number;
+    size: number;
+    status: JobStatus[];
+    completedTime: Date;
+    creationTime: Date;
+    processingTime: Date;
+}
+
+export type JobStatus = 'PAUSED' | 'PRINTING' | 'PRINTED' | 'CANCELLED' | 'PENDING' | 'ABORTED';