@awadheshs109/billing 1.0.29 → 2.0.12

package/README.md

@@ -1,227 +1,231 @@
 # Zentris Billing
 
-Framework-independent TypeScript billing and invoice generation library for Angular, React, Vue, Node.js and JavaScript applications.
+Modern TypeScript billing & invoice generation library for Angular, React, Vue, Node.js and JavaScript applications.
 
-Supports:
+Generate professional invoices in:
 
-✅ GST / Tax calculations  
-✅ Discount calculations  
-✅ Currency formatting  
-✅ Invoice generation  
-✅ PDF export  
-✅ CSV export  
-✅ JSON export  
-✅ HTML invoice templates  
-✅ Browser + Node support  
-✅ CI/CD npm publishing
+- HTML
+- PDF
+- CSV
+- JSON
 
----
-
-## Installation
-
-```bash
-npm install @awadheshs109/billing
-```
+Supports GST invoices, tax calculation, discounts, payment tracking, invoice templates and multi-framework integration.
 
 ---
 
-## Quick Start
-
-```ts
-import { Billing } from "@awadheshs109/billing";
+## Features
+
+- TypeScript-first architecture
+- Framework independent
+- GST & tax calculation utilities
+- Invoice summary calculations
+- Professional HTML invoice templates
+- PDF invoice generation using Puppeteer
+- CSV & JSON export support
+- Multi-payment transaction support
+- Currency formatting
+- Custom branding & themes
+- Lightweight API
+- ESM + CommonJS support
 
-const gst = Billing.calculateGST(1000, 18);
+---
 
-console.log(gst);
+## Installation
 
-//180
+```bash
+npm install @awadheshs109/billing
 ```
 
 ---
 
-# Invoice Example
+## Quick Example
 
 ```ts
-import { InvoiceGenerator } from "@awadheshs109/billing";
+import {
+  InvoiceGenerator
+} from "@awadheshs109/billing";
 
 const invoice = {
   invoiceNo: "INV-1001",
 
-  date: "21-05-2026",
+  date: "25-05-2026",
+
+  currency: "INR",
 
   company: {
     name: "Zentris Pvt Ltd",
-
-    address: "Mumbai",
-
-    phone: "+91 999999999",
+    address: "Mumbai, India",
+    phone: "+91 9999999999"
   },
 
   customer: {
-    name: "Awadhesh Sharma",
-
-    company: "Client Company",
-
-    address: "Bangalore",
+    name: "Rahul Verma",
+    email: "rahul@example.com"
   },
 
   items: [
     {
-      description: "Angular Development",
-
-      quantity: 5,
-
-      rate: 75,
-    },
-
-    {
-      description: "Invoice Setup",
-
+      description: "Angular Dashboard",
       quantity: 2,
-
-      rate: 100,
-    },
+      rate: 12000
+    }
   ],
 
   tax: 18,
-
-  discount: 5,
+  discount: 5
 };
+
+const html =
+  InvoiceGenerator.toHTML(invoice);
+
+console.log(html);
 ```
 
 ---
 
-# Generate HTML Invoice
+## Generate PDF
 
 ```ts
-const html = InvoiceGenerator.toHTML(invoice);
+import fs from "node:fs";
+
+const pdf =
+  await InvoiceGenerator.toPDF(invoice);
+
+fs.writeFileSync(
+  "invoice.pdf",
+  pdf
+);
 ```
 
 ---
 
-# Generate CSV
+## Generate GST Invoice Template
 
 ```ts
-const csv = InvoiceGenerator.toCSV(invoice);
+const html =
+  InvoiceGenerator.toHTML(
+    invoice,
+    {
+      template: "gst"
+    }
+  );
 ```
 
 ---
 
-# Generate JSON
+## Export Formats
+
+### HTML
 
 ```ts
-const json = InvoiceGenerator.toJSON(invoice);
+InvoiceGenerator.toHTML(invoice);
 ```
 
----
-
-# Generate PDF
+### PDF
 
 ```ts
-const pdf = InvoiceGenerator.toPDF(invoice);
+await InvoiceGenerator.toPDF(invoice);
 ```
 
----
-
-# Save PDF in Node
+### CSV
 
 ```ts
-import fs from "fs";
-
-const pdf = InvoiceGenerator.toPDF(invoice);
+InvoiceGenerator.toCSV(invoice);
+```
 
-const buffer = Buffer.from(await pdf.arrayBuffer());
+### JSON
 
-fs.writeFileSync("invoice.pdf", buffer);
+```ts
+InvoiceGenerator.toJSON(invoice);
 ```
 
 ---
 
-## Available APIs
+## Tax Utilities
 
-### Billing
-
-| Method                             | Description        |
-| ---------------------------------- | ------------------ |
-| calculateGST(amount,tax)           | Calculate GST      |
-| calculateDiscount(amount,discount) | Calculate discount |
-| formatCurrency(amount,currency)    | Currency formatter |
-
----
+```ts
+import {
+  Billing
+} from "@awadheshs109/billing";
 
