chromiumly 3.2.1 → 3.3.1

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

@@ -1,134 +0,0 @@
-import FormData from 'form-data';
-
-import {
-    GotenbergUtils,
-    Metadata,
-    PathLikeOrReadStream,
-    PdfFormat
-} from '../../common';
-import { Cookie, PageProperties } from '../interfaces/converter.types';
-import { ConverterUtils } from '../utils/converter.utils';
-import { Converter } from './converter';
-import { ChromiumRoute, Chromiumly } from '../../main.config';
-import { EmulatedMediaType } from '../interfaces/common.types';
-
-/**
- * Class representing an HTML converter that extends the base Converter class.
- * This class is used to convert HTML content to PDF using Gotenberg service.
- *
- * @extends Converter
- */
-export class HtmlConverter extends Converter {
-    /**
-     * Creates an instance of HtmlConverter.
-     * Initializes the converter with the HTML conversion route.
-     */
-    constructor() {
-        super(ChromiumRoute.HTML);
-    }
-
-    /**
-     * Converts HTML content to PDF.
-     *
-     * @param {Object} options - Conversion options.
-     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
-     * @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 {PageProperties} [options.properties] - Page properties for the conversion.
-     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
-     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
-     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
-     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
-     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
-     * @param {string} [options.userAgent] - User agent string to use during the conversion.
-     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
-     * @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.
-     * @param {Cookie[]} options.cookies - Cookies to be written.
-     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
-     */
-    async convert({
-        html,
-        assets,
-        header,
-        footer,
-        properties,
-        pdfFormat,
-        pdfUA,
-        emulatedMediaType,
-        waitDelay,
-        waitForExpression,
-        userAgent,
-        extraHttpHeaders,
-        failOnHttpStatusCodes,
-        failOnConsoleExceptions,
-        skipNetworkIdleEvent,
-        metadata,
-        cookies
-    }: {
-        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;
-        cookies?: Cookie[];
-    }): 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 ConverterUtils.customize(data, {
-            header,
-            footer,
-            properties,
-            pdfFormat,
-            pdfUA,
-            emulatedMediaType,
-            waitDelay,
-            waitForExpression,
-            userAgent,
-            extraHttpHeaders,
-            failOnHttpStatusCodes,
-            failOnConsoleExceptions,
-            skipNetworkIdleEvent,
-            metadata,
-            cookies
-        });
-
-        return GotenbergUtils.fetch(
-            this.endpoint,
-            data,
-            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
-            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
-        );
-    }
-}

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

@@ -1,129 +0,0 @@
-import FormData from 'form-data';
-
-import {
-    GotenbergUtils,
-    PdfFormat,
-    PathLikeOrReadStream,
-    Metadata
-} from '../../common';
-import { Cookie, PageProperties } from '../interfaces/converter.types';
-import { ConverterUtils } from '../utils/converter.utils';
-import { Converter } from './converter';
-import { ChromiumRoute, Chromiumly } from '../../main.config';
-import { EmulatedMediaType } from '../interfaces/common.types';
-
-/**
- * Class representing a Markdown converter that extends the base Converter class.
- * This class is used to convert HTML with markdown content to PDF using Gotenberg service.
- *
- * @extends Converter
- */
-export class MarkdownConverter extends Converter {
-    /**
-     * Creates an instance of MarkdownConverter.
-     * Initializes the converter with the Markdown conversion route.
-     */
-    constructor() {
-        super(ChromiumRoute.MARKDOWN);
-    }
-
-    /**
-     * Converts HTML with markdown content to PDF.
-     *
-     * @param {Object} options - Conversion options.
-     * @param {PathLikeOrReadStream} options.html - PathLike or ReadStream of the HTML content to be converted.
-     * @param {PathLikeOrReadStream} options.markdown - PathLike or ReadStream of the Markdown content to be converted.
-     * @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 {PageProperties} [options.properties] - Page properties for the conversion.
-     * @param {PdfFormat} [options.pdfFormat] - PDF format options.
-     * @param {boolean} [options.pdfUA] - Indicates whether to generate PDF/UA compliant output.
-     * @param {EmulatedMediaType} [options.emulatedMediaType] - Emulated media type for the conversion.
-     * @param {string} [options.waitDelay] - Delay before the conversion process starts.
-     * @param {string} [options.waitForExpression] - JavaScript expression to wait for before completing the conversion.
-     * @param {string} [options.userAgent] - User agent string to use during the conversion.
-     * @param {Record<string, string>} [options.extraHttpHeaders] - Additional HTTP headers for the conversion.
-     * @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.
-     * @param {Cookie[]} options.cookies - Cookies to be written.
-     * @returns {Promise<Buffer>} A Promise resolving to the converted PDF content as a Buffer.
-     */
-    async convert({
-        html,
-        markdown,
-        header,
-        footer,
-        properties,
-        pdfFormat,
-        pdfUA,
-        emulatedMediaType,
-        waitDelay,
-        waitForExpression,
-        userAgent,
-        extraHttpHeaders,
-        failOnHttpStatusCodes,
-        failOnConsoleExceptions,
-        skipNetworkIdleEvent,
-        metadata,
-        cookies
-    }: {
-        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;
-        cookies?: Cookie[];
-    }): Promise<Buffer> {
-        const data = new FormData();
-
-        await GotenbergUtils.addFile(data, html, 'index.html');
-
-        await GotenbergUtils.addFile(data, markdown, 'file.md');
-
-        await ConverterUtils.customize(data, {
-            header,
-            footer,
-            properties,
-            pdfFormat,
-            pdfUA,
-            emulatedMediaType,
-            waitDelay,
-            waitForExpression,
-            userAgent,
-            extraHttpHeaders,
-            failOnHttpStatusCodes,
-            failOnConsoleExceptions,
-            skipNetworkIdleEvent,
-            metadata,
-            cookies
-        });
-
-        return GotenbergUtils.fetch(
-            this.endpoint,
-            data,
-            Chromiumly.GOTENBERG_API_BASIC_AUTH_USERNAME,
-            Chromiumly.GOTENBERG_API_BASIC_AUTH_PASSWORD
-        );
-    }
-}

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

