chromiumly 2.6.0 → 2.8.0

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"}

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

@@ -1,6 +1,5 @@
-import FormData from "form-data";
-import { ConversionOptions, PageProperties } from "../interfaces/converter.types";
-import { PathLikeOrReadStream } from "../../common";
+import FormData from 'form-data';
+import { ConversionOptions, PageProperties } from '../interfaces/converter.types';
 /**
  * Utility class for handling common tasks related to conversion.
  */
@@ -12,15 +11,6 @@ export declare class ConverterUtils {
      * @param {PageProperties} pageProperties - The page properties to be added to the FormData.
      */
     static addPageProperties(data: FormData, pageProperties: PageProperties): void;
-    /**
-     * Adds a file to the FormData object.
-     *
-     * @param {FormData} data - The FormData object to which the file will be added.
-     * @param {PathLikeOrReadStream} file - The file to be added (either a PathLike or a ReadStream).
-     * @param {string} name - The name to be used for the file in the FormData.
-     * @returns {Promise<void>} A Promise that resolves once the file has been added.
-     */
-    static addFile(data: FormData, file: PathLikeOrReadStream, name: string): Promise<void>;
     /**
      * Customizes the FormData object based on the provided conversion options.
      *

package/dist/chromium/utils/converter.utils.js

@@ -2,9 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConverterUtils = void 0;
 const tslib_1 = require("tslib");
-const fs_1 = require("fs");
 const common_1 = require("../../common");
-const fs_2 = require("fs");
 /**
  * Utility class for handling common tasks related to conversion.
  */
@@ -16,67 +14,49 @@ class ConverterUtils {
      * @param {PageProperties} pageProperties - The page properties to be added to the FormData.
      */
     static addPageProperties(data, pageProperties) {
+        if (pageProperties.singlePage) {
+            data.append('singlePage', String(pageProperties.singlePage));
+        }
         if (pageProperties.size) {
-            common_1.GotenbergUtils.assert(pageProperties.size.width >= 1.0 && pageProperties.size.height >= 1.5, "size is smaller than the minimum printing requirements (i.e. 1.0 x 1.5 in)");
-            data.append("paperWidth", pageProperties.size.width);
-            data.append("paperHeight", pageProperties.size.height);
+            common_1.GotenbergUtils.assert(pageProperties.size.width >= 1.0 &&
+                pageProperties.size.height >= 1.5, 'size is smaller than the minimum printing requirements (i.e. 1.0 x 1.5 in)');
+            data.append('paperWidth', pageProperties.size.width);
+            data.append('paperHeight', pageProperties.size.height);
         }
         if (pageProperties.margins) {
             common_1.GotenbergUtils.assert(pageProperties.margins.top >= 0 &&
                 pageProperties.margins.bottom >= 0 &&
                 pageProperties.margins.left >= 0 &&
-                pageProperties.margins.left >= 0, "negative margins are not allowed");
-            data.append("marginTop", pageProperties.margins.top);
-            data.append("marginBottom", pageProperties.margins.bottom);
-            data.append("marginLeft", pageProperties.margins.left);
-            data.append("marginRight", pageProperties.margins.right);
+                pageProperties.margins.left >= 0, 'negative margins are not allowed');
+            data.append('marginTop', pageProperties.margins.top);
+            data.append('marginBottom', pageProperties.margins.bottom);
+            data.append('marginLeft', pageProperties.margins.left);
+            data.append('marginRight', pageProperties.margins.right);
         }
         if (pageProperties.preferCssPageSize) {
-            data.append("preferCssPageSize", String(pageProperties.preferCssPageSize));
+            data.append('preferCssPageSize', String(pageProperties.preferCssPageSize));
         }
         if (pageProperties.printBackground) {
-            data.append("printBackground", String(pageProperties.printBackground));
+            data.append('printBackground', String(pageProperties.printBackground));
         }
         if (pageProperties.omitBackground) {
-            data.append("omitBackground", String(pageProperties.omitBackground));
+            data.append('omitBackground', String(pageProperties.omitBackground));
         }
         if (pageProperties.landscape) {
-            data.append("landscape", String(pageProperties.landscape));
+            data.append('landscape', String(pageProperties.landscape));
         }
         if (pageProperties.scale) {
-            common_1.GotenbergUtils.assert(pageProperties.scale >= 0.1 && pageProperties.scale <= 2.0, "scale is outside of [0.1 - 2] range");
-            data.append("scale", pageProperties.scale);
+            common_1.GotenbergUtils.assert(pageProperties.scale >= 0.1 && pageProperties.scale <= 2.0, 'scale is outside of [0.1 - 2] range');
+            data.append('scale', pageProperties.scale);
         }
         if (pageProperties.nativePageRanges) {
             common_1.GotenbergUtils.assert(pageProperties.nativePageRanges.from > 0 &&
                 pageProperties.nativePageRanges.to > 0 &&
                 pageProperties.nativePageRanges.to >=
-                    pageProperties.nativePageRanges.from, "page ranges syntax error");
-            data.append("nativePageRanges", `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`);
+                    pageProperties.nativePageRanges.from, 'page ranges syntax error');
+            data.append('nativePageRanges', `${pageProperties.nativePageRanges.from}-${pageProperties.nativePageRanges.to}`);
         }
     }
