@shad0wz7/nestjs-pdf 3.2.0 → 4.0.0

package/dist/index.mjs

@@ -1,3 +1,4 @@
+import { createRequire } from "node:module";
 import { basename, dirname, extname, isAbsolute, join, relative, resolve, sep } from "node:path";
 import { Inject, Injectable, Logger, Module, Optional } from "@nestjs/common";
 import { PDFArray, PDFDict, PDFDocument, PDFName, PDFNumber, PDFString, StandardFonts, degrees, rgb } from "pdf-lib";
@@ -8,13 +9,6 @@ import { BlockList, isIP } from "node:net";
 import { fileURLToPath } from "node:url";
 import { TargetType, launch } from "puppeteer";
 import { Browser as Browser$1, BrowserPlatform, canDownload, detectBrowserPlatform, getInstalledBrowsers, install, resolveBuildId } from "@puppeteer/browsers";
-import ejs from "ejs";
-import { Eta } from "eta";
-import Handlebars from "handlebars";
-import mjml from "mjml";
-import mustache from "mustache";
-import nunjucks from "nunjucks";
-import pug from "pug";
 //#region src/exceptions/nestjs-pdf.exception.ts
 let NestjsPdfErrorCode = /* @__PURE__ */ function(NestjsPdfErrorCode) {
 	NestjsPdfErrorCode["ENGINE_NOT_AVAILABLE"] = "ENGINE_NOT_AVAILABLE";
@@ -48,8 +42,8 @@ var BrowserUnavailableException = class extends NestjsPdfException {
 //#region src/exceptions/engine-not-available.exception.ts
 var EngineNotAvailableException = class extends NestjsPdfException {
 	code = "ENGINE_NOT_AVAILABLE";
-	constructor(engineName) {
-		super(`${engineName} service is not available. If the problem persists, open an issue in the repo.`);
+	constructor(engineName, packageName, options) {
+		super(packageName ? `${engineName} engine is not available: the '${packageName}' package is not installed. Run \`npm install ${packageName}\` to use it.` : `${engineName} service is not available. If the problem persists, open an issue in the repo.`, options);
 	}
 };
 //#endregion
@@ -449,7 +443,7 @@ var Queue = class {
 	}
 };
 //#endregion
-//#region node_modules/.pnpm/p-limit@7.3.2/node_modules/p-limit/index.js
+//#region node_modules/.pnpm/p-limit@7.3.3/node_modules/p-limit/index.js
 function pLimit(concurrency) {
 	let rejectOnClear = false;
 	if (typeof concurrency === "object") ({concurrency, rejectOnClear = false} = concurrency);
@@ -508,7 +502,17 @@ function pLimit(concurrency) {
 			}
 		},
 		map: { async value(iterable, function_) {
-			const promises = Array.from(iterable, (value, index) => generator(function_, value, index));
+			const promises = [];
+			try {
+				Array.from(iterable, (value, index) => {
+					const promise = generator(function_, value, index);
+					promises.push(promise);
+					return promise;
+				});
+			} catch (error) {
+				for (const promise of promises) promise.catch(() => {});
+				throw error;
+			}
 			return Promise.all(promises);
 		} }
 	});
