chromiumly 2.7.0 → 2.8.0

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

@@ -0,0 +1,22 @@
+import { ImageProperties, ScreenshotOptions } from './../interfaces/screenshot.types';
+import FormData from 'form-data';
+/**
+ * Utility class for handling common tasks related to screenshot.
+ */
+export declare class ScreenshotUtils {
+    /**
+     * Adds page properties to the FormData object based on the provided imageProperties.
+     *
+     * @param {FormData} data - The FormData object to which page properties will be added.
+     * @param {ImageProperties} imageProperties - The page properties to be added to the FormData.
+     */
+    static addImageProperties(data: FormData, imageProperties: ImageProperties): void;
+    /**
+     * Customizes the FormData object based on the provided screenshot options.
+     *
+     * @param {FormData} data - The FormData object to be customized.
+     * @param {ScreenshotOptions} options - The screenshot options to apply to the FormData.
+     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
+     */
+    static customize(data: FormData, options: ScreenshotOptions): Promise<void>;
+}

package/dist/chromium/utils/screenshot.utils.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScreenshotUtils = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("../../common");
+/**
+ * Utility class for handling common tasks related to screenshot.
+ */
+class ScreenshotUtils {
+    /**
+     * Adds page properties to the FormData object based on the provided imageProperties.
+     *
+     * @param {FormData} data - The FormData object to which page properties will be added.
+     * @param {ImageProperties} imageProperties - The page properties to be added to the FormData.
+     */
+    static addImageProperties(data, imageProperties) {
+        data.append('format', imageProperties.format);
+        if (imageProperties.quality) {
+            common_1.GotenbergUtils.assert(imageProperties.format === 'jpeg', 'Compression quality is exclusively supported for JPEG format.');
+            common_1.GotenbergUtils.assert(imageProperties.quality >= 0 && imageProperties.quality <= 100, 'Invalid compression quality. Please provide a value between 0 and 100.');
+            data.append('quality', imageProperties.quality);
+        }
+        if (imageProperties.omitBackground) {
+            data.append('omitBackground', String(imageProperties.omitBackground));
+        }
+    }
+    /**
+     * Customizes the FormData object based on the provided screenshot options.
+     *
+     * @param {FormData} data - The FormData object to be customized.
+     * @param {ScreenshotOptions} options - The screenshot options to apply to the FormData.
+     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
+     */
+    static customize(data, options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (options.header) {
+                const { header } = options;
+                yield common_1.GotenbergUtils.addFile(data, header, 'header.html');
+            }
+            if (options.footer) {
+                const { footer } = options;
+                yield common_1.GotenbergUtils.addFile(data, footer, 'footer.html');
+            }
+            if (options.emulatedMediaType) {
+                data.append('emulatedMediaType', options.emulatedMediaType);
+            }
+            if (options.properties) {
+                ScreenshotUtils.addImageProperties(data, options.properties);
+            }
+            if (options.waitDelay) {
+                data.append('waitDelay', options.waitDelay);
+            }
+            if (options.waitForExpression) {
+                data.append('waitForExpression', options.waitForExpression);
+            }
+            if (options.extraHttpHeaders) {
+                data.append('extraHttpHeaders', JSON.stringify(options.extraHttpHeaders));
+            }
+            if (options.failOnHttpStatusCodes) {
+                data.append('failOnHttpStatusCodes', JSON.stringify(options.failOnHttpStatusCodes));
+            }
+            if (options.failOnConsoleExceptions) {
+                data.append('failOnConsoleExceptions', String(options.failOnConsoleExceptions));
+            }
+            if (options.skipNetworkIdleEvent) {
+                data.append('skipNetworkIdleEvent', String(options.skipNetworkIdleEvent));
+            }
+            if (options.optimizeForSpeed) {
+                data.append('optimizeForSpeed', String(options.optimizeForSpeed));
+            }
+        });
+    }
+}
+exports.ScreenshotUtils = ScreenshotUtils;
+//# sourceMappingURL=screenshot.utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.utils.js","sourceRoot":"","sources":["../../../src/chromium/utils/screenshot.utils.ts"],"names":[],"mappings":";;;;AAMA,yCAA8C;AAE9C;;GAEG;AACH,MAAa,eAAe;IACxB;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAC5B,IAAc,EACd,eAAgC;QAEhC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,uBAAc,CAAC,MAAM,CACjB,eAAe,CAAC,MAAM,KAAK,MAAM,EACjC,+DAA+D,CAClE,CAAC;YACF,uBAAc,CAAC,MAAM,CACjB,eAAe,CAAC,OAAO,IAAI,CAAC,IAAI,eAAe,CAAC,OAAO,IAAI,GAAG,EAC9D,wEAAwE,CAC3E,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CACP,gBAAgB,EAChB,MAAM,CAAC,eAAe,CAAC,cAAc,CAAC,CACzC,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAO,SAAS,CACzB,IAAc,EACd,OAA0B;;YAE1B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;gBAC3B,MAAM,uBAAc,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;YAC9D,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACjB,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;gBAC3B,MAAM,uBAAc,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;YAC9D,CAAC;YAED,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAChE,CAAC;YAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACrB,eAAe,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;YACjE,CAAC;YAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACpB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAChE,CAAC;YAED,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,IAAI,CAAC,MAAM,CACP,kBAAkB,EAClB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAC3C,CAAC;YACN,CAAC;YAED,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,CACP,uBAAuB,EACvB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAChD,CAAC;YACN,CAAC;YAED,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;gBAClC,IAAI,CAAC,MAAM,CACP,yBAAyB,EACzB,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAC1C,CAAC;YACN,CAAC;YAED,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;gBAC/B,IAAI,CAAC,MAAM,CACP,sBAAsB,EACtB,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CACvC,CAAC;YACN,CAAC;YAED,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;YACtE,CAAC;QACL,CAAC;KAAA;CACJ;AAvGD,0CAuGC"}

