dikshiprintagent 1.0.2 → 1.0.4

package/README.md

@@ -4,8 +4,12 @@ Official JavaScript SDK for connecting a website, billing application, POS, ERP,
 
 It lets a web application discover installed Windows printers and submit text, HTML, image, PDF, barcode, QR-code, RAW, and ESC/POS print jobs through a simple JavaScript API.
 
+The Windows agent is a local print bridge designed around Windows printer queues, so newly installed printers are discovered automatically when Windows has a working driver.
+
 > This npm package is the web SDK. The Dikshi Print Agent Windows application must be installed and running on every computer that needs to print.
 
+Android/iOS remote printing through the optional secure relay is documented in [REMOTE-PRINTING.md](REMOTE-PRINTING.md).
+
 ## How it works
 
 ```text
@@ -19,6 +23,35 @@ Dikshi Print Agent for Windows
 Installed Windows Printer
 ```
 
+## V10 features
+
+- Windows tray application
+- Loopback-only HTTP API on `127.0.0.1:8181`
+- First-run 256-bit random API token
+- Origin allow-list/CORS protection
+- Dynamic installed-printer discovery and default-printer detection
+- Queued print jobs with job status and history
+- Text printing through Windows PrintDocument
+- Image printing (base64 PNG/JPG/BMP and other supported formats)
+- RAW printing through Winspool for label languages and printer-native data
+- ESC/POS printing through the RAW path
+- PDF printing through the Windows registered PDF `printto` handler
+- Direct PDF URL printing: the agent downloads a PDF from an API URL and sends it to the selected printer
+- HTML printing through WebView2 with page-size and orientation options
+- Invoice and receipt template printing from plain JSON data
+- QR and CODE128 barcode printing
+- ESC/POS receipt builder in the browser SDK
+- Persistent recent job history under `%APPDATA%\DikshiPrintAgent\job-history.json`
+- Local dashboard with printer list, HTML/text test printing, and job history
+- Visual template designer at `/designer` with drag-and-drop fields and saved JSON layouts
+- Designer validation, version backups, locked layouts, resize handles, undo/redo, zoom, logo upload, and custom table columns
+- Dashboard and designer pages do not embed the API token; paste it from the tray menu before using protected actions
+- Daily logs under `%APPDATA%\DikshiPrintAgent\logs`
+- Start-with-Windows support
+- Browser JavaScript SDK and test page
+- Single-file, self-contained `win-x64` publish
+- Inno Setup script included
+
 ## Installation
 
 ```bash
@@ -27,6 +60,12 @@ npm install dikshiprintagent
 
 The SDK uses ES modules and supports modern browser build tools such as Vite, React, Vue, Angular, and Next.js client components.
 
+## Build the Windows agent
+
+Install the Microsoft .NET 8 SDK on the Windows development computer, then run `build-exe.bat`.
+
+The output is `DikshiPrintAgent-V10.exe` in the project root.
+
 ## Before you start
 
 On the Windows billing computer:
@@ -51,6 +90,20 @@ On the Windows billing computer:
 
 Never publish or hard-code a customer's API token in source control.
 
+On its first run, the EXE creates `%APPDATA%\DikshiPrintAgent\config.json`. Right-click the tray icon and select **Copy API Token**. Edit `AllowedOrigins` in `config.json` to include your websites, then restart the agent.
+
+For example:
+
+```json
+"AllowedOrigins": [
+  "https://erp.example.com",
+  "https://billing.example.com",
+  "http://localhost:*"
+]
+```
+
+Do not set `AllowAllOrigins=true` on production computers unless you fully understand the security risk.
+
 ## Quick start
 
 ```js
