@shad0wz7/nestjs-pdf 3.0.1 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.cjs +282 -188
- package/dist/index.d.cts +71 -47
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +71 -47
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +273 -189
- package/dist/index.mjs.map +1 -1
- package/package.json +15 -14
package/dist/index.d.cts
CHANGED
|
@@ -8,6 +8,69 @@ import Handlebars from "handlebars";
|
|
|
8
8
|
import { EscapeFunction } from "mustache";
|
|
9
9
|
import { ConfigureOptions } from "nunjucks";
|
|
10
10
|
import { LocalsObject, Options as Options$1 } from "pug";
|
|
11
|
+
//#region src/exceptions/nestjs-pdf.exception.d.ts
|
|
12
|
+
export declare enum NestjsPdfErrorCode {
|
|
13
|
+
ENGINE_NOT_AVAILABLE = "ENGINE_NOT_AVAILABLE",
|
|
14
|
+
TEMPLATE_CONFIGURATION_ERROR = "TEMPLATE_CONFIGURATION_ERROR",
|
|
15
|
+
TEMPLATE_RENDER_ERROR = "TEMPLATE_RENDER_ERROR",
|
|
16
|
+
BROWSER_INSTALLATION_ERROR = "BROWSER_INSTALLATION_ERROR",
|
|
17
|
+
BROWSER_UNAVAILABLE = "BROWSER_UNAVAILABLE",
|
|
18
|
+
PDF_GENERATION_ERROR = "PDF_GENERATION_ERROR",
|
|
19
|
+
SIGNATURE_DEPENDENCY_ERROR = "SIGNATURE_DEPENDENCY_ERROR",
|
|
20
|
+
SIGNATURE_PLACEMENT_ERROR = "SIGNATURE_PLACEMENT_ERROR"
|
|
21
|
+
}
|
|
22
|
+
export declare abstract class NestjsPdfException extends Error {
|
|
23
|
+
abstract readonly code: NestjsPdfErrorCode;
|
|
24
|
+
constructor(message: string, options?: {
|
|
25
|
+
cause?: unknown;
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
//#endregion
|
|
29
|
+
//#region src/exceptions/browser-installation.exception.d.ts
|
|
30
|
+
export declare class BrowserInstallationException extends NestjsPdfException {
|
|
31
|
+
readonly code = NestjsPdfErrorCode.BROWSER_INSTALLATION_ERROR;
|
|
32
|
+
}
|
|
33
|
+
//#endregion
|
|
34
|
+
//#region src/exceptions/browser-unavailable.exception.d.ts
|
|
35
|
+
export declare class BrowserUnavailableException extends NestjsPdfException {
|
|
36
|
+
readonly code = NestjsPdfErrorCode.BROWSER_UNAVAILABLE;
|
|
37
|
+
}
|
|
38
|
+
//#endregion
|
|
39
|
+
//#region src/exceptions/engine-not-available.exception.d.ts
|
|
40
|
+
export declare class EngineNotAvailableException extends NestjsPdfException {
|
|
41
|
+
readonly code = NestjsPdfErrorCode.ENGINE_NOT_AVAILABLE;
|
|
42
|
+
constructor(engineName: string);
|
|
43
|
+
}
|
|
44
|
+
//#endregion
|
|
45
|
+
//#region src/exceptions/pdf-generation.exception.d.ts
|
|
46
|
+
export declare class PdfGenerationException extends NestjsPdfException {
|
|
47
|
+
readonly code = NestjsPdfErrorCode.PDF_GENERATION_ERROR;
|
|
48
|
+
}
|
|
49
|
+
//#endregion
|
|
50
|
+
//#region src/exceptions/signature-dependency.exception.d.ts
|
|
51
|
+
export declare class SignatureDependencyException extends NestjsPdfException {
|
|
52
|
+
readonly code = NestjsPdfErrorCode.SIGNATURE_DEPENDENCY_ERROR;
|
|
53
|
+
}
|
|
54
|
+
//#endregion
|
|
55
|
+
//#region src/exceptions/signature-placement.exception.d.ts
|
|
56
|
+
export declare class SignaturePlacementException extends NestjsPdfException {
|
|
57
|
+
readonly code = NestjsPdfErrorCode.SIGNATURE_PLACEMENT_ERROR;
|
|
58
|
+
}
|
|
59
|
+
//#endregion
|
|
60
|
+
//#region src/exceptions/template-configuration.exception.d.ts
|
|
61
|
+
export declare class TemplateConfigurationException extends NestjsPdfException {
|
|
62
|
+
readonly code = NestjsPdfErrorCode.TEMPLATE_CONFIGURATION_ERROR;
|
|
63
|
+
}
|
|
64
|
+
//#endregion
|
|
65
|
+
//#region src/exceptions/template-render.exception.d.ts
|
|
66
|
+
export declare class TemplateRenderException extends NestjsPdfException {
|
|
67
|
+
readonly engine: string;
|
|
68
|
+
readonly code = NestjsPdfErrorCode.TEMPLATE_RENDER_ERROR;
|
|
69
|
+
constructor(engine: string, message: string, options?: {
|
|
70
|
+
cause?: unknown;
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
//#endregion
|
|
11
74
|
//#region src/helpers/getRelativePath.helper.d.ts
|
|
12
75
|
/**
|
|
13
76
|
* Get the relative path to a value from the module directory.
|
|
@@ -30,43 +93,25 @@ declare enum BrowserTag {
|
|
|
30
93
|
}
|
|
31
94
|
type Headless = boolean | 'shell' | undefined;
|
|
32
95
|
declare class BrowserService implements OnModuleDestroy {
|
|
33
|
-
private
|
|
34
|
-
private readonly options?;
|
|
35
|
-
private _browserInstance;
|
|
36
|
-
private browser;
|
|
96
|
+
#private;
|
|
37
97
|
activeJobs: number;
|
|
38
98
|
totalJobs: number;
|
|
39
|
-
private recycleRequested;
|
|
40
|
-
private recycling;
|
|
41
|
-
private shuttingDown;
|
|
42
99
|
/** Max time to wait for in-flight PDF jobs to finish before closing the browser on shutdown. */
|
|
43
100
|
shutdownDrainTimeoutMs: number;
|
|
44
|
-
private browserTag;
|
|
45
|
-
private useLockedBrowser;
|
|
46
|
-
private buildId;
|
|
47
101
|
constructor(pdfParams: PuppeteerParameters);
|
|
48
102
|
onModuleDestroy(): Promise<void>;
|
|
49
|
-
/** Wait until no PDF job is in flight, or until the timeout elapses. */
|
|
50
|
-
private waitForIdle;
|
|
51
103
|
getBrowserInstance(args: Array<string>, headless: boolean | 'shell' | undefined, executablePathBin: string | undefined): Promise<Browser$1>;
|
|
52
104
|
createContext(args: Array<string>, headless: Headless, executablePath?: string): Promise<BrowserContext>;
|
|
53
105
|
markJobStarted(): void;
|
|
54
106
|
markJobFinished(): Promise<void>;
|
|
55
107
|
recycleBrowserIfNeeded(): Promise<void>;
|
|
56
|
-
private cleanupCacheBestEffort;
|
|
57
108
|
install(lock?: boolean): Promise<import("@puppeteer/browsers").InstalledBrowser | null | undefined>;
|
|
58
|
-
private loadBrowser;
|
|
59
109
|
getBrowser(): Browser;
|
|
60
|
-
private loadBrowserTag;
|
|
61
|
-
private loadBuildId;
|
|
62
110
|
setBrowserTag(browserTag: BrowserTag): void;
|
|
63
111
|
getBrowserTag(): BrowserTag;
|
|
64
112
|
getBuildId(): string | undefined;
|
|
65
|
-
private loadUseLockedBrowser;
|
|
66
113
|
hasBrowserInstalled(browser: Browser, buildId: string): Promise<boolean>;
|
|
67
114
|
getExecutablePath(): Promise<string>;
|
|
68
|
-
private launchBrowser;
|
|
69
|
-
private writeLockFile;
|
|
70
115
|
getLockedBuildId(browser: Browser): string | null;
|
|
71
116
|
}
|
|
72
117
|
//#endregion
|
|
@@ -89,9 +134,7 @@ export interface EtaOptions extends Partial<EtaConfig> {
|
|
|
89
134
|
plugins?: Array<any>;
|
|
90
135
|
}
|
|
91
136
|
export declare class EtaService {
|
|
92
|
-
private
|
|
93
|
-
private readonly templateCache;
|
|
94
|
-
private readonly maxCacheSize;
|
|
137
|
+
#private;
|
|
95
138
|
constructor();
|
|
96
139
|
/**
|
|
97
140
|
* Render an Eta template from a string
|
|
@@ -142,17 +185,9 @@ export interface HandlebarsOptions {
|
|
|
142
185
|
helpers?: Array<HandlebarsHelper>;
|
|
143
186
|
}
|
|
144
187
|
export declare class HandlebarsService {
|
|
145
|
-
private
|
|
146
|
-
private cachedEnv?;
|
|
188
|
+
#private;
|
|
147
189
|
render(template: string, parameters?: unknown, options?: HandlebarsOptions): string;
|
|
148
190
|
renderFile(file: string, parameters?: unknown, options?: HandlebarsOptions): string;
|
|
149
|
-
/**
|
|
150
|
-
* Build an isolated Handlebars environment with the given helpers/partials so
|
|
151
|
-
* nothing leaks into the global Handlebars. Memoised for the common case where
|
|
152
|
-
* the same options object is reused across calls (e.g. the module `hbsOptions`).
|
|
153
|
-
*/
|
|
154
|
-
private getEnv;
|
|
155
|
-
private registerPartials;
|
|
156
191
|
}
|
|
157
192
|
//#endregion
|
|
158
193
|
//#region src/puppeteer/engines/mustache/mustache.service.d.ts
|
|
@@ -161,8 +196,7 @@ export interface MustacheOptions {
|
|
|
161
196
|
escape?: EscapeFunction;
|
|
162
197
|
}
|
|
163
198
|
export declare class MustacheService {
|
|
164
|
-
private
|
|
165
|
-
private readonly maxCacheSize;
|
|
199
|
+
#private;
|
|
166
200
|
/**
|
|
167
201
|
* Render a Mustache template from a string
|
|
168
202
|
* @param template The template string to render
|
|
@@ -251,17 +285,8 @@ export declare class MjmlService {
|
|
|
251
285
|
//#endregion
|
|
252
286
|
//#region src/puppeteer/puppeteer.service.d.ts
|
|
253
287
|
export declare class PuppeteerService {
|
|
254
|
-
private
|
|
255
|
-
|
|
256
|
-
private readonly hbsService?;
|
|
257
|
-
private readonly mjmlService?;
|
|
258
|
-
private readonly pugService?;
|
|
259
|
-
private readonly ejsService?;
|
|
260
|
-
private readonly nunjucksService?;
|
|
261
|
-
private readonly etaService?;
|
|
262
|
-
private readonly mustacheService?;
|
|
263
|
-
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);
|
|
264
|
-
private readonly limit;
|
|
288
|
+
#private;
|
|
289
|
+
constructor(browserService: BrowserService, options: PuppeteerParameters, hbsService?: HandlebarsService, mjmlService?: MjmlService, pugService?: PugService, ejsService?: EjsService, nunjucksService?: NunjucksService, etaService?: EtaService, mustacheService?: MustacheService);
|
|
265
290
|
generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array>;
|
|
266
291
|
generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
|
|
267
292
|
generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
|
|
@@ -281,7 +306,7 @@ export declare class PuppeteerService {
|
|
|
281
306
|
//#endregion
|
|
282
307
|
//#region src/nestjs-pdf.service.d.ts
|
|
283
308
|
export declare class NestjsPdfService {
|
|
284
|
-
private
|
|
309
|
+
#private;
|
|
285
310
|
constructor(puppeteerService: PuppeteerService);
|
|
286
311
|
/**
|
|
287
312
|
* @param html HTML string to convert to PDF
|
|
@@ -431,8 +456,7 @@ export interface PuppeteerModuleAsyncOptions extends Pick<ModuleMetadata, 'impor
|
|
|
431
456
|
useFactory: (...args: Array<any>) => Promise<PuppeteerParameters> | PuppeteerParameters;
|
|
432
457
|
}
|
|
433
458
|
export declare class PuppeteerModule implements OnModuleInit {
|
|
434
|
-
private
|
|
435
|
-
private readonly pdfParams;
|
|
459
|
+
#private;
|
|
436
460
|
constructor(browserService: BrowserService, pdfParams: PuppeteerParameters);
|
|
437
461
|
onModuleInit(): Promise<void>;
|
|
438
462
|
static forRoot(pdfParameters: PuppeteerParameters): DynamicModule;
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +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":"
|
|
1
|
+
{"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
CHANGED
|
@@ -8,6 +8,69 @@ import { EscapeFunction } from "mustache";
|
|
|
8
8
|
import { ConfigureOptions } from "nunjucks";
|
|
9
9
|
import { LocalsObject, Options as Options$1 } from "pug";
|
|
10
10
|
import { MJMLParsingOptions } from "mjml-core";
|
|
11
|
+
//#region src/exceptions/nestjs-pdf.exception.d.ts
|
|
12
|
+
export declare enum NestjsPdfErrorCode {
|
|
13
|
+
ENGINE_NOT_AVAILABLE = "ENGINE_NOT_AVAILABLE",
|
|
14
|
+
TEMPLATE_CONFIGURATION_ERROR = "TEMPLATE_CONFIGURATION_ERROR",
|
|
15
|
+
TEMPLATE_RENDER_ERROR = "TEMPLATE_RENDER_ERROR",
|
|
16
|
+
BROWSER_INSTALLATION_ERROR = "BROWSER_INSTALLATION_ERROR",
|
|
17
|
+
BROWSER_UNAVAILABLE = "BROWSER_UNAVAILABLE",
|
|
18
|
+
PDF_GENERATION_ERROR = "PDF_GENERATION_ERROR",
|
|
19
|
+
SIGNATURE_DEPENDENCY_ERROR = "SIGNATURE_DEPENDENCY_ERROR",
|
|
20
|
+
SIGNATURE_PLACEMENT_ERROR = "SIGNATURE_PLACEMENT_ERROR"
|
|
21
|
+
}
|
|
22
|
+
export declare abstract class NestjsPdfException extends Error {
|
|
23
|
+
abstract readonly code: NestjsPdfErrorCode;
|
|
24
|
+
constructor(message: string, options?: {
|
|
25
|
+
cause?: unknown;
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
//#endregion
|
|
29
|
+
//#region src/exceptions/browser-installation.exception.d.ts
|
|
30
|
+
export declare class BrowserInstallationException extends NestjsPdfException {
|
|
31
|
+
readonly code = NestjsPdfErrorCode.BROWSER_INSTALLATION_ERROR;
|
|
32
|
+
}
|
|
33
|
+
//#endregion
|
|
34
|
+
//#region src/exceptions/browser-unavailable.exception.d.ts
|
|
35
|
+
export declare class BrowserUnavailableException extends NestjsPdfException {
|
|
36
|
+
readonly code = NestjsPdfErrorCode.BROWSER_UNAVAILABLE;
|
|
37
|
+
}
|
|
38
|
+
//#endregion
|
|
39
|
+
//#region src/exceptions/engine-not-available.exception.d.ts
|
|
40
|
+
export declare class EngineNotAvailableException extends NestjsPdfException {
|
|
41
|
+
readonly code = NestjsPdfErrorCode.ENGINE_NOT_AVAILABLE;
|
|
42
|
+
constructor(engineName: string);
|
|
43
|
+
}
|
|
44
|
+
//#endregion
|
|
45
|
+
//#region src/exceptions/pdf-generation.exception.d.ts
|
|
46
|
+
export declare class PdfGenerationException extends NestjsPdfException {
|
|
47
|
+
readonly code = NestjsPdfErrorCode.PDF_GENERATION_ERROR;
|
|
48
|
+
}
|
|
49
|
+
//#endregion
|
|
50
|
+
//#region src/exceptions/signature-dependency.exception.d.ts
|
|
51
|
+
export declare class SignatureDependencyException extends NestjsPdfException {
|
|
52
|
+
readonly code = NestjsPdfErrorCode.SIGNATURE_DEPENDENCY_ERROR;
|
|
53
|
+
}
|
|
54
|
+
//#endregion
|
|
55
|
+
//#region src/exceptions/signature-placement.exception.d.ts
|
|
56
|
+
export declare class SignaturePlacementException extends NestjsPdfException {
|
|
57
|
+
readonly code = NestjsPdfErrorCode.SIGNATURE_PLACEMENT_ERROR;
|
|
58
|
+
}
|
|
59
|
+
//#endregion
|
|
60
|
+
//#region src/exceptions/template-configuration.exception.d.ts
|
|
61
|
+
export declare class TemplateConfigurationException extends NestjsPdfException {
|
|
62
|
+
readonly code = NestjsPdfErrorCode.TEMPLATE_CONFIGURATION_ERROR;
|
|
63
|
+
}
|
|
64
|
+
//#endregion
|
|
65
|
+
//#region src/exceptions/template-render.exception.d.ts
|
|
66
|
+
export declare class TemplateRenderException extends NestjsPdfException {
|
|
67
|
+
readonly engine: string;
|
|
68
|
+
readonly code = NestjsPdfErrorCode.TEMPLATE_RENDER_ERROR;
|
|
69
|
+
constructor(engine: string, message: string, options?: {
|
|
70
|
+
cause?: unknown;
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
//#endregion
|
|
11
74
|
//#region src/helpers/getRelativePath.helper.d.ts
|
|
12
75
|
/**
|
|
13
76
|
* Get the relative path to a value from the module directory.
|
|
@@ -30,43 +93,25 @@ declare enum BrowserTag {
|
|
|
30
93
|
}
|
|
31
94
|
type Headless = boolean | 'shell' | undefined;
|
|
32
95
|
declare class BrowserService implements OnModuleDestroy {
|
|
33
|
-
private
|
|
34
|
-
private readonly options?;
|
|
35
|
-
private _browserInstance;
|
|
36
|
-
private browser;
|
|
96
|
+
#private;
|
|
37
97
|
activeJobs: number;
|
|
38
98
|
totalJobs: number;
|
|
39
|
-
private recycleRequested;
|
|
40
|
-
private recycling;
|
|
41
|
-
private shuttingDown;
|
|
42
99
|
/** Max time to wait for in-flight PDF jobs to finish before closing the browser on shutdown. */
|
|
43
100
|
shutdownDrainTimeoutMs: number;
|
|
44
|
-
private browserTag;
|
|
45
|
-
private useLockedBrowser;
|
|
46
|
-
private buildId;
|
|
47
101
|
constructor(pdfParams: PuppeteerParameters);
|
|
48
102
|
onModuleDestroy(): Promise<void>;
|
|
49
|
-
/** Wait until no PDF job is in flight, or until the timeout elapses. */
|
|
50
|
-
private waitForIdle;
|
|
51
103
|
getBrowserInstance(args: Array<string>, headless: boolean | 'shell' | undefined, executablePathBin: string | undefined): Promise<Browser$1>;
|
|
52
104
|
createContext(args: Array<string>, headless: Headless, executablePath?: string): Promise<BrowserContext>;
|
|
53
105
|
markJobStarted(): void;
|
|
54
106
|
markJobFinished(): Promise<void>;
|
|
55
107
|
recycleBrowserIfNeeded(): Promise<void>;
|
|
56
|
-
private cleanupCacheBestEffort;
|
|
57
108
|
install(lock?: boolean): Promise<import("@puppeteer/browsers").InstalledBrowser | null | undefined>;
|
|
58
|
-
private loadBrowser;
|
|
59
109
|
getBrowser(): Browser;
|
|
60
|
-
private loadBrowserTag;
|
|
61
|
-
private loadBuildId;
|
|
62
110
|
setBrowserTag(browserTag: BrowserTag): void;
|
|
63
111
|
getBrowserTag(): BrowserTag;
|
|
64
112
|
getBuildId(): string | undefined;
|
|
65
|
-
private loadUseLockedBrowser;
|
|
66
113
|
hasBrowserInstalled(browser: Browser, buildId: string): Promise<boolean>;
|
|
67
114
|
getExecutablePath(): Promise<string>;
|
|
68
|
-
private launchBrowser;
|
|
69
|
-
private writeLockFile;
|
|
70
115
|
getLockedBuildId(browser: Browser): string | null;
|
|
71
116
|
}
|
|
72
117
|
//#endregion
|
|
@@ -89,9 +134,7 @@ export interface EtaOptions extends Partial<EtaConfig> {
|
|
|
89
134
|
plugins?: Array<any>;
|
|
90
135
|
}
|
|
91
136
|
export declare class EtaService {
|
|
92
|
-
private
|
|
93
|
-
private readonly templateCache;
|
|
94
|
-
private readonly maxCacheSize;
|
|
137
|
+
#private;
|
|
95
138
|
constructor();
|
|
96
139
|
/**
|
|
97
140
|
* Render an Eta template from a string
|
|
@@ -142,17 +185,9 @@ export interface HandlebarsOptions {
|
|
|
142
185
|
helpers?: Array<HandlebarsHelper>;
|
|
143
186
|
}
|
|
144
187
|
export declare class HandlebarsService {
|
|
145
|
-
private
|
|
146
|
-
private cachedEnv?;
|
|
188
|
+
#private;
|
|
147
189
|
render(template: string, parameters?: unknown, options?: HandlebarsOptions): string;
|
|
148
190
|
renderFile(file: string, parameters?: unknown, options?: HandlebarsOptions): string;
|
|
149
|
-
/**
|
|
150
|
-
* Build an isolated Handlebars environment with the given helpers/partials so
|
|
151
|
-
* nothing leaks into the global Handlebars. Memoised for the common case where
|
|
152
|
-
* the same options object is reused across calls (e.g. the module `hbsOptions`).
|
|
153
|
-
*/
|
|
154
|
-
private getEnv;
|
|
155
|
-
private registerPartials;
|
|
156
191
|
}
|
|
157
192
|
//#endregion
|
|
158
193
|
//#region src/puppeteer/engines/mustache/mustache.service.d.ts
|
|
@@ -161,8 +196,7 @@ export interface MustacheOptions {
|
|
|
161
196
|
escape?: EscapeFunction;
|
|
162
197
|
}
|
|
163
198
|
export declare class MustacheService {
|
|
164
|
-
private
|
|
165
|
-
private readonly maxCacheSize;
|
|
199
|
+
#private;
|
|
166
200
|
/**
|
|
167
201
|
* Render a Mustache template from a string
|
|
168
202
|
* @param template The template string to render
|
|
@@ -251,17 +285,8 @@ export declare class MjmlService {
|
|
|
251
285
|
//#endregion
|
|
252
286
|
//#region src/puppeteer/puppeteer.service.d.ts
|
|
253
287
|
export declare class PuppeteerService {
|
|
254
|
-
private
|
|
255
|
-
|
|
256
|
-
private readonly hbsService?;
|
|
257
|
-
private readonly mjmlService?;
|
|
258
|
-
private readonly pugService?;
|
|
259
|
-
private readonly ejsService?;
|
|
260
|
-
private readonly nunjucksService?;
|
|
261
|
-
private readonly etaService?;
|
|
262
|
-
private readonly mustacheService?;
|
|
263
|
-
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);
|
|
264
|
-
private readonly limit;
|
|
288
|
+
#private;
|
|
289
|
+
constructor(browserService: BrowserService, options: PuppeteerParameters, hbsService?: HandlebarsService, mjmlService?: MjmlService, pugService?: PugService, ejsService?: EjsService, nunjucksService?: NunjucksService, etaService?: EtaService, mustacheService?: MustacheService);
|
|
265
290
|
generatePdfFromHtml(html: string, options?: PuppeteerParameters): Promise<Uint8Array>;
|
|
266
291
|
generatePdfFromTemplateHbsString(template: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
|
|
267
292
|
generatePdfFromTemplateHbsFile(file: string, parameters?: any, options?: PuppeteerParameters): Promise<Uint8Array<ArrayBufferLike>>;
|
|
@@ -281,7 +306,7 @@ export declare class PuppeteerService {
|
|
|
281
306
|
//#endregion
|
|
282
307
|
//#region src/nestjs-pdf.service.d.ts
|
|
283
308
|
export declare class NestjsPdfService {
|
|
284
|
-
private
|
|
309
|
+
#private;
|
|
285
310
|
constructor(puppeteerService: PuppeteerService);
|
|
286
311
|
/**
|
|
287
312
|
* @param html HTML string to convert to PDF
|
|
@@ -431,8 +456,7 @@ export interface PuppeteerModuleAsyncOptions extends Pick<ModuleMetadata, 'impor
|
|
|
431
456
|
useFactory: (...args: Array<any>) => Promise<PuppeteerParameters> | PuppeteerParameters;
|
|
432
457
|
}
|
|
433
458
|
export declare class PuppeteerModule implements OnModuleInit {
|
|
434
|
-
private
|
|
435
|
-
private readonly pdfParams;
|
|
459
|
+
#private;
|
|
436
460
|
constructor(browserService: BrowserService, pdfParams: PuppeteerParameters);
|
|
437
461
|
onModuleInit(): Promise<void>;
|
|
438
462
|
static forRoot(pdfParameters: PuppeteerParameters): DynamicModule;
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","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":"
|
|
1
|
+
{"version":3,"file":"index.d.mts","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"}
|