@shad0wz7/nestjs-pdf 1.0.0 → 1.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Emmanuel Boisset
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2026 Emmanuel Boisset
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,122 +1,118 @@
-# nestjs-pdf
-
-A small NestJS library to generate and manipulate PDFs using Puppeteer and Handlebars.
-
-Main features:
-- Generate PDFs from HTML or Handlebars templates
-- Concurrency limiting for Puppeteer jobs (p-limit)
-- Add signature fields based on a text anchor in an existing PDF
-- Simple API (module + service) to integrate easily into a Nest application
-
-> Note: this repository contains the library source. To use it in another project you can either install it from npm (if published) or import the local package from the source.
-
-## Installation
-
-In this repository:
-
-```bash
-pnpm install
-```
-
-To add the library to another project (example):
-
-```bash
-npm install @shad0wz7/nestjs-pdf
-# or
-pnpm add @shad0wz7/nestjs-pdf
-# or
-yarn add @shad0wz7/nestjs-pdf
-
-# If using the local source, from the other project:
-pnpm add ../path/to/nestjs-pdf
-```
-
-## Quick start
-
-Import the module and configure it in your Nest application:
-
-```ts
-import { Module } from '@nestjs/common';
-import { NestjsPdfModule } from 'nestjs-pdf';
-
-@Module({
-  imports: [
-    NestjsPdfModule.forRoot({
-      // default Puppeteer / PDF options
-      headless: true,
-      pdfOptions: { format: 'A4' },
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-Inject the service and generate a PDF:
-
-```ts
-import { Controller, Get } from '@nestjs/common';
-import { NestjsPdfService } from 'nestjs-pdf';
-
-@Controller()
-export class AppController {
-  constructor(private readonly pdfService: NestjsPdfService) {}
-
-  @Get('pdf')
-  async getPdf() {
-    const html = '<h1>Hello</h1><p>PDF generated by nestjs-pdf</p>';
-    const buffer = await this.pdfService.generatePdfFromHtml(html);
-    return buffer; // return a Buffer / Uint8Array depending on your controller
-  }
-}
-```
-
-Use a Handlebars template (string or file):
-
-```ts
-const template = '<h1>{{title}}</h1><p>{{content}}</p>';
-const pdf = await pdfService.generatePdfFromTemplateString(template, { title: 'T', content: '...' });
-```
-
-Add a signature field to an existing PDF (anchor-based):
-
-```ts
-const originalPdfBytes = await this.pdfService.generatePdfFromHtml(html);
-const modifiedPdf = await pdfService.addSignatureFieldSignatureDebtorRaw(
-  originalPdfBytes,
-  'SignatureDebtor',
-  '__SIG_DEBTOR_ANCHOR__',
-);
-```
-
-If the anchor is not found, the signature field will be added at a default position.
-
-## Options and configuration
-
-The library exposes Puppeteer options via the `PuppeteerParameters` interface (see `src/puppeteer/puppeteer-parameters.interface.ts`). You can configure:
-
-- `headless` (boolean | 'shell')
-- `pdfOptions` (native Puppeteer options for `page.pdf`)
-- `extraPuppeteerArgs` (launch arguments for Chromium)
-
-You can use `forRootAsync(...)` if you need to provide configuration asynchronously.
-
-## Tests
-
-This repository includes unit and integration tests (Jest). To run the tests:
-
-```bash
-pnpm run test
-pnpm run test:e2e
-```
-
-## Contributing
-
-If you want to contribute:
-
-- Open an issue to discuss the change
-- Fork the repo, create a feature/fix branch, then open a PR
-- Follow Conventional Commits for automated releases
-
-## License
-
-MIT — see the `LICENSE` file.
+# nestjs-pdf
+
+A small NestJS library to generate and manipulate PDFs using Puppeteer and Handlebars.
+
+Main features:
+- Generate PDFs from HTML or Handlebars templates
+- Concurrency limiting for Puppeteer jobs (p-limit)
+- Add signature fields based on a text anchor in an existing PDF
+- Simple API (module and service) to integrate easily into a Nest application
+
+> Note: this repository contains the library source. To use it in another project, you can either install it from npm or import the local package from the source.
+
+## Installation
+
+To add the library inside your project :
+
+```bash
+npm install @shad0wz7/nestjs-pdf
+# or
+pnpm add @shad0wz7/nestjs-pdf
+# or
+yarn add @shad0wz7/nestjs-pdf
+
+# If using the local source, from the other project:
+pnpm add ../path/to/nestjs-pdf
+```
+
+## Quick start
+
+Import the module and configure it in your Nest application:
+
+```ts
+import { Module } from '@nestjs/common';
+import { NestjsPdfModule } from 'nestjs-pdf';
+
+@Module({
+  imports: [
+    NestjsPdfModule.forRoot({
+      // default Puppeteer / PDF options
+      headless: true,
+      pdfOptions: { format: 'A4' },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+Inject the service and generate a PDF:
+
+```ts
+import { Controller, Get } from '@nestjs/common';
+import { NestjsPdfService } from 'nestjs-pdf';
+
+@Controller()
+export class AppController {
+  constructor(private readonly pdfService: NestjsPdfService) {}
+
+  @Get('pdf')
+  async getPdf() {
+    const html = '<h1>Hello</h1><p>PDF generated by nestjs-pdf</p>';
+    const buffer = await this.pdfService.generatePdfFromHtml(html);
+    return buffer; // return a Buffer / Uint8Array depending on your controller
+  }
+}
+```
+
+Use a Handlebars template (string or file):
+
+```ts
+const template = '<h1>{{title}}</h1><p>{{content}}</p>';
+const pdf = await pdfService.generatePdfFromTemplateString(template, { title: 'T', content: '...' });
+```
+
+Add a signature field to an existing PDF (anchor-based):
+
+```ts
+const originalPdfBytes = await this.pdfService.generatePdfFromHtml(html);
+const modifiedPdf = await pdfService.addSignatureFieldSignatureDebtorRaw(
+  originalPdfBytes,
+  'SignatureDebtor',
+  '__SIG_DEBTOR_ANCHOR__',
+);
+```
+
+If the anchor is not found, the signature field will be added at a default position.
+
+**Warning:** if you encounter issues like "Failed to load pdfjs-dist." Make sure to install `@napi-rs/canvas` as a dependency in your project, as it's required by the library for PDF manipulation.
+
+## Options and configuration
+
+The library exposes Puppeteer options via the `PuppeteerParameters` interface (see `src/puppeteer/puppeteer-parameters.interface.ts`). You can configure:
+
+- `headless` (boolean | 'shell')
+- `pdfOptions` (native Puppeteer options for `page.pdf`)
+- `extraPuppeteerArgs` (launch arguments for Chromium)
+
+You can use `forRootAsync(...)` if you need to provide configuration asynchronously.
+
+## Tests
+
+This repository includes unit and integration tests (Jest). To run the tests:
+
+```bash
+pnpm run test
+pnpm run test:e2e
+```
+
+## Contributing
+
+If you want to contribute:
+
+- Open an issue to discuss the change
+- Fork the repo, create a feature/fix branch, then open a PR
+- Follow Conventional Commits for automated releases
+
+## License
+
+MIT — see the `LICENSE` file.

package/dist/chunk-DDRU76YD.mjs

@@ -0,0 +1,39 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+export {
+  __name,
+  __require,
+  __commonJS,
+  __toESM
+};

package/dist/index.d.mts

@@ -116,4 +116,6 @@ declare class PuppeteerHandlebarsModule {
     static forRootAsync(options: PuppeteerHandlebarsModuleAsyncOptions): DynamicModule;
 }
 
-export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService };
+declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
+
+export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };

package/dist/index.d.ts

@@ -116,4 +116,6 @@ declare class PuppeteerHandlebarsModule {
     static forRootAsync(options: PuppeteerHandlebarsModuleAsyncOptions): DynamicModule;
 }
 
-export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService };
+declare function getRelativePathToValue(moduleDir: string, relativeToModule: string): string;
+
+export { NestjsPdfModule, NestjsPdfService, type PdfLibModuleAsyncOptions, PuppeteerHandlebarsModule, type PuppeteerHandlebarsModuleAsyncOptions, PuppeteerModule, type PuppeteerModuleAsyncOptions, type PuppeteerParameters, PuppeteerService, getRelativePathToValue };