chromiumly 2.4.0 → 2.5.1

package/README.md

@@ -8,7 +8,8 @@
 [![downloads](https://img.shields.io/npm/dt/chromiumly.svg?color=brightgreen&style=flat-square)](https://npm-stat.com/charts.html?package=chromiumly)
 ![licence](https://img.shields.io/github/license/cherfia/chromiumly?style=flat-square)
 
-A lightweight Typescript library that interacts with [Gotenberg](https://gotenberg.dev/)'s different modules to convert a variety of document formats to PDF files.
+A lightweight Typescript library that interacts with [Gotenberg](https://gotenberg.dev/)'s different modules to convert
+a variety of document formats to PDF files.
 
 ## Install
 
@@ -26,7 +27,8 @@ yarn add chromiumly
 
 ## Prerequisites
 
-Before attempting to use Chromiumly, be sure you install [Docker](https://www.docker.com/) if you have not already done so.
+Before attempting to use Chromiumly, be sure you install [Docker](https://www.docker.com/) if you have not already done
+so.
 
 After that, you can start a default Docker container of [Gotenberg](https://gotenberg.dev/) as follows:
 
@@ -38,7 +40,8 @@ docker run --rm -p 3000:3000 gotenberg/gotenberg:7
 
 ### Configuration
 
-Chromiumly supports both [dotenv](https://www.npmjs.com/package/dotenv) and [config](https://www.npmjs.com/package/config) configuration libraries to add Gotenberg endpoint to your project.
+Chromiumly supports both [dotenv](https://www.npmjs.com/package/dotenv)
+and [config](https://www.npmjs.com/package/config) configuration libraries to add Gotenberg endpoint to your project.
 
 #### dotenv
 
@@ -58,16 +61,21 @@ GOTENBERG_ENDPOINT=http://localhost:3000
 
 ## Modules
 
-Chromiumly introduces different classes that serve as wrappers to Gotenberg's [modules](https://gotenberg.dev/docs/modules/api#modules).
+Chromiumly introduces different classes that serve as wrappers to
+Gotenberg's [modules](https://gotenberg.dev/docs/modules/api#modules). These classes encompass methods featuring an
+input file parameter, such as `html`, `header`, `footer`, and `markdown`, capable of accepting inputs in the form of a
+`string` (i.e. file path), `Buffer`, or `ReadStream`.
 
 ### Chormium
 
-There are three different classes that come with a single method (i.e.`convert`) which calls one of Chromium's [routes](https://gotenberg.dev/docs/modules/chromium#routes) to convert `html` and `markdown` files, or a `url` to a `buffer` which contains the converted PDF file content.
+There are three different classes that come with a single method (i.e.`convert`) which calls one of
+Chromium's [routes](https://gotenberg.dev/docs/modules/chromium#routes) to convert `html` and `markdown` files, or
+a `url` to a `buffer` which contains the converted PDF file content.
 
 #### URL
 
 ```typescript
-import { UrlConverter } from "chromiumly";
+import {UrlConverter} from "chromiumly";
 
 const urlConverter = new UrlConverter();
 const buffer = await urlConverter.convert({
@@ -80,7 +88,7 @@ const buffer = await urlConverter.convert({
 The only requirement is that the file name should be `index.html`.
 
 ```typescript
-import { HtmlConverter } from "chromiumly";
+import {HtmlConverter} from "chromiumly";
 
 const htmlConverter = new HtmlConverter();
 const buffer = await htmlConverter.convert({
@@ -94,7 +102,7 @@ const buffer = await htmlConverter.convert({
 This route accepts an `index.html` file plus a markdown file.
 
 ```typescript
-import { MarkdownConverter } from "chromiumly";
+import {MarkdownConverter} from "chromiumly";
 
 const markdownConverter = new MarkdownConverter();
 const buffer = await markdownConverter.convert({
@@ -105,42 +113,47 @@ const buffer = await markdownConverter.convert({
 
 ### Customization
 
-`convert()` method takes an optional `properties` parameter of the following type which dictates how the PDF generated file will look like.
+`convert()` method takes an optional `properties` parameter of the following type which dictates how the PDF generated
+file will look like.
 
 ```typescript
 type PageProperties = {
-  size?: {
-    width: number; // Paper width, in inches (default 8.5)
-    height: number; //Paper height, in inches (default 11)
-  };
-  margins?: {
-    top: number; // Top margin, in inches (default 0.39)
-    bottom: number; // Bottom margin, in inches (default 0.39)
-    left: number; // Left margin, in inches (default 0.39)
-    right: number; // Right margin, in inches (default 0.39)
-  };
-  preferCssPageSize?: boolean; // Define whether to prefer page size as defined by CSS (default false)
-  printBackground?: boolean; // Print the background graphics (default false)
-  omitBackground?: boolean; // Hide the default white background and allow generating PDFs with transparency (default false)
-  landscape?: boolean; // Set the paper orientation to landscape (default false)
-  scale?: number; // The scale of the page rendering (default 1.0)
-  nativePageRanges?: { from: number; to: number }; // Page ranges to print
+    size?: {
+        width: number; // Paper width, in inches (default 8.5)
+        height: number; //Paper height, in inches (default 11)
+    };
+    margins?: {
+        top: number; // Top margin, in inches (default 0.39)
+        bottom: number; // Bottom margin, in inches (default 0.39)
+        left: number; // Left margin, in inches (default 0.39)
+        right: number; // Right margin, in inches (default 0.39)
+    };
+    preferCssPageSize?: boolean; // Define whether to prefer page size as defined by CSS (default false)
+    printBackground?: boolean; // Print the background graphics (default false)
+    omitBackground?: boolean; // Hide the default white background and allow generating PDFs with transparency (default false)
+    landscape?: boolean; // Set the paper orientation to landscape (default false)
+    scale?: number; // The scale of the page rendering (default 1.0)
+    nativePageRanges?: { from: number; to: number }; // Page ranges to print
 };
 ```
 
 ### PDF Engine
 
-The `PDFEngine` combines the functionality of both Gotenberg's [PDF Engines](https://gotenberg.dev/docs/modules/pdf-engines) and [LibreOffice](https://gotenberg.dev/docs/modules/libreoffice) modules to manipulate different file formats.
+The `PDFEngine` combines the functionality of both
+Gotenberg's [PDF Engines](https://gotenberg.dev/docs/modules/pdf-engines)
+and [LibreOffice](https://gotenberg.dev/docs/modules/libreoffice) modules to manipulate different file formats.
 
 #### convert
 
-This method interacts with [LibreOffice](https://gotenberg.dev/docs/modules/libreoffice) module to convert different documents to PDF files. You can find the file extensions accepted [here](https://gotenberg.dev/docs/modules/libreoffice#route).
+This method interacts with [LibreOffice](https://gotenberg.dev/docs/modules/libreoffice) module to convert different
+documents to PDF files. You can find the file extensions
+accepted [here](https://gotenberg.dev/docs/modules/libreoffice#route).
 
 ```typescript
-import { PDFEngine } from "chromiumly";
+import {PDFEngine} from "chromiumly";
 
 const buffer = await PDFEngine.convert({
-  files: ["path/to/file.docx", "path/to/file.png"],
+    files: ["path/to/file.docx", "path/to/file.png"],
 });
 ```
 
@@ -152,36 +165,40 @@ Similarly to Chromium's module `convert` method, this method takes the following
 
 #### merge
 
-This method interacts with [PDF Engines](https://gotenberg.dev/docs/modules/pdf-engines) module which gathers different engines that can manipulate and merge PDF files such as: [PDFtk](https://gitlab.com/pdftk-java/pdftk), [PDFcpu](https://github.com/pdfcpu/pdfcpu), [QPDF](https://github.com/qpdf/qpdf), and [UNO](https://github.com/unoconv/unoconv).
+This method interacts with [PDF Engines](https://gotenberg.dev/docs/modules/pdf-engines) module which gathers different
+engines that can manipulate and merge PDF files such
+as: [PDFtk](https://gitlab.com/pdftk-java/pdftk), [PDFcpu](https://github.com/pdfcpu/pdfcpu), [QPDF](https://github.com/qpdf/qpdf),
+and [UNO](https://github.com/unoconv/unoconv).
 
 ```typescript
-import { PDFEngine } from "chromiumly";
+import {PDFEngine} from "chromiumly";
 
 const buffer = await PDFEngine.merge({
-  files: ["path/to/file.docx", "path/to/file.png"],
+    files: ["path/to/file.docx", "path/to/file.png"],
 });
 ```
 
 #### generate
 
-It is just a generic complementary method that takes the `buffer` returned by the `convert` method, and a chosen `filename` to generate the PDF file.
+It is just a generic complementary method that takes the `buffer` returned by the `convert` method, and a
+chosen `filename` to generate the PDF file.
 
-Please note that all the PDF files can be found `__generated__` folder in the root folder of your project.  
+Please note that all the PDF files can be found `__generated__` folder in the root folder of your project.
 
 ## Snippet
 
 The following is a short snippet of how to use the library.
 
 ```typescript
-import { PDFEngine, UrlConverter } from "chromiumly";
+import {PDFEngine, UrlConverter} from "chromiumly";
 
 async function run() {
-  const urlConverter = new UrlConverter();
-  const buffer = await urlConverter.convert({
-    url: "https://gotenberg.dev/",
-  });
+    const urlConverter = new UrlConverter();
+    const buffer = await urlConverter.convert({
+        url: "https://gotenberg.dev/",
+    });
 
-  await PDFEngine.generate("gotenberg.pdf", buffer);
+    await PDFEngine.generate("gotenberg.pdf", buffer);
 }
 
 run();

package/dist/chromium/converters/converter.d.ts

@@ -1,5 +1,18 @@
 import { ChromiumRoute } from "../../main.config";
+/**
+ * Abstract class representing a generic converter.
+ * Concrete converter classes should extend this class and implement specific conversion logic.
+ */
 export declare abstract class Converter {
+    /**
+     * The endpoint URL for the converter.
+     */
     readonly endpoint: string;
+    /**
+     * Creates an instance of the Converter class.
+     * Initializes the endpoint URL based on the provided ChromiumRoute.
+     *
+     * @param {ChromiumRoute} route - The ChromiumRoute enum value representing the conversion route.
+     */
     constructor(route: ChromiumRoute);
 }

package/dist/chromium/converters/converter.js

@@ -2,7 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Converter = void 0;
 const main_config_1 = require("../../main.config");
+/**
+ * Abstract class representing a generic converter.
+ * Concrete converter classes should extend this class and implement specific conversion logic.
+ */
 class Converter {
+    /**
+     * Creates an instance of the Converter class.
+     * Initializes the endpoint URL based on the provided ChromiumRoute.
+     *
+     * @param {ChromiumRoute} route - The ChromiumRoute enum value representing the conversion route.
+     */
     constructor(route) {
         this.endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.CHROMIUM_PATH}/${main_config_1.Chromiumly.CHROMIUM_ROUTES[route]}`;
     }

package/dist/chromium/converters/converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/converter.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAE9D,MAAsB,SAAS;IAG7B,YAAY,KAAoB;QAC9B,IAAI,CAAC,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,aAAa,IAAI,wBAAU,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IACtH,CAAC;CACF;AAND,8BAMC"}
+{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/converter.ts"],"names":[],"mappings":";;;AAAA,mDAA4D;AAE5D;;;GAGG;AACH,MAAsB,SAAS;IAM3B;;;;;OAKG;IACH,YAAY,KAAoB;QAC5B,IAAI,CAAC,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,aAAa,IAAI,wBAAU,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IACxH,CAAC;CACJ;AAfD,8BAeC"}

package/dist/chromium/converters/html.converter.d.ts

@@ -1,15 +1,41 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { PathLike } from "fs";
-import { PdfFormat } from "../../common";
+import { PathLikeOrReadStream, PdfFormat } from "../../common";
 import { EmulatedMediaType, PageProperties } from "../interfaces/converter.types";
 import { Converter } from "./converter";
+/**
+ * Class representing an HTML converter that extends the base Converter class.
+ * This class is used to convert HTML content to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 export declare class HtmlConverter extends Converter {
+    /**
+     * Creates an instance of HtmlConverter.
+     * Initializes the converter with the HTML conversion route.
+     */
     constructor();
+    /**
+     * Converts HTML content to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @param {PageProperties} [options.properties] - Page properties for the conversion.
+     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
     convert({ html, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }: {
-        html: PathLike;
-        header?: PathLike;
-        footer?: PathLike;
+        html: PathLikeOrReadStream;
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
         properties?: PageProperties;
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;

package/dist/chromium/converters/html.converter.js

@@ -2,27 +2,48 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HtmlConverter = void 0;
 const tslib_1 = require("tslib");
-const fs_1 = require("fs");
 const form_data_1 = tslib_1.__importDefault(require("form-data"));
 const common_1 = require("../../common");
 const converter_utils_1 = require("../utils/converter.utils");
 const converter_1 = require("./converter");
 const main_config_1 = require("../../main.config");
+/**
+ * Class representing an HTML converter that extends the base Converter class.
+ * This class is used to convert HTML content to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 class HtmlConverter extends converter_1.Converter {
+    /**
+     * Creates an instance of HtmlConverter.
+     * Initializes the converter with the HTML conversion route.
+     */
     constructor() {
         super(main_config_1.ChromiumRoute.HTML);
     }
+    /**
+     * Converts HTML content to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @param {PageProperties} [options.properties] - Page properties for the conversion.
+     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
     convert({ html, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
-            if (Buffer.isBuffer(html)) {
-                data.append("files", html, "index.html");
-            }
-            else {
-                yield fs_1.promises.access(html, fs_1.constants.R_OK);
-                data.append("files", (0, fs_1.createReadStream)(html), "index.html");
-            }
-            converter_utils_1.ConverterUtils.customize(data, {
+            yield converter_utils_1.ConverterUtils.addFile(data, html, "index.html");
+            yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
                 footer,
                 properties,

package/dist/chromium/converters/html.converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"html.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/html.converter.ts"],"names":[],"mappings":";;;;AAAA,2BAAqE;AAErE,kEAAiC;AAEjC,yCAAyD;AAKzD,8DAA0D;AAC1D,2CAAwC;AACxC,mDAAkD;AAElD,MAAa,aAAc,SAAQ,qBAAS;IAC1C;QACE,KAAK,CAAC,2BAAa,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEK,OAAO,CAAC,EACZ,IAAI,EACJ,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAcxB;;YACC,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,aAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;gBAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;YAC7D,CAAC;YAED,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBAC7B,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aACxB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;KAAA;CACF;AAzDD,sCAyDC"}
+{"version":3,"file":"html.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/html.converter.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAA6E;AAK7E,8DAAwD;AACxD,2CAAsC;AACtC,mDAAgD;AAEhD;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,qBAAS;IACxC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,EACI,IAAI,EACJ,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAcxC;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAEvD,MAAM,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBACjC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aAC1B,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA1ED,sCA0EC"}

package/dist/chromium/converters/markdown.converter.d.ts

@@ -1,16 +1,43 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { PathLike } from "fs";
-import { PdfFormat } from "../../common";
+import { PdfFormat, PathLikeOrReadStream } from "../../common";
 import { EmulatedMediaType, PageProperties } from "../interfaces/converter.types";
 import { Converter } from "./converter";
+/**
+ * Class representing a Markdown converter that extends the base Converter class.
+ * This class is used to convert HTML with markdown content to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 export declare class MarkdownConverter extends Converter {
+    /**
+     * Creates an instance of MarkdownConverter.
+     * Initializes the converter with the Markdown conversion route.
+     */
     constructor();
+    /**
+     * Converts HTML with markdown content to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
+     * @param {PathLikeOrReadStream} options.markdown - PathLike or ReadStream of the Markdown content to be converted.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @param {PageProperties} [options.properties] - Page properties for the conversion.
+     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
     convert({ html, markdown, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }: {
-        html: PathLike;
-        markdown: PathLike;
-        header?: PathLike;
-        footer?: PathLike;
+        html: PathLikeOrReadStream;
+        markdown: PathLikeOrReadStream;
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
         properties?: PageProperties;
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;

package/dist/chromium/converters/markdown.converter.js

@@ -2,34 +2,50 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MarkdownConverter = void 0;
 const tslib_1 = require("tslib");
-const fs_1 = require("fs");
 const form_data_1 = tslib_1.__importDefault(require("form-data"));
 const common_1 = require("../../common");
 const converter_utils_1 = require("../utils/converter.utils");
 const converter_1 = require("./converter");
 const main_config_1 = require("../../main.config");
+/**
+ * Class representing a Markdown converter that extends the base Converter class.
+ * This class is used to convert HTML with markdown content to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 class MarkdownConverter extends converter_1.Converter {
+    /**
+     * Creates an instance of MarkdownConverter.
+     * Initializes the converter with the Markdown conversion route.
+     */
     constructor() {
         super(main_config_1.ChromiumRoute.MARKDOWN);
     }
+    /**
+     * Converts HTML with markdown content to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
+     * @param {PathLikeOrReadStream} options.markdown - PathLike or ReadStream of the Markdown content to be converted.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @param {PageProperties} [options.properties] - Page properties for the conversion.
+     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
     convert({ html, markdown, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
-            if (Buffer.isBuffer(html)) {
-                data.append("files", html, "index.html");
-            }
-            else {
-                yield fs_1.promises.access(html, fs_1.constants.R_OK);
-                data.append("files", (0, fs_1.createReadStream)(html), "index.html");
-            }
-            if (Buffer.isBuffer(markdown)) {
-                data.append("files", (0, fs_1.createReadStream)(markdown), "file.md");
-            }
-            else {
-                yield fs_1.promises.access(markdown, fs_1.constants.R_OK);
-                data.append("file.md", (0, fs_1.createReadStream)(markdown));
-            }
-            converter_utils_1.ConverterUtils.customize(data, {
+            yield converter_utils_1.ConverterUtils.addFile(data, html, "index.html");
+            yield converter_utils_1.ConverterUtils.addFile(data, markdown, "file.md");
+            yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
                 footer,
                 properties,

package/dist/chromium/converters/markdown.converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/markdown.converter.ts"],"names":[],"mappings":";;;;AAAA,2BAAqE;AAErE,kEAAiC;AAEjC,yCAAyD;AAKzD,8DAA0D;AAC1D,2CAAwC;AACxC,mDAAkD;AAElD,MAAa,iBAAkB,SAAQ,qBAAS;IAC9C;QACE,KAAK,CAAC,2BAAa,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAEK,OAAO,CAAC,EACZ,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAexB;;YACC,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,aAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;gBAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAA,qBAAgB,EAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;YAC7D,CAAC;YAED,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAA,qBAAgB,EAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,MAAM,aAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;gBAChD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAA,qBAAgB,EAAC,QAAQ,CAAC,CAAC,CAAC;YACrD,CAAC;YAED,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBAC7B,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aACxB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;KAAA;CACF;AAlED,8CAkEC"}
+{"version":3,"file":"markdown.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/markdown.converter.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAA6E;AAK7E,8DAAwD;AACxD,2CAAsC;AACtC,mDAAgD;AAEhD;;;;;GAKG;AACH,MAAa,iBAAkB,SAAQ,qBAAS;IAC5C;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,OAAO,CAAC,EACI,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAexC;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAEvD,MAAM,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;YAExD,MAAM,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBACjC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aAC1B,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA/ED,8CA+EC"}

package/dist/chromium/converters/url.converter.d.ts

@@ -1,15 +1,41 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { PathLike } from "fs";
-import { PdfFormat } from "../../common";
+import { PdfFormat, PathLikeOrReadStream } from "../../common";
 import { EmulatedMediaType, PageProperties } from "../interfaces/converter.types";
 import { Converter } from "./converter";
+/**
+ * Class representing a URL converter that extends the base Converter class.
+ * This class is used to convert content from a URL to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 export declare class UrlConverter extends Converter {
+    /**
+     * Creates an instance of UrlConverter.
+     * Initializes the converter with the URL conversion route.
+     */
     constructor();
+    /**
+     * Converts content from a URL to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {string} options.url - The URL of the content to be converted to PDF.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @param {PageProperties} [options.properties] - Page properties for the conversion.
+     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
     convert({ url, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }: {
         url: string;
-        header?: PathLike;
-        footer?: PathLike;
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
         properties?: PageProperties;
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;

package/dist/chromium/converters/url.converter.js

@@ -8,16 +8,44 @@ const common_1 = require("../../common");
 const converter_utils_1 = require("../utils/converter.utils");
 const converter_1 = require("./converter");
 const main_config_1 = require("../../main.config");
+/**
+ * Class representing a URL converter that extends the base Converter class.
+ * This class is used to convert content from a URL to PDF using Gotenberg service.
+ *
+ * @extends Converter
+ */
 class UrlConverter extends converter_1.Converter {
+    /**
+     * Creates an instance of UrlConverter.
+     * Initializes the converter with the URL conversion route.
+     */
     constructor() {
         super(main_config_1.ChromiumRoute.URL);
     }
+    /**
+     * Converts content from a URL to PDF.
+     *
+     * @param {Object} options - Conversion options.
+     * @param {string} options.url - The URL of the content to be converted to PDF.
+     * @param {PathLikeOrReadStream} [options.header] - PathLike or ReadStream of the header HTML content.
+     * @param {PathLikeOrReadStream} [options.footer] - PathLike or ReadStream of the footer HTML content.
+     * @param {PageProperties} [options.properties] - Page properties for the conversion.
+     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
+     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
+     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
+     * @param {string} [options.userAgent] - User agent string to use during the conversion.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
+     */
     convert({ url, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const _url = new url_1.URL(url);
             const data = new form_data_1.default();
             data.append("url", _url.href);
-            converter_utils_1.ConverterUtils.customize(data, {
+            yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
                 footer,
                 properties,

package/dist/chromium/converters/url.converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"url.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/url.converter.ts"],"names":[],"mappings":";;;;AAEA,6BAA0B;AAE1B,kEAAiC;AAEjC,yCAAyD;AAKzD,8DAA0D;AAC1D,2CAAwC;AACxC,mDAAkD;AAElD,MAAa,YAAa,SAAQ,qBAAS;IACzC;QACE,KAAK,CAAC,2BAAa,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEK,OAAO,CAAC,EACZ,GAAG,EACH,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAcxB;;YACC,MAAM,IAAI,GAAG,IAAI,SAAG,CAAC,GAAG,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAE9B,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBAC7B,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aACxB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;KAAA;CACF;AArDD,oCAqDC"}
+{"version":3,"file":"url.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/url.converter.ts"],"names":[],"mappings":";;;;AAAA,6BAAwB;AACxB,kEAAiC;AACjC,yCAA6E;AAK7E,8DAAwD;AACxD,2CAAsC;AACtC,mDAAgD;AAEhD;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,qBAAS;IACvC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,EACI,GAAG,EACH,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,uBAAuB,GAcxC;;YACG,MAAM,IAAI,GAAG,IAAI,SAAG,CAAC,GAAG,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAE9B,MAAM,gCAAc,CAAC,SAAS,CAAC,IAAI,EAAE;gBACjC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,KAAK;gBACL,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,SAAS;gBACT,gBAAgB;gBAChB,uBAAuB;aAC1B,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA3ED,oCA2EC"}

package/dist/chromium/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/chromium/index.ts"],"names":[],"mappings":";;;AAAA,8DAA4D;AAAnD,+GAAA,aAAa,OAAA;AACtB,sEAAoE;AAA3D,uHAAA,iBAAiB,OAAA;AAC1B,4DAA0D;AAAjD,6GAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/chromium/index.ts"],"names":[],"mappings":";;;AAAA,8DAA0D;AAAlD,+GAAA,aAAa,OAAA;AACrB,sEAAkE;AAA1D,uHAAA,iBAAiB,OAAA;AACzB,4DAAwD;AAAhD,6GAAA,YAAY,OAAA"}

package/dist/chromium/interfaces/converter.types.d.ts

@@ -1,7 +1,4 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { PathLike } from "fs";
-import { PdfFormat } from "../../common";
+import { PathLikeOrReadStream, PdfFormat } from "../../common";
 type PageSize = {
     width: number;
     height: number;
@@ -27,8 +24,8 @@ export type PageProperties = {
 };
 export type EmulatedMediaType = "screen" | "print";
 export type ConversionOptions = {
-    header?: PathLike | Buffer;
-    footer?: PathLike | Buffer;
+    header?: PathLikeOrReadStream;
+    footer?: PathLikeOrReadStream;
     properties?: PageProperties;
     pdfFormat?: PdfFormat;
     pdfUA?: boolean;