Oro Html PDF

Overview
Installation
Example
Template advises
Methods

Overview

Oro Html PDF Generates PDFs through headless Chromium using Handlebars & HTML template.

Installation

npm install oro-html-pdf

Example:

First declare template, data and options:

// cjs
const { OHtmlPdf } = require( 'oro-html-pdf' );

// mjs, ts
import { OHtmlPdf } from 'oro-html-pdf';

//

const data = { 
  name: 'Oropesa', 
  project: 'Test', 
  logo: 'file://C://absolute/dir/to/img/logo.png' 
}

const template = {
  html: `<style>/* ... */</style> \ 
    <body><div>Hi, {{name}}<br><img alt="{{project}}" src="{{{logo}}}" /></div></body`,
  header: `<style>/* ... */</style> \ 
    <div id="header">Header {{project}}</div>`,
  footer: `<style>/* ... */</style> \ 
    <div id="footer">Footer {{project}}</div>`
};

const options = {
  output: 'file.pdf',
  pdf: {
    format: 'A4',
    margin: { top: '50px', bottom: '50px', left: '20px', right: '20px' }
  }
}

To generate only 1 pdf:

const responsePdf = await OHtmlPdf.generatePdfOnce( { template, data, options } );
// -> { 
//   status: true, 
//   filename: 'file.pdf', 
//   filepath: '/absolute/dir/file.pdf', 
//   buffer: <ArrayBuffer> 
// }

To generate several pdfs:

const oHtmlPdf = new OHtmlPdf();

const poolOpen = await oHtmlPdf.poolOpen( options );
if( ! poolOpen.status ) { return poolOpen; }

const responsePdf = await oHtmlPdf.generatePdf( { template, data, options } );
// const responsePdf2 = await oHtmlPdf.generatePdf( { template, data2, options } );
// const responsePdf3 = await oHtmlPdf.generatePdf( { template, data3, options } );
// ...

await oHtmlPdf.poolClose( options );
// Note: don't forget to close it!

Template advises

HEADER / FOOTER.

To use template.header, template.footer, define the style <style>...</style> of each one inside the template.
For example:

const template = {
  html: '<style><!-- Affected only in content --></style><body>...</body>',
  header: '<style><!-- Affected only in header --></style><div id="header">...</div>',
  footer: '<style><!-- Affected only in footer --></style><div id="footer">...</div>'
}

IMAGES.

To use images in template-data, all of image-data are casted to base64.

So to fix HandleBars escape issues, use triple brace {{{image}}} in template.

⚠️ wrong:
<img src={{image}} />,
✔️ use the triple brace instead:
<img src={{{image}}} />

const data = {
  image: 'file://C://absolute/dir/to/img/image.jpg',
  //...
}

// Correct
const template = {
  html: '<style>...</style><body><div> <img alt="img" src="{{{image}}}" /> </div></body>',
}

// Incorrect
const template = {
  html: '<style>...</style><body><div> <img alt="img" src="{{image}}" /> </div></body>',
}

Methods

await poolOpen
await poolClose
await generatePdf
static await generatePdfOnce
Helper functions
- await castData
- processTemplate

await poolOpen()

await poolOpen(args: OHtmlPdfPoolOpenOptions = {}) => Promise<OHtmlPdfPoolOpenResponse>

interface OHtmlPdfPoolOpenOptions {
  oTimer?: OTimer;
  oTimerOpen?: string;
  launch?: PuppeteerLaunchOptions;
}

type OHtmlPdfPoolOpenResponse =
  | SResponseOKBasic
  | SResponseKOObjectSimple<OHtmlPdfPoolOpenError>;

interface SResponseOKBasic {
  status: true,
}

interface SResponseKOObjectSimple {
  status: false,
  error: {
    type: 'PoolOpen';
    msg: string,
    launch: PuppeteerLaunchOptions;
    puppeteerError: Error;
  }
}

interface OHtmlPdfPoolOpenError {
  type: 'PoolOpen';
  launch: PuppeteerLaunchOptions;
  puppeteerError: Error;
}

const oHtmlPdf = new OHtmlPdf();

const response = await oHtmlPdf.poolOpen();
// -> { status: true }

await poolClose()

await poolClose(args: OHtmlPdfPoolCloseOptions = {}) => Promise<SResponseOKBasic>

interface OHtmlPdfPoolCloseOptions {
  oTimer?: OTimer;
  oTimerClose?: string;
}

interface SResponseOKBasic {
  status: true,
}

const oHtmlPdf = new OHtmlPdf();

const response = await oHtmlPdf.poolClose();
// -> { status: true }

await generatePdf()

await generatePdf<T extends Record<string, any> = {}>(
  args: OHtmlPdfGeneratePdfInput<T> 
) => Promise<OHtmlPdfGeneratePdfResponse>

interface OHtmlPdfGeneratePdfInput<T extends Record<string, any> = {}> {
  template?: OHtmlPdfGeneratePdfTemplate;
  data?: T;
  options?: OHtmlPdfGeneratePdfOptions;
}

interface OHtmlPdfGeneratePdfTemplate {
  html?: string;
  header?: string;
  footer?: string;
  url?: string;
}

interface OHtmlPdfGeneratePdfOptions {
  oTimer?: OTimer;
  oTimerExec?: string;
  output?: string;
  handlebars?: HandlebarsOptions;
  hbars?: HandlebarsOptions;
  castData?: boolean;
  buffer?: boolean;
  page?: GoToOptions; // puppeteer
  pdf?: PDFOptions;   // puppeteer
}

//

