chromiumly 2.7.0 → 2.9.0

package/dist/pdf-engines/pdf.engine.js

@@ -20,8 +20,8 @@ class PDFEngine {
      * @param {PathLikeOrReadStream[]} options.files - An array of PathLikes or ReadStreams to the PDF files to be merged.
      * @returns {Promise<Buffer>} A Promise resolving to the merged PDF content as a Buffer.
      */
-    static merge({ files }) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+    static merge(_a) {
+        return tslib_1.__awaiter(this, arguments, void 0, function* ({ files }) {
             const data = new form_data_1.default();
             yield engine_utils_1.PDFEngineUtils.addFiles(files, data);
             const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.PDF_ENGINES_PATH}/${main_config_1.Chromiumly.PDF_ENGINE_ROUTES.merge}`;
@@ -39,8 +39,8 @@ class PDFEngine {
      * @param {boolean} [options.merge] - Indicates whether to merge the resulting PDFs.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
-    static convert({ files, properties, pdfFormat, pdfUA, merge }) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+    static convert(_a) {
+        return tslib_1.__awaiter(this, arguments, void 0, function* ({ files, properties, pdfFormat, pdfUA, merge }) {
             const data = new form_data_1.default();
             if (pdfFormat) {
                 data.append('pdfa', pdfFormat);
@@ -59,6 +59,36 @@ class PDFEngine {
             return common_1.GotenbergUtils.fetch(endpoint, data);
         });
     }
+    /**
+     * Reads metadata from the provided files.
+     *
+     * @param {PathLikeOrReadStream[]} files An array of PathLikes or ReadStreams to the PDF files.
+     * @returns {Promise<Buffer>} A Promise resolving to the metadata buffer.
+     */
+    static readMetadata(files) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const data = new form_data_1.default();
+            yield engine_utils_1.PDFEngineUtils.addFiles(files, data);
+            const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.PDF_ENGINES_PATH}/${main_config_1.Chromiumly.PDF_ENGINE_ROUTES.readMetadata}`;
+            return common_1.GotenbergUtils.fetch(endpoint, data);
+        });
+    }
+    /**
+     * Writes metadata to the provided PDF files.
+     *
+     * @param {PathLikeOrReadStream[]} files - An array of PathLikes or ReadStreams to the PDF files.
+     * @param {Metadata} metadata - Metadata to be written.
+     * @returns {Promise<Buffer>} A Promise that resolves to the PDF file containing metadata as a buffer.
+     */
+    static writeMetadata(_a) {
+        return tslib_1.__awaiter(this, arguments, void 0, function* ({ files, metadata }) {
+            const data = new form_data_1.default();
+            data.append('metadata', JSON.stringify(metadata));
+            yield engine_utils_1.PDFEngineUtils.addFiles(files, data);
+            const endpoint = `${main_config_1.Chromiumly.GOTENBERG_ENDPOINT}/${main_config_1.Chromiumly.PDF_ENGINES_PATH}/${main_config_1.Chromiumly.PDF_ENGINE_ROUTES.writeMetadata}`;
+            return common_1.GotenbergUtils.fetch(endpoint, data);
+        });
+    }
     /**
      * Generates a PDF file from a buffer and saves it to the "__generated__" directory.
      *

package/dist/pdf-engines/pdf.engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"pdf.engine.js","sourceRoot":"","sources":["../../src/pdf-engines/pdf.engine.ts"],"names":[],"mappings":";;;;AAAA,2BAA8B;AAC9B,wDAAwB;AAExB,kEAAiC;AAEjC,gDAA4C;AAC5C,sCAA4E;AAC5E,kDAAmE;AACnE,uDAAsD;AAEtD;;GAEG;AACH,MAAa,SAAS;IAClB;;;;;;OAMG;IACI,MAAM,CAAO,KAAK,CAAC,EACtB,KAAK,EAGR;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YACzH,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAO,OAAO,CAAC,EACxB,KAAK,EACL,UAAU,EACV,SAAS,EACT,KAAK,EACL,KAAK,EAOR;;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACnC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACb,+BAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,+BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE7C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,iBAAiB,IAAI,wBAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAE9H,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,QAAgB,EAChB,MAAc;;YAEd,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC;YACnE,MAAM,aAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,MAAM,aAAQ,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;KAAA;CACJ;AAnFD,8BAmFC"}
+{"version":3,"file":"pdf.engine.js","sourceRoot":"","sources":["../../src/pdf-engines/pdf.engine.ts"],"names":[],"mappings":";;;;AAAA,2BAA8B;AAC9B,wDAAwB;AAExB,kEAAiC;AAEjC,gDAA4C;AAC5C,sCAKmB;AACnB,kDAAmE;AACnE,uDAAsD;AAEtD;;GAEG;AACH,MAAa,SAAS;IAClB;;;;;;OAMG;IACI,MAAM,CAAO,KAAK;qEAAC,EACtB,KAAK,EAGR;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;YACzH,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAO,OAAO;qEAAC,EACxB,KAAK,EACL,UAAU,EACV,SAAS,EACT,KAAK,EACL,KAAK,EAWR;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,SAAS,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACnC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxC,CAAC;YAED,IAAI,UAAU,EAAE,CAAC;gBACb,+BAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,+BAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE7C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,iBAAiB,IAAI,wBAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;YAE9H,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;OAKG;IACI,MAAM,CAAO,YAAY,CAC5B,KAA6B;;YAE7B,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,YAAY,EAAE,CAAC;YAEhI,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,aAAa;qEAAC,EAC9B,KAAK,EACL,QAAQ,EAIX;YACG,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YAElD,MAAM,6BAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE3C,MAAM,QAAQ,GAAG,GAAG,wBAAU,CAAC,kBAAkB,IAAI,wBAAU,CAAC,gBAAgB,IAAI,wBAAU,CAAC,iBAAiB,CAAC,aAAa,EAAE,CAAC;YAEjI,OAAO,uBAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED;;;;;;OAMG;IACI,MAAM,CAAO,QAAQ,CACxB,QAAgB,EAChB,MAAc;;YAEd,MAAM,aAAa,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC;YACnE,MAAM,aAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,MAAM,aAAQ,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;KAAA;CACJ;AAjID,8BAiIC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chromiumly",
-  "version": "2.7.0",
+  "version": "2.9.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",
@@ -41,19 +41,19 @@
     }
   },
   "devDependencies": {
-    "@babel/preset-typescript": "7.23.3",
+    "@babel/preset-typescript": "7.24.1",
     "@commitlint/cli": "^19.0.3",
     "@commitlint/config-conventional": "^19.0.3",
     "@commitlint/cz-commitlint": "^19.0.3",
     "@release-it/conventional-changelog": "8.0.1",
-    "@types/config": "3.3.3",
+    "@types/config": "3.3.4",
     "@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.30",
     "@types/node-fetch": "2.6.11",
-    "@typescript-eslint/eslint-plugin": "7.1.0",
-    "@typescript-eslint/parser": "7.1.0",
+    "@typescript-eslint/eslint-plugin": "7.3.1",
+    "@typescript-eslint/parser": "7.3.1",
     "commitizen": "4.3.0",
     "eslint": "8.57.0",
     "eslint-config-prettier": "^9.1.0",
@@ -67,7 +67,7 @@
     "ts-jest": "29.1.2",
     "ts-node": "10.9.2",
     "tslib": "2.6.2",
-    "typescript": "5.3.3"
+    "typescript": "5.4.3"
   },
   "dependencies": {
     "config": "3.3.11",

package/src/chromium/converters/html.converter.ts

@@ -1,6 +1,11 @@
 import FormData from 'form-data';
 
-import { GotenbergUtils, PathLikeOrReadStream, PdfFormat } from '../../common';
+import {
+    GotenbergUtils,
+    Metadata,
+    PathLikeOrReadStream,
+    PdfFormat
+} from '../../common';
 import { PageProperties } from '../interfaces/converter.types';
 import { ConverterUtils } from '../utils/converter.utils';
 import { Converter } from './converter';
@@ -40,6 +45,7 @@ export class HtmlConverter extends Converter {
      * @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.
+     * @param {Metadata} options.metadata - Metadata to be written.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
     async convert({
@@ -57,23 +63,33 @@ export class HtmlConverter extends Converter {
         extraHttpHeaders,
         failOnHttpStatusCodes,
         failOnConsoleExceptions,
-        skipNetworkIdleEvent
+        skipNetworkIdleEvent,
+        metadata
     }: {
         html: PathLikeOrReadStream;
         assets?: { file: PathLikeOrReadStream; name: string }[];
         header?: PathLikeOrReadStream;
         footer?: PathLikeOrReadStream;
         properties?: PageProperties;
+        /**
+         * @deprecated Starting from Gotenberg version 8.0.0, Chromium no longer provides support for pdfFormat.
+         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
+         */
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;
         emulatedMediaType?: EmulatedMediaType;
         waitDelay?: string;
         waitForExpression?: string;
