@esslassi/electron-printer 0.0.6 → 0.0.7

package/lib/electronPrinter.d.ts

@@ -1,33 +1,61 @@
-export interface PrintOptions {
-    printerName: string;
+export type PrintOnSuccessFunction = (jobId: string) => any;
+export type PrintOnErrorFunction = (err: Error) => any;
+export interface PrintDirectOptions {
     data: string | Buffer;
-    dataType?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO' | undefined;
+    printer?: string;
+    type?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO';
+    options?: {
+        [key: string]: string;
+    };
+    success?: PrintOnSuccessFunction;
+    error?: PrintOnErrorFunction;
 }
-export interface Printer {
+export interface PrintFileOptions {
+    filename: string;
+    printer?: string;
+    success?: PrintOnSuccessFunction;
+    error?: PrintOnErrorFunction;
+}
+export interface PrinterDetails {
     name: string;
     isDefault: boolean;
-    status: string;
-    details: {
-        location?: string;
-        comment?: string;
-        driver?: string;
-        port?: string;
-        [key: string]: string | undefined;
+    options: {
+        [key: string]: string;
     };
 }
-export interface PrintDirectOptions {
-    printerName: string;
-    data: string | Buffer;
-    dataType?: 'RAW' | 'TEXT' | 'COMMAND' | 'AUTO' | undefined;
-}
-export interface GetStatusPrinterOptions {
-    printerName: string;
+export interface PrinterDriverOptions {
+    [key: string]: {
+        [key: string]: boolean;
+    };
 }
-export interface PrintDirectOutput {
+export type JobStatus = 'PAUSED' | 'PRINTING' | 'PRINTED' | 'CANCELLED' | 'PENDING' | 'ABORTED';
+export type JobCommand = "CANCEL" | "PAUSE" | "RESUME";
+export interface JobDetails {
+    id: number;
     name: string;
-    status: 'success' | 'failed';
+    printerName: string;
+    user: string;
+    format: string;
+    priority: number;
+    size: number;
+    status: JobStatus[];
+    completedTime: Date;
+    creationTime: Date;
+    processingTime: Date;
 }
-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>;
+export declare function getPrinters(): PrinterDetails[];
+export declare function getPrinter(printerName: string): PrinterDetails;
+export declare function getPrinterDriverOptions(printerName: string): PrinterDriverOptions;
+export declare function getSelectedPaperSize(printerName: string): string;
+export declare function getDefaultPrinterName(): string | undefined;
+export declare function printDirect(options: PrintDirectOptions): void;
+export declare function printFile(options: PrintFileOptions): void;
+export declare function getSupportedPrintFormats(): string[];
+export declare function getJob(printerName: string, jobId: number): JobDetails;
+export declare function setJob(printerName: string, jobId: number, command: JobCommand): void;
+export declare function getSupportedJobCommands(): string[];
+export declare function printDirectAsync(options: Omit<PrintDirectOptions, 'success' | 'error'>): Promise<string>;
+export declare function printFileAsync(options: Omit<PrintFileOptions, 'success' | 'error'>): Promise<string>;
+export declare function getJobAsync(printerName: string, jobId: number): Promise<JobDetails>;
+export declare function getPrintersAsync(): Promise<PrinterDetails[]>;
+export declare function getPrinterAsync(printerName: string): Promise<PrinterDetails>;

package/lib/electronPrinter.js

@@ -3,36 +3,87 @@ 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;
+exports.getPrinter = getPrinter;
+exports.getPrinterDriverOptions = getPrinterDriverOptions;
+exports.getSelectedPaperSize = getSelectedPaperSize;
+exports.getDefaultPrinterName = getDefaultPrinterName;
+exports.printDirect = printDirect;
+exports.printFile = printFile;
+exports.getSupportedPrintFormats = getSupportedPrintFormats;
+exports.getJob = getJob;
+exports.setJob = setJob;
+exports.getSupportedJobCommands = getSupportedJobCommands;
+exports.printDirectAsync = printDirectAsync;
+exports.printFileAsync = printFileAsync;
+exports.getJobAsync = getJobAsync;
+exports.getPrintersAsync = getPrintersAsync;
+exports.getPrinterAsync = getPrinterAsync;
 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}`;
+const native = (0, bindings_1.default)('electron_printer');
+/* ===========================
+   DIRECT NATIVE EXPORTS
+=========================== */
+function getPrinters() {
+    return native.getPrinters();
+}
+function getPrinter(printerName) {
+    return native.getPrinter(printerName);
+}
+function getPrinterDriverOptions(printerName) {
+    return native.getPrinterDriverOptions(printerName);
+}
+function getSelectedPaperSize(printerName) {
+    return native.getSelectedPaperSize(printerName);
+}
+function getDefaultPrinterName() {
+    return native.getDefaultPrinterName();
+}
+function printDirect(options) {
+    native.printDirect(options);
+}
+function printFile(options) {
+    native.printFile(options);
+}
+function getSupportedPrintFormats() {
+    return native.getSupportedPrintFormats();
+}
+function getJob(printerName, jobId) {
+    return native.getJob(printerName, jobId);
+}
+function setJob(printerName, jobId, command) {
+    native.setJob(printerName, jobId, command);
+}
+function getSupportedJobCommands() {
+    return native.getSupportedJobCommands();
+}
+/* ==================================================
+   PROMISE WRAPPERS (Async/Await Friendly)
+================================================== */
+function printDirectAsync(options) {
+    return new Promise((resolve, reject) => {
+        native.printDirect({
+            ...options,
+            success: (jobId) => resolve(jobId),
+            error: (err) => reject(err)
+        });
+    });
+}
+function printFileAsync(options) {
+    return new Promise((resolve, reject) => {
+        native.printFile({
+            ...options,
+            success: (jobId) => resolve(jobId),
+            error: (err) => reject(err)
+        });
+    });
+}
+function getJobAsync(printerName, jobId) {
+    return Promise.resolve(native.getJob(printerName, jobId));
+}
+function getPrintersAsync() {
+    return Promise.resolve(native.getPrinters());
+}
+function getPrinterAsync(printerName) {
+    return Promise.resolve(native.getPrinter(printerName));
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@esslassi/electron-printer",
   "description": "Node.js and Electron bindings",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "main": "./lib/index.js",
   "private": false,
   "scripts": {