@shad0wz7/nestjs-pdf 3.0.0 → 3.1.0

package/dist/index.d.cts

@@ -8,6 +8,69 @@ import Handlebars from "handlebars";
 import { EscapeFunction } from "mustache";
 import { ConfigureOptions } from "nunjucks";
 import { LocalsObject, Options as Options$1 } from "pug";
+//#region src/exceptions/nestjs-pdf.exception.d.ts
+export declare enum NestjsPdfErrorCode {
+  ENGINE_NOT_AVAILABLE = "ENGINE_NOT_AVAILABLE",
+  TEMPLATE_CONFIGURATION_ERROR = "TEMPLATE_CONFIGURATION_ERROR",
+  TEMPLATE_RENDER_ERROR = "TEMPLATE_RENDER_ERROR",
+  BROWSER_INSTALLATION_ERROR = "BROWSER_INSTALLATION_ERROR",
+  BROWSER_UNAVAILABLE = "BROWSER_UNAVAILABLE",
+  PDF_GENERATION_ERROR = "PDF_GENERATION_ERROR",
+  SIGNATURE_DEPENDENCY_ERROR = "SIGNATURE_DEPENDENCY_ERROR",
+  SIGNATURE_PLACEMENT_ERROR = "SIGNATURE_PLACEMENT_ERROR"
+}
+export declare abstract class NestjsPdfException extends Error {
+  abstract readonly code: NestjsPdfErrorCode;
+  constructor(message: string, options?: {
+    cause?: unknown;
+  });
+}
+//#endregion
+//#region src/exceptions/browser-installation.exception.d.ts
+export declare class BrowserInstallationException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.BROWSER_INSTALLATION_ERROR;
+}
+//#endregion
+//#region src/exceptions/browser-unavailable.exception.d.ts
+export declare class BrowserUnavailableException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.BROWSER_UNAVAILABLE;
+}
+//#endregion
+//#region src/exceptions/engine-not-available.exception.d.ts
+export declare class EngineNotAvailableException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.ENGINE_NOT_AVAILABLE;
+  constructor(engineName: string);
+}
+//#endregion
+//#region src/exceptions/pdf-generation.exception.d.ts
+export declare class PdfGenerationException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.PDF_GENERATION_ERROR;
+}
+//#endregion
+//#region src/exceptions/signature-dependency.exception.d.ts
+export declare class SignatureDependencyException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.SIGNATURE_DEPENDENCY_ERROR;
+}
+//#endregion
+//#region src/exceptions/signature-placement.exception.d.ts
+export declare class SignaturePlacementException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.SIGNATURE_PLACEMENT_ERROR;
+}
+//#endregion
+//#region src/exceptions/template-configuration.exception.d.ts
+export declare class TemplateConfigurationException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.TEMPLATE_CONFIGURATION_ERROR;
+}
+//#endregion
+//#region src/exceptions/template-render.exception.d.ts
+export declare class TemplateRenderException extends NestjsPdfException {
+  readonly engine: string;
+  readonly code = NestjsPdfErrorCode.TEMPLATE_RENDER_ERROR;
+  constructor(engine: string, message: string, options?: {
+    cause?: unknown;
+  });
+}
+//#endregion
 //#region src/helpers/getRelativePath.helper.d.ts
 /**
  * Get the relative path to a value from the module directory.
@@ -18,7 +81,7 @@ import { LocalsObject, Options as Options$1 } from "pug";
  * 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 declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
 //#endregion
 //#region src/puppeteer/browser/browser.service.d.ts
 declare enum BrowserTag {
@@ -30,57 +93,39 @@ declare enum BrowserTag {
 }
 type Headless = boolean | 'shell' | undefined;
 declare class BrowserService implements OnModuleDestroy {
-  private readonly cacheDir;
-  private readonly options?;
-  private _browserInstance;
-  private browser;
+  #private;
   activeJobs: number;
   totalJobs: number;
-  private recycleRequested;
-  private recycling;
-  private shuttingDown;
   /** Max time to wait for in-flight PDF jobs to finish before closing the browser on shutdown. */
   shutdownDrainTimeoutMs: number;
-  private browserTag;
-  private useLockedBrowser;
-  private buildId;
   constructor(pdfParams: PuppeteerParameters);
   onModuleDestroy(): Promise<void>;
-  /** Wait until no PDF job is in flight, or until the timeout elapses. */
-  private waitForIdle;
   getBrowserInstance(args: Array<string>, headless: boolean | 'shell' | undefined, executablePathBin: string | undefined): Promise<Browser$1>;
   createContext(args: Array<string>, headless: Headless, executablePath?: string): Promise<BrowserContext>;
   markJobStarted(): void;
   markJobFinished(): Promise<void>;
   recycleBrowserIfNeeded(): Promise<void>;
-  private cleanupCacheBestEffort;
   install(lock?: boolean): Promise<import("@puppeteer/browsers").InstalledBrowser | null | undefined>;
-  private loadBrowser;
   getBrowser(): Browser;
-  private loadBrowserTag;
-  private loadBuildId;
   setBrowserTag(browserTag: BrowserTag): void;
   getBrowserTag(): BrowserTag;
   getBuildId(): string | undefined;
-  private loadUseLockedBrowser;
   hasBrowserInstalled(browser: Browser, buildId: string): Promise<boolean>;
   getExecutablePath(): Promise<string>;