@@ -109,6 +162,23 @@ const job = await agent.printPdfUrl('HP Laser Printer', invoiceUrl, {
 await agent.wait(job.jobId, 30000);
 ```
 
+The agent can also download and print a PDF returned by a server API as `application/pdf`. It validates the downloaded file, queues it, and prints it through the existing PDF print handler.
+
+```bash
+curl -X POST "http://127.0.0.1:8181/api/v1/print/pdf-url" \
+  -H "Content-Type: application/json" \
+  -H "X-Dikshi-Token: YOUR_AGENT_TOKEN" \
+  -d "{\"printer\":\"YOUR_WINDOWS_PRINTER_NAME\",\"url\":\"https://dikshitech.ddns.net/kingmotorsapi/api/BookingEntry/DownloadBookingPdf/001/B00009AA\",\"documentName\":\"Booking_B00009AA.pdf\"}"
+```
+
+Browser SDK:
+
+```js
+await agent.printPdfUrl(printerName, bookingPdfUrl, {
+  documentName: 'Booking_B00009AA.pdf'
+});
+```
+
 ### QR code and barcode
 
 ```js
@@ -155,6 +225,36 @@ RAW and ESC/POS printing require a printer and Windows driver that accept the co
 
 TypeScript declarations are included.
 
+## Agent API
+
+- `GET /api/v1/health` (no token; health only)
+- `GET /api/v1/printers`
+- `GET /api/v1/jobs`
+- `GET /api/v1/jobs/{id}`
+- `GET /api/v1/templates`
+- `GET /api/v1/templates/{name}`
+- `POST /api/v1/templates`
+- `POST /api/v1/print/text`
+- `POST /api/v1/print/image`
+- `POST /api/v1/print/code`
+- `POST /api/v1/print/raw`
+- `POST /api/v1/print/escpos`
+- `POST /api/v1/print/pdf`
+- `POST /api/v1/print/pdf-url`
+- `POST /api/v1/print/html`
+- `POST /api/v1/print/template`
+- `POST /api/v1/print/designed-template`
+- WebSocket: `/ws?token=...`
+
+Authenticated REST requests require the `X-Dikshi-Token` header.
+
+## Important compatibility notes
+
+1. Generic printing works with printers exposed as valid Windows printer queues. Future printer models normally need only their Windows driver.
+2. RAW/ESC-POS requires the printer and driver to accept the command language being sent. There is no universal ESC/POS guarantee for every model.
+3. PDF `printto` relies on a Windows PDF application that implements the `printto` shell verb. For maximum unattended PDF reliability, a dedicated PDF rendering and printing engine should be embedded in a future signed enterprise build.
+4. An HTTPS website talking to a local agent can be affected by browser mixed-content and private-network policies. For strict enterprise or all-site deployment, use a trusted local TLS certificate or companion Chrome/Edge extension. This source keeps loopback HTTP intentionally simple and auditable.
+
 ## Troubleshooting
 
 - **Token is required:** Copy it from the Windows tray application and pass it to the constructor.

package/package.json

@@ -1,12 +1,75 @@
 {
   "name": "dikshiprintagent",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "JavaScript SDK for silent printing from web applications through the Dikshi Print Agent for Windows",
   "keywords": [
+    "dikshiprintagent",
+    "dikshi-print-agent",
+    "dikshi-technologies",
+    "print-agent",
+    "printer-agent",
     "printing",
     "silent-print",
+    "silent-printing",
+    "direct-printing",
+    "automatic-printing",
+    "background-printing",
+    "browser-printing",
+    "web-printing",
+    "web-to-printer",
+    "local-printing",
+    "windows-printing",
+    "windows-print-service",
     "escpos",
+    "esc-pos",
     "windows-printer",
+    "local-print-agent",
+    "thermal-printer",
+    "receipt-printer",
+    "pos-printer",
+    "receipt-printing",
+    "invoice-printing",
+    "bill-printing",
+    "label-printing",
+    "tag-printing",
+    "raw-printing",
+    "pos-printing",
+    "point-of-sale",
+    "pos",
+    "erp",
+    "billing-software",
+    "billing-system",
+    "retail-software",
+    "retail-pos",
+    "jewellery-billing",
+    "jewellery-software",
+    "jewellery-pos",
+    "pawn-broking",
+    "pawn-software",
+    "rfid",
+    "rfid-printing",
+    "barcode-printing",
+    "barcode-printer",
+    "qr-code-printing",
+    "pdf-printing",
+    "html-printing",
+    "image-printing",
+    "text-printing",
+    "webview2-printing",
+    "printer-sdk",
+    "print-api",
+    "javascript-sdk",
+    "typescript",
+    "javascript",
+    "browser-sdk",
+    "vite",
+    "react",
+    "vue",
+    "angular",
+    "web-application",
+    "desktop-bridge",
+    "localhost-api",
+    "windows",
     "dikshi"
   ],
   "license": "MIT",