@narrow-os/document-templates 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,558 @@
+type A4DocumentTemplateId = "classic" | "modern" | "minimal" | "corporate" | "bold" | "elegant" | "tech" | "vibrant" | "compact" | "mono";
+type ThermalDocumentTemplateId = "classic" | "compact" | "wide" | "dense" | "sparse" | "boxed" | "lined" | "split" | "monobold" | "elegant";
+interface A4DocumentTemplate {
+    id: A4DocumentTemplateId;
+    name: string;
+    description: string;
+    primary: string;
+    accent: string;
+    brand: string;
+    headerBg: string;
+    headerText: string;
+    totalsBg: string;
+    totalsBorder: string;
+    rowAltBg: string;
+    border: string;
+    borderFaint: string;
+    surface: string;
+    text: string;
+    textMuted: string;
+    fontFamily: string;
+    fontFamilyHeading: string;
+    fontSize: string;
+    borderRadius: string;
+    dividerStyle: "solid" | "dashed" | "dotted" | "double" | "none";
+    headerLayout: "stacked" | "split" | "banded" | "sidebar";
+    titleAlign: "left" | "right" | "center";
+}
+interface ThermalDocumentTemplate {
+    id: ThermalDocumentTemplateId;
+    name: string;
+    description: string;
+    fontFamily: string;
+    fontSize: string;
+    fontWeightBase: number;
+    dividerStyle: "solid" | "dashed" | "dotted" | "double" | "none";
+    headerLayout: "centered" | "left-aligned" | "boxed";
+    itemSpacing: "tight" | "normal" | "loose";
+    showBorders?: boolean;
+    totalsStyle?: "bordered" | "plain" | "accent";
+    inkColor?: string;
+    accentColor?: string;
+    backgroundColor?: string;
+}
+
+interface CompanyInfo {
+    id?: string;
+    companyName?: string;
+    taxId?: string;
+    address?: string;
+    Address?: string;
+    city?: string;
+    website?: string;
+    paymentTerms?: string;
+    note?: string;
+    bankAccount?: string;
+    bankAccount2?: string;
+    bankName?: string;
+    bankName2?: string;
+    logo?: string;
+    terminalLogo?: string;
+    province?: string;
+    postCode?: string;
+    phone?: string;
+    phone2?: string;
+    phone3?: string;
+    email?: string;
+    signature?: string;
+    showWatermark?: boolean;
+    showSignature?: boolean;
+    deliveryNoteNote?: string;
+    deliveryNoteTerms?: string;
+    purchaseOrderNote?: string;
+    purchaseOrderTerms?: string;
+    proFormaNote?: string;
+    proFormaTerms?: string;
+    creditNoteNote?: string;
+    creditNoteTerms?: string;
+    supplierListNote?: string;
+    supplierListTerms?: string;
+}
+interface ReceiptCompanyInfo {
+    name: string;
+    address: string;
+    phone: string;
+    email: string;
+    taxNumber?: string;
+    logo?: string;
+    terminalLogo?: string;
+    signature?: string;
+    showWatermark?: boolean;
+    showSignature?: boolean;
+    website?: string;
+}
+
+type DocumentTypeKey = "invoice" | "quotation" | "invoiceDocument" | "deliveryNote" | "thermal";
+interface DocumentTypeSettings {
+    showSignature: boolean;
+    showWatermark: boolean;
+    showBarcode: boolean;
+    showQRCode: boolean;
+    showPreparedBy: boolean;
+    showLastUpdatedBy: boolean;
+    showDescription: boolean;
+    showPaymentTerms: boolean;
+    showAdditionalNotes: boolean;
+    showTaxNumber: boolean;
+    showEmail: boolean;
+    showPhone: boolean;
+    showWebsite: boolean;
+    showBankDetails: boolean;
+}
+type DocumentSettingsMap = Partial<Record<DocumentTypeKey, DocumentTypeSettings>>;
+interface OrganizationDocumentSettings {
+    documentSettings?: DocumentSettingsMap;
+}
+
+interface InvoiceItemData {
+    id?: string;
+    description?: string | null;
+    quantity: string | number | any;
+    unitPrice: string | number | any;
+    amount: string | number | any;
+    taxRate?: string | number | any;
+    taxAmount?: string | number | any;
+    shopProductId?: string | null;
+    serviceId?: string | null;
+    itemDiscountType?: "AMOUNT" | "PERCENTAGE" | null;
+    itemDiscountAmount?: string | number | any;
+    details?: string | null;
+}
+interface InvoicePaymentData {
+    id?: string;
+    amount: string | number | any;
+    method?: string | null;
+    reference?: string | null;
+    notes?: string | null;
+    status?: string | null;
+    paidAt?: string | Date | null;
+    isDeleted?: boolean;
+    deletedBy?: string;
+    documents?: any[];
+    transactionId?: string | null;
+    createdBy?: string | null;
+    creator?: {
+        name: string;
+    };
+    bank?: {
+        id: string;
+        name: string;
+    };
+}
+interface ClientData {
+    id?: string;
+    name?: string | null;
+    company?: string | null;
+    fullName?: string | null;
+    address?: string | null;
+    phone?: string | null;
+    phone2?: string | null;
+    email?: string | null;
+    taxNumber?: string | null;
+    registrationNumber?: string | null;
+    city?: string | null;
+    town?: string | null;
+    village?: string | null;
+    province?: string | null;
+    postalCode?: string | null;
+    website?: string | null;
+}
+interface InvoiceDocumentData {
+    id?: string;
+    invoiceNumber?: string | null;
+    issueDate?: Date | string | null;
+    dueDate?: Date | string | null;
+    status?: string | null;
+    description?: string | null;
+    salutation?: string | null;
+    paymentTerms?: string | null;
+    notes?: string | null;
+    terms?: string | null;
+    amount?: number | string | any;
+    subtotal?: number | string | any;
+    totalAmount?: number | string | any;
+    taxAmount?: number | string | any;
+    taxRate?: number | string | any;
+    discountAmount?: number | string | any;
+    discountType?: string | null | any;
+    pdfUrl?: string | null;
+    depositRequired?: boolean | null;
+    depositType?: string | null | any;
+    depositAmount?: number | string | any;
+    depositRate?: number | string | any;
+    installmentPeriod?: string | null;
+    interestRate?: number | string | any;
+    interestAmount?: number | string | any;
+    items: InvoiceItemData[];
+    payments?: InvoicePaymentData[];
+    client: ClientData;
+    creator?: {
+        name?: string;
+        GeneralSetting?: Array<{
+            companyName?: string;
+            Address?: string;
+            city?: string;
+            logo?: string;
+            province?: string;
+            postCode?: string;
+            phone?: string;
+            phone2?: string;
+            phone3?: string;
+            website?: string;
+            bankAccount?: string;
+            bankAccount2?: string;
+            bankName?: string;
+            bankName2?: string;
+            email?: string;
+            taxId?: string;
+            taxRate?: string;
+            paymentInstructions?: string;
+        }> | any;
+    };
+    createdBy?: string;
+    lastUpdatedBy?: {
+        id: string;
+        name: string;
+    } | null;
+}
+type InvoiceProps = InvoiceDocumentData;
+interface CombinedServiceData {
+    description: string;
+    quantity: number;
+    unitPrice: number;
+    linePrice: number;
+    discountInput: string;
+    vat: number;
+    total: number;
+    individualServices: Array<{
+        description: string;
+        qty: number;
+        unitPrice: number;
+        linePrice: number;
+        discountInput: string;
+        vat: number;
+        total: number;
+        details?: string | null;
+    }>;
+    displayType: "combined-service";
+}
+interface InvoiceReportGeneratorOptions {
+    combineServices?: boolean;
+    hideItemPrices?: boolean;
+    templateId?: string;
+    docSettings?: DocumentTypeSettings;
+}
+
+interface QuotationItemData {
+    id?: string;
+    description?: string | null;
+    quantity: number | string | any;
+    unitPrice: number | string | any;
+    amount: number | string | any;
+    taxAmount?: number | string | any;
+    taxRate?: number | string | any;
+    details?: string | null;
+    serviceId?: string | null;
+    shopProductId?: string | null;
+}
+interface QuotationDocumentData {
+    id?: string;
+    quotationNumber?: string | null;
+    issueDate?: Date | string | null;
+    date?: Date | string | null;
+    createdAt?: Date | string | null;
+    dueDate?: Date | string | null;
+    validUntil?: Date | string | null;
+    status?: string | null;
+    salutation?: string | null;
+    description?: string | null;
+    notes?: string | null;
+    terms?: string | null;
+    amount?: number | string | any;
+    subtotal?: number | string | any;
+    totalAmount?: number | string | any;
+    taxAmount?: number | string | any;
+    taxRate?: number | string | any;
+    discountAmount?: number | string | any;
+    discountType?: string | null | any;
+    depositRequired?: boolean | null;
+    depositType?: string | null | any;
+    depositAmount?: number | string | any;
+    installmentPeriod?: number | string | any;
+    interestRate?: number | string | any;
+    interestAmount?: number | string | any;
+    items: QuotationItemData[];
+    client: ClientData;
+    creator?: {
+        id?: string;
+        name?: string;
+        GeneralSetting?: Array<{
+            logo?: string;
+            companyName?: string;
+            Address?: string;
+            city?: string;
+            taxId?: string;
+            province?: string;
+            postCode?: string;
+            email?: string;
+            phone?: string;
+            phone2?: string;
+            phone3?: string;
+            website?: string;
+            bankAccount?: string;
+            bankAccount2?: string;
+            bankName?: string;
+            bankName2?: string;
+        }> | any;
+    };
+    lastUpdatedBy?: {
+        id: string;
+        name: string;
+    } | null;
+}
+type QuotationWithRelations = QuotationDocumentData;
+interface QuotationReportGeneratorOptions {
+    combineServices?: boolean;
+    hideItemPrices?: boolean;
+    templateId?: string;
+    docSettings?: DocumentTypeSettings;
+}
+
+interface SaleItem {
+    id: string;
+    shopProductId?: string;
+    quantity: number;
+    price: number;
+    total: number;
+    product?: {
+        name: string;
+        sku?: string;
+    };
+    hadNegativeStock?: boolean;
+    awaitedQuantity?: number;
+}
+interface ReceiptData {
+    id: string;
+    saleNumber: string;
+    date: string;
+    customerName?: string;
+    customerPhone?: string;
+    customerEmail?: string;
+    items: SaleItem[];
+    subtotal: number;
+    discount: number;
+    discountPercent?: number;
+    tax: number;
+    taxPercent?: number;
+    total: number;
+    paymentMethod: string;
+    amountReceived?: number;
+    change?: number;
+    company: ReceiptCompanyInfo;
+    createdBy?: string;
+    status?: string;
+    stockAwaitItems?: Array<{
+        id: string;
+        shopProduct: {
+            name: string;
+            sku: string;
+        };
+        quantity: number;
+    }>;
+}
+type ReceiptSize = "A4" | "thermal";
+
+interface DeliveryNoteItemData {
+    id: string;
+    description: string;
+    quantity: number | string;
+    unitPrice?: number | string;
+    amount?: number | string;
+    details?: string | null;
+}
+interface DeliveryNoteDocumentData {
+    id: string;
+    deliveryNoteNumber: string;
+    date: Date | string;
+    referenceNumber?: string;
+    status?: string;
+    notes?: string;
+    terms?: string;
+    items: DeliveryNoteItemData[];
+    client: ClientData;
+    company?: CompanyInfo;
+    creator?: {
+        name?: string;
+    };
+}
+interface DeliveryNoteGeneratorOptions {
+    templateId?: string;
+    docSettings?: DocumentTypeSettings;
+}
+
+declare const A4_TEMPLATES: A4DocumentTemplate[];
+
+declare const THERMAL_TEMPLATES: ThermalDocumentTemplate[];
+
+declare const DEFAULT_A4_ID: A4DocumentTemplateId;
+declare const DEFAULT_THERMAL_ID: ThermalDocumentTemplateId;
+declare const A4_TEMPLATE_IDS: A4DocumentTemplateId[];
+declare const THERMAL_TEMPLATE_IDS: ThermalDocumentTemplateId[];
+declare function isA4TemplateId(value: unknown): value is A4DocumentTemplateId;
+declare function isThermalTemplateId(value: unknown): value is ThermalDocumentTemplateId;
+declare function getA4Template(id?: string | null): A4DocumentTemplate;
+declare function getThermalTemplate(id?: string | null): ThermalDocumentTemplate;
+declare function isClassicTemplate(id?: string | null): boolean;
+
+/**
+ * Shared contact/address block used by invoice, quotation and document
+ * HTML/PDF generators. Renders the same fields, in the same order, with
+ * the same conditional rendering so all document types look consistent.
+ */
+interface RenderContactBoxInput {
+    /** Label shown above the box ("BILL TO", "FOR", "SUPPLIER", ...). */
+    label: string;
+    /** Primary name (company fullName preferred, fall back to display name). */
+    name: string;
+    /** Optional full legal name shown on its own line if different from `name`. */
+    fullName?: string | null;
+    /** VAT/Tax registration number. */
+    taxNumber?: string | null;
+    /** Company registration number. */
+    registrationNumber?: string | null;
+    /** Street address line. */
+    address?: string | null;
+    /** City/Town (may include village depending on caller). */
+    city?: string | null;
+    /** Postal/ZIP code. */
+    postalCode?: string | null;
+    /** Province/State. */
+    province?: string | null;
+    /** Primary phone. */
+    phone?: string | null;
+    /** Secondary phone. */
+    phone2?: string | null;
+    /** Email. */
+    email?: string | null;
+    /** Website URL. */
+    website?: string | null;
+}
+/**
+ * Returns the HTML for the shared contact block.
+ */
+declare function renderContactBox(input: RenderContactBoxInput): string;
+
+interface SectionContext {
+    logo: string;
+    cName: string;
+    cAddress: string;
+    cCity: string;
+    cCode: string;
+    cProv: string;
+    cVat: string;
+    cReg: string;
+    cPhone: string;
+    cPhone2: string;
+    cEmail: string;
+    cWeb: string;
+    cContact: string;
+    template: A4DocumentTemplate;
+    templateId: string;
+    docTitle: string;
+    docNumber: string;
+    barcodeDataUrl: string | null;
+    qrDataUrl: string | null;
+    settings: {
+        showBarcode: boolean;
+        showQRCode: boolean;
+        showWatermark: boolean;
+        showPhone: boolean;
+        showEmail: boolean;
+        showWebsite: boolean;
+        showTaxNumber: boolean;
+        showDescription?: boolean;
+    };
+}
+declare function renderHeaderSection(ctx: SectionContext): string;
+declare function renderClassicHeader(ctx: SectionContext): string;
+
+declare class InvoiceReportGenerator {
+    private static decimalToNumber;
+    private static formatMoney;
+    static generateInvoiceReportHTML(invoice: InvoiceDocumentData, companyInfo?: CompanyInfo | null, combineServices?: boolean, templateId?: string, docSettings?: DocumentTypeSettings): Promise<string>;
+}
+declare function generateInvoiceHTML(invoice: InvoiceDocumentData, options?: InvoiceReportGeneratorOptions & {
+    companyInfo?: CompanyInfo | null;
+}): Promise<string>;
+
+declare class QuotationReportGenerator {
+    private static decimalToNumber;
+    private static formatMoney;
+    static generateQuotationReportHTML(quotation: QuotationDocumentData, companyInfo?: CompanyInfo | null, optionsOrCombineServices?: boolean | QuotationReportGeneratorOptions, legacyTemplateId?: string, docSettings?: DocumentTypeSettings): Promise<string>;
+}
+declare function generateQuotationHTML(quotation: QuotationDocumentData, options?: QuotationReportGeneratorOptions & {
+    companyInfo?: CompanyInfo | null;
+}): Promise<string>;
+
+declare class ReceiptGenerator {
+    private companyInfo;
+    private readonly DEFAULT_TAX_RATE;
+    constructor(companyInfo?: ReceiptCompanyInfo | null);
+    setCompanyInfo(companyInfo: CompanyInfo | ReceiptCompanyInfo | null): void;
+    setTerminalLogo(logoUrl: string | undefined): void;
+    private formatNumber;
+    private formatDate;
+    private getItemName;
+    private getItemSKU;
+    generateReceiptHTML(saleData: any, size?: ReceiptSize, forPrint?: boolean): Promise<string>;
+    private generateA4ReceiptHTML;
+    private generateThermalReceiptHTML;
+}
+declare const receiptGenerator: ReceiptGenerator;
+
+declare class DeliveryNoteGenerator {
+    static generateDeliveryNoteHTML(deliveryNote: DeliveryNoteDocumentData, companyInfo?: CompanyInfo | null, templateId?: string, docSettings?: DocumentTypeSettings): Promise<string>;
+}
+declare function generateDeliveryNoteHTML(deliveryNote: DeliveryNoteDocumentData, options?: DeliveryNoteGeneratorOptions & {
+    companyInfo?: CompanyInfo | null;
+}): Promise<string>;
+
+declare function escapeHtml(value: unknown): string;
+declare function hasVisibleText(str: string | null | undefined): boolean;
+declare function getClientDisplayName(client: ClientData | null | undefined): string;
+declare function formatCurrency(amount: number | string | null | undefined, currency?: string): string;
+declare function formatDate(date: Date | string | null | undefined): string;
+declare function formatCompanyAddress(companyInfo: CompanyInfo | null | undefined): string;
+
+/**
+ * Universal Code 128 vector SVG generator (zero canvas/DOM dependencies).
+ * Works reliably in Node.js, Next.js server components, browser, and serverless.
+ */
+declare function generateCode128Svg(text: string, height?: number): string;
+/**
+ * Generates a Code 128 barcode as an SVG Data URI.
+ */
+declare function generateBarcode(value: string): Promise<string>;
+/**
+ * Universal QR code generator producing an SVG Data URI.
+ * Works without canvas or DOM in both Node.js and browser environments.
+ */
+declare function generateQRCode(value: string): Promise<string>;
+
+declare const DEFAULT_TAX_RATE = 0.15;
+declare const DEFAULT_DOCUMENT_TYPE_SETTINGS: DocumentTypeSettings;
+declare function getDocumentTypeSettings(settings: Record<string, any> | undefined | null, docType: DocumentTypeKey): DocumentTypeSettings;
+declare const DEFAULT_COMPANY_INFO: CompanyInfo;
+declare const DEFAULT_RECEIPT_COMPANY_INFO: ReceiptCompanyInfo;
+
+export { type A4DocumentTemplate, type A4DocumentTemplateId, A4_TEMPLATES, A4_TEMPLATE_IDS, type ClientData, type CombinedServiceData, type CompanyInfo, DEFAULT_A4_ID, DEFAULT_COMPANY_INFO, DEFAULT_DOCUMENT_TYPE_SETTINGS, DEFAULT_RECEIPT_COMPANY_INFO, DEFAULT_TAX_RATE, DEFAULT_THERMAL_ID, type DeliveryNoteDocumentData, DeliveryNoteGenerator, type DeliveryNoteGeneratorOptions, type DeliveryNoteItemData, type DocumentSettingsMap, type DocumentTypeKey, type DocumentTypeSettings, type InvoiceDocumentData, type InvoiceItemData, type InvoicePaymentData, type InvoiceProps, InvoiceReportGenerator, type InvoiceReportGeneratorOptions, type OrganizationDocumentSettings, type QuotationDocumentData, type QuotationItemData, QuotationReportGenerator, type QuotationReportGeneratorOptions, type QuotationWithRelations, type ReceiptCompanyInfo, type ReceiptData, ReceiptGenerator, type ReceiptSize, type RenderContactBoxInput, type SaleItem, type SectionContext, THERMAL_TEMPLATES, THERMAL_TEMPLATE_IDS, type ThermalDocumentTemplate, type ThermalDocumentTemplateId, escapeHtml, formatCompanyAddress, formatCurrency, formatDate, generateBarcode, generateCode128Svg, generateDeliveryNoteHTML, generateInvoiceHTML, generateQRCode, generateQuotationHTML, getA4Template, getClientDisplayName, getDocumentTypeSettings, getThermalTemplate, hasVisibleText, isA4TemplateId, isClassicTemplate, isThermalTemplateId, receiptGenerator, renderClassicHeader, renderContactBox, renderHeaderSection };