+        /**
+         * @deprecated Starting from Gotenberg version 8.0.0, Chromium no longer provides support for userAgent.
+         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
+         */
         userAgent?: string;
         extraHttpHeaders?: Record<string, string>;
         failOnHttpStatusCodes?: number[];
         failOnConsoleExceptions?: boolean;
         skipNetworkIdleEvent?: boolean;
+        metadata?: Metadata;
     }): Promise<Buffer> {
         const data = new FormData();
 
@@ -100,7 +116,8 @@ export class HtmlConverter extends Converter {
             extraHttpHeaders,
             failOnHttpStatusCodes,
             failOnConsoleExceptions,
-            skipNetworkIdleEvent
+            skipNetworkIdleEvent,
+            metadata
         });
 
         return GotenbergUtils.fetch(this.endpoint, data);

package/src/chromium/converters/markdown.converter.ts

@@ -1,6 +1,11 @@
 import FormData from 'form-data';
 
-import { GotenbergUtils, PdfFormat, PathLikeOrReadStream } from '../../common';
+import {
+    GotenbergUtils,
+    PdfFormat,
+    PathLikeOrReadStream,
+    Metadata
+} from '../../common';
 import { PageProperties } from '../interfaces/converter.types';
 import { ConverterUtils } from '../utils/converter.utils';
 import { Converter } from './converter';
