chromiumly 2.7.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:
@@ -62,16 +85,18 @@ 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
@@ -83,6 +108,15 @@ const buffer = await urlConverter.convert({
 });
 ```
 
+```typescript
+import { UrlScreenshot } from "chromiumly";
+
+const screenshot = new UrlScreenshot();
+const buffer = await screenshot.capture({
+  url: "https://www.example.com/",
+});
+```
+
 #### HTML
 
 The only requirement is that the file name should be `index.html`.
@@ -96,6 +130,15 @@ const buffer = await htmlConverter.convert({
 });
 ```
 
+```typescript
+import { HtmlScreenshot } from "chromiumly";
+
+const screenshot = new HtmlScreenshot();
+const buffer = await screenshot.capture({
+  html: "path/to/index.html",
+});
+```
+
 #### Markdown
 
 This route accepts an `index.html` file plus a markdown file.
@@ -110,8 +153,20 @@ const buffer = await markdownConverter.convert({
 });
 ```
 
+```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.
 
@@ -157,17 +212,47 @@ type ConversionOptions = {
 };
 ```
 
+#### 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";
@@ -185,7 +270,7 @@ 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).

package/dist/chromium/index.d.ts

@@ -1,3 +1,6 @@
+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,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,+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/screenshot.types.d.ts

@@ -0,0 +1,10 @@
+import { ChromiumOptions } from './common.types';
+export type ImageProperties = {
+    format: 'png' | 'jpeg' | 'webp';
+    quality?: number;
+    omitBackground?: boolean;
+};
+export type ScreenshotOptions = ChromiumOptions & {
+    properties?: ImageProperties;
+    optimizeForSpeed?: boolean;
+};

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

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

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

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

package/dist/chromium/screenshots/html.screenshot.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="node" />
+import { PathLikeOrReadStream } from '../../common';
+import { EmulatedMediaType } from '../interfaces/common.types';
+import { Screenshot } from './screenshot';
+import { ImageProperties } from '../interfaces/screenshot.types';
+/**
+ * Class representing an HTML Screenshot that extends the base Screenshot class.
+ * This class is used to screenshot HTML content using Gotenberg service.
+ *
+ * @extends Screenshot
+ */
+export declare class HtmlScreenshot extends Screenshot {
+    /**
+     * Creates an instance of HtmlScreenshot.
+     * Initializes the Screenshot with the HTML screenshot route.
+     */
+    constructor();
+    /**
+     * Screenshots HTML content.
+     *
+     * @param {Object} options - Screenshot options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be screenshoted.
+     * @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 {ImageProperties} [options.properties] - Image properties for the screenshot.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
+     * @param {string} [options.waitDelay] - Delay before the screenshot process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
+     * @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
+     * @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
+     * @returns {Promise<Buffer>} A Promise resolving to the image buffer.
+     */
+    capture({ html, assets, header, footer, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnConsoleExceptions, failOnHttpStatusCodes, skipNetworkIdleEvent, optimizeForSpeed }: {
+        html: PathLikeOrReadStream;
+        assets?: {
+            file: PathLikeOrReadStream;
+            name: string;
+        }[];
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
+        properties?: ImageProperties;
+        emulatedMediaType?: EmulatedMediaType;
+        waitDelay?: string;
+        waitForExpression?: string;
+        extraHttpHeaders?: Record<string, string>;
+        failOnConsoleExceptions?: boolean;
+        failOnHttpStatusCodes?: number[];
+        skipNetworkIdleEvent?: boolean;
+        optimizeForSpeed?: boolean;
+    }): Promise<Buffer>;
+}

package/dist/chromium/screenshots/html.screenshot.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HtmlScreenshot = void 0;
+const tslib_1 = require("tslib");
+const form_data_1 = tslib_1.__importDefault(require("form-data"));
+const common_1 = require("../../common");
+const main_config_1 = require("../../main.config");
+const screenshot_utils_1 = require("../utils/screenshot.utils");
+const screenshot_1 = require("./screenshot");
+/**
+ * Class representing an HTML Screenshot that extends the base Screenshot class.
+ * This class is used to screenshot HTML content using Gotenberg service.
+ *
+ * @extends Screenshot
+ */
+class HtmlScreenshot extends screenshot_1.Screenshot {
+    /**
+     * Creates an instance of HtmlScreenshot.
+     * Initializes the Screenshot with the HTML screenshot route.
+     */
+    constructor() {
+        super(main_config_1.ChromiumRoute.HTML);
+    }
+    /**
+     * Screenshots HTML content.
+     *
+     * @param {Object} options - Screenshot options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be screenshoted.
+     * @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 {ImageProperties} [options.properties] - Image properties for the screenshot.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
+     * @param {string} [options.waitDelay] - Delay before the screenshot process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
+     * @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
+     * @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
+     * @returns {Promise<Buffer>} A Promise resolving to the image buffer.
+     */
+    capture({ html, assets, header, footer, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnConsoleExceptions, failOnHttpStatusCodes, skipNetworkIdleEvent, optimizeForSpeed }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const data = new form_data_1.default();
+            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 }) => common_1.GotenbergUtils.addFile(data, file, name)));
+            }
+            yield screenshot_utils_1.ScreenshotUtils.customize(data, {
+                header,
+                footer,
+                properties,
+                emulatedMediaType,
+                waitDelay,
+                waitForExpression,
+                extraHttpHeaders,
+                failOnHttpStatusCodes,
+                failOnConsoleExceptions,
+                skipNetworkIdleEvent,
+                optimizeForSpeed
+            });
+            return common_1.GotenbergUtils.fetch(this.endpoint, data);
+        });
+    }
+}
+exports.HtmlScreenshot = HtmlScreenshot;
+//# sourceMappingURL=html.screenshot.js.map

package/dist/chromium/screenshots/html.screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.screenshot.js","sourceRoot":"","sources":["../../../src/chromium/screenshots/html.screenshot.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAAoE;AACpE,mDAAkD;AAElD,gEAA4D;AAC5D,6CAA0C;AAG1C;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,uBAAU;IAC1C;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,EACV,IAAI,EACJ,MAAM,EACN,MAAM,EACN,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAenB;;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,kCAAe,CAAC,SAAS,CAAC,IAAI,EAAE;gBAClC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,gBAAgB;gBAChB,qBAAqB;gBACrB,uBAAuB;gBACvB,oBAAoB;gBACpB,gBAAgB;aACnB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AApFD,wCAoFC"}

package/dist/chromium/screenshots/markdown.screenshot.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+import { PathLikeOrReadStream } from '../../common';
+import { ImageProperties } from '../interfaces/screenshot.types';
+import { Screenshot } from './screenshot';
+import { EmulatedMediaType } from '../interfaces/common.types';
+/**
+ * Class representing a Markdown screenshot that extends the base Screenshot class.
+ * This class is used to screenshots HTML with markdown content using Gotenberg service.
+ *
+ * @extends Screenshot
+ */
+export declare class MarkdownScreenshot extends Screenshot {
+    /**
+     * Creates an instance of MarkdownScreenshot.
+     * Initializes the Screenshot with the Markdown screenshot route.
+     */
+    constructor();
+    /**
+     * Screenshots HTML with markdown.
+     *
+     * @param {Object} options - Screenshot options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be screenshoted.
+     * @param {PathLikeOrReadStream} options.markdown - PathLike or ReadStream of the Markdown content to be screenshoted.
+     * @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 {ImageProperties} [options.properties] - Image properties for the screenshot.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
+     * @param {string} [options.waitDelay] - Delay before the screenshot process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
+     * @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
+     * @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
+     * @returns {Promise<Buffer>} A Promise resolving to the image buffer.
+     */
+    capture({ html, markdown, header, footer, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent, optimizeForSpeed }: {
+        html: PathLikeOrReadStream;
+        markdown: PathLikeOrReadStream;
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
+        properties?: ImageProperties;
+        emulatedMediaType?: EmulatedMediaType;
+        waitDelay?: string;
+        waitForExpression?: string;
+        extraHttpHeaders?: Record<string, string>;
+        failOnHttpStatusCodes?: number[];
+        failOnConsoleExceptions?: boolean;
+        skipNetworkIdleEvent?: boolean;
+        optimizeForSpeed?: boolean;
+    }): Promise<Buffer>;
+}

package/dist/chromium/screenshots/markdown.screenshot.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownScreenshot = void 0;
+const tslib_1 = require("tslib");
+const form_data_1 = tslib_1.__importDefault(require("form-data"));
+const common_1 = require("../../common");
+const screenshot_utils_1 = require("../utils/screenshot.utils");
+const screenshot_1 = require("./screenshot");
+const main_config_1 = require("../../main.config");
+/**
+ * Class representing a Markdown screenshot that extends the base Screenshot class.
+ * This class is used to screenshots HTML with markdown content using Gotenberg service.
+ *
+ * @extends Screenshot
+ */
+class MarkdownScreenshot extends screenshot_1.Screenshot {
+    /**
+     * Creates an instance of MarkdownScreenshot.
+     * Initializes the Screenshot with the Markdown screenshot route.
+     */
+    constructor() {
+        super(main_config_1.ChromiumRoute.MARKDOWN);
+    }
+    /**
+     * Screenshots HTML with markdown.
+     *
+     * @param {Object} options - Screenshot options.
+     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be screenshoted.
+     * @param {PathLikeOrReadStream} options.markdown - PathLike or ReadStream of the Markdown content to be screenshoted.
+     * @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 {ImageProperties} [options.properties] - Image properties for the screenshot.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
+     * @param {string} [options.waitDelay] - Delay before the screenshot process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
+     * @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
+     * @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
+     * @returns {Promise<Buffer>} A Promise resolving to the image buffer.
+     */
+    capture({ html, markdown, header, footer, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent, optimizeForSpeed }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const data = new form_data_1.default();
+            yield common_1.GotenbergUtils.addFile(data, html, 'index.html');
+            yield common_1.GotenbergUtils.addFile(data, markdown, 'file.md');
+            yield screenshot_utils_1.ScreenshotUtils.customize(data, {
+                header,
+                footer,
+                properties,
+                emulatedMediaType,
+                waitDelay,
+                waitForExpression,
+                extraHttpHeaders,
+                failOnHttpStatusCodes,
+                failOnConsoleExceptions,
+                skipNetworkIdleEvent,
+                optimizeForSpeed
+            });
+            return common_1.GotenbergUtils.fetch(this.endpoint, data);
+        });
+    }
+}
+exports.MarkdownScreenshot = MarkdownScreenshot;
+//# sourceMappingURL=markdown.screenshot.js.map

package/dist/chromium/screenshots/markdown.screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.screenshot.js","sourceRoot":"","sources":["../../../src/chromium/screenshots/markdown.screenshot.ts"],"names":[],"mappings":";;;;AAAA,kEAAiC;AAEjC,yCAAoE;AAEpE,gEAA4D;AAC5D,6CAA0C;AAC1C,mDAAkD;AAGlD;;;;;GAKG;AACH,MAAa,kBAAmB,SAAQ,uBAAU;IAC9C;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,OAAO,CAAC,EACV,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,EAenB;;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,kCAAe,CAAC,SAAS,CAAC,IAAI,EAAE;gBAClC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,gBAAgB;gBAChB,qBAAqB;gBACrB,uBAAuB;gBACvB,oBAAoB;gBACpB,gBAAgB;aACnB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA/ED,gDA+EC"}

package/dist/chromium/screenshots/screenshot.d.ts

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

package/dist/chromium/screenshots/screenshot.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Screenshot = void 0;
+const main_config_1 = require("../../main.config");
+/**
+ * Abstract class representing a generic screenshot.
+ * Concrete screenshot classes should extend this class and implement specific screenshot logic.
+ */
+class Screenshot {
+    /**
+     * Creates an instance of the screenshot class.
+     * Initializes the endpoint URL based on the provided ChromiumRoute.
+     *
+     * @param {ChromiumRoute} route - The ChromiumRoute enum value representing the screenshot route.
+     */
+    constructor(route) {
+        this.endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.CHROMIUM_SCREENSHOT_PATH}/${main_config_1.Chromiumly.CHROMIUM_ROUTES[route]}`;
+    }
+}
+exports.Screenshot = Screenshot;
+//# sourceMappingURL=screenshot.js.map

