chromiumly 3.2.1 → 3.3.1

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

@@ -1,192 +0,0 @@
-// 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);
-            });
-        });
-    });
-});

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

@@ -1,176 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { createReadStream, promises } from 'fs';
-
-import FormData from 'form-data';
-import fetch from 'node-fetch';
-
-import { MarkdownScreenshot } from '../markdown.screenshot';
-
-const { Response } = jest.requireActual('node-fetch');
-jest.mock('node-fetch', () => jest.fn());
-
-describe('MarkdownScreenshot', () => {
-    const screenshot = new MarkdownScreenshot();
-
-    describe('endpoint', () => {
-        it('should route to Chromium Markdown route', () => {
-            expect(screenshot.endpoint).toEqual(
-                'http://localhost:3000/forms/chromium/screenshot/markdown'
-            );
-        });
-    });
-
-    describe('capture', () => {
-        const mockPromisesAccess = jest.spyOn(promises, 'access');
-        const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
-        const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
-
-        beforeEach(() => {
-            (createReadStream as jest.Mock) = jest.fn();
-        });
-
-        afterEach(() => {
-            jest.resetAllMocks();
-        });
-
-        describe('when html and markdown parameters are passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await screenshot.capture({
-                    html: Buffer.from('data'),
-                    markdown: Buffer.from('markdown')
-                });
-                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'),
-                    markdown: Buffer.from('markdown'),
-                    properties: { format: 'jpeg', quality: 50 }
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(4);
-                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'),
-                    markdown: Buffer.from('markdown'),
-                    header: Buffer.from('header')
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
-                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'),
-                    markdown: Buffer.from('markdown'),
-                    footer: Buffer.from('footer')
-                });
-                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'),
-                    markdown: Buffer.from('markdown'),
-                    emulatedMediaType: 'screen'
-                });
-
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
-                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'),
-                    markdown: Buffer.from('markdown'),
-                    failOnHttpStatusCodes: [499, 599]
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
-                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'),
-                    markdown: Buffer.from('markdown'),
-                    skipNetworkIdleEvent: true
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when all parameters are passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await screenshot.capture({
-                    html: Buffer.from('data'),
-                    markdown: Buffer.from('markdown'),
-                    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(11);
-                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',
-                        markdown: 'path/to/file.md'
-                    })
-                ).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',
-                        markdown: 'path/to/file.md'
-                    })
-                ).rejects.toThrow(errorMessage);
-            });
-        });
-    });
-});

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

@@ -1,166 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { createReadStream } from 'fs';
-import FormData from 'form-data';
-import fetch from 'node-fetch';
-
-import { UrlScreenshot } from './../url.screenshot';
-
-const { Response } = jest.requireActual('node-fetch');
-jest.mock('node-fetch', () => jest.fn());
-
-describe('URLScreenshot', () => {
-    const screenshot = new UrlScreenshot();
-
-    describe('endpoint', () => {
-        it('should route to Chromium HTML route', () => {
-            expect(screenshot.endpoint).toEqual(
-                'http://localhost:3000/forms/chromium/screenshot/url'
-            );
-        });
-    });
-
-    describe('capture', () => {
-        const mockFetch = fetch as jest.MockedFunction<typeof fetch>;
-        const mockFormDataAppend = jest.spyOn(FormData.prototype, 'append');
-
-        beforeEach(() => {
-            (createReadStream as jest.Mock) = jest.fn();
-        });
-
-        afterEach(() => {
-            jest.resetAllMocks();
-        });
-
-        describe('when URL is valid', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValueOnce(new Response('content'));
-                const buffer = await screenshot.capture({
-                    url: 'http://www.example.com/'
-                });
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when header parameter is passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValueOnce(new Response('content'));
-                const buffer = await screenshot.capture({
-                    url: 'http://www.example.com/',
-                    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.mockResolvedValueOnce(new Response('content'));
-                const buffer = await screenshot.capture({
-                    url: 'http://www.example.com/',
-                    footer: Buffer.from('footer')
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when image properties parameter is passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValueOnce(new Response('content'));
-                const buffer = await screenshot.capture({
-                    url: 'http://www.example.com/',
-                    properties: { format: 'jpeg', quality: 50 }
-                });
-                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({
-                    url: 'http://www.example.com/',
-                    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({
-                    url: 'http://www.example.com/',
-                    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({
-                    url: 'http://www.example.com/',
-                    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({
-                    url: 'http://www.example.com/',
-                    optimizeForSpeed: true
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when all parameters are passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await screenshot.capture({
-                    url: 'http://www.example.com/',
-                    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(10);
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when URL is invalid', () => {
-            it('should throw an error', async () => {
-                await expect(() =>
-                    screenshot.capture({ url: 'invalid url' })
-                ).rejects.toThrow('Invalid URL');
-            });
-        });
-
-        describe('when fetch request fails', () => {
-            it('should throw an error', async () => {
-                const errorMessage =
-                    'FetchError: request to http://localhost:3000/forms/chromium/convert/html failed';
-                mockFetch.mockRejectedValueOnce(new Error(errorMessage));
-                await expect(() =>
-                    screenshot.capture({ url: 'http://www.example.com/' })
-                ).rejects.toThrow(errorMessage);
-            });
-        });
-    });
-});

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.GOTENBERG_API_BASIC_AUTH_USERNAME,
-            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
-        );
-    }
-}