@narrow-os/document-templates 1.0.0 → 1.1.0

package/README.md

@@ -1,10 +1,13 @@
-# @bizflow/document-templates
+# @narrow-os/document-templates
+
+[![npm version](https://img.shields.io/npm/v/@narrow-os/document-templates.svg)](https://www.npmjs.com/package/@narrow-os/document-templates)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 Universal, framework-agnostic document templates and HTML/PDF generators for **Invoices**, **Quotations**, **Retail POS Receipts**, and **Delivery Notes**.
 
 Designed to run seamlessly across:
 
-- **Node.js / NestJS** (for automated background emails, cron jobs, and Puppeteer PDF generation)
+- **Node.js / NestJS** (automated background emails, queues, and Puppeteer PDF generation)
 - **Next.js Server & Client** (App Router, Pages, SSR, API routes)
 - **Browsers & POS Terminals** (Direct printing, thermal receipt printing, live canvas-free preview)
 
@@ -14,26 +17,25 @@ Designed to run seamlessly across:
 
 - 🎨 **10 Distinct A4 Design Presets**: `classic`, `modern`, `minimal`, `corporate`, `bold`, `elegant`, `tech`, `vibrant`, `compact`, and `mono`.
 - 🧾 **10 Thermal Receipt Presets**: `classic`, `compact`, `wide`, `dense`, `sparse`, `boxed`, `lined`, `split`, `monobold`, and `elegant` (for 80mm & 58mm thermal receipt printers).
-- 🇿🇦 **South African 15% VAT & Multi-Currency Ready**: Built-in compliant tax calculation, deposit breakdowns, installment terms, and banking payment instructions.
-- ⚡ **Zero DOM Canvas Crashes**: Built-in vector SVG Code 128 barcode and QR code generators that run headlessly in pure Node.js without requiring `<canvas>` or native DOM bindings.
+- 🇿🇦 **South African 15% VAT & Multi-Currency Ready**: Built-in compliant tax calculations, deposit breakdowns, installment terms, and banking payment instructions.
+- ⚡ **Zero DOM Canvas Crashes**: Pure vector SVG Code 128 barcode and QR code generators that run headlessly in pure Node.js without requiring `<canvas>` or native DOM bindings.
 - 📦 **Framework Agnostic**: Pure TypeScript returning clean HTML strings ready for `puppeteer.page.setContent(html)` or `window.open().document.write(html)`.
+- 🚀 **Dual ESM & CJS**: Full TypeScript type declarations included out-of-the-box.
 
 ---
 
 ## Installation
 
-### Local Installation in Monorepo / Relative Path
-
 ```bash
-npm install ../packages/document-templates
-# or from root
-npm install ./packages/document-templates
+npm install @narrow-os/document-templates
 ```
 
-### When Published to npm
+Or with yarn / pnpm / bun:
 
 ```bash
-npm install @bizflow/document-templates
+yarn add @narrow-os/document-templates
+pnpm add @narrow-os/document-templates
+bun add @narrow-os/document-templates
 ```
 
 ---
@@ -46,7 +48,7 @@ npm install @bizflow/document-templates
 import {
   InvoiceReportGenerator,
   generateInvoiceHTML,
-} from "@bizflow/document-templates";
+} from "@narrow-os/document-templates";
 
 const invoiceHtml = await generateInvoiceHTML(
   {
@@ -102,7 +104,7 @@ const invoiceHtml = await generateInvoiceHTML(
 ### 2. Generating Quotations
 
 ```typescript
-import { generateQuotationHTML } from "@bizflow/document-templates";
+import { generateQuotationHTML } from "@narrow-os/document-templates";
 
 const quoteHtml = await generateQuotationHTML(quotationData, {
   templateId: "corporate",
@@ -110,12 +112,12 @@ const quoteHtml = await generateQuotationHTML(quotationData, {
 });
 ```
 
-### 3. Printing POS Receipts (A4 & Thermal 80mm)
+### 3. Printing POS Receipts (A4 & Thermal 80mm / 58mm)
 
 ```typescript
-import { receiptGenerator } from "@bizflow/document-templates";
+import { receiptGenerator } from "@narrow-os/document-templates";
 
-// Thermal 80mm
+// Thermal 80mm (ESC/POS style web print)
 const thermalHtml = await receiptGenerator.generateReceiptHTML(
   saleData,
   "thermal",
@@ -130,42 +132,68 @@ const a4ReceiptHtml = await receiptGenerator.generateReceiptHTML(
 );
 ```
 
-### 4. Headless PDF Generation in Node.js / NestJS
+### 4. Headless PDF Generation in Node.js / NestJS (Puppeteer)
 
 ```typescript
 import puppeteer from "puppeteer";
-import { generateInvoiceHTML } from "@bizflow/document-templates";
+import { generateInvoiceHTML } from "@narrow-os/document-templates";
 
 const html = await generateInvoiceHTML(invoice, { companyInfo });
 
-const browser = await puppeteer.launch({ args: ["--no-sandbox"] });
+const browser = await puppeteer.launch({
+  headless: true,
+  args: ["--no-sandbox", "--disable-setuid-sandbox"],
+});
+
 const page = await browser.newPage();
 await page.setContent(html, { waitUntil: "load" });
+
 const pdfBuffer = await page.pdf({
   format: "A4",
   printBackground: true,
-  margin: { top: "0.5in", right: "0.5in", bottom: "0.5in", left: "0.5in" },
+  margin: {
+    top: "0.5in",
+    right: "0.5in",
+    bottom: "0.5in",
+    left: "0.5in",
+  },
 });
+
 await browser.close();
 
-// pdfBuffer is ready to attach to Resend, SendGrid, or nodemailer!
+// pdfBuffer is ready to attach to emails via Resend, SendGrid, or nodemailer!
 ```
 
 ---
 
-## Publishing to npm
+## Available A4 Design Templates
+
+| Template ID | Style | Best For |
+|---|---|---|
+| `classic` | Traditional corporate border with dual header | Formal invoices, government, tenders |
+| `modern` | Clean slate accents with rounded cards | SaaS, modern tech, startups |
+| `minimal` | Ultra-clean layout with delicate lines | Creative agencies, design studios |
+| `corporate` | Navy blue accent with structured tables | Enterprise, legal, financial firms |
+| `bold` | High-contrast black headers and thick borders | Construction, industrial, trades |
+| `elegant` | Serif typography with subtle borders | Law firms, consulting, luxury services |
+| `tech` | Emerald green badges and monospace elements | Software development, hardware, hosting |
+| `vibrant` | Violet gradients and modern card styling | Marketing agencies, event organizers |
+| `compact` | Dense line items and narrow margins | Long item lists, inventory invoices |
+| `mono` | Pure grayscale typography | Black-and-white laser printers |
+
+---
 
-To publish this package to npm:
+## Publishing Updates to npm
 
-1. Build the distribution bundle:
+1. Bump the version in `package.json`:
    ```bash
-   npm run build
+   npm version patch
    ```
-2. Login to npm:
+2. Build the bundle:
    ```bash
-   npm login
+   npm run build
    ```
-3. Publish:
+3. Publish to npm:
    ```bash
    npm publish --access public
    ```
@@ -174,4 +202,4 @@ To publish this package to npm:
 
 ## License
 
-MIT © Rethynk Web Studio
+MIT © Narrow OS

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrow-os/document-templates",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Universal document templates and HTML/PDF generators for invoices, quotations, receipts, and delivery notes",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",