@@ -1,190 +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 { PdfFormat } from '../../../common';
-import { HtmlConverter } from '../html.converter';
-
-const { Response } = jest.requireActual('node-fetch');
-jest.mock('node-fetch', () => jest.fn());
-
-describe('HtmlConverter', () => {
-    const converter = new HtmlConverter();
-
-    describe('endpoint', () => {
-        it('should route to Chromium HTML route', () => {
-            expect(converter.endpoint).toEqual(
-                'http://localhost:3000/forms/chromium/convert/html'
-            );
-        });
-    });
-
-    describe('convert', () => {
-        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 converter.convert({
-                    html: Buffer.from('data')
-                });
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when pdf format parameter is passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await converter.convert({
-                    html: Buffer.from('data'),
-                    pdfFormat: PdfFormat.A_1a
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(2);
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when page properties parameter is passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await converter.convert({
-                    html: Buffer.from('data'),
-                    properties: { size: { width: 8.3, height: 11.7 } }
-                });
-                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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    html: Buffer.from('data'),
-                    skipNetworkIdleEvent: 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 converter.convert({
-                    html: Buffer.from('data'),
-                    assets,
-                    header: Buffer.from('header'),
-                    footer: Buffer.from('footer'),
-                    pdfFormat: PdfFormat.A_1a,
-                    emulatedMediaType: 'screen',
-                    properties: { size: { width: 8.3, height: 11.7 } }
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(9);
-                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(() =>
-                    converter.convert({ 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/convert/html failed';
-                mockPromisesAccess.mockResolvedValue();
-                mockFetch.mockRejectedValue(new Error(errorMessage));
-                await expect(() =>
-                    converter.convert({ html: 'path/to/index.html' })
-                ).rejects.toThrow(errorMessage);
-            });
-        });
-    });
-});

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

@@ -1,187 +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 { PdfFormat } from '../../../common';
-import { MarkdownConverter } from '../markdown.converter';
-
-const { Response } = jest.requireActual('node-fetch');
-jest.mock('node-fetch', () => jest.fn());
-
-describe('MarkdownConverter', () => {
-    const converter = new MarkdownConverter();
-
-    describe('endpoint', () => {
-        it('should route to Chromium Markdown route', () => {
-            expect(converter.endpoint).toEqual(
-                'http://localhost:3000/forms/chromium/convert/markdown'
-            );
-        });
-    });
-
-    describe('convert', () => {
-        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 converter.convert({
-                    html: Buffer.from('data'),
-                    markdown: Buffer.from('markdown')
-                });
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when pdf format parameter is passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await converter.convert({
-                    html: Buffer.from('data'),
-                    markdown: Buffer.from('markdown'),
-                    pdfFormat: PdfFormat.A_2b
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(3);
-                expect(buffer).toEqual(Buffer.from('content'));
-            });
-        });
-
-        describe('when page properties parameter is passed', () => {
-            it('should return a buffer', async () => {
-                mockFetch.mockResolvedValue(new Response('content'));
-                const buffer = await converter.convert({
-                    html: Buffer.from('data'),
-                    markdown: Buffer.from('markdown'),
-                    properties: { size: { width: 8.3, height: 11.7 } }
-                });
-                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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    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 converter.convert({
-                    html: Buffer.from('data'),
-                    markdown: Buffer.from('markdown'),
-                    header: Buffer.from('header'),
-                    footer: Buffer.from('footer'),
-                    pdfFormat: PdfFormat.A_1a,
-                    emulatedMediaType: 'screen',
-                    properties: { size: { width: 8.3, height: 11.7 } }
-                });
-                expect(mockFormDataAppend).toHaveBeenCalledTimes(8);
-                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(() =>
-                    converter.convert({
-                        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/convert/html failed';
-                mockPromisesAccess.mockResolvedValue();
-                mockFetch.mockRejectedValue(new Error(errorMessage));
-                await expect(() =>
-                    converter.convert({
-                        html: 'path/to/index.html',
-                        markdown: 'path/to/file.md'
-                    })
-                ).rejects.toThrow(errorMessage);
-            });
-        });
-    });
-});