@@ -675,19 +679,19 @@ async function installRequestGuard(context, page, options) {
 //#region src/helpers/tokens.ts
 const PDF_PARAMETERS = "PDF_PARAMETERS";
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateMetadata.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/decorateMetadata.js
 function __decorateMetadata(k, v) {
 	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorateParam.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/decorateParam.js
 function __decorateParam(paramIndex, decorator) {
 	return function(target, key) {
 		decorator(target, key, paramIndex);
 	};
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.149.0/helpers/esm/decorate.js
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/decorate.js
 function __decorate(decorators, target, key, desc) {
 	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
 	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -962,11 +966,34 @@ BrowserService = __decorate([
 	__decorateMetadata("design:paramtypes", [Object])
 ], BrowserService);
 //#endregion
+//#region src/puppeteer/libs/loadEngine.utils.ts
+const requireEngine = createRequire(import.meta.url);
+/**
+* Load an optional template engine on first use, so the library can be imported
+* without every engine installed. `require` (not `import()`) is used on purpose:
+* most engines expose a synchronous render API.
+*/
+function loadEngine(packageName, engineName) {
+	let mod;
+	try {
+		mod = requireEngine(packageName);
+	} catch (error) {
+		if (error.code === "MODULE_NOT_FOUND") throw new EngineNotAvailableException(engineName, packageName, { cause: error });
+		throw error;
+	}
+	return mod.__esModule && "default" in mod ? mod.default : mod;
+}
+//#endregion
 //#region src/puppeteer/engines/ejs/ejs.service.ts
 let EjsService = class EjsService {
+	#ejs;
+	get #engine() {
+		return this.#ejs ??= loadEngine("ejs", "EJS");
+	}
 	async render(template, data = {}, options) {
+		const engine = this.#engine;
 		try {
-			return await ejs.render(template, data, {
+			return await engine.render(template, data, {
 				async: true,
 				...options
 			});
@@ -975,8 +1002,9 @@ let EjsService = class EjsService {
 		}
 	}
 	async renderFile(filePath, data = {}, options) {
+		const engine = this.#engine;
 		try {
-			return await ejs.renderFile(filePath, data, {
+			return await engine.renderFile(filePath, data, {
 				async: true,
 				...options
 			});
@@ -989,15 +1017,12 @@ EjsService = __decorate([Injectable()], EjsService);
 //#endregion
 //#region src/puppeteer/engines/eta/eta.service.ts
 let EtaService = class EtaService {
+	#etaModule;
 	#eta;
 	#templateCache = /* @__PURE__ */ new Map();
 	#maxCacheSize = 100;
-	constructor() {
-		this.#eta = new Eta({
-			cache: true,
-			autoEscape: true,
-			useWith: true
-		});
+	get #engine() {
+		return this.#etaModule ??= loadEngine("eta", "Eta");
 	}
 	/**
 	* Render an Eta template from a string
@@ -1007,6 +1032,7 @@ let EtaService = class EtaService {
 	* @returns The rendered HTML string
 	*/
 	render(template, data = {}, options) {
+		const { Eta } = this.#engine;
 		try {
 			return (options && Object.keys(options).length > 0 ? new Eta({
 				cache: true,
@@ -1014,7 +1040,11 @@ let EtaService = class EtaService {
 				useWith: true,
 				...options,
 				varName: options.varName ?? "it"
-			}) : this.#eta).renderString(template, data);
+			}) : this.#eta ??= new Eta({
+				cache: true,
+				autoEscape: true,
+				useWith: true
+			})).renderString(template, data);
 		} catch (error) {
 			throw new TemplateRenderException("Eta", `Eta rendering failed: ${String(error)}`, { cause: error });
 		}
@@ -1037,6 +1067,7 @@ let EtaService = class EtaService {
 			}
 			return this.render(template, data, options);
 		} catch (error) {
+			if (error instanceof EngineNotAvailableException) throw error;
 			throw new TemplateRenderException("Eta", `Eta file rendering failed for ${filePath}: ${String(error)}`, { cause: error });
 		}
 	}
@@ -1054,12 +1085,16 @@ let EtaService = class EtaService {
 		return this.#templateCache.size;
 	}
 };
-EtaService = __decorate([Injectable(), __decorateMetadata("design:paramtypes", [])], EtaService);
+EtaService = __decorate([Injectable()], EtaService);
 //#endregion
 //#region src/puppeteer/engines/handlebars/handlebars.service.ts
 let HandlebarsService = class HandlebarsService {
+	#handlebars;
 	#cachedOptions;
 	#cachedEnv;
+	get #engine() {
+		return this.#handlebars ??= loadEngine("handlebars", "Handlebars");
+	}
 	render(template, parameters = {}, options = {}) {
 		try {
 			return this.#getEnv(options).compile(template, options.compileOptions)(parameters, options.templateOptions);
@@ -1088,7 +1123,7 @@ let HandlebarsService = class HandlebarsService {
 	*/
 	#getEnv(options) {
 		if (this.#cachedEnv && this.#cachedOptions === options) return this.#cachedEnv;
-		const env = Handlebars.create();
+		const env = this.#engine.create();
 		for (const helper of options.helpers ?? []) env.registerHelper(helper.name, helper.fn);
 		this.#registerPartials(env, options.partialDirectory);
 		this.#cachedOptions = options;
@@ -1108,11 +1143,78 @@ let HandlebarsService = class HandlebarsService {
 };
 HandlebarsService = __decorate([Injectable()], HandlebarsService);
 //#endregion
+//#region src/puppeteer/engines/liquid/liquid.service.ts
+let LiquidService = class LiquidService {
+	#liquidModule;
+	#liquid;
+	#templateCache = /* @__PURE__ */ new Map();
+	#maxCacheSize = 100;
+	get #engine() {
+		return this.#liquidModule ??= loadEngine("liquidjs", "Liquid");
+	}
+	/**
+	* Render a Liquid template from a string
+	* @param template The template string to render
+	* @param data The data object to use for rendering
+	* @param options Optional Liquid engine options
+	* @returns The rendered HTML string
+	*/
+	render(template, data = {}, options) {
+		const { Liquid } = this.#engine;
+		try {
+			return (options && Object.keys(options).length > 0 ? new Liquid(options) : this.#liquid ??= new Liquid()).parseAndRenderSync(template, data);
+		} catch (error) {
+			throw new TemplateRenderException("Liquid", `Liquid rendering failed: ${String(error)}`, { cause: error });
+		}
+	}
+	/**
+	* Render a Liquid template from a file
+	* @param filePath The path to the template file
+	* @param data The data object to use for rendering
+	* @param options Optional Liquid engine options
+	* @returns The rendered HTML string
+	*/
+	renderFile(filePath, data = {}, options) {
+		try {
+			const resolvedPath = resolve(filePath);
+			const useCache = options?.cache !== false;
+			let template = useCache ? this.#templateCache.get(resolvedPath) : void 0;
+			if (!template) {
+				template = readFileSync(resolvedPath, "utf-8");
+				if (useCache && this.#templateCache.size < this.#maxCacheSize) this.#templateCache.set(resolvedPath, template);
+			}
+			return this.render(template, data, options);
+		} catch (error) {
+			if (error instanceof EngineNotAvailableException) throw error;
+			throw new TemplateRenderException("Liquid", `Liquid file rendering failed for ${filePath}: ${String(error)}`, { cause: error });
+		}
+	}
+	/**
+	* Clear the template cache
+	*/
+	clearCache() {
+		this.#templateCache.clear();
+	}
+	/**
+	* Get the current cache size
+	* @returns The number of cached templates
+	*/
+	getCacheSize() {
+		return this.#templateCache.size;
+	}
+};
+LiquidService = __decorate([Injectable()], LiquidService);
+//#endregion
 //#region src/puppeteer/engines/mjml/mjml.service.ts
 let MjmlService = class MjmlService {
+	#mjml;
+	get #engine() {
+		return this.#mjml ??= loadEngine("mjml", "MJML");
+	}
 	async render(template, options) {
+		const engine = this.#engine;
 		try {
-			const { html } = await mjml(template, options);
+			const { html } = await engine(template, options);
 			return html;
 		} catch (error) {
 			throw new TemplateRenderException("MJML", `MJML rendering failed: ${String(error)}`, { cause: error });
@@ -1132,8 +1234,12 @@ MjmlService = __decorate([Injectable()], MjmlService);
 //#endregion
 //#region src/puppeteer/engines/mustache/mustache.service.ts
 let MustacheService = class MustacheService {
+	#mustache;
 	#templateCache = /* @__PURE__ */ new Map();
 	#maxCacheSize = 100;
+	get #engine() {
+		return this.#mustache ??= loadEngine("mustache", "Mustache");
+	}
 	/**
 	* Render a Mustache template from a string
 	* @param template The template string to render
@@ -1142,9 +1248,10 @@ let MustacheService = class MustacheService {
 	* @returns The rendered HTML string
 	*/
 	render(template, data = {}, options) {
+		const engine = this.#engine;
 		try {
 			const tags = options?.tags ?? ["{{", "}}"];
-			return mustache.render(template, data, void 0, {
+			return engine.render(template, data, void 0, {
 				tags,
 				escape: options?.escape
 			});
@@ -1169,6 +1276,7 @@ let MustacheService = class MustacheService {
 			}
 			return this.render(template, data, options);
 		} catch (error) {
+			if (error instanceof EngineNotAvailableException) throw error;
 			throw new TemplateRenderException("Mustache", `Mustache file rendering failed for ${filePath}: ${String(error)}`, { cause: error });
 		}
 	}
@@ -1190,14 +1298,20 @@ MustacheService = __decorate([Injectable()], MustacheService);
 //#endregion
 //#region src/puppeteer/engines/nunjucks/nunjucks.service.ts
 let NunjucksService = class NunjucksService {
-	constructor() {
-		nunjucks.configure({
-			noCache: true,
-			trimBlocks: true,
-			lstripBlocks: true
-		});
+	#nunjucks;
+	get #engine() {
+		if (!this.#nunjucks) {
+			this.#nunjucks = loadEngine("nunjucks", "Nunjucks");
+			this.#nunjucks.configure({
+				noCache: true,
+				trimBlocks: true,
+				lstripBlocks: true
+			});
+		}
+		return this.#nunjucks;
 	}
 	render(template, data = {}, options) {
+		const nunjucks = this.#engine;
 		try {
 			if (options) {
 				const configOptions = {
@@ -1215,6 +1329,7 @@ let NunjucksService = class NunjucksService {
 		}
 	}
 	renderFile(filePath, data = {}, options) {
+		const nunjucks = this.#engine;
 		try {
 			if (options) {
 				const configOptions = {
@@ -1232,13 +1347,18 @@ let NunjucksService = class NunjucksService {
 		}
 	}
 };
-NunjucksService = __decorate([Injectable(), __decorateMetadata("design:paramtypes", [])], NunjucksService);
+NunjucksService = __decorate([Injectable()], NunjucksService);
 //#endregion
 //#region src/puppeteer/engines/pug/pug.service.ts
 let PugService = class PugService {
+	#pug;
+	get #engine() {
+		return this.#pug ??= loadEngine("pug", "Pug");
+	}
 	render(template, data = {}, options) {
+		const engine = this.#engine;
 		try {
-			return pug.compile(template, { ...options })(data);
+			return engine.compile(template, { ...options })(data);
 		} catch (error) {
 			throw new TemplateRenderException("Pug", `Pug rendering failed: ${String(error)}`, { cause: error });
 		}
@@ -1248,6 +1368,7 @@ let PugService = class PugService {
 			const template = readFileSync(filePath, "utf-8");
 			return this.render(template, data, options);
 		} catch (error) {
+			if (error instanceof EngineNotAvailableException) throw error;
 			throw new TemplateRenderException("Pug", `Pug file rendering failed: ${String(error)}`, { cause: error });
 		}
 	}
@@ -1271,7 +1392,8 @@ let PuppeteerService = class PuppeteerService {
 	#nunjucksService;
 	#etaService;
 	#mustacheService;
-	constructor(browserService, options, hbsService, mjmlService, pugService, ejsService, nunjucksService, etaService, mustacheService) {
+	#liquidService;
+	constructor(browserService, options, hbsService, mjmlService, pugService, ejsService, nunjucksService, etaService, mustacheService, liquidService) {
 		this.#browserService = browserService;
 		this.#options = options;
 		this.#hbsService = hbsService;
@@ -1281,6 +1403,7 @@ let PuppeteerService = class PuppeteerService {
 		this.#nunjucksService = nunjucksService;
 		this.#etaService = etaService;
 		this.#mustacheService = mustacheService;
+		this.#liquidService = liquidService;
 	}
 	#limit = pLimit(3);
 	async generatePdfFromHtml(html, options) {
@@ -1443,6 +1566,14 @@ let PuppeteerService = class PuppeteerService {
 		const html = requireService(this.#mustacheService, "Mustache").renderFile(file, data, options?.mustacheOptions ?? this.#options.mustacheOptions);
 		return this.generatePdfFromHtml(html, options);
 	}
+	async generatePdfFromLiquidString(template, data = {}, options) {
+		const html = requireService(this.#liquidService, "Liquid").render(template, data, options?.liquidOptions ?? this.#options.liquidOptions);
+		return this.generatePdfFromHtml(html, options);
+	}
+	async generatePdfFromLiquidFile(file, data = {}, options) {
+		const html = requireService(this.#liquidService, "Liquid").renderFile(file, data, options?.liquidOptions ?? this.#options.liquidOptions);
+		return this.generatePdfFromHtml(html, options);
+	}
 };
 PuppeteerService = __decorate([
 	Injectable(),
@@ -1454,6 +1585,7 @@ PuppeteerService = __decorate([
 	__decorateParam(6, Optional()),
 	__decorateParam(7, Optional()),
 	__decorateParam(8, Optional()),
+	__decorateParam(9, Optional()),
 	__decorateMetadata("design:paramtypes", [
 		typeof BrowserService === "undefined" ? Object : BrowserService,
 		Object,
@@ -1463,7 +1595,8 @@ PuppeteerService = __decorate([
 		typeof EjsService === "undefined" ? Object : EjsService,
 		typeof NunjucksService === "undefined" ? Object : NunjucksService,
 		typeof EtaService === "undefined" ? Object : EtaService,
-		typeof MustacheService === "undefined" ? Object : MustacheService
+		typeof MustacheService === "undefined" ? Object : MustacheService,
+		typeof LiquidService === "undefined" ? Object : LiquidService
 	])
 ], PuppeteerService);
 //#endregion
@@ -1621,6 +1754,26 @@ let NestjsPdfService = class NestjsPdfService {
 		return this.#puppeteerService.generatePdfFromMustacheFile(file, data, options);
 	}
 	/**
+	* @param template Liquid template string
+	* @param data Data to inject into the template
+	* @param options PDF generation options (optional)
+	* @returns PDF generated from the provided Liquid template with data applied
+	* @description This method generates a PDF from a Liquid template provided as a string. Liquid is a safe, Shopify-compatible template language with filters, tags, partials and layouts. 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.
+	*/
+	generatePdfFromLiquidString(template, data = {}, options) {
+		return this.#puppeteerService.generatePdfFromLiquidString(template, data, options);
+	}
+	/**
+	* @param file Path to the Liquid template file
+	* @param data Data to inject into the template
+	* @param options PDF generation options (optional)
+	* @returns PDF generated from the Liquid template at the provided file path with data applied
+	* @description This method generates a PDF from a Liquid 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.
+	*/
+	generatePdfFromLiquidFile(file, data = {}, options) {
+		return this.#puppeteerService.generatePdfFromLiquidFile(file, data, options);
+	}
+	/**
 	* @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__')
@@ -1694,7 +1847,8 @@ let PuppeteerModule = _PuppeteerModule = class PuppeteerModule {
 				EjsService,
 				NunjucksService,
 				EtaService,
-				MustacheService
+				MustacheService,
+				LiquidService
 			],
 			exports: [
 				PuppeteerService,
@@ -1703,7 +1857,8 @@ let PuppeteerModule = _PuppeteerModule = class PuppeteerModule {
 				EjsService,
 				NunjucksService,
 				EtaService,
-				MustacheService
+				MustacheService,
+				LiquidService
 			]
 		};
 	}
@@ -1726,7 +1881,8 @@ let PuppeteerModule = _PuppeteerModule = class PuppeteerModule {
 				EjsService,
 				NunjucksService,
 				EtaService,
-				MustacheService
+				MustacheService,
+				LiquidService
 			],
 			exports: [
 				PuppeteerService,
@@ -1735,7 +1891,8 @@ let PuppeteerModule = _PuppeteerModule = class PuppeteerModule {
 				EjsService,
 				NunjucksService,
 				EtaService,
-				MustacheService
+				MustacheService,
+				LiquidService
 			]
 		};
 	}
@@ -1750,7 +1907,8 @@ PuppeteerModule = _PuppeteerModule = __decorate([
 			EjsService,
 			NunjucksService,
 			EtaService,
-			MustacheService
+			MustacheService,
+			LiquidService
 		],
 		exports: [
 			PuppeteerService,
@@ -1759,7 +1917,8 @@ PuppeteerModule = _PuppeteerModule = __decorate([
 			EjsService,
 			NunjucksService,
 			EtaService,
-			MustacheService
+			MustacheService,
+			LiquidService
 		]
 	}),
 	__decorateParam(1, Inject(PDF_PARAMETERS)),
@@ -1788,6 +1947,6 @@ let NestjsPdfModule = _NestjsPdfModule = class NestjsPdfModule {
 };
 NestjsPdfModule = _NestjsPdfModule = __decorate([Module({})], NestjsPdfModule);
 //#endregion
-export { BrowserInstallationException, BrowserUnavailableException, EjsService, EngineNotAvailableException, EtaService, HandlebarsService, MjmlService, MustacheService, NestjsPdfErrorCode, NestjsPdfException, NestjsPdfModule, NestjsPdfService, NunjucksService, PdfGenerationException, PugService, PuppeteerModule, PuppeteerService, SignatureDependencyException, SignaturePlacementException, TemplateConfigurationException, TemplateRenderException, WatermarkException, getRelativePathToValue };
+export { BrowserInstallationException, BrowserUnavailableException, EjsService, EngineNotAvailableException, EtaService, HandlebarsService, LiquidService, MjmlService, MustacheService, NestjsPdfErrorCode, NestjsPdfException, NestjsPdfModule, NestjsPdfService, NunjucksService, PdfGenerationException, PugService, PuppeteerModule, PuppeteerService, SignatureDependencyException, SignaturePlacementException, TemplateConfigurationException, TemplateRenderException, WatermarkException, getRelativePathToValue };
 
 //# sourceMappingURL=index.mjs.map