Accrue.PDF behaviour (accrue v1.0.0)

Copy Markdown View Source

Behaviour + facade for PDF rendering.

You rarely call this module directly. The typical entry point is Accrue.Invoices.render_invoice_pdf/2, which renders an invoice to HTML and then calls Accrue.PDF.render/2 under the hood. You interact with this module mainly through two concerns:

  1. Adapter configuration — choose which backend renders PDFs.
  2. Test setup — swap in Accrue.PDF.Test so your test suite does not require a Chrome binary.

Adapters

  • Accrue.PDF.ChromicPDF — production default. Delegates to the host application's ChromicPDF instance. Accrue does NOT start ChromicPDF — the host app must add it to its own supervision tree.
  • Accrue.PDF.Test — Chrome-free test adapter. Sends {:pdf_rendered, html, opts} to self() and returns {:ok, "%PDF-TEST"}. Use in tests to avoid the Chrome binary dependency in CI.

Telemetry

[:accrue, :pdf, :render, :start | :stop | :exception] is emitted with metadata %{size, archival, adapter}. The HTML body is NEVER placed in metadata — it may contain PII.

Summary

Types

html()
opts()

Callbacks

render(html, opts)

Functions

render(html, opts \\ [])

Renders html to a PDF binary via the configured adapter.

Types

html()

@type html() :: binary()

opts()

@type opts() :: keyword()

Callbacks

render(html, opts)

@callback render(html(), opts()) :: {:ok, binary()} | {:error, term()}

Functions

render(html, opts \\ [])

@spec render(html(), opts()) :: {:ok, binary()} | {:error, term()}

Renders html to a PDF binary via the configured adapter.

Options

  • :size — paper size (atom or tuple, adapter-specific). Default :a4.
  • :archival — when true, produces PDF/A (long-term archival format). ChromicPDF uses print_to_pdfa/1 in this case.
  • :header_html, :footer_html — optional header/footer HTML. The ChromicPDF adapter translates these to the :header/:footer keys that ChromicPDF.Template.source_and_options/1 expects.