Skip to content

Node.js / contracts

Contract PDFs in Node.js

Post your contract HTML to a render API from a route handler that returns the response body directly, then pipe the response body straight to res, so the PDF never lands in a Buffer. No browser binary in your Node.js deployment.

Why contracts become PDFs

A contract has to be fixed at signature. Both parties need to be certain they are looking at identical words, which a rendered page cannot guarantee. That is the difference between a document and a view of a database, and it is why legal and sales operations keep asking for this.

What a contract has to carry

Before any of the code below matters, the template has to produce a document that is actually a contract. These are the fields that make it one, and the ones a reader or an auditor will look for first.

  • the parties, by legal entity name and registered number
  • the effective date and the term
  • numbered clauses with stable numbering, since amendments reference them
  • the commercial schedule, usually as an annexe rather than in the body
  • signature blocks with name, title and date for each party

The Node.js implementation

fetch ships with the runtime, so this adds no dependency. The render happens in a route handler that returns the response body directly, and you pipe the response body straight to res, so the PDF never lands in a Buffer.

javascript

app.get("/contract/:id.pdf", async (req, res) => {
  const html = await renderContract(req.params.id);

  const upstream = await fetch("https://api.pdfpipe.xyz/v1/pdf", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.PDFPIPE_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      html,
      options: { format: "A4", printBackground: true },
    }),
  });

  if (!upstream.ok) throw new Error(`render failed: ${upstream.status}`);

  res.setHeader("Content-Type", "application/pdf");
  // Streamed, not buffered: a long contract never sits in memory.
  upstream.body.pipe(res);
});

The CSS that makes a contract page correctly

The layout problem specific to this document is that numbered clauses with cross-references, where a page break in the wrong place separates a clause from the term it defines. These rules handle it.

css

/* A clause must not be separated from the term it defines, and a
   signature block alone on a final page invites a dispute. */
.clause     { break-inside: avoid; }
.signatures { break-inside: avoid; break-before: avoid; }

p { orphans: 3; widows: 3; }

@page { size: A4; margin: 25mm 20mm; }

What goes wrong in Node.js

Node buffers the whole response if you call res.send(await res.arrayBuffer()). On a 40-page report that is tens of megabytes held per concurrent request, and it is the usual reason a PDF endpoint takes down an otherwise healthy service under load.

What people try first

Most Node.js projects reach for puppeteer, which pulls a 300 MB Chromium download into your image and needs its own memory headroom on every instance. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.

Where the contract lives afterwards

Rendering is the short part. A contract is retained for the term plus the limitation period, which typically means well over a decade. Immutability matters more here than anywhere else on this list: both parties must be able to prove the words have not moved.

Getting the document right

  • Check the parties and the effective date, which is what every later dispute turns on.
  • Generation is triggered by agreement being reached, often with a signature workflow following, so size the timeout for that path rather than for a health check.
  • These are produced one at a time by a person who is waiting, so latency is felt directly.
  • Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.

Frequently asked

Do I need Chromium installed to generate contracts from Node.js?

No. The render happens over HTTP, so your Node.js deployment stays the size it is now. That is the main reason to use an API rather than puppeteer, which pulls a 300 MB Chromium download into your image and needs its own memory headroom on every instance.

How do I stop a long contract using all the memory?

Pipe the response body straight to res, so the PDF never lands in a Buffer. Node buffers the whole response if you call res.send(await res.arrayBuffer()). On a 40-page report that is tens of megabytes held per concurrent request, and it is the usual reason a PDF endpoint takes down an otherwise healthy service under load.

What has to be on a contract?

At minimum: the parties, by legal entity name and registered number; the effective date and the term; numbered clauses with stable numbering, since amendments reference them. The one to get right before anything else is the parties and the effective date, which is what every later dispute turns on.

Do I need to store the generated contracts?

Depends on the document, and this one has a clear answer: a contract is retained for the term plus the limitation period, which typically means well over a decade. Immutability matters more here than anywhere else on this list: both parties must be able to prove the words have not moved.

Can I keep my existing contract template?

Yes, if it produces HTML. Whatever renders your contract view today can render the same markup for the PDF, which is why the CSS above is the only new thing you write.

Related

Other Node.js documents, and the same contract in other stacks.

Packing slip PDFs in Node.jsa packing slip is printed and physically placed in a box. It exists to be paper.Ticket PDFs in Node.jsa ticket has to work at a gate with no signalInvoice PDFs in Node.jsan invoice is a legal record of a demand for paymentReceipt PDFs in Node.jsa receipt is proof a payment happenedReport PDFs in Node.jsa report is a snapshot of numbers at a moment in time. Its whole value is that it does not change when the underlying dashboard does.Contract PDFs in PythonUsing httpx, in an async endpoint that returns a streaming response.Contract PDFs in PHPUsing cURL, in a controller action that echoes the body with a PDF Content-Type.Contract PDFs in RubyUsing Net::HTTP, in a controller action using send_data.Contract PDFs in JavaUsing java.net.http.HttpClient, in a controller returning StreamingResponseBody.Contract PDFs in DjangoUsing httpx, in a view that returns FileResponse.When the output is wrongBlank pages, missing backgrounds, breaks in the wrong place, by symptom.All stacks and documentsThe full grid of what this covers.the full Node.js guideSetup, error handling and the deployment shape, not just the request.contract generation in productionVolume, storage and the delivery step, for teams already shipping these.how this compares to puppeteerThe tradeoff written out, including where the incumbent is the better call.running this in productionConcurrency, timeouts, retries and the failure modes worth planning for.

100 free documents a month, no card.