@@ -41,6 +46,7 @@ export class MarkdownConverter extends Converter {
      * @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.
+     * @param {Metadata} options.metadata - Metadata to be written.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
     async convert({
@@ -58,23 +64,33 @@ export class MarkdownConverter extends Converter {
         extraHttpHeaders,
         failOnHttpStatusCodes,
         failOnConsoleExceptions,
-        skipNetworkIdleEvent
+        skipNetworkIdleEvent,
+        metadata
     }: {
         html: PathLikeOrReadStream;
         markdown: PathLikeOrReadStream;
         header?: PathLikeOrReadStream;
         footer?: PathLikeOrReadStream;
         properties?: PageProperties;
+        /**
+         * @deprecated Starting from Gotenberg version 8.0.0, Chromium no longer provides support for pdfFormat.
+         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
+         */
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;
         emulatedMediaType?: EmulatedMediaType;
         waitDelay?: string;
         waitForExpression?: string;
+        /**
+         * @deprecated Starting from Gotenberg version 8.0.0, Chromium no longer provides support for userAgent.
+         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
+         */
         userAgent?: string;
         extraHttpHeaders?: Record<string, string>;
         failOnHttpStatusCodes?: number[];
         failOnConsoleExceptions?: boolean;
         skipNetworkIdleEvent?: boolean;
+        metadata?: Metadata;
     }): Promise<Buffer> {
         const data = new FormData();
 
@@ -95,7 +111,8 @@ export class MarkdownConverter extends Converter {
             extraHttpHeaders,
             failOnHttpStatusCodes,
             failOnConsoleExceptions,
-            skipNetworkIdleEvent
+            skipNetworkIdleEvent,
+            metadata
         });
 
         return GotenbergUtils.fetch(this.endpoint, data);

package/src/chromium/converters/url.converter.ts

@@ -1,6 +1,11 @@
 import { URL } from 'url';
 import FormData from 'form-data';
-import { GotenbergUtils, PdfFormat, PathLikeOrReadStream } from '../../common';
+import {
+    GotenbergUtils,
+    PdfFormat,
+    PathLikeOrReadStream,
+    Metadata
+} from '../../common';
 import { PageProperties } from '../interfaces/converter.types';
 import { ConverterUtils } from '../utils/converter.utils';
 import { Converter } from './converter';
@@ -40,6 +45,7 @@ export class UrlConverter extends Converter {
      * @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.
+     * @param {Metadata} options.metadata - Metadata to be written.
      * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
      */
     async convert({
@@ -56,22 +62,32 @@ export class UrlConverter extends Converter {
         extraHttpHeaders,
         failOnHttpStatusCodes,
         failOnConsoleExceptions,
-        skipNetworkIdleEvent
+        skipNetworkIdleEvent,
+        metadata
     }: {
         url: string;
         header?: PathLikeOrReadStream;
         footer?: PathLikeOrReadStream;
         properties?: PageProperties;
+        /**
+         * @deprecated Starting from Gotenberg version 8.0.0, Chromium no longer provides support for pdfFormat.
+         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
+         */
         pdfFormat?: PdfFormat;
         pdfUA?: boolean;
         emulatedMediaType?: EmulatedMediaType;
         waitDelay?: string;
         waitForExpression?: string;
+        /**
+         * @deprecated Starting from Gotenberg version 8.0.0, Chromium no longer provides support for userAgent.
+         * @see {@link https://github.com/gotenberg/gotenberg/releases/tag/v8.0.0}
+         */
         userAgent?: string;
         extraHttpHeaders?: Record<string, string>;
         failOnHttpStatusCodes?: number[];
         failOnConsoleExceptions?: boolean;
         skipNetworkIdleEvent?: boolean;
+        metadata?: Metadata;
     }): Promise<Buffer> {
         const _url = new URL(url);
         const data = new FormData();
@@ -91,7 +107,8 @@ export class UrlConverter extends Converter {
             extraHttpHeaders,
             failOnHttpStatusCodes,
             failOnConsoleExceptions,
-            skipNetworkIdleEvent
+            skipNetworkIdleEvent,
+            metadata
         });
 
         return GotenbergUtils.fetch(this.endpoint, data);

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/converter.types.ts

@@ -1,4 +1,4 @@
-import { PdfFormat } from '../../common';
+import { Metadata, PdfFormat } from '../../common';
 import { ChromiumOptions } from './common.types';
 
 type PageSize = {
@@ -30,4 +30,5 @@ export type ConversionOptions = ChromiumOptions & {
     pdfFormat?: PdfFormat;
     pdfUA?: boolean; // Enable PDF for Universal Access for optimal accessibility (default false)
     userAgent?: string;
+    metadata?: Metadata;
 };

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]}`;
+    }
+}