type OHtmlPdfGeneratePdfResponse =
  | SResponseOKObject<OHtmlPdfGeneratePdfObject>
  | SResponseKOObjectSimple<ProcessTemplateError>
  | SResponseKOObjectSimple<OHtmlPdfGeneratePdfErrorDown>
  | SResponseKOObjectSimple<OHtmlPdfGeneratePdfErrorPage>;

interface SResponseOKObject {
  msg: string;
  filename?: string;
  filepath?: string;
  buffer?: Buffer;
}

interface OHtmlPdfGeneratePdfObject {
  filename?: string;
  filepath?: string;
  buffer?: Buffer;
}

interface SResponseKOObjectSimple {
  status: false,
  error:
    | ProcessTemplateError
    | OHtmlPdfGeneratePdfErrorDown
    | OHtmlPdfGeneratePdfErrorPage
}

interface ProcessTemplateError {
  type: 'ProcessTemplateFailed';
  msg: string;
  handlebarsError?: Error;
}

interface OHtmlPdfGeneratePdfErrorDown {
  type: 'OHtmlPdfDown';
  msg: string;
}

interface OHtmlPdfGeneratePdfErrorPage {
  type: 'PageFailed';
  msg: string;
  page: GoToOptions;
  pdf: PDFOptions;
  puppeteerError: Error;
}

const oHtmlPdf = new OHtmlPdf();

const data = {
  name: 'Oropesa',
  project: 'Test',
  logo: 'file://C://absolute/dir/to/img/logo.png'
}

const template = {
  html: `<style>/* ... */</style> \ 
    <body><div>Hi, {{name}}<br><img alt="{{project}}" src="{{{logo}}}" /></div></body`,
};

// To return only file

const options: OHtmlPdfGeneratePdfOptionsOnlyFile = {
  output: 'file.pdf',
  buffer: false,
}

const response: OHtmlPdfGeneratePdfObjectOnlyFile = await oHtmlPdf.generatePdf();
// -> { 
//   status: true, 
//   filename: 'file.pdf', 
//   filepath: '/absolute/path/file.pdf', 
// }


// To return only buffer

const options: OHtmlPdfGeneratePdfOptionsOnlyBuffer = {
  output?: undefined,
  buffer?: true,
}

const response: OHtmlPdfGeneratePdfObjectOnlyBuffer = await oHtmlPdf.generatePdf();
// -> { 
//   status: true, 
//   buffer: Buffer, 
// }


// To return buffer & file

const options: OHtmlPdfGeneratePdfOptionsBufferFile = {
  output: 'file.pdf',
  buffer?: true,
}

const response: OHtmlPdfGeneratePdfObjectBufferFile = await oHtmlPdf.generatePdf();
// -> { 
//   status: true, 
//   filename: 'file.pdf',
//   filepath: '/absolute/path/file.pdf', 
//   buffer: Buffer, 
// }

static await generatePdfOnce()

static await generatePdfOnce<T extends Record<string, any>>(
  args: OHtmlPdfGeneratePdfOnceInput<T>,
): Promise<OHtmlPdfGeneratePdfOnceResponse>

interface OHtmlPdfGeneratePdfOnceInput<T extends Record<string, any>> {
  template?: OHtmlPdfGeneratePdfTemplate;
  data?: T;
  options?: OHtmlPdfGeneratePdfOptions & OHtmlPdfPoolOpenOptions & OHtmlPdfPoolCloseOptions;
}

// poolOpen & generatePdf & poolClose

const response = await OHtmlPdf.generatePdfOnce( { ... } );
// -> { 
//   status: true, 
//   filename: 'output.pdf', 
//   filepath: '/absolute/path/output.pdf', 
//   buffer: Buffer, 
// }

Helper functions

await castData

await castData<T extends Record<string | number, any>>(data: T): Promise<T>

const rawData = {
  project: "Test",
  logo: "file://assets/oropensando.jpg",
  logosmall: "https://oropensando.com/extrafiles/oro-html-pdf-test/oropensando32.png"
}

const data = await castData(rawData);
// -> {
//   project: "Test",
//   logo: "...",     // base64 image string
//   logosmall: "..." // base64 image string
// }

processTemplate

processTemplate<T extends Record<string, any>>(
  html: string,
  data?: T,
  options: HandlebarsOptions = {},
) => ProcessTemplateResponse

type HandlebarsOptions = CompileOptions & {
  registerHelpers?: Record<string, HelperDelegate>;
};

type ProcessTemplateResponse =
  | SResponseOKObject<ProcessTemplateObject>
  | SResponseKOObjectSimple<ProcessTemplateError>

interface SResponseOKObject {
  status: true,
  html: string;
}

interface ProcessTemplateObject {
  html: string;
}

interface SResponseKOObjectSimple {
  status: false,
  error: {
    type: 'ProcessTemplateFailed';
    msg: string;
    handlebarsError?: any;
  }
}

interface ProcessTemplateError {
  type: 'ProcessTemplateFailed';
  msg: string;
  handlebarsError?: any;
}

oro-html-pdf

Oro Html PDF

Overview

Installation

Example:

Template advises

HEADER / FOOTER.

IMAGES.

Methods

await poolOpen()

await poolClose()

await generatePdf()

static await generatePdfOnce()

Helper functions

await castData

processTemplate

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

Weekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

oro-html-pdf

Oro Html PDF

Overview

Installation

Example:

Template advises

HEADER / FOOTER.

IMAGES.

Methods

await poolOpen()

await poolClose()

await generatePdf()

static await generatePdfOnce()

Helper functions

await castData

processTemplate

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

Weekly Downloads