@shad0wz7/nestjs-pdf 1.1.0 → 2.0.0

package/README.md

@@ -1,9 +1,9 @@
 # nestjs-pdf
 
-A small NestJS library to generate and manipulate PDFs using Puppeteer and Handlebars.
+A small NestJS library to generate and manipulate PDFs using Puppeteer and multiple template engines, including Handlebars, EJS, Pug, and MJML.
 
 Main features:
-- Generate PDFs from HTML or Handlebars templates
+- Generate PDFs from HTML, Handlebars, EJS, Pug or MJML templates
 - Concurrency limiting for Puppeteer jobs (p-limit)
 - Add signature fields based on a text anchor in an existing PDF
 - Simple API (module and service) to integrate easily into a Nest application
@@ -68,7 +68,11 @@ Use a Handlebars template (string or file):
 
 ```ts
 const template = '<h1>{{title}}</h1><p>{{content}}</p>';
-const pdf = await pdfService.generatePdfFromTemplateString(template, { title: 'T', content: '...' });
+const pdf = await pdfService.generatePdfFromTemplateHbsString(template, { title: 'T', content: '...' });
+```
+
+```ts
+const pdf = await pdfService.generatePdfFromTemplateHbsFile(filePath, { title: 'T', content: '...' });
 ```
 
 Add a signature field to an existing PDF (anchor-based):

package/dist/index.d.mts

@@ -3,6 +3,9 @@ import { HandlebarsOptions } from '@gboutte/nestjs-hbs/dist/handlebars-options.i
 import * as puppeteerBrowser from '@puppeteer/browsers';
 import { Browser as Browser$1 } from '@puppeteer/browsers';
 import { Browser, BrowserContext, PDFOptions } from 'puppeteer';
