@shad0wz7/nestjs-pdf 2.2.1 → 2.3.0

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"

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"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shad0wz7/nestjs-pdf",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "A NestJS library for generating PDFs with Puppeteer and Handlebars.",
   "author": "Emmanuel Boisset",
   "license": "MIT",
@@ -56,55 +56,55 @@
     "deepmerge-ts": "^7.1.5",
     "p-limit": "^7.3.0",
     "pdf-lib": "^1.17.1",
-    "pdfjs-dist": "^5.7.284",
+    "pdfjs-dist": "^6.0.227",
     "puppeteer": "^25.1.0"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.5",
     "@eslint/js": "^10.0.1",
-    "@nestjs/cli": "^11.0.21",
+    "@nestjs/cli": "^11.0.23",
     "@nestjs/config": "^4.0.4",
-    "@nestjs/platform-express": "^11.1.19",
+    "@nestjs/platform-express": "^11.1.27",
     "@nestjs/schematics": "^11.1.0",
-    "@nestjs/testing": "^11.1.19",
-    "@swc/core": "^1.15.33",
+    "@nestjs/testing": "^11.1.27",
+    "@swc/core": "^1.15.41",
     "@types/ejs": "^3.1.5",
     "@types/express": "^5.0.6",
     "@types/jest": "^30.0.0",
     "@types/mjml": "^5.0.0",
     "@types/mjml-core": "^5.0.0",
     "@types/mustache": "^4.2.6",
-    "@types/node": "^25.6.2",
+    "@types/node": "^26.0.0",
     "@types/nunjucks": "^3.2.6",
     "@types/pug": "^2.0.10",
     "@types/supertest": "^7.2.0",
-    "eslint": "^10.3.0",
+    "eslint": "^10.5.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-prettier": "^5.5.6",
     "globals": "^17.6.0",
     "husky": "^9.1.7",
     "jest": "^30.4.2",
-    "prettier": "^3.8.3",
+    "prettier": "^3.8.4",
     "reflect-metadata": "^0.2.2",
     "source-map-support": "^0.5.21",
     "supertest": "^7.2.2",
-    "ts-jest": "^29.4.9",
-    "ts-loader": "^9.5.7",
+    "ts-jest": "^29.4.11",
+    "ts-loader": "^9.6.1",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.59.3"
+    "typescript-eslint": "^8.61.1"
   },
   "optionalDependencies": {
     "@gboutte/nestjs-hbs": "^0.2.0",
     "@napi-rs/canvas": "^1.0.0",
     "ejs": "^6.0.1",
     "eta": "^4.6.0",
-    "mjml": "^5.2.1",
+    "mjml": "^5.3.0",
     "mustache": "^4.2.0",
     "nunjucks": "^3.2.4",
-    "pug": "^3.0.3"
+    "pug": "^3.0.4"
   },
   "repository": {
     "url": "git+https://github.com/ShadowZ11/nestjs-pdf.git"