-    /**
-     * Adds a file to the FormData object.
-     *
-     * @param {FormData} data - The FormData object to which the file will be added.
-     * @param {PathLikeOrReadStream} file - The file to be added (either a PathLike or a ReadStream).
-     * @param {string} name - The name to be used for the file in the FormData.
-     * @returns {Promise<void>} A Promise that resolves once the file has been added.
-     */
-    static addFile(data, file, name) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            if (Buffer.isBuffer(file)) {
-                data.append("files", file, name);
-            }
-            else if (file instanceof fs_2.ReadStream) {
-                data.append("files", file, name);
-            }
-            else {
-                yield fs_1.promises.access(file, fs_1.constants.R_OK);
-                data.append("files", (0, fs_1.createReadStream)(file), name);
-            }
-        });
-    }
     /**
      * Customizes the FormData object based on the provided conversion options.
      *
@@ -87,39 +67,45 @@ class ConverterUtils {
     static customize(data, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             if (options.pdfFormat) {
-                data.append("pdfa", options.pdfFormat);
+                data.append('pdfa', options.pdfFormat);
             }
             if (options.pdfUA) {
-                data.append("pdfua", String(options.pdfUA));
+                data.append('pdfua', String(options.pdfUA));
             }
             if (options.header) {
                 const { header } = options;
-                yield ConverterUtils.addFile(data, header, "header.html");
+                yield common_1.GotenbergUtils.addFile(data, header, 'header.html');
             }
             if (options.footer) {
                 const { footer } = options;
-                yield ConverterUtils.addFile(data, footer, "footer.html");
+                yield common_1.GotenbergUtils.addFile(data, footer, 'footer.html');
             }
             if (options.emulatedMediaType) {
-                data.append("emulatedMediaType", options.emulatedMediaType);
+                data.append('emulatedMediaType', options.emulatedMediaType);
             }
             if (options.properties) {
                 ConverterUtils.addPageProperties(data, options.properties);
             }
             if (options.waitDelay) {
-                data.append("waitDelay", options.waitDelay);
+                data.append('waitDelay', options.waitDelay);
             }
             if (options.waitForExpression) {
-                data.append("waitForExpression", options.waitForExpression);
+                data.append('waitForExpression', options.waitForExpression);
             }
             if (options.userAgent) {
-                data.append("userAgent", options.userAgent);
+                data.append('userAgent', options.userAgent);
             }
             if (options.extraHttpHeaders) {
-                data.append("extraHttpHeaders", JSON.stringify(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));
+                data.append('failOnConsoleExceptions', String(options.failOnConsoleExceptions));
+            }
+            if (options.skipNetworkIdleEvent) {
+                data.append('skipNetworkIdleEvent', String(options.skipNetworkIdleEvent));
             }
         });
     }