chromiumly 2.6.0 → 2.8.0

package/README.md

@@ -11,6 +11,29 @@
 A lightweight Typescript library that interacts with [Gotenberg](https://gotenberg.dev/)'s different modules to convert
 a variety of document formats to PDF files.
 
+# Table of Contents
+
+1. [Introduction](#introduction)
+   - [Install](#install)
+   - [Prerequisites](#prerequisites)
+   - [Get Started](#get-started)
+2. [Configuration](#configuration)
+   - [dotenv](#dotenv)
+   - [config](#config)
+3. [Modules](#modules)
+   - [Chromium](#chromium)
+     - [URL](#url)
+     - [HTML](#html)
+     - [Markdown](#markdown)
+   - [Customization](#customization)
+     - [Conversion](#conversion)
+     - [Screenshot](#screenshot)
+   - [PDF Engine](#pdf-engine)
+     - [convert](#convert)
+     - [merge](#merge)
+     - [generate](#generate)
+4. [Snippet](#snippet)
+
 ## Install
 
 Using npm:
@@ -33,7 +56,7 @@ so.
 After that, you can start a default Docker container of [Gotenberg](https://gotenberg.dev/) as follows:
 
 ```bash
-docker run --rm -p 3000:3000 gotenberg/gotenberg:7
+docker run --rm -p 3000:3000 gotenberg/gotenberg:8
 ```
 
 ## Get Started
@@ -62,24 +85,35 @@ 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). These classes encompass methods featuring an
+Gotenberg's [routes](https://gotenberg.dev/docs/routes). 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
+Chromium's [Conversion routes](https://gotenberg.dev/docs/routes#convert-with-chromium) to convert `html` and `markdown` files, or
 a `url` to a `buffer` which contains the converted PDF file content.
 
+Similarly, a new set of classes have been added to harness the recently introduced Gotenberg [Screenshot routes](https://gotenberg.dev/docs/routes#screenshots-route). These classes include a single method called `capture`, which allows capturing full-page screenshots of `html`, `markdown`, and `url`.
+
 #### URL
 
 ```typescript
-import {UrlConverter} from "chromiumly";
+import { UrlConverter } from "chromiumly";
 
 const urlConverter = new UrlConverter();
 const buffer = await urlConverter.convert({
-    url: "https://www.example.com/",
+  url: "https://www.example.com/",
+});
+```
+
+```typescript
+import { UrlScreenshot } from "chromiumly";
+
+const screenshot = new UrlScreenshot();
+const buffer = await screenshot.capture({
+  url: "https://www.example.com/",
 });
 ```
 
@@ -88,13 +122,21 @@ 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({
-    html: "path/to/index.html",
+  html: "path/to/index.html",
 });
+```
 
+```typescript
+import { HtmlScreenshot } from "chromiumly";
+
+const screenshot = new HtmlScreenshot();
+const buffer = await screenshot.capture({
+  html: "path/to/index.html",
+});
 ```
 
 #### Markdown
@@ -102,58 +144,121 @@ 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({
-    html: "path/to/index.html",
-    markdown: "path/to/file.md",
+  html: "path/to/index.html",
+  markdown: "path/to/file.md",
+});
+```
+
+```typescript
+import { MarkdownScreenshot } from "chromiumly";
+
+const screenshot = new MarkdownScreenshot();
+const buffer = await screenshot.capture({
+  html: "path/to/index.html",
+  markdown: "path/to/file.md",
 });
 ```
 
 ### Customization
 
+#### Conversion
+
 `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
+  singlePage?: boolean; // Print the entire content in one single page (default false)
+  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
+};
+```
+
+In addition to the `PageProperties` customization options, the `convert()` method also accepts a set of parameters to further enhance the versatility of the conversion process. Here's an overview of the full list of parameters:
+
+```typescript
+type ConversionOptions = {
+  properties?: PageProperties; // Customize the appearance of the generated PDF
+  pdfFormat?: PdfFormat; // Define the PDF format for the conversion
+  pdfUA?: boolean; // Enable PDF for Universal Access for optimal accessibility (default false)
+  userAgent?: string; // Customize the user agent string sent during conversion
+  header?: PathLikeOrReadStream; // Specify a custom header for the PDF
+  footer?: PathLikeOrReadStream; // Specify a custom footer for the PDF
+  emulatedMediaType?: EmulatedMediaType; // Specify the emulated media type for conversion
+  waitDelay?: string; // Duration (e.g., '5s') to wait when loading an HTML document before conversion
+  waitForExpression?: string; // JavaScript expression to wait before converting an HTML document into PDF
+  extraHttpHeaders?: Record<string, string>; // Include additional HTTP headers in the request
+  failOnHttpStatusCodes?: number[]; // List of HTTP status codes triggering a 409 Conflict response (default [499, 599])
+  failOnConsoleExceptions?: boolean; // Return a 409 Conflict response if there are exceptions in the Chromium console (default false)
+  skipNetworkIdleEvent?: boolean; // Do not wait for Chromium network to be idle (default false)
+};
+```
+
+#### Screenshot
+
+Similarly, the `capture()` method takes an optional `properties` parameter of the specified type, influencing the appearance of the captured screenshot file.
+
+```typescript
+type ImageProperties = {
+  format: "png" | "jpeg" | "webp"; //The image compression format, either "png", "jpeg" or "webp".
+  quality?: number; // The compression quality from range 0 to 100 (jpeg only).
+  omitBackground?: boolean; // Hide the default white background and allow generating screenshots with transparency.
+};
+```
+
+Furthermore, alongside the customization options offered by `ImageProperties`, the `capture()` method accommodates a variety of parameters to expand the versatility of the screenshot process. Below is a comprehensive overview of all parameters available:
+
+```typescript
+type ScreenshotOptions = {
+  properties?: ImageProperties;
+  header?: PathLikeOrReadStream;
+  footer?: PathLikeOrReadStream;
+  emulatedMediaType?: EmulatedMediaType;
+  waitDelay?: string; // Duration (e.g, '5s') to wait when loading an HTML document before convertion.
+  waitForExpression?: string; // JavaScript's expression to wait before converting an HTML document into PDF until it returns true.
+  extraHttpHeaders?: Record<string, string>;
+  failOnHttpStatusCodes?: number[]; // Return a 409 Conflict response if the HTTP status code is in the list (default [499,599])
+  failOnConsoleExceptions?: boolean; // Return a 409 Conflict response if there are exceptions in the Chromium console (default false)
+  skipNetworkIdleEvent?: boolean; // Do not wait for Chromium network to be idle (default false)
+  optimizeForSpeed?: boolean; // Define whether to optimize image encoding for speed, not for resulting size.
 };
 ```
 
 ### 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
+Gotenberg's [PDF Engines](https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route)
+and [LibreOffice](https://gotenberg.dev/docs/routes#convert-with-libreoffice) modules to manipulate different file formats.
 
 #### convert
 
-This method interacts with [LibreOffice](https://gotenberg.dev/docs/modules/libreoffice) module to convert different
+This method interacts with [LibreOffice](https://gotenberg.dev/docs/routes#convert-with-libreoffice) module to convert different
 documents to PDF files. You can find the file extensions
-accepted [here](https://gotenberg.dev/docs/modules/libreoffice#route).
+accepted [here](https://gotenberg.dev/docs/routes#convert-with-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"],
 });
 ```
 
@@ -165,16 +270,16 @@ 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
+This method interacts with [PDF Engines](https://gotenberg.dev/docs/routes#merge-pdfs-route) 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"],
 });
 ```
 
@@ -190,15 +295,15 @@ Please note that all the PDF files can be found `__generated__` folder in the ro
 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,4 +1,4 @@
-import { ChromiumRoute } from "../../main.config";
+import { ChromiumRoute } from '../../main.config';
 /**
  * Abstract class representing a generic converter.
  * Concrete converter classes should extend this class and implement specific conversion logic.

package/dist/chromium/converters/converter.js

@@ -14,7 +14,7 @@ class Converter {
      * @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]}`;
+        this.endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.CHROMIUM_CONVERT_PATH}/${main_config_1.Chromiumly.CHROMIUM_ROUTES[route]}`;
     }
 }
 exports.Converter = Converter;

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/converter.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAE9D;;;GAGG;AACH,MAAsB,SAAS;IAM3B;;;;;OAKG;IACH,YAAY,KAAoB;QAC5B,IAAI,CAAC,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,qBAAqB,IAAI,wBAAU,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IAChI,CAAC;CACJ;AAfD,8BAeC"}

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

@@ -1,7 +1,8 @@
 /// <reference types="node" />
-import { PathLikeOrReadStream, PdfFormat } from "../../common";
-import { EmulatedMediaType, PageProperties } from "../interfaces/converter.types";
-import { Converter } from "./converter";
+import { PathLikeOrReadStream, PdfFormat } from '../../common';
+import { PageProperties } from '../interfaces/converter.types';
+import { Converter } from './converter';
+import { EmulatedMediaType } from '../interfaces/common.types';
 /**
  * Class representing an HTML converter that extends the base Converter class.
  * This class is used to convert HTML content to PDF using Gotenberg service.
@@ -29,10 +30,12 @@ export declare class HtmlConverter extends Converter {
      * @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 {number[]} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
      * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
-    convert({ html, assets, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }: {
+    convert({ html, assets, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent }: {
         html: PathLikeOrReadStream;
         assets?: {
             file: PathLikeOrReadStream;
@@ -48,6 +51,8 @@ export declare class HtmlConverter extends Converter {
         waitForExpression?: string;
         userAgent?: string;
         extraHttpHeaders?: Record<string, string>;
+        failOnHttpStatusCodes?: number[];
         failOnConsoleExceptions?: boolean;
+        skipNetworkIdleEvent?: boolean;
     }): Promise<Buffer>;
 }

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

@@ -36,15 +36,17 @@ class HtmlConverter extends converter_1.Converter {
      * @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 {number[]} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
      * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
-    convert({ html, assets, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnConsoleExceptions, }) {
+    convert({ html, assets, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
-            yield converter_utils_1.ConverterUtils.addFile(data, html, "index.html");
+            yield common_1.GotenbergUtils.addFile(data, html, 'index.html');
             if (assets === null || assets === void 0 ? void 0 : assets.length) {
-                yield Promise.all(assets.map(({ file, name }) => converter_utils_1.ConverterUtils.addFile(data, file, name)));
+                yield Promise.all(assets.map(({ file, name }) => common_1.GotenbergUtils.addFile(data, file, name)));
             }
             yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
@@ -57,7 +59,9 @@ class HtmlConverter extends converter_1.Converter {
                 waitForExpression,
                 userAgent,
                 extraHttpHeaders,
+                failOnHttpStatusCodes,
                 failOnConsoleExceptions,
+                skipNetworkIdleEvent
             });
             return common_1.GotenbergUtils.fetch(this.endpoint, data);
         });

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,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,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,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,CAAC;gBACjB,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,gCAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/F,CAAC;YAED,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;AAhFD,sCAgFC"}
+{"version":3,"file":"html.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/html.converter.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAA+E;AAE/E,8DAA0D;AAC1D,2CAAwC;AACxC,mDAAkD;AAGlD;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,qBAAS;IACxC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,OAAO,CAAC,EACV,IAAI,EACJ,MAAM,EACN,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EAiBvB;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,uBAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAEvD,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,CAAC;gBACjB,MAAM,OAAO,CAAC,GAAG,CACb,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAC1B,uBAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAC3C,CACJ,CAAC;YACN,CAAC;YAED,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,qBAAqB;gBACrB,uBAAuB;gBACvB,oBAAoB;aACvB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA5FD,sCA4FC"}

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

@@ -1,7 +1,8 @@
 /// <reference types="node" />
-import { PdfFormat, PathLikeOrReadStream } from "../../common";
-import { EmulatedMediaType, PageProperties } from "../interfaces/converter.types";
-import { Converter } from "./converter";
+import { PdfFormat, PathLikeOrReadStream } from '../../common';
+import { PageProperties } from '../interfaces/converter.types';
+import { Converter } from './converter';
+import { EmulatedMediaType } from '../interfaces/common.types';
 /**
  * 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.
@@ -30,10 +31,12 @@ export declare class MarkdownConverter extends Converter {
      * @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 {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
      * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
      * @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, }: {
+    convert({ html, markdown, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent }: {
         html: PathLikeOrReadStream;
         markdown: PathLikeOrReadStream;
         header?: PathLikeOrReadStream;
@@ -46,6 +49,8 @@ export declare class MarkdownConverter extends Converter {
         waitForExpression?: string;
         userAgent?: string;
         extraHttpHeaders?: Record<string, string>;
+        failOnHttpStatusCodes?: number[];
         failOnConsoleExceptions?: boolean;
+        skipNetworkIdleEvent?: boolean;
     }): Promise<Buffer>;
 }

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

@@ -37,14 +37,16 @@ class MarkdownConverter extends converter_1.Converter {
      * @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 {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
      * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
      * @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, }) {
+    convert({ html, markdown, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent }) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const data = new form_data_1.default();
-            yield converter_utils_1.ConverterUtils.addFile(data, html, "index.html");
-            yield converter_utils_1.ConverterUtils.addFile(data, markdown, "file.md");
+            yield common_1.GotenbergUtils.addFile(data, html, 'index.html');
+            yield common_1.GotenbergUtils.addFile(data, markdown, 'file.md');
             yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
                 footer,
@@ -56,7 +58,9 @@ class MarkdownConverter extends converter_1.Converter {
                 waitForExpression,
                 userAgent,
                 extraHttpHeaders,
+                failOnHttpStatusCodes,
                 failOnConsoleExceptions,
+                skipNetworkIdleEvent
             });
             return common_1.GotenbergUtils.fetch(this.endpoint, data);
         });

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,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"}
+{"version":3,"file":"markdown.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/markdown.converter.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAA+E;AAE/E,8DAA0D;AAC1D,2CAAwC;AACxC,mDAAkD;AAGlD;;;;;GAKG;AACH,MAAa,iBAAkB,SAAQ,qBAAS;IAC5C;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,OAAO,CAAC,EACV,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EAiBvB;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,uBAAc,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;YAEvD,MAAM,uBAAc,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,qBAAqB;gBACrB,uBAAuB;gBACvB,oBAAoB;aACvB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AAvFD,8CAuFC"}

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

@@ -1,7 +1,8 @@
 /// <reference types="node" />
-import { PdfFormat, PathLikeOrReadStream } from "../../common";
-import { EmulatedMediaType, PageProperties } from "../interfaces/converter.types";
-import { Converter } from "./converter";
+import { PdfFormat, PathLikeOrReadStream } from '../../common';
+import { PageProperties } from '../interfaces/converter.types';
+import { Converter } from './converter';
+import { EmulatedMediaType } from '../interfaces/common.types';
 /**
  * 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.
@@ -29,10 +30,12 @@ export declare class UrlConverter extends Converter {
      * @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 {number[]} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
      * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
      * @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, }: {
+    convert({ url, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent }: {
         url: string;
         header?: PathLikeOrReadStream;
         footer?: PathLikeOrReadStream;
@@ -44,6 +47,8 @@ export declare class UrlConverter extends Converter {
         waitForExpression?: string;
         userAgent?: string;
         extraHttpHeaders?: Record<string, string>;
+        failOnHttpStatusCodes?: number[];
         failOnConsoleExceptions?: boolean;
+        skipNetworkIdleEvent?: boolean;
     }): Promise<Buffer>;
 }

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

@@ -37,14 +37,16 @@ class UrlConverter extends converter_1.Converter {
      * @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 {number[]} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
      * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during conversion.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
      * @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, }) {
+    convert({ url, header, footer, properties, pdfFormat, pdfUA, emulatedMediaType, waitDelay, waitForExpression, userAgent, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent }) {
         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);
+            data.append('url', _url.href);
             yield converter_utils_1.ConverterUtils.customize(data, {
                 header,
                 footer,
@@ -56,7 +58,9 @@ class UrlConverter extends converter_1.Converter {
                 waitForExpression,
                 userAgent,
                 extraHttpHeaders,
+                failOnHttpStatusCodes,
                 failOnConsoleExceptions,
+                skipNetworkIdleEvent
             });
             return common_1.GotenbergUtils.fetch(this.endpoint, data);
         });

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":";;;;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"}
+{"version":3,"file":"url.converter.js","sourceRoot":"","sources":["../../../src/chromium/converters/url.converter.ts"],"names":[],"mappings":";;;;AAAA,6BAA0B;AAC1B,kEAAiC;AACjC,yCAA+E;AAE/E,8DAA0D;AAC1D,2CAAwC;AACxC,mDAAkD;AAGlD;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,qBAAS;IACvC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,OAAO,CAAC,EACV,GAAG,EACH,MAAM,EACN,MAAM,EACN,UAAU,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EAgBvB;;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,qBAAqB;gBACrB,uBAAuB;gBACvB,oBAAoB;aACvB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AAnFD,oCAmFC"}

package/dist/chromium/index.d.ts

@@ -1,3 +1,6 @@
-export { HtmlConverter } from "./converters/html.converter";
-export { MarkdownConverter } from "./converters/markdown.converter";
-export { UrlConverter } from "./converters/url.converter";
+export { UrlScreenshot } from './screenshots/url.screenshot';
+export { MarkdownScreenshot } from './screenshots/markdown.screenshot';
+export { HtmlScreenshot } from './screenshots/html.screenshot';
+export { HtmlConverter } from './converters/html.converter';
+export { MarkdownConverter } from './converters/markdown.converter';
+export { UrlConverter } from './converters/url.converter';

package/dist/chromium/index.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UrlConverter = exports.MarkdownConverter = exports.HtmlConverter = void 0;
+exports.UrlConverter = exports.MarkdownConverter = exports.HtmlConverter = exports.HtmlScreenshot = exports.MarkdownScreenshot = exports.UrlScreenshot = void 0;
+var url_screenshot_1 = require("./screenshots/url.screenshot");
+Object.defineProperty(exports, "UrlScreenshot", { enumerable: true, get: function () { return url_screenshot_1.UrlScreenshot; } });
+var markdown_screenshot_1 = require("./screenshots/markdown.screenshot");
+Object.defineProperty(exports, "MarkdownScreenshot", { enumerable: true, get: function () { return markdown_screenshot_1.MarkdownScreenshot; } });
+var html_screenshot_1 = require("./screenshots/html.screenshot");
+Object.defineProperty(exports, "HtmlScreenshot", { enumerable: true, get: function () { return html_screenshot_1.HtmlScreenshot; } });
 var html_converter_1 = require("./converters/html.converter");
 Object.defineProperty(exports, "HtmlConverter", { enumerable: true, get: function () { return html_converter_1.HtmlConverter; } });
 var markdown_converter_1 = require("./converters/markdown.converter");

package/dist/chromium/index.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/chromium/index.ts"],"names":[],"mappings":";;;AAAA,+DAA6D;AAApD,+GAAA,aAAa,OAAA;AACtB,yEAAuE;AAA9D,yHAAA,kBAAkB,OAAA;AAC3B,iEAA+D;AAAtD,iHAAA,cAAc,OAAA;AACvB,8DAA4D;AAAnD,+GAAA,aAAa,OAAA;AACtB,sEAAoE;AAA3D,uHAAA,iBAAiB,OAAA;AAC1B,4DAA0D;AAAjD,6GAAA,YAAY,OAAA"}

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

@@ -0,0 +1,13 @@
+import { PathLikeOrReadStream } from '../../common';
+export type EmulatedMediaType = 'screen' | 'print';
+export type ChromiumOptions = {
+    header?: PathLikeOrReadStream;
+    footer?: PathLikeOrReadStream;
+    emulatedMediaType?: EmulatedMediaType;
+    waitDelay?: string;
+    waitForExpression?: string;
+    extraHttpHeaders?: Record<string, string>;
+    failOnHttpStatusCodes?: number[];
+    failOnConsoleExceptions?: boolean;
+    skipNetworkIdleEvent?: boolean;
+};

package/dist/chromium/interfaces/common.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.types.js.map

package/dist/chromium/interfaces/common.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.types.js","sourceRoot":"","sources":["../../../src/chromium/interfaces/common.types.ts"],"names":[],"mappings":""}

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

@@ -1,4 +1,5 @@
-import { PathLikeOrReadStream, PdfFormat } from "../../common";
+import { PdfFormat } from '../../common';
+import { ChromiumOptions } from './common.types';
 type PageSize = {
     width: number;
     height: number;
@@ -10,6 +11,7 @@ type PageMargins = {
     right: number;
 };
 export type PageProperties = {
+    singlePage?: boolean;
     size?: PageSize;
     margins?: PageMargins;
     preferCssPageSize?: boolean;
@@ -22,18 +24,10 @@ export type PageProperties = {
         to: number;
     };
 };
-export type EmulatedMediaType = "screen" | "print";
-export type ConversionOptions = {
-    header?: PathLikeOrReadStream;
-    footer?: PathLikeOrReadStream;
+export type ConversionOptions = ChromiumOptions & {
     properties?: PageProperties;
     pdfFormat?: PdfFormat;
     pdfUA?: boolean;
-    emulatedMediaType?: EmulatedMediaType;
-    waitDelay?: string;
-    waitForExpression?: string;
     userAgent?: string;
-    extraHttpHeaders?: Record<string, string>;
-    failOnConsoleExceptions?: boolean;
 };
 export {};