package/dist/main.config.d.ts

@@ -35,6 +35,11 @@ export declare class Chromiumly {
      * @type {string}
      */
     static readonly CHROMIUM_CONVERT_PATH = "forms/chromium/convert";
+    /**
+     * The path for Chromium-related screenshots.
+     * @type {string}
+     */
+    static readonly CHROMIUM_SCREENSHOT_PATH = "forms/chromium/screenshot";
     /**
      * The path for PDF engine-related operations.
      * @type {string}

package/dist/main.config.js

@@ -44,6 +44,11 @@ Chromiumly.GOTENBERG_ENDPOINT = gotenberg_1.Gotenberg.endpoint;
  * @type {string}
  */
 Chromiumly.CHROMIUM_CONVERT_PATH = 'forms/chromium/convert';
+/**
+ * The path for Chromium-related screenshots.
+ * @type {string}
+ */
+Chromiumly.CHROMIUM_SCREENSHOT_PATH = 'forms/chromium/screenshot';
 /**
  * The path for PDF engine-related operations.
  * @type {string}

package/dist/main.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.config.js","sourceRoot":"","sources":["../src/main.config.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAExC;;;GAGG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,sCAAqB,CAAA;AACzB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAED;;;GAGG;AACH,IAAK,cAEJ;AAFD,WAAK,cAAc;IACf,iCAAe,CAAA;AACnB,CAAC,EAFI,cAAc,KAAd,cAAc,QAElB;AAED;;;GAGG;AACH,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACjB,uCAAmB,CAAA;AACvB,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AAED;;GAEG;AACH,MAAa,UAAU;;AAAvB,gCAkDC;AAjDG;;;GAGG;AACoB,6BAAkB,GAAG,qBAAS,CAAC,QAAQ,CAAC;AAE/D;;;GAGG;AACoB,gCAAqB,GAAG,wBAAwB,CAAC;AAExE;;;GAGG;AACoB,2BAAgB,GAAG,kBAAkB,CAAC;AAE7D;;;GAGG;AACoB,4BAAiB,GAAG,mBAAmB,CAAC;AAE/D;;;GAGG;AACoB,0BAAe,GAAG;IACrC,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,QAAQ,EAAE,aAAa,CAAC,QAAQ;CACnC,CAAC;AAEF;;;GAGG;AACoB,4BAAiB,GAAG;IACvC,KAAK,EAAE,cAAc,CAAC,KAAK;CAC9B,CAAC;AAEF;;;GAGG;AACoB,8BAAmB,GAAG;IACzC,OAAO,EAAE,gBAAgB,CAAC,OAAO;CACpC,CAAC"}
+{"version":3,"file":"main.config.js","sourceRoot":"","sources":["../src/main.config.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAExC;;;GAGG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,sCAAqB,CAAA;AACzB,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB;AAED;;;GAGG;AACH,IAAK,cAEJ;AAFD,WAAK,cAAc;IACf,iCAAe,CAAA;AACnB,CAAC,EAFI,cAAc,KAAd,cAAc,QAElB;AAED;;;GAGG;AACH,IAAK,gBAEJ;AAFD,WAAK,gBAAgB;IACjB,uCAAmB,CAAA;AACvB,CAAC,EAFI,gBAAgB,KAAhB,gBAAgB,QAEpB;AAED;;GAEG;AACH,MAAa,UAAU;;AAAvB,gCAwDC;AAvDG;;;GAGG;AACoB,6BAAkB,GAAG,qBAAS,CAAC,QAAQ,CAAC;AAE/D;;;GAGG;AACoB,gCAAqB,GAAG,wBAAwB,CAAC;AAExE;;;GAGG;AACoB,mCAAwB,GAC3C,2BAA2B,CAAC;AAChC;;;GAGG;AACoB,2BAAgB,GAAG,kBAAkB,CAAC;AAE7D;;;GAGG;AACoB,4BAAiB,GAAG,mBAAmB,CAAC;AAE/D;;;GAGG;AACoB,0BAAe,GAAG;IACrC,GAAG,EAAE,aAAa,CAAC,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC,IAAI;IACxB,QAAQ,EAAE,aAAa,CAAC,QAAQ;CACnC,CAAC;AAEF;;;GAGG;AACoB,4BAAiB,GAAG;IACvC,KAAK,EAAE,cAAc,CAAC,KAAK;CAC9B,CAAC;AAEF;;;GAGG;AACoB,8BAAmB,GAAG;IACzC,OAAO,EAAE,gBAAgB,CAAC,OAAO;CACpC,CAAC"}

package/dist/main.d.ts

@@ -1,3 +1,3 @@
 export { PdfFormat } from './common/constants';
-export { HtmlConverter, MarkdownConverter, UrlConverter } from './chromium';
+export { HtmlConverter, HtmlScreenshot, MarkdownConverter, MarkdownScreenshot, UrlConverter, UrlScreenshot } from './chromium';
 export { PDFEngine } from './pdf-engines';

package/dist/main.js

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PDFEngine = exports.UrlConverter = exports.MarkdownConverter = exports.HtmlConverter = exports.PdfFormat = void 0;
+exports.PDFEngine = exports.UrlScreenshot = exports.UrlConverter = exports.MarkdownScreenshot = exports.MarkdownConverter = exports.HtmlScreenshot = exports.HtmlConverter = exports.PdfFormat = void 0;
 var constants_1 = require("./common/constants");
 Object.defineProperty(exports, "PdfFormat", { enumerable: true, get: function () { return constants_1.PdfFormat; } });
 var chromium_1 = require("./chromium");
 Object.defineProperty(exports, "HtmlConverter", { enumerable: true, get: function () { return chromium_1.HtmlConverter; } });
+Object.defineProperty(exports, "HtmlScreenshot", { enumerable: true, get: function () { return chromium_1.HtmlScreenshot; } });
 Object.defineProperty(exports, "MarkdownConverter", { enumerable: true, get: function () { return chromium_1.MarkdownConverter; } });
+Object.defineProperty(exports, "MarkdownScreenshot", { enumerable: true, get: function () { return chromium_1.MarkdownScreenshot; } });
 Object.defineProperty(exports, "UrlConverter", { enumerable: true, get: function () { return chromium_1.UrlConverter; } });
+Object.defineProperty(exports, "UrlScreenshot", { enumerable: true, get: function () { return chromium_1.UrlScreenshot; } });
 var pdf_engines_1 = require("./pdf-engines");
 Object.defineProperty(exports, "PDFEngine", { enumerable: true, get: function () { return pdf_engines_1.PDFEngine; } });
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,uCAA4E;AAAnE,yGAAA,aAAa,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,wGAAA,YAAY,OAAA;AACvD,6CAA0C;AAAjC,wGAAA,SAAS,OAAA"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,uCAOoB;AANhB,yGAAA,aAAa,OAAA;AACb,0GAAA,cAAc,OAAA;AACd,6GAAA,iBAAiB,OAAA;AACjB,8GAAA,kBAAkB,OAAA;AAClB,wGAAA,YAAY,OAAA;AACZ,yGAAA,aAAa,OAAA;AAEjB,6CAA0C;AAAjC,wGAAA,SAAS,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chromiumly",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "A lightweight Typescript library that interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -50,10 +50,10 @@
     "@types/dotenv": "8.2.0",
     "@types/form-data": "2.5.0",
     "@types/jest": "29.5.12",
-    "@types/node": "20.11.20",
+    "@types/node": "20.11.24",
     "@types/node-fetch": "2.6.11",
-    "@typescript-eslint/eslint-plugin": "7.1.0",
-    "@typescript-eslint/parser": "7.1.0",
+    "@typescript-eslint/eslint-plugin": "7.1.1",
+    "@typescript-eslint/parser": "7.1.1",
     "commitizen": "4.3.0",
     "eslint": "8.57.0",
     "eslint-config-prettier": "^9.1.0",

package/src/chromium/index.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/src/chromium/interfaces/screenshot.types.ts

@@ -0,0 +1,12 @@
+import { ChromiumOptions } from './common.types';
+
+export 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.
+};
+
+export type ScreenshotOptions = ChromiumOptions & {
+    properties?: ImageProperties;
+    optimizeForSpeed?: boolean; // Define whether to optimize image encoding for speed, not for resulting size.
+};

package/src/chromium/screenshots/html.screenshot.ts

@@ -0,0 +1,100 @@
+import FormData from 'form-data';
+
+import { GotenbergUtils, PathLikeOrReadStream } from '../../common';
+import { ChromiumRoute } from '../../main.config';
+import { EmulatedMediaType } from '../interfaces/common.types';
+import { ScreenshotUtils } from '../utils/screenshot.utils';
+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 class HtmlScreenshot extends Screenshot {
+    /**
+     * Creates an instance of HtmlScreenshot.
+     * Initializes the Screenshot with the HTML screenshot route.
+     */
+    constructor() {
+        super(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.
+     */
+    async 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> {
+        const data = new FormData();
+
+        await GotenbergUtils.addFile(data, html, 'index.html');
+
+        if (assets?.length) {
+            await Promise.all(
+                assets.map(({ file, name }) =>
+                    GotenbergUtils.addFile(data, file, name)
+                )
+            );
+        }
+
+        await ScreenshotUtils.customize(data, {
+            header,
+            footer,
+            properties,
+            emulatedMediaType,
+            waitDelay,
+            waitForExpression,
+            extraHttpHeaders,
+            failOnHttpStatusCodes,
+            failOnConsoleExceptions,
+            skipNetworkIdleEvent,
+            optimizeForSpeed
+        });
+
+        return GotenbergUtils.fetch(this.endpoint, data);
+    }
+}

package/src/chromium/screenshots/markdown.screenshot.ts

@@ -0,0 +1,95 @@
+import FormData from 'form-data';
+
+import { GotenbergUtils, PathLikeOrReadStream } from '../../common';
+import { ImageProperties } from '../interfaces/screenshot.types';
+import { ScreenshotUtils } from '../utils/screenshot.utils';
+import { Screenshot } from './screenshot';
+import { ChromiumRoute } from '../../main.config';
+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 class MarkdownScreenshot extends Screenshot {
+    /**
+     * Creates an instance of MarkdownScreenshot.
+     * Initializes the Screenshot with the Markdown screenshot route.
+     */
+    constructor() {
+        super(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.
+     */
+    async 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> {
+        const data = new FormData();
+
+        await GotenbergUtils.addFile(data, html, 'index.html');
+
+        await GotenbergUtils.addFile(data, markdown, 'file.md');
+
+        await ScreenshotUtils.customize(data, {
+            header,
+            footer,
+            properties,
+            emulatedMediaType,
+            waitDelay,
+            waitForExpression,
+            extraHttpHeaders,
+            failOnHttpStatusCodes,
+            failOnConsoleExceptions,
+            skipNetworkIdleEvent,
+            optimizeForSpeed
+        });
+
+        return GotenbergUtils.fetch(this.endpoint, data);
+    }
+}

package/src/chromium/screenshots/screenshot.ts

@@ -0,0 +1,22 @@
+import { Chromiumly, ChromiumRoute } from '../../main.config';
+
+/**
+ * Abstract class representing a generic screenshot.
+ * Concrete screenshot classes should extend this class and implement specific screenshot logic.
+ */
+export 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) {
+        this.endpoint = `${Chromiumly.GOTENBERG_ENDPOINT}/${Chromiumly.CHROMIUM_SCREENSHOT_PATH}/${Chromiumly.CHROMIUM_ROUTES[route]}`;
+    }
+}

package/src/chromium/screenshots/tests/html.screenshot.test.ts

@@ -0,0 +1,192 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { createReadStream, promises } from 'fs';
+
+import fetch from 'node-fetch';
+import FormData from 'form-data';
+
+import { HtmlScreenshot } from '../html.screenshot';
+
+const { Response } = jest.requireActual('node-fetch');
+jest.mock('node-fetch', () => jest.fn());
+
+describe('HtmlScreenshot', () => {
+    const screenshot = new HtmlScreenshot();
+
+    describe('endpoint', () => {
+        it('should route to Chromium HTML route', () => {
+            expect(screenshot.endpoint).toEqual(
+                'http://localhost:3000/forms/chromium/screenshot/html'
+            );
+        });
+    });
+
+    describe('capture', () => {
+        const mockPromisesAccess = jest.spyOn(promises, 'access');
+        const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
+        const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
+
+        const assets = [
+            { file: Buffer.from('asset1'), name: 'asset1' },
+            { file: Buffer.from('asset2'), name: 'asset2' }
+        ];
+
+        beforeEach(() => {
+            (createReadStream as jest.Mock) = jest.fn();
+        });
+
+        afterEach(() => {
+            jest.resetAllMocks();
+        });
+
+        describe('when html parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data')
+                });
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when image properties parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    properties: { format: 'jpeg', quality: 50 }
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when header parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    header: Buffer.from('header')
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when footer parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    footer: Buffer.from('footer')
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when assets parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    assets
+                });
+
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when emulatedMediaType parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    emulatedMediaType: 'screen'
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when failOnHttpStatusCodes parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    failOnHttpStatusCodes: [499, 599]
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when skipNetworkIdleEvent parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    skipNetworkIdleEvent: true
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when optimizeForSpeed parameter is passed', () => {
+            it('should return a buffer', async () => {
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    optimizeForSpeed: true
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when all parameters are passed', () => {
+            it('should return a buffer', async () => {
+                mockPromisesAccess.mockResolvedValue();
+                mockFetch.mockResolvedValue(new Response('content'));
+                const buffer = await screenshot.capture({
+                    html: Buffer.from('data'),
+                    assets,
+                    header: Buffer.from('header'),
+                    footer: Buffer.from('footer'),
+                    emulatedMediaType: 'screen',
+                    failOnHttpStatusCodes: [499, 599],
+                    skipNetworkIdleEvent: true,
+                    failOnConsoleExceptions: true,
+                    properties: { format: 'jpeg', quality: 50 },
+                    optimizeForSpeed: true
+                });
+                expect(mockFormDataAppend).toHaveBeenCalledTimes(12);
+                expect(buffer).toEqual(Buffer.from('content'));
+            });
+        });
+
+        describe('when file does not exist', () => {
+            it('should throw an error', async () => {
+                const errorMessage =
+                    "ENOENT: no such file or directory, access 'path/to/index.html'";
+                mockPromisesAccess.mockRejectedValue(new Error(errorMessage));
+                await expect(() =>
+                    screenshot.capture({ html: 'path/to/index.html' })
+                ).rejects.toThrow(errorMessage);
+            });
+        });
+
+        describe('when fetch request fails', () => {
+            it('should throw an error', async () => {
+                const errorMessage =
+                    'FetchError: request to http://localhost:3000/forms/chromium/screenshot/html failed';
+                mockPromisesAccess.mockResolvedValue();
+                mockFetch.mockRejectedValue(new Error(errorMessage));
+                await expect(() =>
+                    screenshot.capture({ html: 'path/to/index.html' })
+                ).rejects.toThrow(errorMessage);
+            });
+        });
+    });
+});