package/dist/chromium/screenshots/screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../../src/chromium/screenshots/screenshot.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAE9D;;;GAGG;AACH,MAAsB,UAAU;IAM5B;;;;;OAKG;IACH,YAAY,KAAoB;QAC5B,IAAI,CAAC,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,wBAAwB,IAAI,wBAAU,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IACnI,CAAC;CACJ;AAfD,gCAeC"}

package/dist/chromium/screenshots/url.screenshot.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { PathLikeOrReadStream } from '../../common';
+import { ImageProperties } from '../interfaces/screenshot.types';
+import { Screenshot } from './screenshot';
+import { EmulatedMediaType } from '../interfaces/common.types';
+/**
+ * Class representing a URL screenshot that extends the base screenshot class.
+ * This class is used to screenshot a URL using Gotenberg service.
+ *
+ * @extends Screenshot
+ */
+export declare class UrlScreenshot extends Screenshot {
+    /**
+     * Creates an instance of UrlScreenshot.
+     * Initializes the screenshot with the URL screenshot route.
+     */
+    constructor();
+    /**
+     * Screenshots URL.
+     *
+     * @param {Object} options - Screenshot options.
+     * @param {string} options.url - The URL of the content to be screenshoted
+     * @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 {ImageProperties} [options.properties] - Image properties for the screenshot.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
+     * @param {string} [options.waitDelay] - Delay before the screenshot process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
+     * @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
+     * @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
+     * @returns {Promise<Buffer>} A Promise resolving to the image buffer.
+     */
+    capture({ url, header, footer, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent, optimizeForSpeed }: {
+        url: string;
+        header?: PathLikeOrReadStream;
+        footer?: PathLikeOrReadStream;
+        properties?: ImageProperties;
+        emulatedMediaType?: EmulatedMediaType;
+        waitDelay?: string;
+        waitForExpression?: string;
+        extraHttpHeaders?: Record<string, string>;
+        failOnHttpStatusCodes?: number[];
+        failOnConsoleExceptions?: boolean;
+        skipNetworkIdleEvent?: boolean;
+        optimizeForSpeed?: boolean;
+    }): Promise<Buffer>;
+}