-  private launchBrowser;
-  private writeLockFile;
   getLockedBuildId(browser: Browser): string | null;
 }
 //#endregion
 //#region src/puppeteer/engines/ejs/ejs.service.d.ts
-interface EjsOptions extends Omit<Options, 'async'> {
+export interface EjsOptions extends Omit<Options, 'async'> {
   async?: boolean;
 }
-declare class EjsService {
+export declare class EjsService {
   render(template: string, data?: Data, options?: EjsOptions): Promise<string>;
   renderFile(filePath: string, data?: Data, options?: EjsOptions): Promise<string>;
 }
 //#endregion
 //#region src/puppeteer/engines/eta/eta.service.d.ts
-interface EtaOptions extends Partial<EtaConfig> {
+export interface EtaOptions extends Partial<EtaConfig> {
   cache?: boolean;
   autoEscape?: boolean;
   varName?: string;
@@ -88,10 +133,8 @@ interface EtaOptions extends Partial<EtaConfig> {
   useWith?: boolean;
   plugins?: Array<any>;
 }
-declare class EtaService {
-  private readonly eta;
-  private readonly templateCache;
-  private readonly maxCacheSize;
+export declare class EtaService {
+  #private;
   constructor();
   /**
    * Render an Eta template from a string
@@ -121,11 +164,11 @@ declare class EtaService {
 }
 //#endregion
 //#region src/puppeteer/engines/handlebars/handlebars.service.d.ts
-type HandlebarsHelper = {
+export type HandlebarsHelper = {
   name: string;
   fn: Handlebars.HelperDelegate;
 };
-interface HandlebarsOptions {
+export interface HandlebarsOptions {
   /** Base directory (relative to `process.cwd()`) used to resolve files passed to `renderFile`. */
   templateDirectory?: string;
   /** Directory (relative to `process.cwd()`) whose files are each registered as a partial. */
@@ -141,28 +184,19 @@ interface HandlebarsOptions {
   /** Custom helpers registered on the isolated Handlebars environment for this render. */
   helpers?: Array<HandlebarsHelper>;
 }
-declare class HandlebarsService {
-  private cachedOptions?;
-  private cachedEnv?;
+export declare class HandlebarsService {
+  #private;
   render(template: string, parameters?: unknown, options?: HandlebarsOptions): string;
   renderFile(file: string, parameters?: unknown, options?: HandlebarsOptions): string;
-  /**
-   * Build an isolated Handlebars environment with the given helpers/partials so
-   * nothing leaks into the global Handlebars. Memoised for the common case where
-   * the same options object is reused across calls (e.g. the module `hbsOptions`).
-   */
-  private getEnv;
-  private registerPartials;
 }
 //#endregion
 //#region src/puppeteer/engines/mustache/mustache.service.d.ts
-interface MustacheOptions {
+export interface MustacheOptions {
   tags?: [string, string];
   escape?: EscapeFunction;
 }
-declare class MustacheService {
-  private readonly templateCache;
-  private readonly maxCacheSize;
+export declare class MustacheService {
+  #private;
   /**
    * Render a Mustache template from a string
    * @param template The template string to render
@@ -191,28 +225,28 @@ declare class MustacheService {
 }
 //#endregion
 //#region src/puppeteer/engines/nunjucks/nunjucks.service.d.ts
-interface NunjucksOptions extends Partial<ConfigureOptions> {
+export interface NunjucksOptions extends Partial<ConfigureOptions> {
   noCache?: boolean;
   watch?: boolean;
   throwOnUndefined?: boolean;
   trimBlocks?: boolean;
   lstripBlocks?: boolean;
 }
-declare class NunjucksService {
+export declare class NunjucksService {
   constructor();
   render(template: string, data?: Record<string, unknown>, options?: NunjucksOptions): string;
   renderFile(filePath: string, data?: Record<string, unknown>, options?: NunjucksOptions): string;
 }
 //#endregion
 //#region src/puppeteer/engines/pug/pug.service.d.ts
-type PugOptions = Options$1;
-declare class PugService {
+export type PugOptions = Options$1;
+export declare class PugService {
   render(template: string, data?: LocalsObject, options?: PugOptions): string;
   renderFile(filePath: string, data?: LocalsObject, options?: PugOptions): string;
 }
 //#endregion
 //#region src/puppeteer/puppeteer-parameters.interface.d.ts
-interface PuppeteerParameters {
+export interface PuppeteerParameters {
   pdfOptions?: PDFOptions;
   hbsOptions?: HandlebarsOptions;
   mjmlOptions?: MJMLParsingOptions;
@@ -234,34 +268,25 @@ interface PuppeteerParameters {
 }
 //#endregion
 //#region src/nestjs-pdf.module.d.ts
-interface PdfLibModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+export interface PdfLibModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
   inject?: Array<any>;
   useFactory: (...args: Array<any>) => any;
 }
-declare class NestjsPdfModule {
+export declare class NestjsPdfModule {
   static forRoot(options: PuppeteerParameters): DynamicModule;
   static forRootAsync(options: PdfLibModuleAsyncOptions): DynamicModule;
 }
 //#endregion
 //#region src/puppeteer/engines/mjml/mjml.service.d.ts
-declare class MjmlService {
+export declare class MjmlService {
   render(template: string, options?: MJMLParsingOptions): Promise<string>;
   renderFile(filePath: string, options?: MJMLParsingOptions): Promise<string>;
 }
 //#endregion
 //#region src/puppeteer/puppeteer.service.d.ts
-declare class PuppeteerService {
-  private readonly browserService;
-  private readonly options;
-  private readonly hbsService?;
-  private readonly mjmlService?;
-  private readonly pugService?;
-  private readonly ejsService?;
-  private readonly nunjucksService?;
-  private readonly etaService?;
-  private readonly mustacheService?;
-  constructor(browserService: BrowserService, options: PuppeteerParameters, hbsService?: HandlebarsService | undefined, mjmlService?: MjmlService | undefined, pugService?: PugService | undefined, ejsService?: EjsService | undefined, nunjucksService?: NunjucksService | undefined, etaService?: EtaService | undefined, mustacheService?: MustacheService | undefined);
-  private readonly limit;
+export declare class PuppeteerService {
+  #private;
+  constructor(browserService: BrowserService, options: PuppeteerParameters, hbsService?: HandlebarsService, mjmlService?: MjmlService, pugService?: PugService, ejsService?: EjsService, nunjucksService?: NunjucksService, etaService?: EtaService, mustacheService?: MustacheService);
   generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array>;
   generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
   generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
@@ -280,8 +305,8 @@ declare class PuppeteerService {
 }
 //#endregion
 //#region src/nestjs-pdf.service.d.ts
-declare class NestjsPdfService {
-  private readonly puppeteerService;
+export declare class NestjsPdfService {
+  #private;
   constructor(puppeteerService: PuppeteerService);
   /**
    * @param html HTML string to convert to PDF
@@ -426,18 +451,16 @@ declare class NestjsPdfService {
 }
 //#endregion
 //#region src/puppeteer/puppeteer.module.d.ts
-interface PuppeteerModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+export interface PuppeteerModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
   inject?: Array<InjectionToken | OptionalFactoryDependency>;
   useFactory: (...args: Array<any>) => Promise<PuppeteerParameters> | PuppeteerParameters;
 }
-declare class PuppeteerModule implements OnModuleInit {
-  private readonly browserService;
-  private readonly pdfParams;
+export declare class PuppeteerModule implements OnModuleInit {
+  #private;
   constructor(browserService: BrowserService, pdfParams: PuppeteerParameters);
   onModuleInit(): Promise<void>;
   static forRoot(pdfParameters: PuppeteerParameters): DynamicModule;
   static forRootAsync(options: PuppeteerModuleAsyncOptions): DynamicModule;
 }
 //#endregion
-export { EjsOptions, EjsService, EtaOptions, EtaService, HandlebarsHelper, HandlebarsOptions, HandlebarsService, MjmlService, MustacheOptions, MustacheService, NestjsPdfModule, NestjsPdfService, NunjucksOptions, NunjucksService, PdfLibModuleAsyncOptions, PugOptions, PugService, PuppeteerModule, PuppeteerModuleAsyncOptions, PuppeteerParameters, PuppeteerService, getRelativePathToValue };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/helpers/getRelativePath.helper.ts","../src/puppeteer/browser/browser.service.ts","../src/puppeteer/engines/ejs/ejs.service.ts","../src/puppeteer/engines/eta/eta.service.ts","../src/puppeteer/engines/handlebars/handlebars.service.ts","../src/puppeteer/engines/mustache/mustache.service.ts","../src/puppeteer/engines/nunjucks/nunjucks.service.ts","../src/puppeteer/engines/pug/pug.service.ts","../src/puppeteer/puppeteer-parameters.interface.ts","../src/nestjs-pdf.module.ts","../src/puppeteer/engines/mjml/mjml.service.ts","../src/puppeteer/puppeteer.service.ts","../src/nestjs-pdf.service.ts","../src/puppeteer/puppeteer.module.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;iBAWgB,uBACd,mBACA;;;aCIU;EACV;EACA;EACA;EACA;EACA;;KAGU;cAqCC,0BAA0B;mBACpB;mBACA;UAET;UACA;EAED;EACA;UAEC;UACA;UAEA;;EAED;UAEC;UACA;UACA;EAE8B,YAAA,WAAW;EAU3C,mBAAe;;UAsBP;EAaR,mBACJ,MAAM,eACN,yCACA,wCAAqC,QAAA;EAajC,cACJ,MAAM,eACN,UAAU,UACV,0BACC,QAAQ;EA2BX;EAaM,mBAAe;EAKf,0BAAsB;UA6Bd;EA6BR,QAAQ,iBAAqB,sCAAA;UA2D3B;EAUD,cAAc;UAIb;UAcA;EAUD,cAAc,YAAY;EAI1B,iBAAiB;EAIxB;UAIQ;EAUF,oBAAoB,SAAS,SAAa,kBAAe;EAWzD,qBAAqB;UA2Bb;UAwBN;EAYR,iBAAiB,SAAS;;;;UCzbX,mBAAmB,KAAK;EACvC;;cAIW;EACL,OAAO,kBAAkB,OAAM,MAAW,UAAU,aAAU;EAa9D,WAAW,kBAAkB,OAAM,MAAW,UAAU,aAAU;;;;UChBzD,mBAAmB,QAAQ;EAC1C;EACA;EACA;EACA;EACA;EACA,UAAU;;cAIC;mBACM;mBACA;mBACA;;;;;;;;;EAiBjB,OACE,kBACA,OAAM,yBACN,UAAU;;;;;;;;EA6BZ,WACE,kBACA,OAAM,yBACN,UAAU;;;;EA8BZ;;;;;EAQA;;;;KCvGU;EACV;EACA,IAAI,WAAW;;UAGA;;EAEf;;EAEA;;;;;;EAMA,kBAAkB,KAAK,WAAW;;EAElC,iBAAiB;;EAEjB,UAAU,MAAM;;cAIL;UACH;UACA;EAER,OACE,kBACA,sBACA,UAAS;EAeX,WACE,cACA,sBACA,UAAS;;;;;;UAiCH;UAiBA;;;;UClGO;EACf;EACA,SAAS;;cAIE;mBACM;mBACA;;;;;;;;EASjB,OACE,kBACA,OAAM,yBACN,UAAU;;;;;;;;EAsBZ,WACE,kBACA,OAAM,yBACN,UAAU;;;;EA4BZ;;;;;EAQA;;;;UCpFe,wBAAwB,QAAQ;EAC/C;EACA;EACA;EACA;EACA;;cAIW;;EAUX,OACE,kBACA,OAAM,yBACN,UAAU;EAqBZ,WACE,kBACA,OAAM,yBACN,UAAU;;;;KC5CF,aAAa;cAGZ;EACX,OACE,kBACA,OAAM,cACN,UAAU;EAcZ,WACE,kBACA,OAAM,cACN,UAAU;;;;UCjBG;EACf,aAAa;EACb,aAAa;EACb,cAAc;EACd,aAAa;EACb,aAAa;EACb,kBAAkB;EAClB,aAAa;EACb,kBAAkB;EAClB;EACA;EACA;EACA,UAAU;EACV,aAAa;EACb;EACA;EACA,qBAAqB;EACrB;EACA;;;;UCxBe,iCAAiC,KAChD;EAGA,SAAS;EACT,gBAAgB,MAAM;;cAIX;SACJ,QAAQ,SAAS,sBAAsB;SASvC,aAAa,SAAS,2BAA2B;;;;cClB7C;EACL,OACJ,kBACA,UAAU,qBACT;EAKG,WACJ,kBACA,UAAU,qBACT;;;;cCCQ;mBAEQ;mBACwB;mBACZ;mBACA;mBACA;mBACA;mBACA;mBACA;mBACA;EARZ,YAAA,gBAAgB,gBACQ,SAAS,qBACrB,aAAa,+BACb,cAAc,yBACd,aAAa,wBACb,aAAa,wBACb,kBAAkB,6BAClB,aAAa,wBACb,kBAAkB;mBAGhC;EAEX,oBACJ,cACA,UAAU,sBACT,QAAQ;EA+FL,iCACJ,kBACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;EAWzB,+BACJ,cACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;EAWzB,0BACJ,kBACA,UAAU,sBAAmB,QAAA,WAAA;EAUzB,wBAAwB,cAAc,UAAU,sBAAmB,QAAA,WAAA;EASnE,yBACJ,kBACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,uBACJ,cACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,yBACJ,kBACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,uBACJ,cACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,8BACJ,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,4BACJ,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,yBACJ,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,uBACJ,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,8BACJ,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,4BACJ,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;cC9SpB;mBACkB;EAAA,YAAA,kBAAkB;;;;;;;EAQ/C,oBAAoB,cAAc,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAW/D,iCACE,kBACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,+BACE,cACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;;;;;;;EAe/B,0BAA0B,kBAAkB,UAAU,sBAAmB,QAAA,WAAA;;;;;;;EAUzE,wBAAwB,cAAc,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAWnE,yBACE,kBACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,uBACE,cACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAY/B,yBACE,kBACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,uBACE,cACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAY/B,8BACE,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,4BACE,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,yBACE,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,uBACE,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAY/B,8BACE,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,4BACE,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;;;;;;;;;;;;;;;;EA+BzB,oCACJ,KAAK,aAAa,QAClB,oBACA,sBAA4C,QAAA,WAAA;;;;UCnQ/B,oCAAoC,KACnD;EAGA,SAAS,MAAM,iBAAiB;EAChC,gBACK,MAAM,eACN,QAAQ,uBAAuB;;cAwBzB,2BAA2B;mBAEnB;mBACwB;EADxB,YAAA,gBAAgB,gBACQ,WAAW;EAGhD,gBAAY;SAQX,QAAQ,eAAe,sBAAsB;SA+B7C,aAAa,SAAS,8BAA8B"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/exceptions/nestjs-pdf.exception.ts","../src/exceptions/browser-installation.exception.ts","../src/exceptions/browser-unavailable.exception.ts","../src/exceptions/engine-not-available.exception.ts","../src/exceptions/pdf-generation.exception.ts","../src/exceptions/signature-dependency.exception.ts","../src/exceptions/signature-placement.exception.ts","../src/exceptions/template-configuration.exception.ts","../src/exceptions/template-render.exception.ts","../src/helpers/getRelativePath.helper.ts","../src/puppeteer/browser/browser.service.ts","../src/puppeteer/engines/ejs/ejs.service.ts","../src/puppeteer/engines/eta/eta.service.ts","../src/puppeteer/engines/handlebars/handlebars.service.ts","../src/puppeteer/engines/mustache/mustache.service.ts","../src/puppeteer/engines/nunjucks/nunjucks.service.ts","../src/puppeteer/engines/pug/pug.service.ts","../src/puppeteer/puppeteer-parameters.interface.ts","../src/nestjs-pdf.module.ts","../src/puppeteer/engines/mjml/mjml.service.ts","../src/puppeteer/puppeteer.service.ts","../src/nestjs-pdf.service.ts","../src/puppeteer/puppeteer.module.ts"],"mappings":";;;;;;;;;;;oBAAY;EACV;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;8BAGoB,2BAA2B;oBAC7B,MAAM;EAEZ,YAAA,iBAAiB;IAAY;;;;;qBCZ9B,qCAAqC;WACvC,OAAI,mBAAA;;;;qBCDF,oCAAoC;WACtC,OAAI,mBAAA;;;;qBCDF,oCAAoC;WACtC,OAAI,mBAAA;EAED,YAAA;;;;qBCHD,+BAA+B;WACjC,OAAI,mBAAA;;;;qBCDF,qCAAqC;WACvC,OAAI,mBAAA;;;;qBCDF,oCAAoC;WACtC,OAAI,mBAAA;;;;qBCDF,uCAAuC;WACzC,OAAI,mBAAA;;;;qBCDF,gCAAgC;WAIzB;WAHT,OAAI,mBAAA;EAGK,YAAA,gBAChB,iBACA;IAAY;;;;;;;;;;;;;;wBCGA,uBACd,mBACA;;;aCSU;EACV;EACA;EACA;EACA;EACA;;KAGU;cAqCC,0BAA0B;;EAO9B;EACA;;EAOA;EAM+B,YAAA,WAAW;EAU3C,mBAAe;EAmCf,mBACJ,MAAM,eACN,yCACA,wCAAqC,QAAA;EAajC,cACJ,MAAM,eACN,UAAU,UACV,0BACC,QAAQ;EA2BX;EAeM,mBAAe;EAKf,0BAAsB;EA0DtB,QAAQ,iBAAqB,sCAAA;EAmF5B,cAAc;EA4Bd,cAAc,YAAY;EAI1B,iBAAiB;EAIxB;EAcM,oBAAoB,SAAS,SAAa,kBAAe;EAWzD,qBAAqB;EA+D3B,iBAAiB,SAAS;;;;iBC5cX,mBAAmB,KAAK;EACvC;;qBAIW;EACL,OAAO,kBAAkB,OAAM,MAAW,UAAU,aAAU;EAe9D,WAAW,kBAAkB,OAAM,MAAW,UAAU,aAAU;;;;iBClBzD,mBAAmB,QAAQ;EAC1C;EACA;EACA;EACA;EACA;EACA,UAAU;;qBAIC;;;;;;;;;;EAoBX,OACE,kBACA,OAAM,yBACN,UAAU;;;;;;;;EA+BZ,WACE,kBACA,OAAM,yBACN,UAAU;;;;EA6BZ;;;;;EAQA;;;;YCpGU;EACV;EACA,IAAI,WAAW;;iBAGA;;EAEf;;EAEA;;;;;;EAMA,kBAAkB,KAAK,WAAW;;EAElC,iBAAiB;;EAEjB,UAAU,MAAM;;qBAIL;;EAIX,OACE,kBACA,sBACA,UAAS;EAoBX,WACE,cACA,sBACA,UAAS;;;;iBCzDI;EACf;EACA,SAAS;;qBAIE;;;;;;;;;EAWX,OACE,kBACA,OAAM,yBACN,UAAU;;;;;;;;EAwBZ,WACE,kBACA,OAAM,yBACN,UAAU;;;;EA2BZ;;;;;EAQA;;;;iBCrFe,wBAAwB,QAAQ;EAC/C;EACA;EACA;EACA;EACA;;qBAIW;;EAUX,OACE,kBACA,OAAM,yBACN,UAAU;EAuBZ,WACE,kBACA,OAAM,yBACN,UAAU;;;;YC9CF,aAAa;qBAGZ;EACX,OACE,kBACA,OAAM,cACN,UAAU;EAgBZ,WACE,kBACA,OAAM,cACN,UAAU;;;;iBCrBG;EACf,aAAa;EACb,aAAa;EACb,cAAc;EACd,aAAa;EACb,aAAa;EACb,kBAAkB;EAClB,aAAa;EACb,kBAAkB;EAClB;EACA;EACA;EACA,UAAU;EACV,aAAa;EACb;EACA;EACA,qBAAqB;EACrB;EACA;;;;iBCxBe,iCAAiC,KAChD;EAGA,SAAS;EACT,gBAAgB,MAAM;;qBAIX;SACJ,QAAQ,SAAS,sBAAsB;SASvC,aAAa,SAAS,2BAA2B;;;;qBChB7C;EACL,OACJ,kBACA,UAAU,qBACT;EAaG,WACJ,kBACA,UAAU,qBACT;;;;qBCRQ;;EAYT,YAAA,gBAAgB,gBACQ,SAAS,qBACrB,aAAa,mBACb,cAAc,aACd,aAAa,YACb,aAAa,YACb,kBAAkB,iBAClB,aAAa,YACb,kBAAkB;EAe1B,oBACJ,cACA,UAAU,sBACT,QAAQ;EAuGL,iCACJ,kBACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;EAWzB,+BACJ,cACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;EAWzB,0BACJ,kBACA,UAAU,sBAAmB,QAAA,WAAA;EAUzB,wBAAwB,cAAc,UAAU,sBAAmB,QAAA,WAAA;EASnE,yBACJ,kBACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,uBACJ,cACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,yBACJ,kBACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,uBACJ,cACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,8BACJ,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,4BACJ,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,yBACJ,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,uBACJ,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,8BACJ,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;EAWzB,4BACJ,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;qBC3UpB;;EAGC,YAAA,kBAAkB;;;;;;;EAU9B,oBAAoB,cAAc,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAW/D,iCACE,kBACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,+BACE,cACA,kBACA,UAAU,sBAAmB,QAAA,WAAA;;;;;;;EAe/B,0BAA0B,kBAAkB,UAAU,sBAAmB,QAAA,WAAA;;;;;;;EAUzE,wBAAwB,cAAc,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAWnE,yBACE,kBACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,uBACE,cACA,OAAM,MACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAY/B,yBACE,kBACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,uBACE,cACA,OAAM,cACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAY/B,8BACE,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,4BACE,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,yBACE,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,uBACE,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAY/B,8BACE,kBACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;EAgB/B,4BACE,cACA,OAAM,yBACN,UAAU,sBAAmB,QAAA,WAAA;;;;;;;;;;;;;;;;;;;;;;;EA+BzB,oCACJ,KAAK,aAAa,QAClB,oBACA,sBAA4C,QAAA,WAAA;;;;iBCvQ/B,oCAAoC,KACnD;EAGA,SAAS,MAAM,iBAAiB;EAChC,gBACK,MAAM,eACN,QAAQ,uBAAuB;;qBAwBzB,2BAA2B;;EAKpC,YAAA,gBAAgB,gBACQ,WAAW;EAM/B,gBAAY;SAQX,QAAQ,eAAe,sBAAsB;SA+B7C,aAAa,SAAS,8BAA8B"}

package/dist/index.d.mts

@@ -8,6 +8,69 @@ import { EscapeFunction } from "mustache";
 import { ConfigureOptions } from "nunjucks";
 import { LocalsObject, Options as Options$1 } from "pug";
 import { MJMLParsingOptions } from "mjml-core";
+//#region src/exceptions/nestjs-pdf.exception.d.ts
+export declare enum NestjsPdfErrorCode {
+  ENGINE_NOT_AVAILABLE = "ENGINE_NOT_AVAILABLE",
+  TEMPLATE_CONFIGURATION_ERROR = "TEMPLATE_CONFIGURATION_ERROR",
+  TEMPLATE_RENDER_ERROR = "TEMPLATE_RENDER_ERROR",
+  BROWSER_INSTALLATION_ERROR = "BROWSER_INSTALLATION_ERROR",
+  BROWSER_UNAVAILABLE = "BROWSER_UNAVAILABLE",
+  PDF_GENERATION_ERROR = "PDF_GENERATION_ERROR",
+  SIGNATURE_DEPENDENCY_ERROR = "SIGNATURE_DEPENDENCY_ERROR",
+  SIGNATURE_PLACEMENT_ERROR = "SIGNATURE_PLACEMENT_ERROR"
+}
+export declare abstract class NestjsPdfException extends Error {
+  abstract readonly code: NestjsPdfErrorCode;
+  constructor(message: string, options?: {
+    cause?: unknown;
+  });
+}
+//#endregion
+//#region src/exceptions/browser-installation.exception.d.ts
+export declare class BrowserInstallationException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.BROWSER_INSTALLATION_ERROR;
+}
+//#endregion
+//#region src/exceptions/browser-unavailable.exception.d.ts
+export declare class BrowserUnavailableException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.BROWSER_UNAVAILABLE;
+}
+//#endregion
+//#region src/exceptions/engine-not-available.exception.d.ts
+export declare class EngineNotAvailableException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.ENGINE_NOT_AVAILABLE;
+  constructor(engineName: string);
+}
+//#endregion
+//#region src/exceptions/pdf-generation.exception.d.ts
+export declare class PdfGenerationException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.PDF_GENERATION_ERROR;
+}
+//#endregion
+//#region src/exceptions/signature-dependency.exception.d.ts
+export declare class SignatureDependencyException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.SIGNATURE_DEPENDENCY_ERROR;
+}
+//#endregion
+//#region src/exceptions/signature-placement.exception.d.ts
+export declare class SignaturePlacementException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.SIGNATURE_PLACEMENT_ERROR;
+}
+//#endregion
+//#region src/exceptions/template-configuration.exception.d.ts
+export declare class TemplateConfigurationException extends NestjsPdfException {
+  readonly code = NestjsPdfErrorCode.TEMPLATE_CONFIGURATION_ERROR;
+}
+//#endregion
+//#region src/exceptions/template-render.exception.d.ts
+export declare class TemplateRenderException extends NestjsPdfException {
+  readonly engine: string;
+  readonly code = NestjsPdfErrorCode.TEMPLATE_RENDER_ERROR;
+  constructor(engine: string, message: string, options?: {
+    cause?: unknown;
+  });
+}
+//#endregion
 //#region src/helpers/getRelativePath.helper.d.ts
 /**
  * Get the relative path to a value from the module directory.
@@ -18,7 +81,7 @@ import { MJMLParsingOptions } from "mjml-core";
  * 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 declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
 //#endregion
 //#region src/puppeteer/browser/browser.service.d.ts
 declare enum BrowserTag {
@@ -30,57 +93,39 @@ declare enum BrowserTag {
 }
 type Headless = boolean | 'shell' | undefined;
 declare class BrowserService implements OnModuleDestroy {
-  private readonly cacheDir;
-  private readonly options?;
-  private _browserInstance;
-  private browser;
+  #private;
   activeJobs: number;
   totalJobs: number;
-  private recycleRequested;
-  private recycling;
-  private shuttingDown;
   /** Max time to wait for in-flight PDF jobs to finish before closing the browser on shutdown. */
   shutdownDrainTimeoutMs: number;
-  private browserTag;
-  private useLockedBrowser;
-  private buildId;
   constructor(pdfParams: PuppeteerParameters);
   onModuleDestroy(): Promise<void>;
-  /** Wait until no PDF job is in flight, or until the timeout elapses. */
-  private waitForIdle;
   getBrowserInstance(args: Array<string>, headless: boolean | 'shell' | undefined, executablePathBin: string | undefined): Promise<Browser$1>;
   createContext(args: Array<string>, headless: Headless, executablePath?: string): Promise<BrowserContext>;
   markJobStarted(): void;
   markJobFinished(): Promise<void>;
   recycleBrowserIfNeeded(): Promise<void>;
-  private cleanupCacheBestEffort;
   install(lock?: boolean): Promise<import("@puppeteer/browsers").InstalledBrowser | null | undefined>;
-  private loadBrowser;
   getBrowser(): Browser;
-  private loadBrowserTag;
-  private loadBuildId;
   setBrowserTag(browserTag: BrowserTag): void;
   getBrowserTag(): BrowserTag;
   getBuildId(): string | undefined;
-  private loadUseLockedBrowser;
   hasBrowserInstalled(browser: Browser, buildId: string): Promise<boolean>;
   getExecutablePath(): Promise<string>;
-  private launchBrowser;
-  private writeLockFile;
   getLockedBuildId(browser: Browser): string | null;
 }
 //#endregion
 //#region src/puppeteer/engines/ejs/ejs.service.d.ts
-interface EjsOptions extends Omit<Options, 'async'> {
+export interface EjsOptions extends Omit<Options, 'async'> {
   async?: boolean;
 }
-declare class EjsService {
+export declare class EjsService {
   render(template: string, data?: Data, options?: EjsOptions): Promise<string>;
   renderFile(filePath: string, data?: Data, options?: EjsOptions): Promise<string>;
 }
 //#endregion
 //#region src/puppeteer/engines/eta/eta.service.d.ts
-interface EtaOptions extends Partial<EtaConfig> {
+export interface EtaOptions extends Partial<EtaConfig> {
   cache?: boolean;
   autoEscape?: boolean;
   varName?: string;
@@ -88,10 +133,8 @@ interface EtaOptions extends Partial<EtaConfig> {
   useWith?: boolean;
   plugins?: Array<any>;
 }
-declare class EtaService {
-  private readonly eta;
-  private readonly templateCache;
-  private readonly maxCacheSize;
+export declare class EtaService {
+  #private;
   constructor();
   /**
    * Render an Eta template from a string
@@ -121,11 +164,11 @@ declare class EtaService {
 }
 //#endregion
 //#region src/puppeteer/engines/handlebars/handlebars.service.d.ts
-type HandlebarsHelper = {
+export type HandlebarsHelper = {
   name: string;
   fn: Handlebars.HelperDelegate;
 };
-interface HandlebarsOptions {
+export interface HandlebarsOptions {
   /** Base directory (relative to `process.cwd()`) used to resolve files passed to `renderFile`. */
   templateDirectory?: string;
   /** Directory (relative to `process.cwd()`) whose files are each registered as a partial. */
@@ -141,28 +184,19 @@ interface HandlebarsOptions {
   /** Custom helpers registered on the isolated Handlebars environment for this render. */
   helpers?: Array<HandlebarsHelper>;
 }
-declare class HandlebarsService {
-  private cachedOptions?;
-  private cachedEnv?;
+export declare class HandlebarsService {
+  #private;
   render(template: string, parameters?: unknown, options?: HandlebarsOptions): string;
   renderFile(file: string, parameters?: unknown, options?: HandlebarsOptions): string;
-  /**
-   * Build an isolated Handlebars environment with the given helpers/partials so
-   * nothing leaks into the global Handlebars. Memoised for the common case where
-   * the same options object is reused across calls (e.g. the module `hbsOptions`).
-   */
-  private getEnv;
-  private registerPartials;
 }
 //#endregion
 //#region src/puppeteer/engines/mustache/mustache.service.d.ts
-interface MustacheOptions {
+export interface MustacheOptions {
   tags?: [string, string];
   escape?: EscapeFunction;
 }
-declare class MustacheService {
-  private readonly templateCache;
-  private readonly maxCacheSize;
+export declare class MustacheService {
+  #private;
   /**
    * Render a Mustache template from a string
    * @param template The template string to render
@@ -191,28 +225,28 @@ declare class MustacheService {
 }
 //#endregion
 //#region src/puppeteer/engines/nunjucks/nunjucks.service.d.ts
-interface NunjucksOptions extends Partial<ConfigureOptions> {
+export interface NunjucksOptions extends Partial<ConfigureOptions> {
   noCache?: boolean;
   watch?: boolean;
   throwOnUndefined?: boolean;
   trimBlocks?: boolean;
   lstripBlocks?: boolean;
 }
-declare class NunjucksService {
+export declare class NunjucksService {
   constructor();
   render(template: string, data?: Record<string, unknown>, options?: NunjucksOptions): string;
   renderFile(filePath: string, data?: Record<string, unknown>, options?: NunjucksOptions): string;
 }
 //#endregion
 //#region src/puppeteer/engines/pug/pug.service.d.ts
-type PugOptions = Options$1;
-declare class PugService {
+export type PugOptions = Options$1;
+export declare class PugService {
   render(template: string, data?: LocalsObject, options?: PugOptions): string;
   renderFile(filePath: string, data?: LocalsObject, options?: PugOptions): string;
 }
 //#endregion
 //#region src/puppeteer/puppeteer-parameters.interface.d.ts
-interface PuppeteerParameters {
+export interface PuppeteerParameters {
   pdfOptions?: PDFOptions;
   hbsOptions?: HandlebarsOptions;
   mjmlOptions?: MJMLParsingOptions;
@@ -234,34 +268,25 @@ interface PuppeteerParameters {
 }
 //#endregion
 //#region src/nestjs-pdf.module.d.ts
-interface PdfLibModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+export interface PdfLibModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
   inject?: Array<any>;
   useFactory: (...args: Array<any>) => any;
 }
-declare class NestjsPdfModule {
+export declare class NestjsPdfModule {
   static forRoot(options: PuppeteerParameters): DynamicModule;
   static forRootAsync(options: PdfLibModuleAsyncOptions): DynamicModule;
 }
 //#endregion
 //#region src/puppeteer/engines/mjml/mjml.service.d.ts
-declare class MjmlService {
+export declare class MjmlService {
   render(template: string, options?: MJMLParsingOptions): Promise<string>;
   renderFile(filePath: string, options?: MJMLParsingOptions): Promise<string>;
 }
 //#endregion
 //#region src/puppeteer/puppeteer.service.d.ts
-declare class PuppeteerService {
-  private readonly browserService;
-  private readonly options;
-  private readonly hbsService?;
-  private readonly mjmlService?;
-  private readonly pugService?;
-  private readonly ejsService?;
-  private readonly nunjucksService?;
-  private readonly etaService?;
-  private readonly mustacheService?;
-  constructor(browserService: BrowserService, options: PuppeteerParameters, hbsService?: HandlebarsService | undefined, mjmlService?: MjmlService | undefined, pugService?: PugService | undefined, ejsService?: EjsService | undefined, nunjucksService?: NunjucksService | undefined, etaService?: EtaService | undefined, mustacheService?: MustacheService | undefined);
-  private readonly limit;
+export declare class PuppeteerService {
+  #private;
+  constructor(browserService: BrowserService, options: PuppeteerParameters, hbsService?: HandlebarsService, mjmlService?: MjmlService, pugService?: PugService, ejsService?: EjsService, nunjucksService?: NunjucksService, etaService?: EtaService, mustacheService?: MustacheService);
   generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array>;
   generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
   generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
@@ -280,8 +305,8 @@ declare class PuppeteerService {
 }
 //#endregion
 //#region src/nestjs-pdf.service.d.ts
-declare class NestjsPdfService {
-  private readonly puppeteerService;
+export declare class NestjsPdfService {
+  #private;
   constructor(puppeteerService: PuppeteerService);
   /**
    * @param html HTML string to convert to PDF
@@ -426,18 +451,16 @@ declare class NestjsPdfService {
 }
 //#endregion
 //#region src/puppeteer/puppeteer.module.d.ts
-interface PuppeteerModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+export interface PuppeteerModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
   inject?: Array<InjectionToken | OptionalFactoryDependency>;
   useFactory: (...args: Array<any>) => Promise<PuppeteerParameters> | PuppeteerParameters;
 }
-declare class PuppeteerModule implements OnModuleInit {
-  private readonly browserService;
-  private readonly pdfParams;
+export declare class PuppeteerModule implements OnModuleInit {
+  #private;
   constructor(browserService: BrowserService, pdfParams: PuppeteerParameters);
   onModuleInit(): Promise<void>;
   static forRoot(pdfParameters: PuppeteerParameters): DynamicModule;
   static forRootAsync(options: PuppeteerModuleAsyncOptions): DynamicModule;
 }
 //#endregion
-export { EjsOptions, EjsService, EtaOptions, EtaService, HandlebarsHelper, HandlebarsOptions, HandlebarsService, MjmlService, MustacheOptions, MustacheService, NestjsPdfModule, NestjsPdfService, NunjucksOptions, NunjucksService, PdfLibModuleAsyncOptions, PugOptions, PugService, PuppeteerModule, PuppeteerModuleAsyncOptions, PuppeteerParameters, PuppeteerService, getRelativePathToValue };
 //# sourceMappingURL=index.d.mts.map