chromiumly 3.3.0 → 3.3.2

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

@@ -1,96 +0,0 @@
-import { URL } from 'url';
-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, Chromiumly } from '../../main.config';
-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 class UrlScreenshot extends Screenshot {
-    /**
-     * Creates an instance of UrlScreenshot.
-     * Initializes the screenshot with the URL screenshot route.
-     */
-    constructor() {
-        super(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.
-     */
-    async 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> {
-        const _url = new URL(url);
-        const data = new FormData();
-
-        data.append('url', _url.href);
-
-        await ScreenshotUtils.customize(data, {
-            header,
-            footer,
-            properties,
-            emulatedMediaType,
-            waitDelay,
-            waitForExpression,
-            extraHttpHeaders,
-            failOnHttpStatusCodes,
-            failOnConsoleExceptions,
-            skipNetworkIdleEvent,
-            optimizeForSpeed
-        });
-
-        return GotenbergUtils.fetch(
-            this.endpoint,
-            data,
-            Chromiumly.getGotenbergApiBasicAuthUsername(),
-            Chromiumly.getGotenbergApiBasicAuthPassword()
-        );
-    }
-}

package/src/chromium/utils/converter.utils.ts

@@ -1,187 +0,0 @@
-import FormData from 'form-data';
-
-import {
-    ConversionOptions,
-    PageProperties
-} from '../interfaces/converter.types';
-import { GotenbergUtils } from '../../common';
-
-/**
- * Utility class for handling common tasks related to conversion.
- */
-export class ConverterUtils {
-    /**
-     * Adds page properties to the FormData object based on the provided PageProperties.
-     *
-     * @param {FormData} data - The FormData object to which page properties will be added.
-     * @param {PageProperties} pageProperties - The page properties to be added to the FormData.
-     */
-    public static addPageProperties(
-        data: FormData,
-        pageProperties: PageProperties
-    ): void {
-        if (pageProperties.singlePage) {
-            data.append('singlePage', String(pageProperties.singlePage));
-        }
-
-        if (pageProperties.size) {
-            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) {
-            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);
-        }
-
-        if (pageProperties.preferCssPageSize) {
-            data.append(
-                'preferCssPageSize',
-                String(pageProperties.preferCssPageSize)
-            );
-        }
-
-        if (pageProperties.printBackground) {
-            data.append(
-                'printBackground',
-                String(pageProperties.printBackground)
-            );
-        }
-
-        if (pageProperties.omitBackground) {
-            data.append(
-                'omitBackground',
-                String(pageProperties.omitBackground)
-            );
-        }
-
-        if (pageProperties.landscape) {
-            data.append('landscape', String(pageProperties.landscape));
-        }
-
-        if (pageProperties.scale) {
-            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) {
-            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}`
-            );
-        }
-    }
-
-    /**
-     * Customizes the FormData object based on the provided conversion options.
-     *
-     * @param {FormData} data - The FormData object to be customized.
-     * @param {ConversionOptions} options - The conversion options to apply to the FormData.
-     * @returns {Promise<void>} A Promise that resolves once the customization is complete.
-     */
-    public static async customize(
-        data: FormData,
-        options: ConversionOptions
-    ): Promise<void> {
-        if (options.pdfFormat) {
-            data.append('pdfa', options.pdfFormat);
-        }
-
-        if (options.pdfUA) {
-            data.append('pdfua', String(options.pdfUA));
-        }
-
-        if (options.header) {
-            const { header } = options;
-            await GotenbergUtils.addFile(data, header, 'header.html');
-        }
-
-        if (options.footer) {
-            const { footer } = options;
-            await GotenbergUtils.addFile(data, footer, 'footer.html');
-        }
-
-        if (options.emulatedMediaType) {
-            data.append('emulatedMediaType', options.emulatedMediaType);
-        }
-
-        if (options.properties) {
-            ConverterUtils.addPageProperties(data, options.properties);
-        }
-
-        if (options.waitDelay) {
-            data.append('waitDelay', options.waitDelay);
-        }
-
-        if (options.waitForExpression) {
-            data.append('waitForExpression', options.waitForExpression);
-        }
-
-        if (options.userAgent) {
-            data.append('userAgent', options.userAgent);
-        }
-
-        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.metadata) {
-            data.append('metadata', JSON.stringify(options.metadata));
-        }
-
-        if (options.cookies) {
-            data.append('cookies', JSON.stringify(options.cookies));
-        }
-    }
-}

package/src/chromium/utils/screenshot.utils.ts

@@ -1,127 +0,0 @@
-import {
-    ImageProperties,
-    ScreenshotOptions
-} from './../interfaces/screenshot.types';
-import FormData from 'form-data';
-
-import { GotenbergUtils } from '../../common';
-
-/**
- * Utility class for handling common tasks related to screenshot.
- */
-export 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.
-     */
-    public static addImageProperties(
-        data: FormData,
-        imageProperties: ImageProperties
-    ): void {
-        data.append('format', imageProperties.format);
-
-        if (imageProperties.quality) {
-            GotenbergUtils.assert(
-                imageProperties.format === 'jpeg',
-                'Compression quality is exclusively supported for JPEG format.'
-            );
-            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)
-            );
-        }
-
-        if (imageProperties.width) {
-            data.append('width', imageProperties.width);
-        }
-
-        if (imageProperties.height) {
-            data.append('height', imageProperties.height);
-        }
-
-        if (imageProperties.clip) {
-            data.append('clip', String(imageProperties.clip));
-        }
-    }
-
-    /**
-     * 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.
-     */
-    public static async customize(
-        data: FormData,
-        options: ScreenshotOptions
-    ): Promise<void> {
-        if (options.header) {
-            const { header } = options;
-            await GotenbergUtils.addFile(data, header, 'header.html');
-        }
-
-        if (options.footer) {
-            const { footer } = options;
-            await 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));
-        }
-    }
-}