+import { MJMLParsingOptions } from 'mjml-core';
+import pug, { LocalsObject } from 'pug';
+import { Options, Data } from 'ejs';
 import { HandlebarsService } from '@gboutte/nestjs-hbs';
 
 declare enum BrowserTag {
@@ -50,9 +53,26 @@ declare class BrowserService implements OnModuleDestroy {
     getLockedBuildId(browser: Browser$1): string | null;
 }
 
+type PugOptions = pug.Options;
+declare class PugService {
+    render(template: string, data?: pug.LocalsObject, options?: PugOptions): string;
+    renderFile(filePath: string, data?: pug.LocalsObject, options?: PugOptions): string;
+}
+
+interface EjsOptions extends Omit<Options, 'async'> {
+    async?: boolean;
+}
+declare class EjsService {
+    render(template: string, data?: Data, options?: EjsOptions): Promise<string>;
+    renderFile(filePath: string, data?: Data, options?: EjsOptions): Promise<string>;
+}
+
 interface PuppeteerParameters {
     pdfOptions?: PDFOptions;
     hbsOptions?: HandlebarsOptions;
+    mjmlOptions?: MJMLParsingOptions;
+    pugOptions?: PugOptions;
+    ejsOptions?: EjsOptions;
     chromiumRevision?: string;
     buildId?: string;
     headless?: boolean | 'shell';
@@ -73,23 +93,143 @@ declare class NestjsPdfModule {
     static forRootAsync(options: PdfLibModuleAsyncOptions): DynamicModule;
 }
 
+declare class MjmlService {
+    render(template: string, options?: MJMLParsingOptions): Promise<string>;
+    renderFile(filePath: string, options?: MJMLParsingOptions): Promise<string>;
+}
+
 declare class PuppeteerService {
     private readonly hbsService;
     private readonly browserService;
     private readonly options;
-    constructor(hbsService: HandlebarsService, browserService: BrowserService, options: PuppeteerParameters);
+    private readonly mjmlService?;
+    private readonly pugService?;
+    private readonly ejsService?;
+    constructor(hbsService: HandlebarsService, browserService: BrowserService, options: PuppeteerParameters, mjmlService?: MjmlService | undefined, pugService?: PugService | undefined, ejsService?: EjsService | undefined);
     private readonly limit;
     generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array>;
-    generatePdfFromTemplateString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
-    generatePdfFromTemplateFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromMjmlString(template: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromMjmlFile(file: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromPugString(template: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromPugFile(file: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromEjsString(template: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromEjsFile(file: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
 declare class NestjsPdfService {
     private readonly puppeteerService;
     constructor(puppeteerService: PuppeteerService);
+    /**
+     * @param html HTML string to convert to PDF
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided HTML
+     * @description This method uses the Puppeteer service to generate a PDF from an HTML string. Generation options can be customized by passing a `PuppeteerParameters` object as the second argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @deprecated Use the new method generatePdfFromTemplateHbsString
+     * @param template Handlebars template string
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Handlebars template with parameters applied
+     * @description This method generates a PDF from a Handlebars template provided as a string. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @deprecated Use the new method generatePdfFromTemplateHbsFile
+     * @param file Path to the Handlebars template file
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Handlebars template at the provided file path with parameters applied
+     * @description This method generates a PDF from a Handlebars template located at the specified file path. The file path is passed as a string in the `file` parameter. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template Handlebars template string
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Handlebars template with parameters applied
+     * @description This method generates a PDF from a Handlebars template provided as a string. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
+    generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the Handlebars template file
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Handlebars template at the provided file path with parameters applied
+     * @description This method generates a PDF from a Handlebars template located at the specified file path. The file path is passed as a string in the `file` parameter. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
+    generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template MJML template string
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided MJML template
+     * @description This method generates a PDF from an MJML template provided as a string. MJML (MJML Markup Language) is a markup language designed to reduce the pain of coding a responsive email. The template is first rendered to HTML using the MJML renderer, then converted to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the second argument.
+     */
+    generatePdfFromMjmlString(template: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the MJML template file
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the MJML template at the provided file path
+     * @description This method generates a PDF from an MJML template located at the specified file path. The file path is passed as a string in the `file` parameter. The template is first rendered to HTML using the MJML renderer, then converted to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the second argument.
+     */
+    generatePdfFromMjmlFile(file: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template EJS template string
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided EJS template with data applied
+     * @description This method generates a PDF from an EJS (Embedded JavaScript) template provided as a string. EJS is a templating language with a simple, straightforward syntax. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromEjsString(template: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the EJS template file
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the EJS template at the provided file path with data applied
+     * @description This method generates a PDF from an EJS template located at the specified file path. The file path is passed as a string in the `file` parameter. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromEjsFile(file: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template Pug template string
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Pug template with data applied
+     * @description This method generates a PDF from a Pug template provided as a string. Pug is a clean, whitespace-sensitive syntax for writing HTML. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromPugString(template: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the Pug template file
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Pug template at the provided file path with data applied
+     * @description This method generates a PDF from a Pug template located at the specified file path. The file path is passed as a string in the `file` parameter. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromPugFile(file: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param pdf The PDF bytes to modify
+     * @param fieldName The name of the signature field to add (default: 'SignatureDebtor')
+     * @param anchorText The text anchor to locate the signature field position (default: '__SIG_DEBTOR_ANCHOR__')
+     * @returns Modified PDF with a signature field added at the anchor position
+     * @description This method adds a signature field to a PDF using a text anchor as a reference for the field position. It uses the `addSignatureFieldUsingAnchor` function which finds the anchor in the PDF and inserts a signature field at that location. The signature field is named according to the `fieldName` parameter and the anchor is defined by `anchorText`.
+     *
+     * Usage example:
+     * ```typescript
+     * const modifiedPdf = await pdfService.addSignatureFieldSignatureDebtorRaw(
+     *   originalPdfBytes,
+     *   'SignatureDebtor',
+     *   '__SIG_DEBTOR_ANCHOR__'
+     * );
+     * ```
+     *
+     * In this example, `originalPdfBytes` is a byte array representing the original PDF, `SignatureDebtor` is the name of the signature field to add, and `__SIG_DEBTOR_ANCHOR__` is the anchor text used to position the signature field in the PDF.
+     *
+     * If the anchor is not found, the signature field will be added at a default position (centered at the bottom of the last page).
+     *
+     * Note: Ensure that the input PDF contains the anchor defined by `anchorText` for the signature field to be positioned correctly. Otherwise, it will be added at a default position.
+     */
     addSignatureFieldSignatureDebtorRaw(pdf: Uint8Array | Buffer, fieldName?: string, anchorText?: string): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
@@ -106,16 +246,15 @@ declare class PuppeteerModule implements OnModuleInit {
     static forRootAsync(options: PuppeteerModuleAsyncOptions): DynamicModule;
 }
 
-interface PuppeteerHandlebarsModuleAsyncOptions {
-    imports?: DynamicModule[];
-    inject?: (InjectionToken | OptionalFactoryDependency)[];
-    useFactory: (...args: unknown[]) => Promise<HandlebarsOptions> | HandlebarsOptions;
-}
-declare class PuppeteerHandlebarsModule {
-    static forRoot(handlebarsOptions: HandlebarsOptions): DynamicModule;
-    static forRootAsync(options: PuppeteerHandlebarsModuleAsyncOptions): DynamicModule;
-}
-
+/**
+ * Get the relative path to a value from the module directory.
+ * @param moduleDir the path of the module, typically __dirname
+ * @param relativeToModule the path to the value relative to the module directory
+ * @returns the relative path from the current working directory to the value
+ * @example
+ * getRelativePathToValue(__dirname, './templates/my-template.hbs');
+ * // returns 'context/pdf/templates/my-template.hbs' if the current working directory is '/
+ */
 declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
 
-export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };
+export { type EjsOptions, EjsService, MjmlService, NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, type PugOptions, PugService, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };

package/dist/index.d.ts

@@ -3,6 +3,9 @@ import { HandlebarsOptions } from '@gboutte/nestjs-hbs/dist/handlebars-options.i
 import * as puppeteerBrowser from '@puppeteer/browsers';
 import { Browser as Browser$1 } from '@puppeteer/browsers';
 import { Browser, BrowserContext, PDFOptions } from 'puppeteer';
+import { MJMLParsingOptions } from 'mjml-core';
+import pug, { LocalsObject } from 'pug';
+import { Options, Data } from 'ejs';
 import { HandlebarsService } from '@gboutte/nestjs-hbs';
 
 declare enum BrowserTag {
@@ -50,9 +53,26 @@ declare class BrowserService implements OnModuleDestroy {
     getLockedBuildId(browser: Browser$1): string | null;
 }
 
+type PugOptions = pug.Options;
+declare class PugService {
+    render(template: string, data?: pug.LocalsObject, options?: PugOptions): string;
+    renderFile(filePath: string, data?: pug.LocalsObject, options?: PugOptions): string;
+}
+
+interface EjsOptions extends Omit<Options, 'async'> {
+    async?: boolean;
+}
+declare class EjsService {
+    render(template: string, data?: Data, options?: EjsOptions): Promise<string>;
+    renderFile(filePath: string, data?: Data, options?: EjsOptions): Promise<string>;
+}
+
 interface PuppeteerParameters {
     pdfOptions?: PDFOptions;
     hbsOptions?: HandlebarsOptions;
+    mjmlOptions?: MJMLParsingOptions;
+    pugOptions?: PugOptions;
+    ejsOptions?: EjsOptions;
     chromiumRevision?: string;
     buildId?: string;
     headless?: boolean | 'shell';
@@ -73,23 +93,143 @@ declare class NestjsPdfModule {
     static forRootAsync(options: PdfLibModuleAsyncOptions): DynamicModule;
 }
 
+declare class MjmlService {
+    render(template: string, options?: MJMLParsingOptions): Promise<string>;
+    renderFile(filePath: string, options?: MJMLParsingOptions): Promise<string>;
+}
+
 declare class PuppeteerService {
     private readonly hbsService;
     private readonly browserService;
     private readonly options;
-    constructor(hbsService: HandlebarsService, browserService: BrowserService, options: PuppeteerParameters);
+    private readonly mjmlService?;
+    private readonly pugService?;
+    private readonly ejsService?;
+    constructor(hbsService: HandlebarsService, browserService: BrowserService, options: PuppeteerParameters, mjmlService?: MjmlService | undefined, pugService?: PugService | undefined, ejsService?: EjsService | undefined);
     private readonly limit;
     generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array>;
-    generatePdfFromTemplateString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
-    generatePdfFromTemplateFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromMjmlString(template: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromMjmlFile(file: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromPugString(template: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromPugFile(file: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromEjsString(template: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    generatePdfFromEjsFile(file: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
 declare class NestjsPdfService {
     private readonly puppeteerService;
     constructor(puppeteerService: PuppeteerService);
+    /**
+     * @param html HTML string to convert to PDF
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided HTML
+     * @description This method uses the Puppeteer service to generate a PDF from an HTML string. Generation options can be customized by passing a `PuppeteerParameters` object as the second argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @deprecated Use the new method generatePdfFromTemplateHbsString
+     * @param template Handlebars template string
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Handlebars template with parameters applied
+     * @description This method generates a PDF from a Handlebars template provided as a string. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @deprecated Use the new method generatePdfFromTemplateHbsFile
+     * @param file Path to the Handlebars template file
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Handlebars template at the provided file path with parameters applied
+     * @description This method generates a PDF from a Handlebars template located at the specified file path. The file path is passed as a string in the `file` parameter. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
     generatePdfFromTemplateFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template Handlebars template string
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Handlebars template with parameters applied
+     * @description This method generates a PDF from a Handlebars template provided as a string. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
+    generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the Handlebars template file
+     * @param parameters Data parameters to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Handlebars template at the provided file path with parameters applied
+     * @description This method generates a PDF from a Handlebars template located at the specified file path. The file path is passed as a string in the `file` parameter. The parameters to inject into the template are passed in the `parameters` object, which is used to render the template before converting it to PDF. PDF generation options can also be customized by passing a `PuppeteerParameters` object as the third argument. This allows you to control various aspects of PDF rendering, such as page size, margins, background display, etc. If no options are provided, the default parameters defined in the Puppeteer service will be used.
+     */
+    generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template MJML template string
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided MJML template
+     * @description This method generates a PDF from an MJML template provided as a string. MJML (MJML Markup Language) is a markup language designed to reduce the pain of coding a responsive email. The template is first rendered to HTML using the MJML renderer, then converted to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the second argument.
+     */
+    generatePdfFromMjmlString(template: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the MJML template file
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the MJML template at the provided file path
+     * @description This method generates a PDF from an MJML template located at the specified file path. The file path is passed as a string in the `file` parameter. The template is first rendered to HTML using the MJML renderer, then converted to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the second argument.
+     */
+    generatePdfFromMjmlFile(file: string, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template EJS template string
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided EJS template with data applied
+     * @description This method generates a PDF from an EJS (Embedded JavaScript) template provided as a string. EJS is a templating language with a simple, straightforward syntax. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromEjsString(template: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the EJS template file
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the EJS template at the provided file path with data applied
+     * @description This method generates a PDF from an EJS template located at the specified file path. The file path is passed as a string in the `file` parameter. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromEjsFile(file: string, data?: Data, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param template Pug template string
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the provided Pug template with data applied
+     * @description This method generates a PDF from a Pug template provided as a string. Pug is a clean, whitespace-sensitive syntax for writing HTML. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromPugString(template: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param file Path to the Pug template file
+     * @param data Data to inject into the template
+     * @param options PDF generation options (optional)
+     * @returns PDF generated from the Pug template at the provided file path with data applied
+     * @description This method generates a PDF from a Pug template located at the specified file path. The file path is passed as a string in the `file` parameter. The data to inject into the template is passed in the `data` object, which is used to render the template before converting it to PDF. PDF generation options can be customized by passing a `PuppeteerParameters` object as the third argument.
+     */
+    generatePdfFromPugFile(file: string, data?: LocalsObject, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * @param pdf The PDF bytes to modify
+     * @param fieldName The name of the signature field to add (default: 'SignatureDebtor')
+     * @param anchorText The text anchor to locate the signature field position (default: '__SIG_DEBTOR_ANCHOR__')
+     * @returns Modified PDF with a signature field added at the anchor position
+     * @description This method adds a signature field to a PDF using a text anchor as a reference for the field position. It uses the `addSignatureFieldUsingAnchor` function which finds the anchor in the PDF and inserts a signature field at that location. The signature field is named according to the `fieldName` parameter and the anchor is defined by `anchorText`.
+     *
+     * Usage example:
+     * ```typescript
+     * const modifiedPdf = await pdfService.addSignatureFieldSignatureDebtorRaw(
+     *   originalPdfBytes,
+     *   'SignatureDebtor',
+     *   '__SIG_DEBTOR_ANCHOR__'
+     * );
+     * ```
+     *
+     * In this example, `originalPdfBytes` is a byte array representing the original PDF, `SignatureDebtor` is the name of the signature field to add, and `__SIG_DEBTOR_ANCHOR__` is the anchor text used to position the signature field in the PDF.
+     *
+     * If the anchor is not found, the signature field will be added at a default position (centered at the bottom of the last page).
+     *
+     * Note: Ensure that the input PDF contains the anchor defined by `anchorText` for the signature field to be positioned correctly. Otherwise, it will be added at a default position.
+     */
     addSignatureFieldSignatureDebtorRaw(pdf: Uint8Array | Buffer, fieldName?: string, anchorText?: string): Promise<Uint8Array<ArrayBufferLike>>;
 }
 
@@ -106,16 +246,15 @@ declare class PuppeteerModule implements OnModuleInit {
     static forRootAsync(options: PuppeteerModuleAsyncOptions): DynamicModule;
 }
 
-interface PuppeteerHandlebarsModuleAsyncOptions {
-    imports?: DynamicModule[];
-    inject?: (InjectionToken | OptionalFactoryDependency)[];
-    useFactory: (...args: unknown[]) => Promise<HandlebarsOptions> | HandlebarsOptions;
-}
-declare class PuppeteerHandlebarsModule {
-    static forRoot(handlebarsOptions: HandlebarsOptions): DynamicModule;
-    static forRootAsync(options: PuppeteerHandlebarsModuleAsyncOptions): DynamicModule;
-}
-
+/**
+ * Get the relative path to a value from the module directory.
+ * @param moduleDir the path of the module, typically __dirname
+ * @param relativeToModule the path to the value relative to the module directory
+ * @returns the relative path from the current working directory to the value
+ * @example
+ * getRelativePathToValue(__dirname, './templates/my-template.hbs');
+ * // returns 'context/pdf/templates/my-template.hbs' if the current working directory is '/
+ */
 declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
 
-export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };
+export { type EjsOptions, EjsService, MjmlService, NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, type PugOptions, PugService, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };