@devraghu/electron-printer 1.1.0 → 2.1.0

package/README.md

@@ -21,7 +21,7 @@ yarn add @devraghu/electron-printer
 This library is designed for use in the **main process only**.
 
 ```js
-const { posPrinter } = require('@devraghu/electron-printer');
+import { printer } from '@devraghu/electron-printer';
 
 const options = {
   preview: false,
@@ -55,7 +55,7 @@ const data = [
   },
 ];
 
-posPrinter
+printer
   .print(data, options)
   .then(() => console.log('Print successful'))
   .catch((error) => console.error(error));
@@ -63,12 +63,14 @@ posPrinter
 
 > **Note:** If you need to trigger printing from the renderer process, use IPC to communicate with the main process.
 
-## TypeScript Usage
+## TypeScript
+
+Full TypeScript support with exported types:
 
 ```typescript
-import { posPrinter, type PosPrintData, type PosPrintOptions, type PrintResult } from '@devraghu/electron-printer';
+import { printer, type PrintData, type PrintOptions, type PrintResult } from '@devraghu/electron-printer';
 
-const options: PosPrintOptions = {
+const options: PrintOptions = {
   preview: false,
   margin: '0 0 0 0',
   copies: 1,
@@ -77,7 +79,7 @@ const options: PosPrintOptions = {
   pageSize: '80mm',
 };
 
-const data: PosPrintData[] = [
+const data: PrintData[] = [
   {
     type: 'text',
     value: 'Hello World',
@@ -85,7 +87,7 @@ const data: PosPrintData[] = [
   },
 ];
 
-posPrinter
+printer
   .print(data, options)
   .then(() => console.log('Done'))
   .catch((error) => console.error(error));
@@ -232,9 +234,9 @@ Tables can contain text and images in cells:
 Retrieve a list of all available printers on the system:
 
 ```typescript
-import { posPrinter } from '@devraghu/electron-printer';
+import { printer } from '@devraghu/electron-printer';
 
-const printers = posPrinter.getPrinters();
+const printers = await printer.getPrinters();
 console.log(printers);
 // [{ name: 'XP-80C', isDefault: true, ... }, ...]
 ```
@@ -244,10 +246,10 @@ console.log(printers);
 Open a cash drawer connected to a thermal printer:
 
 ```typescript
-import { posPrinter } from '@devraghu/electron-printer';
+import { printer } from '@devraghu/electron-printer';
 
 // Open cash drawer on specific printer
-posPrinter
+printer
   .openCashDrawer('XP-80C')
   .then(() => console.log('Cash drawer opened'))
   .catch((error) => console.error('Failed to open cash drawer:', error));
@@ -262,15 +264,16 @@ electron-printer/
 ├── src/
 │   ├── main/
 │   │   ├── index.ts          # Main exports
-│   │   ├── pos-printer.ts    # posPrinter exports
+│   │   ├── printer.ts        # Printer API
 │   │   ├── models.ts         # TypeScript interfaces
 │   │   └── utils.ts          # Helper functions
 │   ├── renderer/
 │   │   ├── renderer.ts       # Content rendering
 │   │   ├── utils.ts          # HTML generation
-│   │   └── index.html        # Print template
+│   │   ├── index.html        # Print template
+│   │   └── index.css         # Print styles
 │   └── preload/
-│       └── preload.ts        # Preload script with API types
+│       └── preload.ts        # Preload script
 ├── demo/                     # Demo application
 ├── test/                     # Playwright E2E tests
 └── dist/                     # Compiled output

package/dist/index.d.ts

@@ -1,128 +1 @@
-import { DrawerOptions, OpenCashDrawerResult, PrinterErrorCodes, PrinterInfo, PrinterStatus, PrinterType, getAvailablePrinters, openCashDrawer } from '@devraghu/cashdrawer';
-
-export declare const posPrinter: {
-	print: (data: PosPrintData[], options: PosPrintOptions) => Promise<PrintResult>;
-	openCashDrawer: typeof openCashDrawer;
-	getPrinters: typeof getAvailablePrinters;
-};
-export declare type PaperSize = "80mm" | "78mm" | "76mm" | "57mm" | "58mm" | "44mm";
-/**
- * @type PosPrintPosition
- * @description Alignment for type barCode and qrCode
- *
- */
-export declare type PosPrintPosition = "left" | "center" | "right";
-/**
- * @type PosPrintType
- * @name PosPrintType
- * **/
-export declare type PosPrintType = "text" | "barCode" | "qrCode" | "image" | "table";
-/**
- * @interface
- * @name PosPrintData
- * **/
-export interface PosPrintData {
-	/**
-	 * @property type
-	 * @description type data to print: 'text' | 'barCode' | 'qrcode' | 'image' | 'table'
-	 */
-	type: PosPrintType;
-	value?: string;
-	style?: PrintDataStyle;
-	width?: string;
-	height?: string;
-	fontsize?: number;
-	displayValue?: boolean;
-	position?: PosPrintPosition;
-	path?: string;
-	url?: string;
-	tableHeader?: PosPrintTableField[] | string[];
-	tableBody?: PosPrintTableField[][] | string[][];
-	tableFooter?: PosPrintTableField[] | string[];
-	tableHeaderStyle?: PrintDataStyle;
-	tableBodyStyle?: PrintDataStyle;
-	tableFooterStyle?: PrintDataStyle;
-}
-/**
- * @description Print options
- * {@link https://www.electronjs.org/docs/latest/api/web-contents#contentsprintoptions-callback}
- * @field copies: number of copies to print
- * @field preview: bool，false=print，true=pop preview window
- * @field deviceName: string，default device name, check it at webContent.getPrinters()
- * @field timeoutPerLine: int，timeout，actual time is ：data.length * timeoutPerLine ms
- * @field silent: To print silently
- * @field pathTemplate: Path to HTML file for custom print options
- */
-export interface PosPrintOptions {
-	header?: string;
-	width?: string | number;
-	footer?: string;
-	copies?: number;
-	preview?: boolean;
-	printerName?: string;
-	margin?: string;
-	timeOutPerLine?: number;
-	silent?: boolean;
-	color?: boolean;
-	printBackground?: boolean;
-	margins?: {
-		marginType?: "default" | "none" | "printableArea" | "custom";
-		top?: number;
-		bottom?: number;
-		right?: number;
-		left?: number;
-	};
-	landscape?: boolean;
-	scaleFactor?: number;
-	pagesPerSheet?: number;
-	collate?: boolean;
-	pageRanges?: {
-		from: number;
-		to: number;
-	}[];
-	duplexMode?: "simplex" | "shortEdge" | "longEdge";
-	pageSize?: PaperSize | SizeOptions;
-	dpi?: {
-		horizontal: number;
-		vertical: number;
-	};
-	pathTemplate?: string;
-}
-/**
- * @interface
- * @name PosPrintTableField
- * */
-export interface PosPrintTableField {
-	type: "text" | "image";
-	value?: string;
-	path?: string;
-	style?: PrintDataStyle;
-	width?: string;
-	height?: string;
-}
-export interface PrintResult {
-	complete: boolean;
-	data?: PosPrintData[];
-	options?: PosPrintOptions;
-}
-export interface SizeOptions {
-	height: number;
-	width: number;
-}
-/**
- * CSS Style interface - a subset of CSSStyleDeclaration properties commonly used for printing
- * Uses Record type for flexibility while maintaining type safety
- */
-export type PrintDataStyle = {
-	[K in keyof CSSStyleDeclaration]?: CSSStyleDeclaration[K];
-};
-
-export {
-	DrawerOptions,
-	OpenCashDrawerResult,
-	PrinterErrorCodes,
-	PrinterInfo,
-	PrinterStatus,
-	PrinterType,
-};
-
+export { }

package/dist/index.js

@@ -1 +1,157 @@
-import{fileURLToPath as e}from"node:url";var r=e(import.meta.url.replace(/\/(?:[^\/]*)$/,""));import{BrowserWindow as t,ipcMain as o}from"electron";import{join as n}from"node:path";import{PrinterErrorCodes as a,PrinterStatus as i,PrinterType as s,getAvailablePrinters as p,openCashDrawer as c}from"@devraghu/cashdrawer";var l={};function d(e,r,t){return new Promise((n,a)=>{o.once(`${e}-reply`,(e,r)=>{r.status?n(r):a(r.error)}),r.send(e,t)})}function h(e){let r=1200,t=219;if("string"==typeof e)switch(e){case"44mm":t=166;break;case"57mm":t=215;break;case"58mm":t=219;break;case"76mm":t=287;break;case"78mm":t=295;break;case"80mm":t=302}else"object"==typeof e&&(t=e.width,r=e.height);return{width:t,height:r}}function m(e){return Math.ceil(264.5833*e)}if(l.d=(e,r)=>{for(var t in r)l.o(r,t)&&!l.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},l.o=(e,r)=>Object.prototype.hasOwnProperty.call(e,r),"renderer"===process.type)throw new Error("electron-pos-printer: this module must be used in the main process only");const w={print:(e,o)=>new Promise((a,i)=>{o.preview||o.printerName||o.silent||i(new Error("A printer name is required, if you don't want to specify a printer name, set silent to true")),"object"!=typeof o.pageSize||o.pageSize.height&&o.pageSize.width||i(new Error("height and width properties are required for options.pageSize"));let s=!1,p=null;const c=o.timeOutPerLine?o.timeOutPerLine*e.length+200:400*e.length+200;o.preview||o.silent||setTimeout(()=>{if(!s){const e=p||new Error("[TimedOutError] Make sure your printer is connected");i(e),s=!0}},c);let l=new t({...h(o.pageSize),show:!!o.preview,webPreferences:{nodeIntegration:!1,contextIsolation:!0,sandbox:!1,preload:n(r,"preload/preload.cjs")}});l.on("closed",()=>{l=null}),l.loadFile(o.pathTemplate||n(r,"renderer/index.html")),l.webContents.on("did-finish-load",async()=>{if(l)return await d("body-init",l.webContents,o),(async(e,r)=>{for(const[t,o]of r.entries()){if("image"===o.type&&!o.path&&!o.url)throw e.close(),new Error("An Image url/path is required for type image");if(o.style&&"object"!=typeof o.style)throw e.close(),new Error('`options.styles` at "'+o.style+'" should be an object. Example: {style: {fontSize: 12}}');const r=await d("render-line",e.webContents,{line:o,lineIndex:t});if(!r.status)throw e.close(),new Error(`Failed to render line ${t} (type: ${o.type}): ${r.error||"Unknown error"}`)}return{message:"page-rendered"}})(l,e).then(async()=>{if(!l)return void i(new Error("Window was closed during rendering"));let{width:r,height:t}=function(e){let r=1e4,t=58e3;if("string"==typeof e)switch(e){case"44mm":t=Math.ceil(44e3);break;case"57mm":t=Math.ceil(57e3);break;case"58mm":t=Math.ceil(58e3);break;case"76mm":t=Math.ceil(76e3);break;case"78mm":t=Math.ceil(78e3);break;case"80mm":t=Math.ceil(8e4)}else"object"==typeof e&&(t=m(e.width),r=m(e.height));return{width:t,height:r}}(o.pageSize);if("string"==typeof o.pageSize){t=m(await l.webContents.executeJavaScript("document.body.clientHeight"))}o.preview?a({complete:!0,data:e,options:o}):l.webContents.print({silent:!!o.silent,printBackground:!!o.printBackground,deviceName:o.printerName,copies:o?.copies||1,pageSize:{width:r,height:t},...o.header&&{header:o.header},...o.footer&&{footer:o.footer},...o.color&&{color:o.color},...o.printBackground&&{printBackground:o.printBackground},...o.margins&&{margins:o.margins},...o.landscape&&{landscape:o.landscape},...o.scaleFactor&&{scaleFactor:o.scaleFactor},...o.pagesPerSheet&&{pagesPerSheet:o.pagesPerSheet},...o.collate&&{collate:o.collate},...o.pageRanges&&{pageRanges:o.pageRanges},...o.duplexMode&&{duplexMode:o.duplexMode},...o.dpi&&{dpi:o.dpi}},(e,r)=>{r&&(p=new Error(r),i(p)),s||(a({complete:e,options:o}),s=!0),l?.close()})}).catch(e=>i(e));i(new Error("Window was closed before loading completed"))})}),openCashDrawer:c,getPrinters:p};export{a as PrinterErrorCodes,i as PrinterStatus,s as PrinterType,w as posPrinter};
+import { ipcMain as w, BrowserWindow as p } from "electron";
+import { join as d } from "node:path";
+import { getAvailablePrinters as g, openCashDrawer as P } from "@devraghu/cashdrawer";
+import { PrinterErrorCodes as D, PrinterStatus as R, PrinterType as k } from "@devraghu/cashdrawer";
+const l = /* @__PURE__ */ new Set(["44mm", "57mm", "58mm", "76mm", "78mm", "80mm"]), y = {
+  "44mm": 166,
+  "57mm": 215,
+  "58mm": 219,
+  "76mm": 287,
+  "78mm": 295,
+  "80mm": 302
+}, b = {
+  "44mm": 44e3,
+  "57mm": 57e3,
+  "58mm": 58e3,
+  "76mm": 76e3,
+  "78mm": 78e3,
+  "80mm": 8e4
+};
+function h(e, t, n) {
+  return new Promise((r, i) => {
+    w.once(`${e}-reply`, (o, a) => {
+      a.status ? r(a) : i(a.error);
+    }), t.send(e, n);
+  });
+}
+function E(e) {
+  if (typeof e == "string") {
+    if (!l.has(e)) {
+      const r = [...l].join(", ");
+      throw new Error(`Invalid pageSize "${e}". Valid sizes are: ${r}`);
+    }
+    return {
+      width: y[e],
+      height: 1200
+    };
+  }
+  if (typeof e == "object") {
+    if (!e.width || !e.height)
+      throw new Error("height and width properties are required for options.pageSize");
+    return {
+      width: e.width,
+      height: e.height
+    };
+  }
+  return { width: 219, height: 1200 };
+}
+function s(e) {
+  return Math.ceil(e * 264.5833);
+}
+async function v(e, t) {
+  if (typeof t == "string") {
+    const i = await e.executeJavaScript("document.body.clientHeight");
+    return {
+      width: b[t] ?? 58e3,
+      height: s(i)
+    };
+  }
+  return typeof t == "object" ? {
+    width: s(t.width),
+    height: s(t.height)
+  } : { width: 58e3, height: 1e4 };
+}
+function I(e, t, n) {
+  return new Promise((r, i) => {
+    const o = setTimeout(() => {
+      i(new Error("[TimedOutError] Make sure your printer is connected"));
+    }, t), a = () => clearTimeout(o);
+    n.addEventListener("abort", a, { once: !0 }), e.then((c) => {
+      a(), r(c);
+    }).catch((c) => {
+      a(), i(c);
+    });
+  });
+}
+function x(e, t) {
+  if (!t.preview && !t.printerName && !t.silent)
+    throw new Error("A printer name is required, if you don't want to specify a printer name, set silent to true");
+  if (typeof t.copies == "number" && t.copies <= 0)
+    throw new Error(`Invalid copies value: ${t.copies}. Must be a positive integer`);
+  for (const [n, r] of e.entries()) {
+    if (r.type === "image" && !r.path && !r.url)
+      throw new Error(`Print item ${n}: image requires a path or url`);
+    if (r.style && typeof r.style != "object")
+      throw new Error(`Print item ${n}: style must be an object. Example: {style: {fontSize: 12}}`);
+  }
+}
+if (process.type === "renderer")
+  throw new Error("electron-printer: this module must be used in the main process only");
+function M(e, t) {
+  return {
+    silent: !!e.silent,
+    printBackground: !!e.printBackground,
+    deviceName: e.printerName,
+    copies: e.copies ?? 1,
+    pageSize: t,
+    header: e.header,
+    footer: e.footer,
+    color: e.color,
+    margins: e.margins,
+    landscape: e.landscape,
+    scaleFactor: e.scaleFactor,
+    pagesPerSheet: e.pagesPerSheet,
+    collate: e.collate,
+    pageRanges: e.pageRanges,
+    duplexMode: e.duplexMode,
+    dpi: e.dpi
+  };
+}
+async function C(e, t) {
+  for (const [n, r] of t.entries()) {
+    const i = await h("render-line", e.webContents, { printItem: r, itemIndex: n });
+    if (!i.status)
+      throw new Error(
+        `Failed to render item ${n} (type: ${r.type}): ${i.error || "Unknown error"}`
+      );
+  }
+}
+function H(e, t) {
+  return new Promise((n, r) => {
+    e.webContents.print(t, (i, o) => {
+      o ? r(new Error(o)) : n({ success: i }), e.close();
+    });
+  });
+}
+async function T(e, t) {
+  x(e, t);
+  const n = E(t.pageSize), r = new p({
+    ...n,
+    show: !!t.preview,
+    webPreferences: {
+      nodeIntegration: !1,
+      contextIsolation: !0,
+      sandbox: !1,
+      preload: d(import.meta.dirname, "preload/preload.cjs")
+    }
+  }), i = t.pathTemplate || d(import.meta.dirname, "renderer/index.html");
+  try {
+    if (await r.loadFile(i), await h("body-init", r.webContents, t), await C(r, e), t.preview)
+      return { complete: !0, data: e, options: t };
+    const o = await v(r.webContents, t.pageSize), a = M(t, o), c = H(r, a), m = new AbortController(), u = (t.timeOutPerLine ?? 400) * e.length + 200, { success: f } = t.silent ? await c : await I(c, u, m.signal);
+    return m.abort(), { complete: f, options: t };
+  } catch (o) {
+    throw r.close(), o;
+  }
+}
+const A = {
+  print: T,
+  openCashDrawer: P,
+  getPrinters: g
+};
+export {
+  D as PrinterErrorCodes,
+  R as PrinterStatus,
+  k as PrinterType,
+  A as printer
+};

package/dist/preload/preload.cjs

@@ -1 +1 @@
-(()=>{"use strict";const e=require("electron"),r=require("node:fs"),n=require("node:path"),s={onBodyInit:r=>{e.ipcRenderer.on("body-init",(e,n)=>{r(n)})},onRenderLine:r=>{e.ipcRenderer.on("render-line",(e,n)=>{r(n)})},sendBodyInitReply:r=>{e.ipcRenderer.send("body-init-reply",r)},sendRenderLineReply:r=>{e.ipcRenderer.send("render-line-reply",r)},readFileAsBase64:e=>{try{const s=n.resolve(e),i=process.cwd();if(!s.startsWith(i+n.sep)&&s!==i)return{success:!1,error:"Access denied: Path outside allowed directory"};if(!r.existsSync(s))return{success:!1,error:"File not found"};return{success:!0,data:r.readFileSync(s).toString("base64")}}catch(e){return{success:!1,error:e.message}}},getFileExtension:e=>n.extname(e).slice(1)};e.contextBridge.exposeInMainWorld("electronAPI",s)})();
+"use strict";const t=require("electron"),a=require("node:fs"),d=require("node:path");function i(e){const r=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const n in e)if(n!=="default"){const s=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(r,n,s.get?s:{enumerable:!0,get:()=>e[n]})}}return r.default=e,Object.freeze(r)}const o=i(a),c=i(d),l={onBodyInit:e=>{t.ipcRenderer.once("body-init",(r,n)=>{e(n)})},onRenderLine:e=>{t.ipcRenderer.on("render-line",(r,n)=>{e(n)})},sendBodyInitReply:e=>{t.ipcRenderer.send("body-init-reply",e)},sendRenderLineReply:e=>{t.ipcRenderer.send("render-line-reply",e)},readFileAsBase64:e=>{try{const r=c.resolve(e),n=process.cwd();return!r.startsWith(n+c.sep)&&r!==n?{success:!1,error:"Access denied: Path outside allowed directory"}:o.existsSync(r)?{success:!0,data:o.readFileSync(r).toString("base64")}:{success:!1,error:"File not found"}}catch(r){return{success:!1,error:r.message}}},getFileExtension:e=>c.extname(e).slice(1)};t.contextBridge.exposeInMainWorld("electronAPI",l);

package/dist/renderer/assets/index-Dr_XYfBm.css

@@ -0,0 +1 @@
+@page{margin:0;page-break-before:always}body{font-size:12px}.barcode-container:after{content:"";display:table;clear:both}.font{font-size:12px;margin:0 15px}table{width:100%;display:table;border-collapse:collapse;border-spacing:0;font-family:monospace,cursive}table tbody{border-top:1px solid #999}table th,table td{padding:7px 2px}table tr{border-bottom:1px dotted #999;padding:5px 0;text-align:center}table img{max-height:40px}