package/dist/chromium/screenshots/url.screenshot.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlScreenshot = void 0;
+const tslib_1 = require("tslib");
+const url_1 = require("url");
+const form_data_1 = tslib_1.__importDefault(require("form-data"));
+const common_1 = require("../../common");
+const screenshot_utils_1 = require("../utils/screenshot.utils");
+const screenshot_1 = require("./screenshot");
+const main_config_1 = require("../../main.config");
+/**
+ * Class representing a URL screenshot that extends the base screenshot class.
+ * This class is used to screenshot a URL using Gotenberg service.
+ *
+ * @extends Screenshot
+ */
+class UrlScreenshot extends screenshot_1.Screenshot {
+    /**
+     * Creates an instance of UrlScreenshot.
+     * Initializes the screenshot with the URL screenshot route.
+     */
+    constructor() {
+        super(main_config_1.ChromiumRoute.URL);
+    }
+    /**
+     * Screenshots URL.
+     *
+     * @param {Object} options - Screenshot options.
+     * @param {string} options.url - The URL of the content to be screenshoted
+     * @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 {ImageProperties} [options.properties] - Image properties for the screenshot.
+     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the screenshot.
+     * @param {string} [options.waitDelay] - Delay before the screenshot process starts.
+     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the screenshot.
+     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the screenshot.
+     * @param {number []} [options.failOnHttpStatusCodes] - Whether to fail on HTTP status code.
+     * @param {boolean} [options.failOnConsoleExceptions] - Whether to fail on console exceptions during screenshot.
+     * @param {boolean} [options.skipNetworkIdleEvent] - Whether to skip network idle event.
+     * @param {boolean} [options.optimizeForSpeed] - Whether to optimize for speed.
+     * @returns {Promise<Buffer>} A Promise resolving to the image buffer.
+     */
+    capture({ url, header, footer, properties, emulatedMediaType, waitDelay, waitForExpression, extraHttpHeaders, failOnHttpStatusCodes, failOnConsoleExceptions, skipNetworkIdleEvent, optimizeForSpeed }) {
+        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);
+            yield screenshot_utils_1.ScreenshotUtils.customize(data, {
+                header,
+                footer,
+                properties,
+                emulatedMediaType,
+                waitDelay,
+                waitForExpression,
+                extraHttpHeaders,
+                failOnHttpStatusCodes,
+                failOnConsoleExceptions,
+                skipNetworkIdleEvent,
+                optimizeForSpeed
+            });
+            return common_1.GotenbergUtils.fetch(this.endpoint, data);
+        });
+    }
+}
+exports.UrlScreenshot = UrlScreenshot;
+//# sourceMappingURL=url.screenshot.js.map

package/dist/chromium/screenshots/url.screenshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.screenshot.js","sourceRoot":"","sources":["../../../src/chromium/screenshots/url.screenshot.ts"],"names":[],"mappings":";;;;AAAA,6BAA0B;AAC1B,kEAAiC;AACjC,yCAAoE;AAEpE,gEAA4D;AAC5D,6CAA0C;AAC1C,mDAAkD;AAGlD;;;;;GAKG;AACH,MAAa,aAAc,SAAQ,uBAAU;IACzC;;;OAGG;IACH;QACI,KAAK,CAAC,2BAAa,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,EACV,GAAG,EACH,MAAM,EACN,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,EAcnB;;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,kCAAe,CAAC,SAAS,CAAC,IAAI,EAAE;gBAClC,MAAM;gBACN,MAAM;gBACN,UAAU;gBACV,iBAAiB;gBACjB,SAAS;gBACT,iBAAiB;gBACjB,gBAAgB;gBAChB,qBAAqB;gBACrB,uBAAuB;gBACvB,oBAAoB;gBACpB,gBAAgB;aACnB,CAAC,CAAC;YAEH,OAAO,uBAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;CACJ;AA3ED,sCA2EC"}