-### InvoiceGenerator
+const gst =
+  Billing.calculateGST(
+    1000,
+    18
+  );
 
-| Method   | Description           |
-| -------- | --------------------- |
-| toHTML() | Generate invoice HTML |
-| toCSV()  | Export CSV            |
-| toJSON() | Export JSON           |
-| toPDF()  | Export PDF            |
+console.log(gst);
+```
 
 ---
 
-## Development
+## Currency Formatting
 
-Build:
-
-```bash
-npm run build
+```ts
+Billing.formatCurrency(
+  15000,
+  "INR"
+);
 ```
 
-Run tests:
-
-```bash
-npm run test:run
-```
+---
 
-Local invoice validation:
+## Supported Frameworks
 
-```bash
-npx tsx test-invoice.ts
-```
+- Angular
+- React
+- Vue
+- Next.js
+- Node.js
+- Express
+- NestJS
+- Vanilla JavaScript
 
 ---
 
-## Release Process
+## Invoice Templates
 
-Version update:
+### Classic Template
 
-```bash
-npm version patch --no-git-tag-version
-```
+Professional clean invoice layout.
 
-Commit:
+### GST Template
 
-```bash
-git add .
-git commit -m "development: add feature"
-```
+Indian GST-compliant invoice design.
 
-Tag:
+---
 
-```bash
-git tag v1.1.0
-git push
-git push --tags
+## Package Exports
+
+```ts
+import {
+  InvoiceGenerator,
+  Billing,
+  TAX_RATES,
+  VERSION
+} from "@awadheshs109/billing";
 ```
 
-GitHub Actions automatically:
+---
+
+## Version
 
-```txt
-build
-→ test
-→ publish npm
+```ts
+console.log(VERSION);
 ```
 
 ---
 
-## Changelog
-
-See:
+## Roadmap
 
-```txt
-CHANGELOG.md
-```
+- QR payment generation
+- Razorpay integration
+- UPI invoice QR
+- Multi-language invoice support
+- Thermal receipt template
+- Email invoice sender
+- React invoice viewer
+- Angular invoice component
 
 ---
 
@@ -233,8 +237,8 @@ MIT
 
 ## Repository
 
-:contentReference[oaicite:0]{index=0}
-
-Package:
+GitHub:
+https://github.com/Awadheshs109/zentris-billing
 
-:contentReference[oaicite:1]{index=1}
+npm:
+https://www.npmjs.com/package/@awadheshs109/billing

package/dist/index.d.mts

@@ -6,13 +6,23 @@ declare function calculateDiscount(amount: number, percent: number): number;
 type CurrencyType = 'INR' | 'USD' | 'EUR' | 'GBP';
 declare function formatCurrency(amount: number, currency?: CurrencyType): string;
 
