pdf-reports

Node library to generate PDF reports from HTML.

Installation

yarn add @journeyapps/pdf-reports

Usage

Basic Usage

``js
const pdf = require("@journeyapps/pdf-reports");
const fs = require("fs");
pdf.setApiToken(process.env.JOURNEY_PDF_KEY);

async function test() {
const result = await pdf.generatePdf({ html: "

Test Pdf

" });
const buffer = await result.toBuffer();
fs.writeFileSync("out.pdf", buffer);
}
test().catch(console.error);
`

Upload to S3

`js
const pdf = require("@journeyapps/pdf-reports");
const fs = require("fs");
pdf.setApiToken(process.env.JOURNEY_PDF_KEY);

const BASE_UPLOAD_CONFIG = {
bucket: process.env.JOURNEY_PDF_BUCKET,
prefix: 'test-reports/',
credentials: {
accessKeyId: process.env.AWS_ACCESS_KEY_ID,
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
region: 'us-east-1'
}
};

async function test() {
// This function uploads the PDF directly to S3 from the service,
// no intermediate download is required.
const result = await pdf.generateAndUploadPdf(
{ html: "

Test PDF

" },
{ name: 'test1.pdf', ...BASE_UPLOAD_CONFIG }
);
// URL is valid for 7 days by default
const url = result.getSignedUrl();
console.log('url', url);
}
test().catch(console.error);
`

Other Options

`js
// Generate from an online URL
await pdf.generatePdf({ url: "https://en.wikipedia.org/wiki/Portable_Document_Format" });

// Specify print options

await pdf.generatePdf({
html: "

Test PDF

",
print: {
// These are the defaults used by the service.
// Specify any of these to override the value.
landscape: false,
displayHeaderFooter: false,
printBackground: true,
scale: 1,
paperWidth: 8.27, // A4
paperHeight: 11.69, // A4
marginTop: 0,
marginBottom: 0,
marginLeft: 0,
marginRight: 0,
pageRanges: ''
}
});
`

Official documentation for the options are here:

https://chromedevtools.github.io/devtools-protocol/1-3/Page#method-printToPDF

$3

A template for a header and/or footer can be provided, to render on every page.
When specifying a class of pageNumber, date, title, url or totalPages, the contents
of the tag is automatically replaced with the computed content.

`js
await pdf.generatePdf({
html: "

Test PDF

",
print: {
// These are the defaults used by the service.
// Specify any of these to override the value.
landscape: false,
displayHeaderFooter: true,
headerTemplate:





,
footerTemplate: '',
printBackground: true,
scale: 1,
paperWidth: 8.27, // A4
paperHeight: 11.69, // A4
marginTop: 1,
marginBottom: 1,
marginLeft: 1,
marginRight: 1,
pageRanges: ''
}
});
`

There are some caveats and limitations to be aware of:
* displayHeaderFooter must be set to true for the templates to have an effect.
* The headers and footers are rendered behind the page contents. If the page has a solid white background,
the headers and footers won't be visible at all, unless a sufficient margin is added.
* Apart from the computed content, the same header and footer is rendered on every page. It is not possible
to script or customize the headers and footers per page.
* The rendering of the headers and footers happen in a completely separate context from the rest of the page.
It is not possible to use styles from the page in the headers and footers.
* Headers and footers do not support external resources, including stylesheets and images. Inline styles, and
images with inline base64 content, are supported.
* -webkit-print-color-adjust:exact; should be added to any styles that rely on background colors.

Using DocRaptor

By default, a Chrome rendering service is used. To use DocRaptor instead,
use the generatePdfDocRaptor function instead:

`js
const pdf = require("@journeyapps/pdf-reports");
const fs = require("fs");
pdf.setDocRaptorToken(process.env.DOCRAPTOR_TOKEN);

async function test() {
const result = await pdf.generatePdfDocRaptor({
html: "

Test Pdf

",
docraptor: {
// Any additional DocRaptor API options here
}
});
const buffer = await result.toBuffer();
fs.writeFileSync("out.pdf", buffer);

// The PDF may be uploaded to S3 afterwards:
const s3result = await pdf.uploadToS3(result, { name: 'test1.pdf', ...BASE_UPLOAD_CONFIG });
const url = s3result.getSignedUrl();
console.log('url', url);
}
test().catch(console.error);
`

Development

Setup

Clone this repo, then run:

yarn

Tests

To run the tests, the following environment variables are required:

JOURNEY_PDF_KEY # Key for the PDF service
JOURNEY_PDF_BUCKET # AWS bucket name to store test reports
# AWS Credentials
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY

As mentioned in the docs, for local development you can use the following token for JOURNEY_PDF_KEY: ohhu8Yahyu6ipee6aemeeg3quohghu2ijeph2xoZ`

Then run:

yarn test