@awadheshs109/billing 1.0.29 → 2.0.12

package/dist/index.d.ts

@@ -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 };