dikshiprintagent 1.0.1 → 1.0.2

package/README.md

@@ -1,98 +1,211 @@
-# Dikshi Print Agent V10
-
-Windows local print bridge for websites. Designed around Windows printer queues, so newly installed printers are discovered automatically when Windows has a working driver.
-
-Android/iOS remote printing through the optional secure relay is documented in [REMOTE-PRINTING.md](REMOTE-PRINTING.md).
-
-## 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 + job status/history
-- Text printing through Windows PrintDocument
-- Image printing (base64 PNG/JPG/BMP etc.)
-- RAW printing through Winspool (label languages / printer-native data)
-- ESC/POS uses the RAW path
-- PDF printing through Windows registered PDF `printto` handler
-- Direct PDF URL printing: agent downloads the PDF from an API URL and sends it to the selected printer
-- HTML printing through WebView2 with page size/orientation options
-- Invoice/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 print, and job history
-- Visual template designer at `/designer` with drag/drop fields and saved JSON layouts
-- Designer validation, version backups, locked layouts, resize handles, undo/redo, zoom, logo upload, and custom table columns
-- Dashboard/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 + test page
-- Single-file self-contained `win-x64` publish
-- Inno Setup script included
-
-## Build
-Install the Microsoft .NET 8 SDK on the Windows development PC, then run `build-exe.bat`.
-Output: `DikshiPrintAgent-V10.exe` in the project root.
-
-## First run
-Run the EXE. It creates:
-`%APPDATA%\DikshiPrintAgent\config.json`
-
-Right-click the tray icon -> **Copy API Token**.
-Edit `AllowedOrigins` in config.json to include your websites, then restart the agent.
-Example:
-```json
-"AllowedOrigins": [
-  "https://erp.example.com",
-  "https://billing.example.com",
-  "http://localhost:*"
-]
-```
-Do not set `AllowAllOrigins=true` on production PCs unless you fully understand the security risk.
-
-## 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 `X-Dikshi-Token`.
-
-### Print a PDF directly from an API URL
-Use this when your server API returns `application/pdf` as a downloadable file. The agent downloads the PDF locally, validates it, queues it, and prints 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'
-});
-```
-
-## 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/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/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/private-network policies. For strict enterprise/all-site deployment, use a trusted local TLS certificate or companion Chrome/Edge extension. This source keeps loopback HTTP intentionally simple and auditable.
+# dikshiprintagent
+
+Official JavaScript SDK for connecting a website, billing application, POS, ERP, or web portal to **Dikshi Print Agent** running on a Windows computer.
+
+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.
+
+> 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.
+
+## How it works
+
+```text
+Website / Billing App
+        |  dikshiprintagent npm SDK
+        v
+http://127.0.0.1:8181
+        v
+Dikshi Print Agent for Windows
+        v
+Installed Windows Printer
+```
+
+## Installation
+
+```bash
+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.
+
+## Before you start
+
+On the Windows billing computer:
+
+1. Install and run Dikshi Print Agent.
+2. Confirm that the required printer is installed in Windows.
+3. Right-click the agent tray icon and select **Copy API Token**.
+4. Add your website origin to `%APPDATA%\DikshiPrintAgent\config.json`.
+5. Restart the agent after changing its configuration.
+
+```json
+{
+  "port": 8181,
+  "allowAllOrigins": false,
+  "allowedOrigins": [
+    "http://localhost:5173",
+    "http://localhost:3000",
+    "https://your-website.example"
+  ]
+}
+```
+
+Never publish or hard-code a customer's API token in source control.
+
+## Quick start
+
+```js
+import DikshiPrintAgent from 'dikshiprintagent';
+
+const agent = new DikshiPrintAgent({
+  token: 'TOKEN_COPIED_FROM_THE_WINDOWS_TRAY_APP'
+});
+
+const health = await agent.health();
+console.log('Agent:', health);
+
+const result = await agent.printers();
+console.log('Printers:', result.printers);
+
+const job = await agent.printText(result.printers[0].name, 'Hello from Dikshi!');
+const completedJob = await agent.wait(job.jobId, 30000);
+console.log('Completed:', completedJob);
+```
+
+## Constructor
+
+```js
+const agent = new DikshiPrintAgent({
+  token: 'required-api-token',
+  host: '127.0.0.1', // optional
+  port: 8181,        // optional
+  protocol: 'http'  // optional: http or https
+});
+```
+
+## Common examples
+
+### Print text
+
+```js
+const job = await agent.printText('EPSON TM-T82', 'Thank you!', {
+  documentName: 'Receipt 1001',
+  fontName: 'Consolas',
+  fontSize: 10,
+  copies: 1
+});
+await agent.wait(job.jobId);
+```
+
+### Print HTML or PDF URL
+
+```js
+await agent.printHtml('Invoice Printer', '<h1>Invoice #1001</h1>', {
+  documentName: 'Invoice 1001'
+});
+
+const job = await agent.printPdfUrl('HP Laser Printer', invoiceUrl, {
+  documentName: 'Invoice 1001.pdf'
+});
+await agent.wait(job.jobId, 30000);
+```
+
+### QR code and barcode
+
+```js
+await agent.printQr('Label Printer', 'https://www.dikshitech.com/');
+await agent.printBarcode('Label Printer', 'ITEM-10001');
+```
+
+### ESC/POS receipt
+
+```js
+const receipt = DikshiPrintAgent.receiptBuilder({ width: 42 })
+  .center().bold().text('DIKSHI STORE\n').bold(false)
+  .line()
+  .row('Invoice', 'INV-1001')
+  .item('Product', 2, 100)
+  .line()
+  .row('Total', 'Rs. 200.00')
+  .cut()
+  .build();
+
+const job = await agent.printEscPos('Thermal Printer', receipt);
+await agent.wait(job.jobId);
+```
+
+RAW and ESC/POS printing require a printer and Windows driver that accept the commands being sent.
+
+## SDK methods
+
+| Method | Purpose |
+| --- | --- |
+| `health()` | Check whether the local agent is running |
+| `printers()` | Get installed Windows printers |
+| `jobs()` / `job(jobId)` | Read recent jobs or one job |
+| `wait(jobId, timeoutMs)` | Wait until a job completes or fails |
+| `printText()` / `printHtml()` | Print text or HTML |
+| `printImage()` | Print a base64 image |
+| `printPdf()` / `printPdfUrl()` | Print a base64 PDF or PDF URL |
+| `printQr()` / `printBarcode()` | Print QR and CODE128 codes |
+| `printRaw()` / `printEscPos()` | Send printer-native data |
+| `templates()` / `template(name)` | Read saved templates |
+| `saveTemplate()` | Save a print template |
+| `printTemplate()` | Print template data |
+| `printDesignedTemplate()` | Print a designer template |
+
+TypeScript declarations are included.
+
+## Troubleshooting
+
+- **Token is required:** Copy it from the Windows tray application and pass it to the constructor.
+- **Connection failed:** Open `http://127.0.0.1:8181/api/v1/health`. Start or restart the agent if it does not return JSON.
+- **HTTP 401:** The token is missing or incorrect. Copy the current token again.
+- **CORS/origin error:** Add the exact origin, such as `http://localhost:5173`, to `allowedOrigins` and restart the agent.
+- **HTTPS to local HTTP blocked:** Some browsers and enterprise policies require trusted local HTTPS or approved browser configuration.
+- **Printer missing:** Install its Windows driver, confirm it appears in Windows Printers & scanners, and reload the list.
+
+## Security
+
+- Keep `allowAllOrigins` disabled in production.
+- Allow only trusted application origins.
+- Never store a real agent token in a public repository.
+- Store the token locally per billing computer or user.
+- The default service listens on loopback address `127.0.0.1`.
+
+## About Dikshi Technologies
+
+**Dikshi Technologies** is a Chennai-based software and digital-solutions company with its office in Pallikaranai. With over 22 years of domain experience, the company develops practical ERP, billing, mobile, RFID, and automation solutions for retail and service businesses.
+
+### Products and services
+
+- Jewellery billing, POS, stock, order, customer, and ERP solutions
+- Jewellery RFID inventory, auditing, tracking, and loss-prevention solutions
+- **Pawn Pro** for pawn-broking and pledge-management operations
+- Wholesale, retail, supermarket, and hypermarket billing software
+- Textile, readymade, garment, and footwear ERP software
+- Restaurant, hotel, hardware, fancy-store, and industry-specific billing systems
+- Barcode, QR-code, tag, label, and thermal-printing integrations
+- Windows, web, Android, iOS, cloud, and multi-branch applications
+- Custom ERP, CRM, business automation, and software development
+- Website and mobile-application development
+- Social-media marketing, digital marketing, SEO, content, creative, and other digital services
+
+### Office and contact
+
+```text
+Dikshi Technologies
+No. 80 & 81, Devi Karumariamman Nagar
+Velachery Main Road, Near Oil Mill Bus Stop
+Pallikaranai, Chennai – 600100
+Tamil Nadu, India
+```
+
+- Website: [www.dikshitech.com](https://www.dikshitech.com/)
+- Email: [dikshitechnologies@gmail.com](mailto:dikshitechnologies@gmail.com)
+- Phone: [+91 98414 19981](tel:+919841419981)
+- Demo / WhatsApp: [+91 74488 80373](tel:+917448880373)
+- LinkedIn: [Dikshi Technologies](https://www.linkedin.com/company/dikshitech/)
+
+## License
+
+[MIT](LICENSE) © 2026 Dikshi Technologies.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dikshiprintagent",
-  "version": "1.0.1",
-  "description": "JavaScript SDK for the Dikshi Print Agent local Windows printing service",
+  "version": "1.0.2",
+  "description": "JavaScript SDK for silent printing from web applications through the Dikshi Print Agent for Windows",
   "keywords": [
     "printing",
     "silent-print",
@@ -10,6 +10,12 @@
     "dikshi"
   ],
   "license": "MIT",
+  "author": {
+    "name": "Dikshi Technologies",
+    "email": "dikshitechnologies@gmail.com",
+    "url": "https://www.dikshitech.com/"
+  },
+  "homepage": "https://www.dikshitech.com/",
   "type": "module",
   "main": "./npm/index.js",
   "module": "./npm/index.js",