@maistik/nuxt-pdf 1.0.17 → 1.1.4

package/dist/module.d.mts

@@ -7,7 +7,7 @@ interface PdfModuleOptions {
     enableI18n: boolean;
     defaultLocale: string;
     availableLocales: string[];
-    i18nMessages: Record<string, Record<string, string>>;
+    i18nMessages: Record<string, Record<string, unknown>>;
     providers: {
         gotenberg: {
             url: string;
@@ -17,7 +17,7 @@ interface PdfModuleOptions {
             apiKey: string;
         };
         puppeteer: {
-            launchOptions: Record<string, any>;
+            launchOptions: Record<string, unknown>;
         };
     };
     defaultOptions: {

package/dist/module.d.ts

@@ -7,7 +7,7 @@ interface PdfModuleOptions {
     enableI18n: boolean;
     defaultLocale: string;
     availableLocales: string[];
-    i18nMessages: Record<string, Record<string, string>>;
+    i18nMessages: Record<string, Record<string, unknown>>;
     providers: {
         gotenberg: {
             url: string;
@@ -17,7 +17,7 @@ interface PdfModuleOptions {
             apiKey: string;
         };
         puppeteer: {
-            launchOptions: Record<string, any>;
+            launchOptions: Record<string, unknown>;
         };
     };
     defaultOptions: {

package/dist/module.json

@@ -2,11 +2,11 @@
   "name": "@maistik/nuxt-pdf",
   "configKey": "pdf",
   "compatibility": {
-    "nuxt": "^3.0.0"
+    "nuxt": ">=3.0.0"
   },
-  "version": "1.0.17",
+  "version": "1.1.4",
   "builder": {
-    "@nuxt/module-builder": "1.0.1",
-    "unbuild": "3.5.0"
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
   }
 }

package/dist/module.mjs

@@ -1,13 +1,13 @@
-import { defineNuxtModule, createResolver, addServerHandler, addImports } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addServerTemplate, addServerHandler, addImports } from '@nuxt/kit';
 import { existsSync, readdirSync, statSync, readFileSync } from 'fs';
 import { join } from 'path';
 
-const module = defineNuxtModule({
+const module$1 = defineNuxtModule({
   meta: {
     name: "@maistik/nuxt-pdf",
     configKey: "pdf",
     compatibility: {
-      nuxt: "^3.0.0"
+      nuxt: ">=3.0.0"
     }
   },
   defaults: {
@@ -55,14 +55,15 @@ const module = defineNuxtModule({
     const resolver = createResolver(import.meta.url);
     const templateSources = {};
     const partialSources = {};
+    const baseDir = nuxt.options.rootDir;
     for (const componentDir of options.components) {
-      const fullPath = join(nuxt.options.srcDir, componentDir);
+      const fullPath = join(baseDir, componentDir);
       if (existsSync(fullPath)) {
         scanDirectory(fullPath, templateSources, ".hbs");
       }
     }
     for (const sharedDir of options.sharedComponents) {
-      const fullPath = join(nuxt.options.srcDir, sharedDir);
+      const fullPath = join(baseDir, sharedDir);
       if (existsSync(fullPath)) {
         scanDirectory(fullPath, partialSources, ".hbs");
       }
@@ -76,9 +77,12 @@ const module = defineNuxtModule({
       providers: options.providers,
       defaultOptions: options.defaultOptions,
       templateSources,
-      partialSources,
-      customHelpers: options.customHelpers || {}
+      partialSources
     };
+    addServerTemplate({
+      filename: "#pdf-custom-helpers",
+      getContents: () => generateCustomHelpersModule(options.customHelpers || {})
+    });
     nuxt.options.runtimeConfig.public.pdf = {
       enableI18n: options.enableI18n,
       defaultLocale: options.defaultLocale,
@@ -86,6 +90,7 @@ const module = defineNuxtModule({
     };
     addServerHandler({
       route: "/api/pdf",
+      method: "post",
       handler: resolver.resolve("./runtime/server/api/pdf.post")
     });
     addImports({
@@ -95,6 +100,13 @@ const module = defineNuxtModule({
     });
   }
 });
+function generateCustomHelpersModule(helpers) {
+  const entries = Object.entries(helpers).filter(([, fn]) => typeof fn === "function").map(([name, fn]) => `  ${JSON.stringify(name)}: ${fn.toString()}`);
+  return `export const customHelpers = {
+${entries.join(",\n")}
+}
+`;
+}
 function scanDirectory(dir, sources, extension) {
   if (!existsSync(dir)) return;
   const files = readdirSync(dir);
@@ -110,4 +122,4 @@ function scanDirectory(dir, sources, extension) {
   }
 }
 
-export { module as default };
+export { module$1 as default };

package/dist/runtime/composables/usePdf.d.ts

@@ -15,8 +15,8 @@ export interface PdfGenerateOptions {
     };
 }
 export declare function usePdf(): {
-    generate: (template: string, data: any, options?: PdfGenerateOptions, locale?: string) => Promise<Blob>;
-    download: (template: string, data: any, options?: PdfGenerateOptions, filename?: string, locale?: string) => Promise<void>;
+    generate: (template: string, data: Record<string, unknown>, options?: PdfGenerateOptions, locale?: string) => Promise<Blob>;
+    download: (template: string, data: Record<string, unknown>, options?: PdfGenerateOptions, filename?: string, locale?: string) => Promise<void>;
     getAvailableLocales: () => string[];
     getDefaultLocale: () => string;
 };

package/dist/runtime/server/api/pdf.post.js

@@ -1,23 +1,43 @@
-import { defineEventHandler, readBody, setHeader } from "h3";
+import { defineEventHandler, readBody, setHeader, createError, isError } from "h3";
 import { useRuntimeConfig } from "#imports";
+import { customHelpers } from "#pdf-custom-helpers";
 import { compilePdfComponent } from "../../utils/compiler.js";
 import { createPdfProvider } from "../../utils/providers.js";
 export default defineEventHandler(async (event) => {
+  const config = useRuntimeConfig();
+  const body = await readBody(event);
+  const template = body?.template;
+  const ctx = body?.ctx;
+  if (typeof template !== "string" || template.length === 0) {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'Missing or invalid "template"'
+    });
+  }
+  if (!ctx || typeof ctx !== "object") {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'Missing or invalid "ctx"'
+    });
+  }
+  const templateSources = config.pdf.templateSources;
+  if (!Object.prototype.hasOwnProperty.call(templateSources, template)) {
+    throw createError({
+      statusCode: 404,
+      statusMessage: `Template "${template}" not found`
+    });
+  }
+  const { data, options = {}, locale } = ctx;
+  const mergedOptions = { ...config.pdf.defaultOptions, ...options };
+  const messages = config.pdf.enableI18n ? config.pdf.i18nMessages[locale || config.pdf.defaultLocale] || {} : {};
   try {
-    const config = useRuntimeConfig();
-    const { template, ctx } = await readBody(event);
-    if (!template || !ctx) {
-      throw new Error("Missing template or context");
-    }
-    const { data, options = {}, locale } = ctx;
-    const mergedOptions = { ...config.pdf.defaultOptions, ...options };
-    const messages = config.pdf.enableI18n ? config.pdf.i18nMessages[locale || config.pdf.defaultLocale] || {} : {};
     const html = compilePdfComponent(
       template,
       { data, options: mergedOptions, locale },
       messages,
-      config.pdf.templateSources,
-      config.pdf.partialSources
+      templateSources,
+      config.pdf.partialSources,
+      customHelpers
     );
     const provider = createPdfProvider(config.pdf.provider, config.pdf.providers);
     const pdfBuffer = await provider.generatePdf(html, mergedOptions);
@@ -26,6 +46,12 @@ export default defineEventHandler(async (event) => {
     return pdfBuffer;
   } catch (error) {
     console.error("PDF generation error:", error);
-    throw error;
+    if (isError(error)) {
+      throw error;
+    }
+    throw createError({
+      statusCode: 500,
+      statusMessage: "Failed to generate PDF"
+    });
   }
 });

package/dist/runtime/types.d.ts

@@ -1,5 +1,5 @@
 export interface PdfContext {
-    data: any;
+    data: Record<string, unknown>;
     options: PdfOptions;
     locale?: string;
 }
@@ -28,9 +28,9 @@ export interface PdfProviderConfig {
         apiKey: string;
     };
     puppeteer: {
-        launchOptions: Record<string, any>;
+        launchOptions: Record<string, unknown>;
     };
 }
 export interface PdfProvider {
-    generatePdf(html: string, options: any): Promise<Buffer>;
+    generatePdf(html: string, options: PdfOptions): Promise<Buffer>;
 }

package/dist/runtime/utils/compiler.d.ts

@@ -1,5 +1,6 @@
+import type { HelperDelegate } from 'handlebars';
 export declare function compilePdfComponent(templateName: string, ctx: {
-    data: any;
-    options: any;
+    data: Record<string, unknown>;
+    options: Record<string, unknown>;
     locale?: string;
-}, messages: Record<string, string>, templateSources: Record<string, string>, partialSources: Record<string, string>): string;
+}, messages: Record<string, string>, templateSources: Record<string, string>, partialSources: Record<string, string>, customHelpers?: Record<string, HelperDelegate>): string;

package/dist/runtime/utils/compiler.js

@@ -1,12 +1,11 @@
-import { useRuntimeConfig } from "#imports";
 import Handlebars from "handlebars";
-export function compilePdfComponent(templateName, ctx, messages, templateSources, partialSources) {
+export function compilePdfComponent(templateName, ctx, messages, templateSources, partialSources, customHelpers = {}) {
   const handlebars = Handlebars.create();
   handlebars.registerHelper("t", function(key) {
     const keys = key.split(".");
     let value = messages;
     for (const k of keys) {
-      if (value && typeof value === "object" && k in value) {
+      if (value && typeof value === "object" && Object.prototype.hasOwnProperty.call(value, k)) {
         value = value[k];
       } else {
         return key;
@@ -21,8 +20,11 @@ export function compilePdfComponent(templateName, ctx, messages, templateSources
     let currency = "USD";
     if (typeof currencyOrOptions === "string") {
       currency = currencyOrOptions;
-    } else if (currencyOrOptions && typeof currencyOrOptions.hash?.currency === "string") {
-      currency = currencyOrOptions.hash.currency;
+    } else {
+      const hash = currencyOrOptions?.hash;
+      if (typeof hash?.currency === "string") {
+        currency = hash.currency;
+      }
     }
     if (!/^[A-Z]{3}$/.test(currency)) {
       currency = "USD";
@@ -42,20 +44,29 @@ export function compilePdfComponent(templateName, ctx, messages, templateSources
     }
     return isEqual;
   });
-  handlebars.registerHelper(
-    "ne",
-    (a, b, opts) => a !== b ? opts.fn(this) : opts.inverse(this)
-  );
-  handlebars.registerHelper(
-    "gt",
-    (a, b, opts) => a > b ? opts.fn(this) : opts.inverse(this)
-  );
+  handlebars.registerHelper("ne", function(a, b, options) {
+    const result = a !== b;
+    if (options && typeof options.fn === "function") {
+      return result ? options.fn(this) : options.inverse(this);
+    }
+    return result;
+  });
+  handlebars.registerHelper("gt", function(a, b, options) {
+    const result = a > b;
+    if (options && typeof options.fn === "function") {
+      return result ? options.fn(this) : options.inverse(this);
+    }
+    return result;
+  });
   handlebars.registerHelper("formatDate", function(date, formatOrOptions) {
     let style = "short";
     if (typeof formatOrOptions === "string") {
       style = formatOrOptions;
-    } else if (formatOrOptions && typeof formatOrOptions.hash?.format === "string") {
-      style = formatOrOptions.hash.format;
+    } else {
+      const hash = formatOrOptions?.hash;
+      if (typeof hash?.format === "string") {
+        style = hash.format;
+      }
     }
     if (!["full", "long", "medium", "short"].includes(style)) {
       style = "short";
@@ -75,22 +86,17 @@ export function compilePdfComponent(templateName, ctx, messages, templateSources
       dateStyle: style
     }).format(dateObj);
   });
-  handlebars.registerHelper("formatNumber", function(value, options = {}) {
+  handlebars.registerHelper("formatNumber", function(value, options) {
     if (typeof value !== "number") return value;
-    return new Intl.NumberFormat(ctx.locale || "en-US", options).format(value);
-  });
-  try {
-    const config = useRuntimeConfig();
-    const customHelpers = config.pdf.customHelpers;
-    if (customHelpers && typeof customHelpers === "object") {
-      Object.entries(customHelpers).forEach(([name, helper]) => {
-        if (typeof helper === "function") {
-          handlebars.registerHelper(name, helper);
-        }
-      });
+    const intlOptions = options && typeof options.hash === "object" ? options.hash : {};
+    return new Intl.NumberFormat(ctx.locale || "en-US", intlOptions).format(value);
+  });
+  if (customHelpers && typeof customHelpers === "object") {
+    for (const [name, helper] of Object.entries(customHelpers)) {
+      if (typeof helper === "function") {
+        handlebars.registerHelper(name, helper);
+      }
     }
-  } catch (error) {
-    console.warn("Failed to load custom helpers:", error);
   }
   handlebars.registerHelper("upper", function(str) {
     return String(str || "").toUpperCase();
@@ -138,13 +144,15 @@ export function compilePdfComponent(templateName, ctx, messages, templateSources
 function enrichContextForTemplate(templateName, data) {
   const enriched = { ...data };
   if (templateName.toLowerCase().includes("invoice")) {
-    if (enriched.items && Array.isArray(enriched.items)) {
-      enriched.subtotal = enriched.items.reduce((sum, item) => {
-        return sum + item.quantity * item.price;
-      }, 0);
-      enriched.tax = enriched.subtotal * (enriched.taxRate || 0.1);
-      enriched.total = enriched.subtotal + enriched.tax;
-      if (enriched.issueDate && enriched.paymentTerms) {
+    if (Array.isArray(enriched.items)) {
+      const items = enriched.items;
+      const subtotal = items.reduce((sum, item) => sum + item.quantity * item.price, 0);
+      const taxRate = typeof enriched.taxRate === "number" ? enriched.taxRate : 0.1;
+      const tax = subtotal * taxRate;
+      enriched.subtotal = subtotal;
+      enriched.tax = tax;
+      enriched.total = subtotal + tax;
+      if (enriched.issueDate && typeof enriched.paymentTerms === "number") {
         const issueDate = new Date(enriched.issueDate);
         const dueDate = new Date(issueDate);
         dueDate.setDate(dueDate.getDate() + enriched.paymentTerms);
@@ -153,9 +161,10 @@ function enrichContextForTemplate(templateName, data) {
     }
   }
   if (templateName.toLowerCase().includes("salesreport")) {
-    if (enriched.salesData && Array.isArray(enriched.salesData)) {
-      enriched.quarters = calculateQuarters(enriched.salesData);
-      const totalSales = enriched.salesData.reduce((sum, item) => sum + item.amount, 0);
+    if (Array.isArray(enriched.salesData)) {
+      const salesData = enriched.salesData;
+      enriched.quarters = calculateQuarters(salesData);
+      const totalSales = salesData.reduce((sum, item) => sum + item.amount, 0);
       enriched.rating = calculatePerformanceRating(totalSales);
     }
   }

package/dist/runtime/utils/providers.d.ts

@@ -1,2 +1,2 @@
-import type { PdfProvider } from '../types.js';
-export declare function createPdfProvider(providerType: string, config: any): PdfProvider;
+import type { PdfProvider, PdfProviderConfig } from '../types.js';
+export declare function createPdfProvider(providerType: string, config: Partial<PdfProviderConfig>): PdfProvider;

package/dist/runtime/utils/providers.js

@@ -29,10 +29,10 @@ class GotenbergProvider {
       form.append("paperHeight", dimensions.height);
     }
     if (options.margin) {
-      form.append("marginTop", (options.margin.top / 25.4).toString());
-      form.append("marginBottom", (options.margin.bottom / 25.4).toString());
-      form.append("marginLeft", (options.margin.left / 25.4).toString());
-      form.append("marginRight", (options.margin.right / 25.4).toString());
+      form.append("marginTop", ((options.margin.top ?? 0) / 25.4).toString());
+      form.append("marginBottom", ((options.margin.bottom ?? 0) / 25.4).toString());
+      form.append("marginLeft", ((options.margin.left ?? 0) / 25.4).toString());
+      form.append("marginRight", ((options.margin.right ?? 0) / 25.4).toString());
     }
     if (options.landscape) {
       form.append("landscape", "true");
@@ -97,22 +97,58 @@ class PuppeteerProvider {
   constructor(config) {
     this.config = config;
   }
+  // Launching a full Chromium per request is slow and flaky (especially on CI),
+  // so we keep one browser alive and reuse it, relaunching if it disconnects.
+  static browser = null;
+  static launching = null;
+  async getBrowser() {
+    const existing = PuppeteerProvider.browser;
+    if (existing?.connected) {
+      return existing;
+    }
+    if (!PuppeteerProvider.launching) {
+      PuppeteerProvider.launching = (async () => {
+        const puppeteer = await import("puppeteer").then((m) => m.default);
+        const launchOptions = this.config.launchOptions;
+        const browser = await puppeteer.launch({
+          // `--disable-dev-shm-usage` avoids Chromium exhausting the small
+          // /dev/shm tmpfs in CI/Docker, a common cause of hangs and crashes.
+          ...launchOptions,
+          args: ["--disable-dev-shm-usage", ...launchOptions?.args ?? []]
+        });
+        PuppeteerProvider.browser = browser;
+        browser.on("disconnected", () => {
+          PuppeteerProvider.browser = null;
+        });
+        return browser;
+      })();
+      try {
+        await PuppeteerProvider.launching;
+      } finally {
+        PuppeteerProvider.launching = null;
+      }
+    } else {
+      await PuppeteerProvider.launching;
+    }
+    return PuppeteerProvider.browser;
+  }
   async generatePdf(html, options) {
-    const puppeteer = await import("puppeteer").then((m) => m.default);
-    const browser = await puppeteer.launch(this.config.launchOptions);
+    const browser = await this.getBrowser();
+    const page = await browser.newPage();
     try {
-      const page = await browser.newPage();
-      await page.setContent(html, { waitUntil: "networkidle0" });
+      await page.setContent(html, { waitUntil: "domcontentloaded", timeout: 3e4 });
       const pdfOptions = {
         format: options.format || "A4",
         margin: options.margin,
         landscape: options.landscape || false,
-        printBackground: options.printBackground !== false
+        printBackground: options.printBackground !== false,
+        timeout: 3e4
       };
       const pdfBuffer = await page.pdf(pdfOptions);
       return Buffer.from(pdfBuffer);
     } finally {
-      await browser.close();
+      await page.close().catch(() => {
+      });
     }
   }
 }

package/package.json

@@ -1,50 +1,39 @@
 {
   "name": "@maistik/nuxt-pdf",
-  "version": "1.0.17",
-  "description": "A Nuxt 3 module for server-side PDF generation using Handlebars templates",
+  "version": "1.1.4",
+  "description": "A Nuxt 3 & 4 module for server-side PDF generation using Handlebars templates",
   "type": "module",
   "private": false,
   "main": "./dist/module.mjs",
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "nuxt-module-build prepare && nuxt-module-build build",
-    "dev": "nuxi dev playground",
-    "dev:build": "nuxi build playground",
-    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-    "release": "npm run lint && npm run test:unit && npm run prepack && changelogen --release && npm publish --access public && git push --follow-tags",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "test": "vitest run && playwright test",
-    "test:watch": "vitest watch",
-    "test:unit": "vitest run",
-    "test:e2e": "playwright test",
-    "test:e2e:ui": "playwright test --ui",
-    "prepack": "nuxt-module-build build"
+  "engines": {
+    "node": ">=22.0.0"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.17.7",
-    "handlebars": "^4.7.8",
-    "puppeteer": "^24.14.0",
-    "form-data": "^4.0.4"
+    "@nuxt/kit": "^4.4.8",
+    "handlebars": "^4.7.9",
+    "puppeteer": "^25.1.0",
+    "form-data": "^4.0.6"
   },
   "devDependencies": {
     "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^1.6.0",
-    "@nuxt/module-builder": "^1.0.1",
-    "@nuxt/schema": "^3.17.7",
-    "@nuxt/test-utils": "^3.19.2",
-    "@playwright/test": "^1.49.1",
+    "@nuxt/eslint-config": "^1.16.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.4.8",
+    "@nuxt/test-utils": "^4.0.3",
+    "@playwright/test": "^1.60.0",
     "changelogen": "^0.6.2",
-    "eslint": "^9.31.0",
-    "nuxt": "^3.17.7",
-    "unbuild": "^3.5.0",
-    "vitest": "^3.2.4"
+    "eslint": "^10.5.0",
+    "nuxt": "^4.4.8",
+    "unbuild": "^3.6.1",
+    "vitest": "^4.1.8"
   },
   "keywords": [
     "nuxt",
     "nuxt3",
+    "nuxt4",
     "pdf",
     "handlebars",
     "gotenberg",
@@ -57,5 +46,18 @@
     "type": "git",
     "url": "https://github.com/Maistik-Studio/nuxt-pdf"
   },
-  "packageManager": "pnpm@9.15.3"
-}
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test:unit && npm run prepack && changelogen --release && npm publish --access public && git push --follow-tags",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run && playwright test",
+    "test:watch": "vitest watch",
+    "test:unit": "vitest run",
+    "test:e2e": "playwright test",
+    "test:e2e:ui": "playwright test --ui"
+  }
+}