baptistejamin / node-microinvoice

Fast & elegant PDF invoice generator for Node using PDFKit. No Puppeteer

node-microinvoice

Fast & elegant PDF invoice generator for Node using PDFKit.

• What Microinvoice does?

• It builds invoices that looks good
• Generates a PDF in less than 30ms
• Custom Styling & Text
• Covers extended charsets like Russian, Polish (native PDF fonts only supports Latin)
• Transliterate to Latin when charset is not supported (Chinese, Arabic)

• How invoices looks like ?

Why another invoice generator

This project was made for our own company Crisp. We are generating everymonth thousands of HTML invoices. Given this scale, using Puppeteer for generating HTML to PDF would be very inefficient.

As everyday, our customers were asking for PDF invoices as some accounting softwares automatically fetch invoices from emails. I could really understand their frustration. At the end, why generating PDF should be easy?

Who uses it?

Crisp

👋 You use microinvoice and you want to be listed there? Contact me.

How to install?

Include microinvoice in your package.json dependencies.

Alternatively, you can run npm install microinvoice --save.

How to use?

Import the module in your code:

var MicroInvoice = require("microinvoice");

let myInvoice = new MicroInvoice({
  // Use example from examples/index.js
});
// Render invoice as PDF
myInvoice.generate("example.pdf").then(() => {
  console.log("Invoice saved");
});

node-microinvoice's Issues

Option to generate buffer

I would love to see an option to generate invoices in buffer output

Microinvoice

I propose to add a builder

It seems to me that the builder design pattern is most suitable for this library.

const brandInvoiceBuilder = new InvoiceBuilder()
   .useStyles(
       new StyleBulder()
           .withDocument({ marginLeft: 30, marginRight: 30, marginTop: 30 })
           .withFonts({ ... })
           .withHeader({ ... })
       // or use style objects as well
       // if you pass style builder, invoice builder will build your styles automatically
   );

// then in any business logic
brandInvoiceBuilder.generate(invoiceData, 'path/to/your/invoice.pdf');

If you don't use custom styles, it will generate an invoice with default styles. Also if you use StyleBuilder with no or partial use of its methods, it will create default styles or your styles that have been merged with the default styles

const defaultInvoiceBuilder = new InvoiceBuilder();
// or new InvoiceBuilder().useStyles(new StyleBuilder())
defaultInvoiceBuilder.generate(invoiceData, 'path/to/your/invoice.pdf');