+interface BillingSummary {
+    subtotal: number;
+    taxAmount: number;
+    discountAmount: number;
+    total: number;
+}
+
+interface InvoiceItem {
+    description: string;
+    quantity: number;
+    rate: number;
+    hsn?: string;
+    taxRate?: number;
+}
+
 declare class InvoiceCalculator {
-    static summary(items: any[], tax?: number, discount?: number): {
-        subtotal: any;
-        discount: number;
-        tax: number;
-        total: number;
-    };
+    static summary(items: InvoiceItem[], tax?: number, discount?: number): BillingSummary;
 }
 
 declare class Billing {
@@ -34,6 +44,20 @@ declare class InvoiceError extends Error {
     constructor(message: string);
 }
 
+declare const TAX_RATES: {
+    readonly GST_5: 5;
+    readonly GST_12: 12;
+    readonly GST_18: 18;
+    readonly GST_28: 28;
+};
+
+declare function formatDate(date?: Date, locale?: string): string;
+declare function getCurrentTimestamp(): number;
+
+declare function isValidEmail(email: string): boolean;
+declare function isValidPhone(phone: string): boolean;
+declare function isValidGST(gst: string): boolean;
+
 interface Customer {
     id?: string;
     name: string;
@@ -43,31 +67,95 @@ interface Customer {
     address?: string;
 }
 
-interface InvoiceItem {
-    description: string;
-    quantity: number;
-    rate: number;
+interface BankDetails {
+    bankName: string;
+    accountName: string;
+    accountNumber: string;
+    ifscCode?: string;
+    upiId?: string;
+}
+
+interface Branch {
+    id?: string;
+    name: string;
+    address?: string;
+    phone?: string;
+    gstNumber?: string;
+}
+
+interface Company {
+    name: string;
+    address: string;
+    phone: string;
+    email?: string;
+    gstNumber?: string;
+    panNumber?: string;
+    website?: string;
+    bankDetails?: BankDetails;
+    branches?: Branch[];
+}
+
+type PaymentMode = "cash" | "upi" | "bank" | "mixed";
+type PaymentStatus = "paid" | "partial" | "pending";
+interface PaymentTransaction {
+    mode: string;
+    amount: number;
+    reference?: string;
+}
+interface Payment {
+    mode: PaymentMode;
+    paidAmount: number;
+    dueAmount: number;
+    status: PaymentStatus;
+    udhar: boolean;
+    transactions?: PaymentTransaction[];
 }
 
+interface InvoiceTheme {
+    primaryColor?: string;
+    accentColor?: string;
+}
+interface InvoiceBranding {
+    showSoftwareCredit?: boolean;
+    softwareCreditText?: string;
+    logoText?: string;
+    logoSubText?: string;
+}
+interface InvoiceFeatures {
+    showSellerGST?: boolean;
+    showBuyerGST?: boolean;
+    showPAN?: boolean;
+    showTransport?: boolean;
+    showEWay?: boolean;
+    showBankDetails?: boolean;
+    showTerms?: boolean;
+    showSignature?: boolean;
+    showSoftwareCredit?: boolean;
+    showBranchDetails?: boolean;
+    showPaymentDetails?: boolean;
+    showPaymentTransactions?: boolean;
+    showAmountWords?: boolean;
+}
 interface Invoice {
     invoiceNo: string;
     date: string;
-    company: {
-        name: string;
-        address: string;
-        phone: string;
-        email?: string;
-    };
-    customer: {
-        name: string;
-        company?: string;
-        address: string;
-        email?: string;
-    };
+    dueDate?: string;
+    company: Company;
+    customer: Customer;
     items: InvoiceItem[];
-    discount?: number;
+    payment?: Payment;
+    features?: InvoiceFeatures;
+    branding?: InvoiceBranding;
+    theme?: InvoiceTheme;
     tax?: number;
+    discount?: number;
+    transport?: string;
+    eway?: string;
+    amountWords?: string;
     notes?: string;
+    signature?: string;
+    terms?: string[];
+    currency?: string;
 }
 
 interface Tax {
@@ -75,32 +163,26 @@ interface Tax {
     rate: number;
 }
 
-interface BillingSummary {
-    subtotal: number;
-    taxAmount: number;
-    discountAmount: number;
-    total: number;
+declare class InvoiceNormalizer {
+    static normalize(invoice: Partial<Invoice>): Invoice;
 }
 
-declare function formatDate(date?: Date, locale?: string): string;
-declare function getCurrentTimestamp(): number;
-
-declare function isValidEmail(email: string): boolean;
-declare function isValidPhone(phone: string): boolean;
-declare function isValidGST(gst: string): boolean;
-
-declare const TAX_RATES: {
-    readonly GST_5: 5;
-    readonly GST_12: 12;
-    readonly GST_18: 18;
-    readonly GST_28: 28;
-};
+type InvoiceTemplate = (invoice: Invoice, summary: BillingSummary) => string;
+declare class InvoiceRenderer {
+    static renderHTML(invoice: Invoice, summary: BillingSummary, template: InvoiceTemplate): string;
+}
 
 declare class InvoiceGenerator {
-    static toPDF(invoice: any): Blob;
-    static toCSV(invoice: any): string;
-    static toJSON(invoice: any): string;
-    static toHTML(invoice: any): string;
+    static toHTML(invoice: Partial<Invoice>, options?: {
+        template?: "classic" | "gst";
+    }): string;
+    static toCSV(invoice: Invoice): string;
+    static toJSON(invoice: Invoice): string;
+    static toPDF(invoice: Partial<Invoice>, options?: {
+        template?: "classic" | "gst";
+    }): Promise<Buffer>;
 }
 
-export { Billing, BillingError, type BillingSummary, type CurrencyType, type Customer, type Invoice, InvoiceCalculator, InvoiceError, InvoiceGenerator, type InvoiceItem, TAX_RATES, type Tax, ValidationError, calculateDiscount, calculateGST, calculateTax, formatCurrency, formatDate, getCurrentTimestamp, isValidEmail, isValidGST, isValidPhone };
+declare const VERSION = "2.0.1";
+
+export { type BankDetails, Billing, BillingError, type BillingSummary, type Branch, type Company, type CurrencyType, type Customer, type Invoice, type InvoiceBranding, InvoiceCalculator, InvoiceError, type InvoiceFeatures, InvoiceGenerator, type InvoiceItem, InvoiceNormalizer, InvoiceRenderer, type InvoiceTemplate, type InvoiceTheme, type Payment, type PaymentMode, type PaymentStatus, type PaymentTransaction, TAX_RATES, type Tax, VERSION, ValidationError, calculateDiscount, calculateGST, calculateTax, formatCurrency, formatDate, getCurrentTimestamp, isValidEmail, isValidGST, isValidPhone };