@shad0wz7/nestjs-pdf 2.2.2 → 2.3.1

package/README.md

@@ -1,10 +1,10 @@
 # nestjs-pdf
 
-A small NestJS library to generate and manipulate PDFs using Puppeteer and multiple template engines, including Handlebars, EJS, Pug, and MJML.
+A small NestJS library to generate and manipulate PDFs using Puppeteer and multiple template engines, including Handlebars, EJS, Pug, MJML, Nunjucks, Eta and Mustache.
 
 Main features:
 
-- Generate PDFs from HTML, Handlebars, EJS, Pug or MJML templates
+- Generate PDFs from HTML, Handlebars, EJS, Pug, MJML, Nunjucks, Eta or Mustache 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
@@ -128,6 +128,7 @@ The library exposes Puppeteer options via the `PuppeteerParameters` interface (s
 | `buildId`                   | You can force the build id. Should be `string`                                                                                                                                                                                                                                                 |
 | `cleanupBrowserCacheOnExit` | Define if you want to clean up the browser cache folder on exit. By default it's `true`. Allowed values: `true`,`false`                                                                                                                                                                        |
 | `extraPuppeteerArgs`        | It passes some extra arguments to Puppeteer's launch method. You can check the default args at bellow. Should be `string[]`                                                                                                                                                                    |
+| `executablePath`            | The path to the browser executable to use. If not specified, Puppeteer will install Chromium in cache dir. (useLockedBrowser is useless with this param specified)                                                                                                                             |
 
 these are the default extra arguments passed to Puppeteer:
 ```ts

package/dist/index.d.mts

@@ -32,8 +32,8 @@ declare class BrowserService implements OnModuleDestroy {
     private buildId;
     constructor(pdfParams: PuppeteerParameters);
     onModuleDestroy(): Promise<void>;
-    getBrowserInstance(args: string[], headless: boolean | 'shell' | undefined): Promise<Browser>;
-    createContext(args: string[], headless: boolean | 'shell' | undefined): Promise<BrowserContext>;
+    getBrowserInstance(args: string[], headless: boolean | 'shell' | undefined, executablePathBin: string | undefined): Promise<Browser>;
+    createContext(args: string[], headless: boolean | 'shell' | undefined, executablePath?: string): Promise<BrowserContext>;
     markJobStarted(): void;
     markJobFinished(): Promise<void>;
     recycleBrowserIfNeeded(): Promise<void>;
@@ -174,6 +174,7 @@ interface PuppeteerParameters {
     useLockedBrowser?: boolean;
     browserInstallBaseUrl?: string;
     extraPuppeteerArgs?: string[];
+    executablePath?: string;
     cleanupBrowserCacheOnExit?: boolean;
 }
 

package/dist/index.d.ts

@@ -32,8 +32,8 @@ declare class BrowserService implements OnModuleDestroy {
     private buildId;
     constructor(pdfParams: PuppeteerParameters);
     onModuleDestroy(): Promise<void>;
-    getBrowserInstance(args: string[], headless: boolean | 'shell' | undefined): Promise<Browser>;
-    createContext(args: string[], headless: boolean | 'shell' | undefined): Promise<BrowserContext>;
+    getBrowserInstance(args: string[], headless: boolean | 'shell' | undefined, executablePathBin: string | undefined): Promise<Browser>;
+    createContext(args: string[], headless: boolean | 'shell' | undefined, executablePath?: string): Promise<BrowserContext>;
     markJobStarted(): void;
     markJobFinished(): Promise<void>;
     recycleBrowserIfNeeded(): Promise<void>;
@@ -174,6 +174,7 @@ interface PuppeteerParameters {
     useLockedBrowser?: boolean;
     browserInstallBaseUrl?: string;
     extraPuppeteerArgs?: string[];
+    executablePath?: string;
     cleanupBrowserCacheOnExit?: boolean;
 }
 

package/dist/index.js

@@ -2683,9 +2683,9 @@ var BrowserService = class {
     }
     await this.cleanupCacheBestEffort();
   }
-  async getBrowserInstance(args, headless) {
+  async getBrowserInstance(args, headless, executablePathBin) {
     if (!this._browserInstance?.connected) {
-      const executablePath = await this.getExecutablePath();
+      const executablePath = executablePathBin ?? await this.getExecutablePath();
       this._browserInstance = await (0, import_puppeteer.launch)({
         executablePath,
         headless,
@@ -2697,8 +2697,8 @@ var BrowserService = class {
     }
     return this._browserInstance;
   }
-  async createContext(args, headless) {
-    const browser = await this.getBrowserInstance(args, headless);
+  async createContext(args, headless, executablePath) {
+    const browser = await this.getBrowserInstance(args, headless, executablePath);
     return await browser.createBrowserContext();
   }
   markJobStarted() {
@@ -4337,6 +4337,7 @@ var PuppeteerService = class {
         import_common8.Logger.warn("Using `chromiumRevision` is no longer supported since the puppeteer update.");
       }
       const headless = mergePuppeteerOptions.headless ?? true;
+      const executablePath = mergePuppeteerOptions.executablePath || void 0;
       const args = mergePuppeteerOptions.extraPuppeteerArgs || [
         "--autoplay-policy=user-gesture-required",
         "--disable-background-networking",
@@ -4378,7 +4379,7 @@ var PuppeteerService = class {
       this.browserService.markJobStarted();
       let context = null;
       try {
-        context = await this.browserService.createContext(args, headless);
+        context = await this.browserService.createContext(args, headless, executablePath);
         const page = await context.newPage();
         const pdfOptions = mergePuppeteerOptions.pdfOptions ?? {
           format: "A4"
@@ -4910,7 +4911,7 @@ var PuppeteerModule = class _PuppeteerModule {
     this.pdfParams = pdfParams;
   }
   async onModuleInit() {
-    await this.browserService.install(this.pdfParams.useLockedBrowser ?? false);
+    if (!this.pdfParams.executablePath) await this.browserService.install(this.pdfParams.useLockedBrowser ?? false);
   }
   static forRoot(pdfParameters) {
     const providers = [

package/dist/index.mjs

@@ -2666,9 +2666,9 @@ var BrowserService = class {
     }
     await this.cleanupCacheBestEffort();
   }
-  async getBrowserInstance(args, headless) {
+  async getBrowserInstance(args, headless, executablePathBin) {
     if (!this._browserInstance?.connected) {
-      const executablePath = await this.getExecutablePath();
+      const executablePath = executablePathBin ?? await this.getExecutablePath();
       this._browserInstance = await launch({
         executablePath,
         headless,
@@ -2680,8 +2680,8 @@ var BrowserService = class {
     }
     return this._browserInstance;
   }
-  async createContext(args, headless) {
-    const browser = await this.getBrowserInstance(args, headless);
+  async createContext(args, headless, executablePath) {
+    const browser = await this.getBrowserInstance(args, headless, executablePath);
     return await browser.createBrowserContext();
   }
   markJobStarted() {
@@ -4320,6 +4320,7 @@ var PuppeteerService = class {
         Logger2.warn("Using `chromiumRevision` is no longer supported since the puppeteer update.");
       }
       const headless = mergePuppeteerOptions.headless ?? true;
+      const executablePath = mergePuppeteerOptions.executablePath || void 0;
       const args = mergePuppeteerOptions.extraPuppeteerArgs || [
         "--autoplay-policy=user-gesture-required",
         "--disable-background-networking",
@@ -4361,7 +4362,7 @@ var PuppeteerService = class {
       this.browserService.markJobStarted();
       let context = null;
       try {
-        context = await this.browserService.createContext(args, headless);
+        context = await this.browserService.createContext(args, headless, executablePath);
         const page = await context.newPage();
         const pdfOptions = mergePuppeteerOptions.pdfOptions ?? {
           format: "A4"
@@ -4893,7 +4894,7 @@ var PuppeteerModule = class _PuppeteerModule {
     this.pdfParams = pdfParams;
   }
   async onModuleInit() {
-    await this.browserService.install(this.pdfParams.useLockedBrowser ?? false);
+    if (!this.pdfParams.executablePath) await this.browserService.install(this.pdfParams.useLockedBrowser ?? false);
   }
   static forRoot(pdfParameters) {
     const providers = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shad0wz7/nestjs-pdf",
-  "version": "2.2.2",
+  "version": "2.3.1",
   "description": "A NestJS library for generating PDFs with Puppeteer and Handlebars.",
   "author": "Emmanuel Boisset",
   "license": "MIT",